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 #ifndef __LUFA_COMMON_H__
  53 #define __LUFA_COMMON_H__
  54
  55         /* Macros: */
  56                 #define __INCLUDE_FROM_COMMON_H
  57
  58         /* Includes: */
  59                 #include <stdint.h>
  60                 #include <stdbool.h>
  61                 #include <string.h>
  62                 #include <stddef.h>
  63
  64                 #include "Architectures.h"
  65                 #include "Attributes.h"
  66                 #include "BoardTypes.h"
  67
  68         /* Architecture specific utility includes: */
  69                 #if defined(__DOXYGEN__)
  70                         /** Type define for an unsigned integer the same width as the selected architecture's machine register. */
  71                         typedef MACHINE_REG_t uint_reg_t;
  72                 #elif (ARCH == ARCH_AVR8)
  73                         #include <avr/io.h>
  74                         #include <avr/interrupt.h>
  75                         #include <avr/pgmspace.h>
  76                         #include <avr/eeprom.h>
  77                         #include <avr/boot.h>
  78                         #include <util/atomic.h>
  79                         #include <util/delay.h>
  80
  81                         typedef uint8_t uint_reg_t;
  82
  83                         #define ARCH_HAS_EEPROM_ADDRESS_SPACE
  84                         #define ARCH_HAS_FLASH_ADDRESS_SPACE
  85                         #define ARCH_HAS_MULTI_ADDRESS_SPACE
  86                         #define ARCH_LITTLE_ENDIAN
  87
  88                         #include "Endianness.h"
  89                 #elif (ARCH == ARCH_UC3)
  90                         #include <avr32/io.h>
  91
  92                         // === TODO: Find abstracted way to handle these ===
  93                         #define ISR(Name)                void Name (void) __attribute__((__interrupt__)); void Name (void)
  94                         #define PROGMEM                  const
  95                         #define ATOMIC_BLOCK(x)          if (1)
  96                         #define ATOMIC_RESTORESTATE
  97                         #define pgm_read_byte(x)         *x
  98                         #define _delay_ms(x)
  99                         #define memcmp_P(...)            memcmp(__VA_ARGS__)
 100                         #define memcpy_P(...)            memcpy(__VA_ARGS__)
 101                         // ==================================================
 102
 103                         typedef uint32_t uint_reg_t;
 104
 105                         #define  ARCH_BIG_ENDIAN
 106
 107                         #include "Endianness.h"
 108                 #else
 109                         #error Unknown device architecture specified.
 110                 #endif
 111
 112         /* Public Interface - May be used in end-application: */
 113                 /* Macros: */
 114                         /** Macro for encasing other multi-statement macros. This should be used along with an opening brace
 115                          *  before the start of any multi-statement macro, so that the macros contents as a whole are treated
 116                          *  as a discrete block and not as a list of separate statements which may cause problems when used as
 117                          *  a block (such as inline \c if statements).
 118                          */
 119                         #define MACROS                  do
 120
 121                         /** Macro for encasing other multi-statement macros. This should be used along with a preceding closing
 122                          *  brace at the end of any multi-statement macro, so that the macros contents as a whole are treated
 123                          *  as a discrete block and not as a list of separate statements which may cause problems when used as
 124                          *  a block (such as inline \c if statements).
 125                          */
 126                         #define MACROE                  while (0)
 127
 128                         /** Convenience macro to determine the larger of two values.
 129                          *
 130                          *  \note This macro should only be used with operands that do not have side effects from being evaluated
 131                          *        multiple times.
 132                          *
 133                          *  \param[in] x  First value to compare
 134                          *  \param[in] y  First value to compare
 135                          *
 136                          *  \return The larger of the two input parameters
 137                          */
 138                         #if !defined(MAX) || defined(__DOXYGEN__)
 139                                 #define MAX(x, y)               ((x > y) ? x : y)
 140                         #endif
 141
 142                         /** Convenience macro to determine the smaller of two values.
 143                          *
 144                          *  \note This macro should only be used with operands that do not have side effects from being evaluated
 145                          *        multiple times.
 146                          *
 147                          *  \param[in] x  First value to compare
 148                          *  \param[in] y  First value to compare
 149                          *
 150                          *  \return The smaller of the two input parameters
 151                          */
 152                         #if !defined(MIN) || defined(__DOXYGEN__)
 153                                 #define MIN(x, y)               ((x < y) ? x : y)
 154                         #endif
 155
 156                         #if (ARCH == ARCH_AVR8) || defined(__DOXYGEN__)
 157                                 /** Defines a volatile \c NOP statement which cannot be optimized out by the compiler, and thus can always
 158                                  *  be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimiser
 159                                  *  removes/reorders code to the point where break points cannot reliably be set.
 160                                  *
 161                                  *  \ingroup Group_Debugging
 162                                  */
 163                                 #define JTAG_DEBUG_POINT()      __asm__ __volatile__ ("NOP" ::)
 164
 165                                 /** Defines an explicit JTAG break point in the resulting binary via the assembly \c BREAK statement. When
 166                                  *  a JTAG is used, this causes the program execution to halt when reached until manually resumed.
 167                                  *
 168                                  *  \ingroup Group_Debugging
 169                                  */
 170                                 #define JTAG_DEBUG_BREAK()      __asm__ __volatile__ ("BREAK" ::)
 171
 172                                 #if !defined(pgm_read_ptr) || defined(__DOXYGEN__)
 173                                         /** Reads a pointer out of PROGMEM space on the AVR8 architecture. This is currently a wrapper for the
 174                                          *  avr-libc \c pgm_read_ptr() macro with a \c void* cast, so that its value can be assigned directly
 175                                          *  to a pointer variable or used in pointer arithmetic without further casting in C. In a future
 176                                          *  avr-libc distribution this will be part of the standard API and will be implemented in a more formal
 177                                          *  manner.
 178                                          *
 179                                          *  \param[in] Addr  Address of the pointer to read.
 180                                          *
 181                                          *  \return Pointer retrieved from PROGMEM space.
 182                                          */
 183                                         #define pgm_read_ptr(Addr)    (void*)pgm_read_word(Addr)
 184                                 #endif
 185
 186                                 /** Macro for testing condition "x" and breaking via \ref JTAG_DEBUG_BREAK() if the condition is false.
 187                                  *
 188                                  *  \param[in] Condition  Condition that will be evaluated,
 189                                  *
 190                                  *  \ingroup Group_Debugging
 191                                 */
 192                                 #define JTAG_DEBUG_ASSERT(Condition)    MACROS{ if (!(Condition)) { JTAG_DEBUG_BREAK(); } }MACROE
 193
 194                                 /** Macro for testing condition "x" and writing debug data to the stdout stream if \c false. The stdout stream
 195                                  *  must be pre-initialized before this macro is run and linked to an output device, such as the microcontroller's
 196                                  *  USART peripheral.
 197                                  *
 198                                  *  The output takes the form "{FILENAME}: Function {FUNCTION NAME}, Line {LINE NUMBER}: Assertion {Condition} failed."
 199                                  *
 200                                  *  \param[in] Condition  Condition that will be evaluated,
 201                                  *
 202                                  *  \ingroup Group_Debugging
 203                                  */
 204                                 #define STDOUT_ASSERT(Condition)        MACROS{ if (!(x)) { printf_P(PSTR("%s: Function \"%s\", Line %d: "   \
 205                                                                                 "Assertion \"%s\" failed.\r\n"),     \
 206                                                                                 __FILE__, __func__, __LINE__, #Condition); } }MACROE
 207                         #endif
 208
 209                         /** Forces GCC to use pointer indirection (via the device's pointer register pairs) when accessing the given
 210                          *  struct pointer. In some cases GCC will emit non-optimal assembly code when accessing a structure through
 211                          *  a pointer, resulting in a larger binary. When this macro is used on a (non \c const) structure pointer before
 212                          *  use, it will force GCC to use pointer indirection on the elements rather than direct store and load
 213                          *  instructions.
 214                          *
 215                          *  \param[in, out] StructPtr  Pointer to a structure which is to be forced into indirect access mode.
 216                          */
 217                         #define GCC_FORCE_POINTER_ACCESS(StructPtr) __asm__ __volatile__("" : "=b" (StructPtr) : "0" (StructPtr))
 218
 219                         /** Forces GCC to create a memory barrier, ensuring that memory accesses are not reordered past the barrier point.
 220                          *  This can be used before ordering-critical operations, to ensure that the compiler does not re-order the resulting
 221                          *  assembly output in an unexpected manner on sections of code that are ordering-specific.
 222                          */
 223                         #define GCC_MEMORY_BARRIER()                __asm__ __volatile__("" ::: "memory");
 224
 225                 /* Inline Functions: */
 226                         /** Function to reverse the individual bits in a byte - i.e. bit 7 is moved to bit 0, bit 6 to bit 1,
 227                          *  etc.
 228                          *
 229                          *  \param[in] Byte  Byte of data whose bits are to be reversed.
 230                          */
 231                         static inline uint8_t BitReverse(uint8_t Byte) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
 232                         static inline uint8_t BitReverse(uint8_t Byte)
 233                         {
 234                                 Byte = (((Byte & 0xF0) >> 4) | ((Byte & 0x0F) << 4));
 235                                 Byte = (((Byte & 0xCC) >> 2) | ((Byte & 0x33) << 2));
 236                                 Byte = (((Byte & 0xAA) >> 1) | ((Byte & 0x55) << 1));
 237
 238                                 return Byte;
 239                         }
 240
 241 #endif
 242
 243 /** @} */
 244