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_UTILS_H
29 #define FREERTOS_IPV4_UTILS_H
30 
31 /**
32  * @file FreeRTOS_IPv4_Utils.h
33  * @brief Implements the utility functions for FreeRTOS_IP.c
34  */
35 
36 /* Standard includes. */
37 #include <stdint.h>
38 #include <stdio.h>
39 
40 /* FreeRTOS includes. */
41 #include "FreeRTOS.h"
42 
43 /* FreeRTOS+TCP includes. */
44 #include "FreeRTOS_IP.h"
45 
46 /* *INDENT-OFF* */
47 #ifdef __cplusplus
48     extern "C" {
49 #endif
50 /* *INDENT-ON* */
51 
52 /* Set the MAC-address that belongs to a given IPv4 multi-cast address. */
53 void vSetMultiCastIPv4MacAddress( uint32_t ulIPAddress,
54                                   MACAddress_t * pxMACAddress );
55 
56 /* The first IPv4 length checks at the IP-header level. */
57 BaseType_t prvChecksumIPv4Checks( uint8_t * pucEthernetBuffer,
58                                   size_t uxBufferLength,
59                                   struct xPacketSummary * pxSet );
60 
61 /* *INDENT-OFF* */
62 #ifdef __cplusplus
63     } /* extern "C" */
64 #endif
65 /* *INDENT-ON* */
66 
67 #endif /* FREERTOS_IP_UTILS_H */
68