beacon_handler.h

00001 /*
00002  * Copyright (c) 2016-2017, Arm Limited and affiliates.
00003  * SPDX-License-Identifier: Apache-2.0
00004  *
00005  * Licensed under the Apache License, Version 2.0 (the "License");
00006  * you may not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  *     http://www.apache.org/licenses/LICENSE-2.0
00010  *
00011  * Unless required by applicable law or agreed to in writing, software
00012  * distributed under the License is distributed on an "AS IS" BASIS,
00013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  * See the License for the specific language governing permissions and
00015  * limitations under the License.
00016  */
00017 
00018 #ifndef BEACON_HANDLER_H
00019 #define BEACON_HANDLER_H
00020 
00021 #include <inttypes.h>
00022 #include "net_interface.h"
00023 
00024 // 1 byte for protocol id, 1 byte for accept join, 16 bytes for network id
00025 #define PLAIN_BEACON_PAYLOAD_SIZE   (1 + 1 + sizeof((border_router_setup_s *)0)->network_id)
00026 
00027 #define BEACON_OPTION_END_DELIMITER            0x00
00028 #define BEACON_OPTION_JOIN_PRIORITY_TYPE       0x0c
00029 #define BEACON_OPTION_JOIN_PRIORITY_VAL_LEN    0x01
00030 #define BEACON_OPTION_JOIN_PRIORITY_LEN        0x02
00031 #define BEACON_OPTION_JOIN_PRIORITY_TYPE_LEN   0xc1
00032 
00033 struct mlme_beacon_ind_s;
00034 
00035 void beacon_received(int8_t if_id, const struct mlme_beacon_ind_s *data);
00036 
00037 void beacon_optional_tlv_fields_skip(uint16_t *len, uint8_t **ptr, uint8_t offset);
00038 
00039 /* Beacon */
00040 int8_t mac_beacon_link_beacon_compare_rx_callback_set(int8_t interface_id,
00041     beacon_compare_rx_cb *beacon_compare_rx_cb_ptr);
00042 int8_t mac_beacon_link_beacon_join_priority_tx_callback_set(int8_t interface_id,
00043     beacon_join_priority_tx_cb *beacon_join_priority_tx_cb_ptr);
00044 
00045 void beacon_join_priority_update(int8_t interface_id);
00046 
00047 //TODO: beacon storage here if needed by 6loWPAN?
00048 
00049 #endif // BEACON_HANDLER_H