289 lines
11 KiB
C
289 lines
11 KiB
C
/*
|
|
* Copyright (c) 2017 - 2022, 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 contains core of the nRF IEEE 802.15.4 radio driver.
|
|
*
|
|
*/
|
|
|
|
#ifndef NRF_802154_CORE_H_
|
|
#define NRF_802154_CORE_H_
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
|
|
#include "nrf_802154_config.h"
|
|
#include "nrf_802154_notification.h"
|
|
#include "nrf_802154_rx_buffer.h"
|
|
#include "nrf_802154_types_internal.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief States of the nRF 802.15.4 driver.
|
|
*/
|
|
typedef enum
|
|
{
|
|
// Sleep
|
|
RADIO_STATE_SLEEP, ///< Low power mode (disabled) - the only state in which all radio preconditions are not requested.
|
|
RADIO_STATE_FALLING_ASLEEP, ///< Before entering the sleep state, all radio preconditions are requested.
|
|
|
|
// Receive
|
|
RADIO_STATE_RX, ///< The receiver is enabled and it is receiving frames.
|
|
RADIO_STATE_TX_ACK, ///< The frame is received and the ACK is being transmitted.
|
|
|
|
// Transmit
|
|
RADIO_STATE_CCA_TX, ///< Performing CCA followed by the frame transmission.
|
|
RADIO_STATE_TX, ///< Transmitting data frame (or beacon).
|
|
RADIO_STATE_RX_ACK, ///< Receiving ACK after the transmitted frame.
|
|
|
|
// Energy Detection
|
|
RADIO_STATE_ED, ///< Performing the energy detection procedure.
|
|
|
|
// CCA
|
|
RADIO_STATE_CCA, ///< Performing the CCA procedure.
|
|
|
|
// Continuous carrier
|
|
RADIO_STATE_CONTINUOUS_CARRIER, ///< Emitting the continuous carrier wave.
|
|
|
|
// Modulated carrier
|
|
RADIO_STATE_MODULATED_CARRIER ///< Emitting the modulated carrier signal.
|
|
|
|
} radio_state_t;
|
|
|
|
/**
|
|
* @brief Initializes the 802.15.4 driver core.
|
|
*/
|
|
void nrf_802154_core_init(void);
|
|
|
|
/**
|
|
* @brief Deinitializes the 802.15.4 driver core.
|
|
*/
|
|
void nrf_802154_core_deinit(void);
|
|
|
|
/**
|
|
* @brief Gets the current state of the nRF 802.15.4 driver.
|
|
*
|
|
* @returns Current state of the 802.15.4 driver.
|
|
*/
|
|
radio_state_t nrf_802154_core_state_get(void);
|
|
|
|
/***************************************************************************************************
|
|
* @section State machine transition requests
|
|
**************************************************************************************************/
|
|
|
|
/**
|
|
* @brief Requests the transition to the @ref RADIO_STATE_SLEEP state.
|
|
*
|
|
* @param[in] term_lvl Termination level of this request. Selects procedures to abort.
|
|
*
|
|
* @retval true Entering the sleep state succeeded.
|
|
* @retval false Entering the sleep state failed (the driver is performing other procedure).
|
|
*/
|
|
bool nrf_802154_core_sleep(nrf_802154_term_t term_lvl);
|
|
|
|
/**
|
|
* @brief Requests the transition to the @ref RADIO_STATE_RX state.
|
|
*
|
|
* @param[in] term_lvl Termination level of this request. Selects procedures to abort.
|
|
* @param[in] req_orig Module that originates this request.
|
|
* @param[in] notify_function Function called to notify the status of this procedure. May be NULL.
|
|
* @param[in] notify_abort If abort notification is to be triggered.
|
|
* @param[in] id Identifier of reception window.
|
|
*
|
|
* @retval true Entering the receive state succeeded.
|
|
* @retval false Entering the receive state failed (the driver is performing other procedure).
|
|
*/
|
|
bool nrf_802154_core_receive(nrf_802154_term_t term_lvl,
|
|
req_originator_t req_orig,
|
|
nrf_802154_notification_func_t notify_function,
|
|
bool notify_abort,
|
|
uint32_t id);
|
|
|
|
/**
|
|
* @brief Requests the transition to the @ref RADIO_STATE_TX state.
|
|
*
|
|
* @param[in] term_lvl Termination level of this request. Selects procedures to abort.
|
|
* @param[in] req_orig Module that originates this request.
|
|
* @param[in] p_data Pointer to a frame to transmit.
|
|
* @param[in] p_params Pointer to transmission parameters.
|
|
* @param[in] notify_function Function called to notify the status of this procedure. May be NULL.
|
|
*
|
|
* @retval true Entering the transmit state succeeded.
|
|
* @retval false Entering the transmit state failed (the driver is performing other procedure).
|
|
*/
|
|
bool nrf_802154_core_transmit(nrf_802154_term_t term_lvl,
|
|
req_originator_t req_orig,
|
|
uint8_t * p_data,
|
|
nrf_802154_transmit_params_t * p_params,
|
|
nrf_802154_notification_func_t notify_function);
|
|
|
|
/**
|
|
* @brief Requests the transition to the @ref RADIO_STATE_ED state.
|
|
*
|
|
* When the energy detection procedure is finished, the driver transitions
|
|
* to the @ref RADIO_STATE_RX state.
|
|
*
|
|
* @param[in] term_lvl Termination level of this request. Selects procedures to abort.
|
|
* @param[in] time_us Minimal time of energy detection procedure.
|
|
*
|
|
* @retval true Entering the energy detection state succeeded.
|
|
* @retval false Entering the energy detection state failed
|
|
* (the driver is performing other procedure).
|
|
*/
|
|
bool nrf_802154_core_energy_detection(nrf_802154_term_t term_lvl, uint32_t time_us);
|
|
|
|
/**
|
|
* @brief Requests the transition to the @ref RADIO_STATE_CCA state.
|
|
*
|
|
* When the CCA procedure is finished, the driver transitions to the @ref RADIO_STATE_RX state.
|
|
*
|
|
* @param[in] term_lvl Termination level of this request. Selects procedures to abort.
|
|
*
|
|
* @retval true Entering the CCA state succeeded.
|
|
* @retval false Entering the CCA state failed (the driver is performing other procedure).
|
|
*/
|
|
bool nrf_802154_core_cca(nrf_802154_term_t term_lvl);
|
|
|
|
#if NRF_802154_CARRIER_FUNCTIONS_ENABLED
|
|
|
|
/**
|
|
* @brief Requests the transition to the @ref RADIO_STATE_CONTINUOUS_CARRIER state.
|
|
*
|
|
* @param[in] term_lvl Termination level of this request. Selects procedures to abort.
|
|
*
|
|
* @retval true Entering the continuous carrier state succeeded.
|
|
* @retval false Entering the continuous carrier state failed
|
|
* (the driver is performing other procedure).
|
|
*/
|
|
bool nrf_802154_core_continuous_carrier(nrf_802154_term_t term_lvl);
|
|
|
|
/**
|
|
* @brief Requests the transition to the @ref RADIO_STATE_MODULATED_CARRIER state.
|
|
*
|
|
* @param[in] term_lvl Termination level of this request. Selects procedures to abort.
|
|
* @param[in] p_data Data buffer to modulate the carrier with.
|
|
*
|
|
* @retval true Entering the modulated carrier state succeeded.
|
|
* @retval false Entering the modulated carrier state failed
|
|
* (the driver is performing other procedure).
|
|
*/
|
|
bool nrf_802154_core_modulated_carrier(nrf_802154_term_t term_lvl,
|
|
const uint8_t * p_data);
|
|
|
|
#endif // NRF_802154_CARRIER_FUNCTIONS_ENABLED
|
|
|
|
/***************************************************************************************************
|
|
* @section State machine notifications
|
|
**************************************************************************************************/
|
|
|
|
/**
|
|
* @brief Notifies the core module that a higher layer freed a frame buffer.
|
|
*
|
|
* When there are no free buffers available, the core does not start the receiver.
|
|
* If the core receives this notification, it changes the internal state to make sure
|
|
* the receiver is started if requested.
|
|
*
|
|
* @param[in] p_data Pointer to buffer that has been freed.
|
|
*/
|
|
bool nrf_802154_core_notify_buffer_free(uint8_t * p_data);
|
|
|
|
/**
|
|
* @brief Notifies the core module that the next higher layer requested the change of the channel.
|
|
*
|
|
* The core is expected to update the frequency register of the peripheral and, if it is
|
|
* in the @ref RADIO_STATE_RX, in the @ref RADIO_STATE_CONTINUOUS_CARRIER
|
|
* or in the @ref RADIO_STATE_MODULATED_CARRIER state, the transceiver is disabled
|
|
* and enabled again to use the new channel.
|
|
*
|
|
* @param[in] req_orig Module that originates this request.
|
|
*/
|
|
bool nrf_802154_core_channel_update(req_originator_t req_orig);
|
|
|
|
/**
|
|
* @brief Notifies the core module that the next higher layer requested the change
|
|
* of the CCA configuration.
|
|
*/
|
|
bool nrf_802154_core_cca_cfg_update(void);
|
|
|
|
/**
|
|
* @brief Notifies the core module that the next higher layer requested the RSSI measurement.
|
|
*/
|
|
bool nrf_802154_core_rssi_measure(void);
|
|
|
|
/**
|
|
* @brief Gets the last RSSI measurement.
|
|
*
|
|
* @param[out] p_rssi RSSI measurement value in dBm.
|
|
*/
|
|
bool nrf_802154_core_last_rssi_measurement_get(int8_t * p_rssi);
|
|
|
|
/**
|
|
* Get RSSI of the last received non-ACK frame.
|
|
*
|
|
* Returns 0 if no frame was received yet.
|
|
*
|
|
* @returns Temperature-corrected RSSI of the last received frame
|
|
*/
|
|
int8_t nrf_802154_core_last_frame_rssi_get(void);
|
|
|
|
/**
|
|
* Get LQI of the last received non-ACK frame.
|
|
*
|
|
* Returns 0 if no frame was received yet.
|
|
*
|
|
* @returns Temperature-corrected LQI of the last received frame
|
|
*/
|
|
uint8_t nrf_802154_core_last_frame_lqi_get(void);
|
|
|
|
/**
|
|
* @brief Notifies the core module that the next higher layer requested the change of the antenna.
|
|
*/
|
|
bool nrf_802154_core_antenna_update(void);
|
|
|
|
#if !NRF_802154_INTERNAL_IRQ_HANDLING
|
|
/**
|
|
* @brief Notifies the core module that there is a pending IRQ to be handled.
|
|
*/
|
|
void nrf_802154_core_irq_handler(void);
|
|
#endif // !NRF_802154_INTERNAL_IRQ_HANDLING
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* NRF_802154_CORE_H_ */
|