1 /*
2  *  Copyright (c) 2023, 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 includes the platform abstraction for border routing manager.
33  */
34 
35 #ifndef OPENTHREAD_PLATFORM_BORDER_ROUTER_H_
36 #define OPENTHREAD_PLATFORM_BORDER_ROUTER_H_
37 
38 #include <stdint.h>
39 
40 #include <openthread/error.h>
41 #include <openthread/instance.h>
42 
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46 
47 /**
48  * Handles ICMP6 RA messages received on the Thread interface on the platform.
49  *
50  * The `aMessage` should point to a buffer of a valid ICMPv6 message (without IP headers) with router advertisement as
51  * the value of type field of the message.
52  *
53  * When DHCPv6 PD is disabled, the message will be dropped silently.
54  *
55  * Note: RA messages will not be forwarded into Thread networks, while for many platforms, RA messages is the way of
56  * distributing a prefix and other infomations to the downstream network. The typical usecase of this function is to
57  * handle the router advertisement messages sent by the platform as a result of DHCPv6 Prefix Delegation.
58  *
59  * Requires `OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_ENABLE`.
60  *
61  * @param[in] aInstance A pointer to an OpenThread instance.
62  * @param[in] aMessage  A pointer to an ICMPv6 RouterAdvertisement message.
63  * @param[in] aLength   The length of ICMPv6 RouterAdvertisement message.
64  *
65  */
66 extern void otPlatBorderRoutingProcessIcmp6Ra(otInstance *aInstance, const uint8_t *aMessage, uint16_t aLength);
67 
68 #ifdef __cplusplus
69 }
70 #endif
71 
72 #endif // OPENTHREAD_PLATFORM_BORDER_ROUTER_H_
73