LightweightRingBuff.h 2.5 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/*
             LUFA Library
     Copyright (C) Dean Camera, 2010.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)

  Permission to use, copy, modify, distribute, and sell this 
  software and its documentation for any purpose is hereby granted
  without fee, provided that the above copyright notice appear in 
  all copies and that both that the copyright notice and this
  permission notice and warranty disclaimer appear in supporting 
  documentation, and that the name of the author not be used in 
  advertising or publicity pertaining to distribution of the 
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

/** \file
 *
 *  Ultra lightweight ring buffer, for fast insertion/deletion.
 */
 
#ifndef _ULW_RING_BUFF_H_
#define _ULW_RING_BUFF_H_

	/* Includes: */
		#include <stdint.h>
		#include <stdbool.h>

	/* Defines: */
		/** Size of each ring buffer, in bytes */
		#define BUFFER_SIZE      128
		
		/** Type of data to store into the buffer */
		#define RingBuff_Data_t  uint8_t

	/* Type Defines: */
		typedef struct
		{
			RingBuff_Data_t  Buffer[BUFFER_SIZE];
			RingBuff_Data_t* In;
			RingBuff_Data_t* Out;
		} RingBuff_t;
	
	/* Inline Functions: */
		static inline void RingBuffer_InitBuffer(RingBuff_t* const Buffer)
		{
			Buffer->In  = Buffer->Buffer;
			Buffer->Out = Buffer->Buffer;		
		}
		
		static inline void RingBuffer_Insert(RingBuff_t* const Buffer, RingBuff_Data_t Data)
		{
			*Buffer->In = Data;
		
			if (++Buffer->In == &Buffer->Buffer[BUFFER_SIZE])
			  Buffer->In = Buffer->Buffer;
		}

		static inline RingBuff_Data_t RingBuffer_Remove(RingBuff_t* const Buffer)
		{
			RingBuff_Data_t Data = *Buffer->Out;
		
			if (++Buffer->Out == &Buffer->Buffer[BUFFER_SIZE])
			  Buffer->Out = Buffer->Buffer;
			  
			return Data;
		}

		static inline bool RingBuffer_Empty(RingBuff_t* const Buffer)
		{
			return (Buffer->In == Buffer->Out);
		}

#endif