nrf_802154_callouts.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_CALLOUTS_H_
#define NRF_802154_CALLOUTS_H_
 
#include <stdint.h>
#include <stdbool.h>
 
#include "nrf_802154_config.h"
#include "nrf_802154_types.h"
 
extern void nrf_802154_cca_done(bool channel_free);
 
extern void nrf_802154_cca_failed(nrf_802154_cca_error_t error);
 
extern void nrf_802154_energy_detected(const nrf_802154_energy_detected_t * p_result);
 
extern void nrf_802154_energy_detection_failed(nrf_802154_ed_error_t error);
 
extern void nrf_802154_tx_ack_started(const uint8_t * p_data);
 
#if NRF_802154_USE_RAW_API || defined(DOXYGEN)
 
#if !NRF_802154_SERIALIZATION_HOST || defined(DOXYGEN)
extern void nrf_802154_received_raw(uint8_t * p_data, int8_t power, uint8_t lqi);
 
#endif // !NRF_802154_SERIALIZATION_HOST
 
extern void nrf_802154_received_timestamp_raw(uint8_t * p_data,
                                              int8_t    power,
                                              uint8_t   lqi,
                                              uint64_t  time);
 
#endif // NRF_802154_USE_RAW_API
 
#if !NRF_802154_USE_RAW_API || defined(DOXYGEN)
#if !NRF_802154_SERIALIZATION_HOST || defined(DOXYGEN)
extern void nrf_802154_received(uint8_t * p_data, uint8_t length, int8_t power, uint8_t lqi);
 
extern void nrf_802154_received_timestamp(uint8_t * p_data,
                                          uint8_t   length,
                                          int8_t    power,
                                          uint8_t   lqi,
                                          uint32_t  time);
 
#endif // !NRF_802154_SERIALIZATION_HOST
#endif // !NRF_802154_USE_RAW_API
 
extern void nrf_802154_receive_failed(nrf_802154_rx_error_t error, uint32_t id);
 
#if NRF_802154_USE_RAW_API || defined(DOXYGEN)
extern void nrf_802154_transmitted_raw(uint8_t                                   * p_frame,
                                       const nrf_802154_transmit_done_metadata_t * p_metadata);
 
#endif // NRF_802154_USE_RAW_API
 
#if !NRF_802154_USE_RAW_API || defined(DOXYGEN)
extern void nrf_802154_transmitted(uint8_t                                   * p_frame,
                                   const nrf_802154_transmit_done_metadata_t * p_metadata);
 
#endif // !NRF_802154_USE_RAW_API
 
extern void nrf_802154_transmit_failed(uint8_t                                   * p_frame,
                                       nrf_802154_tx_error_t                       error,
                                       const nrf_802154_transmit_done_metadata_t * p_metadata);
 
#if !NRF_802154_SERIALIZATION_HOST || defined(DOXYGEN)
extern void nrf_802154_tx_started(const uint8_t * p_frame);
 
extern void nrf_802154_custom_part_of_radio_init(void);
 
#endif // !NRF_802154_SERIALIZATION_HOST
 
#endif /* NRF_802154_CALLOUTS_H_ */