Common.h 12.3 KB
 Dean Camera committed May 08, 2010 1 2 /* LUFA Library  Dean Camera committed Feb 04, 2012 3  Copyright (C) Dean Camera, 2012.  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 Feb 04, 2012 10  Copyright 2012 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  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. */  Dean Camera committed Apr 07, 2012 31 32 33 34 35 36 37 /** \dir * \brief Common library header files. * * This folder contains header files which are common to all parts of the LUFA library. They may be used freely in * user applications. */  Dean Camera committed May 08, 2010 38 /** \file  Dean Camera committed Feb 20, 2011 39  * \brief Common library convenience headers, macros and functions.  Dean Camera committed May 08, 2010 40  *  Dean Camera committed Feb 20, 2011 41  * \copydetails Group_Common  Dean Camera committed May 08, 2010 42  */  43   Dean Camera committed Feb 19, 2011 44 /** \defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h  Dean Camera committed Feb 20, 2011 45  * \brief Common library convenience headers, macros and functions.  Dean Camera committed May 08, 2010 46 47 48 49 50 51  * * Common utility headers containing macros, functions, enums and types which are common to all * aspects of the library. * * @{ */  Dean Camera committed Dec 23, 2011 52   53 54 55 56 57 /** \defgroup Group_GlobalInt Global Interrupt Macros * \brief Convenience macros for the management of interrupts globally within the device. * * Macros and functions to create and control global interrupts within the device. */  58   Dean Camera committed Feb 19, 2011 59 60 #ifndef __LUFA_COMMON_H__ #define __LUFA_COMMON_H__  Dean Camera committed May 08, 2010 61   Dean Camera committed Feb 19, 2011 62  /* Macros: */  Dean Camera committed Mar 15, 2011 63  #define __INCLUDE_FROM_COMMON_H  Dean Camera committed Dec 23, 2011 64   Dean Camera committed May 08, 2010 65  /* Includes: */  Dean Camera committed Jul 21, 2010 66 67  #include #include  Dean Camera committed Feb 20, 2011 68  #include  Dean Camera committed Feb 20, 2011 69  #include  Dean Camera committed Dec 23, 2011 70   71 72  #include "Architectures.h" #include "BoardTypes.h"  Dean Camera committed Aug 16, 2011 73  #include "ArchitectureSpecific.h"  Dean Camera committed Jul 06, 2011 74  #include "CompilerSpecific.h"  Dean Camera committed May 08, 2010 75  #include "Attributes.h"  Dean Camera committed Dec 23, 2011 76   Dean Camera committed May 29, 2012 77 78 79 80  #if defined(USE_LUFA_CONFIG_HEADER) #include "LUFAConfig.h" #endif  Dean Camera committed Jun 20, 2011 81 82 83 84 85  /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { #endif  Dean Camera committed Feb 19, 2011 86  /* Architecture specific utility includes: */  Dean Camera committed Feb 20, 2011 87  #if defined(__DOXYGEN__)  Dean Camera committed May 08, 2011 88 89 90 91  /** Type define for an unsigned integer the same width as the selected architecture's machine register. * This is distinct from the non-specific standard int data type, whose width is machine dependant but * which may not reflect the actual machine register width on some targets (e.g. AVR8). */  Dean Camera committed Feb 20, 2011 92 93  typedef MACHINE_REG_t uint_reg_t; #elif (ARCH == ARCH_AVR8)  Dean Camera committed Feb 19, 2011 94 95 96 97  #include #include #include #include  Dean Camera committed Feb 20, 2011 98  #include  Dean Camera committed Feb 18, 2012 99  #include  Dean Camera committed Feb 19, 2011 100  #include  Dean Camera committed Dec 23, 2011 101   Dean Camera committed Feb 20, 2011 102  typedef uint8_t uint_reg_t;  Dean Camera committed Dec 23, 2011 103   Dean Camera committed Mar 21, 2011 104 105 106 107 108  #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 109  #include "Endianness.h"  Dean Camera committed Mar 13, 2011 110  #elif (ARCH == ARCH_UC3)  Dean Camera committed Feb 20, 2011 111  #include  Dean Camera committed Jun 12, 2012 112  #include  Dean Camera committed Feb 20, 2011 113   Dean Camera committed Mar 13, 2011 114  // === TODO: Find abstracted way to handle these ===  Dean Camera committed Jun 12, 2012 115  #define PROGMEM  Dean Camera committed Feb 27, 2011 116 117 118  #define pgm_read_byte(x) *x #define memcmp_P(...) memcmp(__VA_ARGS__) #define memcpy_P(...) memcpy(__VA_ARGS__)  Dean Camera committed Apr 10, 2011 119  // =================================================  Dean Camera committed Mar 13, 2011 120 121  typedef uint32_t uint_reg_t;  Dean Camera committed Dec 23, 2011 122   Dean Camera committed Apr 08, 2011 123  #define ARCH_BIG_ENDIAN  Dean Camera committed Mar 21, 2011 124   Dean Camera committed Mar 13, 2011 125  #include "Endianness.h"  Dean Camera committed Jul 13, 2011 126 127 128 129 130  #elif (ARCH == ARCH_XMEGA) #include #include #include #include  Dean Camera committed Feb 18, 2012 131  #include  Dean Camera committed Jul 13, 2011 132  #include  Dean Camera committed Dec 23, 2011 133   Dean Camera committed Jul 13, 2011 134  typedef uint8_t uint_reg_t;  Dean Camera committed Dec 23, 2011 135   Dean Camera committed Jul 13, 2011 136 137 138 139 140  #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 Dec 23, 2011 141  #include "Endianness.h"  Dean Camera committed Mar 13, 2011 142 143  #else #error Unknown device architecture specified.  Dean Camera committed Feb 19, 2011 144  #endif  Dean Camera committed May 08, 2010 145 146  /* Public Interface - May be used in end-application: */  Dean Camera committed Jul 21, 2010 147  /* Macros: */  Dean Camera committed May 08, 2010 148 149 150  /** 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 151  * a block (such as inline \c if statements).  Dean Camera committed May 08, 2010 152 153 154 155 156 157  */ #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 158  * a block (such as inline \c if statements).  Dean Camera committed May 08, 2010 159 160  */ #define MACROE while (0)  161   Dean Camera committed Jan 26, 2011 162 163  /** Convenience macro to determine the larger of two values. *  Dean Camera committed Feb 24, 2012 164 165  * \attention This macro should only be used with operands that do not have side effects from being evaluated * multiple times.  Dean Camera committed Jan 26, 2011 166 167 168 169 170 171  * * \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 172  #if !defined(MAX) || defined(__DOXYGEN__)  Dean Camera committed Aug 23, 2011 173  #define MAX(x, y) (((x) > (y)) ? (x) : (y))  Dean Camera committed Feb 19, 2011 174  #endif  Dean Camera committed Jan 26, 2011 175 176 177  /** Convenience macro to determine the smaller of two values. *  Dean Camera committed Feb 24, 2012 178 179  * \attention This macro should only be used with operands that do not have side effects from being evaluated * multiple times.  Dean Camera committed Jan 26, 2011 180 181 182 183 184 185  * * \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 186  #if !defined(MIN) || defined(__DOXYGEN__)  Dean Camera committed Aug 23, 2011 187  #define MIN(x, y) (((x) < (y)) ? (x) : (y))  Dean Camera committed Feb 19, 2011 188  #endif  Dean Camera committed Dec 23, 2011 189   Dean Camera committed Jul 14, 2011 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208  #if !defined(STRINGIFY) || defined(__DOXYGEN__) /** Converts the given input into a string, via the C Preprocessor. This macro puts literal quotation * marks around the input, converting the source into a string literal. * * \param[in] x Input to convert into a string literal. * * \return String version of the input. */ #define STRINGIFY(x) #x /** Converts the given input into a string after macro expansion, via the C Preprocessor. This macro puts * literal quotation marks around the expanded input, converting the source into a string literal. * * \param[in] x Input to expand and convert into a string literal. * * \return String version of the expanded input. */ #define STRINGIFY_EXPANDED(x) STRINGIFY(x) #endif  Dean Camera committed May 08, 2010 209   Dean Camera committed Apr 08, 2011 210 211 212 213 214 215 216 217  #if !defined(ISR) || defined(__DOXYGEN__) /** Macro for the definition of interrupt service routines, so that the compiler can insert the required * prologue and epilogue code to properly manage the interrupt routine without affecting the main thread's * state with unintentional side-effects. * * Interrupt handlers written using this macro may still need to be registered with the microcontroller's * Interrupt Controller (if present) before they will properly handle incoming interrupt events. *  Dean Camera committed Apr 10, 2011 218 219  * \note This macro is only supplied on some architectures, where the standard library does not include a valid * definition. If an existing definition exists, the alternative definition here will be ignored.  Dean Camera committed Apr 08, 2011 220  *  221 222  * \ingroup Group_GlobalInt *  Dean Camera committed Apr 08, 2012 223  * \param[in] Name Unique name of the interrupt service routine.  Dean Camera committed Apr 08, 2011 224  */  Dean Camera committed Feb 03, 2012 225  #define ISR(Name, ...) void Name (void) __attribute__((__interrupt__)) __VA_ARGS__; void Name (void)  Dean Camera committed Apr 08, 2011 226 227  #endif  Dean Camera committed May 08, 2010 228 229 230 231  /* 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 232  * \param[in] Byte Byte of data whose bits are to be reversed.  Dean Camera committed Sep 22, 2011 233 234  * * \return Input data with the individual bits reversed (mirrored).  Dean Camera committed May 08, 2010 235 236 237 238 239 240 241 242 243 244  */ 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; }  245   246 247 248  /** 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 249 250  * * \param[in] Milliseconds Number of milliseconds to delay  251  */  Dean Camera committed Sep 02, 2011 252 253  static inline void Delay_MS(uint16_t Milliseconds) ATTR_ALWAYS_INLINE; static inline void Delay_MS(uint16_t Milliseconds)  254  {  Dean Camera committed Apr 08, 2011 255  #if (ARCH == ARCH_AVR8)  256  if (GCC_IS_COMPILE_CONST(Milliseconds))  Dean Camera committed Apr 08, 2011 257 258 259 260 261 262 263 264 265  { _delay_ms(Milliseconds); } else { while (Milliseconds--) _delay_ms(1); } #elif (ARCH == ARCH_UC3)  266 267 268  while (Milliseconds--) { __builtin_mtsr(AVR32_COUNT, 0);  Dean Camera committed Feb 18, 2012 269  while ((uint32_t)__builtin_mfsr(AVR32_COUNT) < (F_CPU / 1000));  270  }  Dean Camera committed Jul 13, 2011 271 272 273 274 275 276 277 278 279  #elif (ARCH == ARCH_XMEGA) if (GCC_IS_COMPILE_CONST(Milliseconds)) { _delay_ms(Milliseconds); } else { while (Milliseconds--) _delay_ms(1);  Dean Camera committed Dec 23, 2011 280  }  Dean Camera committed Apr 08, 2011 281  #endif  282 283  }  Dean Camera committed Apr 08, 2011 284 285 286 287  /** Retrieves a mask which contains the current state of the global interrupts for the device. This * value can be stored before altering the global interrupt enable state, before restoring the * flag(s) back to their previous values after a critical section using \ref SetGlobalInterruptMask(). *  288 289  * \ingroup Group_GlobalInt *  Dean Camera committed Apr 08, 2011 290 291 292 293 294 295 296 297 298 299  * \return Mask containing the current Global Interrupt Enable Mask bit(s). */ static inline uint_reg_t GetGlobalInterruptMask(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT; static inline uint_reg_t GetGlobalInterruptMask(void) { GCC_MEMORY_BARRIER(); #if (ARCH == ARCH_AVR8) return SREG; #elif (ARCH == ARCH_UC3)  Dean Camera committed Jul 13, 2011 300 301 302  return __builtin_mfsr(AVR32_SR); #elif (ARCH == ARCH_XMEGA) return SREG;  Dean Camera committed Apr 08, 2011 303 304 305 306 307 308 309  #endif } /** Sets the global interrupt enable state of the microcontroller to the mask passed into the function. * This can be combined with \ref GetGlobalInterruptMask() to save and restore the Global Interrupt Enable * Mask bit(s) of the device after a critical section has completed. *  310 311  * \ingroup Group_GlobalInt *  Dean Camera committed Apr 08, 2011 312 313 314 315 316 317 318 319 320 321 322 323 324 325  * \param[in] GlobalIntState Global Interrupt Enable Mask value to use */ static inline void SetGlobalInterruptMask(const uint_reg_t GlobalIntState) ATTR_ALWAYS_INLINE; static inline void SetGlobalInterruptMask(const uint_reg_t GlobalIntState) { GCC_MEMORY_BARRIER(); #if (ARCH == ARCH_AVR8) SREG = GlobalIntState; #elif (ARCH == ARCH_UC3) if (GlobalIntState & AVR32_SR_GM) __builtin_ssrf(AVR32_SR_GM_OFFSET); else __builtin_csrf(AVR32_SR_GM_OFFSET);  Dean Camera committed Jul 13, 2011 326  #elif (ARCH == ARCH_XMEGA)  Dean Camera committed Dec 23, 2011 327  SREG = GlobalIntState;  Dean Camera committed Apr 08, 2011 328  #endif  Dean Camera committed Dec 23, 2011 329   Dean Camera committed Apr 08, 2011 330 331  GCC_MEMORY_BARRIER(); }  Dean Camera committed Dec 23, 2011 332   333 334 335 336  /** Enables global interrupt handling for the device, allowing interrupts to be handled. * * \ingroup Group_GlobalInt */  Dean Camera committed Apr 08, 2011 337 338 339 340 341 342 343 344 345  static inline void GlobalInterruptEnable(void) ATTR_ALWAYS_INLINE; static inline void GlobalInterruptEnable(void) { GCC_MEMORY_BARRIER(); #if (ARCH == ARCH_AVR8) sei(); #elif (ARCH == ARCH_UC3) __builtin_csrf(AVR32_SR_GM_OFFSET);  Dean Camera committed Jul 13, 2011 346 347  #elif (ARCH == ARCH_XMEGA) sei();  Dean Camera committed Apr 08, 2011 348 349 350  #endif GCC_MEMORY_BARRIER();  Dean Camera committed Dec 23, 2011 351  }  Dean Camera committed Apr 08, 2011 352   353 354 355 356  /** Disabled global interrupt handling for the device, preventing interrupts from being handled. * * \ingroup Group_GlobalInt */  Dean Camera committed Apr 08, 2011 357 358 359 360 361 362 363 364 365  static inline void GlobalInterruptDisable(void) ATTR_ALWAYS_INLINE; static inline void GlobalInterruptDisable(void) { GCC_MEMORY_BARRIER(); #if (ARCH == ARCH_AVR8) cli(); #elif (ARCH == ARCH_UC3) __builtin_ssrf(AVR32_SR_GM_OFFSET);  Dean Camera committed Jul 13, 2011 366 367  #elif (ARCH == ARCH_XMEGA) cli();  Dean Camera committed Apr 08, 2011 368 369 370 371 372  #endif GCC_MEMORY_BARRIER(); }  Dean Camera committed Jun 20, 2011 373 374 375 376 377  /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif  Dean Camera committed May 08, 2010 378 379 380 #endif /** @} */  381