LUFA/Common/Common.h

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