mirror of
https://github.com/qmk/qmk_firmware.git
synced 2025-07-16 12:51:47 +00:00
Pull out architecture specific macros and other definitions into a new common header file. Add new JTAG_DISABLE() macro for the AVR8s to software-disable JTAG debugging using cycle-safe assembly code.
This commit is contained in:
parent
3478178127
commit
fc5fa769ef
File diff suppressed because one or more lines are too long
143
LUFA/Common/ArchitectureSpecific.h
Normal file
143
LUFA/Common/ArchitectureSpecific.h
Normal file
@ -0,0 +1,143 @@
|
|||||||
|
/*
|
||||||
|
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 Architecture specific definitions relating to specific processor architectures.
|
||||||
|
*
|
||||||
|
* \copydetails Group_ArchitectureSpecific
|
||||||
|
*
|
||||||
|
* \note Do not include this file directly, rather include the Common.h header file instead to gain this file's
|
||||||
|
* functionality.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/** \ingroup Group_Common
|
||||||
|
* \defgroup Group_ArchitectureSpecific Architecture Specific Definitions
|
||||||
|
* \brief Architecture specific definitions relating to specific processor architectures.
|
||||||
|
*
|
||||||
|
* 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.
|
||||||
|
*
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef __LUFA_ARCHSPEC_H__
|
||||||
|
#define __LUFA_ARCHSPEC_H__
|
||||||
|
|
||||||
|
/* Preprocessor Checks: */
|
||||||
|
#if !defined(__INCLUDE_FROM_COMMON_H)
|
||||||
|
#error Do not include this file directly. Include LUFA/Common/Common.h instead to gain this functionality.
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/* Public Interface - May be used in end-application: */
|
||||||
|
/* Macros: */
|
||||||
|
#if (ARCH == ARCH_AVR8) || defined(__DOXYGEN__)
|
||||||
|
/** 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_DISABLE() MACROS{ \
|
||||||
|
__asm__ __volatile__ ( \
|
||||||
|
"in __tmp_reg__,__SREG__" "\n\t" \
|
||||||
|
"cli" "\n\t" \
|
||||||
|
"out %1, %0" "\n\t" \
|
||||||
|
"out __SREG__, __tmp_reg__" "\n\t" \
|
||||||
|
"out %1, %0" "\n\t" \
|
||||||
|
: \
|
||||||
|
: "r" (1 << JTD), \
|
||||||
|
"M" (_SFR_IO_ADDR(MCUCR)) \
|
||||||
|
: "r0"); \
|
||||||
|
}MACROE
|
||||||
|
|
||||||
|
/** 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 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_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.
|
||||||
|
*
|
||||||
|
* \note This macro is not available for all architectures.
|
||||||
|
*/
|
||||||
|
#define JTAG_DEBUG_BREAK() __asm__ __volatile__ ("BREAK" ::)
|
||||||
|
|
||||||
|
/** Macro for testing condition "x" and breaking via \ref JTAG_DEBUG_BREAK() if the condition is false.
|
||||||
|
*
|
||||||
|
* \note This macro is not available for all architectures.
|
||||||
|
*
|
||||||
|
* \param[in] Condition Condition that will be evaluated.
|
||||||
|
*/
|
||||||
|
#define JTAG_DEBUG_ASSERT(Condition) MACROS{ if (!(Condition)) { JTAG_DEBUG_BREAK(); } }MACROE
|
||||||
|
|
||||||
|
/** Macro for testing condition \c "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."
|
||||||
|
*
|
||||||
|
* \note This macro is not available for all architectures.
|
||||||
|
*
|
||||||
|
* \param[in] Condition Condition that will be evaluated,
|
||||||
|
*/
|
||||||
|
#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
|
||||||
|
|
||||||
|
#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.
|
||||||
|
*
|
||||||
|
* \note This macro is not available for all architectures.
|
||||||
|
*
|
||||||
|
* \param[in] Address Address of the pointer to read.
|
||||||
|
*
|
||||||
|
* \return Pointer retrieved from PROGMEM space.
|
||||||
|
*/
|
||||||
|
#define pgm_read_ptr(Address) (void*)pgm_read_word(Address)
|
||||||
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/* Disable C linkage for C++ Compilers: */
|
||||||
|
#if defined(__cplusplus)
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/** @} */
|
||||||
|
|
@ -42,12 +42,6 @@
|
|||||||
*
|
*
|
||||||
* @{
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** \defgroup Group_Debugging Debugging Macros
|
|
||||||
* \brief Convenience macros to aid in debugging applications.
|
|
||||||
*
|
|
||||||
* Macros to aid debugging of a user application.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/** \defgroup Group_GlobalInt Global Interrupt Macros
|
/** \defgroup Group_GlobalInt Global Interrupt Macros
|
||||||
* \brief Convenience macros for the management of interrupts globally within the device.
|
* \brief Convenience macros for the management of interrupts globally within the device.
|
||||||
@ -71,6 +65,7 @@
|
|||||||
#include "LUFAConfig.h"
|
#include "LUFAConfig.h"
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
#include "ArchitectureSpecific.h"
|
||||||
#include "CompilerSpecific.h"
|
#include "CompilerSpecific.h"
|
||||||
#include "Architectures.h"
|
#include "Architectures.h"
|
||||||
#include "Attributes.h"
|
#include "Attributes.h"
|
||||||
@ -202,69 +197,6 @@
|
|||||||
#define STRINGIFY_EXPANDED(x) STRINGIFY(x)
|
#define STRINGIFY_EXPANDED(x) STRINGIFY(x)
|
||||||
#endif
|
#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 optimizer
|
|
||||||
* removes/reorders code to the point where break points cannot reliably be set.
|
|
||||||
*
|
|
||||||
* \note This macro is not available for all architectures.
|
|
||||||
*
|
|
||||||
* \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.
|
|
||||||
*
|
|
||||||
* \note This macro is not available for all architectures.
|
|
||||||
*
|
|
||||||
* \ingroup Group_Debugging
|
|
||||||
*/
|
|
||||||
#define JTAG_DEBUG_BREAK() __asm__ __volatile__ ("BREAK" ::)
|
|
||||||
|
|
||||||
/** Macro for testing condition "x" and breaking via \ref JTAG_DEBUG_BREAK() if the condition is false.
|
|
||||||
*
|
|
||||||
* \note This macro is not available for all architectures.
|
|
||||||
*
|
|
||||||
* \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."
|
|
||||||
*
|
|
||||||
* \note This macro is not available for all architectures.
|
|
||||||
*
|
|
||||||
* \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
|
|
||||||
|
|
||||||
#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.
|
|
||||||
*
|
|
||||||
* \note This macro is not available for all architectures.
|
|
||||||
*
|
|
||||||
* \param[in] Address Address of the pointer to read.
|
|
||||||
*
|
|
||||||
* \return Pointer retrieved from PROGMEM space.
|
|
||||||
*/
|
|
||||||
#define pgm_read_ptr(Address) (void*)pgm_read_word(Address)
|
|
||||||
#endif
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#if !defined(ISR) || defined(__DOXYGEN__)
|
#if !defined(ISR) || defined(__DOXYGEN__)
|
||||||
/** Macro for the definition of interrupt service routines, so that the compiler can insert the required
|
/** Macro for the definition of interrupt service routines, so that the compiler can insert the required
|
||||||
* prologue and epilogue code to properly manage the interrupt routine without affecting the main thread's
|
* prologue and epilogue code to properly manage the interrupt routine without affecting the main thread's
|
||||||
|
@ -29,7 +29,7 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/** \file
|
/** \file
|
||||||
* \brief Compiler specific macros for code optimization and correctness.
|
* \brief Compiler specific definitions for code optimization and correctness.
|
||||||
*
|
*
|
||||||
* \copydetails Group_CompilerSpecific
|
* \copydetails Group_CompilerSpecific
|
||||||
*
|
*
|
||||||
@ -38,10 +38,10 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/** \ingroup Group_Common
|
/** \ingroup Group_Common
|
||||||
* \defgroup Group_CompilerSpecific Compiler Specific Macros
|
* \defgroup Group_CompilerSpecific Compiler Specific Definitions
|
||||||
* \brief Compiler specific macros for code optimization and correctness.
|
* \brief Compiler specific definitions for code optimization and correctness.
|
||||||
*
|
*
|
||||||
* Compiler specific macros to expose certain compiler features which may increase the level of code optimization
|
* Compiler specific definitions to expose certain compiler features which may increase the level of code optimization
|
||||||
* for a specific compiler, or correct certain issues that may be present such as memory barriers for use in conjunction
|
* for a specific compiler, or correct certain issues that may be present such as memory barriers for use in conjunction
|
||||||
* with atomic variable access.
|
* with atomic variable access.
|
||||||
*
|
*
|
||||||
|
@ -28,6 +28,7 @@
|
|||||||
* - Added new USB_Host_GetDeviceStatus() function to the host standard request function set
|
* - Added new USB_Host_GetDeviceStatus() function to the host standard request function set
|
||||||
* - Added AVR USB XMEGA architecture port (currently incomplete/experimental)
|
* - Added AVR USB XMEGA architecture port (currently incomplete/experimental)
|
||||||
* - Added new STRINGIFY() and STRINGIFY_EXPANDED() convenience macros
|
* - Added new STRINGIFY() and STRINGIFY_EXPANDED() convenience macros
|
||||||
|
* - Added new JTAG_DISABLE() macro for the AVR8 architecture
|
||||||
* - Added Device Qualifier standard descriptor structure definitions USB_StdDescriptor_DeviceQualifier_t and USB_Descriptor_DeviceQualifier_t
|
* - Added Device Qualifier standard descriptor structure definitions USB_StdDescriptor_DeviceQualifier_t and USB_Descriptor_DeviceQualifier_t
|
||||||
* - Library Applications:
|
* - Library Applications:
|
||||||
* - Added RNDIS device mode to the Webserver project
|
* - Added RNDIS device mode to the Webserver project
|
||||||
|
@ -270,7 +270,8 @@
|
|||||||
* <td>VTARGET_USE_INTERNAL_REF</td>
|
* <td>VTARGET_USE_INTERNAL_REF</td>
|
||||||
* <td>Makefile LUFA_OPTS</td>
|
* <td>Makefile LUFA_OPTS</td>
|
||||||
* <td>Selects the internal 2.56V ADC reference voltage, instead of using the AVR's VREF pin. When enabled, this option will
|
* <td>Selects the internal 2.56V ADC reference voltage, instead of using the AVR's VREF pin. When enabled, this option will
|
||||||
* override the VTARGET_REF_VOLTS configuration option.</i></td>
|
* override the VTARGET_REF_VOLTS configuration option. <i>Ignored when compiled for targets lacking an ADC, or when
|
||||||
|
* NO_VTARGET_DETECT is defined.</i></td>
|
||||||
* </tr>
|
* </tr>
|
||||||
* <tr>
|
* <tr>
|
||||||
* <td>VTARGET_SCALE_FACTOR</td>
|
* <td>VTARGET_SCALE_FACTOR</td>
|
||||||
|
Loading…
Reference in New Issue
Block a user