LUFA/Common/Common.h

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