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 #include "FreeRTOS_IPv6_Private.h"
35 
36 #undef listSET_LIST_ITEM_OWNER
37 void listSET_LIST_ITEM_OWNER( ListItem_t * pxListItem,
38                               void * owner );
39 
40 #undef listGET_END_MARKER
41 ListItem_t * listGET_END_MARKER( List_t * pxList );
42 
43 #undef listGET_NEXT
44 ListItem_t * listGET_NEXT( const ListItem_t * pxListItem );
45 
46 #undef  listLIST_IS_EMPTY
47 BaseType_t listLIST_IS_EMPTY( const List_t * pxList );
48 
49 #undef  listGET_OWNER_OF_HEAD_ENTRY
50 void * listGET_OWNER_OF_HEAD_ENTRY( const List_t * pxList );
51 
52 #undef listIS_CONTAINED_WITHIN
53 BaseType_t listIS_CONTAINED_WITHIN( List_t * list,
54                                     const ListItem_t * listItem );
55 
56 #undef listGET_LIST_ITEM_VALUE
57 TickType_t listGET_LIST_ITEM_VALUE( const ListItem_t * listItem );
58 
59 #undef listSET_LIST_ITEM_VALUE
60 void listSET_LIST_ITEM_VALUE( ListItem_t * listItem,
61                               TickType_t itemValue );
62 
63 
64 #undef listLIST_ITEM_CONTAINER
65 List_t * listLIST_ITEM_CONTAINER( const ListItem_t * listItem );
66 
67 #undef listCURRENT_LIST_LENGTH
68 UBaseType_t listCURRENT_LIST_LENGTH( List_t * list );
69 
70 #undef listGET_ITEM_VALUE_OF_HEAD_ENTRY
71 TickType_t listGET_ITEM_VALUE_OF_HEAD_ENTRY( List_t * list );
72 
73 #undef listGET_LIST_ITEM_OWNER
74 void * listGET_LIST_ITEM_OWNER( const ListItem_t * listItem );
75 
76 extern NetworkInterface_t xInterfaces[ 1 ];
77 
78 /* The function 'prvAllowIPPacket()' checks if a IPv6 packets should be processed. */
79 eFrameProcessingResult_t prvAllowIPPacketIPv6( const IPHeader_IPv6_t * const pxIPv6Header,
80                                                const NetworkBufferDescriptor_t * const pxNetworkBuffer,
81                                                UBaseType_t uxHeaderLength );
82 
83 BaseType_t xGetExtensionOrder( uint8_t ucProtocol,
84                                uint8_t ucNextHeader );
85 
86 /** @brief Handle the IPv6 extension headers. */
87 eFrameProcessingResult_t eHandleIPv6ExtensionHeaders( NetworkBufferDescriptor_t * const pxNetworkBuffer,
88                                                       BaseType_t xDoRemove );
89 
90 /* prvProcessICMPMessage_IPv6() is declared in FreeRTOS_routing.c
91  * It handles all ICMP messages except the PING requests. */
92 eFrameProcessingResult_t prvProcessICMPMessage_IPv6( NetworkBufferDescriptor_t * const pxNetworkBuffer );
93 
94 /**
95  * @brief Work on the RA/SLAAC processing.
96  * @param[in] xDoReset: WHen true, the state-machine will be reset and initialised.
97  * @param[in] pxEndPoint: The end-point for which the RA/SLAAC process should be done..
98  */
99 void vRAProcess( BaseType_t xDoReset,
100                  NetworkEndPoint_t * pxEndPoint );
101 
102 NetworkInterface_t * pxFillInterfaceDescriptor( BaseType_t xEMACIndex,
103                                                 NetworkInterface_t * pxInterface );
104 
105 void vApplicationIPNetworkEventHook( eIPCallbackEvent_t eNetworkEvent );
106 
107 #endif /* ifndef LIST_MACRO_H */
108