1 /* Copyright (c) 2014, Nordic Semiconductor ASA
2  *
3  * Permission is hereby granted, free of charge, to any person obtaining a copy
4  * of this software and associated documentation files (the "Software"), to deal
5  * in the Software without restriction, including without limitation the rights
6  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7  * copies of the Software, and to permit persons to whom the Software is
8  * furnished to do so, subject to the following conditions:
9  *
10  * The above copyright notice and this permission notice shall be included in all
11  * copies or substantial portions of the Software.
12  *
13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19  * SOFTWARE.
20  */
21 
22 /**
23  * @file
24  * @brief Interface for buffer.
25  * @ingroup aci
26  */
27 
28 /**
29 @{
30 */
31 
32 #ifndef ACI_QUEUE_H__
33 #define ACI_QUEUE_H__
34 
35 #include "aci.h"
36 #include "hal_aci_tl.h"
37 
38 /***********************************************************************    */
39 /* The ACI_QUEUE_SIZE determines the memory usage of the system.            */
40 /* Successfully tested to a ACI_QUEUE_SIZE of 4 (interrupt) and 4 (polling) */
41 /***********************************************************************    */
42 #define ACI_QUEUE_SIZE  4
43 
44 /** Data type for queue of data packets to send/receive from radio.
45  *
46  *  A FIFO queue is maintained for packets. New packets are added (enqueued)
47  *  at the tail and taken (dequeued) from the head. The head variable is the
48  *  index of the next packet to dequeue while the tail variable is the index of
49  *  where the next packet should be queued.
50  */
51 
52 typedef struct {
53     hal_aci_data_t           aci_data[ACI_QUEUE_SIZE];
54     uint8_t                  head;
55     uint8_t                  tail;
56 } aci_queue_t;
57 
58 void aci_queue_init(aci_queue_t *aci_q);
59 
60 bool aci_queue_dequeue(aci_queue_t *aci_q, hal_aci_data_t *p_data);
61 bool aci_queue_dequeue_from_isr(aci_queue_t *aci_q, hal_aci_data_t *p_data);
62 
63 bool aci_queue_enqueue(aci_queue_t *aci_q, hal_aci_data_t *p_data);
64 bool aci_queue_enqueue_from_isr(aci_queue_t *aci_q, hal_aci_data_t *p_data);
65 
66 bool aci_queue_is_empty(aci_queue_t *aci_q);
67 bool aci_queue_is_empty_from_isr(aci_queue_t *aci_q);
68 
69 bool aci_queue_is_full(aci_queue_t *aci_q);
70 bool aci_queue_is_full_from_isr(aci_queue_t *aci_q);
71 
72 bool aci_queue_peek(aci_queue_t *aci_q, hal_aci_data_t *p_data);
73 bool aci_queue_peek_from_isr(aci_queue_t *aci_q, hal_aci_data_t *p_data);
74 
75 #endif /* ACI_QUEUE_H__ */
76 /** @} */
77