nrf_802154_request.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_REQUEST_H__
#define NRF_802154_REQUEST_H__
 
#include <stdbool.h>
#include <stdint.h>
 
#include "nrf_802154_const.h"
#include "nrf_802154_notification.h"
#include "nrf_802154_types_internal.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
void nrf_802154_request_init(void);
 
bool nrf_802154_request_sleep(nrf_802154_term_t term_lvl);
 
#if NRF_802154_CSMA_CA_CANCEL_ENABLED
 
bool nrf_802154_request_sleep_with_cancel_csma_ca(nrf_802154_term_t term_lvl);
 
#endif /* NRF_802154_CSMA_CA_CANCEL_ENABLED */
 
bool nrf_802154_request_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_request_transmit(nrf_802154_term_t              term_lvl,
                                                  req_originator_t               req_orig,
                                                  nrf_802154_transmit_params_t * p_params);
 
bool nrf_802154_request_ack_timeout_handle(const nrf_802154_ack_timeout_handle_params_t * p_param);
 
bool nrf_802154_request_energy_detection(nrf_802154_term_t term_lvl, uint32_t time_us);
 
bool nrf_802154_request_cca(nrf_802154_term_t term_lvl);
 
#if NRF_802154_CARRIER_FUNCTIONS_ENABLED
 
bool nrf_802154_request_continuous_carrier(nrf_802154_term_t term_lvl);
 
bool nrf_802154_request_modulated_carrier(nrf_802154_term_t term_lvl,
                                          const uint8_t   * p_data);
 
#endif /* NRF_802154_CARRIER_FUNCTIONS_ENABLED */
 
bool nrf_802154_request_buffer_free(uint8_t * p_data);
 
bool nrf_802154_request_antenna_update(void);
 
bool nrf_802154_request_channel_update(req_originator_t req_orig);
 
bool nrf_802154_request_cca_cfg_update(void);
 
bool nrf_802154_request_rssi_measure(void);
 
bool nrf_802154_request_rssi_measurement_get(int8_t * p_rssi);
 
#if NRF_802154_DELAYED_TRX_ENABLED
nrf_802154_tx_error_t nrf_802154_request_transmit_raw_at(
    const nrf_802154_frame_t                * p_frame,
    uint64_t                                  tx_time,
    const nrf_802154_transmit_at_metadata_t * p_metadata);
 
bool nrf_802154_request_transmit_at_cancel(void);
 
bool nrf_802154_request_receive_at(uint64_t rx_time,
                                   uint32_t timeout,
                                   uint8_t  channel,
                                   uint32_t id);
 
bool nrf_802154_request_receive_at_cancel(uint32_t id);
 
bool nrf_802154_request_receive_at_scheduled_cancel(uint32_t id);
 
#endif /* NRF_802154_DELAYED_TRX_ENABLED */
 
nrf_802154_tx_error_t nrf_802154_request_csma_ca_start(
    const nrf_802154_frame_t                     * p_frame,
    const nrf_802154_transmit_csma_ca_metadata_t * p_metadata);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF_802154_REQUEST_H__ */