nrf_802154_trx.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019, 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_TRX_H_
#define NRF_802154_TRX_H_
 
#include <stdbool.h>
#include <stdint.h>
 
#include "nrf_802154_config.h"
#include "nrf_802154_sl_types.h"
#include "nrf_802154_types_internal.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum
{
    TRX_STATE_DISABLED = 0,
    TRX_STATE_IDLE,
    TRX_STATE_GOING_IDLE,
    TRX_STATE_RXFRAME,
 
    /* PPIS disabled deconfigured
     * RADIO is DISABLED, RXDISABLE
     * RADIO shorts are 0
     * TIMER is running
     * FEM is going to powered or is powered depending if RADIO reached DISABLED
     */
    TRX_STATE_RXFRAME_FINISHED,
 
    TRX_STATE_RXACK,
    TRX_STATE_TXFRAME,
    TRX_STATE_TXACK,
    TRX_STATE_STANDALONE_CCA,
    TRX_STATE_CONTINUOUS_CARRIER,
    TRX_STATE_MODULATED_CARRIER,
    TRX_STATE_ENERGY_DETECTION,
 
    /* PPIS disabled deconfigured
     * RADIO is DISABLED, TXDISABLE, RXDISABLE
     * RADIO shorts are 0
     * TIMER is stopped
     * FEM is going to powered or is powered depending if RADIO reached DISABLED
     */
    TRX_STATE_FINISHED
} trx_state_t;
 
typedef enum
{
    TRX_RAMP_UP_SW_TRIGGER, 
    TRX_RAMP_UP_HW_TRIGGER  
} nrf_802154_trx_ramp_up_trigger_mode_t;
 
typedef enum
{
    TRX_RECEIVE_NOTIFICATION_NONE = 0U,
 
    TRX_RECEIVE_NOTIFICATION_PRESTARTED = (1U << 0),
 
    TRX_RECEIVE_NOTIFICATION_STARTED = (1U << 1),
} nrf_802154_trx_receive_notifications_t;
 
typedef enum
{
    TRX_TRANSMIT_NOTIFICATION_NONE = 0U,
 
    TRX_TRANSMIT_NOTIFICATION_CCAIDLE = (1U << 1),
 
    TRX_TRANSMIT_NOTIFICATION_CCASTARTED = (1U << 2)
} nrf_802154_trx_transmit_notifications_t;
 
void nrf_802154_trx_init(void);
 
void nrf_802154_trx_enable(void);
 
void nrf_802154_trx_disable(void);
 
void nrf_802154_trx_antenna_update(void);
 
void nrf_802154_trx_channel_set(uint8_t channel);
 
void nrf_802154_trx_cca_configuration_update(void);
 
void nrf_802154_trx_receive_frame(uint8_t                                 bcc,
                                  nrf_802154_trx_ramp_up_trigger_mode_t   rampup_trigg_mode,
                                  nrf_802154_trx_receive_notifications_t  notifications_mask,
                                  const nrf_802154_fal_tx_power_split_t * p_ack_tx_power);
 
void nrf_802154_trx_receive_ack(void);
 
bool nrf_802154_trx_rssi_measure(void);
 
bool nrf_802154_trx_rssi_measure_is_started(void);
 
bool nrf_802154_trx_rssi_sample_is_available(void);
 
uint8_t nrf_802154_trx_rssi_last_sample_get(void);
 
bool nrf_802154_trx_psdu_is_being_received(void);
 
bool nrf_802154_trx_receive_is_buffer_missing(void);
 
bool nrf_802154_trx_receive_buffer_set(void * p_receive_buffer);
 
void nrf_802154_trx_transmit_frame(const void                            * p_transmit_buffer,
                                   nrf_802154_trx_ramp_up_trigger_mode_t   rampup_trigg_mode,
                                   uint8_t                                 cca_attempts,
                                   const nrf_802154_fal_tx_power_split_t * p_tx_power,
                                   nrf_802154_trx_transmit_notifications_t notifications_mask);
 
bool nrf_802154_trx_transmit_ack(const void * p_transmit_buffer, uint32_t delay_us);
 
bool nrf_802154_trx_go_idle(void);
 
void nrf_802154_trx_standalone_cca(void);
 
#if NRF_802154_CARRIER_FUNCTIONS_ENABLED
 
void nrf_802154_trx_continuous_carrier(const nrf_802154_fal_tx_power_split_t * p_tx_power);
 
void nrf_802154_trx_continuous_carrier_restart(void);
 
void nrf_802154_trx_modulated_carrier(const void                            * p_transmit_buffer,
                                      const nrf_802154_fal_tx_power_split_t * p_tx_power);
 
void nrf_802154_trx_modulated_carrier_restart(void);
 
#endif // NRF_802154_CARRIER_FUNCTIONS_ENABLED
 
void nrf_802154_trx_energy_detection(uint32_t ed_count);
 
void nrf_802154_trx_abort(void);
 
trx_state_t nrf_802154_trx_state_get(void);
 
uint32_t nrf_802154_trx_ramp_up_ppi_channel_get(void);
 
extern void nrf_802154_trx_receive_ack_started(void);
 
extern void nrf_802154_trx_receive_frame_prestarted(void);
 
extern void nrf_802154_trx_receive_frame_started(void);
 
extern uint8_t nrf_802154_trx_receive_frame_bcmatched(uint8_t bcc);
 
extern void nrf_802154_trx_receive_frame_received(void);
 
extern void nrf_802154_trx_receive_frame_crcerror(void);
 
extern void nrf_802154_trx_receive_ack_received(void);
 
extern void nrf_802154_trx_receive_ack_crcerror(void);
 
extern void nrf_802154_trx_transmit_frame_ccastarted(void);
 
extern void nrf_802154_trx_transmit_frame_ccaidle(void);
 
extern void nrf_802154_trx_transmit_frame_ccabusy(void);
 
extern void nrf_802154_trx_transmit_frame_started(void);
 
extern void nrf_802154_trx_transmit_frame_transmitted(void);
 
extern void nrf_802154_trx_transmit_ack_started(void);
 
extern void nrf_802154_trx_transmit_ack_transmitted(void);
 
extern void nrf_802154_trx_go_idle_finished(void);
 
extern void nrf_802154_trx_standalone_cca_finished(bool channel_was_idle);
 
extern void nrf_802154_trx_energy_detection_finished(uint8_t ed_sample);
 
const nrf_802154_sl_event_handle_t * nrf_802154_trx_radio_end_event_handle_get(void);
 
const nrf_802154_sl_event_handle_t * nrf_802154_trx_radio_ready_event_handle_get(void);
 
const nrf_802154_sl_event_handle_t * nrf_802154_trx_radio_crcok_event_handle_get(void);
 
const nrf_802154_sl_event_handle_t * nrf_802154_trx_radio_phyend_event_handle_get(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF_802154_TRX_H_ */