thread_bbr_commercial.h

00001 /*
00002  * Copyright (c) 2017-2019, 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 Thread 1.2 primary border router support.
00032  */
00033 
00034 #ifndef THREAD_BBR_COMMERCIAL_H_
00035 #define THREAD_BBR_COMMERCIAL_H_
00036 
00037 #ifdef __cplusplus
00038 extern "C" {
00039 #endif
00040 
00041 /*
00042  * Thread PBBR ML-EID map structure
00043  */
00044 typedef struct thread_pbbr_dua_info {
00045     uint8_t mleid_ptr[8];
00046     uint32_t last_contact_time;
00047 } thread_pbbr_dua_info_t;
00048 
00049 #if defined(HAVE_THREAD_V2) && defined(HAVE_THREAD_BORDER_ROUTER)
00050 int8_t thread_bbr_commercial_init(int8_t interface_id, int8_t backbone_interface_id);
00051 void thread_bbr_commercial_delete(int8_t interface_id);
00052 bool thread_bbr_commercial_nd_query_process(protocol_interface_info_entry_t *cur, const uint8_t *target_addr, uint16_t rloc);
00053 void thread_bbr_commercial_seconds_timer(int8_t interface_id, uint32_t seconds);
00054 int thread_bbr_commercial_sequence_number_set(int8_t interface_id, uint8_t seq_number);
00055 int thread_bbr_commercial_timeout_set(int8_t interface_id, uint32_t timeout_a, uint32_t timeout_b, uint32_t delay);
00056 int thread_bbr_commercial_address_set(int8_t interface_id, const uint8_t *addr_ptr, uint16_t port);
00057 void thread_bbr_commercial_route_update(protocol_interface_info_entry_t *cur);
00058 int thread_bbr_commercial_prefix_set(int8_t interface_id, uint8_t *prefix);
00059 void thread_bbr_commercial_old_partition_data_clean(int8_t interface_id);
00060 void thread_bbr_commercial_status_override_get(uint8_t *dua_status, uint8_t *dua_count, uint8_t *ba_failure_count);
00061 void thread_bbr_commercial_status_override_set(uint8_t dua_status, uint8_t dua_count, uint8_t ba_failure_count);
00062 void thread_bbr_commercial_mcast_fwd_check(int8_t interface_id, bool *multicast_fwd);
00063 
00064 
00065 #else
00066 
00067 #define thread_bbr_commercial_init(interface_id, backbone_interface_id)
00068 #define thread_bbr_commercial_delete(interface_id)
00069 #define thread_bbr_commercial_nd_query_process(cur, target_addr, rloc) false
00070 #define thread_bbr_commercial_seconds_timer(interface_id, seconds)
00071 #define thread_bbr_commercial_timeout_set(interface_id, timeout_a, timeout_b, delay)
00072 #define thread_bbr_commercial_address_set(interface_id, addr_ptr, port) (-1)
00073 #define thread_bbr_commercial_route_update(cur)
00074 #define thread_bbr_commercial_sequence_number_set(interface_id, seq_number) (-1)
00075 #define thread_bbr_commercial_prefix_set(interface_id, prefix) 0
00076 #define thread_bbr_commercial_old_partition_data_clean(interface_id)
00077 #define thread_bbr_commercial_status_override_get(dua_status, dua_count, ba_failure_count);
00078 #define thread_bbr_commercial_status_override_set(dua_status, dua_count, ba_failure_count);
00079 #define thread_bbr_commercial_mcast_fwd_check(interface_id, multicast_fwd)
00080 #endif
00081 
00082 #ifdef __cplusplus
00083 }
00084 #endif
00085 
00086 #endif //THREAD_BBR_COMMERCIAL_H_