| LPCOpen Platform v1.03 LPCOpen Platform for NXP LPC Microcontrollers

- Main Page
- Modules
- Data Structures
- Files
- Related Pages

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
ring_buffer.h
Go to the documentation of this file.
1 /*
2 * @brief Common ring buffer support functions
3 *
4 * @note
5 * Copyright(C) NXP Semiconductors, 2012
6 * All rights reserved.
7 *
8 * @par
9 * Software that is described herein is for illustrative purposes only
10 * which provides customers with programming information regarding the
11 * LPC products. This software is supplied "AS IS" without any warranties of
12 * any kind, and NXP Semiconductors and its licensor disclaim any and
13 * all warranties, express or implied, including all implied warranties of
14 * merchantability, fitness for a particular purpose and non-infringement of
15 * intellectual property rights. NXP Semiconductors assumes no responsibility
16 * or liability for the use of the software, conveys no license or rights under any
17 * patent, copyright, mask work right, or any other intellectual property rights in
18 * or to any products. NXP Semiconductors reserves the right to make changes
19 * in the software without notification. NXP Semiconductors also makes no
20 * representation or warranty that such application will be suitable for the
21 * specified use without further testing or modification.
22 *
23 * @par
24 * Permission to use, copy, modify, and distribute this software and its
25 * documentation is hereby granted, under NXP Semiconductors' and its
26 * licensor's relevant copyrights in the software, without fee, provided that it
27 * is used in conjunction with NXP Semiconductors microcontrollers. This
28 * copyright, permission, and disclaimer notice must appear in all copies of
29 * this code.
30 */
31
32 #ifndef __RING_BUFFER_H_
33 #define __RING_BUFFER_H_
34
35 #include "lpc_types.h"
36
45 typedef struct {
46 void *data;
47 int count;
48 int itemSz;
49 uint32_t head;
50 uint32_t tail;
51 uint32_t valid;
52 } RINGBUFF_T;
53
54
55 /* Ring buffer validity signature */
56 #define RB_SIGNATURE 0x51DEF00D
57
62 #define RB_VHEAD(rb) (*(volatile uint32_t *) &(rb)->head)
63
68 #define RB_VTAIL(rb) (*(volatile uint32_t *) &(rb)->tail)
69
75 #define RingBuffer_IsValid(rb) ((rb)->valid == RB_SIGNATURE)
76
88 int RingBuffer_Init(RINGBUFF_T *RingBuff, void *buffer, int itemSize, int count);
89
95 STATIC INLINE void RingBuffer_Flush(RINGBUFF_T *RingBuff)
96 {
97 RingBuff->head = RingBuff->tail = 0;
98 }
99
105 STATIC INLINE int RingBuffer_GetSize(RINGBUFF_T *RingBuff)
106 {
107 return RingBuff->count;
108 }
109
115 STATIC INLINE int RingBuffer_GetCount(RINGBUFF_T *RingBuff)
116 {
117 return RB_VHEAD(RingBuff) - RB_VTAIL(RingBuff);
118 }
119
125 STATIC INLINE int RingBuffer_GetFree(RINGBUFF_T *RingBuff)
126 {
127 return RingBuff->count - RingBuffer_GetCount(RingBuff);
128 }
129
135 STATIC INLINE int RingBuffer_IsFull(RINGBUFF_T *RingBuff)
136 {
137 return (RingBuffer_GetCount(RingBuff) >= RingBuff->count);
138 }
139
145 STATIC INLINE int RingBuffer_IsEmpty(RINGBUFF_T *RingBuff)
146 {
147 return RB_VHEAD(RingBuff) == RB_VTAIL(RingBuff);
148 }
149
150
160 int RingBuffer_Insert(RINGBUFF_T *RingBuff, const void *data);
161
172 int RingBuffer_InsertMult(RINGBUFF_T *RingBuff, const void *data, int num);
173
183 int RingBuffer_Pop(RINGBUFF_T *RingBuff, void *data);
184
194 int RingBuffer_PopMult(RINGBUFF_T *RingBuff, void *data, int num);
195
196
201 #endif /* __RING_BUFFER_H_ */