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_IFS_H
36 #define NRF_802154_IFS_H
37 
38 #include <stdbool.h>
39 #include <stdint.h>
40 
41 #include "nrf_802154_const.h"
42 #include "nrf_802154_types_internal.h"
43 
44 /**
45  * @brief Initializes the Interframe Spacing handling feature.
46  */
47 void nrf_802154_ifs_init(void);
48 
49 /**
50  * @brief Deinitializes the Interframe Spacing handling feature.
51  */
52 void nrf_802154_ifs_deinit(void);
53 
54 /**
55  * @brief Examines the frame before transmission and checks if it needs to be delayed.
56  *
57  * @param[in]  p_frame          Pointer to the buffer that contains the PHR and PSDU
58  *                              of the transmitted frame.
59  * @param[in]  p_params         Pointer to the transmission parameters.
60  * @param[in]  notify_function  Function to be called to notify transmission failure.
61  *
62  * @retval     true      Frame will be transmitted right away.
63  * @retval     false     Frame is delayed and will be transmistted after a needed IFS.
64  */
65 bool nrf_802154_ifs_pretransmission(
66     uint8_t                                 * p_frame,
67     nrf_802154_transmit_params_t            * p_params,
68     nrf_802154_transmit_failed_notification_t notify_function);
69 
70 /**
71  * @brief Captures the timestamp, length and destination address of the transmitted
72  *        frame for the sake of future analysis by the @ref nrf_802154_ifs_pretransmission
73  *
74  * @param[in]  p_frame  Pointer to the buffer that contains the PHR and PSDU of the transmitted frame.
75  */
76 void nrf_802154_ifs_transmitted_hook(const uint8_t * p_frame);
77 
78 /**
79  * @brief Aborts an ongoing IFS-delayed transmission.
80  *
81  * @param[in]  term_lvl  Termination level set by the request to abort the ongoing operation.
82  * @param[in]  req_orig  Module that originates this request.
83  *
84  * @retval  true   Transmission procedure have been stopped.
85  * @retval  false  Transmission procedure were not running.
86  *
87  */
88 bool nrf_802154_ifs_abort(nrf_802154_term_t term_lvl, req_originator_t req_orig);
89 
90 #endif // NRF_802154_IFS_H
91