1 /*
2  * FreeRTOS+TCP <DEVELOPMENT BRANCH>
3  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
4  *
5  * SPDX-License-Identifier: MIT
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a copy of
8  * this software and associated documentation files (the "Software"), to deal in
9  * the Software without restriction, including without limitation the rights to
10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
11  * the Software, and to permit persons to whom the Software is furnished to do so,
12  * subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in all
15  * copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
19  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
20  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
21  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  *
24  * http://aws.amazon.com/freertos
25  * http://www.FreeRTOS.org
26  */
27 
28 #ifndef LIST_MACRO_H
29 #define LIST_MACRO_H
30 
31 #include "FreeRTOS.h"
32 #include "portmacro.h"
33 #include "list.h"
34 
35 #undef listSET_LIST_ITEM_OWNER
36 void listSET_LIST_ITEM_OWNER( ListItem_t * pxListItem,
37                               void * owner );
38 
39 #undef listGET_HEAD_ENTRY
40 ListItem_t * listGET_HEAD_ENTRY( List_t * pxList );
41 
42 #undef listGET_END_MARKER
43 ListItem_t * listGET_END_MARKER( List_t * pxList );
44 
45 #undef listGET_NEXT
46 ListItem_t * listGET_NEXT( const ListItem_t * pxListItem );
47 
48 #undef  listLIST_IS_EMPTY
49 BaseType_t listLIST_IS_EMPTY( const List_t * pxList );
50 
51 #undef  listGET_OWNER_OF_HEAD_ENTRY
52 void * listGET_OWNER_OF_HEAD_ENTRY( const List_t * pxList );
53 
54 #undef listIS_CONTAINED_WITHIN
55 BaseType_t listIS_CONTAINED_WITHIN( List_t * list,
56                                     const ListItem_t * listItem );
57 
58 #undef listGET_LIST_ITEM_VALUE
59 TickType_t listGET_LIST_ITEM_VALUE( const ListItem_t * listItem );
60 
61 #undef listSET_LIST_ITEM_VALUE
62 void listSET_LIST_ITEM_VALUE( ListItem_t * listItem,
63                               TickType_t itemValue );
64 
65 
66 #undef listLIST_ITEM_CONTAINER
67 List_t * listLIST_ITEM_CONTAINER( const ListItem_t * listItem );
68 
69 #undef listCURRENT_LIST_LENGTH
70 UBaseType_t listCURRENT_LIST_LENGTH( List_t * list );
71 
72 #undef listGET_ITEM_VALUE_OF_HEAD_ENTRY
73 TickType_t listGET_ITEM_VALUE_OF_HEAD_ENTRY( List_t * list );
74 
75 #undef listGET_LIST_ITEM_OWNER
76 void * listGET_LIST_ITEM_OWNER( const ListItem_t * listItem );
77 
78 #undef listLIST_IS_INITIALISED
79 BaseType_t listLIST_IS_INITIALISED( List_t * pxList );
80 
81 /*
82  * Returns pdTRUE if the IP task has been created and is initialised.  Otherwise
83  * returns pdFALSE.
84  */
85 BaseType_t xIPIsNetworkTaskReady( void );
86 
87 /*
88  * The same as above, but a struct as a parameter, containing:
89  *      eIPEvent_t eEventType;
90  *      void *pvData;
91  */
92 BaseType_t xSendEventStructToIPTask( const IPStackEvent_t * pxEvent,
93                                      TickType_t uxTimeout );
94 
95 /* Returns pdTRUE is this function is called from the IP-task */
96 BaseType_t xIsCallingFromIPTask( void );
97 
98 /* Get the size of the IP-header.
99  * 'usFrameType' must be filled in if IPv6is to be recognised. */
100 size_t uxIPHeaderSizePacket( const NetworkBufferDescriptor_t * pxNetworkBuffer );
101 
102 /*
103  * Returns a pointer to the original NetworkBuffer from a pointer to a UDP
104  * payload buffer.
105  */
106 NetworkBufferDescriptor_t * pxUDPPayloadBuffer_to_NetworkBuffer( const void * pvBuffer );
107 
108 /*
109  * Send the event eEvent to the IP task event queue, using a block time of
110  * zero.  Return pdPASS if the message was sent successfully, otherwise return
111  * pdFALSE.
112  */
113 BaseType_t xSendEventToIPTask( eIPEvent_t eEvent );
114 
115 /*
116  * Internal: Sets a new state for a TCP socket and performs the necessary
117  * actions like calling a OnConnected handler to notify the socket owner.
118  */
119 #if ( ipconfigUSE_TCP == 1 )
120     void vTCPStateChange( FreeRTOS_Socket_t * pxSocket,
121                           enum eTCP_STATE eTCPState );
122 #endif /* ipconfigUSE_TCP */
123 
124 /* Check a single socket for retransmissions and timeouts */
125 BaseType_t xTCPSocketCheck( FreeRTOS_Socket_t * pxSocket );
126 
127 /* Get the size of the IP-header.
128  * The socket is checked for its type: IPv4 or IPv6. */
129 size_t uxIPHeaderSizeSocket( const FreeRTOS_Socket_t * pxSocket );
130 
131 #endif /* ifndef LIST_MACRO_H */
132