LUFA/Common/Common.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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  *
  33  *  This file contains macros which are common to all library elements, and which may be useful in user code. It
  34  *  also includes other common headers, such as Atomic.h, FunctionAttributes.h and BoardTypes.h.
  35  */
  36
  37 /** @defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h
  38  *
  39  *  Common utility headers containing macros, functions, enums and types which are common to all
  40  *  aspects of the library.
  41  *
  42  *  @{
  43  */
  44
  45 /** @defgroup Group_Debugging Debugging Macros
  46  *
  47  *  Macros for debugging use.
  48  */
  49
  50 /** @defgroup Group_BitManip Endian and Bit Macros
  51  *
  52  *  Functions for swapping endianness and reversing bit orders.
  53  */
  54
  55 #ifndef __COMMON_H__
  56 #define __COMMON_H__
  57
  58         /* Includes: */
  59                 #if defined(__AVR32__)
  60                         #include <avr32/io.h>
  61                         #include <stdint.h>
  62
  63                         #include "Atomic.h"
  64
  65                         #define PROGMEM
  66                 #else
  67                         #include <avr/io.h>
  68                 #endif
  69
  70                 #include "FunctionAttributes.h"
  71                 #include "BoardTypes.h"
  72
  73         /* Public Interface - May be used in end-application: */
  74                 /* Macros: */
  75                         /** Macro for encasing other multi-statement macros. This should be used along with an opening brace
  76                          *  before the start of any multi-statement macro, so that the macros contents as a whole are treated
  77                          *  as a discrete block and not as a list of separate statements which may cause problems when used as
  78                          *  a block (such as inline IF statements).
  79                          */
  80                         #define MACROS                  do
  81
  82                         /** Macro for encasing other multi-statement macros. This should be used along with a preceding closing
  83                          *  brace at the end of any multi-statement macro, so that the macros contents as a whole are treated
  84                          *  as a discrete block and not as a list of separate statements which may cause problems when used as
  85                          *  a block (such as inline IF statements).
  86                          */
  87                         #define MACROE                  while (0)
  88
  89                         /** Defines a volatile NOP statement which cannot be optimized out by the compiler, and thus can always
  90                          *  be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimizer
  91                          *  removes/reorders code to the point where break points cannot reliably be set.
  92                          *
  93                          *  \ingroup Group_Debugging
  94                          */
  95                         #define JTAG_DEBUG_POINT()      asm volatile ("NOP" ::)
  96
  97                         /** Defines an explicit JTAG break point in the resulting binary via the ASM BREAK statement. When
  98                          *  a JTAG is used, this causes the program execution to halt when reached until manually resumed.
  99                          *
 100                          *  \ingroup Group_Debugging
 101                          */
 102                         #define JTAG_DEBUG_BREAK()      asm volatile ("BREAK" ::)
 103
 104                         /** Macro for testing condition "x" and breaking via JTAG_DEBUG_BREAK() if the condition is false.
 105                          *
 106                          *  \ingroup Group_Debugging
 107                         */
 108                         #define JTAG_DEBUG_ASSERT(x)    MACROS{ if (!(x)) { JTAG_DEBUG_BREAK(); } }MACROE
 109
 110                         /** Macro for testing condition "x" and writing debug data to the serial stream if false. As a
 111                          *  prerequisite for this macro, the serial stream should be configured via the Peripheral/SerialStream driver.
 112                          *
 113                          *  The serial output takes the form "{FILENAME}: Function {FUNCTION NAME}, Line {LINE NUMBER}: Assertion
 114                          *  {x} failed."
 115                          *
 116                          *  \ingroup Group_Debugging
 117                          */
 118                         #define SERIAL_STREAM_ASSERT(x) MACROS{ if (!(x)) { printf_P(PSTR("%s: Function \"%s\", Line %d: "   \
 119                                                                                                                                 "Assertion \"%s\" failed.\r\n"),   \
 120                                                                                                                                 __FILE__, __func__, __LINE__, #x); \
 121                                                         } }MACROE
 122
 123                 /* Inline Functions: */
 124                         /** Function to reverse the individual bits in a byte - i.e. bit 7 is moved to bit 0, bit 6 to bit 1,
 125                          *  etc.
 126                          *
 127                          *  \ingroup Group_BitManip
 128                          *
 129                          *  \param[in] Byte   Byte of data whose bits are to be reversed
 130                          */
 131                         static inline uint8_t BitReverse(uint8_t Byte) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
 132                         static inline uint8_t BitReverse(uint8_t Byte)
 133                         {
 134                                 Byte = (((Byte & 0xF0) >> 4) | ((Byte & 0x0F) << 4));
 135                                 Byte = (((Byte & 0xCC) >> 2) | ((Byte & 0x33) << 2));
 136                                 Byte = (((Byte & 0xAA) >> 1) | ((Byte & 0x55) << 1));
 137
 138                                 return Byte;
 139                         }
 140
 141                         /** Function to reverse the byte ordering of the individual bytes in a 16 bit number.
 142                          *
 143                          *  \ingroup Group_BitManip
 144                          *
 145                          *  \param[in] Word   Word of data whose bytes are to be swapped
 146                          */
 147                         static inline uint16_t SwapEndian_16(uint16_t Word) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
 148                         static inline uint16_t SwapEndian_16(uint16_t Word)
 149                         {
 150                                 return ((Word >> 8) | (Word << 8));
 151                         }
 152
 153                         /** Function to reverse the byte ordering of the individual bytes in a 32 bit number.
 154                          *
 155                          *  \ingroup Group_BitManip
 156                          *
 157                          *  \param[in] DWord   Double word of data whose bytes are to be swapped
 158                          */
 159                         static inline uint32_t SwapEndian_32(uint32_t DWord) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
 160                         static inline uint32_t SwapEndian_32(uint32_t DWord)
 161                         {
 162                                 return (((DWord & 0xFF000000) >> 24) |
 163                                         ((DWord & 0x00FF0000) >> 8)  |
 164                                                 ((DWord & 0x0000FF00) << 8)  |
 165                                                 ((DWord & 0x000000FF) << 24));
 166                         }
 167
 168                         /** Function to reverse the byte ordering of the individual bytes in a n byte number.
 169                          *
 170                          *  \ingroup Group_BitManip
 171                          *
 172                          *  \param[in,out] Data  Pointer to a number containing an even number of bytes to be reversed
 173                          *  \param[in] Bytes  Length of the data in bytes
 174                          */
 175                         static inline void SwapEndian_n(uint8_t* Data, uint8_t Bytes);
 176                         static inline void SwapEndian_n(uint8_t* Data, uint8_t Bytes)
 177                         {
 178                                 uint8_t Temp;
 179
 180                                 while (Bytes)
 181                                 {
 182                                         Temp = *Data;
 183                                         *Data = *(Data + Bytes - 1);
 184                                         *(Data + Bytes - 1) = Temp;
 185
 186                                         Data++;
 187                                         Bytes -= 2;
 188                                 }
 189                         }
 190
 191                 /* Type Defines: */
 192                         #if defined(__AVR32__)
 193                                 /** Type define for an unsigned native word-sized chunk of data. */
 194                                 typedef uint32_t uintN_t;
 195
 196                                 /** Type define for a signed native word-sized chunk of data. */
 197                                 typedef int32_t intN_t;
 198                         #else
 199                                 /** Type define for an unsigned native word-sized chunk of data. */
 200                                 typedef uint8_t uintN_t;
 201
 202                                 /** Type define for a signed native word-sized chunk of data. */
 203                                 typedef int8_t intN_t;
 204                         #endif
 205 #endif
 206
 207 /** @} */