/home/jander/temp/etherdune/config.h

Go to the documentation of this file.

// EtherDune configuration file
// Author: Javier Peletier <jm@friendev.com>
// Summary: EtherDune settings, buffer sizes, compilation options, etc
//
// Copyright (c) 2015 All Rights Reserved, http://friendev.com
//
// This source is subject to the GPLv2 license.
// Please see the License.txt file for more information.
// All other rights reserved.
//
// THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY 
// KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
// PARTICULAR PURPOSE.

#ifndef __EtherDune_CONFIG__
#define __EtherDune_CONFIG__

#include <ACross.h>


static const uint16_t NETWORK_TIMER_RESOLUTION = 200;



#define EtherDune_BUFFER_SIZE 566 


#define EtherDune_SAMPLE_SIZE 42  



#define ENABLE_IP_RX_CHECKSUM true

#define ENABLE_UDPTCP_RX_CHECKSUM true

#define ENABLE_ICMP_RX_CHECKSUM true 



#define MAX_FRAMELEN      1500

#define RXBUFFER_SIZE 3072 
#define TXBUFFER_SIZE 1024  



static const uint8_t TCP_SRC_PORT_H = 250; 

static const uint8_t UDP_SRC_PORT_H = 240;

static const uint16_t TCP_MAXIMUM_SEGMENT_SIZE = 512; 
static const uint8_t MAX_TCP_CONNECT_RETRIES = 50; 


    #define SCK_TIMEOUT_SYN_SENT_MS  5000 
    #define SCK_TIMEOUT_SYN_RECEIVED_MS  5000 
    #define SCK_TIMEOUT_FIN_WAIT_1_MS  6000 
    #define SCK_TIMEOUT_FIN_WAIT_2_MS  2000 
    #define SCK_TIMEOUT_CLOSE_WAIT_MS  2000 
    #define SCK_TIMEOUT_CLOSING_MS  2000 
    #define SCK_TIMEOUT_LAST_ACK_MS  2000 
    #define SCK_TIMEOUT_TIME_WAIT_MS  3000 
    #define SCK_TIMEOUT_RESOLVING_MS  3000 



static const uint8_t ARP_TABLE_LENGTH = 2; 
static const int16_t MAX_ARP_TTL = 20; 



#define DNS_TIMEOUT_QUERY_MS 5000 




#define ENABLE_DHCP_HOSTNAME _DEBUG

static const char DHCP_HOSTNAME[] PROGMEM = "ARDUINO"; 


    #define DHCP_TIMEOUT_SELECTING_MS  1000 
    #define DHCP_TIMEOUT_REQUESTING_MS  5000 
    #define DHCP_TIMEOUT_BOUND_MS  1000 

    static const uint8_t DHCP_MAX_ATTEMPTS = 4; 

    static const uint16_t DHCP_DEFAULT_RENEWAL_TIMER_S = 7200; 




static const uint8_t ICMP_PING_DATA_LENGTH = 32; 


#define HTTP_SERVER_HEADER_NAME_MAX_LENGTH 20 
#define HTTP_SERVER_HEADER_VALUE_MAX_LENGTH 20 
#define HTTP_SERVER_QUERY_STRING_MAX_LENGTH 41 

// ----------------- END OF CONFIGURATION ------------------------

// what follows are just computed values based on the above.

#ifndef DOXYGEN_SHOULD_SKIP_THIS

#define RXSTART_INIT  0x0000  
#define RXSTOP_INIT (RXBUFFER_SIZE-1)  

#define TX_STATUS_VECTOR_SIZE  15 

#define TXSTART_INIT  (RXSTOP_INIT + 1)  
#define TXSTOP_INIT  (TXSTART_INIT + TXBUFFER_SIZE - 1)  

#define ENC28J60_MEMSIZE  8192 

#define SHARED_BUFFER_INIT  (TXSTOP_INIT + 1 + TX_STATUS_VECTOR_SIZE) 
#define SHARED_BUFFER_CAPACITY  (ENC28J60_MEMSIZE - SHARED_BUFFER_INIT) 

#define TXSTART_INIT_DATA (TXSTART_INIT + 1) // skip 1 byte to make room for the control byte required by ENC28J60

static const uint16_t i2 = TXSTOP_INIT;
static const uint16_t i1 = SHARED_BUFFER_INIT;

#define NTICKS(ms) ((ms)/NETWORK_TIMER_RESOLUTION)

static const uint8_t SCK_TIMEOUT_SYN_SENT = NTICKS(SCK_TIMEOUT_SYN_SENT_MS); // (client) represents waiting for a matching connection request after having sent a connection request.
static const uint8_t SCK_TIMEOUT_SYN_RECEIVED = NTICKS(SCK_TIMEOUT_SYN_RECEIVED_MS); //(server) SYN has been received, SYN ACK was sent and now waiting for ACK.
static const uint8_t SCK_TIMEOUT_FIN_WAIT_1 = NTICKS(SCK_TIMEOUT_FIN_WAIT_1_MS); // (both server and client) represents waiting for a connection termination request from the remote TCP, or an acknowledgment of the connection termination request previously sent.
static const uint8_t SCK_TIMEOUT_FIN_WAIT_2 = NTICKS(SCK_TIMEOUT_FIN_WAIT_2_MS); // (both server and client) represents waiting for a connection termination request from the remote TCP.
static const uint8_t SCK_TIMEOUT_CLOSE_WAIT = NTICKS(SCK_TIMEOUT_CLOSE_WAIT_MS); // (both server and client) represents waiting for a connection termination request from the local user.
static const uint8_t SCK_TIMEOUT_CLOSING = NTICKS(SCK_TIMEOUT_CLOSING_MS); // (both server and client) represents waiting for a connection termination request acknowledgment from the remote TCP.
static const uint8_t SCK_TIMEOUT_LAST_ACK = NTICKS(SCK_TIMEOUT_LAST_ACK_MS); // (both server and client) represents waiting for an acknowledgment of the connection termination request previously sent to the remote TCP (which includes an acknowledgment of its connection termination request).
static const uint8_t SCK_TIMEOUT_TIME_WAIT = NTICKS(SCK_TIMEOUT_TIME_WAIT_MS); //(either server or client) represents waiting for enough time to pass to be sure the remote TCP received the acknowledgment of its connection termination request. [According to RFC 793 a connection can stay in TIME-WAIT for a maximum of four minutes known as a MSL (maximum segment lifetime).]
static const uint8_t SCK_TIMEOUT_RESOLVING = NTICKS(SCK_TIMEOUT_RESOLVING_MS); // waiting for a DNS query to resolve

static const uint8_t DNS_TIMEOUT_QUERY = NTICKS(DNS_TIMEOUT_QUERY_MS);//DNS timeout

static const uint8_t DHCP_TIMEOUT_SELECTING = NTICKS(DHCP_TIMEOUT_SELECTING_MS);
static const uint8_t DHCP_TIMEOUT_REQUESTING = NTICKS(DHCP_TIMEOUT_REQUESTING_MS);
static const uint8_t DHCP_TIMEOUT_BOUND = NTICKS(DHCP_TIMEOUT_BOUND_MS); 
static const uint16_t DHCP_DEFAULT_RENEWAL_TIMER = DHCP_DEFAULT_RENEWAL_TIMER_S * 1000 / DHCP_TIMEOUT_BOUND_MS;

#define QUOTE(str) #str

//error checking

#if EtherDune_BUFFER_SIZE < 566
#error EtherDune_BUFFER_SIZE must be at least 566 bytes
#endif

//see EtherDune_SAMPLE_SIZE definition above to see why 42
#if EtherDune_SAMPLE_SIZE < 42
#error EtherDune_SAMPLE_SIZE must be at least 42 bytes
#endif

#if EtherDune_SAMPLE_SIZE > EtherDune_BUFFER_SIZE
#error EtherDune_SAMPLE_SIZE must be less than EtherDune_BUFFER_SIZE
#endif

#if EtherDune_BUFFER_SIZE & 1
#error EtherDune_BUFFER_SIZE must be an even number
#endif

#define BUFFER_END (SHARED_BUFFER_INIT + SHARED_BUFFER_CAPACITY)

#if (BUFFER_END) != (ENC28J60_MEMSIZE)
#error Memory mapping error
#endif

#if RXBUFFER_SIZE & 1
#error RXBUFFER_SIZE must be an even number
#endif

#if (SHARED_BUFFER_CAPACITY) < 2048
#error Resulting shared buffer capacity is too small. Reduce TXBUFFER_SIZE or RXBUFFER_SIZE to allow for more shared buffer.
#endif

#endif


#endif