diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2011-02-20 14:43:13 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2011-02-20 14:43:13 +0000 |
| commit | f3ec62b5c689d9c66b07a57df76ca83881ce3fe3 (patch) | |
| tree | f9ccd1810692daf4839b1bf38de33263a370be1f /LUFA/Common | |
| parent | 28a1ee29a1a200c8e8c76355a9036a7456425bc3 (diff) | |
| download | lufa-f3ec62b5c689d9c66b07a57df76ca83881ce3fe3.tar.gz lufa-f3ec62b5c689d9c66b07a57df76ca83881ce3fe3.tar.bz2 lufa-f3ec62b5c689d9c66b07a57df76ca83881ce3fe3.zip | |
More updates to remove architecture-specific comments from the documentation, alter USBMode.h preprocessor logic to support future architectures more easily.
Diffstat (limited to 'LUFA/Common')
| -rw-r--r-- | LUFA/Common/Attributes.h | 4 | ||||
| -rw-r--r-- | LUFA/Common/Common.h | 15 |
2 files changed, 10 insertions, 9 deletions
diff --git a/LUFA/Common/Attributes.h b/LUFA/Common/Attributes.h index ad6882769..8c4006990 100644 --- a/LUFA/Common/Attributes.h +++ b/LUFA/Common/Attributes.h @@ -29,7 +29,7 @@ */ /** \file - * \brief AVR-GCC special function/variable attribute macros. + * \brief GCC special function/variable attribute macros. * * \copydetails Group_GCCAttributes * @@ -39,7 +39,7 @@ /** \ingroup Group_Common * \defgroup Group_GCCAttributes Function/Variable Attributes - * \brief AVR-GCC special function/variable attribute macros. + * \brief GCC special function/variable attribute macros. * * This module contains macros for applying GCC specific attributes to functions and variables to control various * optimiser and code generation features of the compiler. Attributes may be placed in the function prototype diff --git a/LUFA/Common/Common.h b/LUFA/Common/Common.h index 57bebeda4..114f566b2 100644 --- a/LUFA/Common/Common.h +++ b/LUFA/Common/Common.h @@ -144,10 +144,11 @@ #define JTAG_DEBUG_BREAK() __asm__ __volatile__ ("BREAK" ::) #if !defined(pgm_read_ptr) || defined(__DOXYGEN__) - /** Reads a pointer out of PROGMEM space. 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. + /** 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. * @@ -165,8 +166,8 @@ #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 AVR's USART - * peripheral. + * 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." * @@ -179,7 +180,7 @@ __FILE__, __func__, __LINE__, #Condition); } }MACROE #endif - /** Forces GCC to use pointer indirection (via the AVR's pointer register pairs) when accessing the given + /** 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 |