nrf_802154_core.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_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
 
typedef enum
{
    /* Sleep */
    RADIO_STATE_SLEEP,          
    RADIO_STATE_FALLING_ASLEEP, 
    /* Receive */
    RADIO_STATE_RX,             
    RADIO_STATE_TX_ACK,         
    /* Transmit */
    RADIO_STATE_CCA_TX,         
    RADIO_STATE_TX,             
    RADIO_STATE_RX_ACK,         
    /* Energy Detection */
    RADIO_STATE_ED,             
    /* CCA */
    RADIO_STATE_CCA,            
#if NRF_802154_CARRIER_FUNCTIONS_ENABLED
 
    /* Continuous carrier */
    RADIO_STATE_CONTINUOUS_CARRIER, 
    /* Modulated carrier */
    RADIO_STATE_MODULATED_CARRIER   
#endif  /* NRF_802154_CARRIER_FUNCTIONS_ENABLED */
 
} radio_state_t;
 
void nrf_802154_core_init(void);
 
void nrf_802154_core_deinit(void);
 
radio_state_t nrf_802154_core_state_get(void);
 
/***************************************************************************************************
 * @section State machine transition requests
 **************************************************************************************************/
 
bool nrf_802154_core_sleep(nrf_802154_term_t term_lvl);
 
#if NRF_802154_CSMA_CA_CANCEL_ENABLED || defined(__DOXYGEN__)
 
bool nrf_802154_core_sleep_with_cancel_csma_ca(nrf_802154_term_t term_lvl);
 
#endif /* NRF_802154_CSMA_CA_CANCEL_ENABLED */
 
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);
 
nrf_802154_tx_error_t nrf_802154_core_transmit(nrf_802154_term_t              term_lvl,
                                               req_originator_t               req_orig,
                                               nrf_802154_transmit_params_t * p_params);
 
bool nrf_802154_core_ack_timeout_handle(const nrf_802154_ack_timeout_handle_params_t * p_param);
 
bool nrf_802154_core_energy_detection(nrf_802154_term_t term_lvl, uint32_t time_us);
 
bool nrf_802154_core_cca(nrf_802154_term_t term_lvl);
 
#if NRF_802154_CARRIER_FUNCTIONS_ENABLED
 
bool nrf_802154_core_continuous_carrier(nrf_802154_term_t term_lvl);
 
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
 **************************************************************************************************/
 
bool nrf_802154_core_notify_buffer_free(uint8_t * p_data);
 
bool nrf_802154_core_channel_update(req_originator_t req_orig);
 
bool nrf_802154_core_cca_cfg_update(void);
 
bool nrf_802154_core_rssi_measure(void);
 
bool nrf_802154_core_last_rssi_measurement_get(int8_t * p_rssi);
 
int8_t nrf_802154_core_last_frame_rssi_get(void);
 
uint8_t nrf_802154_core_last_frame_lqi_get(void);
 
bool nrf_802154_core_antenna_update(void);
 
#if !NRF_802154_INTERNAL_IRQ_HANDLING
 
void nrf_802154_core_irq_handler(void);
 
#endif /* !NRF_802154_INTERNAL_IRQ_HANDLING */
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF_802154_CORE_H_ */