From 4ba8614c006f9828f0796c140bc3e13c9e67938c Mon Sep 17 00:00:00 2001
From: Yuval Adam <yuv.adm@gmail.com>
Date: Mon, 29 Oct 2012 23:06:01 +0200
Subject: Added utils

---
 utils/ringbuf.h | 105 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 105 insertions(+)
 create mode 100644 utils/ringbuf.h

(limited to 'utils/ringbuf.h')

diff --git a/utils/ringbuf.h b/utils/ringbuf.h
new file mode 100644
index 0000000..7aeab65
--- /dev/null
+++ b/utils/ringbuf.h
@@ -0,0 +1,105 @@
+//*****************************************************************************
+//
+// ringbuf.h - Defines and Macros for the ring buffer utilities.
+//
+// Copyright (c) 2008-2012 Texas Instruments Incorporated.  All rights reserved.
+// Software License Agreement
+// 
+// Texas Instruments (TI) is supplying this software for use solely and
+// exclusively on TI's microcontroller products. The software is owned by
+// TI and/or its suppliers, and is protected under applicable copyright
+// laws. You may not combine this software with "viral" open-source
+// software in order to form a larger program.
+// 
+// THIS SOFTWARE IS PROVIDED "AS IS" AND WITH ALL FAULTS.
+// NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT
+// NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. TI SHALL NOT, UNDER ANY
+// CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
+// DAMAGES, FOR ANY REASON WHATSOEVER.
+// 
+// This is part of revision 9453 of the Stellaris Firmware Development Package.
+//
+//*****************************************************************************
+
+#ifndef __RINGBUF_H__
+#define __RINGBUF_H__
+
+//*****************************************************************************
+//
+// If building with a C++ compiler, make all of the definitions in this header
+// have a C binding.
+//
+//*****************************************************************************
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+//*****************************************************************************
+//
+// The structure used for encapsulating all the items associated with a
+// ring buffer.
+//
+//*****************************************************************************
+typedef struct
+{
+    //
+    // The ring buffer size.
+    //
+    unsigned long ulSize;
+
+    //
+    // The ring buffer write index.
+    //
+    volatile unsigned long ulWriteIndex;
+
+    //
+    // The ring buffer read index.
+    //
+    volatile unsigned long ulReadIndex;
+
+    //
+    // The ring buffer.
+    //
+    unsigned char *pucBuf;
+
+}
+tRingBufObject;
+
+//*****************************************************************************
+//
+// API Function prototypes
+//
+//*****************************************************************************
+extern tBoolean RingBufFull(tRingBufObject *ptRingBuf);
+extern tBoolean RingBufEmpty(tRingBufObject *ptRingBuf);
+extern void RingBufFlush(tRingBufObject *ptRingBuf);
+extern unsigned long RingBufUsed(tRingBufObject *ptRingBuf);
+extern unsigned long RingBufFree(tRingBufObject *ptRingBuf);
+extern unsigned long RingBufContigUsed(tRingBufObject *ptRingBuf);
+extern unsigned long RingBufContigFree(tRingBufObject *ptRingBuf);
+extern unsigned long RingBufSize(tRingBufObject *ptRingBuf);
+extern unsigned char RingBufReadOne(tRingBufObject *ptRingBuf);
+extern void RingBufRead(tRingBufObject *ptRingBuf, unsigned char *pucData,
+                        unsigned long ulLength);
+extern void RingBufWriteOne(tRingBufObject *ptRingBuf, unsigned char ucData);
+extern void RingBufWrite(tRingBufObject *ptRingBuf, unsigned char *pucData,
+                         unsigned long ulLength);
+extern void RingBufAdvanceWrite(tRingBufObject *ptRingBuf,
+                                unsigned long ulNumBytes);
+extern void RingBufAdvanceRead(tRingBufObject *ptRingBuf,
+                                unsigned long ulNumBytes);
+extern void RingBufInit(tRingBufObject *ptRingBuf, unsigned char *pucBuf,
+                        unsigned long ulSize);
+
+//*****************************************************************************
+//
+// Mark the end of the C bindings section for C++ compilers.
+//
+//*****************************************************************************
+#ifdef __cplusplus
+}
+#endif
+
+#endif //  __RINGBUF_H__
-- 
cgit v1.3.1