1 /*
2  * Copyright (c) 2020 - 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 /**
36  * @file Common types provided by the nRF 802.15.4 Service Layer.
37  *
38  */
39 
40 #ifndef NRF_802154_SL_TYPES_H__
41 #define NRF_802154_SL_TYPES_H__
42 
43 #include <stdint.h>
44 #include <stdbool.h>
45 #include <nrfx.h>
46 
47 /**
48  * @brief Handle of a hardware event.
49  *
50  * This handle can be used to trigger peripheral tasks through hardware.
51  */
52 typedef struct
53 {
54     /**
55      * @brief Actual handle to use when configuring hardware.
56      *
57      * On nRF52 series, this field represents an address of a hardware event
58      * that can be written to a PPI register.
59      *
60      * On nRF53 series, this field depending on @c shared might either represent
61      * an address of a hardware event that should publish to a DPPI channel,
62      * or a number of a DPPI channel that the hardware event of interest
63      * is already publishing to.
64      */
65     uint32_t event_addr;
66 
67 #if defined(DPPI_PRESENT)
68     /**
69      * @brief Indicates if the event is already publishing to a DPPI channel.
70      */
71     bool shared;
72 
73 #endif
74 } nrf_802154_sl_event_handle_t;
75 
76 #endif // NRF_802154_SL_TYPES_H__
77