Update UC3 platform driver support to use the bitmasks defined in the header files...
[pub/USBasp.git] / Projects / Magstripe / Lib / CircularBitBuffer.c
index 2142ead..b316963 100644 (file)
-/*\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, distribute, and sell this \r
-  software and its documentation for any purpose is hereby granted\r
-  without fee, provided that the above copyright notice appear in \r
-  all 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
-/** Circular bit buffer library. This will allow for individual bits\r
- *  to be stored in packed form inside circular buffers, to reduce\r
- *  overall RAM usage.\r
- */\r
-\r
-#include "CircularBitBuffer.h"\r
-\r
-/** Function to initialize or reset a bit buffer, ready for data to be stored into it. */\r
-void BitBuffer_Init(BitBuffer_t* const Buffer)\r
-{\r
-       /* Reset the number of stored bits in the buffer */\r
-       Buffer->Elements        = 0;\r
-       \r
-       /* Reset the data in and out pointer structures in the buffer to the first buffer bit */\r
-       Buffer->In.CurrentByte  = Buffer->Data;\r
-       Buffer->In.ByteMask     = (1 << 0);\r
-       Buffer->Out.CurrentByte = Buffer->Data;\r
-       Buffer->Out.ByteMask    = (1 << 0);\r
-}\r
-\r
-/** Function to store the given bit into the given bit buffer. */\r
-void BitBuffer_StoreNextBit(BitBuffer_t* const Buffer, const bool Bit)\r
-{\r
-       /* If the bit to store is true, set the next bit in the buffer */\r
-       if (Bit)\r
-         *Buffer->In.CurrentByte |= Buffer->In.ByteMask;\r
-       \r
-       /* Increment the number of stored bits in the buffer counter */\r
-       Buffer->Elements++;\r
-       \r
-       /* Check if the current buffer byte is full of stored bits */\r
-       if (Buffer->In.ByteMask == (1 << 7))\r
-       {\r
-               /* Check if the end of the buffer has been reached, if so reset to start of buffer, otherwise advance to next bit */\r
-               if (Buffer->In.CurrentByte != &Buffer->Data[sizeof(Buffer->Data) - 1])\r
-                 Buffer->In.CurrentByte++;\r
-               else\r
-                 Buffer->In.CurrentByte = Buffer->Data;\r
-                 \r
-               /* Reset the storage bit mask in the current buffer byte to the first bit */            \r
-               Buffer->In.ByteMask = (1 << 0);\r
-       }\r
-       else\r
-       {\r
-               /* Shift the current storage bit mask to the next bit in the current byte */\r
-               Buffer->In.ByteMask <<= 1;\r
-       }\r
-}\r
-\r
-/** Function to retrieve the next bit stored in the given bit buffer. */\r
-bool BitBuffer_GetNextBit(BitBuffer_t* const Buffer)\r
-{      \r
-       /* Retrieve the value of the next bit stored in the buffer */\r
-       bool Bit = ((*Buffer->Out.CurrentByte & Buffer->Out.ByteMask) != 0);\r
-\r
-       /* Clear the buffer bit */\r
-       *Buffer->Out.CurrentByte &= ~Buffer->Out.ByteMask;\r
-\r
-       /* Decrement the number of stored bits in the buffer counter */\r
-       Buffer->Elements--;\r
-       \r
-       /* Check if the current buffer byte is empty of stored bits */  \r
-       if (Buffer->Out.ByteMask == (1 << 7))\r
-       {\r
-               /* Check if the end of the buffer has been reached, if so reset to start of buffer, otherwise advance to next bit */\r
-               if (Buffer->Out.CurrentByte != &Buffer->Data[sizeof(Buffer->Data) - 1])\r
-                 Buffer->Out.CurrentByte++;\r
-               else\r
-                 Buffer->Out.CurrentByte = Buffer->Data;               \r
-               \r
-               /* Reset the retrieval bit mask in the current buffer byte to the first bit */          \r
-               Buffer->Out.ByteMask = (1 << 0);\r
-       }\r
-       else\r
-       {\r
-               /* Shift the current retrieval bit mask to the next bit in the current byte */\r
-               Buffer->Out.ByteMask <<= 1;\r
-       }\r
-\r
-       /* Return the retrieved bit from the buffer */\r
-       return Bit;\r
-}\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2011.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
+  Copyright 2011  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.
+*/
+
+/** Circular bit buffer library. This will allow for individual bits
+ *  to be stored in packed form inside circular buffers, to reduce
+ *  overall RAM usage.
+ */
+
+#include "CircularBitBuffer.h"
+
+/** Function to initialize or reset a bit buffer, ready for data to be stored into it. */
+void BitBuffer_Init(BitBuffer_t* const Buffer)
+{
+       /* Reset the number of stored bits in the buffer */
+       Buffer->Elements        = 0;
+
+       /* Reset the data in and out pointer structures in the buffer to the first buffer bit */
+       Buffer->In.CurrentByte  = Buffer->Data;
+       Buffer->In.ByteMask     = (1 << 0);
+       Buffer->Out.CurrentByte = Buffer->Data;
+       Buffer->Out.ByteMask    = (1 << 0);
+}
+
+/** Function to store the given bit into the given bit buffer. */
+void BitBuffer_StoreNextBit(BitBuffer_t* const Buffer,
+                            const bool Bit)
+{
+       /* If the bit to store is true, set the next bit in the buffer */
+       if (Bit)
+         *Buffer->In.CurrentByte |= Buffer->In.ByteMask;
+
+       /* Increment the number of stored bits in the buffer counter */
+       Buffer->Elements++;
+
+       /* Check if the current buffer byte is full of stored bits */
+       if (Buffer->In.ByteMask == (1 << 7))
+       {
+               /* Check if the end of the buffer has been reached, if so reset to start of buffer, otherwise advance to next bit */
+               if (Buffer->In.CurrentByte != &Buffer->Data[sizeof(Buffer->Data) - 1])
+                 Buffer->In.CurrentByte++;
+               else
+                 Buffer->In.CurrentByte = Buffer->Data;
+
+               /* Reset the storage bit mask in the current buffer byte to the first bit */
+               Buffer->In.ByteMask = (1 << 0);
+       }
+       else
+       {
+               /* Shift the current storage bit mask to the next bit in the current byte */
+               Buffer->In.ByteMask <<= 1;
+       }
+}
+
+/** Function to retrieve the next bit stored in the given bit buffer. */
+bool BitBuffer_GetNextBit(BitBuffer_t* const Buffer)
+{
+       /* Retrieve the value of the next bit stored in the buffer */
+       bool Bit = ((*Buffer->Out.CurrentByte & Buffer->Out.ByteMask) != 0);
+
+       /* Clear the buffer bit */
+       *Buffer->Out.CurrentByte &= ~Buffer->Out.ByteMask;
+
+       /* Decrement the number of stored bits in the buffer counter */
+       Buffer->Elements--;
+
+       /* Check if the current buffer byte is empty of stored bits */
+       if (Buffer->Out.ByteMask == (1 << 7))
+       {
+               /* Check if the end of the buffer has been reached, if so reset to start of buffer, otherwise advance to next bit */
+               if (Buffer->Out.CurrentByte != &Buffer->Data[sizeof(Buffer->Data) - 1])
+                 Buffer->Out.CurrentByte++;
+               else
+                 Buffer->Out.CurrentByte = Buffer->Data;
+
+               /* Reset the retrieval bit mask in the current buffer byte to the first bit */
+               Buffer->Out.ByteMask = (1 << 0);
+       }
+       else
+       {
+               /* Shift the current retrieval bit mask to the next bit in the current byte */
+               Buffer->Out.ByteMask <<= 1;
+       }
+
+       /* Return the retrieved bit from the buffer */
+       return Bit;
+}
+