Common.h 9.15 KB
 Dean Camera committed May 08, 2010 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 /* 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 * \brief Common library convenience macros and functions. * * This file contains macros which are common to all library elements, and which may be useful in user code. It * also includes other common headers, such as Atomic.h, Attributes.h and BoardTypes.h. */ /** @defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h * * Common utility headers containing macros, functions, enums and types which are common to all * aspects of the library. * * @{ */ /** @defgroup Group_Debugging Debugging Macros * * Macros for debugging use. */ /** @defgroup Group_BitManip Endian and Bit Macros * * Functions for swapping endianness and reversing bit orders. */ #ifndef __COMMON_H__ #define __COMMON_H__ /* Includes: */  Dean Camera committed Jul 21, 2010 60 61  #include #include  Dean Camera committed May 08, 2010 62 63 64 65 66  #include "Attributes.h" #include "BoardTypes.h" /* Public Interface - May be used in end-application: */  Dean Camera committed Jul 21, 2010 67  /* Macros: */  Dean Camera committed May 08, 2010 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82  /** Macro for encasing other multi-statement macros. This should be used along with an opening brace * before the start of any multi-statement macro, so that the macros contents as a whole are treated * as a discrete block and not as a list of separate statements which may cause problems when used as * a block (such as inline IF statements). */ #define MACROS do /** Macro for encasing other multi-statement macros. This should be used along with a preceding closing * brace at the end of any multi-statement macro, so that the macros contents as a whole are treated * as a discrete block and not as a list of separate statements which may cause problems when used as * a block (such as inline IF statements). */ #define MACROE while (0) /** Defines a volatile NOP statement which cannot be optimized out by the compiler, and thus can always  Dean Camera committed Jul 30, 2010 83  * be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimiser  Dean Camera committed May 08, 2010 84 85 86 87  * removes/reorders code to the point where break points cannot reliably be set. * * \ingroup Group_Debugging */  88  #define JTAG_DEBUG_POINT() __asm__ volatile ("NOP" ::)  Dean Camera committed May 08, 2010 89 90 91 92 93 94  /** Defines an explicit JTAG break point in the resulting binary via the ASM BREAK statement. When * a JTAG is used, this causes the program execution to halt when reached until manually resumed. * * \ingroup Group_Debugging */  95  #define JTAG_DEBUG_BREAK() __asm__ volatile ("BREAK" ::)  Dean Camera committed May 08, 2010 96 97 98 99 100 101 102  /** Macro for testing condition "x" and breaking via JTAG_DEBUG_BREAK() if the condition is false. * * \ingroup Group_Debugging */ #define JTAG_DEBUG_ASSERT(x) MACROS{ if (!(x)) { JTAG_DEBUG_BREAK(); } }MACROE  Dean Camera committed Jun 17, 2010 103 104 105  /** Macro for testing condition "x" and writing debug data to the stdout stream if false. The stdout stream * must be pre-initialized before this macro is run and linked to an output device, such as the AVR's USART * peripheral.  Dean Camera committed May 08, 2010 106  *  Dean Camera committed Jun 17, 2010 107  * The output takes the form "{FILENAME}: Function {FUNCTION NAME}, Line {LINE NUMBER}: Assertion {x} failed."  Dean Camera committed May 08, 2010 108 109 110  * * \ingroup Group_Debugging */  111  #define STDOUT_ASSERT(x) MACROS{ if (!(x)) { printf_P(PSTR("%s: Function \"%s\", Line %d: " \  Dean Camera committed Jun 17, 2010 112  "Assertion \"%s\" failed.\r\n"), \  113 114 115 116  __FILE__, __func__, __LINE__, #x); } }MACROE #if !defined(pgm_read_ptr) || defined(__DOXYGEN__) /** Reads a pointer out of PROGMEM space. This is currently a wrapper for the avr-libc pgm_read_ptr()  Dean Camera committed Jul 29, 2010 117  * macro with a void* cast, so that its value can be assigned directly to a pointer variable or used  118 119 120 121 122 123 124 125 126 127 128 129  * in pointer arithmetic without further casting in C. In a future avr-libc distribution this will be * part of the standard API and will be implemented in a more formal manner. * * \param[in] Addr Address of the pointer to read. * * \return Pointer retrieved from PROGMEM space. */ #define pgm_read_ptr(Addr) (void*)pgm_read_word(Addr) #endif /** Swaps the byte ordering of a 16-bit value at compile time. Do not use this macro for swapping byte orderings * of dynamic values computed at runtime, use \ref SwapEndian_16() instead. The result of this macro can be used  Dean Camera committed Jul 30, 2010 130  * inside struct or other variable initializers outside of a function, something that is not possible with the  131 132 133 134 135 136 137 138 139 140  * inline function variant. * * \param[in] x 16-bit value whose byte ordering is to be swapped. * * \return Input value with the byte ordering reversed. */ #define SWAPENDIAN_16(x) ((((x) & 0xFF00) >> 8) | (((x) & 0x00FF) << 8)) /** Swaps the byte ordering of a 32-bit value at compile time. Do not use this macro for swapping byte orderings * of dynamic values computed at runtime- use \ref SwapEndian_32() instead. The result of this macro can be used  Dean Camera committed Jul 30, 2010 141  * inside struct or other variable initializers outside of a function, something that is not possible with the  142 143 144 145 146 147 148 149  * inline function variant. * * \param[in] x 32-bit value whose byte ordering is to be swapped. * * \return Input value with the byte ordering reversed. */ #define SWAPENDIAN_32(x) ((((x) & 0xFF000000UL) >> 24UL) | (((x) & 0x00FF0000UL) >> 8UL) | \ (((x) & 0x0000FF00UL) << 8UL) | (((x) & 0x000000FFUL) << 24UL))  Dean Camera committed Jun 02, 2010 150   Dean Camera committed May 08, 2010 151 152 153 154 155 156  /* Inline Functions: */ /** Function to reverse the individual bits in a byte - i.e. bit 7 is moved to bit 0, bit 6 to bit 1, * etc. * * \ingroup Group_BitManip *  Dean Camera committed Jun 17, 2010 157  * \param[in] Byte Byte of data whose bits are to be reversed.  Dean Camera committed May 08, 2010 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172  */ static inline uint8_t BitReverse(uint8_t Byte) ATTR_WARN_UNUSED_RESULT ATTR_CONST; static inline uint8_t BitReverse(uint8_t Byte) { Byte = (((Byte & 0xF0) >> 4) | ((Byte & 0x0F) << 4)); Byte = (((Byte & 0xCC) >> 2) | ((Byte & 0x33) << 2)); Byte = (((Byte & 0xAA) >> 1) | ((Byte & 0x55) << 1)); return Byte; } /** Function to reverse the byte ordering of the individual bytes in a 16 bit number. * * \ingroup Group_BitManip *  Dean Camera committed Jun 17, 2010 173  * \param[in] Word Word of data whose bytes are to be swapped.  Dean Camera committed May 08, 2010 174  */  Dean Camera committed Jul 21, 2010 175 176  static inline uint16_t SwapEndian_16(const uint16_t Word) ATTR_WARN_UNUSED_RESULT ATTR_CONST; static inline uint16_t SwapEndian_16(const uint16_t Word)  Dean Camera committed May 08, 2010 177  {  Dean Camera committed Jul 09, 2010 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192  uint8_t Temp; union { uint16_t Word; uint8_t Bytes[2]; } Data; Data.Word = Word; Temp = Data.Bytes[0]; Data.Bytes[0] = Data.Bytes[1]; Data.Bytes[1] = Temp; return Data.Word;  Dean Camera committed May 08, 2010 193 194 195 196 197 198  } /** Function to reverse the byte ordering of the individual bytes in a 32 bit number. * * \ingroup Group_BitManip *  Dean Camera committed Jun 17, 2010 199  * \param[in] DWord Double word of data whose bytes are to be swapped.  Dean Camera committed May 08, 2010 200  */  Dean Camera committed Jul 21, 2010 201 202  static inline uint32_t SwapEndian_32(const uint32_t DWord) ATTR_WARN_UNUSED_RESULT ATTR_CONST; static inline uint32_t SwapEndian_32(const uint32_t DWord)  Dean Camera committed May 08, 2010 203  {  Dean Camera committed Jul 09, 2010 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222  uint8_t Temp; union { uint32_t DWord; uint8_t Bytes[4]; } Data; Data.DWord = DWord; Temp = Data.Bytes[0]; Data.Bytes[0] = Data.Bytes[3]; Data.Bytes[3] = Temp; Temp = Data.Bytes[1]; Data.Bytes[1] = Data.Bytes[2]; Data.Bytes[2] = Temp; return Data.DWord;  Dean Camera committed May 08, 2010 223 224 225 226 227 228  } /** Function to reverse the byte ordering of the individual bytes in a n byte number. * * \ingroup Group_BitManip *  Dean Camera committed Jun 17, 2010 229 230  * \param[in,out] Data Pointer to a number containing an even number of bytes to be reversed. * \param[in] Bytes Length of the data in bytes.  Dean Camera committed May 08, 2010 231  */  Dean Camera committed Jul 21, 2010 232 233 234 235  static inline void SwapEndian_n(void* Data, uint8_t Bytes) ATTR_NON_NULL_PTR_ARG(1); static inline void SwapEndian_n(void* Data, uint8_t Bytes)  Dean Camera committed May 08, 2010 236  {  Dean Camera committed May 25, 2010 237  uint8_t* CurrDataPos = (uint8_t*)Data;  Dean Camera committed May 08, 2010 238   239  while (Bytes > 1)  Dean Camera committed May 08, 2010 240 241 242 243 244 245 246 247 248 249 250 251 252  { uint8_t Temp = *CurrDataPos; *CurrDataPos = *(CurrDataPos + Bytes - 1); *(CurrDataPos + Bytes - 1) = Temp; CurrDataPos++; Bytes -= 2; } } #endif /** @} */