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 /**
36  * @brief Module that contains buffer for frames received by the nRF 802.15.4 radio driver.
37  *
38  */
39 
40 #ifndef NRF_802154_RX_BUFFER_H_
41 #define NRF_802154_RX_BUFFER_H_
42 
43 #include <stdbool.h>
44 #include <stdint.h>
45 
46 #include "nrf_802154_const.h"
47 
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51 
52 /**
53  * @brief Structure that contains the received frame.
54  */
55 typedef struct
56 {
57     uint8_t data[MAX_PACKET_SIZE + 1];
58     bool    free; // If this buffer is free or contains a frame.
59 } rx_buffer_t;
60 
61 /**
62  * @brief Array that contains all buffers used to receive frame.
63  *
64  * This array is in the global scope to allow optimizations in the core module if there is only
65  * one buffer provided by this module.
66  *
67  */
68 extern rx_buffer_t nrf_802154_rx_buffers[];
69 
70 /**
71  * @brief Initializes the buffer for received frames.
72  */
73 void nrf_802154_rx_buffer_init(void);
74 
75 /**
76  * @brief Gets a free buffer to receive a frame.
77  *
78  * @returns  Pointer to a free buffer, or NULL if no free buffer is available.
79  */
80 rx_buffer_t * nrf_802154_rx_buffer_free_find(void);
81 
82 #ifdef __cplusplus
83 }
84 #endif
85 
86 #endif /* NRF_802154_RX_BUFFER_H_ */
87