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