LUFA/Common/Common.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2015.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2015  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 disclaims 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                 #include "Architectures.h"
  72                 #include "BoardTypes.h"
  73                 #include "ArchitectureSpecific.h"
  74                 #include "CompilerSpecific.h"
  75                 #include "Attributes.h"
  76
  77                 #if defined(USE_LUFA_CONFIG_HEADER)
  78                         #include "LUFAConfig.h"
  79                 #endif
  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                         #include <math.h>
 113
 114                         // === TODO: Find abstracted way to handle these ===
 115                         #define PROGMEM
 116                         #define pgm_read_byte(x)         *x
 117                         #define memcmp_P(...)            memcmp(__VA_ARGS__)
 118                         #define memcpy_P(...)            memcpy(__VA_ARGS__)
 119                         // =================================================
 120
 121                         typedef uint32_t uint_reg_t;
 122
 123                         #define ARCH_BIG_ENDIAN
 124
 125                         #include "Endianness.h"
 126                 #elif (ARCH == ARCH_XMEGA)
 127                         #include <avr/io.h>
 128                         #include <avr/interrupt.h>
 129                         #include <avr/pgmspace.h>
 130                         #include <avr/eeprom.h>
 131                         #include <math.h>
 132                         #include <util/delay.h>
 133
 134                         typedef uint8_t uint_reg_t;
 135
 136                         #define ARCH_HAS_EEPROM_ADDRESS_SPACE
 137                         #define ARCH_HAS_FLASH_ADDRESS_SPACE
 138                         #define ARCH_HAS_MULTI_ADDRESS_SPACE
 139                         #define ARCH_LITTLE_ENDIAN
 140
 141                         #include "Endianness.h"
 142                 #else
 143                         #error Unknown device architecture specified.
 144                 #endif
 145
 146         /* Public Interface - May be used in end-application: */
 147                 /* Macros: */
 148                         #if !defined(__DOXYGEN__)
 149                                 // Obsolete, retained for compatibility with user code
 150                                 #define MACROS                  do
 151                                 #define MACROE                  while (0)
 152                         #endif
 153
 154                         /** Convenience macro to determine the larger of two values.
 155                          *
 156                          *  \attention This macro should only be used with operands that do not have side effects from being evaluated
 157                          *             multiple times.
 158                          *
 159                          *  \param[in] x  First value to compare
 160                          *  \param[in] y  First value to compare
 161                          *
 162                          *  \return The larger of the two input parameters
 163                          */
 164                         #if !defined(MAX) || defined(__DOXYGEN__)
 165                                 #define MAX(x, y)               (((x) > (y)) ? (x) : (y))
 166                         #endif
 167
 168                         /** Convenience macro to determine the smaller of two values.
 169                          *
 170                          *  \attention This macro should only be used with operands that do not have side effects from being evaluated
 171                          *             multiple times.
 172                          *
 173                          *  \param[in] x  First value to compare.
 174                          *  \param[in] y  First value to compare.
 175                          *
 176                          *  \return The smaller of the two input parameters
 177                          */
 178                         #if !defined(MIN) || defined(__DOXYGEN__)
 179                                 #define MIN(x, y)               (((x) < (y)) ? (x) : (y))
 180                         #endif
 181
 182                         #if !defined(STRINGIFY) || defined(__DOXYGEN__)
 183                                 /** Converts the given input into a string, via the C Preprocessor. This macro puts literal quotation
 184                                  *  marks around the input, converting the source into a string literal.
 185                                  *
 186                                  *  \param[in] x  Input to convert into a string literal.
 187                                  *
 188                                  *  \return String version of the input.
 189                                  */
 190                                 #define STRINGIFY(x)            #x
 191
 192                                 /** Converts the given input into a string after macro expansion, via the C Preprocessor. This macro puts
 193                                  *  literal quotation marks around the expanded input, converting the source into a string literal.
 194                                  *
 195                                  *  \param[in] x  Input to expand and convert into a string literal.
 196                                  *
 197                                  *  \return String version of the expanded input.
 198                                  */
 199                                 #define STRINGIFY_EXPANDED(x)   STRINGIFY(x)
 200                         #endif
 201
 202                         #if !defined(CONCAT) || defined(__DOXYGEN__)
 203                                 /** Concatenates the given input into a single token, via the C Preprocessor.
 204                                  *
 205                                  *  \param[in] x  First item to concatenate.
 206                                  *  \param[in] y  Second item to concatenate.
 207                                  *
 208                                  *  \return Concatenated version of the input.
 209                                  */
 210                                 #define CONCAT(x, y)            x ## y
 211
 212                                 /** CConcatenates the given input into a single token after macro expansion, via the C Preprocessor.
 213                                  *
 214                                  *  \param[in] x  First item to concatenate.
 215                                  *  \param[in] y  Second item to concatenate.
 216                                  *
 217                                  *  \return Concatenated version of the expanded input.
 218                                  */
 219                                 #define CONCAT_EXPANDED(x, y)   CONCAT(x, y)
 220                         #endif
 221
 222                         #if !defined(ISR) || defined(__DOXYGEN__)
 223                                 /** Macro for the definition of interrupt service routines, so that the compiler can insert the required
 224                                  *  prologue and epilogue code to properly manage the interrupt routine without affecting the main thread's
 225                                  *  state with unintentional side-effects.
 226                                  *
 227                                  *  Interrupt handlers written using this macro may still need to be registered with the microcontroller's
 228                                  *  Interrupt Controller (if present) before they will properly handle incoming interrupt events.
 229                                  *
 230                                  *  \note This macro is only supplied on some architectures, where the standard library does not include a valid
 231                                  *        definition. If an existing definition exists, the alternative definition here will be ignored.
 232                                  *
 233                                  *  \ingroup Group_GlobalInt
 234                                  *
 235                                  *  \param[in] Name  Unique name of the interrupt service routine.
 236                                  */
 237                                 #define ISR(Name, ...)          void Name (void) __attribute__((__interrupt__)) __VA_ARGS__; void Name (void)
 238                         #endif
 239
 240                 /* Inline Functions: */
 241                         /** Function to reverse the individual bits in a byte - i.e. bit 7 is moved to bit 0, bit 6 to bit 1,
 242                          *  etc.
 243                          *
 244                          *  \param[in] Byte  Byte of data whose bits are to be reversed.
 245                          *
 246                          *  \return Input data with the individual bits reversed (mirrored).
 247                          */
 248                         static inline uint8_t BitReverse(uint8_t Byte) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
 249                         static inline uint8_t BitReverse(uint8_t Byte)
 250                         {
 251                                 Byte = (((Byte & 0xF0) >> 4) | ((Byte & 0x0F) << 4));
 252                                 Byte = (((Byte & 0xCC) >> 2) | ((Byte & 0x33) << 2));
 253                                 Byte = (((Byte & 0xAA) >> 1) | ((Byte & 0x55) << 1));
 254
 255                                 return Byte;
 256                         }
 257
 258                         /** Function to perform a blocking delay for a specified number of milliseconds. The actual delay will be
 259                          *  at a minimum the specified number of milliseconds, however due to loop overhead and internal calculations
 260                          *  may be slightly higher.
 261                          *
 262                          *  \param[in] Milliseconds  Number of milliseconds to delay
 263                          */
 264                         static inline void Delay_MS(uint16_t Milliseconds) ATTR_ALWAYS_INLINE;
 265                         static inline void Delay_MS(uint16_t Milliseconds)
 266                         {
 267                                 #if (ARCH == ARCH_AVR8)
 268                                 if (GCC_IS_COMPILE_CONST(Milliseconds))
 269                                 {
 270                                         _delay_ms(Milliseconds);
 271                                 }
 272                                 else
 273                                 {
 274                                         while (Milliseconds--)
 275                                           _delay_ms(1);
 276                                 }
 277                                 #elif (ARCH == ARCH_UC3)
 278                                 while (Milliseconds--)
 279                                 {
 280                                         __builtin_mtsr(AVR32_COUNT, 0);
 281                                         while ((uint32_t)__builtin_mfsr(AVR32_COUNT) < (F_CPU / 1000));
 282                                 }
 283                                 #elif (ARCH == ARCH_XMEGA)
 284                                 if (GCC_IS_COMPILE_CONST(Milliseconds))
 285                                 {
 286                                         _delay_ms(Milliseconds);
 287                                 }
 288                                 else
 289                                 {
 290                                         while (Milliseconds--)
 291                                           _delay_ms(1);
 292                                 }
 293                                 #endif
 294                         }
 295
 296                         /** Retrieves a mask which contains the current state of the global interrupts for the device. This
 297                          *  value can be stored before altering the global interrupt enable state, before restoring the
 298                          *  flag(s) back to their previous values after a critical section using \ref SetGlobalInterruptMask().
 299                          *
 300                          *  \ingroup Group_GlobalInt
 301                          *
 302                          *  \return  Mask containing the current Global Interrupt Enable Mask bit(s).
 303                          */
 304                         static inline uint_reg_t GetGlobalInterruptMask(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 305                         static inline uint_reg_t GetGlobalInterruptMask(void)
 306                         {
 307                                 GCC_MEMORY_BARRIER();
 308
 309                                 #if (ARCH == ARCH_AVR8)
 310                                 return SREG;
 311                                 #elif (ARCH == ARCH_UC3)
 312                                 return __builtin_mfsr(AVR32_SR);
 313                                 #elif (ARCH == ARCH_XMEGA)
 314                                 return SREG;
 315                                 #endif
 316                         }
 317
 318                         /** Sets the global interrupt enable state of the microcontroller to the mask passed into the function.
 319                          *  This can be combined with \ref GetGlobalInterruptMask() to save and restore the Global Interrupt Enable
 320                          *  Mask bit(s) of the device after a critical section has completed.
 321                          *
 322                          *  \ingroup Group_GlobalInt
 323                          *
 324                          *  \param[in] GlobalIntState  Global Interrupt Enable Mask value to use
 325                          */
 326                         static inline void SetGlobalInterruptMask(const uint_reg_t GlobalIntState) ATTR_ALWAYS_INLINE;
 327                         static inline void SetGlobalInterruptMask(const uint_reg_t GlobalIntState)
 328                         {
 329                                 GCC_MEMORY_BARRIER();
 330
 331                                 #if (ARCH == ARCH_AVR8)
 332                                 SREG = GlobalIntState;
 333                                 #elif (ARCH == ARCH_UC3)
 334                                 if (GlobalIntState & AVR32_SR_GM)
 335                                   __builtin_ssrf(AVR32_SR_GM_OFFSET);
 336                                 else
 337                                   __builtin_csrf(AVR32_SR_GM_OFFSET);
 338                                 #elif (ARCH == ARCH_XMEGA)
 339                                 SREG = GlobalIntState;
 340                                 #endif
 341
 342                                 GCC_MEMORY_BARRIER();
 343                         }
 344
 345                         /** Enables global interrupt handling for the device, allowing interrupts to be handled.
 346                          *
 347                          *  \ingroup Group_GlobalInt
 348                          */
 349                         static inline void GlobalInterruptEnable(void) ATTR_ALWAYS_INLINE;
 350                         static inline void GlobalInterruptEnable(void)
 351                         {
 352                                 GCC_MEMORY_BARRIER();
 353
 354                                 #if (ARCH == ARCH_AVR8)
 355                                 sei();
 356                                 #elif (ARCH == ARCH_UC3)
 357                                 __builtin_csrf(AVR32_SR_GM_OFFSET);
 358                                 #elif (ARCH == ARCH_XMEGA)
 359                                 sei();
 360                                 #endif
 361
 362                                 GCC_MEMORY_BARRIER();
 363                         }
 364
 365                         /** Disabled global interrupt handling for the device, preventing interrupts from being handled.
 366                          *
 367                          *  \ingroup Group_GlobalInt
 368                          */
 369                         static inline void GlobalInterruptDisable(void) ATTR_ALWAYS_INLINE;
 370                         static inline void GlobalInterruptDisable(void)
 371                         {
 372                                 GCC_MEMORY_BARRIER();
 373
 374                                 #if (ARCH == ARCH_AVR8)
 375                                 cli();
 376                                 #elif (ARCH == ARCH_UC3)
 377                                 __builtin_ssrf(AVR32_SR_GM_OFFSET);
 378                                 #elif (ARCH == ARCH_XMEGA)
 379                                 cli();
 380                                 #endif
 381
 382                                 GCC_MEMORY_BARRIER();
 383                         }
 384
 385         /* Disable C linkage for C++ Compilers: */
 386                 #if defined(__cplusplus)
 387                         }
 388                 #endif
 389
 390 #endif
 391
 392 /** @} */
 393