thread_bbr_api_internal.h

00001 /*
00002  * Copyright (c) 2016-2018, Arm Limited and affiliates.
00003  * SPDX-License-Identifier: BSD-3-Clause
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions are met:
00007  *
00008  * 1. Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in the
00012  *    documentation and/or other materials provided with the distribution.
00013  * 3. Neither the name of the copyright holder nor the
00014  *    names of its contributors may be used to endorse or promote products
00015  *    derived from this software without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00018  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00019  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00020  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
00021  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00022  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00023  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00024  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00025  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00026  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00027  * POSSIBILITY OF SUCH DAMAGE.
00028  */
00029 
00030 /**
00031  * \brief Nanostack BBR internal instance and corresponding methods.
00032  */
00033 
00034 #ifndef THREAD_BBR_API_INTERNAL_H_
00035 #define THREAD_BBR_API_INTERNAL_H_
00036 
00037 #include "net_interface.h"
00038 #ifdef HAVE_THREAD_ROUTER
00039 struct ipv6_route;
00040 
00041 /**
00042  * \brief Initialize Thread Commissioner relay for BBR and Routers
00043  *
00044  * \param interface_id current interface id
00045  * \param external_commisssioner_port External commissioner port
00046  */
00047 int8_t thread_bbr_init(int8_t interface_id, uint16_t external_commisssioner_port);
00048 /**
00049  * \brief delete Thread Commissioner relay for BBR and Routers
00050  *
00051  * \param interface_id current interface id
00052  */
00053 void thread_bbr_delete(int8_t interface_id);
00054 
00055 /**
00056  * \brief seconds timer for border router
00057  *
00058  * \param interface_id current interface id
00059  * \param tics seconds pass since last call
00060  */
00061 void thread_bbr_seconds_timer(int8_t interface_id, uint32_t tics);
00062 
00063 /**
00064  * \brief enable/disable UDP proxy
00065  *
00066  * \param interface_id current interface id
00067  */
00068 int thread_bbr_commissioner_proxy_service_update(int8_t interface_id);
00069 /**
00070  * \brief get commissioner service id to add new services
00071  *
00072  * \param interface_id current interface id
00073  * \return service id or 0 if invalid
00074  */
00075 int8_t thread_bbr_get_commissioner_service(int8_t interface_id);
00076 
00077 #else
00078 #define thread_bbr_init(interface_id, external_commisssioner_port)
00079 #define thread_bbr_delete(interface_id)
00080 #define thread_bbr_seconds_timer(interface_id, tics)
00081 #define thread_bbr_commissioner_proxy_service_update(interface_id)
00082 #endif //HAVE_THREAD_ROUTER
00083 
00084 #ifdef HAVE_THREAD_BORDER_ROUTER
00085 /**
00086  * \brief nd proxy and relay service state change
00087  *
00088  * \param interface_id current interface id
00089  */
00090 int thread_bbr_proxy_state_update(int8_t caller_interface_id, int8_t handler_interface_id, bool status);
00091 
00092 /**
00093  * \brief Test if border router routing is enabled
00094  *
00095  * \param cur Protocol interface
00096  */
00097 bool thread_bbr_routing_enabled(protocol_interface_info_entry_t *cur);
00098 
00099 /**
00100  * \brief Inform BBR for network data change
00101  *
00102  * \param cur Protocol interface
00103  */
00104 void thread_bbr_network_data_update_notify(protocol_interface_info_entry_t *cur);
00105 
00106 /**
00107  * \brief Add new nd entry to bbr
00108  *
00109  * \param interface_id addr_data_ptr lifetime info
00110  */
00111 int thread_bbr_nd_entry_add(int8_t interface_id, const uint8_t *addr_data_ptr, uint32_t lifetime, void *info);
00112 
00113 /**
00114  * \brief Add new dua entry to bbr
00115  *
00116  * \param interface_id addr_data_ptr lifetime info mleid_ptr
00117  */
00118 int thread_bbr_dua_entry_add(int8_t interface_id, const uint8_t *addr_data_ptr, uint32_t lifetime, const uint8_t *mleid_ptr);
00119 
00120 /**
00121  * \brief Send na
00122  *
00123  * \param interface_id addr_data_ptr lifetime info mleid_ptr
00124  */
00125 int thread_bbr_na_send(int8_t interface_id, const uint8_t target[static 16]);
00126 
00127 
00128 #else
00129 #define thread_bbr_proxy_state_update(caller_interface_id , handler_interface_id, status) (NULL)
00130 #define thread_bbr_routing_enabled(cur) false
00131 #define thread_bbr_network_data_update_notify(cur)
00132 #define thread_bbr_nd_entry_add(interface_id, addr_data_ptr, lifetime, info) (0)
00133 #define thread_bbr_dua_entry_add(interface_id, addr_data_ptr, lifetime, mleid_ptr) (0)
00134 #define thread_bbr_na_send(interface_id, target) (0)
00135 #endif //HAVE_THREAD_BORDER_ROUTER
00136 
00137 
00138 #endif /* THREAD_BORDER_ROUTER_API_INTERNAL_H_ */
00139