| /* Copyright (c) 2017 - 2018, Nordic Semiconductor ASA |
| * All rights reserved. |
| * |
| * 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.h" |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| /** |
| * @defgroup nrf_802154_request 802.15.4 driver request |
| * @{ |
| * @ingroup nrf_802154 |
| * @brief Requests to the driver triggered from the MAC layer. |
| */ |
| |
| /** |
| * @brief Initialize request module. |
| */ |
| void nrf_802154_request_init(void); |
| |
| /** |
| * @brief Request entering sleep state. |
| * |
| * @param[in] term_lvl Termination level of this request. Selects procedures to abort. |
| * |
| * @retval true The driver will enter sleep state. |
| * @retval false The driver cannot enter sleep state due to ongoing operation. |
| */ |
| bool nrf_802154_request_sleep(nrf_802154_term_t term_lvl); |
| |
| /** |
| * @brief Request entering receive 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 status of this procedure. May be NULL. |
| * @param[in] notify_abort If abort notification should be triggered automatically. |
| * |
| * @retval true The driver will enter receive state. |
| * @retval false The driver cannot enter receive state due to ongoing operation. |
| */ |
| 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); |
| |
| /** |
| * @brief Request entering transmit 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 the frame to transmit. |
| * @param[in] cca If the driver should perform CCA procedure before transmission. |
| * @param[in] immediate If true, the driver schedules transmission immediately or never; |
| * if false transmission may be postponed until tx preconditions are |
| * met. |
| * @param[in] notify_function Function called to notify status of this procedure. May be NULL. |
| * |
| * @retval true The driver will enter transmit state. |
| * @retval false The driver cannot enter transmit state due to ongoing operation. |
| */ |
| bool nrf_802154_request_transmit(nrf_802154_term_t term_lvl, |
| req_originator_t req_orig, |
| const uint8_t * p_data, |
| bool cca, |
| bool immediate, |
| nrf_802154_notification_func_t notify_function); |
| |
| /** |
| * @brief Request entering energy detection state. |
| * |
| * @param[in] term_lvl Termination level of this request. Selects procedures to abort. |
| * @param[in] time_us Requested duration of energy detection procedure. |
| * |
| * @retval true The driver will enter energy detection state. |
| * @retval false The driver cannot enter energy detection state due to ongoing operation. |
| */ |
| bool nrf_802154_request_energy_detection(nrf_802154_term_t term_lvl, uint32_t time_us); |
| |
| /** |
| * @brief Request entering CCA state. |
| * |
| * @param[in] term_lvl Termination level of this request. Selects procedures to abort. |
| * |
| * @retval true The driver will enter CCA state. |
| * @retval false The driver cannot enter CCA state due to ongoing operation. |
| */ |
| bool nrf_802154_request_cca(nrf_802154_term_t term_lvl); |
| |
| /** |
| * @brief Request entering continuous carrier state. |
| * |
| * @param[in] term_lvl Termination level of this request. Selects procedures to abort. |
| * |
| * @retval true The driver will enter continuous carrier state. |
| * @retval false The driver cannot enter continuous carrier state due to ongoing operation. |
| */ |
| bool nrf_802154_request_continuous_carrier(nrf_802154_term_t term_lvl); |
| |
| /** |
| * @brief Request the driver to free given buffer. |
| * |
| * @param[in] p_data Pointer to the buffer to free. |
| */ |
| bool nrf_802154_request_buffer_free(uint8_t * p_data); |
| |
| /** |
| * @brief Request the driver to update channel number used by the RADIO peripheral. |
| */ |
| bool nrf_802154_request_channel_update(void); |
| |
| /** |
| * @brief Request the driver to update CCA configuration used by the RADIO peripheral. |
| */ |
| bool nrf_802154_request_cca_cfg_update(void); |
| |
| /** |
| *@} |
| **/ |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif // NRF_802154_REQUEST_H__ |
