LUFA/Common/Common.h

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