summaryrefslogtreecommitdiff
path: root/FreeRTOS-Plus/Source/FreeRTOS-Plus-TCP/include/FreeRTOS_IP.h
diff options
context:
space:
mode:
Diffstat (limited to 'FreeRTOS-Plus/Source/FreeRTOS-Plus-TCP/include/FreeRTOS_IP.h')
-rw-r--r--FreeRTOS-Plus/Source/FreeRTOS-Plus-TCP/include/FreeRTOS_IP.h674
1 files changed, 337 insertions, 337 deletions
diff --git a/FreeRTOS-Plus/Source/FreeRTOS-Plus-TCP/include/FreeRTOS_IP.h b/FreeRTOS-Plus/Source/FreeRTOS-Plus-TCP/include/FreeRTOS_IP.h
index 6bfb4ad42..46a215777 100644
--- a/FreeRTOS-Plus/Source/FreeRTOS-Plus-TCP/include/FreeRTOS_IP.h
+++ b/FreeRTOS-Plus/Source/FreeRTOS-Plus-TCP/include/FreeRTOS_IP.h
@@ -1,337 +1,337 @@
-/*
- * FreeRTOS+TCP V2.2.0
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of
- * this software and associated documentation files (the "Software"), to deal in
- * the Software without restriction, including without limitation the rights to
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
- * the Software, and to permit persons to whom the Software is furnished to do so,
- * subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- *
- * http://aws.amazon.com/freertos
- * http://www.FreeRTOS.org
- */
-
-#ifndef FREERTOS_IP_H
-#define FREERTOS_IP_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/* Application level configuration options. */
-#include "FreeRTOSIPConfig.h"
-#include "FreeRTOSIPConfigDefaults.h"
-#include "IPTraceMacroDefaults.h"
-
-/* Some constants defining the sizes of several parts of a packet */
-#define ipSIZE_OF_ETH_HEADER 14u
-#define ipSIZE_OF_IPv4_HEADER 20u
-#define ipSIZE_OF_IGMP_HEADER 8u
-#define ipSIZE_OF_ICMP_HEADER 8u
-#define ipSIZE_OF_UDP_HEADER 8u
-#define ipSIZE_OF_TCP_HEADER 20u
-
-
-/* The number of octets in the MAC and IP addresses respectively. */
-#define ipMAC_ADDRESS_LENGTH_BYTES ( 6 )
-#define ipIP_ADDRESS_LENGTH_BYTES ( 4 )
-
-/* IP protocol definitions. */
-#define ipPROTOCOL_ICMP ( 1 )
-#define ipPROTOCOL_IGMP ( 2 )
-#define ipPROTOCOL_TCP ( 6 )
-#define ipPROTOCOL_UDP ( 17 )
-
-/* Dimensions the buffers that are filled by received Ethernet frames. */
-#define ipSIZE_OF_ETH_CRC_BYTES ( 4UL )
-#define ipSIZE_OF_ETH_OPTIONAL_802_1Q_TAG_BYTES ( 4UL )
-#define ipTOTAL_ETHERNET_FRAME_SIZE ( ( ( uint32_t ) ipconfigNETWORK_MTU ) + ( ( uint32_t ) ipSIZE_OF_ETH_HEADER ) + ipSIZE_OF_ETH_CRC_BYTES + ipSIZE_OF_ETH_OPTIONAL_802_1Q_TAG_BYTES )
-
-/*_RB_ Comment may need updating. */
-/* Space left at the beginning of a network buffer storage area to store a
-pointer back to the network buffer. Should be a multiple of 8 to ensure 8 byte
-alignment is maintained on architectures that require it.
-
-In order to get a 32-bit alignment of network packets, an offset of 2 bytes
-would be desirable, as defined by ipconfigPACKET_FILLER_SIZE. So the malloc'd
-buffer will have the following contents:
- uint32_t pointer; // word-aligned
- uchar_8 filler[6];
- << ETH-header >> // half-word-aligned
- uchar_8 dest[6]; // start of pucEthernetBuffer
- uchar_8 dest[6];
- uchar16_t type;
- << IP-header >> // word-aligned
- uint8_t ucVersionHeaderLength;
- etc
- */
-#if( ipconfigBUFFER_PADDING != 0 )
- #define ipBUFFER_PADDING ipconfigBUFFER_PADDING
-#else
- #define ipBUFFER_PADDING ( 8u + ipconfigPACKET_FILLER_SIZE )
-#endif
-
-/* The structure used to store buffers and pass them around the network stack.
-Buffers can be in use by the stack, in use by the network interface hardware
-driver, or free (not in use). */
-typedef struct xNETWORK_BUFFER
-{
- ListItem_t xBufferListItem; /* Used to reference the buffer form the free buffer list or a socket. */
- uint32_t ulIPAddress; /* Source or destination IP address, depending on usage scenario. */
- uint8_t *pucEthernetBuffer; /* Pointer to the start of the Ethernet frame. */
- size_t xDataLength; /* Starts by holding the total Ethernet frame length, then the UDP/TCP payload length. */
- uint16_t usPort; /* Source or destination port, depending on usage scenario. */
- uint16_t usBoundPort; /* The port to which a transmitting socket is bound. */
- #if( ipconfigUSE_LINKED_RX_MESSAGES != 0 )
- struct xNETWORK_BUFFER *pxNextBuffer; /* Possible optimisation for expert users - requires network driver support. */
- #endif
-} NetworkBufferDescriptor_t;
-
-#include "pack_struct_start.h"
-struct xMAC_ADDRESS
-{
- uint8_t ucBytes[ ipMAC_ADDRESS_LENGTH_BYTES ];
-}
-#include "pack_struct_end.h"
-
-typedef struct xMAC_ADDRESS MACAddress_t;
-
-typedef enum eNETWORK_EVENTS
-{
- eNetworkUp, /* The network is configured. */
- eNetworkDown /* The network connection has been lost. */
-} eIPCallbackEvent_t;
-
-typedef enum ePING_REPLY_STATUS
-{
- eSuccess = 0, /* A correct reply has been received for an outgoing ping. */
- eInvalidChecksum, /* A reply was received for an outgoing ping but the checksum of the reply was incorrect. */
- eInvalidData /* A reply was received to an outgoing ping but the payload of the reply was not correct. */
-} ePingReplyStatus_t;
-
-typedef enum eNETWORK_ADDRESS_TYPE
-{
- eNetWorkAddressTypeIPV4,
- eNetWorkAddressTypeIPV6,
- eNetWorkAddressTypeHostName
-} eNetWorkAddressType_t;
-
-/* Endian related definitions. */
-#if( ipconfigBYTE_ORDER == pdFREERTOS_LITTLE_ENDIAN )
-
- /* FreeRTOS_htons / FreeRTOS_htonl: some platforms might have built-in versions
- using a single instruction so allow these versions to be overridden. */
- #ifndef FreeRTOS_htons
- #define FreeRTOS_htons( usIn ) ( (uint16_t) ( ( ( usIn ) << 8U ) | ( ( usIn ) >> 8U ) ) )
- #endif
-
- #ifndef FreeRTOS_htonl
- #define FreeRTOS_htonl( ulIn ) \
- ( \
- ( uint32_t ) \
- ( \
- ( ( ( ( uint32_t ) ( ulIn ) ) ) << 24 ) | \
- ( ( ( ( uint32_t ) ( ulIn ) ) & 0x0000ff00UL ) << 8 ) | \
- ( ( ( ( uint32_t ) ( ulIn ) ) & 0x00ff0000UL ) >> 8 ) | \
- ( ( ( ( uint32_t ) ( ulIn ) ) ) >> 24 ) \
- ) \
- )
- #endif
-
-#else /* ipconfigBYTE_ORDER */
-
- #define FreeRTOS_htons( x ) ( ( uint16_t ) ( x ) )
- #define FreeRTOS_htonl( x ) ( ( uint32_t ) ( x ) )
-
-#endif /* ipconfigBYTE_ORDER == pdFREERTOS_LITTLE_ENDIAN */
-
-#define FreeRTOS_ntohs( x ) FreeRTOS_htons( x )
-#define FreeRTOS_ntohl( x ) FreeRTOS_htonl( x )
-
-#if( ipconfigHAS_INLINE_FUNCTIONS == 1 )
-
- static portINLINE int32_t FreeRTOS_max_int32 (int32_t a, int32_t b);
- static portINLINE uint32_t FreeRTOS_max_uint32 (uint32_t a, uint32_t b);
- static portINLINE int32_t FreeRTOS_min_int32 (int32_t a, int32_t b);
- static portINLINE uint32_t FreeRTOS_min_uint32 (uint32_t a, uint32_t b);
- static portINLINE uint32_t FreeRTOS_round_up (uint32_t a, uint32_t d);
- static portINLINE uint32_t FreeRTOS_round_down (uint32_t a, uint32_t d);
- static portINLINE BaseType_t FreeRTOS_min_BaseType (BaseType_t a, BaseType_t b);
- static portINLINE BaseType_t FreeRTOS_max_BaseType (BaseType_t a, BaseType_t b);
- static portINLINE UBaseType_t FreeRTOS_max_UBaseType (UBaseType_t a, UBaseType_t b);
- static portINLINE UBaseType_t FreeRTOS_min_UBaseType (UBaseType_t a, UBaseType_t b);
-
-
- static portINLINE int32_t FreeRTOS_max_int32 (int32_t a, int32_t b) { return a >= b ? a : b; }
- static portINLINE uint32_t FreeRTOS_max_uint32 (uint32_t a, uint32_t b) { return a >= b ? a : b; }
- static portINLINE int32_t FreeRTOS_min_int32 (int32_t a, int32_t b) { return a <= b ? a : b; }
- static portINLINE uint32_t FreeRTOS_min_uint32 (uint32_t a, uint32_t b) { return a <= b ? a : b; }
- static portINLINE uint32_t FreeRTOS_round_up (uint32_t a, uint32_t d) { return d * ( ( a + d - 1u ) / d ); }
- static portINLINE uint32_t FreeRTOS_round_down (uint32_t a, uint32_t d) { return d * ( a / d ); }
-
- static portINLINE BaseType_t FreeRTOS_max_BaseType (BaseType_t a, BaseType_t b) { return a >= b ? a : b; }
- static portINLINE UBaseType_t FreeRTOS_max_UBaseType (UBaseType_t a, UBaseType_t b) { return a >= b ? a : b; }
- static portINLINE BaseType_t FreeRTOS_min_BaseType (BaseType_t a, BaseType_t b) { return a <= b ? a : b; }
- static portINLINE UBaseType_t FreeRTOS_min_UBaseType (UBaseType_t a, UBaseType_t b) { return a <= b ? a : b; }
-
-#else
-
- #define FreeRTOS_max_int32(a,b) ( ( ( int32_t ) ( a ) ) >= ( ( int32_t ) ( b ) ) ? ( ( int32_t ) ( a ) ) : ( ( int32_t ) ( b ) ) )
- #define FreeRTOS_max_uint32(a,b) ( ( ( uint32_t ) ( a ) ) >= ( ( uint32_t ) ( b ) ) ? ( ( uint32_t ) ( a ) ) : ( ( uint32_t ) ( b ) ) )
-
- #define FreeRTOS_min_int32(a,b) ( ( ( int32_t ) a ) <= ( ( int32_t ) b ) ? ( ( int32_t ) a ) : ( ( int32_t ) b ) )
- #define FreeRTOS_min_uint32(a,b) ( ( ( uint32_t ) a ) <= ( ( uint32_t ) b ) ? ( ( uint32_t ) a ) : ( ( uint32_t ) b ) )
-
- /* Round-up: a = d * ( ( a + d - 1 ) / d ) */
- #define FreeRTOS_round_up(a,d) ( ( ( uint32_t ) ( d ) ) * ( ( ( ( uint32_t ) ( a ) ) + ( ( uint32_t ) ( d ) ) - 1UL ) / ( ( uint32_t ) ( d ) ) ) )
- #define FreeRTOS_round_down(a,d) ( ( ( uint32_t ) ( d ) ) * ( ( ( uint32_t ) ( a ) ) / ( ( uint32_t ) ( d ) ) ) )
-
- #define FreeRTOS_ms_to_tick(ms) ( ( ms * configTICK_RATE_HZ + 500 ) / 1000 )
-
- #define FreeRTOS_max_BaseType(a, b) ( ( ( BaseType_t ) ( a ) ) >= ( ( BaseType_t ) ( b ) ) ? ( ( BaseType_t ) ( a ) ) : ( ( BaseType_t ) ( b ) ) )
- #define FreeRTOS_max_UBaseType(a, b) ( ( ( UBaseType_t ) ( a ) ) >= ( ( UBaseType_t ) ( b ) ) ? ( ( UBaseType_t ) ( a ) ) : ( ( UBaseType_t ) ( b ) ) )
- #define FreeRTOS_min_BaseType(a, b) ( ( ( BaseType_t ) ( a ) ) <= ( ( BaseType_t ) ( b ) ) ? ( ( BaseType_t ) ( a ) ) : ( ( BaseType_t ) ( b ) ) )
- #define FreeRTOS_min_UBaseType(a, b) ( ( ( UBaseType_t ) ( a ) ) <= ( ( UBaseType_t ) ( b ) ) ? ( ( UBaseType_t ) ( a ) ) : ( ( UBaseType_t ) ( b ) ) )
-
-#endif /* ipconfigHAS_INLINE_FUNCTIONS */
-
-#define pdMS_TO_MIN_TICKS( xTimeInMs ) ( pdMS_TO_TICKS( ( xTimeInMs ) ) < ( ( TickType_t ) 1 ) ? ( ( TickType_t ) 1 ) : pdMS_TO_TICKS( ( xTimeInMs ) ) )
-
-#ifndef pdTRUE_SIGNED
- /* Temporary solution: eventually the defines below will appear in 'Source\include\projdefs.h' */
- #define pdTRUE_SIGNED pdTRUE
- #define pdFALSE_SIGNED pdFALSE
- #define pdTRUE_UNSIGNED ( ( UBaseType_t ) 1u )
- #define pdFALSE_UNSIGNED ( ( UBaseType_t ) 0u )
-#endif
-
-/*
- * FULL, UP-TO-DATE AND MAINTAINED REFERENCE DOCUMENTATION FOR ALL THESE
- * FUNCTIONS IS AVAILABLE ON THE FOLLOWING URL:
- * http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/FreeRTOS_TCP_API_Functions.html
- */
-BaseType_t FreeRTOS_IPInit( const uint8_t ucIPAddress[ ipIP_ADDRESS_LENGTH_BYTES ],
- const uint8_t ucNetMask[ ipIP_ADDRESS_LENGTH_BYTES ],
- const uint8_t ucGatewayAddress[ ipIP_ADDRESS_LENGTH_BYTES ],
- const uint8_t ucDNSServerAddress[ ipIP_ADDRESS_LENGTH_BYTES ],
- const uint8_t ucMACAddress[ ipMAC_ADDRESS_LENGTH_BYTES ] );
-
-void * FreeRTOS_GetUDPPayloadBuffer( size_t xRequestedSizeBytes, TickType_t xBlockTimeTicks );
-void FreeRTOS_GetAddressConfiguration( uint32_t *pulIPAddress, uint32_t *pulNetMask, uint32_t *pulGatewayAddress, uint32_t *pulDNSServerAddress );
-void FreeRTOS_SetAddressConfiguration( const uint32_t *pulIPAddress, const uint32_t *pulNetMask, const uint32_t *pulGatewayAddress, const uint32_t *pulDNSServerAddress );
-BaseType_t FreeRTOS_SendPingRequest( uint32_t ulIPAddress, size_t xNumberOfBytesToSend, TickType_t xBlockTimeTicks );
-void FreeRTOS_ReleaseUDPPayloadBuffer( void *pvBuffer );
-const uint8_t * FreeRTOS_GetMACAddress( void );
-void FreeRTOS_UpdateMACAddress( const uint8_t ucMACAddress[ipMAC_ADDRESS_LENGTH_BYTES] );
-void vApplicationIPNetworkEventHook( eIPCallbackEvent_t eNetworkEvent );
-void vApplicationPingReplyHook( ePingReplyStatus_t eStatus, uint16_t usIdentifier );
-uint32_t FreeRTOS_GetIPAddress( void );
-void FreeRTOS_SetIPAddress( uint32_t ulIPAddress );
-void FreeRTOS_SetNetmask( uint32_t ulNetmask );
-void FreeRTOS_SetGatewayAddress( uint32_t ulGatewayAddress );
-uint32_t FreeRTOS_GetGatewayAddress( void );
-uint32_t FreeRTOS_GetDNSServerAddress( void );
-uint32_t FreeRTOS_GetNetmask( void );
-void FreeRTOS_OutputARPRequest( uint32_t ulIPAddress );
-BaseType_t FreeRTOS_IsNetworkUp( void );
-
-#if( ipconfigCHECK_IP_QUEUE_SPACE != 0 )
- UBaseType_t uxGetMinimumIPQueueSpace( void );
-#endif
-
-/*
- * Defined in FreeRTOS_Sockets.c
- * //_RB_ Don't think this comment is correct. If this is for internal use only it should appear after all the public API functions and not start with FreeRTOS_.
- * Socket has had activity, reset the timer so it will not be closed
- * because of inactivity
- */
-const char *FreeRTOS_GetTCPStateName( UBaseType_t ulState);
-
-/* _HT_ Temporary: show all valid ARP entries
- */
-void FreeRTOS_PrintARPCache( void );
-void FreeRTOS_ClearARP( void );
-
-#if( ipconfigDHCP_REGISTER_HOSTNAME == 1 )
-
- /* DHCP has an option for clients to register their hostname. It doesn't
- have much use, except that a device can be found in a router along with its
- name. If this option is used the callback below must be provided by the
- application writer to return a const string, denoting the device's name. */
- const char *pcApplicationHostnameHook( void );
-
-#endif /* ipconfigDHCP_REGISTER_HOSTNAME */
-
-
-/* This xApplicationGetRandomNumber() will set *pulNumber to a random number,
-and return pdTRUE. When the random number generator is broken, it shall return
-pdFALSE.
-The function is defined in 'iot_secure_sockets.c'.
-If that module is not included in the project, the application must provide an
-implementation of it.
-The macro's ipconfigRAND32() and configRAND32() are not in use anymore. */
-BaseType_t xApplicationGetRandomNumber( uint32_t *pulNumber );
-
-/* For backward compatibility define old structure names to the newer equivalent
-structure name. */
-#ifndef ipconfigENABLE_BACKWARD_COMPATIBILITY
- #define ipconfigENABLE_BACKWARD_COMPATIBILITY 1
-#endif
-
-#if( ipconfigENABLE_BACKWARD_COMPATIBILITY == 1 )
- #define xIPStackEvent_t IPStackEvent_t
- #define xNetworkBufferDescriptor_t NetworkBufferDescriptor_t
- #define xMACAddress_t MACAddress_t
- #define xWinProperties_t WinProperties_t
- #define xSocket_t Socket_t
- #define xSocketSet_t SocketSet_t
- #define ipSIZE_OF_IP_HEADER ipSIZE_OF_IPv4_HEADER
-
- /* Since August 2016, the public types and fields below have changed name:
- abbreviations TCP/UDP are now written in capitals, and type names now end with "_t". */
- #define FOnConnected FOnConnected_t
- #define FOnTcpReceive FOnTCPReceive_t
- #define FOnTcpSent FOnTCPSent_t
- #define FOnUdpReceive FOnUDPReceive_t
- #define FOnUdpSent FOnUDPSent_t
-
- #define pOnTcpConnected pxOnTCPConnected
- #define pOnTcpReceive pxOnTCPReceive
- #define pOnTcpSent pxOnTCPSent
- #define pOnUdpReceive pxOnUDPReceive
- #define pOnUdpSent pxOnUDPSent
-
- #define FOnUdpSent FOnUDPSent_t
- #define FOnTcpSent FOnTCPSent_t
-#endif /* ipconfigENABLE_BACKWARD_COMPATIBILITY */
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif
-
-#endif /* FREERTOS_IP_H */
-
-
-
-
-
-
-
-
-
-
-
-
-
+/*
+ * FreeRTOS+TCP V2.2.0
+ * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * http://aws.amazon.com/freertos
+ * http://www.FreeRTOS.org
+ */
+
+#ifndef FREERTOS_IP_H
+#define FREERTOS_IP_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* Application level configuration options. */
+#include "FreeRTOSIPConfig.h"
+#include "FreeRTOSIPConfigDefaults.h"
+#include "IPTraceMacroDefaults.h"
+
+/* Some constants defining the sizes of several parts of a packet */
+#define ipSIZE_OF_ETH_HEADER 14u
+#define ipSIZE_OF_IPv4_HEADER 20u
+#define ipSIZE_OF_IGMP_HEADER 8u
+#define ipSIZE_OF_ICMP_HEADER 8u
+#define ipSIZE_OF_UDP_HEADER 8u
+#define ipSIZE_OF_TCP_HEADER 20u
+
+
+/* The number of octets in the MAC and IP addresses respectively. */
+#define ipMAC_ADDRESS_LENGTH_BYTES ( 6 )
+#define ipIP_ADDRESS_LENGTH_BYTES ( 4 )
+
+/* IP protocol definitions. */
+#define ipPROTOCOL_ICMP ( 1 )
+#define ipPROTOCOL_IGMP ( 2 )
+#define ipPROTOCOL_TCP ( 6 )
+#define ipPROTOCOL_UDP ( 17 )
+
+/* Dimensions the buffers that are filled by received Ethernet frames. */
+#define ipSIZE_OF_ETH_CRC_BYTES ( 4UL )
+#define ipSIZE_OF_ETH_OPTIONAL_802_1Q_TAG_BYTES ( 4UL )
+#define ipTOTAL_ETHERNET_FRAME_SIZE ( ( ( uint32_t ) ipconfigNETWORK_MTU ) + ( ( uint32_t ) ipSIZE_OF_ETH_HEADER ) + ipSIZE_OF_ETH_CRC_BYTES + ipSIZE_OF_ETH_OPTIONAL_802_1Q_TAG_BYTES )
+
+/*_RB_ Comment may need updating. */
+/* Space left at the beginning of a network buffer storage area to store a
+pointer back to the network buffer. Should be a multiple of 8 to ensure 8 byte
+alignment is maintained on architectures that require it.
+
+In order to get a 32-bit alignment of network packets, an offset of 2 bytes
+would be desirable, as defined by ipconfigPACKET_FILLER_SIZE. So the malloc'd
+buffer will have the following contents:
+ uint32_t pointer; // word-aligned
+ uchar_8 filler[6];
+ << ETH-header >> // half-word-aligned
+ uchar_8 dest[6]; // start of pucEthernetBuffer
+ uchar_8 dest[6];
+ uchar16_t type;
+ << IP-header >> // word-aligned
+ uint8_t ucVersionHeaderLength;
+ etc
+ */
+#if( ipconfigBUFFER_PADDING != 0 )
+ #define ipBUFFER_PADDING ipconfigBUFFER_PADDING
+#else
+ #define ipBUFFER_PADDING ( 8u + ipconfigPACKET_FILLER_SIZE )
+#endif
+
+/* The structure used to store buffers and pass them around the network stack.
+Buffers can be in use by the stack, in use by the network interface hardware
+driver, or free (not in use). */
+typedef struct xNETWORK_BUFFER
+{
+ ListItem_t xBufferListItem; /* Used to reference the buffer form the free buffer list or a socket. */
+ uint32_t ulIPAddress; /* Source or destination IP address, depending on usage scenario. */
+ uint8_t *pucEthernetBuffer; /* Pointer to the start of the Ethernet frame. */
+ size_t xDataLength; /* Starts by holding the total Ethernet frame length, then the UDP/TCP payload length. */
+ uint16_t usPort; /* Source or destination port, depending on usage scenario. */
+ uint16_t usBoundPort; /* The port to which a transmitting socket is bound. */
+ #if( ipconfigUSE_LINKED_RX_MESSAGES != 0 )
+ struct xNETWORK_BUFFER *pxNextBuffer; /* Possible optimisation for expert users - requires network driver support. */
+ #endif
+} NetworkBufferDescriptor_t;
+
+#include "pack_struct_start.h"
+struct xMAC_ADDRESS
+{
+ uint8_t ucBytes[ ipMAC_ADDRESS_LENGTH_BYTES ];
+}
+#include "pack_struct_end.h"
+
+typedef struct xMAC_ADDRESS MACAddress_t;
+
+typedef enum eNETWORK_EVENTS
+{
+ eNetworkUp, /* The network is configured. */
+ eNetworkDown /* The network connection has been lost. */
+} eIPCallbackEvent_t;
+
+typedef enum ePING_REPLY_STATUS
+{
+ eSuccess = 0, /* A correct reply has been received for an outgoing ping. */
+ eInvalidChecksum, /* A reply was received for an outgoing ping but the checksum of the reply was incorrect. */
+ eInvalidData /* A reply was received to an outgoing ping but the payload of the reply was not correct. */
+} ePingReplyStatus_t;
+
+typedef enum eNETWORK_ADDRESS_TYPE
+{
+ eNetWorkAddressTypeIPV4,
+ eNetWorkAddressTypeIPV6,
+ eNetWorkAddressTypeHostName
+} eNetWorkAddressType_t;
+
+/* Endian related definitions. */
+#if( ipconfigBYTE_ORDER == pdFREERTOS_LITTLE_ENDIAN )
+
+ /* FreeRTOS_htons / FreeRTOS_htonl: some platforms might have built-in versions
+ using a single instruction so allow these versions to be overridden. */
+ #ifndef FreeRTOS_htons
+ #define FreeRTOS_htons( usIn ) ( (uint16_t) ( ( ( usIn ) << 8U ) | ( ( usIn ) >> 8U ) ) )
+ #endif
+
+ #ifndef FreeRTOS_htonl
+ #define FreeRTOS_htonl( ulIn ) \
+ ( \
+ ( uint32_t ) \
+ ( \
+ ( ( ( ( uint32_t ) ( ulIn ) ) ) << 24 ) | \
+ ( ( ( ( uint32_t ) ( ulIn ) ) & 0x0000ff00UL ) << 8 ) | \
+ ( ( ( ( uint32_t ) ( ulIn ) ) & 0x00ff0000UL ) >> 8 ) | \
+ ( ( ( ( uint32_t ) ( ulIn ) ) ) >> 24 ) \
+ ) \
+ )
+ #endif
+
+#else /* ipconfigBYTE_ORDER */
+
+ #define FreeRTOS_htons( x ) ( ( uint16_t ) ( x ) )
+ #define FreeRTOS_htonl( x ) ( ( uint32_t ) ( x ) )
+
+#endif /* ipconfigBYTE_ORDER == pdFREERTOS_LITTLE_ENDIAN */
+
+#define FreeRTOS_ntohs( x ) FreeRTOS_htons( x )
+#define FreeRTOS_ntohl( x ) FreeRTOS_htonl( x )
+
+#if( ipconfigHAS_INLINE_FUNCTIONS == 1 )
+
+ static portINLINE int32_t FreeRTOS_max_int32 (int32_t a, int32_t b);
+ static portINLINE uint32_t FreeRTOS_max_uint32 (uint32_t a, uint32_t b);
+ static portINLINE int32_t FreeRTOS_min_int32 (int32_t a, int32_t b);
+ static portINLINE uint32_t FreeRTOS_min_uint32 (uint32_t a, uint32_t b);
+ static portINLINE uint32_t FreeRTOS_round_up (uint32_t a, uint32_t d);
+ static portINLINE uint32_t FreeRTOS_round_down (uint32_t a, uint32_t d);
+ static portINLINE BaseType_t FreeRTOS_min_BaseType (BaseType_t a, BaseType_t b);
+ static portINLINE BaseType_t FreeRTOS_max_BaseType (BaseType_t a, BaseType_t b);
+ static portINLINE UBaseType_t FreeRTOS_max_UBaseType (UBaseType_t a, UBaseType_t b);
+ static portINLINE UBaseType_t FreeRTOS_min_UBaseType (UBaseType_t a, UBaseType_t b);
+
+
+ static portINLINE int32_t FreeRTOS_max_int32 (int32_t a, int32_t b) { return a >= b ? a : b; }
+ static portINLINE uint32_t FreeRTOS_max_uint32 (uint32_t a, uint32_t b) { return a >= b ? a : b; }
+ static portINLINE int32_t FreeRTOS_min_int32 (int32_t a, int32_t b) { return a <= b ? a : b; }
+ static portINLINE uint32_t FreeRTOS_min_uint32 (uint32_t a, uint32_t b) { return a <= b ? a : b; }
+ static portINLINE uint32_t FreeRTOS_round_up (uint32_t a, uint32_t d) { return d * ( ( a + d - 1u ) / d ); }
+ static portINLINE uint32_t FreeRTOS_round_down (uint32_t a, uint32_t d) { return d * ( a / d ); }
+
+ static portINLINE BaseType_t FreeRTOS_max_BaseType (BaseType_t a, BaseType_t b) { return a >= b ? a : b; }
+ static portINLINE UBaseType_t FreeRTOS_max_UBaseType (UBaseType_t a, UBaseType_t b) { return a >= b ? a : b; }
+ static portINLINE BaseType_t FreeRTOS_min_BaseType (BaseType_t a, BaseType_t b) { return a <= b ? a : b; }
+ static portINLINE UBaseType_t FreeRTOS_min_UBaseType (UBaseType_t a, UBaseType_t b) { return a <= b ? a : b; }
+
+#else
+
+ #define FreeRTOS_max_int32(a,b) ( ( ( int32_t ) ( a ) ) >= ( ( int32_t ) ( b ) ) ? ( ( int32_t ) ( a ) ) : ( ( int32_t ) ( b ) ) )
+ #define FreeRTOS_max_uint32(a,b) ( ( ( uint32_t ) ( a ) ) >= ( ( uint32_t ) ( b ) ) ? ( ( uint32_t ) ( a ) ) : ( ( uint32_t ) ( b ) ) )
+
+ #define FreeRTOS_min_int32(a,b) ( ( ( int32_t ) a ) <= ( ( int32_t ) b ) ? ( ( int32_t ) a ) : ( ( int32_t ) b ) )
+ #define FreeRTOS_min_uint32(a,b) ( ( ( uint32_t ) a ) <= ( ( uint32_t ) b ) ? ( ( uint32_t ) a ) : ( ( uint32_t ) b ) )
+
+ /* Round-up: a = d * ( ( a + d - 1 ) / d ) */
+ #define FreeRTOS_round_up(a,d) ( ( ( uint32_t ) ( d ) ) * ( ( ( ( uint32_t ) ( a ) ) + ( ( uint32_t ) ( d ) ) - 1UL ) / ( ( uint32_t ) ( d ) ) ) )
+ #define FreeRTOS_round_down(a,d) ( ( ( uint32_t ) ( d ) ) * ( ( ( uint32_t ) ( a ) ) / ( ( uint32_t ) ( d ) ) ) )
+
+ #define FreeRTOS_ms_to_tick(ms) ( ( ms * configTICK_RATE_HZ + 500 ) / 1000 )
+
+ #define FreeRTOS_max_BaseType(a, b) ( ( ( BaseType_t ) ( a ) ) >= ( ( BaseType_t ) ( b ) ) ? ( ( BaseType_t ) ( a ) ) : ( ( BaseType_t ) ( b ) ) )
+ #define FreeRTOS_max_UBaseType(a, b) ( ( ( UBaseType_t ) ( a ) ) >= ( ( UBaseType_t ) ( b ) ) ? ( ( UBaseType_t ) ( a ) ) : ( ( UBaseType_t ) ( b ) ) )
+ #define FreeRTOS_min_BaseType(a, b) ( ( ( BaseType_t ) ( a ) ) <= ( ( BaseType_t ) ( b ) ) ? ( ( BaseType_t ) ( a ) ) : ( ( BaseType_t ) ( b ) ) )
+ #define FreeRTOS_min_UBaseType(a, b) ( ( ( UBaseType_t ) ( a ) ) <= ( ( UBaseType_t ) ( b ) ) ? ( ( UBaseType_t ) ( a ) ) : ( ( UBaseType_t ) ( b ) ) )
+
+#endif /* ipconfigHAS_INLINE_FUNCTIONS */
+
+#define pdMS_TO_MIN_TICKS( xTimeInMs ) ( pdMS_TO_TICKS( ( xTimeInMs ) ) < ( ( TickType_t ) 1 ) ? ( ( TickType_t ) 1 ) : pdMS_TO_TICKS( ( xTimeInMs ) ) )
+
+#ifndef pdTRUE_SIGNED
+ /* Temporary solution: eventually the defines below will appear in 'Source\include\projdefs.h' */
+ #define pdTRUE_SIGNED pdTRUE
+ #define pdFALSE_SIGNED pdFALSE
+ #define pdTRUE_UNSIGNED ( ( UBaseType_t ) 1u )
+ #define pdFALSE_UNSIGNED ( ( UBaseType_t ) 0u )
+#endif
+
+/*
+ * FULL, UP-TO-DATE AND MAINTAINED REFERENCE DOCUMENTATION FOR ALL THESE
+ * FUNCTIONS IS AVAILABLE ON THE FOLLOWING URL:
+ * http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/FreeRTOS_TCP_API_Functions.html
+ */
+BaseType_t FreeRTOS_IPInit( const uint8_t ucIPAddress[ ipIP_ADDRESS_LENGTH_BYTES ],
+ const uint8_t ucNetMask[ ipIP_ADDRESS_LENGTH_BYTES ],
+ const uint8_t ucGatewayAddress[ ipIP_ADDRESS_LENGTH_BYTES ],
+ const uint8_t ucDNSServerAddress[ ipIP_ADDRESS_LENGTH_BYTES ],
+ const uint8_t ucMACAddress[ ipMAC_ADDRESS_LENGTH_BYTES ] );
+
+void * FreeRTOS_GetUDPPayloadBuffer( size_t xRequestedSizeBytes, TickType_t xBlockTimeTicks );
+void FreeRTOS_GetAddressConfiguration( uint32_t *pulIPAddress, uint32_t *pulNetMask, uint32_t *pulGatewayAddress, uint32_t *pulDNSServerAddress );
+void FreeRTOS_SetAddressConfiguration( const uint32_t *pulIPAddress, const uint32_t *pulNetMask, const uint32_t *pulGatewayAddress, const uint32_t *pulDNSServerAddress );
+BaseType_t FreeRTOS_SendPingRequest( uint32_t ulIPAddress, size_t xNumberOfBytesToSend, TickType_t xBlockTimeTicks );
+void FreeRTOS_ReleaseUDPPayloadBuffer( void *pvBuffer );
+const uint8_t * FreeRTOS_GetMACAddress( void );
+void FreeRTOS_UpdateMACAddress( const uint8_t ucMACAddress[ipMAC_ADDRESS_LENGTH_BYTES] );
+void vApplicationIPNetworkEventHook( eIPCallbackEvent_t eNetworkEvent );
+void vApplicationPingReplyHook( ePingReplyStatus_t eStatus, uint16_t usIdentifier );
+uint32_t FreeRTOS_GetIPAddress( void );
+void FreeRTOS_SetIPAddress( uint32_t ulIPAddress );
+void FreeRTOS_SetNetmask( uint32_t ulNetmask );
+void FreeRTOS_SetGatewayAddress( uint32_t ulGatewayAddress );
+uint32_t FreeRTOS_GetGatewayAddress( void );
+uint32_t FreeRTOS_GetDNSServerAddress( void );
+uint32_t FreeRTOS_GetNetmask( void );
+void FreeRTOS_OutputARPRequest( uint32_t ulIPAddress );
+BaseType_t FreeRTOS_IsNetworkUp( void );
+
+#if( ipconfigCHECK_IP_QUEUE_SPACE != 0 )
+ UBaseType_t uxGetMinimumIPQueueSpace( void );
+#endif
+
+/*
+ * Defined in FreeRTOS_Sockets.c
+ * //_RB_ Don't think this comment is correct. If this is for internal use only it should appear after all the public API functions and not start with FreeRTOS_.
+ * Socket has had activity, reset the timer so it will not be closed
+ * because of inactivity
+ */
+const char *FreeRTOS_GetTCPStateName( UBaseType_t ulState);
+
+/* _HT_ Temporary: show all valid ARP entries
+ */
+void FreeRTOS_PrintARPCache( void );
+void FreeRTOS_ClearARP( void );
+
+#if( ipconfigDHCP_REGISTER_HOSTNAME == 1 )
+
+ /* DHCP has an option for clients to register their hostname. It doesn't
+ have much use, except that a device can be found in a router along with its
+ name. If this option is used the callback below must be provided by the
+ application writer to return a const string, denoting the device's name. */
+ const char *pcApplicationHostnameHook( void );
+
+#endif /* ipconfigDHCP_REGISTER_HOSTNAME */
+
+
+/* This xApplicationGetRandomNumber() will set *pulNumber to a random number,
+and return pdTRUE. When the random number generator is broken, it shall return
+pdFALSE.
+The function is defined in 'iot_secure_sockets.c'.
+If that module is not included in the project, the application must provide an
+implementation of it.
+The macro's ipconfigRAND32() and configRAND32() are not in use anymore. */
+BaseType_t xApplicationGetRandomNumber( uint32_t *pulNumber );
+
+/* For backward compatibility define old structure names to the newer equivalent
+structure name. */
+#ifndef ipconfigENABLE_BACKWARD_COMPATIBILITY
+ #define ipconfigENABLE_BACKWARD_COMPATIBILITY 1
+#endif
+
+#if( ipconfigENABLE_BACKWARD_COMPATIBILITY == 1 )
+ #define xIPStackEvent_t IPStackEvent_t
+ #define xNetworkBufferDescriptor_t NetworkBufferDescriptor_t
+ #define xMACAddress_t MACAddress_t
+ #define xWinProperties_t WinProperties_t
+ #define xSocket_t Socket_t
+ #define xSocketSet_t SocketSet_t
+ #define ipSIZE_OF_IP_HEADER ipSIZE_OF_IPv4_HEADER
+
+ /* Since August 2016, the public types and fields below have changed name:
+ abbreviations TCP/UDP are now written in capitals, and type names now end with "_t". */
+ #define FOnConnected FOnConnected_t
+ #define FOnTcpReceive FOnTCPReceive_t
+ #define FOnTcpSent FOnTCPSent_t
+ #define FOnUdpReceive FOnUDPReceive_t
+ #define FOnUdpSent FOnUDPSent_t
+
+ #define pOnTcpConnected pxOnTCPConnected
+ #define pOnTcpReceive pxOnTCPReceive
+ #define pOnTcpSent pxOnTCPSent
+ #define pOnUdpReceive pxOnUDPReceive
+ #define pOnUdpSent pxOnUDPSent
+
+ #define FOnUdpSent FOnUDPSent_t
+ #define FOnTcpSent FOnTCPSent_t
+#endif /* ipconfigENABLE_BACKWARD_COMPATIBILITY */
+
+#ifdef __cplusplus
+} /* extern "C" */
+#endif
+
+#endif /* FREERTOS_IP_H */
+
+
+
+
+
+
+
+
+
+
+
+
+
View Lorry Controller Status