nrf_802154.h

Go to the documentation of this file.

/*
 * 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.
 *
 */
 
#ifndef NRF_802154_H_
#define NRF_802154_H_
 
#include <stdbool.h>
#include <stdint.h>
 
#include "nrf_802154_callouts.h"
#include "nrf_802154_config.h"
#include "nrf_802154_types.h"
#include "nrf_802154_common_utils.h"
 
#if !NRF_802154_SERIALIZATION_HOST || defined(DOXYGEN)
#include "nrf_802154_irq_handlers.h"
#include "nrf_802154_sl_ant_div.h"
#endif // !NRF_802154_SERIALIZATION_HOST
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* The __deprecated macro is provided by Zephyr. Define a compatible fallback for unit tests
 * and other toolchains that do not support it.
 */
#ifndef __deprecated
#define __deprecated
#endif /* __deprecated */
 
#define NRF_802154_NO_TIMESTAMP                0
 
#define NRF_802154_RESERVED_INVALID_ID         UINT32_MAX
 
#define NRF_802154_RESERVED_IMM_RX_WINDOW_ID   (UINT32_MAX - 1)
 
#define NRF_802154_RESERVED_DRX_ID_UPPER_BOUND (UINT32_MAX - 4)
 
#define NRF_802154_MAX_PENDING_NOTIFICATIONS \
    (NRF_802154_RX_BUFFERS + NRF_802154_MAX_DISREGARDABLE_NOTIFICATIONS + 4 + 1)
 
#define NRF_802154_TX_FUNCTIONS_RETURN_ERROR_CODE
 
void nrf_802154_init(void);
 
#if (!NRF_802154_SERIALIZATION_HOST && NRF_802154_DRV_REINIT_ENABLED) || defined(DOXYGEN)
 
bool nrf_802154_reinit(void);
 
#endif /* !NRF_802154_SERIALIZATION_HOST && NRF_802154_DRV_REINIT_ENABLED */
 
#if !NRF_802154_SERIALIZATION_HOST || defined(DOXYGEN)
__deprecated void nrf_802154_deinit(void);
#endif // !NRF_802154_SERIALIZATION_HOST
 
void nrf_802154_channel_set(uint8_t channel);
 
uint8_t nrf_802154_channel_get(void);
 
void nrf_802154_tx_power_set(int8_t power);
 
int8_t nrf_802154_tx_power_get(void);
 
#if !NRF_802154_SERIALIZATION_HOST || defined(DOXYGEN)
 
bool nrf_802154_antenna_diversity_rx_mode_set(nrf_802154_sl_ant_div_mode_t mode);
 
nrf_802154_sl_ant_div_mode_t nrf_802154_antenna_diversity_rx_mode_get(void);
 
bool nrf_802154_antenna_diversity_tx_mode_set(nrf_802154_sl_ant_div_mode_t mode);
 
nrf_802154_sl_ant_div_mode_t nrf_802154_antenna_diversity_tx_mode_get(void);
 
bool nrf_802154_antenna_diversity_rx_antenna_set(nrf_802154_sl_ant_div_antenna_t antenna);
 
nrf_802154_sl_ant_div_antenna_t nrf_802154_antenna_diversity_rx_antenna_get(void);
 
bool nrf_802154_antenna_diversity_tx_antenna_set(nrf_802154_sl_ant_div_antenna_t antenna);
 
nrf_802154_sl_ant_div_antenna_t nrf_802154_antenna_diversity_tx_antenna_get(void);
 
nrf_802154_sl_ant_div_antenna_t nrf_802154_antenna_diversity_last_rx_best_antenna_get(void);
 
void nrf_802154_antenna_diversity_config_set(const nrf_802154_sl_ant_div_cfg_t * p_cfg);
 
bool nrf_802154_antenna_diversity_config_get(nrf_802154_sl_ant_div_cfg_t * p_cfg);
 
bool nrf_802154_antenna_diversity_init(void);
 
void nrf_802154_antenna_diversity_timer_irq_handler(void);
 
#endif // !NRF_802154_SERIALIZATION_HOST
 
uint64_t nrf_802154_time_get(void);
 
void nrf_802154_pan_id_set(const uint8_t * p_pan_id);
 
#if (!NRF_802154_SERIALIZATION_HOST && NRF_802154_PAN_ID_GET_ENABLED) || defined(DOXYGEN)
 
bool nrf_802154_pan_id_get(uint8_t * p_pan_id);
 
#endif /* !NRF_802154_SERIALIZATION_HOST && NRF_802154_PAN_ID_GET_ENABLED */
 
void nrf_802154_extended_address_set(const uint8_t * p_extended_address);
 
#if (!NRF_802154_SERIALIZATION_HOST && NRF_802154_EXTENDED_ADDRESS_GET_ENABLED) || defined(DOXYGEN)
 
bool nrf_802154_extended_address_get(uint8_t * p_extended_address);
 
#endif /* !NRF_802154_SERIALIZATION_HOST && NRF_802154_EXTENDED_ADDRESS_GET_ENABLED */
 
void nrf_802154_short_address_set(const uint8_t * p_short_address);
 
#if (!NRF_802154_SERIALIZATION_HOST && NRF_802154_SHORT_ADDRESS_GET_ENABLED) || defined(DOXYGEN)
 
bool nrf_802154_short_address_get(uint8_t * p_short_address);
 
#endif /* !NRF_802154_SERIALIZATION_HOST && NRF_802154_SHORT_ADDRESS_GET_ENABLED */
 
void nrf_802154_alternate_short_address_set(const uint8_t * p_short_address);
 
#if (!NRF_802154_SERIALIZATION_HOST && NRF_802154_ALTERNATE_SHORT_ADDRESS_GET_ENABLED) || defined(DOXYGEN)
 
bool nrf_802154_alternate_short_address_get(uint8_t * p_short_address);
 
#endif /* !NRF_802154_SERIALIZATION_HOST && NRF_802154_ALTERNATE_SHORT_ADDRESS_GET_ENABLED */
 
bool nrf_802154_sleep(void);
 
nrf_802154_sleep_error_t nrf_802154_sleep_if_idle(void);
 
bool nrf_802154_receive(void);
 
bool nrf_802154_receive_at(uint64_t rx_time,
                           uint32_t timeout,
                           uint8_t  channel,
                           uint32_t id);
 
bool nrf_802154_receive_at_cancel(uint32_t id);
 
bool nrf_802154_receive_at_scheduled_cancel(uint32_t id);
 
nrf_802154_tx_error_t nrf_802154_transmit_raw(uint8_t                              * p_data,
                                              const nrf_802154_transmit_metadata_t * p_metadata);
 
nrf_802154_tx_error_t nrf_802154_transmit_raw_at(
    uint8_t                                 * p_data,
    uint64_t                                  tx_time,
    const nrf_802154_transmit_at_metadata_t * p_metadata);
 
bool nrf_802154_transmit_at_cancel(void);
 
bool nrf_802154_energy_detection(uint32_t time_us);
 
bool nrf_802154_cca(void);
 
#if NRF_802154_CARRIER_FUNCTIONS_ENABLED
 
bool nrf_802154_continuous_carrier(void);
 
bool nrf_802154_modulated_carrier(const uint8_t * p_data);
 
#endif // NRF_802154_CARRIER_FUNCTIONS_ENABLED
 
void nrf_802154_buffer_free_raw(uint8_t * p_data);
 
#if !NRF_802154_SERIALIZATION_HOST || defined(DOXYGEN)
bool nrf_802154_rssi_measure_begin(void);
 
int8_t nrf_802154_rssi_last_get(void);
 
#endif // !NRF_802154_SERIALIZATION_HOST
 
void nrf_802154_promiscuous_set(bool enabled);
 
#if !NRF_802154_SERIALIZATION_HOST || defined(DOXYGEN)
bool nrf_802154_promiscuous_get(void);
 
void nrf_802154_auto_ack_set(bool enabled);
 
bool nrf_802154_auto_ack_get(void);
 
#endif // !NRF_802154_SERIALIZATION_HOST
 
void nrf_802154_pan_coord_set(bool enabled);
 
#if NRF_802154_PAN_COORD_GET_ENABLED || defined(DOXYGEN)
bool nrf_802154_pan_coord_get(void);
 
#endif // NRF_802154_PAN_COORD_GET_ENABLED
 
void nrf_802154_src_addr_matching_method_set(nrf_802154_src_addr_match_t match_method);
 
bool nrf_802154_ack_data_set(const uint8_t       * p_addr,
                             bool                  extended,
                             const void          * p_data,
                             uint16_t              length,
                             nrf_802154_ack_data_t data_type);
 
bool nrf_802154_ack_data_clear(const uint8_t       * p_addr,
                               bool                  extended,
                               nrf_802154_ack_data_t data_type);
 
void nrf_802154_ack_data_remove_all(bool extended, nrf_802154_ack_data_t data_type);
 
void nrf_802154_auto_pending_bit_set(bool enabled);
 
bool nrf_802154_pending_bit_for_addr_set(const uint8_t * p_addr, bool extended);
 
bool nrf_802154_pending_bit_for_addr_clear(const uint8_t * p_addr, bool extended);
 
void nrf_802154_pending_bit_for_addr_reset(bool extended);
 
void nrf_802154_cca_cfg_set(const nrf_802154_cca_cfg_t * p_cca_cfg);
 
void nrf_802154_cca_cfg_get(nrf_802154_cca_cfg_t * p_cca_cfg);
 
#if NRF_802154_CSMA_CA_ENABLED || defined(DOXYGEN)
 
nrf_802154_tx_error_t nrf_802154_transmit_csma_ca_raw(
    uint8_t                                      * p_data,
    const nrf_802154_transmit_csma_ca_metadata_t * p_metadata);
 
bool nrf_802154_csma_ca_min_be_set(uint8_t min_be);
 
uint8_t nrf_802154_csma_ca_min_be_get(void);
 
bool nrf_802154_csma_ca_max_be_set(uint8_t max_be);
 
uint8_t nrf_802154_csma_ca_max_be_get(void);
 
void nrf_802154_csma_ca_max_backoffs_set(uint8_t max_backoffs);
 
uint8_t nrf_802154_csma_ca_max_backoffs_get(void);
 
#endif // NRF_802154_CSMA_CA_ENABLED
 
#if !NRF_802154_SERIALIZATION_HOST || defined(DOXYGEN)
#if NRF_802154_ACK_TIMEOUT_ENABLED || defined(DOXYGEN)
 
void nrf_802154_ack_timeout_set(uint32_t time);
 
#endif // !NRF_802154_SERIALIZATION_HOST
 
#endif // NRF_802154_ACK_TIMEOUT_ENABLED
 
#if !NRF_802154_SERIALIZATION_HOST || defined(DOXYGEN)
bool nrf_802154_wifi_coex_is_enabled(void);
 
bool nrf_802154_coex_rx_request_mode_set(nrf_802154_coex_rx_request_mode_t mode);
 
nrf_802154_coex_rx_request_mode_t nrf_802154_coex_rx_request_mode_get(void);
 
bool nrf_802154_coex_tx_request_mode_set(nrf_802154_coex_tx_request_mode_t mode);
 
nrf_802154_coex_tx_request_mode_t nrf_802154_coex_tx_request_mode_get(void);
 
#endif // !NRF_802154_SERIALIZATION_HOST
 
#if !NRF_802154_SERIALIZATION_HOST || defined(DOXYGEN)
void nrf_802154_stats_get(nrf_802154_stats_t * p_stats);
 
void nrf_802154_stat_counters_get(nrf_802154_stat_counters_t * p_stat_counters);
 
void nrf_802154_stat_counters_subtract(const nrf_802154_stat_counters_t * p_stat_counters);
 
#endif // !NRF_802154_SERIALIZATION_HOST
 
void nrf_802154_stat_timestamps_get(nrf_802154_stat_timestamps_t * p_stat_timestamps);
 
#if !NRF_802154_SERIALIZATION_HOST || defined(DOXYGEN)
void nrf_802154_stat_counters_reset(void);
 
#endif // !NRF_802154_SERIALIZATION_HOST
 
#if NRF_802154_IFS_ENABLED || defined(DOXYGEN)
 
nrf_802154_ifs_mode_t nrf_802154_ifs_mode_get(void);
 
bool nrf_802154_ifs_mode_set(nrf_802154_ifs_mode_t mode);
 
uint16_t nrf_802154_ifs_min_sifs_period_get(void);
 
void nrf_802154_ifs_min_sifs_period_set(uint16_t period);
 
uint16_t nrf_802154_ifs_min_lifs_period_get(void);
 
void nrf_802154_ifs_min_lifs_period_set(uint16_t period);
 
#endif // NRF_802154_IFS_ENABLED
 
nrf_802154_capabilities_t nrf_802154_capabilities_get(void);
 
void nrf_802154_security_global_frame_counter_set(uint32_t frame_counter);
 
void nrf_802154_security_global_frame_counter_set_if_larger(uint32_t frame_counter);
 
nrf_802154_security_error_t nrf_802154_security_key_store(nrf_802154_key_t * p_key);
 
nrf_802154_security_error_t nrf_802154_security_key_remove(nrf_802154_key_id_t * p_id);
 
void nrf_802154_security_key_remove_all(void);
 
void nrf_802154_csl_writer_period_set(uint16_t period);
 
void nrf_802154_csl_writer_anchor_time_set(uint64_t anchor_time);
 
void nrf_802154_rx_on_when_idle_set(bool rx_on_when_idle);
 
void nrf_802154_cst_writer_period_set(uint16_t period);
 
void nrf_802154_cst_writer_anchor_time_set(uint64_t anchor_time);
 
bool nrf_802154_pa_modulation_fix_get(void);
 
void nrf_802154_pa_modulation_fix_set(bool enable);
 
#if NRF_802154_TEST_MODES_ENABLED
nrf_802154_test_mode_csmaca_backoff_t nrf_802154_test_mode_csmaca_backoff_get(void);
 
void nrf_802154_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_H_ */