Moved all source to the trunk directory.

[pub/lufa.git] / Projects / Magstripe / CircularBitBuffer.h

diff --git a/Projects/Magstripe/CircularBitBuffer.h b/Projects/Magstripe/CircularBitBuffer.h
new file mode 100644 (file)
index 0000000..52410f6
--- /dev/null
+++ b/Projects/Magstripe/CircularBitBuffer.h
@@ -0,0 +1,95 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2009.\r
+              \r
+  dean [at] fourwalledcubicle [dot] com\r
+      www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+  Copyright 2009  Denver Gingerich (denver [at] ossguy [dot] com)\r
+  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, and distribute this software\r
+  and its documentation for any purpose and without fee is hereby\r
+  granted, provided that the above copyright notice appear in all\r
+  copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting\r
+  documentation, and that the name of the author not be used in\r
+  advertising or publicity pertaining to distribution of the\r
+  software without specific, written prior permission.\r
+\r
+  The author disclaim all warranties with regard to this\r
+  software, including all implied warranties of merchantability\r
+  and fitness.  In no event shall the author be liable for any\r
+  special, indirect or consequential damages or any damages\r
+  whatsoever resulting from loss of use, data or profits, whether\r
+  in an action of contract, negligence or other tortious action,\r
+  arising out of or in connection with the use or performance of\r
+  this software.\r
+*/\r
+\r
+/** \file\r
+ *\r
+ *  Header file for CircularBitBuffer.c.\r
+ */\r
+\r
+#ifndef _CIRCULARBITBUFFER_H_\r
+#define _CIRCULARBITBUFFER_H_\r
+\r
+       /* Includes: */\r
+               #include <avr/io.h>\r
+               #include <stdbool.h>\r
+               \r
+               #include <LUFA/Common/Common.h>\r
+\r
+       /* Macros: */\r
+               #if (defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) || \\r
+                    defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__)) || defined(__DOXYGEN__)\r
+                       /** Maximum number of bits which can be stored into a bit buffer. The memory usage is one eigth of this value per buffer. */\r
+                       #define MAX_BITS 20480\r
+               #else\r
+                       #define MAX_BITS 1024\r
+               #endif\r
+               \r
+       /* Type Defines: */\r
+               /* Type define for a pointer to a bit in a bit buffer. */\r
+               typedef struct\r
+               {\r
+                       uint8_t* CurrentByte; /**< Pointer to the current byte in the buffer */\r
+                       uint8_t  ByteMask; /**< Mask of the current bit in the buffer */\r
+               } BitBufferPointer_t;\r
+\r
+               /** Type define for a circular packet bit buffer. */\r
+               typedef struct\r
+               {\r
+                       uint8_t            Data[MAX_BITS / 8]; /**< Buffer to hold the stored bits in packed form */\r
+                       uint16_t           Elements; /**< Number of stored bits in the bit buffer */\r
+                       \r
+                       BitBufferPointer_t In; /**< Bit pointer to the next storage location in the buffer */\r
+                       BitBufferPointer_t Out; /**< Bit pointer to the next retrieval location in the buffer */\r
+               } BitBuffer_t;\r
+               \r
+       /* Function Prototypes: */      \r
+               /** Initializes or resets a given bit buffer, ready to store new bits.\r
+                *  \r
+                *  \param Buffer  Bit buffer to initialize\r
+                */\r
+               void BitBuffer_Init(BitBuffer_t* Buffer) ATTR_NON_NULL_PTR_ARG(1);\r
+               \r
+               /** Stores a bit into the next location inside a given bit buffer.\r
+                *\r
+                *  \param Buffer  Bit buffer to store a bit into\r
+                *  \param Bit  Bit to store into the buffer\r
+                */\r
+               void BitBuffer_StoreNextBit(BitBuffer_t* Buffer, bool Bit) ATTR_NON_NULL_PTR_ARG(1);\r
+               \r
+               /** Retrieves a bit from the next location inside a given bit buffer.\r
+                *\r
+                *  \param Buffer  Bit buffer to store a bit into\r
+                *\r
+                *  \return Next bit from the buffer\r
+                */\r
+               bool BitBuffer_GetNextBit(BitBuffer_t* Buffer) ATTR_NON_NULL_PTR_ARG(1);\r
+               \r
+#endif\r