channel_functions.h

00001 /*
00002  * Copyright (c) 2018, 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 #ifndef CHANNEL_FUNC_H_
00018 #define CHANNEL_FUNC_H_
00019 
00020 /**
00021  * @brief Compute the unicast schedule channel index using tr51 channel function.
00022  * @param slot_number Current slot number.
00023  * @param mac MAC address of the node for which the index is calculated.
00024  * @param number_of_channels Number of channels.
00025  * @param excluded_channels Excluded channels.
00026  * @return Channel index.
00027  */
00028 int32_t tr51_get_uc_channel_index(uint16_t slot_number, uint8_t *mac, int16_t number_of_channels, uint32_t *excluded_channels);
00029 
00030 /**
00031  * @brief Compute the broadcast schedule channel index using tr51 channel function.
00032  * @param slot_number Current slot number.
00033  * @param bsi Broadcast schedule identifier of the node for which the index is calculated.
00034  * @param number_of_channels Number of channels.
00035  * @param excluded_channels Excluded channels.
00036  * @return Channel index.
00037  */
00038 int32_t tr51_get_bc_channel_index(uint16_t slot_number, uint16_t bsi, int16_t number_of_channels, uint32_t *excluded_channels);
00039 
00040 /**
00041  * @brief Compute the unicast schedule channel index using direct hash channel function.
00042  * @param slot_number Current slot number.
00043  * @param mac MAC address of the node for which the index is calculated.
00044  * @param number_of_channels Number of channels.
00045  * @return Channel index.
00046  */
00047 int32_t dh1cf_get_uc_channel_index(uint16_t slot_number, uint8_t *mac, int16_t number_of_channels);
00048 
00049 /**
00050  * @brief Compute the broadcast schedule channel index using direct hash channel function.
00051  * @param slot_number Current slot number.
00052  * @param bsi Broadcast schedule identifier of the node for which the index is calculated.
00053  * @param number_of_channels Number of channels.
00054  * @return Channel index.
00055  */
00056 int32_t dh1cf_get_bc_channel_index(uint16_t slot_number, uint16_t bsi, int16_t number_of_channels);
00057 
00058 #endif /*CHANNEL_FUNC_H_*/