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 FREERTOS_IPV4_SOCKETS_H
29     #define FREERTOS_IPV4_SOCKETS_H
30 
31 /* Standard includes. */
32     #include <string.h>
33 
34 /* FreeRTOS includes. */
35     #include "FreeRTOS.h"
36 
37     #ifdef __cplusplus
38         extern "C" {
39     #endif
40 
41 
42 /* Translate from 192.168.1.1 to a 32-bit number. */
43     BaseType_t FreeRTOS_inet_pton4( const char * pcSource,
44                                     void * pvDestination );
45 
46     const char * FreeRTOS_inet_ntop4( const void * pvSource,
47                                       char * pcDestination,
48                                       socklen_t uxSize );
49 
50 /**
51  * @brief Called by prvSendUDPPacket(), this function will UDP packet
52  *        fields and IPv4 address for the packet to be send.
53  */
54     void * xSend_UDP_Update_IPv4( NetworkBufferDescriptor_t * pxNetworkBuffer,
55                                   const struct freertos_sockaddr * pxDestinationAddress );
56 
57 /**
58  * @brief Called by FreeRTOS_recvfrom(), this function will update socket
59  *        address with IPv4 address from the packet received.
60  */
61     size_t xRecv_Update_IPv4( const NetworkBufferDescriptor_t * pxNetworkBuffer,
62                               struct freertos_sockaddr * pxSourceAddress );
63 
64     #ifdef __cplusplus
65 }         /* extern "C" */
66     #endif
67 #endif /* FREERTOS_IPV4_SOCKETS_H */
68