2.9 TCPIP Lite Driver Library

• struct arpHeader_t

  Contains the ARP information.

• struct arpMap_t

  Contains the ARP database.

• void ARPV4_Init (void)

  Initializes the ARP table.

• error_msg ARPV4_Packet (void)

  Receives all ARP packets on the network and searches the ARP table for an existing ARP entry. If present, it updates the table. If the ARP packet is for the device and its operation is REQUEST, the function replies with the device MAC address.

• void ARPV4_Update (void)

  Updates the ARP table at least every 10s to avoid aging.

• mac48Address_t * ARPV4_Lookup (uint32_t ipAddress)

  Maintains an ARP table which maps hardware address to internet address.

• error_msg ARPV4_Request (uint32_t destAddress)

  Sends the ARP Request.

void ARPV4_Init (void )

Initializes the ARP table.

mac48Address_t* ARPV4_Lookup (uint32_t ipAddress)

Maintains an ARP table which maps hardware address to internet address.

error_msg ARPV4_Packet (void )

Receives all ARP packets on the network and searches the ARP table for an existing ARP entry. If present, it updates the table. If the ARP packet is for the device and its operation is REQUEST, the function replies with the device MAC address.

error_msg ARPV4_Request (uint32_t destAddress)

Sends the ARP Request.

void ARPV4_Update (void )

Updates the ARP table at least every 10s to avoid aging.

• struct dhcp_data_t

  Contains option data.

• struct dhcp_state_t

  Contains state data.

• enum dhcp_type { DHCP_DISCOVER = 1, DHCP_OFFER, DHCP_REQUEST, DHCP_DECLINE, DHCP_ACK, DHCP_NACK, DHCP_RELEASE, DHCP_INFORM, DHCP_FORCERENEW, DHCP_LEASEQUERY, DHCP_LEASEUNASSIGNED, DHCP_LEASEUNKNOWN, DHCP_LEASEACTIVE, DHCP_BULKLEASEQUERY, DHCP_LEASEQUERYDONE }

  Contains DCHP request types.

• enum dhcp_rx_client_state { SELECTING, REQUESTING, RENEWLEASE, BOUND }

  Contains the DCHP RX Client state.

• enum dhcp_timer_client_state { INIT_TIMER, WAITFORTIMER, STARTDISCOVER, STARTREQUEST }

  Contains the DCHP Timer Client state.

• bool sendDHCPDISCOVER (void)

  Sends the DHCP DISCOVER request.

• bool sendDHCPREQUEST (void)

  Sends the DHCP REQUEST request.

• bool sendDHCPDECLINE (void)

  Sends DHCP DECLINE request.

• bool sendRequest (dhcp_type type)

  Sends a DHCP request.

• void DHCP_init (void)

  Initializes the DHCP.

• void DHCP_Handler (int16_t length)

  Receives and processes the DHCP packet.

• void DHCP_Manage (void)

  Updates the DHCP status at least every one second.

• void DHCP_WriteZeros (uint16_t length)

  Writes zeroes for the number of bytes passed.

void DHCP_Handler (int16_t length)

Receives and processes the DHCP packet.

void DHCP_init (void )

Initializes the DHCP.

void DHCP_Manage (void )

Updates the DHCP status at least every one second.

void DHCP_WriteZeros (uint16_t length)

Writes zeroes for the number of bytes passed.

bool sendDHCPDECLINE (void )

Sends DHCP DECLINE request.

bool sendDHCPDISCOVER (void )

Sends the DHCP DISCOVER request.

bool sendDHCPREQUEST (void )

Sends the DHCP REQUEST request.

bool sendRequest (dhcp_type type)

Sends a DHCP request.

enum dhcp_rx_client_state

Contains the DCHP RX Client state.

enum dhcp_timer_client_state

Contains the DCHP Timer Client state.

enum dhcp_type

Contains DCHP request types.

• static int generateSeed (void)

  Generates the seed.

• void DNS_Init (void)

  Initializes the DNS table.

• void DNS_Query (const char *str)

  Searches the DNS server for the IPv4 (type A) addresses of the domain names.

• void DNS_Handler (int16_t length)

  Receives and processes the DNS packet.

• uint32_t DNS_Lookup (const char *dns_name)

  Maintains the DNS table and maps Domain names to the Internet address.

• void DNS_Update (void)

  Updates the DNS table at least every 10s to avoid aging.

void DNS_Handler (int16_t length)

Receives and processes the DNS packet.

void DNS_Init (void )

Initializes the DNS table.

uint32_t DNS_Lookup (const char * dns_name)

Maintains the DNS table and maps Domain names to the Internet address.

void DNS_Query (const char * str)

Searches the DNS server for the IPv4 (type A) addresses of the domain names.

void DNS_Update (void )

Updates the DNS table at least every 10s to avoid aging.

static int generateSeed (void )[static]

Generates the seed.

• error_msg ICMP_Receive (ipv4Header_t *ipv4Hdr)

  Receives the ICMP packet. This function processes only Echo Request messages.

• error_msg ICMP_EchoReply (ipv4Header_t *ipv4Hdr)

  Sends an Echo Reply packet to the destination.

• error_msg ICMP_PortUnreachable (uint32_t srcIPAddress, uint32_t destIPAddress, uint16_t length)

  Sends Port Unreachable messages to the destination.

• bool isPortUnreachable (uint16_t port)

  Checks if the Port Unreachable flag is set to the port number of the application.

• void resetPortUnreachable (void)

  Resets the Port Unreachable flag to zero.

error_msg ICMP_EchoReply (ipv4Header_t * ipv4Hdr)

Sends an Echo Reply packet to the destination.

error_msg ICMP_PortUnreachable (uint32_t srcIPAddress, uint32_t destIPAddress, uint16_t length)

Sends Port Unreachable messages to the destination.

error_msg ICMP_Receive (ipv4Header_t * ipv4Hdr)

Receives the ICMP packet. This function processes only Echo Request messages.

bool isPortUnreachable (uint16_t port)

Checks if the Port Unreachable flag is set to the port number of the application.

void resetPortUnreachable (void )

Resets the Port Unreachable flag to zero.

• struct ip_db_info_t

  Contains IP information.

• void ipdb_init (void)

  Initializes the IP database.

• uint32_t makeStrToIpv4Address (char *str)

  Converts a string into a 32-bit IPv4 address.

• char * makeIpv4AddresstoStr (uint32_t addr)

  Converts an IPv4 address into a string.

• void TCP_Recv (uint32_t remoteAddress, uint16_t length)

  Receives TCP packets.

• static uint8_t getHeaderLen (void)

  Returns the header length.

• error_msg IPV4_Packet (void)

  Receives the IPv4 packet. This function reads the IPv4 header and filters the upper layer protocols.

• error_msg IPv4_Start (uint32_t dstAddress, ipProtocolNumbers protocol)

  Starts the IPv4 packet. This routine starts the Ethernet packet and writes the IPv4 header. Initially Checksum and Payload length are set to '0'. An error code is returned if there has been an error in accepting, or if something goes wrong.

• uint16_t IPV4_PseudoHeaderChecksum (uint16_t payloadLen)

  Computes the pseudo-header checksum for transport layer protocols.

• error_msg IPV4_Send (uint16_t payloadLength)

  Sends the IPv4 packet. This function inserts the total length of IPv4 packet, computes and adds the Ipv4 header checksum.

• uint16_t IPV4_GetDatagramLength (void)

  Returns the length of the IPv4 datagram.

static uint8_t getHeaderLen (void )[static]

Returns the header length.

void ipdb_init (void )

Initializes the IP database.

uint16_t IPV4_GetDatagramLength (void )

Returns the length of the IPv4 datagram.

error_msg IPV4_Packet (void )

Receives the IPv4 packet. This function reads the IPv4 header and filters the upper layer protocols.

uint16_t IPV4_PseudoHeaderChecksum (uint16_t payloadLen)

Computes the pseudo-header checksum for transport layer protocols.

error_msg IPV4_Send (uint16_t payloadLength)

Sends the IPv4 packet. This function inserts the total length of IPv4 packet, computes and adds the Ipv4 header checksum.

error_msg IPv4_Start (uint32_t dstAddress, ipProtocolNumbers protocol)

Starts the IPv4 packet. This routine starts the Ethernet packet and writes the IPv4 header. Initially Checksum and Payload length are set to '0'. An error code is returned if there has been an error in accepting, or if something goes wrong.

char* makeIpv4AddresstoStr (uint32_t addr)

Converts an IPv4 address into a string.

uint32_t makeStrToIpv4Address (char * str)

Converts a string into a 32-bit IPv4 address.

void TCP_Recv (uint32_t remoteAddress, uint16_t length)

Receives TCP packets.

Receives TCP packets.

• struct lldp_tx_port_t

  Per-interface structure for TX, part of lldp_port.

• struct lldp_rx_port_t

  Per-interface structure for RX, part of lldp_port.

• struct lldp_per_port_t

  LLDP per port.

• struct lldp_tx_timers_t

  LLDP TX timers.

• struct createBasicTLV_t

  Creates a basic Type-Length-Value (TLV).

• struct createOrgTLV_t

  Creates Organizationally Specific TLV.

• struct orgSpecificTLVs_t

  Initializes the Organizationally Specific TLV.

• union orgProcessFlags

  Process flags.

• enum lldp_admin_status { disabled =0, enabledTxOnly = 1, enabledRxOnly = 2, enabledRxTx = 3 }

  Contains the LLDP admin status.

• enum lldp_txTimerStates_t { TX_TIMER_INITIALIZE, TX_TIMER_IDLE, TX_TIMER_EXPIRES, TX_TICK, SIGNAL_TX, TX_FAST_START }

  LLDP TX Timer states.

• enum lldp_txStates_t { TX_LLDP_INITIALIZE, TX_IDLE, TX_INFO_FRAME, TX_SHUTDOWN_FRAME }

  LLDP TX states.

• enum lldp_rxStates_t { LLDP_WAIT_PORT_OPERATIONAL, RX_LLDP_INITIALIZE, RX_WAIT_FOR_FRAME, RX_FRAME }

  LLDP RX states.

• enum TLV_TYPES { END_LLDPDU_TLV =0, CHASSIS_ID_TLV, PORT_ID_TLV, TIME_TO_LIVE_TLV, PORT_DESCRIPTION_TLV, SYSTEM_NAME_TLV, SYSTEM_DESCRIPTION_TLV, SYSTEM_CAPABILITIES_TLV, MANAGEMENT_ADDRESS_TLV, ORG_SPECIFIC_TLV =127 }

  Mandatory and optional TLV types from IEEE 802.1AB.

• enum CHASSIS_SUBTYPE { CHASSIS_COMPONENT =1, CHASSIS_INTERFACE_ALIAS, CHASSIS_PORT_COMPONENT, CHASSIS_MAC_ADDRESS, CHASSIS_NETWORK_ADDRESS, CHASSIS_INTERFACE_NAME, CHASSIS_LOCALLY_ASSIGNED }

  TLV subtypes from section 9 of IEEE 802.1AB.

• enum PORT_SUBTYPE { reserved, PORT_INTERFACE_ALIAS =1, PORT_COMPONENT, PORT_MAC_ADDRESS, PORT_NETWORK_ADDRESS, PORT_INTERFACE_NAME, PORT_AGENT_CIRCUIT_ID, PORT_LOCALLY_ASSIGNED }

  TLV subtypes from section 9 of IEEE 802.1AB.

• enum ORG_IEEE_3_SUBTYPE { res, IEEE_3_MAC_PHY_CONFIG =1, IEEE_3_POWER_VIA_MDI, IEEE_3_LINK_AGGREGATION, IEEE_3_MAX_FRAME_SIZE, IEEE_3_ENERGY_EFFICIENT_ETHERNET }

  Organizationally Specific TLVs from section 79.3 of IEEE 802.3.

• enum ORG_TIA_SUBTYPE { res1, TIA_LLDP_MED =1, TIA_NETWORK_POLICY, TIA_LOCATION_ID, TIA_EXTENDED_POWER_VIA_MDI, TIA_INVENT_HW_REV, TIA_INVENT_FW_REV, TIA_INVENT_SW_REV, TIA_INVENT_SERIAL_NUM, TIA_INVENT_MANUFACT_NAME, TIA_INVENT_MODEL_NAME, TIA_INVENT_ASSET_ID }

  Organizationally Specific TLVs from section 10 of ANSI-TIA_1057.

• enum ORG_CISCO_SUBTYPE { res2 =0, CISCO_POWER_VIA_MDI =1, CISCO_OUI_TLV, CISCO_CLASS_TLV, CISCO_PROTOCOL_TLV }

  Organizationally Specific TLVs from section 79.3 of IEEE 802.3.

• enum ORG_MUD_CISCO_SUBTYPE { res3 =0, CISCO_MUD_TLV =1 }

  Organizationally Specific TLVs from section 79.3 of IEEE 802.3.

• void LLDP_Packet (void)

  Processes LLDP packets.

• uint8_t get_org_tlvs_table_size (void)

  Gets the size of the table that stores Organizationally Specific TLVs.

• void LLDP_Run (void)

  Runs the LLDP.

• void LLDP_InitRx (void)

  Initializes the LLDP RX.

• void LLDP_InitTx (void)

  Initializes the LLDP TX.

• void LLDP_InitRxTx (void)

  Initializes the LLDP RX and TX.

• void LLDP_DecTTR (void)

  Decreases the LLDP TX timer value.

• void LLDP_SetDesiredPower (uint16_t pwr)

  Sets the LLDP desired power.

• uint16_t LLDP_GetAllocatedPower (void)

  Gets the LLDP allocated power.

• void LLDP_setPortDescription (const char *val)

  Sets the LLDP port description.

• char * LLDP_getPortDescription (void)

  Gets the LLDP port description.

• char * LLDP_getInfo (char *Name)

  Gets the LLDP information.

• void LLDP_setAssetID (const char *val)

  Sets the LLDP asset ID.

• char * LLDP_getAssetID (void)

  Gets the LLDP asset ID.

• void LLDP_setModelName (const char *val)

  Sets the LLDP module name.

• char * LLDP_getModelName (void)

  Gets the LLDP module name.

• void LLDP_setManufacturer (const char *val)

  Sets the LLDP manufacturer.

• char * LLDP_getManufacturer (void)

  Gets the LLDP manufacturer.

• void LLDP_setSerialNumber (const char *val)

  Sets the LLDP serial number.

• char * LLDP_getSerialNumber (void)

  Gets the LLDP serial number.

• void LLDP_setSoftwareRevision (const char *val)

  Sets the LLDP software revision.

• char * LLDP_getSoftwareRevision (void)

  Gets the LLDP software revision.

• void LLDP_setHardwareRevision (const char *val)

  Sets the LLDP hardware revision.

• char * LLDP_getHardwareRevision (void)

  Gets the LLDP hardware revision.

• void LLDP_setFirmwareRevision (const char *val)

  Sets the LLDP firmware revision.

• char * LLDP_getFirmwareRevision (void)

  Gets the LLDP firmware revision.

• void LLDP_setMUDInfo (const char *val)

  Sets the LLDP Manufacturer Usage Description (MUD) information.

• MulticastMacAddr LLDP_SetDestAddress (void)

  Sets the LLDP destination address.

uint8_t get_org_tlvs_table_size (void )

Gets the size of the table that stores Organizationally Specific TLVs.

void LLDP_DecTTR (void )

Decreases the LLDP TX timer value.

uint16_t LLDP_GetAllocatedPower (void )

Gets the LLDP allocated power.

char* LLDP_getAssetID (void )

Gets the LLDP asset ID.

char* LLDP_getFirmwareRevision (void )

Gets the LLDP firmware revision.

char* LLDP_getHardwareRevision (void )

Gets the LLDP hardware revision.

char* LLDP_getInfo (char * Name)

Gets the LLDP information.

char* LLDP_getManufacturer (void )

Gets the LLDP manufacturer.

char* LLDP_getModelName (void )

Gets the LLDP module name.

char* LLDP_getPortDescription (void )

Gets the LLDP port description.

char* LLDP_getSerialNumber (void )

Gets the LLDP serial number.

char* LLDP_getSoftwareRevision (void )

Gets the LLDP software revision.

void LLDP_InitRx (void )

Initializes the LLDP RX.

void LLDP_InitRxTx (void )

Initializes the LLDP RX and TX.

void LLDP_InitTx (void )

Initializes the LLDP TX.

void LLDP_Packet (void )

Processes LLDP packets.

void LLDP_Run (void )

Runs the LLDP.

void LLDP_setAssetID (const char * val)

Sets the LLDP asset ID.

void LLDP_SetDesiredPower (uint16_t pwr)

Sets the LLDP desired power.

MulticastMacAddr LLDP_SetDestAddress (void )

Sets the LLDP destination address.

void LLDP_setFirmwareRevision (const char * val)

Sets the LLDP firmware revision.

void LLDP_setHardwareRevision (const char * val)

Sets the LLDP hardware revision.

void LLDP_setManufacturer (const char * val)

Sets the LLDP manufacturer.

void LLDP_setModelName (const char * val)

Sets the LLDP module name.

void LLDP_setMUDInfo (const char * val)

Sets the LLDP Manufacturer Usage Description (MUD) information.

void LLDP_setPortDescription (const char * val)

Sets the LLDP port description.

void LLDP_setSerialNumber (const char * val)

Sets the LLDP serial number.

void LLDP_setSoftwareRevision (const char * val)

Sets the LLDP software revision.

enum CHASSIS_SUBTYPE

TLV subtypes from section 9 of IEEE 802.1AB.

enum lldp_admin_status

Contains the LLDP admin status.

enum lldp_rxStates_t

LLDP RX states.

enum lldp_txStates_t

LLDP TX states.

enum lldp_txTimerStates_t

LLDP TX Timer states.

enum ORG_CISCO_SUBTYPE

Organizationally Specific TLVs from section 79.3 of IEEE 802.3.

enum ORG_IEEE_3_SUBTYPE

Organizationally Specific TLVs from section 79.3 of IEEE 802.3.

enum ORG_MUD_CISCO_SUBTYPE

Organizationally Specific TLVs from section 79.3 of IEEE 802.3.

enum ORG_TIA_SUBTYPE

Organizationally Specific TLVs from section 10 of ANSI-TIA_1057.

enum PORT_SUBTYPE

TLV subtypes from section 9 of IEEE 802.1AB.

enum TLV_TYPES

Mandatory and optional TLV types from IEEE 802.1AB.

• #define NTP_TIME_OFFSET 2208988800

  The time offset converts from unix time (seconds, since January 1, 1970) to RFC 868 time (seconds, since January 1, 1900). The RFC indicates that this is sufficient until 2036.

• void NTP_Request (void)

  Sends the NTP request to the NTP server.

• void NTP_Handler (int16_t length)

  Receives and processes the NTP packet.

#define NTP_TIME_OFFSET 2208988800

The time offset converts from unix time (seconds, since January 1, 1970) to RFC 868 time (seconds, since January 1, 1900). The RFC indicates that this is sufficient until 2036.

void NTP_Handler (int16_t length)

Receives and processes the NTP packet.

void NTP_Request (void )

Sends the NTP request to the NTP server.

• struct tcpTCB_t

  Defines TCP Transmission Control Block.

• enum tcp_fsm_states_t { CLOSED = 0, LISTEN, SYN_SENT, SYN_RECEIVED, ESTABLISHED, FIN_WAIT_1, FIN_WAIT_2, CLOSE_WAIT, CLOSING, LAST_ACK, TIME_WAIT }

  TCP Finite State Machine (FSM) states.

• enum tcpEvent_t { CLOSE = 0, ACTIVE_OPEN, PASIVE_OPEN, RCV_SYN, RCV_ACK, RCV_SYNACK, RCV_FIN, RCV_FINACK, RX_PACKET, RCV_RST, RCV_RSTACK, RCV_PSHACK, TIMEOUT, NOP }

  TCP events.

• enum socketState_t { NOT_A_SOCKET = 0, SOCKET_CLOSED, SOCKET_IN_PROGRESS, SOCKET_CONNECTED, SOCKET_CLOSING }

  Socket states to be used in the application.

• enum tcpBufferState_t { NO_BUFF = 0, RX_BUFF_IN_USE, TX_BUFF_IN_USE }

  TCP Buffer state.

• enum tcp_options_t { TCP_EOP = 0u, TCP_NOP = 1u, TCP_MSS = 2u }

  TCP options.

• static error_msg TCP_FiniteStateMachine (void)

  TCP stack state machine called upon the occurrence of each event (e.g., opening/closing a connection, receiving a TCP packet).

• static error_msg TCP_TimoutRetransmit (void)

  Retransmits TCP packets after timeout.

• static void TCB_Insert (tcpTCB_t *ptr)

  Inserts a pointer to the new TCB into the TCB pointer list.

• static void TCB_Remove (tcpTCB_t *ptr)

  Removes a pointer to a TCB from the TCB pointer list and connects its adjacent items together.

• static void TCB_Reset (tcpTCB_t *tcbPtr)

  Resets the socket to a known state.

• static error_msg TCB_Check (tcpTCB_t *ptr)

  Check if there is a pointer to a socket/TCB. If the pointer is in the TCB list, then it is a valid socket.

• static error_msg TCP_Snd (tcpTCB_t *tcbPtr)

  Internal function of the TCP stack to send a TCP packet.

• error_msg TCP_PayloadSave (uint16_t len)

  Copies the TCP packet payload to the socket RX buffer. This routine also sends the ACK for the received packet and any data ready to be sent.

• static error_msg TCP_ParseTCPOptions (void)

  Reads and parses the Options field in the TCP header. This routine reads only the ones that have SYN or SYN + ACK. For the other TCP headers the field will be skipped.

• void TCP_Recv (uint32_t remoteAddress, uint16_t length)

  Identifies the destination socket and parses the TCP header. This routine is called by the IP layer for each received TCP packet.

• void TCP_Init (void)

  Initializes TCP structures, meaning certain internal TCP stack variables.

• error_msg TCP_SocketInit (tcpTCB_t *tcbPtr)

  Initializes the TCB and adds it to the list of TCB pointers. The socket needs to be put in the Closed state. The user is responsible to manage memory allocation and release.

• error_msg TCP_SocketRemove (tcpTCB_t *tcbPtr)

  Removes the socket pointer from the TCP stack, and the list of TCB pointers, respectively. After calling this routine the memory is ready to be used again.

• socketState_t TCP_SocketPoll (tcpTCB_t *socket_ptr)

  Provides an interface to read the status of the socket. This routine also checks if the pointer is already in the TCB list. This means that the socket is "in use". If the socket is in the TCB list, the socket status will be returned.

• error_msg TCP_Bind (tcpTCB_t *tcbPtr, uint16_t port)

  Assigns a port number to the specified socket. This is used for configuring the local port of a socket.

• error_msg TCP_Listen (tcpTCB_t *tcbPtr)

  Listens for connections on a socket. This routine marks the socket as passive, meaning that it will be used to accept incoming connection requests.

• error_msg TCP_Connect (tcpTCB_t *tcbPtr, sockaddr_in4_t *srvaddr)

  Starts the client for a particular socket.

• error_msg TCP_Close (tcpTCB_t *tcbPtr)

  Closes the TCP connection. This initiates the closing sequence for the TCP connection.

• error_msg TCP_Send (tcpTCB_t *tcbPtr, uint8_t *data, uint16_t dataLen)

  Sends a buffer to a remote machine using a TCP connection. This routine adds the buffer to the socket and the payload is sent as soon as possible.

• error_msg TCP_SendDone (tcpTCB_t *tcbPtr)

  Checks if the TX buffer was sent. This means that the data was received correctly by the remote machine and the TX buffer memory can be reused by the application.

• error_msg TCP_InsertRxBuffer (tcpTCB_t *tcbPtr, uint8_t *data, uint16_t data_len)

  Adds the RX buffer to the socket.

• int16_t TCP_GetReceivedData (tcpTCB_t *tcbPtr)

  Reads the available data from the socket. This routine provides the start address of the received buffer to the user.

• int16_t TCP_GetRxLength (tcpTCB_t *tcbPtr)

  Checks and returns the number of available bytes received on a socket.

• void TCP_Update (void)

  Handles the TCP stack time-outs for each available socket. This routine needs to be called periodically.

static error_msg TCB_Check (tcpTCB_t * ptr)[static]

Check if there is a pointer to a socket/TCB. If the pointer is in the TCB list, then it is a valid socket.

static void TCB_Insert (tcpTCB_t * ptr)[static]

Inserts a pointer to the new TCB into the TCB pointer list.

static void TCB_Remove (tcpTCB_t * ptr)[static]

Removes a pointer to a TCB from the TCB pointer list and connects its adjacent items together.

static void TCB_Reset (tcpTCB_t * tcbPtr)[static]

Resets the socket to a known state.

error_msg TCP_Bind (tcpTCB_t * tcbPtr, uint16_t port)

Assigns a port number to the specified socket. This is used for configuring the local port of a socket.

error_msg TCP_Close (tcpTCB_t * tcbPtr)

Closes the TCP connection. This initiates the closing sequence for the TCP connection.

error_msg TCP_Connect (tcpTCB_t * tcbPtr, sockaddr_in4_t * srvaddr)

Starts the client for a particular socket.

static error_msg TCP_FiniteStateMachine (void )[static]

TCP stack state machine called upon the occurrence of each event (e.g., opening/closing a connection, receiving a TCP packet).

int16_t TCP_GetReceivedData (tcpTCB_t * tcbPtr)

Reads the available data from the socket. This routine provides the start address of the received buffer to the user.

int16_t TCP_GetRxLength (tcpTCB_t * tcbPtr)

Checks and returns the number of available bytes received on a socket.

void TCP_Init (void )

Initializes TCP structures, meaning certain internal TCP stack variables.

error_msg TCP_InsertRxBuffer (tcpTCB_t * tcbPtr, uint8_t * data, uint16_t data_len)

Adds the RX buffer to the socket.

error_msg TCP_Listen (tcpTCB_t * tcbPtr)

Listens for connections on a socket. This routine marks the socket as passive, meaning that it will be used to accept incoming connection requests.

static error_msg TCP_ParseTCPOptions (void )[static]

Reads and parses the Options field in the TCP header. This routine reads only the ones that have SYN or SYN + ACK. For the other TCP headers the field will be skipped.

error_msg TCP_PayloadSave (uint16_t len)

Copies the TCP packet payload to the socket RX buffer. This routine also sends the ACK for the received packet and any data ready to be sent.

void TCP_Recv (uint32_t remoteAddress, uint16_t length)

Identifies the destination socket and parses the TCP header. This routine is called by the IP layer for each received TCP packet.

Receives TCP packets.

error_msg TCP_Send (tcpTCB_t * tcbPtr, uint8_t * data, uint16_t dataLen)

Sends a buffer to a remote machine using a TCP connection. This routine adds the buffer to the socket and the payload is sent as soon as possible.

error_msg TCP_SendDone (tcpTCB_t * tcbPtr)

Checks if the TX buffer was sent. This means that the data was received correctly by the remote machine and the TX buffer memory can be reused by the application.

static error_msg TCP_Snd (tcpTCB_t * tcbPtr)[static]

Internal function of the TCP stack to send a TCP packet.

error_msg TCP_SocketInit (tcpTCB_t * tcbPtr)

Initializes the TCB and adds it to the list of TCB pointers. The socket needs to be put in the Closed state. The user is responsible to manage memory allocation and release.

socketState_t TCP_SocketPoll (tcpTCB_t * socket_ptr)

Provides an interface to read the status of the socket. This routine also checks if the pointer is already in the TCB list. This means that the socket is "in use". If the socket is in the TCB list, the socket status will be returned.

error_msg TCP_SocketRemove (tcpTCB_t * tcbPtr)

Removes the socket pointer from the TCP stack, and the list of TCB pointers, respectively. After calling this routine the memory is ready to be used again.

static error_msg TCP_TimoutRetransmit (void )[static]

Retransmits TCP packets after timeout.

void TCP_Update (void )

Handles the TCP stack time-outs for each available socket. This routine needs to be called periodically.

enum socketState_t

Socket states to be used in the application.

enum tcp_fsm_states_t

TCP Finite State Machine (FSM) states.

enum tcp_options_t

TCP options.

enum tcpBufferState_t

TCP Buffer state.

enum tcpEvent_t

TCP events.

• struct store_handler_t

  Storage handler.

• enum tftp_client_state { tftp_read = 1, tftp_write, tftp_data, tftp_ack, tftp_error, tftp_optack }

  TFTP Client state.

• enum tftp_opcode { TFTP_READ_REQUEST =0x0001, TFTP_WRITE_REQUEST, TFTP_DATA, TFTP_ACK, TFTP_ERROR, TFTP_OPTACK }

  TFTP opcode.

• void TFTP_Ack (uint8_t opcode)

  Sends an acknowledgement on receiving a packet from a TFTP Server.

• error_msg TFTP_Read_Write_Request (uint8_t opcode)

  Sends a read or write request to the TFTP server depending on the opcode.

• void TFTP_Handler (int16_t length)

  Processes a TFTP message as per the opcode in the packet.

• void Process_TFTP_Data (uint32_t address, char *data, uint16_t length)

  Processes TFTP packets with 'data' opcode and blocks of the specified size. Depending on TFTP_callBackTable, the storage can be in EEPROM, Flash, etc.

• void TFTP_Configure (uint32_t tftp_server_address, char *tftp_filename, char *tftp_block_size)

  Allows the user to configure the TFTP server options.

• uint16_t store_type = 0

void Process_TFTP_Data (uint32_t address, char * data, uint16_t length)

Processes TFTP packets with 'data' opcode and blocks of the specified size. Depending on TFTP_callBackTable, the storage can be in EEPROM, Flash, etc.

void TFTP_Ack (uint8_t opcode)

Sends an acknowledgement on receiving a packet from a TFTP Server.

void TFTP_Configure (uint32_t tftp_server_address, char * tftp_filename, char * tftp_block_size)

Allows the user to configure the TFTP server options.

void TFTP_Handler (int16_t length)

Processes a TFTP message as per the opcode in the packet.

error_msg TFTP_Read_Write_Request (uint8_t opcode)

Sends a read or write request to the TFTP server depending on the opcode.

enum tftp_client_state

TFTP Client state.

enum tftp_opcode

TFTP opcode.

store_type = 0

Default storage type for TFTP handler is 0.

• struct udp_handler_t

  UDP handler types.

• error_msg UDP_Start (uint32_t destIP, uint16_t srcPort, uint16_t dstPort)

  Starts a UDP packet.

• error_msg UDP_Send (void)

  Sends a UDP packet.

• error_msg UDP_Receive (uint16_t udpcksm)

  Catches all UDP packets and dispatches them to the appropriate callback.

• udp_table_iterator_t udp_table_getIterator (void)

  Returns the UDP table iterator.

• udp_table_iterator_t udp_table_nextEntry (udp_table_iterator_t i)

  Returns the UDP table next entry.

error_msg UDP_Receive (uint16_t udpcksm)

Catches all UDP packets and dispatches them to the appropriate callback.

error_msg UDP_Send (void )

Sends a UDP packet.

error_msg UDP_Start (uint32_t destIP, uint16_t srcPort, uint16_t dstPort)

Starts a UDP packet.

udp_table_iterator_t udp_table_getIterator (void )

Returns the UDP table iterator.

udp_table_iterator_t udp_table_nextEntry (udp_table_iterator_t i)

Returns the UDP table next entry.

• uint16_t htype

• uint16_t ptype

• uint8_t hlen

• uint8_t plen

• uint16_t oper

• mac48Address_t sha

• uint32_t spa

• mac48Address_t tha

• uint32_t tpa

uint8_t hlen

Hardware Address Length

uint16_t htype

Hardware Type

uint16_t oper

Operation

uint8_t plen

Protocol Address Length

uint16_t ptype

Protocol Type

mac48Address_t sha

Sender Hardware Address

uint32_t spa

Sender Protocol Address

mac48Address_t tha

Target Hardware Address

uint32_t tpa

Target Protocol Address

• mac48Address_t macAddress

• uint32_t ipAddress

• uint16_t protocolType

• uint8_t age

uint8_t age

Replace oldest entry with new data as required.

uint32_t ipAddress

IP address

mac48Address_t macAddress

MAC address

uint16_t protocolType

Protocol type

• uint8_t tlvOrder

• uint8_t type

• uint8_t subtype

• uint16_t buffLength

• createBasicFuncPtr callTlvMaker

uint16_t buffLength

createBasicFuncPtr callTlvMaker

uint8_t subtype

uint8_t tlvOrder

uint8_t type

• uint8_t tlvOrder

• uint8_t type

• uint16_t buffLength

• uint32_t OUI

• createOrgFuncPtr callTlvMaker

uint16_t buffLength

createOrgFuncPtr callTlvMaker

uint32_t OUI

Organizationally Unique Identifier

uint8_t tlvOrder

uint8_t type

inAddr_t dest_addr

• uint32_t dhcpIPAddress

• uint32_t subnetMask

• uint32_t routerAddress

• uint32_t dnsAddress [2]

• uint32_t ntpAddress [2]

• uint32_t gatewayAddress

• uint32_t xidValue

• uint32_t t1

• uint32_t t2

• uint32_t dhcpServerIdentifier

uint32_t dhcpIPAddress

DHCP IP address

uint32_t dhcpServerIdentifier

DHCP Server ID

uint32_t dnsAddress[2]

Captures only two DNS addresses

uint32_t gatewayAddress

x ID value

uint32_t ntpAddress[2]

Captures only two DNS addresses

uint32_t routerAddress

Router address

uint32_t subnetMask

Subnet mask

uint32_t t1

Name as per the RFC, page 35

uint32_t t2

Name as per the RFC, page 35  

uint32_t xidValue

x ID value

• dhcp_rx_client_state rxClientState

• dhcp_timer_client_state tmrClientState

dhcp_rx_client_state rxClientState

dhcp_timer_client_state tmrClientState

time_t birthSecond

const char* dnsName

uint32_t ipAddress

bool isValid

uint32_t ttl

• uint8_t destinationMAC [6]

• uint8_t sourceMAC [6]

• union {

  • uint16_t type

  • uint16_t length

  • uint16_t tpid

• } id

uint8_t destinationMAC[6]

union { ... } id

uint16_t length

uint8_t sourceMAC[6]

uint16_t tpid

uint16_t type

Ethernet 2 frame type, 802.3 length, 802.1Q TPID

• union {

  • uint16_t typeCode

  • struct {

    • uint8_t code

    • uint8_t type

  • }

• };

• uint16_t checksum

union { ... }

uint16_t checksum

uint8_t code

uint8_t type

uint16_t typeCode

• union {

  • uint32_t s_addr

  • uint8_t s_addr_byte [4]

• };

union { ... }

uint32_t s_addr

uint8_t s_addr_byte[4]

• uint32_t ipv4_myAddress

• uint32_t ipv4_dns [MAX_DNS]

• uint32_t ipv4_subnetMask

• uint32_t ipv4_router

• uint32_t ipv4_gateway

• uint32_t ipv4_ntpAddress [MAX_NTP]

• uint32_t ipv4_tftpAddress

uint32_t ipv4_dns[MAX_DNS]

Primary & secondary DNS addresses

uint32_t ipv4_gateway

Gateway address

uint32_t ipv4_myAddress

IP address

uint32_t ipv4_ntpAddress[MAX_NTP]

NTP addresses

uint32_t ipv4_router

Router address

uint32_t ipv4_subnetMask

Subnet mask

uint32_t ipv4_tftpAddress

TFTP address

• uint32_t srcIpAddress

• uint32_t dstIpAddress

• uint8_t protocol

• uint8_t z

• uint16_t length

uint32_t dstIpAddress

Destination IP Address

uint16_t length

Length

uint8_t protocol

Protocol

uint32_t srcIpAddress

Source IP Address

uint8_t z

Used for memory cleaning

• unsigned ihl: 4

• unsigned version: 4

• unsigned ecn: 2

• unsigned dscp: 6

• uint16_t length

• uint16_t identifcation

• unsigned fragmentOffsetHigh: 5

• unsigned __pad0__: 1

• unsigned dontFragment: 1

• unsigned moreFragments: 1

• uint8_t fragmentOffsetLow

• uint8_t timeToLive

• uint8_t protocol

• uint16_t headerCksm

• uint32_t srcIpAddress

• uint32_t dstIpAddress

unsigned __pad0__

Leave this bit as zero

unsigned dontFragment

Drop if fragmentation is required to route

unsigned dscp

Differentiated Service Code Point RFC3260

uint32_t dstIpAddress

Destination IP Address

unsigned ecn

Explicit Congestion Notification RFC3168

unsigned fragmentOffsetHigh

Offset for a fragment, needed for reassembly

uint8_t fragmentOffsetLow

Low byte for the fragment offset

uint16_t headerCksm

RFC1071 defines this calculation

uint16_t identifcation

ID for packet fragments

unsigned ihl

Internet header length in 32-bit words

uint16_t length

Total length including header and data (no more than 576 octets)

unsigned moreFragments

Fragments have this bit set (except for the final packet)

uint8_t protocol

IP Protocol (from RFC790)

uint32_t srcIpAddress

Source IP Address

uint8_t timeToLive

Decrement at each hop and discard when zero

unsigned version

4 for IPV4

• uint8_t source_mac [6]

• uint8_t source_ipaddr [4]

• bool newNeighbor

• lldp_tx_port_t tx

• lldp_rx_port_t rx

• bool portEnabled

• uint8_t adminStatus

• uint16_t allocatedPower

• uint16_t desiredPower

uint8_t adminStatus

IEEE 802.1AB 9.2.5.1

uint16_t allocatedPower

uint16_t desiredPower

bool newNeighbor

bool portEnabled

IEEE 802.1AB 9.2.4.1

lldp_rx_port_t rx

uint8_t source_ipaddr[4]

uint8_t source_mac[6]

lldp_tx_port_t tx

• uint8_t state

• bool badFrame

• bool rcvFrame

bool badFrame

bool rcvFrame

uint8_t state

• uint8_t state

• bool localChange

• uint16_t txTTL

• lldp_tx_timers_t timers

• uint8_t txCredit

• uint8_t txFast

• bool txNow

bool localChange

IEEE 802.1AB var

uint8_t state

The TX state for this interface

lldp_tx_timers_t timers

LLDP TX state machine timers for this interface

uint8_t txCredit

IEEE 802.1AB 9.2.5.16

uint8_t txFast

IEEE 802.1AB 9.2.5.18

bool txNow

IEEE 802.1AB 9.2.5.20

uint16_t txTTL

IEEE 802.1AB var

• uint16_t txDelay

• uint16_t txTTR

• uint16_t txShutdownWhile

• uint16_t txDelayWhile

• bool txTick

uint16_t txDelay

IEEE 802.1AB 10.5.3

uint16_t txDelayWhile

uint16_t txShutdownWhile

IEEE 802.1AB 9.2.2.3

bool txTick

IEEE 802.1AB 9.2.5.21

uint16_t txTTR

IEEE 802.1AB 9.2.2.3 Transmit on expire

• LOG_FACILITY logFacility

• LOG_SEVERITY severityThreshold

LOG_FACILITY logFacility

LOG_SEVERITY severityThreshold

• uint8_t val

• struct {

  • unsigned fixTlvSize:1

  • unsigned poeEnabledPair:1

  • unsigned uPoeEnabledPower:1

  • unsigned poePlusEnabledPower:1

  • unsigned poeEnabledMinPower:1

  • unsigned is4WireSupported:1

  • unsigned PD_requestSparePairOn:1

  • unsigned __pad0__:1

• };

struct { ... }

unsigned __pad0__

unsigned fixTlvSize

unsigned is4WireSupported

Switch capabilities - RO for all practical purposes

unsigned PD_requestSparePairOn

Only if the desired power is more than 25.5w and 4-wire supported

unsigned poeEnabledMinPower

unsigned poeEnabledPair

unsigned poePlusEnabledPower

unsigned uPoeEnabledPower

uint8_t val

• uint32_t oui

• uint8_t subtype

• OrgFuncPtr processOrgTlvs

uint32_t oui

OrgFuncPtr processOrgTlvs

uint8_t subtype

• uint16_t port

• inAddr_t addr

inAddr_t addr

uint16_t port

• uint16_t storeNumber

• TFTP_receive_function_ptr TFTP_CallBack

uint16_t storeNumber

TFTP_receive_function_ptr TFTP_CallBack

• uint16_t sourcePort

• uint16_t destPort

• uint32_t sequenceNumber

• uint32_t ackNumber

• union {

  • uint8_t byte13

  • struct {

    • uint8_t ns: 1

    • uint8_t reserved: 3

    • uint8_t dataOffset: 4

  • }

• };

• union {

  • uint8_t flags

  • struct {

    • uint8_t fin: 1

    • uint8_t syn: 1

    • uint8_t rst: 1

    • uint8_t psh: 1

    • uint8_t ack: 1

    • uint8_t urg: 1

    • uint8_t ece: 1

    • uint8_t cwr: 1

  • }

• };

• uint16_t windowSize

• uint16_t checksum

• uint16_t urgentPtr

union { ... }

union { ... }

uint8_t ack

Indicates that the ACKfield is significant.

uint32_t ackNumber

ACK Number

uint8_t byte13

uint16_t checksum

TCP Header Checksum.

uint8_t cwr

Congestion Window Reduced (CWR) (added to header by RFC 3168).

uint8_t dataOffset

Specifies the size of the TCP header in 32-bit words.

uint16_t destPort

Destination port

uint8_t ece

ECN-Echo. Depends on SYN flag set or clear.

uint8_t fin

No more data from sender.

uint8_t flags

Flags

uint8_t ns

ECN-nonce concealment protection (added to header by RFC 3540).

uint8_t psh

Asks to push the buffered data to the receiving application.

uint8_t reserved

For future use and needs to be set to zero.

uint8_t rst

Resets the connection.

uint32_t sequenceNumber

Sequence number

uint16_t sourcePort

Source port

uint8_t syn

Synchronizes sequence numbers. Only the first packet sent from each end must have this flag set.

uint8_t urg

Indicates that the Urgent pointer field is significant.

uint16_t urgentPtr

Urgent pointer.

uint16_t windowSize

Window size.

uint32_t localIP

uint16_t localPort

uint32_t remoteIP

uint16_t remotePort

• uint16_t localPort

• uint32_t destIP

• uint16_t destPort

• uint32_t remoteSeqno

• uint32_t remoteAck

• uint32_t localSeqno

• uint32_t localLastAck

• uint16_t remoteWnd

• uint16_t localWnd

• uint16_t mss

• uint8_t * rxBufferStart

• uint8_t * rxBufferPtr

• tcpBufferState_t rxBufState

• uint8_t * txBufferStart

• uint8_t * txBufferPtr

• uint16_t bytesToSend

• tcpBufferState_t txBufState

• uint16_t bytesSent

• bool payloadSave

• tcp_fsm_states_t fsmState

• tcpEvent_t connectionEvent

• void * nextTCB

• void * prevTCB

• uint16_t timeout

• uint16_t timeoutReloadValue

• uint8_t timeoutsCount

• uint8_t flags

• socketState_t socketState

uint16_t bytesSent

uint16_t bytesToSend

tcpEvent_t connectionEvent

uint32_t destIP

uint16_t destPort

uint8_t flags

Save the flags to be used for time-outs

tcp_fsm_states_t fsmState

Connection state

uint32_t localLastAck

Last ACK number received

uint16_t localPort

Local Port

uint32_t localSeqno

uint16_t localWnd

Receiver window

uint16_t mss

void* nextTCB

Downstream list pointer

bool payloadSave

void* prevTCB

Upstream list pointer

uint32_t remoteAck

Last ACK packet sent to remote

uint32_t remoteSeqno

uint16_t remoteWnd

Sender window

uint8_t* rxBufferPtr

Pointer to write inside the RX buffer

uint8_t* rxBufferStart

tcpBufferState_t rxBufState

socketState_t socketState

Socket states used in application

uint16_t timeout

Retransmission time-out in seconds

uint16_t timeoutReloadValue

uint8_t timeoutsCount

Number of retransmissions

uint8_t* txBufferPtr

uint8_t* txBufferStart

tcpBufferState_t txBufState

char tftp_block_size[5]

char tftp_filename[32]

uint32_t tftp_server_address

• uint16_t portNumber

• ip_receive_function_ptr callBack

ip_receive_function_ptr callBack

uint16_t portNumber

• uint16_t srcPort

• uint16_t dstPort

• uint16_t length

• uint16_t checksum

uint16_t checksum

Checksum

uint16_t dstPort

Destination Port

uint16_t length

Length

uint16_t srcPort

Source Port

#define ARP_NAK 10

#define ARP_REPLY 2

#define ARP_REQUEST 1

arpMap_t arpMap[ARP_MAP_SIZE]

mac48Address_t hostMacAddress

#define DHCP_HEADER_SIZE 240

#define DHCP_REQUEST_LENGTH DHCP_PACKET_SIZE

#define logMsg( msg, msgSeverity, msgLogDest)

dhcp_data_t dhcpData = {0,0,0,{0,0},{0,0},0,0,10,3600,0}

const char dhcpName[] = "PIC16F18857 Ethernet"

dhcp_state_t dhcpState = {SELECTING,INIT_TIMER}

mac48Address_t ethMAC[static]

#define ARRAYSIZE( a) (sizeof(a) / sizeof(*(a)))

#define DNS_CLASS_SIZE 2

#define DNS_HEADER_SIZE 12

#define DNS_MAP_SIZE 8

#define DNS_PACKET_SIZE (DNS_HEADER_SIZE + DNS_QUERY_SIZE)

#define DNS_QUERY_SIZE (DNS_TYPE_SIZE + DNS_CLASS_SIZE)

#define DNS_TYPE_SIZE 2

#define logMsg( msg, msgSeverity, msgLogDest)

dns_map_t dnsCache[DNS_MAP_SIZE]

uint16_t dnsXidValue

mac48Address_t ethMACdns

uint16_t portUnreachable = 0

#define DEST_UNREACHABLE_LEN 64

ip_db_info_t ip_database_info

#define ALL_HOST_MULTICAST_ADDRESS 0xE0000001

#define CLASS_A_IPV4_BROADCAST_MASK 0XFF000000

#define CLASS_A_IPV4_REVERSE_BROADCAST_MASK 0x00FFFFFF

#define CLASS_B_IPV4_BROADCAST_MASK 0xFFFF0000

#define CLASS_B_IPV4_REVERSE_BROADCAST_MASK 0x0000FFFF

#define CLASS_C_IPV4_BROADCAST_MASK 0xFFFFFF00

#define CLASS_C_IPV4_REVERSE_BROADCAST_MASK 0X000000FF

#define ipdb_classAbroadcastAddress( ) (ip_database_info.ipv4_myAddress|CLASS_A_IPV4_REVERSE_BROADCAST_MASK)

#define ipdb_classBbroadcastAddress( ) (ip_database_info.ipv4_myAddress|CLASS_B_IPV4_REVERSE_BROADCAST_MASK)

#define ipdb_classCbroadcastAddress( ) (ip_database_info.ipv4_myAddress|CLASS_C_IPV4_REVERSE_BROADCAST_MASK)

#define ipdb_getAddress( ) (ip_database_info.ipv4_myAddress)

#define ipdb_getDNS( x) (x < MAX_DNS ? ip_database_info.ipv4_dns[x] : ip_database_info.ipv4_dns[0])

#define ipdb_getNTP( x) (x < MAX_NTP ? ip_database_info.ipv4_ntpAddress[x] : ip_database_info.ipv4_ntpAddress[0])

#define ipdb_getRouter( ) (ip_database_info.ipv4_router)

#define ipdb_getSubNetMASK( ) (ip_database_info.ipv4_subnetMask)

#define ipdb_getTFTP( ) (ip_database_info.ipv4_tftpAddress)

#define ipdb_setAddress( a) do{ ip_database_info.ipv4_myAddress = a; } while(0)

#define ipdb_setDNS( x, v) do{ if(x < MAX_DNS) ip_database_info.ipv4_dns[x] = v; } while(0)

#define ipdb_setGateway( g) do{ ip_database_info.ipv4_gateway = g; } while(0)

#define ipdb_setNTP( x, n) do{ if(x < MAX_NTP) ip_database_info.ipv4_ntpAddress[x] = n; } while(0)

#define ipdb_setRouter( r) do{ ip_database_info.ipv4_router = r; } while(0)

#define ipdb_setSubNetMASK( m) do{ ip_database_info.ipv4_subnetMask = m; } while(0)

#define ipdb_setTFTP( a) do{ ip_database_info.ipv4_tftpAddress = a; } while(0)

#define ipdb_specialbroadcastAddress( ) SPECIAL_IPV4_BROADCAST_ADDRESS

#define IPV4_ZERO_ADDRESS 0

#define LOCAL_HOST_ADDRESS 0x7F000001

#define MAX_DNS 2

#define MAX_NTP 2

#define SPECIAL_IPV4_BROADCAST_ADDRESS 0xFFFFFFFF

ip_db_info_t ip_database_info

void IPV4_Init (void )

Initializes IPv4.

#define logMsg( msg, msgSeverity, msgLogDest)

ipv4Header_t ipv4Header

uint32_t remoteIpv4Address

void IPV4_Init (void )

Initializes IPv4.