git.sur5r.net Git - freertos/blob - FreeRTOS-Labs/Source/FreeRTOS-Plus-TCP/include/FreeRTOS_IP_Private.h

   1 /*\r
   2  * FreeRTOS+TCP V2.2.0\r
   3  * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software.\r
  14  *\r
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  21  *\r
  22  * http://aws.amazon.com/freertos\r
  23  * http://www.FreeRTOS.org\r
  24  */\r
  25 \r
  26 #ifndef FREERTOS_IP_PRIVATE_H\r
  27 #define FREERTOS_IP_PRIVATE_H\r
  28 \r
  29 #ifdef __cplusplus\r
  30 extern "C" {\r
  31 #endif\r
  32 \r
  33 /* Application level configuration options. */\r
  34 #include "FreeRTOSIPConfig.h"\r
  35 #include "FreeRTOSIPConfigDefaults.h"\r
  36 #include "FreeRTOS_Sockets.h"\r
  37 #include "IPTraceMacroDefaults.h"\r
  38 #include "FreeRTOS_Stream_Buffer.h"\r
  39 #if( ipconfigUSE_TCP == 1 )\r
  40         #include "FreeRTOS_TCP_WIN.h"\r
  41         #include "FreeRTOS_TCP_IP.h"\r
  42 #endif\r
  43 \r
  44 #include "event_groups.h"\r
  45 \r
  46 typedef struct xNetworkAddressingParameters\r
  47 {\r
  48         uint32_t ulDefaultIPAddress;\r
  49         uint32_t ulNetMask;\r
  50         uint32_t ulGatewayAddress;\r
  51         uint32_t ulDNSServerAddress;\r
  52         uint32_t ulBroadcastAddress;\r
  53 } NetworkAddressingParameters_t;\r
  54 \r
  55 extern BaseType_t xTCPWindowLoggingLevel;\r
  56 \r
  57 /*-----------------------------------------------------------*/\r
  58 /* Protocol headers.                                         */\r
  59 /*-----------------------------------------------------------*/\r
  60 \r
  61 #include "pack_struct_start.h"\r
  62 struct xETH_HEADER\r
  63 {\r
  64         MACAddress_t xDestinationAddress; /*  0 + 6 = 6  */\r
  65         MACAddress_t xSourceAddress;      /*  6 + 6 = 12 */\r
  66         uint16_t usFrameType;              /* 12 + 2 = 14 */\r
  67 }\r
  68 #include "pack_struct_end.h"\r
  69 typedef struct xETH_HEADER EthernetHeader_t;\r
  70 \r
  71 #include "pack_struct_start.h"\r
  72 struct xARP_HEADER\r
  73 {\r
  74         uint16_t usHardwareType;                                /*  0 +  2 =  2 */\r
  75         uint16_t usProtocolType;                                /*  2 +  2 =  4 */\r
  76         uint8_t ucHardwareAddressLength;                /*  4 +  1 =  5 */\r
  77         uint8_t ucProtocolAddressLength;                /*  5 +  1 =  6 */\r
  78         uint16_t usOperation;                                   /*  6 +  2 =  8 */\r
  79         MACAddress_t xSenderHardwareAddress;    /*  8 +  6 = 14 */\r
  80         uint8_t ucSenderProtocolAddress[ 4 ];   /* 14 +  4 = 18  */\r
  81         MACAddress_t xTargetHardwareAddress;    /* 18 +  6 = 24  */\r
  82         uint32_t ulTargetProtocolAddress;               /* 24 +  4 = 28  */\r
  83 }\r
  84 #include "pack_struct_end.h"\r
  85 typedef struct xARP_HEADER ARPHeader_t;\r
  86 \r
  87 #include "pack_struct_start.h"\r
  88 struct xIP_HEADER\r
  89 {\r
  90         uint8_t ucVersionHeaderLength;        /*  0 + 1 =  1 */\r
  91         uint8_t ucDifferentiatedServicesCode; /*  1 + 1 =  2 */\r
  92         uint16_t usLength;                    /*  2 + 2 =  4 */\r
  93         uint16_t usIdentification;            /*  4 + 2 =  6 */\r
  94         uint16_t usFragmentOffset;            /*  6 + 2 =  8 */\r
  95         uint8_t ucTimeToLive;                 /*  8 + 1 =  9 */\r
  96         uint8_t ucProtocol;                   /*  9 + 1 = 10 */\r
  97         uint16_t usHeaderChecksum;            /* 10 + 2 = 12 */\r
  98         uint32_t ulSourceIPAddress;           /* 12 + 4 = 16 */\r
  99         uint32_t ulDestinationIPAddress;      /* 16 + 4 = 20 */\r
 100 }\r
 101 #include "pack_struct_end.h"\r
 102 typedef struct xIP_HEADER IPHeader_t;\r
 103 \r
 104 #include "pack_struct_start.h"\r
 105 struct xIGMP_HEADER\r
 106 {\r
 107         uint8_t ucVersionType;     /* 0 + 1 = 1 */\r
 108         uint8_t ucMaxResponseTime; /* 1 + 1 = 2 */\r
 109         uint16_t usChecksum;       /* 2 + 2 = 4 */\r
 110         uint32_t usGroupAddress;   /* 4 + 4 = 8 */\r
 111 }\r
 112 #include "pack_struct_end.h"\r
 113 typedef struct xIGMP_HEADER IGMPHeader_t;\r
 114 \r
 115 #include "pack_struct_start.h"\r
 116 struct xICMP_HEADER\r
 117 {\r
 118         uint8_t ucTypeOfMessage;   /* 0 + 1 = 1 */\r
 119         uint8_t ucTypeOfService;   /* 1 + 1 = 2 */\r
 120         uint16_t usChecksum;       /* 2 + 2 = 4 */\r
 121         uint16_t usIdentifier;     /* 4 + 2 = 6 */\r
 122         uint16_t usSequenceNumber; /* 6 + 2 = 8 */\r
 123 }\r
 124 #include "pack_struct_end.h"\r
 125 typedef struct xICMP_HEADER ICMPHeader_t;\r
 126 \r
 127 #include "pack_struct_start.h"\r
 128 struct xUDP_HEADER\r
 129 {\r
 130         uint16_t usSourcePort;      /* 0 + 2 = 2 */\r
 131         uint16_t usDestinationPort; /* 2 + 2 = 4 */\r
 132         uint16_t usLength;          /* 4 + 2 = 6 */\r
 133         uint16_t usChecksum;        /* 6 + 2 = 8 */\r
 134 }\r
 135 #include "pack_struct_end.h"\r
 136 typedef struct xUDP_HEADER UDPHeader_t;\r
 137 \r
 138 #include "pack_struct_start.h"\r
 139 struct xTCP_HEADER\r
 140 {\r
 141         uint16_t usSourcePort;          /* +  2 =  2 */\r
 142         uint16_t usDestinationPort;     /* +  2 =  4 */\r
 143         uint32_t ulSequenceNumber;      /* +  4 =  8 */\r
 144         uint32_t ulAckNr;               /* +  4 = 12 */\r
 145         uint8_t  ucTCPOffset;           /* +  1 = 13 */\r
 146         uint8_t  ucTCPFlags;            /* +  1 = 14 */\r
 147         uint16_t usWindow;                      /* +  2 = 15 */\r
 148         uint16_t usChecksum;            /* +  2 = 18 */\r
 149         uint16_t usUrgent;                      /* +  2 = 20 */\r
 150 #if ipconfigUSE_TCP == 1\r
 151         /* the option data is not a part of the TCP header */\r
 152         uint8_t  ucOptdata[ipSIZE_TCP_OPTIONS];         /* + 12 = 32 */\r
 153 #endif\r
 154 }\r
 155 #include "pack_struct_end.h"\r
 156 typedef struct xTCP_HEADER TCPHeader_t;\r
 157 \r
 158 #include "pack_struct_start.h"\r
 159 struct xPSEUDO_HEADER\r
 160 {\r
 161         uint32_t ulSourceAddress;\r
 162         uint32_t ulDestinationAddress;\r
 163         uint8_t ucZeros;\r
 164         uint8_t ucProtocol;\r
 165         uint16_t usUDPLength;\r
 166 }\r
 167 #include "pack_struct_end.h"\r
 168 typedef struct xPSEUDO_HEADER PseudoHeader_t;\r
 169 \r
 170 /*-----------------------------------------------------------*/\r
 171 /* Nested protocol packets.                                  */\r
 172 /*-----------------------------------------------------------*/\r
 173 \r
 174 #include "pack_struct_start.h"\r
 175 struct xARP_PACKET\r
 176 {\r
 177         EthernetHeader_t xEthernetHeader;       /*  0 + 14 = 14 */\r
 178         ARPHeader_t xARPHeader;                 /* 14 + 28 = 42 */\r
 179 }\r
 180 #include "pack_struct_end.h"\r
 181 typedef struct xARP_PACKET ARPPacket_t;\r
 182 \r
 183 #include "pack_struct_start.h"\r
 184 struct xIP_PACKET\r
 185 {\r
 186         EthernetHeader_t xEthernetHeader;\r
 187         IPHeader_t xIPHeader;\r
 188 }\r
 189 #include "pack_struct_end.h"\r
 190 typedef struct xIP_PACKET IPPacket_t;\r
 191 \r
 192 #include "pack_struct_start.h"\r
 193 struct xICMP_PACKET\r
 194 {\r
 195         EthernetHeader_t xEthernetHeader;\r
 196         IPHeader_t xIPHeader;\r
 197         ICMPHeader_t xICMPHeader;\r
 198 }\r
 199 #include "pack_struct_end.h"\r
 200 typedef struct xICMP_PACKET ICMPPacket_t;\r
 201 \r
 202 #include "pack_struct_start.h"\r
 203 struct xUDP_PACKET\r
 204 {\r
 205         EthernetHeader_t xEthernetHeader; /*  0 + 14 = 14 */\r
 206         IPHeader_t xIPHeader;             /* 14 + 20 = 34 */\r
 207         UDPHeader_t xUDPHeader;           /* 34 +  8 = 42 */\r
 208 }\r
 209 #include "pack_struct_end.h"\r
 210 typedef struct xUDP_PACKET UDPPacket_t;\r
 211 \r
 212 #include "pack_struct_start.h"\r
 213 struct xTCP_PACKET\r
 214 {\r
 215         EthernetHeader_t xEthernetHeader; /*  0 + 14 = 14 */\r
 216         IPHeader_t xIPHeader;             /* 14 + 20 = 34 */\r
 217         TCPHeader_t xTCPHeader;           /* 34 + 32 = 66 */\r
 218 }\r
 219 #include "pack_struct_end.h"\r
 220 typedef struct xTCP_PACKET TCPPacket_t;\r
 221 \r
 222 typedef union XPROT_PACKET\r
 223 {\r
 224         ARPPacket_t xARPPacket;\r
 225         TCPPacket_t xTCPPacket;\r
 226         UDPPacket_t xUDPPacket;\r
 227         ICMPPacket_t xICMPPacket;\r
 228 } ProtocolPacket_t;\r
 229 \r
 230 \r
 231 /* The maximum UDP payload length. */\r
 232 #define ipMAX_UDP_PAYLOAD_LENGTH ( ( ipconfigNETWORK_MTU - ipSIZE_OF_IPv4_HEADER ) - ipSIZE_OF_UDP_HEADER )\r
 233 \r
 234 typedef enum\r
 235 {\r
 236         eReleaseBuffer = 0,             /* Processing the frame did not find anything to do - just release the buffer. */\r
 237         eProcessBuffer,                 /* An Ethernet frame has a valid address - continue process its contents. */\r
 238         eReturnEthernetFrame,   /* The Ethernet frame contains an ARP or ICMP packet that can be returned to its source. */\r
 239         eFrameConsumed                  /* Processing the Ethernet packet contents resulted in the payload being sent to the stack. */\r
 240 } eFrameProcessingResult_t;\r
 241 \r
 242 typedef enum\r
 243 {\r
 244         eNoEvent = -1,\r
 245         eNetworkDownEvent,              /* 0: The network interface has been lost and/or needs [re]connecting. */\r
 246         eNetworkRxEvent,                /* 1: The network interface has queued a received Ethernet frame. */\r
 247         eNetworkTxEvent,                /* 2: Let the IP-task send a network packet. */\r
 248         eARPTimerEvent,                 /* 3: The ARP timer expired. */\r
 249         eStackTxEvent,                  /* 4: The software stack has queued a packet to transmit. */\r
 250         eDHCPEvent,                             /* 5: Process the DHCP state machine. */\r
 251         eTCPTimerEvent,                 /* 6: See if any TCP socket needs attention. */\r
 252         eTCPAcceptEvent,                /* 7: Client API FreeRTOS_accept() waiting for client connections. */\r
 253         eTCPNetStat,                    /* 8: IP-task is asked to produce a netstat listing. */\r
 254         eSocketBindEvent,               /* 9: Send a message to the IP-task to bind a socket to a port. */\r
 255         eSocketCloseEvent,              /*10: Send a message to the IP-task to close a socket. */\r
 256         eSocketSelectEvent,             /*11: Send a message to the IP-task for select(). */\r
 257         eSocketSignalEvent,             /*12: A socket must be signalled. */\r
 258 } eIPEvent_t;\r
 259 \r
 260 typedef struct IP_TASK_COMMANDS\r
 261 {\r
 262         eIPEvent_t eEventType;\r
 263         void *pvData;\r
 264 } IPStackEvent_t;\r
 265 \r
 266 #define ipBROADCAST_IP_ADDRESS 0xffffffffUL\r
 267 \r
 268 /* Offset into the Ethernet frame that is used to temporarily store information\r
 269 on the fragmentation status of the packet being sent.  The value is important,\r
 270 as it is past the location into which the destination address will get placed. */\r
 271 #define ipFRAGMENTATION_PARAMETERS_OFFSET               ( 6 )\r
 272 #define ipSOCKET_OPTIONS_OFFSET                                 ( 6 )\r
 273 \r
 274 /* Only used when outgoing fragmentation is being used (FreeRTOSIPConfig.h\r
 275 setting. */\r
 276 #define ipGET_UDP_PAYLOAD_OFFSET_FOR_FRAGMENT( usFragmentOffset ) ( ( ( usFragmentOffset ) == 0 ) ? ipUDP_PAYLOAD_OFFSET_IPv4 : ipIP_PAYLOAD_OFFSET )\r
 277 \r
 278 /* The offset into a UDP packet at which the UDP data (payload) starts. */\r
 279 #define ipUDP_PAYLOAD_OFFSET_IPv4       ( sizeof( UDPPacket_t ) )\r
 280 \r
 281 /* The offset into an IP packet into which the IP data (payload) starts. */\r
 282 #define ipIP_PAYLOAD_OFFSET             ( sizeof( IPPacket_t ) )\r
 283 \r
 284 #include "pack_struct_start.h"\r
 285 struct xUDP_IP_FRAGMENT_PARAMETERS\r
 286 {\r
 287         uint8_t ucSocketOptions;\r
 288         uint8_t ucPadFor16BitAlignment;\r
 289         uint16_t usFragmentedPacketOffset;\r
 290         uint16_t usFragmentLength;\r
 291         uint16_t usPayloadChecksum;\r
 292 }\r
 293 #include "pack_struct_end.h"\r
 294 typedef struct xUDP_IP_FRAGMENT_PARAMETERS IPFragmentParameters_t;\r
 295 \r
 296 #if( ipconfigBYTE_ORDER == pdFREERTOS_LITTLE_ENDIAN )\r
 297 \r
 298         /* Ethernet frame types. */\r
 299         #define ipARP_FRAME_TYPE        ( 0x0608U )\r
 300         #define ipIPv4_FRAME_TYPE       ( 0x0008U )\r
 301 \r
 302         /* ARP related definitions. */\r
 303         #define ipARP_PROTOCOL_TYPE                             ( 0x0008U )\r
 304         #define ipARP_HARDWARE_TYPE_ETHERNET    ( 0x0100U )\r
 305         #define ipARP_REQUEST                                   ( 0x0100U )\r
 306         #define ipARP_REPLY                                             ( 0x0200U )\r
 307 \r
 308 #else\r
 309 \r
 310         /* Ethernet frame types. */\r
 311         #define ipARP_FRAME_TYPE        ( 0x0806U )\r
 312         #define ipIPv4_FRAME_TYPE       ( 0x0800U )\r
 313 \r
 314         /* ARP related definitions. */\r
 315         #define ipARP_PROTOCOL_TYPE ( 0x0800U )\r
 316         #define ipARP_HARDWARE_TYPE_ETHERNET ( 0x0001U )\r
 317         #define ipARP_REQUEST ( 0x0001 )\r
 318         #define ipARP_REPLY ( 0x0002 )\r
 319 \r
 320 #endif /* ipconfigBYTE_ORDER == pdFREERTOS_LITTLE_ENDIAN */\r
 321 \r
 322 \r
 323 /* For convenience, a MAC address of all zeros and another of all 0xffs are\r
 324 defined const for quick reference. */\r
 325 extern const MACAddress_t xBroadcastMACAddress; /* all 0xff's */\r
 326 extern uint16_t usPacketIdentifier;\r
 327 \r
 328 /* Define a default UDP packet header (declared in FreeRTOS_UDP_IP.c) */\r
 329 typedef union xUDPPacketHeader\r
 330 {\r
 331         uint8_t ucBytes[24];\r
 332         uint32_t ulWords[6];\r
 333 } UDPPacketHeader_t;\r
 334 extern UDPPacketHeader_t xDefaultPartUDPPacketHeader;\r
 335 \r
 336 /* Structure that stores the netmask, gateway address and DNS server addresses. */\r
 337 extern NetworkAddressingParameters_t xNetworkAddressing;\r
 338 \r
 339 /* Structure that stores the defaults for netmask, gateway address and DNS.\r
 340 These values will be copied to 'xNetworkAddressing' in case DHCP is not used,\r
 341 and also in case DHCP does not lead to a confirmed request. */\r
 342 extern NetworkAddressingParameters_t xDefaultAddressing;\r
 343 \r
 344 /* True when BufferAllocation_1.c was included, false for BufferAllocation_2.c */\r
 345 extern const BaseType_t xBufferAllocFixedSize;\r
 346 \r
 347 /* Defined in FreeRTOS_Sockets.c */\r
 348 #if ( ipconfigUSE_TCP == 1 )\r
 349         extern List_t xBoundTCPSocketsList;\r
 350 #endif\r
 351 \r
 352 /* The local IP address is accessed from within xDefaultPartUDPPacketHeader,\r
 353 rather than duplicated in its own variable. */\r
 354 #define ipLOCAL_IP_ADDRESS_POINTER ( ( uint32_t * ) &( xDefaultPartUDPPacketHeader.ulWords[ 20u / sizeof(uint32_t) ] ) )\r
 355 \r
 356 /* The local MAC address is accessed from within xDefaultPartUDPPacketHeader,\r
 357 rather than duplicated in its own variable. */\r
 358 #define ipLOCAL_MAC_ADDRESS ( &xDefaultPartUDPPacketHeader.ucBytes[0] )\r
 359 \r
 360 /* ICMP packets are sent using the same function as UDP packets.  The port\r
 361 number is used to distinguish between the two, as 0 is an invalid UDP port. */\r
 362 #define ipPACKET_CONTAINS_ICMP_DATA                                     ( 0 )\r
 363 \r
 364 /* For now, the lower 8 bits in 'xEventBits' will be reserved for the above\r
 365 socket events. */\r
 366 #define SOCKET_EVENT_BIT_COUNT   8\r
 367 \r
 368 #define vSetField16( pxBase, xType, xField, usValue ) \\r
 369 { \\r
 370         ( ( uint8_t* )( pxBase ) ) [ offsetof( xType, xField ) + 0 ] = ( uint8_t ) ( ( usValue ) >> 8 ); \\r
 371         ( ( uint8_t* )( pxBase ) ) [ offsetof( xType, xField ) + 1 ] = ( uint8_t ) ( ( usValue ) & 0xff ); \\r
 372 }\r
 373 \r
 374 #define vSetField32( pxBase, xType, xField, ulValue ) \\r
 375 { \\r
 376         ( (uint8_t*)( pxBase ) ) [ offsetof( xType, xField ) + 0 ] = ( uint8_t )   ( ( ulValue ) >> 24 ); \\r
 377         ( (uint8_t*)( pxBase ) ) [ offsetof( xType, xField ) + 1 ] = ( uint8_t ) ( ( ( ulValue ) >> 16 ) & 0xff ); \\r
 378         ( (uint8_t*)( pxBase ) ) [ offsetof( xType, xField ) + 2 ] = ( uint8_t ) ( ( ( ulValue ) >> 8 ) & 0xff ); \\r
 379         ( (uint8_t*)( pxBase ) ) [ offsetof( xType, xField ) + 3 ] = ( uint8_t )   ( ( ulValue ) & 0xff ); \\r
 380 }\r
 381 \r
 382 #define vFlip_16( left, right ) \\r
 383         do { \\r
 384                 uint16_t tmp = (left); \\r
 385                 (left) = (right); \\r
 386                 (right) = tmp; \\r
 387         } while (0)\r
 388 \r
 389 #define vFlip_32( left, right ) \\r
 390         do { \\r
 391                 uint32_t tmp = (left); \\r
 392                 (left) = (right); \\r
 393                 (right) = tmp; \\r
 394         } while (0)\r
 395 \r
 396 #ifndef ARRAY_SIZE\r
 397         #define ARRAY_SIZE(x)   (BaseType_t)(sizeof(x)/sizeof(x)[0])\r
 398 #endif\r
 399 \r
 400 /*\r
 401  * A version of FreeRTOS_GetReleaseNetworkBuffer() that can be called from an\r
 402  * interrupt.  If a non zero value is returned, then the calling ISR should\r
 403  * perform a context switch before exiting the ISR.\r
 404  */\r
 405 BaseType_t FreeRTOS_ReleaseFreeNetworkBufferFromISR( void );\r
 406 \r
 407 /*\r
 408  * Create a message that contains a command to initialise the network interface.\r
 409  * This is used during initialisation, and at any time the network interface\r
 410  * goes down thereafter.  The network interface hardware driver is responsible\r
 411  * for sending the message that contains the network interface down command/\r
 412  * event.\r
 413  *\r
 414  * Only use the FreeRTOS_NetworkDownFromISR() version if the function is to be\r
 415  * called from an interrupt service routine.  If FreeRTOS_NetworkDownFromISR()\r
 416  * returns a non-zero value then a context switch should be performed ebfore\r
 417  * the interrupt is exited.\r
 418  */\r
 419 void FreeRTOS_NetworkDown( void );\r
 420 BaseType_t FreeRTOS_NetworkDownFromISR( void );\r
 421 \r
 422 /*\r
 423  * Processes incoming ARP packets.\r
 424  */\r
 425 eFrameProcessingResult_t eARPProcessPacket( ARPPacket_t * const pxARPFrame );\r
 426 \r
 427 /*\r
 428  * Inspect an Ethernet frame to see if it contains data that the stack needs to\r
 429  * process.  eProcessBuffer is returned if the frame should be processed by the\r
 430  * stack.  eReleaseBuffer is returned if the frame should be discarded.\r
 431  */\r
 432 eFrameProcessingResult_t eConsiderFrameForProcessing( const uint8_t * const pucEthernetBuffer );\r
 433 \r
 434 /*\r
 435  * Return the checksum generated over xDataLengthBytes from pucNextData.\r
 436  */\r
 437 uint16_t usGenerateChecksum( uint32_t ulSum, const uint8_t * pucNextData, size_t uxDataLengthBytes );\r
 438 \r
 439 /* Socket related private functions. */\r
 440 \r
 441 /* \r
 442  * The caller must ensure that pxNetworkBuffer->xDataLength is the UDP packet \r
 443  * payload size (excluding packet headers) and that the packet in pucEthernetBuffer \r
 444  * is at least the size of UDPPacket_t. \r
 445  */\r
 446 BaseType_t xProcessReceivedUDPPacket( NetworkBufferDescriptor_t *pxNetworkBuffer, uint16_t usPort );\r
 447 \r
 448 /*\r
 449  * Initialize the socket list data structures for TCP and UDP. \r
 450  */\r
 451 BaseType_t vNetworkSocketsInit( void );\r
 452 \r
 453 /*\r
 454  * Returns pdTRUE if the IP task has been created and is initialised.  Otherwise\r
 455  * returns pdFALSE.\r
 456  */\r
 457 BaseType_t xIPIsNetworkTaskReady( void );\r
 458 \r
 459 #if( ipconfigSOCKET_HAS_USER_WAKE_CALLBACK == 1 )\r
 460         struct xSOCKET;\r
 461         typedef void (*SocketWakeupCallback_t)( struct xSOCKET * pxSocket );\r
 462 #endif\r
 463 \r
 464 #if( ipconfigUSE_TCP == 1 )\r
 465 \r
 466         /*\r
 467          * Actually a user thing, but because xBoundTCPSocketsList, let it do by the\r
 468          * IP-task\r
 469          */\r
 470         void vTCPNetStat( void );\r
 471 \r
 472         /*\r
 473          * At least one socket needs to check for timeouts\r
 474          */\r
 475         TickType_t xTCPTimerCheck( BaseType_t xWillSleep );\r
 476 \r
 477         /* Every TCP socket has a buffer space just big enough to store\r
 478         the last TCP header received.\r
 479         As a reference of this field may be passed to DMA, force the\r
 480         alignment to 8 bytes. */\r
 481         typedef union\r
 482         {\r
 483                 struct\r
 484                 {\r
 485                         /* Increase the alignment of this union by adding a 64-bit variable. */\r
 486                         uint64_t ullAlignmentWord;\r
 487                 } a;\r
 488                 struct\r
 489                 {\r
 490                         /* The next field only serves to give 'ucLastPacket' a correct\r
 491                         alignment of 8 + 2.  See comments in FreeRTOS_IP.h */\r
 492                         uint8_t ucFillPacket[ ipconfigPACKET_FILLER_SIZE ];\r
 493                         uint8_t ucLastPacket[ sizeof( TCPPacket_t ) ];\r
 494                 } u;\r
 495         } LastTCPPacket_t;\r
 496 \r
 497         /*\r
 498          * Note that the values of all short and long integers in these structs\r
 499          * are being stored in the native-endian way\r
 500          * Translation should take place when accessing any structure which defines\r
 501          * network packets, such as IPHeader_t and TCPHeader_t\r
 502          */\r
 503         typedef struct TCPSOCKET\r
 504         {\r
 505                 uint32_t ulRemoteIP;            /* IP address of remote machine */\r
 506                 uint16_t usRemotePort;          /* Port on remote machine */\r
 507                 struct {\r
 508                         /* Most compilers do like bit-flags */\r
 509                         uint32_t\r
 510                                 bMssChange : 1,         /* This socket has seen a change in MSS */\r
 511                                 bPassAccept : 1,        /* when true, this socket may be returned in a call to accept() */\r
 512                                 bPassQueued : 1,        /* when true, this socket is an orphan until it gets connected\r
 513                                                                          * Why an orphan? Because it may not be returned in a accept() call until it\r
 514                                                                          * gets the state eESTABLISHED */\r
 515                                 bReuseSocket : 1,       /* When a listening socket gets a connection, do not create a new instance but keep on using it */\r
 516                                 bCloseAfterSend : 1,/* As soon as the last byte has been transmitted, finalise the connection\r
 517                                                                          * Useful in e.g. FTP connections, where the last data bytes are sent along with the FIN flag */\r
 518                                 bUserShutdown : 1,      /* User requesting a graceful shutdown */\r
 519                                 bCloseRequested : 1,/* Request to finalise the connection */\r
 520                                 bLowWater : 1,          /* high-water level has been reached. Cleared as soon as 'rx-count < lo-water' */\r
 521                                 bWinChange : 1,         /* The value of bLowWater has changed, must send a window update */\r
 522                                 bSendKeepAlive : 1,     /* When this flag is true, a TCP keep-alive message must be send */\r
 523                                 bWaitKeepAlive : 1,     /* When this flag is true, a TCP keep-alive reply is expected */\r
 524                                 bConnPrepared : 1,      /* Connecting socket: Message has been prepared */\r
 525                                 #if( ipconfigSUPPORT_SELECT_FUNCTION == 1 )\r
 526                                         bConnPassed : 1,        /* Connecting socket: Socket has been passed in a successful select()  */\r
 527                                 #endif /* ipconfigSUPPORT_SELECT_FUNCTION */\r
 528                                 bFinAccepted : 1,       /* This socket has received (or sent) a FIN and accepted it */\r
 529                                 bFinSent : 1,           /* We've sent out a FIN */\r
 530                                 bFinRecv : 1,           /* We've received a FIN from our peer */\r
 531                                 bFinAcked : 1,          /* Our FIN packet has been acked */\r
 532                                 bFinLast : 1,           /* The last ACK (after FIN and FIN+ACK) has been sent or will be sent by the peer */\r
 533                                 bRxStopped : 1,         /* Application asked to temporarily stop reception */\r
 534                                 bMallocError : 1,       /* There was an error allocating a stream */\r
 535                                 bWinScaling : 1;        /* A TCP-Window Scaling option was offered and accepted in the SYN phase. */\r
 536                 } bits;\r
 537                 uint32_t ulHighestRxAllowed;\r
 538                                                                 /* The highest sequence number that we can receive at any moment */\r
 539                 uint16_t usTimeout;             /* Time (in ticks) after which this socket needs attention */\r
 540                 uint16_t usCurMSS;              /* Current Maximum Segment Size */\r
 541                 uint16_t usInitMSS;             /* Initial maximum segment Size */\r
 542                 uint16_t usChildCount;  /* In case of a listening socket: number of connections on this port number */\r
 543                 uint16_t usBacklog;             /* In case of a listening socket: maximum number of concurrent connections on this port number */\r
 544                 uint8_t ucRepCount;             /* Send repeat count, for retransmissions\r
 545                                                                  * This counter is separate from the xmitCount in the\r
 546                                                                  * TCP win segments */\r
 547                 uint8_t ucTCPState;             /* TCP state: see eTCP_STATE */\r
 548                 struct xSOCKET *pxPeerSocket;   /* for server socket: child, for child socket: parent */\r
 549                 #if( ipconfigTCP_KEEP_ALIVE == 1 )\r
 550                         uint8_t ucKeepRepCount;\r
 551                         TickType_t xLastAliveTime;\r
 552                 #endif /* ipconfigTCP_KEEP_ALIVE */\r
 553                 #if( ipconfigTCP_HANG_PROTECTION == 1 )\r
 554                         TickType_t xLastActTime;\r
 555                 #endif /* ipconfigTCP_HANG_PROTECTION */\r
 556                 size_t uxLittleSpace;\r
 557                 size_t uxEnoughSpace;\r
 558                 size_t uxRxStreamSize;\r
 559                 size_t uxTxStreamSize;\r
 560                 StreamBuffer_t *rxStream;\r
 561                 StreamBuffer_t *txStream;\r
 562                 #if( ipconfigUSE_TCP_WIN == 1 )\r
 563                         NetworkBufferDescriptor_t *pxAckMessage;\r
 564                 #endif /* ipconfigUSE_TCP_WIN */\r
 565                 /* Buffer space to store the last TCP header received. */\r
 566                 LastTCPPacket_t xPacket;\r
 567                 uint8_t tcpflags;               /* TCP flags */\r
 568                 #if( ipconfigUSE_TCP_WIN != 0 )\r
 569                         uint8_t ucMyWinScaleFactor;\r
 570                         uint8_t ucPeerWinScaleFactor;\r
 571                 #endif\r
 572                 #if( ipconfigUSE_CALLBACKS == 1 )\r
 573                         FOnTCPReceive_t pxHandleReceive;        /*\r
 574                                                                                                  * In case of a TCP socket:\r
 575                                                                                                  * typedef void (* FOnTCPReceive_t) (Socket_t xSocket, void *pData, size_t xLength );\r
 576                                                                                                  */\r
 577                         FOnTCPSent_t pxHandleSent;\r
 578                         FOnConnected_t pxHandleConnected;       /* Actually type: typedef void (* FOnConnected_t) (Socket_t xSocket, BaseType_t ulConnected ); */\r
 579                 #endif /* ipconfigUSE_CALLBACKS */\r
 580                 uint32_t ulWindowSize;          /* Current Window size advertised by peer */\r
 581                 size_t uxRxWinSize;     /* Fixed value: size of the TCP reception window */\r
 582                 size_t uxTxWinSize;     /* Fixed value: size of the TCP transmit window */\r
 583 \r
 584                 TCPWindow_t xTCPWindow;\r
 585         } IPTCPSocket_t;\r
 586 \r
 587 #endif /* ipconfigUSE_TCP */\r
 588 \r
 589 typedef struct UDPSOCKET\r
 590 {\r
 591         List_t xWaitingPacketsList;     /* Incoming packets */\r
 592         #if( ipconfigUDP_MAX_RX_PACKETS > 0 )\r
 593                 UBaseType_t uxMaxPackets; /* Protection: limits the number of packets buffered per socket */\r
 594         #endif /* ipconfigUDP_MAX_RX_PACKETS */\r
 595         #if( ipconfigUSE_CALLBACKS == 1 )\r
 596                 FOnUDPReceive_t pxHandleReceive;        /*\r
 597                                                                                          * In case of a UDP socket:\r
 598                                                                                          * typedef void (* FOnUDPReceive_t) (Socket_t xSocket, void *pData, size_t xLength, struct freertos_sockaddr *pxAddr );\r
 599                                                                                          */\r
 600                 FOnUDPSent_t pxHandleSent;\r
 601         #endif /* ipconfigUSE_CALLBACKS */\r
 602 } IPUDPSocket_t;\r
 603 \r
 604 typedef enum eSOCKET_EVENT {\r
 605         eSOCKET_RECEIVE = 0x0001,\r
 606         eSOCKET_SEND    = 0x0002,\r
 607         eSOCKET_ACCEPT  = 0x0004,\r
 608         eSOCKET_CONNECT = 0x0008,\r
 609         eSOCKET_BOUND   = 0x0010,\r
 610         eSOCKET_CLOSED  = 0x0020,\r
 611         eSOCKET_INTR    = 0x0040,\r
 612         eSOCKET_ALL             = 0x007F,\r
 613 } eSocketEvent_t;\r
 614 \r
 615 typedef struct xSOCKET\r
 616 {\r
 617         EventBits_t xEventBits;\r
 618         EventGroupHandle_t xEventGroup;\r
 619 \r
 620         ListItem_t xBoundSocketListItem; /* Used to reference the socket from a bound sockets list. */\r
 621         TickType_t xReceiveBlockTime; /* if recv[to] is called while no data is available, wait this amount of time. Unit in clock-ticks */\r
 622         TickType_t xSendBlockTime; /* if send[to] is called while there is not enough space to send, wait this amount of time. Unit in clock-ticks */\r
 623 \r
 624         uint16_t usLocalPort;           /* Local port on this machine */\r
 625         uint8_t ucSocketOptions;\r
 626         uint8_t ucProtocol; /* choice of FREERTOS_IPPROTO_UDP/TCP */\r
 627         #if( ipconfigSOCKET_HAS_USER_SEMAPHORE == 1 )\r
 628                 SemaphoreHandle_t pxUserSemaphore;\r
 629         #endif /* ipconfigSOCKET_HAS_USER_SEMAPHORE */\r
 630         #if( ipconfigSOCKET_HAS_USER_WAKE_CALLBACK == 1 )\r
 631                 SocketWakeupCallback_t pxUserWakeCallback;\r
 632         #endif /* ipconfigSOCKET_HAS_USER_WAKE_CALLBACK */\r
 633 \r
 634         #if( ipconfigSUPPORT_SELECT_FUNCTION == 1 )\r
 635                 struct xSOCKET_SET *pxSocketSet;\r
 636                 /* User may indicate which bits are interesting for this socket. */\r
 637                 EventBits_t xSelectBits;\r
 638                 /* These bits indicate the events which have actually occurred.\r
 639                 They are maintained by the IP-task */\r
 640                 EventBits_t xSocketBits;\r
 641         #endif /* ipconfigSUPPORT_SELECT_FUNCTION */\r
 642         /* TCP/UDP specific fields: */\r
 643         /* Before accessing any member of this structure, it should be confirmed */\r
 644         /* that the protocol corresponds with the type of structure */\r
 645 \r
 646         union\r
 647         {\r
 648                 IPUDPSocket_t xUDP;\r
 649                 #if( ipconfigUSE_TCP == 1 )\r
 650                         IPTCPSocket_t xTCP;\r
 651                         /* Make sure that xTCP is 8-bytes aligned by\r
 652                         declaring a 64-bit variable in the same union */\r
 653                         uint64_t ullTCPAlignment;\r
 654                 #endif /* ipconfigUSE_TCP */\r
 655         } u;\r
 656 } FreeRTOS_Socket_t;\r
 657 \r
 658 #if( ipconfigUSE_TCP == 1 )\r
 659         /*\r
 660          * Lookup a TCP socket, using a multiple matching: both port numbers and\r
 661          * return IP address.\r
 662          */\r
 663         FreeRTOS_Socket_t *pxTCPSocketLookup( uint32_t ulLocalIP, UBaseType_t uxLocalPort, uint32_t ulRemoteIP, UBaseType_t uxRemotePort );\r
 664 \r
 665 #endif /* ipconfigUSE_TCP */\r
 666 \r
 667 /*\r
 668  * Look up a local socket by finding a match with the local port.\r
 669  */\r
 670 FreeRTOS_Socket_t *pxUDPSocketLookup( UBaseType_t uxLocalPort );\r
 671 \r
 672 /*\r
 673  * Called when the application has generated a UDP packet to send.\r
 674  */\r
 675 void vProcessGeneratedUDPPacket( NetworkBufferDescriptor_t * const pxNetworkBuffer );\r
 676 \r
 677 /*\r
 678  * Calculate the upper-layer checksum\r
 679  * Works both for UDP, ICMP and TCP packages\r
 680  * bOut = true: checksum will be set in outgoing packets\r
 681  * bOut = false: checksum will be calculated for incoming packets\r
 682  *     returning 0xffff means: checksum was correct\r
 683  */\r
 684 uint16_t usGenerateProtocolChecksum( const uint8_t * const pucEthernetBuffer, size_t uxBufferLength, BaseType_t xOutgoingPacket );\r
 685 \r
 686 /*\r
 687  * An Ethernet frame has been updated (maybe it was an ARP request or a PING\r
 688  * request?) and is to be sent back to its source.\r
 689  */\r
 690 void vReturnEthernetFrame( NetworkBufferDescriptor_t * pxNetworkBuffer, BaseType_t xReleaseAfterSend );\r
 691 \r
 692 /*\r
 693  * The internal version of bind()\r
 694  * If 'ulInternal' is true, it is called by the driver\r
 695  * The TCP driver needs to bind a socket at the moment a listening socket\r
 696  * creates a new connected socket\r
 697  */\r
 698 BaseType_t vSocketBind( FreeRTOS_Socket_t *pxSocket, struct freertos_sockaddr * pxAddress, size_t uxAddressLength, BaseType_t xInternal );\r
 699 \r
 700 /*\r
 701  * Internal function to add streaming data to a TCP socket. If ulIn == true,\r
 702  * data will be added to the rxStream, otherwise to the tXStream.  Normally data\r
 703  * will be written with ulOffset == 0, meaning: at the end of the FIFO.  When\r
 704  * packet come in out-of-order, an offset will be used to put it in front and\r
 705  * the head will not change yet.\r
 706  */\r
 707 int32_t lTCPAddRxdata(FreeRTOS_Socket_t *pxSocket, size_t uxOffset, const uint8_t *pcData, uint32_t ulByteCount);\r
 708 \r
 709 /*\r
 710  * Currently called for any important event.\r
 711  */\r
 712 void vSocketWakeUpUser( FreeRTOS_Socket_t *pxSocket );\r
 713 \r
 714 /*\r
 715  * Some helping function, their meaning should be clear\r
 716  */\r
 717 static portINLINE uint32_t ulChar2u32 (const uint8_t *apChr);\r
 718 static portINLINE uint32_t ulChar2u32 (const uint8_t *apChr)\r
 719 {\r
 720         return  ( ( ( uint32_t )apChr[0] ) << 24) |\r
 721                         ( ( ( uint32_t )apChr[1] ) << 16) |\r
 722                         ( ( ( uint32_t )apChr[2] ) << 8) |\r
 723                         ( ( ( uint32_t )apChr[3] ) );\r
 724 }\r
 725 \r
 726 static portINLINE uint16_t usChar2u16 (const uint8_t *apChr);\r
 727 static portINLINE uint16_t usChar2u16 (const uint8_t *apChr)\r
 728 {\r
 729         return ( uint16_t )\r
 730                         ( ( ( ( uint32_t )apChr[0] ) << 8) |\r
 731                           ( ( ( uint32_t )apChr[1] ) ) );\r
 732 }\r
 733 \r
 734 /* Check a single socket for retransmissions and timeouts */\r
 735 BaseType_t xTCPSocketCheck( FreeRTOS_Socket_t *pxSocket );\r
 736 \r
 737 BaseType_t xTCPCheckNewClient( FreeRTOS_Socket_t *pxSocket );\r
 738 \r
 739 /* Defined in FreeRTOS_Sockets.c\r
 740  * Close a socket\r
 741  */\r
 742 void *vSocketClose( FreeRTOS_Socket_t *pxSocket );\r
 743 \r
 744 /*\r
 745  * Send the event eEvent to the IP task event queue, using a block time of\r
 746  * zero.  Return pdPASS if the message was sent successfully, otherwise return\r
 747  * pdFALSE.\r
 748 */\r
 749 BaseType_t xSendEventToIPTask( eIPEvent_t eEvent );\r
 750 \r
 751 /*\r
 752  * The same as above, but a struct as a parameter, containing:\r
 753  *              eIPEvent_t eEventType;\r
 754  *              void *pvData;\r
 755  */\r
 756 BaseType_t xSendEventStructToIPTask( const IPStackEvent_t *pxEvent, TickType_t xTimeout );\r
 757 \r
 758 /*\r
 759  * Returns a pointer to the original NetworkBuffer from a pointer to a UDP\r
 760  * payload buffer.\r
 761  */\r
 762 NetworkBufferDescriptor_t *pxUDPPayloadBuffer_to_NetworkBuffer( void *pvBuffer );\r
 763 \r
 764 #if( ipconfigZERO_COPY_TX_DRIVER != 0 )\r
 765         /*\r
 766          * For the case where the network driver passes a buffer directly to a DMA\r
 767          * descriptor, this function can be used to translate a 'network buffer' to\r
 768          * a 'network buffer descriptor'.\r
 769          */\r
 770         NetworkBufferDescriptor_t *pxPacketBuffer_to_NetworkBuffer( const void *pvBuffer );\r
 771 #endif\r
 772 \r
 773 /*\r
 774  * Internal: Sets a new state for a TCP socket and performs the necessary\r
 775  * actions like calling a OnConnected handler to notify the socket owner.\r
 776  */\r
 777 #if( ipconfigUSE_TCP == 1 )\r
 778         void vTCPStateChange( FreeRTOS_Socket_t *pxSocket, enum eTCP_STATE eTCPState );\r
 779 #endif /* ipconfigUSE_TCP */\r
 780 \r
 781 /*_RB_ Should this be part of the public API? */\r
 782 void FreeRTOS_netstat( void );\r
 783 \r
 784 /* Returns pdTRUE is this function is called from the IP-task */\r
 785 BaseType_t xIsCallingFromIPTask( void );\r
 786 \r
 787 #if( ipconfigSUPPORT_SELECT_FUNCTION == 1 )\r
 788 \r
 789 typedef struct xSOCKET_SET\r
 790 {\r
 791         EventGroupHandle_t xSelectGroup;\r
 792         BaseType_t bApiCalled;  /* True if the API was calling  the private vSocketSelect */\r
 793         FreeRTOS_Socket_t *pxSocket;\r
 794 } SocketSelect_t;\r
 795 \r
 796 extern void vSocketSelect( SocketSelect_t *pxSocketSelect );\r
 797 \r
 798 #endif /* ipconfigSUPPORT_SELECT_FUNCTION */\r
 799 \r
 800 void vIPSetDHCPTimerEnableState( BaseType_t xEnableState );\r
 801 void vIPReloadDHCPTimer( uint32_t ulLeaseTime );\r
 802 #if( ipconfigDNS_USE_CALLBACKS != 0 )\r
 803         void vIPReloadDNSTimer( uint32_t ulCheckTime );\r
 804         void vIPSetDnsTimerEnableState( BaseType_t xEnableState );\r
 805 #endif\r
 806 \r
 807 /* Send the network-up event and start the ARP timer. */\r
 808 void vIPNetworkUpCalls( void );\r
 809 \r
 810 #ifdef __cplusplus\r
 811 } /* extern "C" */\r
 812 #endif\r
 813 \r
 814 #endif /* FREERTOS_IP_PRIVATE_H */\r
 815 \r
 816 \r
 817 \r
 818 \r
 819 \r
 820 \r
 821 \r
 822 \r
 823 \r
 824 \r
 825 \r
 826 \r
 827 \r