-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2009.\r
- \r
- dean [at] fourwalledcubicle [dot] com\r
- www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
- Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
- Permission to use, copy, modify, and distribute this software\r
- and its documentation for any purpose and without fee is hereby\r
- granted, provided that the above copyright notice appear in all\r
- copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting\r
- documentation, and that the name of the author not be used in\r
- advertising or publicity pertaining to distribution of the\r
- software without specific, written prior permission.\r
-\r
- The author disclaim all warranties with regard to this\r
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \file\r
- *\r
- * This file contains macros which are common to all library elements, and which may be useful in user code. It\r
- * also includes other common headees, such as Atomic.h, FunctionAttributes.h and BoardTypes.h.\r
- */\r
-\r
-#ifndef __COMMON_H__\r
-#define __COMMON_H__\r
-\r
- /* Includes: */\r
- #include <avr/io.h>\r
- #include <stdio.h>\r
- #include <avr/version.h>\r
- \r
- #include "FunctionAttributes.h"\r
- #include "BoardTypes.h"\r
- \r
- #include <alloca.h>\r
-\r
- /* Public Interface - May be used in end-application: */\r
- /* Macros: */ \r
- /** Macro for encasing other multi-statment macros. This should be used along with an opening brace\r
- * before the start of any multi-statement macro, so that the macros contents as a whole are treated\r
- * as a discreete block and not as a list of seperate statements which may cause problems when used as\r
- * a block (such as inline IF statments).\r
- */\r
- #define MACROS do\r
-\r
- /** Macro for encasing other multi-statment macros. This should be used along with a preceeding closing\r
- * brace at the end of any multi-statement macro, so that the macros contents as a whole are treated\r
- * as a discreete block and not as a list of seperate statements which may cause problems when used as\r
- * a block (such as inline IF statments).\r
- */\r
- #define MACROE while (0)\r
- \r
- /** Defines a volatile NOP statment which cannot be optimized out by the compiler, and thus can always\r
- * be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimizer\r
- * removes/reorders code to the point where break points cannot reliably be set.\r
- */\r
- #define JTAG_DEBUG_POINT() asm volatile ("NOP" ::)\r
-\r
- /** Defines an explicit JTAG break point in the resulting binary via the ASM BREAK statment. When\r
- * a JTAG is used, this causes the program execution to halt when reached until manually resumed. */\r
- #define JTAG_DEBUG_BREAK() asm volatile ("BREAK" ::)\r
- \r
- /** Macro for testing condition "x" and breaking via JTAG_DEBUG_BREAK() if the condition is false. */\r
- #define JTAG_DEBUG_ASSERT(x) MACROS{ if (!(x)) { JTAG_DEBUG_BREAK(); } }MACROE\r
-\r
- /** Macro for testing condition "x" and writing debug data to the serial stream if false. As a\r
- * prerequisite for this macro, the serial stream should be configured via the Serial_Stream driver.\r
- *\r
- * The serial output takes the form "{FILENAME}: Function {FUNCTION NAME}, Line {LINE NUMBER}: Assertion\r
- * {x} failed."\r
- */\r
- #define SERIAL_STREAM_ASSERT(x) MACROS{ if (!(x)) { printf_P(PSTR("%s: Function \"%s\", Line %d: " \\r
- "Assertion \"%s\" failed.\r\n"), \\r
- __FILE__, __func__, __LINE__, #x); \\r
- } }MACROE\r
-\r
- /* Inline Functions: */\r
- /** Function for reliably setting the AVR's system clock prescaler, using inline assembly. This function\r
- * is guaranteed to operate reliably regardless of optimization setting or other compile time options. \r
- *\r
- * \param PrescalerMask The mask of the new prescaler setting for CLKPR\r
- */\r
- static inline void SetSystemClockPrescaler(uint8_t PrescalerMask)\r
- {\r
- uint8_t tmp = (1 << CLKPCE);\r
- __asm__ __volatile__ (\r
- "in __tmp_reg__,__SREG__" "\n\t"\r
- "cli" "\n\t"\r
- "sts %1, %0" "\n\t"\r
- "sts %1, %2" "\n\t"\r
- "out __SREG__, __tmp_reg__"\r
- : /* no outputs */\r
- : "d" (tmp),\r
- "M" (_SFR_MEM_ADDR(CLKPR)),\r
- "d" (PrescalerMask)\r
- : "r0");\r
- }\r
-\r
- /** Function to reverse the individual bits in a byte - i.e. bit 7 is moved to bit 0, bit 6 to bit 1,\r
- * etc.\r
- *\r
- * \param Byte Byte of data whose bits are to be reversed\r
- */\r
- static inline uint8_t BitReverse(uint8_t Byte) ATTR_WARN_UNUSED_RESULT ATTR_CONST;\r
- static inline uint8_t BitReverse(uint8_t Byte)\r
- {\r
- Byte = (((Byte & 0xF0) >> 4) | ((Byte & 0x0F) << 4));\r
- Byte = (((Byte & 0xCC) >> 2) | ((Byte & 0x33) << 2));\r
- Byte = (((Byte & 0xAA) >> 1) | ((Byte & 0x55) << 1));\r
-\r
- return Byte;\r
- }\r
- \r
- /** Function to reverse the byte ordering of the individual bytes in a 16 bit number.\r
- *\r
- * \param Word Word of data whose bytes are to be swapped\r
- */\r
- static inline uint16_t SwapEndian_16(uint16_t Word) ATTR_WARN_UNUSED_RESULT ATTR_CONST;\r
- static inline uint16_t SwapEndian_16(uint16_t Word)\r
- {\r
- return ((Word >> 8) | (Word << 8)); \r
- }\r
-\r
- /** Function to reverse the byte ordering of the individual bytes in a 32 bit number.\r
- *\r
- * \param DWord Double word of data whose bytes are to be swapped\r
- */\r
- static inline uint32_t SwapEndian_32(uint32_t DWord) ATTR_WARN_UNUSED_RESULT ATTR_CONST;\r
- static inline uint32_t SwapEndian_32(uint32_t DWord)\r
- {\r
- return (((DWord & 0xFF000000) >> 24) |\r
- ((DWord & 0x00FF0000) >> 8) |\r
- ((DWord & 0x0000FF00) << 8) |\r
- ((DWord & 0x000000FF) << 24));\r
- }\r
-\r
- /** Function to reverse the byte ordering of the individual bytes in a n byte number.\r
- *\r
- * \param Data Pointer to a number containing an even number of bytes to be reversed\r
- * \param Bytes Length of the data in bytes\r
- */\r
- static inline void SwapEndian_n(uint8_t* Data, uint8_t Bytes);\r
- static inline void SwapEndian_n(uint8_t* Data, uint8_t Bytes)\r
- {\r
- uint8_t Temp;\r
- \r
- while (Bytes)\r
- {\r
- Temp = *Data;\r
- *Data = *(Data + Bytes - 1);\r
- *(Data + Bytes) = Temp;\r
-\r
- Data++;\r
- Bytes -= 2;\r
- }\r
- }\r
-\r
-#endif\r
+/*
+ LUFA Library
+ Copyright (C) Dean Camera, 2011.
+
+ dean [at] fourwalledcubicle [dot] com
+ www.lufa-lib.org
+*/
+
+/*
+ Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+ Permission to use, copy, modify, distribute, and sell this
+ software and its documentation for any purpose is hereby granted
+ without fee, provided that the above copyright notice appear in
+ all copies and that both that the copyright notice and this
+ permission notice and warranty disclaimer appear in supporting
+ documentation, and that the name of the author not be used in
+ advertising or publicity pertaining to distribution of the
+ software without specific, written prior permission.
+
+ The author disclaim all warranties with regard to this
+ software, including all implied warranties of merchantability
+ and fitness. In no event shall the author be liable for any
+ special, indirect or consequential damages or any damages
+ whatsoever resulting from loss of use, data or profits, whether
+ in an action of contract, negligence or other tortious action,
+ arising out of or in connection with the use or performance of
+ this software.
+*/
+
+/** \file
+ * \brief Common library convenience headers, macros and functions.
+ *
+ * \copydetails Group_Common
+ */
+
+/** \defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h
+ * \brief Common library convenience headers, macros and functions.
+ *
+ * Common utility headers containing macros, functions, enums and types which are common to all
+ * aspects of the library.
+ *
+ * @{
+ */
+
+/** \defgroup Group_Debugging Debugging Macros
+ * \brief Convenience macros to aid in debugging applications.
+ *
+ * Macros to aid debugging of a user application.
+ */
+
+#ifndef __LUFA_COMMON_H__
+#define __LUFA_COMMON_H__
+
+ /* Macros: */
+ #define __INCLUDE_FROM_COMMON_H
+
+ /* Includes: */
+ #include <stdint.h>
+ #include <stdbool.h>
+ #include <string.h>
+ #include <stddef.h>
+
+ #include "Architectures.h"
+ #include "Attributes.h"
+ #include "BoardTypes.h"
+
+ /* Architecture specific utility includes: */
+ #if defined(__DOXYGEN__)
+ /** Type define for an unsigned integer the same width as the selected architecture's machine register. */
+ typedef MACHINE_REG_t uint_reg_t;
+ #elif (ARCH == ARCH_AVR8)
+ #include <avr/io.h>
+ #include <avr/interrupt.h>
+ #include <avr/pgmspace.h>
+ #include <avr/eeprom.h>
+ #include <avr/boot.h>
+ #include <util/atomic.h>
+ #include <util/delay.h>
+
+ typedef uint8_t uint_reg_t;
+
+ #define ARCH_LITTLE_ENDIAN
+ #include "Endianness.h"
+ #elif (ARCH == ARCH_UC3)
+ #include <avr32/io.h>
+
+ // === TODO: Find abstracted way to handle these ===
+ #define ISR(Name) void Name (void) __attribute__((__interrupt__)); void Name (void)
+ #define PROGMEM const
+ #define ATOMIC_BLOCK(x) if (1)
+ #define ATOMIC_RESTORESTATE
+ #define pgm_read_byte(x) *x
+ #define _delay_ms(x)
+ #define memcmp_P(...) memcmp(__VA_ARGS__)
+ #define memcpy_P(...) memcpy(__VA_ARGS__)
+ #define USE_RAM_DESCRIPTORS
+ // ==================================================
+
+ typedef uint32_t uint_reg_t;
+
+ #define ARCH_BIG_ENDIAN
+ #include "Endianness.h"
+ #else
+ #error Unknown device architecture specified.
+ #endif
+
+ /* Public Interface - May be used in end-application: */
+ /* Macros: */
+ /** Macro for encasing other multi-statement macros. This should be used along with an opening brace
+ * before the start of any multi-statement macro, so that the macros contents as a whole are treated
+ * as a discrete block and not as a list of separate statements which may cause problems when used as
+ * a block (such as inline \c if statements).
+ */
+ #define MACROS do
+
+ /** Macro for encasing other multi-statement macros. This should be used along with a preceding closing
+ * brace at the end of any multi-statement macro, so that the macros contents as a whole are treated
+ * as a discrete block and not as a list of separate statements which may cause problems when used as
+ * a block (such as inline \c if statements).
+ */
+ #define MACROE while (0)
+
+ /** Convenience macro to determine the larger of two values.
+ *
+ * \note This macro should only be used with operands that do not have side effects from being evaluated
+ * multiple times.
+ *
+ * \param[in] x First value to compare
+ * \param[in] y First value to compare
+ *
+ * \return The larger of the two input parameters
+ */
+ #if !defined(MAX) || defined(__DOXYGEN__)
+ #define MAX(x, y) ((x > y) ? x : y)
+ #endif
+
+ /** Convenience macro to determine the smaller of two values.
+ *
+ * \note This macro should only be used with operands that do not have side effects from being evaluated
+ * multiple times.
+ *
+ * \param[in] x First value to compare
+ * \param[in] y First value to compare
+ *
+ * \return The smaller of the two input parameters
+ */
+ #if !defined(MIN) || defined(__DOXYGEN__)
+ #define MIN(x, y) ((x < y) ? x : y)
+ #endif
+
+ #if (ARCH == ARCH_AVR8) || defined(__DOXYGEN__)
+ /** Defines a volatile \c NOP statement which cannot be optimized out by the compiler, and thus can always
+ * be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimiser
+ * removes/reorders code to the point where break points cannot reliably be set.
+ *
+ * \ingroup Group_Debugging
+ */
+ #define JTAG_DEBUG_POINT() __asm__ __volatile__ ("NOP" ::)
+
+ /** Defines an explicit JTAG break point in the resulting binary via the assembly \c BREAK statement. When
+ * a JTAG is used, this causes the program execution to halt when reached until manually resumed.
+ *
+ * \ingroup Group_Debugging
+ */
+ #define JTAG_DEBUG_BREAK() __asm__ __volatile__ ("BREAK" ::)
+
+ #if !defined(pgm_read_ptr) || defined(__DOXYGEN__)
+ /** Reads a pointer out of PROGMEM space on the AVR8 architecture. This is currently a wrapper for the
+ * avr-libc \c pgm_read_ptr() macro with a \c void* cast, so that its value can be assigned directly
+ * to a pointer variable or used in pointer arithmetic without further casting in C. In a future
+ * avr-libc distribution this will be part of the standard API and will be implemented in a more formal
+ * manner.
+ *
+ * \param[in] Addr Address of the pointer to read.
+ *
+ * \return Pointer retrieved from PROGMEM space.
+ */
+ #define pgm_read_ptr(Addr) (void*)pgm_read_word(Addr)
+ #endif
+
+ /** Macro for testing condition "x" and breaking via \ref JTAG_DEBUG_BREAK() if the condition is false.
+ *
+ * \param[in] Condition Condition that will be evaluated,
+ *
+ * \ingroup Group_Debugging
+ */
+ #define JTAG_DEBUG_ASSERT(Condition) MACROS{ if (!(Condition)) { JTAG_DEBUG_BREAK(); } }MACROE
+
+ /** Macro for testing condition "x" and writing debug data to the stdout stream if \c false. The stdout stream
+ * must be pre-initialized before this macro is run and linked to an output device, such as the microcontroller's
+ * USART peripheral.
+ *
+ * The output takes the form "{FILENAME}: Function {FUNCTION NAME}, Line {LINE NUMBER}: Assertion {Condition} failed."
+ *
+ * \param[in] Condition Condition that will be evaluated,
+ *
+ * \ingroup Group_Debugging
+ */
+ #define STDOUT_ASSERT(Condition) MACROS{ if (!(x)) { printf_P(PSTR("%s: Function \"%s\", Line %d: " \
+ "Assertion \"%s\" failed.\r\n"), \
+ __FILE__, __func__, __LINE__, #Condition); } }MACROE
+ #endif
+
+ /** Forces GCC to use pointer indirection (via the device's pointer register pairs) when accessing the given
+ * struct pointer. In some cases GCC will emit non-optimal assembly code when accessing a structure through
+ * a pointer, resulting in a larger binary. When this macro is used on a (non \c const) structure pointer before
+ * use, it will force GCC to use pointer indirection on the elements rather than direct store and load
+ * instructions.
+ *
+ * \param[in, out] StructPtr Pointer to a structure which is to be forced into indirect access mode.
+ */
+ #define GCC_FORCE_POINTER_ACCESS(StructPtr) __asm__ __volatile__("" : "=b" (StructPtr) : "0" (StructPtr))
+
+ /** Forces GCC to create a memory barrier, ensuring that memory accesses are not reordered past the barrier point.
+ * This can be used before ordering-critical operations, to ensure that the compiler does not re-order the resulting
+ * assembly output in an unexpected manner on sections of code that are ordering-specific.
+ */
+ #define GCC_MEMORY_BARRIER() __asm__ __volatile__("" ::: "memory");
+
+ /* Inline Functions: */
+ /** Function to reverse the individual bits in a byte - i.e. bit 7 is moved to bit 0, bit 6 to bit 1,
+ * etc.
+ *
+ * \param[in] Byte Byte of data whose bits are to be reversed.
+ */
+ static inline uint8_t BitReverse(uint8_t Byte) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
+ static inline uint8_t BitReverse(uint8_t Byte)
+ {
+ Byte = (((Byte & 0xF0) >> 4) | ((Byte & 0x0F) << 4));
+ Byte = (((Byte & 0xCC) >> 2) | ((Byte & 0x33) << 2));
+ Byte = (((Byte & 0xAA) >> 1) | ((Byte & 0x55) << 1));
+
+ return Byte;
+ }
+
+#endif
+
+/** @} */
+
projects / pub / USBasp.git / blobdiff