constants.h

Go to the documentation of this file.

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
#include <predef.h>
 
#ifndef _CONSTANTS_H
#define _CONSTANTS_H
 
#define TICK_IRQ_LEVEL (5) /* System clock IRQ level */
#define SERIAL_IRQ_LEVEL (3)
#define SERIAL_VECTOR_BASE (64)
 
/*
 
PLEASE READ THIS BEFORE MODIFYING TICKS_PER_SECOND
 
Before you change this value understand what changing it does.
Making it faster only slows things down. It does not speed up task switches,
If only changes the granularity of time delays and timeouts.
Task switches happen much much faster than the tick interval. They happen as
soon as one task blocks or an interrupt /or task causes a higher priority task
to be unblocked. The Time tick has NOTHING to do with task switches.
 
If you change it to the maximum 200 you have increased the RTOS overhead by a factor
of 10 and have actually slowed your system.
*/
 
#define TICKS_PER_SECOND (20) /* System clock tick */
 
/*
 *****************************************************************************
 * OS Maximum Interrupt Level
 *
 *  OS_MAX_IRQ_MASK       - Optional, Maximum IRQ level that the RTOS is
 *                          allowed to mask. RTOS objects may not be used
 *                          in ISRs above this level.
 *****************************************************************************
 */
/* #define OS_MAX_IRQ       (3) */
 
/* Ethernet buffer defines */
#define ETHER_BUFFER_SIZE 1548
#define ETH_MAX_PAYLOAD (1500)
#define ETH_MAX_SIZE (1522)
#define ETH_MIN_SIZE (46)
#define IP_HEADER_SIZE (20)
#define UDP_HEADER_SIZE (8)
#define MAX_UDPDATA (ETH_MAX_PAYLOAD - (IP_HEADER_SIZE + UDP_HEADER_SIZE))
 
#define SERIAL_TX_BUFFERS (2) /* ETHERN_BUFFER_SIZE = bytes of serial TX fifo */
#define SERIAL_RX_BUFFERS (2) /* ETHERN_BUFFER_SIZE = bytes of serial RX fifo */
#define stdin_buffer_size (200)
 
#define OS_MAX_TASKS 32 /* Max number of system tasks */
 
#define OS_MAX_PRIOS 64 /* Maximum number of system priorities */
 
/*
 ******************************************************************************
 *
 * System task priorities
 *
 *    Restating the NBRTOS RTOS Library document (NBRtosLibrary.pdf)
 *       Lowest priority is OS_MAX_PRIOS-1, 1 is the highest.
 *       There can only be one task at each priority level.
 *       Idle task is created at priority 63.
 *
 *    UserMain is created at priority 10. It is recommended and is supported by
 *       examples and default projects that a call to
 *          OSChangePrio( MAIN_PRIO );
 *       be made to lower the priority to the range recommended for the main
 *       application.
 *
 *    Factory applications use priorities 46 through 56.
 *
 *    Netburner Runtime library support and driver tasks use 36 through 45.
 *
 *    Care should be taken in use of priorities it can affect reliability and
 *       performance.
 *
 ******************************************************************************
 */
 
/* Recommend UserMain priority */
#define MAIN_PRIO (50)
 
/* Runtime library driver and support task priorities */
#define USB_HW_PRIO (45)
#define PPP_PRIO (44)
#define SECURITY_TASK_PRIO (43)
#define WIFI_STATION_TASK_PRIO (42)
#define WIFI_TASK_PRIO (41)
#define CONFIG_SERVER_PRIO (40)
#define HTTP_PRIO (39)
#define ETHER_SEND_PRIO (38)
 
/* Features */
/* SSH server must be lower than main for progress displays */
#define SSH_TASK_PRIORITY (56)
 
/*
 ******************************************************************************
 *
 * Stack size definitions
 *
 *    SSH requires larger stacks for session key generation see predef.h
 *
 ******************************************************************************
 */
#if defined NB_SSH_SUPPORTED || defined NB_SSL_SUPPORTED
#define MAIN_TASK_STK_SIZE (3072)
#define IP_STK_SIZE (2048)
#define TCP_STK_SIZE (3072)
#define HTTP_STK_SIZE (3072)
#define IDLE_STK_SIZE (2048)
#define ETHER_SEND_STK_SIZE (2048)
#define PPP_STK_SIZE (2048)
#define USB_HW_STK_SIZE (2048)
#define USER_TASK_STK_SIZE (3072)
#else /* #ifdef NB_SSH_SUPPORTED */
#define MAIN_TASK_STK_SIZE (2048)
#define IP_STK_SIZE (2048)
#define TCP_STK_SIZE (2048)
#define HTTP_STK_SIZE (2048)
#define IDLE_STK_SIZE (2048)
#define ETHER_SEND_STK_SIZE (2048)
#define PPP_STK_SIZE (2048)
#define USB_HW_STK_SIZE (2048)
#define USER_TASK_STK_SIZE (2048)
#endif /* #ifdef NB_SSH_SUPPORTED */
 
/* TCP definitions */
#define DEFAULT_TCP4_MSS (512)
#define DEFAULT_TCP6_MSS (1200)
#define DEFAULT_TCP_RTTVAR \
    ((TICKS_PER_SECOND * 3) / 4)            /*See RFC 1122 for a 50msec tick 60 ticks=3 sec 4*15=60 (The 4 comes from stevens Vol1-300) */
#define TCP_CONN_TO (75 * TICKS_PER_SECOND) /* 75 seconds Min  */
#define TCP_ACK_TICK_DLY (TICKS_PER_SECOND / 5) /* 200 msec delayed ACK timer */
#define DEFAULT_INITAL_RTO (TICKS_PER_SECOND * 3)
#define TCP_MAX_RTO (64 * TICKS_PER_SECOND)
#define TCP_MIN_RTO (TICKS_PER_SECOND / 2)
#define TCP_2MSL_WAIT (60 * TICKS_PER_SECOND)
#define MAX_TCP_RETRY (12)
#define TCP_WRITE_TIMEOUT (TICKS_PER_SECOND * 10)
#define TCP_BUFFER_SEGMENTS (5) /* Store 4 segments max in tx and rx buffers  allows fast retransmit when packets lost*/
 
#define MAX_MULTICAST_GROUPS (32)
 
#define HTTP_TIMEOUT (TICKS_PER_SECOND * 10) /* 10 idle Seconds and a partially received request is abandoned */
#define HTTP_READ_TIME_LIMIT (30)            /* Seconds to allow reading to avoid denial of service*/
#define HTTP_RX_BUFFERSIZE (10000)
#define MAX_HTTP_PENDING_SOCKETS (5)     // Number of sockets allowed to be pending on listening socket, performance will degrade < 3
#define MAX_HTTP_CONNECTED_SOCKETS (5)   // Number of sockets allowed to be connected to http server simultaneously
#define MAX_HTTP_POST_VAR_NAME_SIZE  (256)  // Max HTTP POST variable name length
#define MAX_HTTP_POST_VAR_VALUE_SIZE (256)  // Max HTTP POST variable value length
 
// FDs are preallocated
// STDOUT
// STDIN
// STDERR
//           <-SERIAL_SOCKET_OFFSET
// Serial 0
// Serial 1
//           <-TCP_SOCKET_OFFSET
// TCP FD's
//           <-EXTRA_IO_OFFSET
// Extra FDS
 
#define SERIAL_SOCKET_OFFSET (3)
#define TCP_SOCKET_OFFSET (5)
#define TCP_SOCKET_STRUCTS (128)
#define EXTRA_IO_OFFSET (TCP_SOCKET_OFFSET + TCP_SOCKET_STRUCTS)
#define EXTRA_FDS (122)
#define TOTAL_FDS (TCP_SOCKET_OFFSET + TCP_SOCKET_STRUCTS + EXTRA_FDS)
#define FDSET_ELEMENTS ((TOTAL_FDS) / 32)
 
#define TASK_TABLE_SIZE 2
 
#define MAX_IP_ERRS 3
 
#define BUFFER_POOL_SIZE (256) /* was 64 in last release, we increased buffer segments to handle higher throughput events*/
#define POOL_BUFFER_SIZE (sizeof(pool_buffer))   // Size of each buffer - 1712 bytes by default
#define UDP_DISPATCH_SIZE (15)
#define UDP_MIN_BUFFER_THRESHOLD (10)
#define ARP_ENTRY_SIZE (256)
 
#define UDP_NETBURNERID_PORT (0x4E42) /* NB */
#define UDP_DHCP_SERVER_PORT (67)
#define UDP_DHCP_CLIENT_PORT (68)
#define UDP_MDNS_PORT (5353)
 
#define TFTP_RX_PORT (1414)
 
#define LINK_STATUS_CHECK_INTERVAL (2 * TICKS_PER_SECOND)
 
#define FTPD_SOCKET_TIMEOUT (5 * 60 * TICKS_PER_SECOND)
 
#ifndef _DEBUG
#define ENABLE_SRAM_SYS
#endif
 
/* If ENABLE _SRAM_SYS is TRUE, then the processor's on-chip SRAM will be
    used for fast network buffering and OS tasks as defined below:
*/
#ifdef ENABLE_SRAM_SYS
#define FAST_SYSTEM_VARIABLES
 
// Uncommented system tasks will be stored in SRAM, otherwise SDRAM will be used.
//#define FAST_IDLE_STACK
#define FAST_MAIN_STACK
#define FAST_ETHERNET_VARIABLES
#define FAST_ETHERNET_STACK
#define FAST_BUFFERS_VARIABLES
#define FAST_BUFFERS
#define FAST_IP_VARIABLES
#define FAST_IP_STACK
#define FAST_TCP_VARIABLES
#define FAST_TCP_STACK
#define FAST_USB_VARIABLES
#define FAST_USB_STACK
//#define FAST_HTTP_STACK
//#define FAST_FTP_STACK
//#define FAST_WIFI_STACK
//#define FAST_PPP_STACK
//#define FAST_COMMAND_STACK
 
/* If these defines are enabled, any user variables or tasks declared with
    FAST_USR_STK or FAST_USR_VAR will be stored in SRAM.
*/
#define FAST_USER_VARIABLES
#define FAST_USER_STACK
 
#define FAST_TLS_VARIABLES
 
#endif
 
#ifdef FAST_SYSTEM_VARIABLES
#define FAST_SYS_VAR __attribute__((section("SYS_VAR_SECT")))
#define FAST_SYS_VAR_REL __attribute__((section("SYS_VAR_SECT_REL")))
#define FAST_SYS_VAR_REL_STR __attribute__((section("SYS_VAR_SECT_REL_STR")))
#else
#define FAST_SYS_VAR
#define FAST_SYS_VAR_REL
#define FAST_SYS_VAR_REL_STR
#endif
#ifdef FAST_IDLE_STACK
#define FAST_IDLE_STK __attribute__((section("IDLE_STK_SECT")))
#else
#define FAST_IDLE_STK
#endif
#ifdef FAST_MAIN_STACK
#define FAST_MAIN_STK __attribute__((section("MAIN_STK_SECT")))
#else
#define FAST_MAIN_STK
#endif
#ifdef FAST_USER_STACK
#define FAST_USER_STK __attribute__((section("USER_STK_SECT")))
#else
#define FAST_USER_STK
#endif
#ifdef FAST_USER_VARIABLES
#define FAST_USER_VAR __attribute__((section("USER_VAR_SECT")))
#else
#define FAST_USER_VAR
#endif
#ifdef FAST_ETHERNET_VARIABLES
#define FAST_ETHER_VAR __attribute__((section("ETHER_VAR_SECT")))
#define FAST_ETHER_VAR_REL __attribute__((section("ETHER_VAR_SECT_REL")))
#else
#define FAST_ETHER_VAR
#define FAST_ETHER_VAR_REL
#endif
#ifdef FAST_ETHERNET_STACK
#define FAST_ETHER_STK __attribute__((section("ETHER_STK_SECT")))
#else
#define FAST_ETHER_STK
#endif
#ifdef FAST_IP_VARIABLES
#define FAST_IP_VAR __attribute__((section("IP_VAR_SECT")))
#define FAST_IP_VAR_REL __attribute__((section("IP_VAR_SECT_REL")))
#else
#define FAST_IP_VAR
#define FAST_IP_VAR_REL
#endif
#ifdef FAST_IP_STACK
#define FAST_IP_STK __attribute__((section("IP_STK_SECT")))
#else
#define FAST_IP_STK
#endif
#ifdef FAST_TCP_VARIABLES
#define FAST_TCP_VAR __attribute__((section("TCP_VAR_SECT")))
#define FAST_TCP_VAR_REL __attribute__((section("TCP_VAR_SECT_REL")))
#else
#define FAST_TCP_VAR
#define FAST_TCP_VAR_REL
#endif
#ifdef FAST_TCP_STACK
#define FAST_TCP_STK __attribute__((section("TCP_STK_SECT")))
#else
#define FAST_TCP_STK
#endif
#ifdef FAST_HTTP_STACK
#define FAST_HTTP_STK __attribute__((section("HTTP_STK_SECT")))
#else
#define FAST_HTTP_STK
#endif
#ifdef FAST_FTP_STACK
#define FAST_FTP_STK __attribute__((section("FTP_STK_SECT")))
#else
#define FAST_FTP_STK
#endif
#ifdef FAST_WIFI_STACK
#define FAST_WIFI_STK __attribute__((section("WIFI_STK_SECT")))
#else
#define FAST_WIFI_STK
#endif
#ifdef FAST_PPP_STACK
#define FAST_PPP_STK __attribute__((section("PPP_STK_SECT")))
#else
#define FAST_PPP_STK
#endif
#ifdef FAST_COMMAND_STACK
#define FAST_COMMAND_STK __attribute__((section("COMMAND_STK_SECT")))
#else
#define FAST_COMMAND_STK
#endif
#ifdef FAST_BUFFERS_VARIABLES
#define FAST_BUFF_VAR __attribute__((section("BUFFERS_VAR_SECT")))
#define FAST_BUFF_VAR_REL __attribute__((section("BUFFERS_VAR_SECT_REL")))
#else
#define FAST_BUFF_VAR
#define FAST_BUFF_VAR_REL
#endif
#ifdef FAST_TLS_VARIABLES
#define FAST_TLS_VAR __attribute__((section("TLS_VAR_SECT")))
#define FAST_TLS_VAR_REL __attribute__((section("TLS_VAR_SECT_REL")))
#else
#define FAST_TLS_VAR
#define FAST_TLS_VAR_REL
#endif
#ifdef FAST_USB_VARIABLES
#define FAST_USB_VAR __attribute__((section("USB_VAR_SECT")))
#define FAST_USB_VAR_REL __attribute__((section("USB_VAR_SECT_REL")))
#else
#define FAST_USB_VAR
#define FAST_USB_VAR_REL
#endif
#ifdef FAST_USB_STACK
#define FAST_USB_STK __attribute__((section("USB_STK_SECT")))
#else
#define FAST_USB_STK
#endif
 
#define DO_NOT_CACHE __attribute__((section("NO_CACHE_SECT")))
 
#define FIRST_UNUSED_TIMER (-1)
 
/* Config server stuff */
#define NumberOfConfigWebChannels 12
#define ConfigActionIdleTimeout (TICKS_PER_SECOND * 30)
#define MAX_HDR_SIZE (256) /* Size of web client recieve single header maximum*/
 
 
#define NUM_DNS_CACHE (16)
 
#endif /* #ifndef _CONSTANTS_H */