2 * FreeRTOS+TCP V2.0.7
\r
3 * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
\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
12 * The above copyright notice and this permission notice shall be included in all
\r
13 * copies or substantial portions of the Software.
\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
22 * http://aws.amazon.com/freertos
\r
23 * http://www.FreeRTOS.org
\r
26 #ifndef FREERTOS_IP_PRIVATE_H
\r
27 #define FREERTOS_IP_PRIVATE_H
\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
44 #include "event_groups.h"
\r
46 typedef struct xNetworkAddressingParameters
\r
48 uint32_t ulDefaultIPAddress;
\r
50 uint32_t ulGatewayAddress;
\r
51 uint32_t ulDNSServerAddress;
\r
52 uint32_t ulBroadcastAddress;
\r
53 } NetworkAddressingParameters_t;
\r
55 extern BaseType_t xTCPWindowLoggingLevel;
\r
57 /*-----------------------------------------------------------*/
\r
58 /* Protocol headers. */
\r
59 /*-----------------------------------------------------------*/
\r
61 #include "pack_struct_start.h"
\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
68 #include "pack_struct_end.h"
\r
69 typedef struct xETH_HEADER EthernetHeader_t;
\r
71 #include "pack_struct_start.h"
\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
84 #include "pack_struct_end.h"
\r
85 typedef struct xARP_HEADER ARPHeader_t;
\r
87 #include "pack_struct_start.h"
\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
101 #include "pack_struct_end.h"
\r
102 typedef struct xIP_HEADER IPHeader_t;
\r
104 #include "pack_struct_start.h"
\r
105 struct xIGMP_HEADER
\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
112 #include "pack_struct_end.h"
\r
113 typedef struct xIGMP_HEADER IGMPHeader_t;
\r
115 #include "pack_struct_start.h"
\r
116 struct xICMP_HEADER
\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
124 #include "pack_struct_end.h"
\r
125 typedef struct xICMP_HEADER ICMPHeader_t;
\r
127 #include "pack_struct_start.h"
\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
135 #include "pack_struct_end.h"
\r
136 typedef struct xUDP_HEADER UDPHeader_t;
\r
138 #include "pack_struct_start.h"
\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
155 #include "pack_struct_end.h"
\r
156 typedef struct xTCP_HEADER TCPHeader_t;
\r
158 #include "pack_struct_start.h"
\r
159 struct xPSEUDO_HEADER
\r
161 uint32_t ulSourceAddress;
\r
162 uint32_t ulDestinationAddress;
\r
164 uint8_t ucProtocol;
\r
165 uint16_t usUDPLength;
\r
167 #include "pack_struct_end.h"
\r
168 typedef struct xPSEUDO_HEADER PseudoHeader_t;
\r
170 /*-----------------------------------------------------------*/
\r
171 /* Nested protocol packets. */
\r
172 /*-----------------------------------------------------------*/
\r
174 #include "pack_struct_start.h"
\r
177 EthernetHeader_t xEthernetHeader; /* 0 + 14 = 14 */
\r
178 ARPHeader_t xARPHeader; /* 14 + 28 = 42 */
\r
180 #include "pack_struct_end.h"
\r
181 typedef struct xARP_PACKET ARPPacket_t;
\r
183 #include "pack_struct_start.h"
\r
186 EthernetHeader_t xEthernetHeader;
\r
187 IPHeader_t xIPHeader;
\r
189 #include "pack_struct_end.h"
\r
190 typedef struct xIP_PACKET IPPacket_t;
\r
192 #include "pack_struct_start.h"
\r
193 struct xICMP_PACKET
\r
195 EthernetHeader_t xEthernetHeader;
\r
196 IPHeader_t xIPHeader;
\r
197 ICMPHeader_t xICMPHeader;
\r
199 #include "pack_struct_end.h"
\r
200 typedef struct xICMP_PACKET ICMPPacket_t;
\r
202 #include "pack_struct_start.h"
\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
209 #include "pack_struct_end.h"
\r
210 typedef struct xUDP_PACKET UDPPacket_t;
\r
212 #include "pack_struct_start.h"
\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
219 #include "pack_struct_end.h"
\r
220 typedef struct xTCP_PACKET TCPPacket_t;
\r
222 typedef union XPROT_PACKET
\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
231 /* The maximum UDP payload length. */
\r
232 #define ipMAX_UDP_PAYLOAD_LENGTH ( ( ipconfigNETWORK_MTU - ipSIZE_OF_IPv4_HEADER ) - ipSIZE_OF_UDP_HEADER )
\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
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 eARPTimerEvent, /* 2: The ARP timer expired. */
\r
248 eStackTxEvent, /* 3: The software stack has queued a packet to transmit. */
\r
249 eDHCPEvent, /* 4: Process the DHCP state machine. */
\r
250 eTCPTimerEvent, /* 5: See if any TCP socket needs attention. */
\r
251 eTCPAcceptEvent, /* 6: Client API FreeRTOS_accept() waiting for client connections. */
\r
252 eTCPNetStat, /* 7: IP-task is asked to produce a netstat listing. */
\r
253 eSocketBindEvent, /* 8: Send a message to the IP-task to bind a socket to a port. */
\r
254 eSocketCloseEvent, /* 9: Send a message to the IP-task to close a socket. */
\r
255 eSocketSelectEvent, /*10: Send a message to the IP-task for select(). */
\r
256 eSocketSignalEvent, /*11: A socket must be signalled. */
\r
259 typedef struct IP_TASK_COMMANDS
\r
261 eIPEvent_t eEventType;
\r
265 #define ipBROADCAST_IP_ADDRESS 0xffffffffUL
\r
267 /* Offset into the Ethernet frame that is used to temporarily store information
\r
268 on the fragmentation status of the packet being sent. The value is important,
\r
269 as it is past the location into which the destination address will get placed. */
\r
270 #define ipFRAGMENTATION_PARAMETERS_OFFSET ( 6 )
\r
271 #define ipSOCKET_OPTIONS_OFFSET ( 6 )
\r
273 /* Only used when outgoing fragmentation is being used (FreeRTOSIPConfig.h
\r
275 #define ipGET_UDP_PAYLOAD_OFFSET_FOR_FRAGMENT( usFragmentOffset ) ( ( ( usFragmentOffset ) == 0 ) ? ipUDP_PAYLOAD_OFFSET_IPv4 : ipIP_PAYLOAD_OFFSET )
\r
277 /* The offset into a UDP packet at which the UDP data (payload) starts. */
\r
278 #define ipUDP_PAYLOAD_OFFSET_IPv4 ( sizeof( UDPPacket_t ) )
\r
280 /* The offset into an IP packet into which the IP data (payload) starts. */
\r
281 #define ipIP_PAYLOAD_OFFSET ( sizeof( IPPacket_t ) )
\r
283 #include "pack_struct_start.h"
\r
284 struct xUDP_IP_FRAGMENT_PARAMETERS
\r
286 uint8_t ucSocketOptions;
\r
287 uint8_t ucPadFor16BitAlignment;
\r
288 uint16_t usFragmentedPacketOffset;
\r
289 uint16_t usFragmentLength;
\r
290 uint16_t usPayloadChecksum;
\r
292 #include "pack_struct_end.h"
\r
293 typedef struct xUDP_IP_FRAGMENT_PARAMETERS IPFragmentParameters_t;
\r
295 #if( ipconfigBYTE_ORDER == pdFREERTOS_LITTLE_ENDIAN )
\r
297 /* Ethernet frame types. */
\r
298 #define ipARP_FRAME_TYPE ( 0x0608U )
\r
299 #define ipIPv4_FRAME_TYPE ( 0x0008U )
\r
301 /* ARP related definitions. */
\r
302 #define ipARP_PROTOCOL_TYPE ( 0x0008U )
\r
303 #define ipARP_HARDWARE_TYPE_ETHERNET ( 0x0100U )
\r
304 #define ipARP_REQUEST ( 0x0100U )
\r
305 #define ipARP_REPLY ( 0x0200U )
\r
309 /* Ethernet frame types. */
\r
310 #define ipARP_FRAME_TYPE ( 0x0806U )
\r
311 #define ipIPv4_FRAME_TYPE ( 0x0800U )
\r
313 /* ARP related definitions. */
\r
314 #define ipARP_PROTOCOL_TYPE ( 0x0800U )
\r
315 #define ipARP_HARDWARE_TYPE_ETHERNET ( 0x0001U )
\r
316 #define ipARP_REQUEST ( 0x0001 )
\r
317 #define ipARP_REPLY ( 0x0002 )
\r
319 #endif /* ipconfigBYTE_ORDER == pdFREERTOS_LITTLE_ENDIAN */
\r
322 /* For convenience, a MAC address of all zeros and another of all 0xffs are
\r
323 defined const for quick reference. */
\r
324 extern const MACAddress_t xBroadcastMACAddress; /* all 0xff's */
\r
325 extern uint16_t usPacketIdentifier;
\r
327 /* Define a default UDP packet header (declared in FreeRTOS_UDP_IP.c) */
\r
328 typedef union xUDPPacketHeader
\r
330 uint8_t ucBytes[24];
\r
331 uint32_t ulWords[6];
\r
332 } UDPPacketHeader_t;
\r
333 extern UDPPacketHeader_t xDefaultPartUDPPacketHeader;
\r
335 /* Structure that stores the netmask, gateway address and DNS server addresses. */
\r
336 extern NetworkAddressingParameters_t xNetworkAddressing;
\r
338 /* Structure that stores the defaults for netmask, gateway address and DNS.
\r
339 These values will be copied to 'xNetworkAddressing' in case DHCP is not used,
\r
340 and also in case DHCP does not lead to a confirmed request. */
\r
341 extern NetworkAddressingParameters_t xDefaultAddressing;
\r
343 /* True when BufferAllocation_1.c was included, false for BufferAllocation_2.c */
\r
344 extern const BaseType_t xBufferAllocFixedSize;
\r
346 /* Defined in FreeRTOS_Sockets.c */
\r
347 #if ( ipconfigUSE_TCP == 1 )
\r
348 extern List_t xBoundTCPSocketsList;
\r
351 /* The local IP address is accessed from within xDefaultPartUDPPacketHeader,
\r
352 rather than duplicated in its own variable. */
\r
353 #define ipLOCAL_IP_ADDRESS_POINTER ( ( uint32_t * ) &( xDefaultPartUDPPacketHeader.ulWords[ 20u / sizeof(uint32_t) ] ) )
\r
355 /* The local MAC address is accessed from within xDefaultPartUDPPacketHeader,
\r
356 rather than duplicated in its own variable. */
\r
357 #define ipLOCAL_MAC_ADDRESS ( &xDefaultPartUDPPacketHeader.ucBytes[0] )
\r
359 /* ICMP packets are sent using the same function as UDP packets. The port
\r
360 number is used to distinguish between the two, as 0 is an invalid UDP port. */
\r
361 #define ipPACKET_CONTAINS_ICMP_DATA ( 0 )
\r
363 /* For now, the lower 8 bits in 'xEventBits' will be reserved for the above
\r
365 #define SOCKET_EVENT_BIT_COUNT 8
\r
367 #define vSetField16( pxBase, xType, xField, usValue ) \
\r
369 ( ( uint8_t* )( pxBase ) ) [ offsetof( xType, xField ) + 0 ] = ( uint8_t ) ( ( usValue ) >> 8 ); \
\r
370 ( ( uint8_t* )( pxBase ) ) [ offsetof( xType, xField ) + 1 ] = ( uint8_t ) ( ( usValue ) & 0xff ); \
\r
373 #define vSetField32( pxBase, xType, xField, ulValue ) \
\r
375 ( (uint8_t*)( pxBase ) ) [ offsetof( xType, xField ) + 0 ] = ( uint8_t ) ( ( ulValue ) >> 24 ); \
\r
376 ( (uint8_t*)( pxBase ) ) [ offsetof( xType, xField ) + 1 ] = ( uint8_t ) ( ( ( ulValue ) >> 16 ) & 0xff ); \
\r
377 ( (uint8_t*)( pxBase ) ) [ offsetof( xType, xField ) + 2 ] = ( uint8_t ) ( ( ( ulValue ) >> 8 ) & 0xff ); \
\r
378 ( (uint8_t*)( pxBase ) ) [ offsetof( xType, xField ) + 3 ] = ( uint8_t ) ( ( ulValue ) & 0xff ); \
\r
381 #define vFlip_16( left, right ) \
\r
383 uint16_t tmp = (left); \
\r
384 (left) = (right); \
\r
388 #define vFlip_32( left, right ) \
\r
390 uint32_t tmp = (left); \
\r
391 (left) = (right); \
\r
396 #define ARRAY_SIZE(x) (BaseType_t)(sizeof(x)/sizeof(x)[0])
\r
400 * A version of FreeRTOS_GetReleaseNetworkBuffer() that can be called from an
\r
401 * interrupt. If a non zero value is returned, then the calling ISR should
\r
402 * perform a context switch before exiting the ISR.
\r
404 BaseType_t FreeRTOS_ReleaseFreeNetworkBufferFromISR( void );
\r
407 * Create a message that contains a command to initialise the network interface.
\r
408 * This is used during initialisation, and at any time the network interface
\r
409 * goes down thereafter. The network interface hardware driver is responsible
\r
410 * for sending the message that contains the network interface down command/
\r
413 * Only use the FreeRTOS_NetworkDownFromISR() version if the function is to be
\r
414 * called from an interrupt service routine. If FreeRTOS_NetworkDownFromISR()
\r
415 * returns a non-zero value then a context switch should be performed ebfore
\r
416 * the interrupt is exited.
\r
418 void FreeRTOS_NetworkDown( void );
\r
419 BaseType_t FreeRTOS_NetworkDownFromISR( void );
\r
422 * Processes incoming ARP packets.
\r
424 eFrameProcessingResult_t eARPProcessPacket( ARPPacket_t * const pxARPFrame );
\r
427 * Inspect an Ethernet frame to see if it contains data that the stack needs to
\r
428 * process. eProcessBuffer is returned if the frame should be processed by the
\r
429 * stack. eReleaseBuffer is returned if the frame should be discarded.
\r
431 eFrameProcessingResult_t eConsiderFrameForProcessing( const uint8_t * const pucEthernetBuffer );
\r
434 * Return the checksum generated over xDataLengthBytes from pucNextData.
\r
436 uint16_t usGenerateChecksum( uint32_t ulSum, const uint8_t * pucNextData, size_t uxDataLengthBytes );
\r
438 /* Socket related private functions. */
\r
441 * The caller must ensure that pxNetworkBuffer->xDataLength is the UDP packet
\r
442 * payload size (excluding packet headers) and that the packet in pucEthernetBuffer
\r
443 * is at least the size of UDPPacket_t.
\r
445 BaseType_t xProcessReceivedUDPPacket( NetworkBufferDescriptor_t *pxNetworkBuffer, uint16_t usPort );
\r
448 * Initialize the socket list data structures for TCP and UDP.
\r
450 BaseType_t vNetworkSocketsInit( void );
\r
453 * Returns pdTRUE if the IP task has been created and is initialised. Otherwise
\r
456 BaseType_t xIPIsNetworkTaskReady( void );
\r
458 #if( ipconfigSOCKET_HAS_USER_WAKE_CALLBACK == 1 )
\r
460 typedef void (*SocketWakeupCallback_t)( struct XSOCKET * pxSocket );
\r
463 #if( ipconfigUSE_TCP == 1 )
\r
466 * Actually a user thing, but because xBoundTCPSocketsList, let it do by the
\r
469 void vTCPNetStat( void );
\r
472 * At least one socket needs to check for timeouts
\r
474 TickType_t xTCPTimerCheck( BaseType_t xWillSleep );
\r
476 /* Every TCP socket has a buffer space just big enough to store
\r
477 the last TCP header received.
\r
478 As a reference of this field may be passed to DMA, force the
\r
479 alignment to 8 bytes. */
\r
484 /* Increase the alignment of this union by adding a 64-bit variable. */
\r
485 uint64_t ullAlignmentWord;
\r
489 /* The next field only serves to give 'ucLastPacket' a correct
\r
490 alignment of 8 + 2. See comments in FreeRTOS_IP.h */
\r
491 uint8_t ucFillPacket[ ipconfigPACKET_FILLER_SIZE ];
\r
492 uint8_t ucLastPacket[ sizeof( TCPPacket_t ) ];
\r
497 * Note that the values of all short and long integers in these structs
\r
498 * are being stored in the native-endian way
\r
499 * Translation should take place when accessing any structure which defines
\r
500 * network packets, such as IPHeader_t and TCPHeader_t
\r
502 typedef struct TCPSOCKET
\r
504 uint32_t ulRemoteIP; /* IP address of remote machine */
\r
505 uint16_t usRemotePort; /* Port on remote machine */
\r
507 /* Most compilers do like bit-flags */
\r
509 bMssChange : 1, /* This socket has seen a change in MSS */
\r
510 bPassAccept : 1, /* when true, this socket may be returned in a call to accept() */
\r
511 bPassQueued : 1, /* when true, this socket is an orphan until it gets connected
\r
512 * Why an orphan? Because it may not be returned in a accept() call until it
\r
513 * gets the state eESTABLISHED */
\r
514 bReuseSocket : 1, /* When a listening socket gets a connection, do not create a new instance but keep on using it */
\r
515 bCloseAfterSend : 1,/* As soon as the last byte has been transmitted, finalise the connection
\r
516 * Useful in e.g. FTP connections, where the last data bytes are sent along with the FIN flag */
\r
517 bUserShutdown : 1, /* User requesting a graceful shutdown */
\r
518 bCloseRequested : 1,/* Request to finalise the connection */
\r
519 bLowWater : 1, /* high-water level has been reached. Cleared as soon as 'rx-count < lo-water' */
\r
520 bWinChange : 1, /* The value of bLowWater has changed, must send a window update */
\r
521 bSendKeepAlive : 1, /* When this flag is true, a TCP keep-alive message must be send */
\r
522 bWaitKeepAlive : 1, /* When this flag is true, a TCP keep-alive reply is expected */
\r
523 bConnPrepared : 1, /* Connecting socket: Message has been prepared */
\r
524 #if( ipconfigSUPPORT_SELECT_FUNCTION == 1 )
\r
525 bConnPassed : 1, /* Connecting socket: Socket has been passed in a successful select() */
\r
526 #endif /* ipconfigSUPPORT_SELECT_FUNCTION */
\r
527 bFinAccepted : 1, /* This socket has received (or sent) a FIN and accepted it */
\r
528 bFinSent : 1, /* We've sent out a FIN */
\r
529 bFinRecv : 1, /* We've received a FIN from our peer */
\r
530 bFinAcked : 1, /* Our FIN packet has been acked */
\r
531 bFinLast : 1, /* The last ACK (after FIN and FIN+ACK) has been sent or will be sent by the peer */
\r
532 bRxStopped : 1, /* Application asked to temporarily stop reception */
\r
533 bMallocError : 1, /* There was an error allocating a stream */
\r
534 bWinScaling : 1; /* A TCP-Window Scaling option was offered and accepted in the SYN phase. */
\r
536 uint32_t ulHighestRxAllowed;
\r
537 /* The highest sequence number that we can receive at any moment */
\r
538 uint16_t usTimeout; /* Time (in ticks) after which this socket needs attention */
\r
539 uint16_t usCurMSS; /* Current Maximum Segment Size */
\r
540 uint16_t usInitMSS; /* Initial maximum segment Size */
\r
541 uint16_t usChildCount; /* In case of a listening socket: number of connections on this port number */
\r
542 uint16_t usBacklog; /* In case of a listening socket: maximum number of concurrent connections on this port number */
\r
543 uint8_t ucRepCount; /* Send repeat count, for retransmissions
\r
544 * This counter is separate from the xmitCount in the
\r
545 * TCP win segments */
\r
546 uint8_t ucTCPState; /* TCP state: see eTCP_STATE */
\r
547 struct XSOCKET *pxPeerSocket; /* for server socket: child, for child socket: parent */
\r
548 #if( ipconfigTCP_KEEP_ALIVE == 1 )
\r
549 uint8_t ucKeepRepCount;
\r
550 TickType_t xLastAliveTime;
\r
551 #endif /* ipconfigTCP_KEEP_ALIVE */
\r
552 #if( ipconfigTCP_HANG_PROTECTION == 1 )
\r
553 TickType_t xLastActTime;
\r
554 #endif /* ipconfigTCP_HANG_PROTECTION */
\r
555 size_t uxLittleSpace;
\r
556 size_t uxEnoughSpace;
\r
557 size_t uxRxStreamSize;
\r
558 size_t uxTxStreamSize;
\r
559 StreamBuffer_t *rxStream;
\r
560 StreamBuffer_t *txStream;
\r
561 #if( ipconfigUSE_TCP_WIN == 1 )
\r
562 NetworkBufferDescriptor_t *pxAckMessage;
\r
563 #endif /* ipconfigUSE_TCP_WIN */
\r
564 /* Buffer space to store the last TCP header received. */
\r
565 LastTCPPacket_t xPacket;
\r
566 uint8_t tcpflags; /* TCP flags */
\r
567 #if( ipconfigUSE_TCP_WIN != 0 )
\r
568 uint8_t ucMyWinScaleFactor;
\r
569 uint8_t ucPeerWinScaleFactor;
\r
571 #if( ipconfigUSE_CALLBACKS == 1 )
\r
572 FOnTCPReceive_t pxHandleReceive; /*
\r
573 * In case of a TCP socket:
\r
574 * typedef void (* FOnTCPReceive_t) (Socket_t xSocket, void *pData, size_t xLength );
\r
576 FOnTCPSent_t pxHandleSent;
\r
577 FOnConnected_t pxHandleConnected; /* Actually type: typedef void (* FOnConnected_t) (Socket_t xSocket, BaseType_t ulConnected ); */
\r
578 #endif /* ipconfigUSE_CALLBACKS */
\r
579 uint32_t ulWindowSize; /* Current Window size advertised by peer */
\r
580 uint32_t ulRxCurWinSize; /* Constantly changing: this is the current size available for data reception */
\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
584 TCPWindow_t xTCPWindow;
\r
587 #endif /* ipconfigUSE_TCP */
\r
589 typedef struct UDPSOCKET
\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
600 FOnUDPSent_t pxHandleSent;
\r
601 #endif /* ipconfigUSE_CALLBACKS */
\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
615 typedef struct XSOCKET
\r
617 EventBits_t xEventBits;
\r
618 EventGroupHandle_t xEventGroup;
\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
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
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
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
656 } FreeRTOS_Socket_t;
\r
658 #if( ipconfigUSE_TCP == 1 )
\r
660 * Lookup a TCP socket, using a multiple matching: both port numbers and
\r
661 * return IP address.
\r
663 FreeRTOS_Socket_t *pxTCPSocketLookup( uint32_t ulLocalIP, UBaseType_t uxLocalPort, uint32_t ulRemoteIP, UBaseType_t uxRemotePort );
\r
665 #endif /* ipconfigUSE_TCP */
\r
668 * Look up a local socket by finding a match with the local port.
\r
670 FreeRTOS_Socket_t *pxUDPSocketLookup( UBaseType_t uxLocalPort );
\r
673 * Called when the application has generated a UDP packet to send.
\r
675 void vProcessGeneratedUDPPacket( NetworkBufferDescriptor_t * const pxNetworkBuffer );
\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
684 uint16_t usGenerateProtocolChecksum( const uint8_t * const pucEthernetBuffer, size_t uxBufferLength, BaseType_t xOutgoingPacket );
\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
690 void vReturnEthernetFrame( NetworkBufferDescriptor_t * pxNetworkBuffer, BaseType_t xReleaseAfterSend );
\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
698 BaseType_t vSocketBind( FreeRTOS_Socket_t *pxSocket, struct freertos_sockaddr * pxAddress, size_t uxAddressLength, BaseType_t xInternal );
\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
707 int32_t lTCPAddRxdata(FreeRTOS_Socket_t *pxSocket, size_t uxOffset, const uint8_t *pcData, uint32_t ulByteCount);
\r
710 * Currently called for any important event.
\r
712 void vSocketWakeUpUser( FreeRTOS_Socket_t *pxSocket );
\r
715 * Some helping function, their meaning should be clear
\r
717 static portINLINE uint32_t ulChar2u32 (const uint8_t *apChr);
\r
718 static portINLINE uint32_t ulChar2u32 (const uint8_t *apChr)
\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
726 static portINLINE uint16_t usChar2u16 (const uint8_t *apChr);
\r
727 static portINLINE uint16_t usChar2u16 (const uint8_t *apChr)
\r
729 return ( uint16_t )
\r
730 ( ( ( ( uint32_t )apChr[0] ) << 8) |
\r
731 ( ( ( uint32_t )apChr[1] ) ) );
\r
734 /* Check a single socket for retransmissions and timeouts */
\r
735 BaseType_t xTCPSocketCheck( FreeRTOS_Socket_t *pxSocket );
\r
737 BaseType_t xTCPCheckNewClient( FreeRTOS_Socket_t *pxSocket );
\r
739 /* Defined in FreeRTOS_Sockets.c
\r
742 void *vSocketClose( FreeRTOS_Socket_t *pxSocket );
\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
749 BaseType_t xSendEventToIPTask( eIPEvent_t eEvent );
\r
752 * The same as above, but a struct as a parameter, containing:
\r
753 * eIPEvent_t eEventType;
\r
756 BaseType_t xSendEventStructToIPTask( const IPStackEvent_t *pxEvent, TickType_t xTimeout );
\r
759 * Returns a pointer to the original NetworkBuffer from a pointer to a UDP
\r
762 NetworkBufferDescriptor_t *pxUDPPayloadBuffer_to_NetworkBuffer( void *pvBuffer );
\r
764 #if( ipconfigZERO_COPY_TX_DRIVER != 0 )
\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
770 NetworkBufferDescriptor_t *pxPacketBuffer_to_NetworkBuffer( const void *pvBuffer );
\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
777 #if( ipconfigUSE_TCP == 1 )
\r
778 void vTCPStateChange( FreeRTOS_Socket_t *pxSocket, enum eTCP_STATE eTCPState );
\r
779 #endif /* ipconfigUSE_TCP */
\r
781 /*_RB_ Should this be part of the public API? */
\r
782 void FreeRTOS_netstat( void );
\r
784 /* Returns pdTRUE is this function is called from the IP-task */
\r
785 BaseType_t xIsCallingFromIPTask( void );
\r
787 #if( ipconfigSUPPORT_SELECT_FUNCTION == 1 )
\r
789 typedef struct xSOCKET_SET
\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
796 extern void vSocketSelect( SocketSelect_t *pxSocketSelect );
\r
798 #endif /* ipconfigSUPPORT_SELECT_FUNCTION */
\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
807 /* Send the network-up event and start the ARP timer. */
\r
808 void vIPNetworkUpCalls( void );
\r
814 #endif /* FREERTOS_IP_PRIVATE_H */
\r