1 /*
2  * Copyright (c) 2021 - 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 This file implements the nRF 802.15.4 Service Layer capabilities API.
37  *
38  */
39 #ifndef NRF_802154_SL_CAPABILITIES_H__
40 #define NRF_802154_SL_CAPABILITIES_H__
41 
42 #include <stdint.h>
43 
44 /**
45  * @brief Capabilities of nrf 802.15.4 service layer
46  *
47  * Possible values:
48  * - @ref NRF_802154_SL_CAPABILITY_CSMA,
49  * - @ref NRF_802154_SL_CAPABILITY_DELAYED_TX,
50  * - @ref NRF_802154_SL_CAPABILITY_DELAYED_RX,
51  * - @ref NRF_802154_SL_CAPABILITY_ANT_DIVERSITY,
52  * - @ref NRF_802154_SL_CAPABILITY_MULTITIMER,
53  * - @ref NRF_802154_SL_CAPABILITY_TIMESTAMP
54  *
55  */
56 typedef uint32_t nrf_802154_sl_capabilities_t;
57 
58 #define NRF_802154_SL_CAPABILITY_CSMA          (1UL << 0UL) // !< CSMA-CA supported
59 #define NRF_802154_SL_CAPABILITY_DELAYED_TX    (1UL << 1UL) // !< TX at specified time supported
60 #define NRF_802154_SL_CAPABILITY_DELAYED_RX    (1UL << 2UL) // !< RX at specified time supported
61 #define NRF_802154_SL_CAPABILITY_ANT_DIVERSITY (1UL << 3UL) // !< Antenna diversity supported
62 #define NRF_802154_SL_CAPABILITY_MULTITIMER    (1UL << 4UL) // !< Scheduling multiple timers supported
63 #define NRF_802154_SL_CAPABILITY_TIMESTAMP     (1UL << 5UL) // !< Frame timestamping supported
64 
65 /**
66  * @brief Get capabilities of current nRF 802.15.4 SL implementation.
67  *
68  * @return Mask of current SL capabilities
69  */
70 nrf_802154_sl_capabilities_t nrf_802154_sl_capabilities_get(void);
71 
72 #endif // NRF_802154_SL_CAPABILITIES_H__
73