X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/071e02c6b6b4837fa9cf0b6d4c749994e02638d7..77a9df36a77d2523dd2bc24fa17f9f04c6c175c5:/Projects/Magstripe/Lib/CircularBitBuffer.h diff --git a/Projects/Magstripe/Lib/CircularBitBuffer.h b/Projects/Magstripe/Lib/CircularBitBuffer.h index dff4d2e5d..ddd8cc1a6 100644 --- a/Projects/Magstripe/Lib/CircularBitBuffer.h +++ b/Projects/Magstripe/Lib/CircularBitBuffer.h @@ -1,22 +1,22 @@ /* LUFA Library - Copyright (C) Dean Camera, 2010. - + Copyright (C) Dean Camera, 2011. + dean [at] fourwalledcubicle [dot] com - www.fourwalledcubicle.com + www.lufa-lib.org */ /* Copyright 2010 Denver Gingerich (denver [at] ossguy [dot] com) - Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com) - Permission to use, copy, modify, distribute, and sell this + 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 + 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 + 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 @@ -40,7 +40,7 @@ /* Includes: */ #include #include - + #include /* Macros: */ @@ -51,7 +51,7 @@ #else #define MAX_BITS 1024 #endif - + /* Type Defines: */ /** Type define for a pointer to a bit in a bit buffer. */ typedef struct @@ -65,31 +65,33 @@ { uint8_t Data[MAX_BITS / 8]; /**< Buffer to hold the stored bits in packed form */ uint16_t Elements; /**< Number of stored bits in the bit buffer */ - + BitBufferPointer_t In; /**< Bit pointer to the next storage location in the buffer */ BitBufferPointer_t Out; /**< Bit pointer to the next retrieval location in the buffer */ } BitBuffer_t; - - /* Function Prototypes: */ - /** Initializes or resets a given bit buffer, ready to store new bits. - * + + /* Function Prototypes: */ + /** Initialises or resets a given bit buffer, ready to store new bits. + * * \param[in,out] Buffer Bit buffer to initialize */ void BitBuffer_Init(BitBuffer_t* const Buffer) ATTR_NON_NULL_PTR_ARG(1); - + /** Stores a bit into the next location inside a given bit buffer. * * \param[in,out] Buffer Bit buffer to store a bit into * \param[in] Bit Bit to store into the buffer */ - void BitBuffer_StoreNextBit(BitBuffer_t* const Buffer, const bool Bit) ATTR_NON_NULL_PTR_ARG(1); - + void BitBuffer_StoreNextBit(BitBuffer_t* const Buffer, + const bool Bit) ATTR_NON_NULL_PTR_ARG(1); + /** Retrieves a bit from the next location inside a given bit buffer. * - * \param[in,out] Buffer Bit buffer to store a bit into + * \param[in,out] Buffer Bit buffer to retrieve a bit from * * \return Next bit from the buffer */ bool BitBuffer_GetNextBit(BitBuffer_t* const Buffer) ATTR_NON_NULL_PTR_ARG(1); - + #endif +