nrfxlib API 3.3.99
Loading...
Searching...
No Matches
nrf_802154_delayed_trx.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2017, Nordic Semiconductor ASA
3 * All rights reserved.
4 *
5 * SPDX-License-Identifier: BSD-3-Clause
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
9 *
10 * 1. Redistributions of source code must retain the above copyright notice, this
11 * list of conditions and the following disclaimer.
12 *
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
18 * contributors may be used to endorse or promote products derived from this
19 * software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
25 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
32 *
33 */
34
35#ifndef NRF_802154_DELAYED_TRX_H__
36#define NRF_802154_DELAYED_TRX_H__
37
38#include <stdbool.h>
39#include <stdint.h>
40
41#include "nrf_802154_const.h"
42#include "nrf_802154_config.h"
43#include "nrf_802154_types.h"
45
46#if NRF_802154_DELAYED_TRX_ENABLED || defined(__DOXYGEN__)
47
62
67
82 const nrf_802154_frame_t * p_frame,
83 uint64_t tx_time,
84 const nrf_802154_transmit_at_metadata_t * p_metadata);
85
95
119bool nrf_802154_delayed_trx_receive(uint64_t rx_time,
120 uint32_t timeout,
121 uint8_t channel,
122 uint32_t id);
123
137
153
154#if NRF_802154_DELAYED_TRX_CANCEL_ALL_ENABLED || defined(__DOXYGEN__)
155
164
165#endif /* NRF_802154_DELAYED_TRX_CANCEL_ALL_ENABLED */
166
181
193
204bool nrf_802154_delayed_trx_nearest_drx_time_to_midpoint_get(uint32_t * p_drx_time_to_midpoint);
205
210#endif /* NRF_802154_DELAYED_TRX_ENABLED */
211
212#endif /* NRF_802154_DELAYED_TRX_H__ */
nrf_802154_tx_error_t nrf_802154_delayed_trx_transmit(const nrf_802154_frame_t *p_frame, uint64_t tx_time, const nrf_802154_transmit_at_metadata_t *p_metadata)
Requests transmission of a frame at a given time.
bool nrf_802154_delayed_trx_receive_scheduled_cancel(uint32_t id)
Cancels a scheduled reception scheduled by a call to nrf_802154_delayed_trx_receive.
bool nrf_802154_delayed_trx_nearest_drx_time_to_midpoint_get(uint32_t *p_drx_time_to_midpoint)
Gets the time in microseconds to the midpoint of the nearest scheduled DRX window.
void nrf_802154_delayed_trx_init(void)
Initializes delayed transmission and reception window features.
bool nrf_802154_delayed_trx_receive(uint64_t rx_time, uint32_t timeout, uint8_t channel, uint32_t id)
Requests the reception of a frame at a given time.
void nrf_802154_delayed_trx_deinit(void)
Deinitializes delayed transmission and reception window features.
void nrf_802154_delayed_trx_rx_started_hook(const nrf_802154_frame_t *p_frame)
Extends the timeout timer when the reception start is detected and there is not enough time left for ...
void nrf_802154_delayed_trx_receive_cancel_all(void)
Cancels all receptions scheduled by a call to nrf_802154_delayed_trx_receive.
bool nrf_802154_delayed_trx_abort(nrf_802154_term_t term_lvl, req_originator_t req_orig)
Aborts an ongoing delayed reception procedure.
bool nrf_802154_delayed_trx_receive_cancel(uint32_t id)
Cancels a reception scheduled by a call to nrf_802154_delayed_trx_receive.
bool nrf_802154_delayed_trx_transmit_cancel(void)
Cancels a transmission scheduled by a call to nrf_802154_delayed_trx_transmit.
uint8_t nrf_802154_term_t
Termination level selected for a particular request.
Definition nrf_802154_types.h:162
uint8_t nrf_802154_tx_error_t
Errors reported during the frame transmission.
Definition nrf_802154_types.h:88
req_originator_t
Definition nrf_802154_const.h:235
Definition nrf_802154_frame.h:139
Structure with transmit request metadata for scheduling transmission at a specific time.
Definition nrf_802154_types.h:443