TCPIPConfig.h

Go to the documentation of this file.

#ifndef __TCPIPCONFIG_H
#define __TCPIPCONFIG_H

#include "TCPIP.h"
#include "projectdefs.h"

// =======================================================================
//   Application Options
// =======================================================================

/* Application Level Module Selection
 *   Uncomment or comment the following lines to enable or
 *   disabled the following high-level application modules.
 */
#define STACK_USE_ICMP_SERVER
#define STACK_USE_HTTP2_SERVER
#define STACK_USE_DHCP_CLIENT
#define STACK_USE_MPFS2

/* MPFS File Handles
 *   Maximum number of simultaneously open MPFS2 files.
 *   For MPFS Classic, this has no effect.
 */
#define MAX_MPFS_HANDLES                (5ul)

// =======================================================================
//   Transport Layer Options
// =======================================================================

/* Transport Layer Configuration
 *   The following low level modules are automatically enabled
 *   based on module selections above.  If your custom module
 *   requires them otherwise, enable them here.
 */
#define STACK_USE_TCP
#define STACK_USE_UDP

/* Client Mode Configuration
 *   Uncomment following line if this stack will be used in CLIENT
 *   mode.  In CLIENT mode, some functions specific to client operation
 *   are enabled.
 */
#define STACK_CLIENT_MODE

/* TCP Socket Memory Allocation
 *   TCP needs memory to buffer incoming and outgoing data.  The 
 *   amount and medium of storage can be allocated on a per-socket
 *   basis using the example below as a guide.
 */
    // Allocate how much total RAM (in bytes) you want to allocate 
    // for use by your TCP TCBs, RX FIFOs, and TX FIFOs.  
    #define TCP_ETH_RAM_SIZE                    (5220ul)
    #define TCP_PIC_RAM_SIZE                    (0ul)
    #define TCP_SPI_RAM_SIZE                    (0ul)
    #define TCP_SPI_RAM_BASE_ADDRESS            (0x00)
    
    // Define names of socket types
    #define TCP_SOCKET_TYPES
        #define TCP_PURPOSE_GENERIC_TCP_CLIENT 0
        #define TCP_PURPOSE_GENERIC_TCP_SERVER 1
        #define TCP_PURPOSE_TELNET 2
        #define TCP_PURPOSE_FTP_COMMAND 3
        #define TCP_PURPOSE_FTP_DATA 4
        #define TCP_PURPOSE_TCP_PERFORMANCE_TX 5
        #define TCP_PURPOSE_TCP_PERFORMANCE_RX 6
        #define TCP_PURPOSE_UART_2_TCP_BRIDGE 7
        #define TCP_PURPOSE_HTTP_SERVER 8
        #define TCP_PURPOSE_DEFAULT 9
        #define TCP_PURPOSE_BERKELEY_SERVER 10
        #define TCP_PURPOSE_BERKELEY_CLIENT 11
    #define END_OF_TCP_SOCKET_TYPES
    
    #if defined(__TCP_C)
        // Define what types of sockets are needed, how many of 
        // each to include, where their TCB, TX FIFO, and RX FIFO
        // should be stored, and how big the RX and TX FIFOs should 
        // be.  Making this initializer bigger or smaller defines 
        // how many total TCP sockets are available.
        //
        // Each socket requires up to 48 bytes of PIC RAM and 
        // 40+(TX FIFO size)+(RX FIFO size) bytes bytes of 
        // TCP_*_RAM each.
        // Note: The RX FIFO must be at least 1 byte in order to 
        // receive SYN and FIN messages required by TCP.  The TX 
        // FIFO can be zero if desired.
        #define TCP_CONFIGURATION
        ROM struct
        {
            BYTE vSocketPurpose;
            BYTE vMemoryMedium;
            WORD wTXBufferSize;
            WORD wRXBufferSize;
        } TCPSocketInitializer[] = 
        {
            {TCP_PURPOSE_HTTP_SERVER, TCP_ETH_RAM, 1500, 500},

            PROJECT_SOCKET_CONFIGURATION
        };
        #define END_OF_TCP_CONFIGURATION
    #endif

/* UDP Socket Configuration
 *   Define the maximum number of available UDP Sockets, and whether
 *   or not to include a checksum on packets being transmitted.
 */
#define MAX_UDP_SOCKETS     (5u)
#define UDP_USE_TX_CHECKSUM     // This slows UDP TX performance by nearly 50%

// =======================================================================
//   Application-Specific Options
// =======================================================================

// -- HTTP2 Server options -----------------------------------------------

    // Maximum numbers of simultaneous HTTP connections allowed.
    // Each connection consumes 2 bytes of RAM and a TCP socket
    #define MAX_HTTP_CONNECTIONS    (1u)
    
    // Indicate what file to serve when no specific one is requested
    #define HTTP_DEFAULT_FILE       "index.htm"
    #define HTTPS_DEFAULT_FILE      "index.htm"
    #define HTTP_DEFAULT_LEN        (10u)           // For buffer overrun protection.
                                                // Set to longest length of above two strings.

    #define HTTP_USE_POST                   // Enable POST support
#endif

---