1 /*
2 * Copyright (c) 2017 - 2023, 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_SL_CRIT_SECT_IF_H__
36 #define NRF_802154_SL_CRIT_SECT_IF_H__
37
38 #include <stdbool.h>
39
40 /**
41 * @defgroup nrf_802154_sl_crit_sect_if Interface of the critical section.
42 * @{
43 */
44
45 /**
46 * @brief Pointer to function used to enter critical section.
47 */
48 typedef bool (* nrf_802154_sl_crit_sect_enter_t)(void);
49
50 /**
51 * @brief Pointer to function used to exit critical section.
52 */
53 typedef void (* nrf_802154_sl_crit_sect_exit_t)(void);
54
55 /**
56 * @brief Structure that holds interface of Radio Driver critical sections.
57 */
58 typedef struct
59 {
60 nrf_802154_sl_crit_sect_enter_t enter;
61 nrf_802154_sl_crit_sect_exit_t exit;
62 } nrf_802154_sl_crit_sect_interface_t;
63
64 /**
65 * @brief Initializes the critical section interface.
66 *
67 * After the call SL library can use @ref nrf_802154_sl_crit_sect_enter and
68 * @ref nrf_802154_sl_crit_sect_exit to use critical section provided by the Radio Driver.
69 *
70 * @param[in] p_crit_sect_interface Pointer to a critical section interface of the Radio Driver.
71 * It must point to static data for lifetime of Radio Driver.
72 */
73 void nrf_802154_sl_crit_sect_init(
74 const nrf_802154_sl_crit_sect_interface_t * p_crit_sect_interface);
75
76 /**
77 * @brief Enters into the critical section.
78 *
79 * @retval true Code entered into the critical section.
80 * @retval false Critical section was already taken, could not enter into critical section.
81 */
nrf_802154_sl_crit_sect_enter(void)82 static inline bool nrf_802154_sl_crit_sect_enter(void)
83 {
84 extern const nrf_802154_sl_crit_sect_interface_t * gp_nrf_802154_sl_crit_sect_interface;
85
86 return gp_nrf_802154_sl_crit_sect_interface->enter();
87 }
88
89 /**
90 * @brief Exits out of the critical section.
91 */
nrf_802154_sl_crit_sect_exit(void)92 static inline void nrf_802154_sl_crit_sect_exit(void)
93 {
94 extern const nrf_802154_sl_crit_sect_interface_t * gp_nrf_802154_sl_crit_sect_interface;
95
96 return gp_nrf_802154_sl_crit_sect_interface->exit();
97 }
98
99 /**
100 *@}
101 **/
102
103 #endif // NRF_802154_SL_CRIT_SECT_IF_H__
104
