LUFA/Common/Common.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *  \brief Common library convenience headers, macros and functions.
  33  *
  34  *  \copydetails Group_Common
  35  */
  36
  37 /** \defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h
  38  *  \brief Common library convenience headers, macros and functions.
  39  *
  40  *  Common utility headers containing macros, functions, enums and types which are common to all
  41  *  aspects of the library.
  42  *
  43  *  @{
  44  */
  45
  46 /** \defgroup Group_Debugging Debugging Macros
  47  *  \brief Convenience macros to aid in debugging applications.
  48  *
  49  *  Macros to aid debugging of a user application.
  50  */
  51
  52 /** \defgroup Group_GlobalInt Global Interrupt Macros
  53  *  \brief Convenience macros for the management of interrupts globally within the device.
  54  *
  55  *  Macros and functions to create and control global interrupts within the device.
  56  */
  57
  58 #ifndef __LUFA_COMMON_H__
  59 #define __LUFA_COMMON_H__
  60
  61         /* Macros: */
  62                 #define __INCLUDE_FROM_COMMON_H
  63
  64         /* Includes: */
  65                 #include <stdint.h>
  66                 #include <stdbool.h>
  67                 #include <string.h>
  68                 #include <stddef.h>
  69
  70                 #include "Architectures.h"
  71                 #include "Attributes.h"
  72                 #include "BoardTypes.h"
  73
  74         /* Architecture specific utility includes: */
  75                 #if defined(__DOXYGEN__)
  76                         /** Type define for an unsigned integer the same width as the selected architecture's machine register. */
  77                         typedef MACHINE_REG_t uint_reg_t;
  78                 #elif (ARCH == ARCH_AVR8)
  79                         #include <avr/io.h>
  80                         #include <avr/interrupt.h>
  81                         #include <avr/pgmspace.h>
  82                         #include <avr/eeprom.h>
  83                         #include <avr/boot.h>
  84                         #include <util/delay.h>
  85
  86                         typedef uint8_t uint_reg_t;
  87
  88                         #define ARCH_HAS_EEPROM_ADDRESS_SPACE
  89                         #define ARCH_HAS_FLASH_ADDRESS_SPACE
  90                         #define ARCH_HAS_MULTI_ADDRESS_SPACE
  91                         #define ARCH_LITTLE_ENDIAN
  92
  93                         #include "Endianness.h"
  94                 #elif (ARCH == ARCH_UC3)
  95                         #include <avr32/io.h>
  96
  97                         // === TODO: Find abstracted way to handle these ===
  98                         #define PROGMEM                  const
  99                         #define pgm_read_byte(x)         *x
 100                         #define memcmp_P(...)            memcmp(__VA_ARGS__)
 101                         #define memcpy_P(...)            memcpy(__VA_ARGS__)
 102                         // =================================================
 103
 104                         typedef uint32_t uint_reg_t;
 105
 106                         #define ARCH_BIG_ENDIAN
 107
 108                         #include "Endianness.h"
 109                 #else
 110                         #error Unknown device architecture specified.
 111                 #endif
 112
 113         /* Public Interface - May be used in end-application: */
 114                 /* Macros: */
 115                         /** Macro for encasing other multi-statement macros. This should be used along with an opening brace
 116                          *  before the start of any multi-statement macro, so that the macros contents as a whole are treated
 117                          *  as a discrete block and not as a list of separate statements which may cause problems when used as
 118                          *  a block (such as inline \c if statements).
 119                          */
 120                         #define MACROS                  do
 121
 122                         /** Macro for encasing other multi-statement macros. This should be used along with a preceding closing
 123                          *  brace at the end of any multi-statement macro, so that the macros contents as a whole are treated
 124                          *  as a discrete block and not as a list of separate statements which may cause problems when used as
 125                          *  a block (such as inline \c if statements).
 126                          */
 127                         #define MACROE                  while (0)
 128
 129                         /** Convenience macro to determine the larger of two values.
 130                          *
 131                          *  \note This macro should only be used with operands that do not have side effects from being evaluated
 132                          *        multiple times.
 133                          *
 134                          *  \param[in] x  First value to compare
 135                          *  \param[in] y  First value to compare
 136                          *
 137                          *  \return The larger of the two input parameters
 138                          */
 139                         #if !defined(MAX) || defined(__DOXYGEN__)
 140                                 #define MAX(x, y)               ((x > y) ? x : y)
 141                         #endif
 142
 143                         /** Convenience macro to determine the smaller of two values.
 144                          *
 145                          *  \note This macro should only be used with operands that do not have side effects from being evaluated
 146                          *        multiple times.
 147                          *
 148                          *  \param[in] x  First value to compare
 149                          *  \param[in] y  First value to compare
 150                          *
 151                          *  \return The smaller of the two input parameters
 152                          */
 153                         #if !defined(MIN) || defined(__DOXYGEN__)
 154                                 #define MIN(x, y)               ((x < y) ? x : y)
 155                         #endif
 156
 157                         #if (ARCH == ARCH_AVR8) || defined(__DOXYGEN__)
 158                                 /** Defines a volatile \c NOP statement which cannot be optimized out by the compiler, and thus can always
 159                                  *  be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimiser
 160                                  *  removes/reorders code to the point where break points cannot reliably be set.
 161                                  *
 162                                  *  \note This macro is not available for all architectures.
 163                                  *
 164                                  *  \ingroup Group_Debugging
 165                                  */
 166                                 #define JTAG_DEBUG_POINT()      __asm__ __volatile__ ("NOP" ::)
 167
 168                                 /** Defines an explicit JTAG break point in the resulting binary via the assembly \c BREAK statement. When
 169                                  *  a JTAG is used, this causes the program execution to halt when reached until manually resumed.
 170                                  *
 171                                  *  \note This macro is not available for all architectures.
 172                                  *
 173                                  *  \ingroup Group_Debugging
 174                                  */
 175                                 #define JTAG_DEBUG_BREAK()      __asm__ __volatile__ ("BREAK" ::)
 176
 177                                 /** Macro for testing condition "x" and breaking via \ref JTAG_DEBUG_BREAK() if the condition is false.
 178                                  *
 179                                  *  \note This macro is not available for all architectures.
 180                                  *
 181                                  *  \param[in] Condition  Condition that will be evaluated.
 182                                  *
 183                                  *  \ingroup Group_Debugging
 184                                 */
 185                                 #define JTAG_DEBUG_ASSERT(Condition)    MACROS{ if (!(Condition)) { JTAG_DEBUG_BREAK(); } }MACROE
 186
 187                                 /** Macro for testing condition "x" and writing debug data to the stdout stream if \c false. The stdout stream
 188                                  *  must be pre-initialized before this macro is run and linked to an output device, such as the microcontroller's
 189                                  *  USART peripheral.
 190                                  *
 191                                  *  The output takes the form "{FILENAME}: Function {FUNCTION NAME}, Line {LINE NUMBER}: Assertion {Condition} failed."
 192                                  *
 193                                  *  \note This macro is not available for all architectures.
 194                                  *
 195                                  *  \param[in] Condition  Condition that will be evaluated,
 196                                  *
 197                                  *  \ingroup Group_Debugging
 198                                  */
 199                                 #define STDOUT_ASSERT(Condition)        MACROS{ if (!(x)) { printf_P(PSTR("%s: Function \"%s\", Line %d: "   \
 200                                                                                 "Assertion \"%s\" failed.\r\n"),     \
 201                                                                                 __FILE__, __func__, __LINE__, #Condition); } }MACROE
 202
 203                                 #if !defined(pgm_read_ptr) || defined(__DOXYGEN__)
 204                                         /** Reads a pointer out of PROGMEM space on the AVR8 architecture. This is currently a wrapper for the
 205                                          *  avr-libc \c pgm_read_ptr() macro with a \c void* cast, so that its value can be assigned directly
 206                                          *  to a pointer variable or used in pointer arithmetic without further casting in C. In a future
 207                                          *  avr-libc distribution this will be part of the standard API and will be implemented in a more formal
 208                                          *  manner.
 209                                          *
 210                                          *  \note This macro is not available for all architectures.
 211                                          *
 212                                          *  \param[in] Address  Address of the pointer to read.
 213                                          *
 214                                          *  \return Pointer retrieved from PROGMEM space.
 215                                          */
 216                                         #define pgm_read_ptr(Address)        (void*)pgm_read_word(Address)
 217                                 #endif
 218                         #endif
 219
 220                         /** Forces GCC to use pointer indirection (via the device's pointer register pairs) when accessing the given
 221                          *  struct pointer. In some cases GCC will emit non-optimal assembly code when accessing a structure through
 222                          *  a pointer, resulting in a larger binary. When this macro is used on a (non \c const) structure pointer before
 223                          *  use, it will force GCC to use pointer indirection on the elements rather than direct store and load
 224                          *  instructions.
 225                          *
 226                          *  \param[in, out] StructPtr  Pointer to a structure which is to be forced into indirect access mode.
 227                          */
 228                         #define GCC_FORCE_POINTER_ACCESS(StructPtr) __asm__ __volatile__("" : "=b" (StructPtr) : "0" (StructPtr))
 229
 230                         /** Forces GCC to create a memory barrier, ensuring that memory accesses are not reordered past the barrier point.
 231                          *  This can be used before ordering-critical operations, to ensure that the compiler does not re-order the resulting
 232                          *  assembly output in an unexpected manner on sections of code that are ordering-specific.
 233                          */
 234                         #define GCC_MEMORY_BARRIER()                __asm__ __volatile__("" ::: "memory");
 235
 236                         /** Evaluates to boolean true if the specified value can be determined at compile time to be a constant value
 237                          *  when compiling under GCC.
 238                          *
 239                          *  \param[in] x  Value to check compile time constantness of.
 240                          *
 241                          *  \return Boolean true if the given value is known to be a compile time constant.
 242                          */
 243                         #define GCC_IS_COMPILE_CONST(x)             __builtin_constant_p(x)
 244
 245                         #if !defined(ISR) || defined(__DOXYGEN__)
 246                                 /** Macro for the definition of interrupt service routines, so that the compiler can insert the required
 247                                  *  prologue and epilogue code to properly manage the interrupt routine without affecting the main thread's
 248                                  *  state with unintentional side-effects.
 249                                  *
 250                                  *  Interrupt handlers written using this macro may still need to be registered with the microcontroller's
 251                                  *  Interrupt Controller (if present) before they will properly handle incoming interrupt events.
 252                                  *
 253                                  *  \note This macro is only supplied on some architectures, where the standard library does not include a valid
 254                                  *        definition. If an existing definition exists, the alternative definition here will be ignored.
 255                                  *
 256                                  *  \ingroup Group_GlobalInt
 257                                  *
 258                                  *  \param Name  Unique name of the interrupt service routine.
 259                                  */
 260                                 #define ISR(Name, ...)                  void Name (void) __attribute__((__interrupt__)); void Name (void)
 261                         #endif
 262
 263                 /* Inline Functions: */
 264                         /** Function to reverse the individual bits in a byte - i.e. bit 7 is moved to bit 0, bit 6 to bit 1,
 265                          *  etc.
 266                          *
 267                          *  \param[in] Byte  Byte of data whose bits are to be reversed.
 268                          */
 269                         static inline uint8_t BitReverse(uint8_t Byte) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
 270                         static inline uint8_t BitReverse(uint8_t Byte)
 271                         {
 272                                 Byte = (((Byte & 0xF0) >> 4) | ((Byte & 0x0F) << 4));
 273                                 Byte = (((Byte & 0xCC) >> 2) | ((Byte & 0x33) << 2));
 274                                 Byte = (((Byte & 0xAA) >> 1) | ((Byte & 0x55) << 1));
 275
 276                                 return Byte;
 277                         }
 278
 279                         /** Function to perform a blocking delay for a specified number of milliseconds. The actual delay will be
 280                          *  at a minimum the specified number of milliseconds, however due to loop overhead and internal calculations
 281                          *  may be slightly higher.
 282                          *
 283                          *  \param[in] Milliseconds  Number of milliseconds to delay
 284                          */
 285                         static inline void Delay_MS(uint8_t Milliseconds) ATTR_ALWAYS_INLINE;
 286                         static inline void Delay_MS(uint8_t Milliseconds)
 287                         {
 288                                 #if (ARCH == ARCH_AVR8)
 289                                 if (GCC_IS_COMPILE_CONST(Milliseconds))
 290                                 {
 291                                         _delay_ms(Milliseconds);
 292                                 }
 293                                 else
 294                                 {
 295                                         while (Milliseconds--)
 296                                           _delay_ms(1);
 297                                 }
 298                                 #elif (ARCH == ARCH_UC3)
 299                                 while (Milliseconds--)
 300                                 {
 301                                         __builtin_mtsr(AVR32_COUNT, 0);
 302                                         while (__builtin_mfsr(AVR32_COUNT) < (F_CPU / 1000));
 303                                 }
 304                                 #endif
 305                         }
 306
 307                         /** Retrieves a mask which contains the current state of the global interrupts for the device. This
 308                          *  value can be stored before altering the global interrupt enable state, before restoring the
 309                          *  flag(s) back to their previous values after a critical section using \ref SetGlobalInterruptMask().
 310                          *
 311                          *  \ingroup Group_GlobalInt
 312                          *
 313                          *  \return  Mask containing the current Global Interrupt Enable Mask bit(s).
 314                          */
 315                         static inline uint_reg_t GetGlobalInterruptMask(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 316                         static inline uint_reg_t GetGlobalInterruptMask(void)
 317                         {
 318                                 GCC_MEMORY_BARRIER();
 319
 320                                 #if (ARCH == ARCH_AVR8)
 321                                 return SREG;
 322                                 #elif (ARCH == ARCH_UC3)
 323                                 return __builtin_mfsr(AVR32_SR);
 324                                 #endif
 325
 326                                 GCC_MEMORY_BARRIER();
 327                         }
 328
 329                         /** Sets the global interrupt enable state of the microcontroller to the mask passed into the function.
 330                          *  This can be combined with \ref GetGlobalInterruptMask() to save and restore the Global Interrupt Enable
 331                          *  Mask bit(s) of the device after a critical section has completed.
 332                          *
 333                          *  \ingroup Group_GlobalInt
 334                          *
 335                          *  \param[in] GlobalIntState  Global Interrupt Enable Mask value to use
 336                          */
 337                         static inline void SetGlobalInterruptMask(const uint_reg_t GlobalIntState) ATTR_ALWAYS_INLINE;
 338                         static inline void SetGlobalInterruptMask(const uint_reg_t GlobalIntState)
 339                         {
 340                                 GCC_MEMORY_BARRIER();
 341
 342                                 #if (ARCH == ARCH_AVR8)
 343                                 SREG = GlobalIntState;
 344                                 #elif (ARCH == ARCH_UC3)
 345                                 if (GlobalIntState & AVR32_SR_GM)
 346                                   __builtin_ssrf(AVR32_SR_GM_OFFSET);
 347                                 else
 348                                   __builtin_csrf(AVR32_SR_GM_OFFSET);
 349                                 #endif
 350
 351                                 GCC_MEMORY_BARRIER();
 352                         }
 353
 354                         /** Enables global interrupt handling for the device, allowing interrupts to be handled.
 355                          *
 356                          *  \ingroup Group_GlobalInt
 357                          */
 358                         static inline void GlobalInterruptEnable(void) ATTR_ALWAYS_INLINE;
 359                         static inline void GlobalInterruptEnable(void)
 360                         {
 361                                 GCC_MEMORY_BARRIER();
 362
 363                                 #if (ARCH == ARCH_AVR8)
 364                                 sei();
 365                                 #elif (ARCH == ARCH_UC3)
 366                                 __builtin_csrf(AVR32_SR_GM_OFFSET);
 367                                 #endif
 368
 369                                 GCC_MEMORY_BARRIER();
 370                         }
 371
 372                         /** Disabled global interrupt handling for the device, preventing interrupts from being handled.
 373                          *
 374                          *  \ingroup Group_GlobalInt
 375                          */
 376                         static inline void GlobalInterruptDisable(void) ATTR_ALWAYS_INLINE;
 377                         static inline void GlobalInterruptDisable(void)
 378                         {
 379                                 GCC_MEMORY_BARRIER();
 380
 381                                 #if (ARCH == ARCH_AVR8)
 382                                 cli();
 383                                 #elif (ARCH == ARCH_UC3)
 384                                 __builtin_ssrf(AVR32_SR_GM_OFFSET);
 385                                 #endif
 386
 387                                 GCC_MEMORY_BARRIER();
 388                         }
 389
 390 #endif
 391
 392 /** @} */
 393