Common.h 9.97 KB
 Dean Camera committed May 08, 2010 1 2 /* LUFA Library  Dean Camera committed Jan 01, 2011 3  Copyright (C) Dean Camera, 2011.  4   Dean Camera committed May 08, 2010 5  dean [at] fourwalledcubicle [dot] com  Dean Camera committed Oct 28, 2010 6  www.lufa-lib.org  Dean Camera committed May 08, 2010 7 8 9 */ /*  Dean Camera committed Jan 01, 2011 10  Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com)  Dean Camera committed May 08, 2010 11   12  Permission to use, copy, modify, distribute, and sell this  Dean Camera committed May 08, 2010 13  software and its documentation for any purpose is hereby granted  14  without fee, provided that the above copyright notice appear in  Dean Camera committed May 08, 2010 15  all copies and that both that the copyright notice and this  16 17 18  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  Dean Camera committed May 08, 2010 19 20 21 22 23 24 25 26 27 28 29 30 31  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  Dean Camera committed Feb 20, 2011 32  * \brief Common library convenience headers, macros and functions.  Dean Camera committed May 08, 2010 33  *  Dean Camera committed Feb 20, 2011 34  * \copydetails Group_Common  Dean Camera committed May 08, 2010 35  */  36   Dean Camera committed Feb 19, 2011 37 /** \defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h  Dean Camera committed Feb 20, 2011 38  * \brief Common library convenience headers, macros and functions.  Dean Camera committed May 08, 2010 39 40 41 42 43 44 45  * * Common utility headers containing macros, functions, enums and types which are common to all * aspects of the library. * * @{ */  Dean Camera committed Feb 19, 2011 46 /** \defgroup Group_Debugging Debugging Macros  Dean Camera committed Feb 20, 2011 47  * \brief Convenience macros to aid in debugging applications.  Dean Camera committed May 08, 2010 48  *  Dean Camera committed Feb 20, 2011 49  * Macros to aid debugging of a user application.  Dean Camera committed May 08, 2010 50  */  51   Dean Camera committed Feb 19, 2011 52 53 #ifndef __LUFA_COMMON_H__ #define __LUFA_COMMON_H__  Dean Camera committed May 08, 2010 54   Dean Camera committed Feb 19, 2011 55  /* Macros: */  Dean Camera committed Mar 15, 2011 56  #define __INCLUDE_FROM_COMMON_H  Dean Camera committed Feb 19, 2011 57   Dean Camera committed May 08, 2010 58  /* Includes: */  Dean Camera committed Jul 21, 2010 59 60  #include #include  Dean Camera committed Feb 20, 2011 61  #include  Dean Camera committed Feb 20, 2011 62  #include  Dean Camera committed Feb 20, 2011 63   Dean Camera committed Feb 19, 2011 64  #include "Architectures.h"  Dean Camera committed May 08, 2010 65 66  #include "Attributes.h" #include "BoardTypes.h"  Dean Camera committed Feb 19, 2011 67 68  /* Architecture specific utility includes: */  Dean Camera committed Feb 20, 2011 69 70 71 72  #if defined(__DOXYGEN__) /** Type define for an unsigned integer the same width as the selected architecture's machine register. */ typedef MACHINE_REG_t uint_reg_t; #elif (ARCH == ARCH_AVR8)  Dean Camera committed Feb 19, 2011 73 74 75 76  #include #include #include #include  Dean Camera committed Feb 20, 2011 77  #include  Dean Camera committed Feb 19, 2011 78  #include  Dean Camera committed Feb 20, 2011 79   Dean Camera committed Feb 20, 2011 80  typedef uint8_t uint_reg_t;  Dean Camera committed Mar 13, 2011 81   Dean Camera committed Mar 21, 2011 82 83 84 85 86  #define ARCH_HAS_EEPROM_ADDRESS_SPACE #define ARCH_HAS_FLASH_ADDRESS_SPACE #define ARCH_HAS_MULTI_ADDRESS_SPACE #define ARCH_LITTLE_ENDIAN  Dean Camera committed Mar 13, 2011 87  #include "Endianness.h"  Dean Camera committed Mar 13, 2011 88  #elif (ARCH == ARCH_UC3)  Dean Camera committed Feb 20, 2011 89 90  #include  Dean Camera committed Mar 13, 2011 91  // === TODO: Find abstracted way to handle these ===  Dean Camera committed Feb 27, 2011 92 93 94 95  #define PROGMEM const #define pgm_read_byte(x) *x #define memcmp_P(...) memcmp(__VA_ARGS__) #define memcpy_P(...) memcpy(__VA_ARGS__)  Dean Camera committed Mar 13, 2011 96 97 98 99 100  // ================================================== typedef uint32_t uint_reg_t; #define ARCH_BIG_ENDIAN  Dean Camera committed Mar 21, 2011 101   Dean Camera committed Mar 13, 2011 102 103 104  #include "Endianness.h" #else #error Unknown device architecture specified.  Dean Camera committed Feb 19, 2011 105  #endif  Dean Camera committed May 08, 2010 106 107  /* Public Interface - May be used in end-application: */  Dean Camera committed Jul 21, 2010 108  /* Macros: */  Dean Camera committed May 08, 2010 109 110 111  /** 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  Dean Camera committed Jan 08, 2011 112  * a block (such as inline \c if statements).  Dean Camera committed May 08, 2010 113 114 115 116 117 118  */ #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  Dean Camera committed Jan 08, 2011 119  * a block (such as inline \c if statements).  Dean Camera committed May 08, 2010 120 121  */ #define MACROE while (0)  122   Dean Camera committed Jan 26, 2011 123 124 125 126 127 128 129 130 131 132  /** Convenience macro to determine the larger of two values. * * \note This macro should only be used with operands that do not have side effects from being evaluated * multiple times. * * \param[in] x First value to compare * \param[in] y First value to compare * * \return The larger of the two input parameters */  Dean Camera committed Feb 19, 2011 133 134 135  #if !defined(MAX) || defined(__DOXYGEN__) #define MAX(x, y) ((x > y) ? x : y) #endif  Dean Camera committed Jan 26, 2011 136 137 138 139 140 141 142 143 144 145 146  /** Convenience macro to determine the smaller of two values. * * \note This macro should only be used with operands that do not have side effects from being evaluated * multiple times. * * \param[in] x First value to compare * \param[in] y First value to compare * * \return The smaller of the two input parameters */  Dean Camera committed Feb 19, 2011 147 148 149  #if !defined(MIN) || defined(__DOXYGEN__) #define MIN(x, y) ((x < y) ? x : y) #endif  Dean Camera committed May 08, 2010 150   Dean Camera committed Feb 20, 2011 151  #if (ARCH == ARCH_AVR8) || defined(__DOXYGEN__)  Dean Camera committed Feb 19, 2011 152 153 154 155 156 157 158  /** Defines a volatile \c NOP statement which cannot be optimized out by the compiler, and thus can always * be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimiser * removes/reorders code to the point where break points cannot reliably be set. * * \ingroup Group_Debugging */ #define JTAG_DEBUG_POINT() __asm__ __volatile__ ("NOP" ::)  159   Dean Camera committed Feb 19, 2011 160 161 162 163 164 165 166 167  /** Defines an explicit JTAG break point in the resulting binary via the assembly \c BREAK statement. When * a JTAG is used, this causes the program execution to halt when reached until manually resumed. * * \ingroup Group_Debugging */ #define JTAG_DEBUG_BREAK() __asm__ __volatile__ ("BREAK" ::) #if !defined(pgm_read_ptr) || defined(__DOXYGEN__)  Dean Camera committed Feb 20, 2011 168 169 170 171 172  /** Reads a pointer out of PROGMEM space on the AVR8 architecture. This is currently a wrapper for the * avr-libc \c pgm_read_ptr() macro with a \c void* cast, so that its value can be assigned directly * to a pointer variable or used 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.  Dean Camera committed Feb 19, 2011 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187  * * \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 /** Macro for testing condition "x" and breaking via \ref JTAG_DEBUG_BREAK() if the condition is false. * * \param[in] Condition Condition that will be evaluated, * * \ingroup Group_Debugging */ #define JTAG_DEBUG_ASSERT(Condition) MACROS{ if (!(Condition)) { JTAG_DEBUG_BREAK(); } }MACROE  Dean Camera committed May 08, 2010 188   Dean Camera committed Feb 19, 2011 189  /** Macro for testing condition "x" and writing debug data to the stdout stream if \c false. The stdout stream  Dean Camera committed Feb 20, 2011 190 191  * must be pre-initialized before this macro is run and linked to an output device, such as the microcontroller's * USART peripheral.  Dean Camera committed Feb 19, 2011 192 193 194 195 196 197 198 199 200 201 202  * * The output takes the form "{FILENAME}: Function {FUNCTION NAME}, Line {LINE NUMBER}: Assertion {Condition} failed." * * \param[in] Condition Condition that will be evaluated, * * \ingroup Group_Debugging */ #define STDOUT_ASSERT(Condition) MACROS{ if (!(x)) { printf_P(PSTR("%s: Function \"%s\", Line %d: " \ "Assertion \"%s\" failed.\r\n"), \ __FILE__, __func__, __LINE__, #Condition); } }MACROE #endif  Dean Camera committed Dec 26, 2010 203   Dean Camera committed Feb 20, 2011 204  /** Forces GCC to use pointer indirection (via the device's pointer register pairs) when accessing the given  Dean Camera committed Dec 26, 2010 205  * struct pointer. In some cases GCC will emit non-optimal assembly code when accessing a structure through  Dean Camera committed Jan 08, 2011 206  * a pointer, resulting in a larger binary. When this macro is used on a (non \c const) structure pointer before  Dean Camera committed Dec 26, 2010 207 208 209 210 211 212  * use, it will force GCC to use pointer indirection on the elements rather than direct store and load * instructions. * * \param[in, out] StructPtr Pointer to a structure which is to be forced into indirect access mode. */ #define GCC_FORCE_POINTER_ACCESS(StructPtr) __asm__ __volatile__("" : "=b" (StructPtr) : "0" (StructPtr))  213   214 215 216 217 218 219  /** Forces GCC to create a memory barrier, ensuring that memory accesses are not reordered past the barrier point. * This can be used before ordering-critical operations, to ensure that the compiler does not re-order the resulting * assembly output in an unexpected manner on sections of code that are ordering-specific. */ #define GCC_MEMORY_BARRIER() __asm__ __volatile__("" ::: "memory");  Dean Camera committed May 08, 2010 220 221 222 223  /* 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. *  Dean Camera committed Jun 17, 2010 224  * \param[in] Byte Byte of data whose bits are to be reversed.  Dean Camera committed May 08, 2010 225 226 227 228 229 230 231 232 233 234  */ 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; }  235   236 237 238  /** Function to perform a blocking delay for a specified number of milliseconds. The actual delay will be * at a minimum the specified number of milliseconds, however due to loop overhead and internal calculations * may be slightly higher.  Dean Camera committed Apr 08, 2011 239 240  * * \param[in] Milliseconds Number of milliseconds to delay  241 242 243  */ static inline void Delay_MS(uint8_t Milliseconds) {  Dean Camera committed Apr 08, 2011 244 245 246 247 248 249 250 251 252 253 254  #if (ARCH == ARCH_AVR8) if (__builtin_constant_p(Milliseconds)) { _delay_ms(Milliseconds); } else { while (Milliseconds--) _delay_ms(1); } #elif (ARCH == ARCH_UC3)  255 256 257 258 259  while (Milliseconds--) { __builtin_mtsr(AVR32_COUNT, 0); while (__builtin_mfsr(AVR32_COUNT) < (F_CPU / 1000)); }  Dean Camera committed Apr 08, 2011 260  #endif  261 262  }  Dean Camera committed May 08, 2010 263 264 265 #endif /** @} */  266