LPCOpen Platform
LPCOpen Platform for NXP LPC Microcontrollers
 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  uint8_t *bufferBase, *bufferLast;
47  uint8_t *bufferIn, *bufferOut;
48  int count, used, itemSize;
49 } RINGBUFF_T;
50 
59 void RingBuffer_Init(RINGBUFF_T *RingBuff, void *buffer, int itemSize, int count);
60 
67 {
68  return RingBuff->used;
69 }
70 
77 {
78  return (bool) (RingBuff->used >= RingBuff->count);
79 }
80 
87 {
88  return (bool) (RingBuff->used == 0);
89 }
90 
97 bool RingBuffer_Insert8(RINGBUFF_T *RingBuff, uint8_t data8);
98 
105 bool RingBuffer_Insert16(RINGBUFF_T *RingBuff, uint16_t data16);
106 
113 bool RingBuffer_Insert32(RINGBUFF_T *RingBuff, uint32_t data32);
114 
121 bool RingBuffer_Pop8(RINGBUFF_T *RingBuff, uint8_t *data8);
122 
129 bool RingBuffer_Pop16(RINGBUFF_T *RingBuff, uint16_t *data16);
130 
137 bool RingBuffer_Pop32(RINGBUFF_T *RingBuff, uint32_t *data32);
138 
143 #endif /* __RING_BUFFER_H_ */