1 /* 2 * Copyright (c) 2022, The OpenThread Authors. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 3. Neither the name of the copyright holder nor the 13 * names of its contributors may be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 /** 30 * @file 31 * @brief 32 * This file defines the OpenThread API for NAT64 on a border router. 33 */ 34 35 #ifndef OPENTHREAD_NAT64_H_ 36 #define OPENTHREAD_NAT64_H_ 37 38 #include <openthread/message.h> 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 /** 45 * @addtogroup api-nat64 46 * 47 * @brief This module includes functions and structs for the NAT64 function on the border router. These functions are 48 * only available when `OPENTHREAD_CONFIG_BORDER_ROUTING_NAT64_ENABLE` is enabled. 49 * 50 * @{ 51 * 52 */ 53 54 #define OT_IP4_ADDRESS_SIZE 4 ///< Size of an IPv4 address (bytes) 55 56 /** 57 * @struct otIp4Address 58 * 59 * This structure represents an IPv4 address. 60 * 61 */ 62 OT_TOOL_PACKED_BEGIN 63 struct otIp4Address 64 { 65 union OT_TOOL_PACKED_FIELD 66 { 67 uint8_t m8[OT_IP4_ADDRESS_SIZE]; ///< 8-bit fields 68 uint32_t m32; ///< 32-bit representation 69 } mFields; 70 } OT_TOOL_PACKED_END; 71 72 /** 73 * This structure represents an IPv4 address. 74 * 75 */ 76 typedef struct otIp4Address otIp4Address; 77 78 /** 79 * @struct otIp4Cidr 80 * 81 * This structure represents an IPv4 CIDR block. 82 * 83 */ 84 typedef struct otIp4Cidr 85 { 86 otIp4Address mAddress; 87 uint8_t mLength; 88 } otIp4Cidr; 89 90 /** 91 * @} 92 * 93 */ 94 95 #ifdef __cplusplus 96 } 97 #endif 98 99 #endif // OPENTHREAD_NAT64_H_ 100