/* * Copyright (c) 2017, Nordic Semiconductor ASA * All rights reserved. * * SPDX-License-Identifier: BSD-3-Clause * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * 1. Redistributions of source code must retain the above copyright notice, this * list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * 3. Neither the name of Nordic Semiconductor ASA nor the names of its * contributors may be used to endorse or promote products derived from this * software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * */ /** * @brief Module that implements the storage of PIB attributes in the nRF 802.15.4 radio driver. * */ #ifndef NRF_802154_PIB_H_ #define NRF_802154_PIB_H_ #include #include #include "nrf_802154.h" #ifdef __cplusplus extern "C" { #endif /** * @brief Initializes this module. */ void nrf_802154_pib_init(void); /** * @brief Checks if the promiscuous mode is enabled. * * @retval true The promiscuous mode is enabled. * @retval false The promiscuous mode is disabled. */ bool nrf_802154_pib_promiscuous_get(void); /** * @brief Enables or disables the promiscuous mode. * * @param[in] enabled If the promiscuous mode is to be enabled. */ void nrf_802154_pib_promiscuous_set(bool enabled); /** * @brief Checks if the RxOnWhenIdle mode is enabled. * * @retval true The RxOnWhenIdle mode is enabled. * @retval false The RxOnWhenIdle mode is disabled. */ bool nrf_802154_pib_rx_on_when_idle_get(void); /** * @brief Enables or disables the RxOnWhenIdle mode. * * @param[in] enabled If the RxOnWhenIdle mode is to be enabled. */ void nrf_802154_pib_rx_on_when_idle_set(bool enabled); /** * @brief Checks if the auto ACK procedure is enabled. * * @retval true The auto ACK procedure is enabled. * @retval false The auto ACK procedure is disabled. */ bool nrf_802154_pib_auto_ack_get(void); /** * @brief Enables or disables the auto ACK procedure. * * @param[in] enabled If the auto ACK procedure is to be enabled. */ void nrf_802154_pib_auto_ack_set(bool enabled); /** * @brief Checks if the radio is configured as the PAN coordinator. * * @retval true The radio is configured as the PAN coordinator. * @retval false The radio is not configured as the PAN coordinator. */ bool nrf_802154_pib_pan_coord_get(void); /** * @brief Configures the device as the PAN coordinator. * * @param[in] enabled If the radio is configured as the PAN coordinator. */ void nrf_802154_pib_pan_coord_set(bool enabled); /** * @brief Gets the currently used channel. * * @returns Channel number used by the driver. */ uint8_t nrf_802154_pib_channel_get(void); /** * @brief Sets the channel that will be used by the driver. * * @param[in] channel Number of the channel used by the driver. */ void nrf_802154_pib_channel_set(uint8_t channel); /** * @brief Gets the transmit power. * * @returns Transmit power in dBm. */ int8_t nrf_802154_pib_tx_power_get(void); /** * @brief Sets the transmit power used for ACK frames. * * @param[in] dbm Transmit power in dBm. */ void nrf_802154_pib_tx_power_set(int8_t dbm); /** * @brief Gets the PAN ID used by this device. * * @returns Pointer to the buffer containing the PAN ID value (2 bytes, little-endian). */ const uint8_t * nrf_802154_pib_pan_id_get(void); /** * @brief Sets the PAN ID used by this device. * * @param[in] p_pan_id Pointer to the PAN ID (2 bytes, little-endian). * * This function makes a copy of the PAN ID. */ void nrf_802154_pib_pan_id_set(const uint8_t * p_pan_id); /** * @brief Gets the extended address of this device. * * @returns Pointer to the buffer containing the extended address (8 bytes, little-endian). */ const uint8_t * nrf_802154_pib_extended_address_get(void); /** * @brief Sets the extended address of this device. * * @param[in] p_extended_address Pointer to extended address (8 bytes, little-endian). * * This function makes a copy of the address. */ void nrf_802154_pib_extended_address_set(const uint8_t * p_extended_address); /** * @brief Gets the short address of this device. * * @returns Pointer to the buffer containing the short address (2 bytes, little-endian). */ const uint8_t * nrf_802154_pib_short_address_get(void); /** * @brief Sets the short address of this device. * * @param[in] p_short_address Pointer to the short address (2 bytes, little-endian). * * This function makes a copy of the address. */ void nrf_802154_pib_short_address_set(const uint8_t * p_short_address); /** * @brief Sets the radio CCA mode and threshold. * * @param[in] p_cca_cfg Pointer to the CCA configuration structure. Only fields relevant * to the selected mode are updated. */ void nrf_802154_pib_cca_cfg_set(const nrf_802154_cca_cfg_t * p_cca_cfg); /** * @brief Gets the current radio CCA configuration. * * @param[out] p_cca_cfg Pointer to the structure for the current CCA configuration. */ void nrf_802154_pib_cca_cfg_get(nrf_802154_cca_cfg_t * p_cca_cfg); /** * @brief Sets Coex request mode used in receive operations. * * @param[in] mode Coex receive request mode. * * @retval true When value provided by @p mode param is supported. * @retval false Otherwise. */ bool nrf_802154_pib_coex_rx_request_mode_set(nrf_802154_coex_rx_request_mode_t mode); /** * @brief Gets Coex request mode used in receive operations. * * @return Current Coex receive request mode. */ nrf_802154_coex_rx_request_mode_t nrf_802154_pib_coex_rx_request_mode_get(void); /** * @brief Sets Coex request mode used in transmit operations. * * @param[in] mode Coex transmit request mode. * * @retval true When value provided by @p mode param is supported. * @retval false Otherwise. */ bool nrf_802154_pib_coex_tx_request_mode_set(nrf_802154_coex_tx_request_mode_t mode); /** * @brief Gets Coex request mode used in transmit operations. * * @return Current Coex transmit request mode. */ nrf_802154_coex_tx_request_mode_t nrf_802154_pib_coex_tx_request_mode_get(void); #if NRF_802154_CSMA_CA_ENABLED /** * @brief Sets the minimum value of the backoff exponent (BE) in the CSMA-CA algorithm. * * @param[in] min_be Minimum value of the backoff exponent. * * @retval true When value provided by @p min_be does not exceed the implementation limit ( <= 8). * @retval false Otherwise. */ bool nrf_802154_pib_csmaca_min_be_set(uint8_t min_be); /** * @brief Gets the minimum value of the backoff exponent (BE) in the CSMA-CA algorithm. * * @return Current minimum value of the backoff exponent. */ uint8_t nrf_802154_pib_csmaca_min_be_get(void); /** * @brief Sets the maximum value of the backoff exponent (BE) in the CSMA-CA algorithm. * * @param[in] max_be Maximum value of the backoff exponent. * * @retval true When value provided by @p max_be does not exceed the implementation limit ( <= 8). * @retval false Otherwise. */ bool nrf_802154_pib_csmaca_max_be_set(uint8_t max_be); /** * @brief Gets the maximum value of the backoff exponent (BE) in the CSMA-CA algorithm. * * @return Current maximum value of the backoff exponent. */ uint8_t nrf_802154_pib_csmaca_max_be_get(void); /** * @brief Sets the maximum number of backoffs the CSMA-CA algorithm will attempt before declaring * a channel access failure. * * @param[in] max_backoffs Maximum number of backoffs. */ void nrf_802154_pib_csmaca_max_backoffs_set(uint8_t max_backoffs); /** * @brief Gets the maximum number of backoffs the CSMA-CA algorithm will attempt before declaring * a channel access failure. * * @return Current maximum number of backoffs. */ uint8_t nrf_802154_pib_csmaca_max_backoffs_get(void); #endif // NRF_802154_CSMA_CA_ENABLED #if NRF_802154_IFS_ENABLED /** * @brief Gets IFS operation mode. * * @return Current IFS operation mode. Refer to @ref nrf_802154_ifs_mode_t for details. */ nrf_802154_ifs_mode_t nrf_802154_pib_ifs_mode_get(void); /** * @brief Sets IFS operation mode. * * @param[in] mode IFS operation mode. Refer to @ref nrf_802154_ifs_mode_t for details. * * @retval true The update of PIB was successful. * @retval false The update of PIB failed due to the unsupported mode. */ bool nrf_802154_pib_ifs_mode_set(nrf_802154_ifs_mode_t mode); /** * @brief Gets Short IFS period in microseconds. * * @return Current Short IFS period in microseconds. */ uint16_t nrf_802154_pib_ifs_min_sifs_period_get(void); /** * @brief Sets Short IFS period in microseconds. * * @param[in] period Short IFS period in microseconds. * * @note The period cannot be smaller than aTurnaroundTime. */ void nrf_802154_pib_ifs_min_sifs_period_set(uint16_t period); /** * @brief Gets Long IFS period in microseconds. * * @return Current Long IFS period in microseconds. */ uint16_t nrf_802154_pib_ifs_min_lifs_period_get(void); /** * @brief Sets Long IFS period in microseconds. * * @param[in] period Long IFS period in microseconds. */ void nrf_802154_pib_ifs_min_lifs_period_set(uint16_t period); #endif // NRF_802154_IFS_ENABLED #if NRF_802154_TEST_MODES_ENABLED /** * @brief Gets the current CSMA/CA backoff test mode. * * @return Current CSMA/CA backoff test mode. */ nrf_802154_test_mode_csmaca_backoff_t nrf_802154_pib_test_mode_csmaca_backoff_get(void); /** * @brief Sets the csmaca backoff test mode. * * @param[in] value CSMA/CA backoff test mode. */ void nrf_802154_pib_test_mode_csmaca_backoff_set(nrf_802154_test_mode_csmaca_backoff_t value); #endif // NRF_802154_TEST_MODES_ENABLED #ifdef __cplusplus } #endif #endif /* NRF_802154_PIB_H_ */