| LUFA Library 140302 |

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Macros
Architecture Specific Definitions
Common Utility Headers - LUFA/Drivers/Common/Common.h

Architecture specific definitions relating to specific processor architectures. More...

## Macros
#define | JTAG_ASSERT(Condition) MACROS{ if (!(Condition)) { JTAG_DEBUG_BREAK(); } }MACROE
#define | JTAG_DEBUG_BREAK() __asm__ __volatile__ ("break" ::)
#define | JTAG_DEBUG_POINT() __asm__ __volatile__ ("nop" ::)
#define | JTAG_DISABLE()
#define | JTAG_ENABLE()
#define | pgm_read_ptr(Address) (void*)pgm_read_word(Address)
#define | STDOUT_ASSERT(Condition)

## Detailed Description

Architecture specific macros, functions and other definitions, which relate to specific architectures. This definitions may or may not be available in some form on other architectures, and thus should be protected by preprocessor checks in portable code to prevent compile errors.

## Macro Definition Documentation

#define JTAG_ASSERT | ( |  | Condition | ) | MACROS{ if (!(Condition)) { JTAG_DEBUG_BREAK(); } }MACROE

Macro for testing condition "x" and breaking via JTAG_DEBUG_BREAK() if the condition is false.

Note
  This macro is not available for all architectures.

Parameters

  [in] | Condition | Condition that will be evaluated.

#define JTAG_DEBUG_BREAK | ( |  | ) | __asm__ __volatile__ ("break" ::)

Defines an explicit JTAG break point in the resulting binary via the assembly `BREAK` statement. When a JTAG is used, this causes the program execution to halt when reached until manually resumed.

Note
  This macro is not available for all architectures.

#define JTAG_DEBUG_POINT | ( |  | ) | __asm__ __volatile__ ("nop" ::)

Defines a volatile `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 optimizer removes/reorders code to the point where break points cannot reliably be set.

Note
  This macro is not available for all architectures.

#define JTAG_DISABLE | ( |  | ) |

Disables the AVR's JTAG bus in software, until a system reset. This will override the current JTAG status as set by the JTAGEN fuse, disabling JTAG debugging and reverting the JTAG pins back to GPIO mode.

Note
  This macro is not available for all architectures.

#define JTAG_ENABLE | ( |  | ) |

Re-enables the AVR's JTAG bus in software, until a system reset. This will re-enable JTAG debugging interface after is has been disabled in software via JTAG_DISABLE().

Note
  This macro is not available for all architectures.

#define pgm_read_ptr | ( |  | Address | ) | (void*)pgm_read_word(Address)

Reads a pointer out of PROGMEM space on the AVR8 architecture. This is currently a wrapper for the avr-libc `pgm_read_word()` macro with a `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.

Note
  This macro is not available for all architectures.

Parameters

  [in] | Address | Address of the pointer to read.

Returns
  Pointer retrieved from PROGMEM space.

#define STDOUT_ASSERT | ( |  | Condition | ) |

Macro for testing condition `"x"` and writing debug data to the stdout stream if `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."

Note
  This macro is not available for all architectures.

Parameters

  [in] | Condition | Condition that will be evaluated,