- * To use a LUFA build system module, simply add an include to your project makefile. All user projects\r
- * should at a minimum include \ref Page_BuildModule_CORE for base functionality:\r
- * \code\r
- * include $(LUFA_PATH)/Build/lufa_core.mk\r
- * \endcode\r
- *\r
- * Once included in your project makefile, the associated build module targets will be added to your\r
- * project's build makefile targets automatically. To call a build target, run <tt>make {TARGET_NAME}</tt>\r
- * from the command line, substituting in the appropriate target name.\r
- *\r
- * \see \ref Sec_ConfiguringApps_AppMakefileParams for a copy of the sample LUFA project makefile.\r
- *\r
- * Each build module may have one or more mandatory parameters (GNU Make variables) which <i>must</i>\r
- * be supplied in the project makefile for the module to work, and one or more optional parameters which\r
- * may be defined and which will assume a sensible default if not.\r
- *\r
- * \section SSec_BuildSystem_Modules Available Modules\r
- *\r
- * The following modules are included in this LUFA release:\r
- *\r
- * \li \subpage Page_BuildModule_ATPROGRAM - Device Programming\r
- * \li \subpage Page_BuildModule_AVRDUDE - Device Programming\r
- * \li \subpage Page_BuildModule_BUILD - Compiling/Assembling/Linking\r
- * \li \subpage Page_BuildModule_CORE - Core Build System Functions\r
- * \li \subpage Page_BuildModule_CPPCHECK - Static Code Analysis\r
- * \li \subpage Page_BuildModule_DFU - Device Programming\r
- * \li \subpage Page_BuildModule_DOXYGEN - Automated Source Code Documentation\r
- * \li \subpage Page_BuildModule_HID - Device Programming\r
- * \li \subpage Page_BuildModule_SOURCES - LUFA Module Source Code Variables\r
- *\r
- * If you have problems building using the LUFA build system, see \subpage Page_BuildTroubleshooting for resolution steps.\r
- */\r
-\r
- /** \page Page_BuildModule_BUILD The BUILD build module\r
- *\r
- * The BUILD LUFA build system module, providing targets for the compilation,\r
- * assembling and linking of an application from source code into binary files\r
- * suitable for programming into a target device, using the GCC compiler.\r
- *\r
- * To use this module in your application makefile, add the following code:\r
- * \code\r
- * include $(LUFA_PATH)/Build/lufa_build.mk\r
- * \endcode\r
- *\r
- * \section SSec_BuildModule_BUILD_Requirements Requirements\r
- * This module requires the the architecture appropriate binaries of the GCC compiler are available in your\r
- * system's <b>PATH</b> variable. The GCC compiler and associated toolchain is distributed in Atmel AVR Studio\r
- * 5.x and Atmel Studio 6.x installation directories, as well as in many third party distribution packages.\r
- *\r
- * \section SSec_BuildModule_BUILD_Targets Targets\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><tt>size</tt></td>\r
- * <td>Display size of the compiled application FLASH and SRAM segments.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>symbol-sizes</tt></td>\r
- * <td>Display a size-sorted list of symbols from the compiled application, in decimal bytes.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>lib</tt></td>\r
- * <td>Build and archive all source files into a library A binary file.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>all</tt></td>\r
- * <td>Build and link the application into ELF debug and HEX binary files.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>elf</tt></td>\r
- * <td>Build and link the application into an ELF debug file.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>bin</tt></td>\r
- * <td>Build and link the application and produce a BIN binary file.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>hex</tt></td>\r
- * <td>Build and link the application and produce HEX and EEP binary files.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>lss</tt></td>\r
- * <td>Build and link the application and produce a LSS source code/assembly code mixed listing file.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>clean</tt></td>\r
- * <td>Remove all intermediary files and binary output files.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>mostlyclean</tt></td>\r
- * <td>Remove all intermediary files but preserve any binary output files.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt><i><filename></i>.s</tt></td>\r
- * <td>Create an assembly listing of a given input C/C++ source file.</td>\r
- * </tr>\r
- * </table>\r
- *\r
- * \section SSec_BuildModule_BUILD_MandatoryParams Mandatory Parameters\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><tt>TARGET</tt></td>\r
- * <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>ARCH</tt></td>\r
- * <td>Architecture of the target processor (see \ref Page_DeviceSupport).</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>MCU</tt></td>\r
- * <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>SRC</tt></td>\r
- * <td>List of relative or absolute paths to the application C (.c), C++ (.cpp) and Assembly (.S) source files.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>F_USB</tt></td>\r
- * <td>Speed in Hz of the input clock frequency to the target's USB controller.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>LUFA_PATH</tt></td>\r
- * <td>Path to the LUFA library core, either relative or absolute (e.g. <tt>../LUFA-000000/LUFA/</tt>).</td>\r
- * </tr>\r
- * </table>\r
- *\r
- * \section SSec_BuildModule_BUILD_OptionalParams Optional Parameters\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><tt>BOARD</tt></td>\r
- * <td>LUFA board hardware drivers to use (see \ref Page_DeviceSupport).</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>OPTIMIZATION</tt></td>\r
- * <td>Optimization level to use when compiling source files (see GCC manual).</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>C_STANDARD</tt></td>\r
- * <td>Version of the C standard to apply when compiling C++ source files (see GCC manual).</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>CPP_STANDARD</tt></td>\r
- * <td>Version of the C++ standard to apply when compiling C++ source files (see GCC manual).</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>DEBUG_FORMAT</tt></td>\r
- * <td>Format of the debug information to embed in the generated object files (see GCC manual).</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>DEBUG_LEVEL</tt></td>\r
- * <td>Level of the debugging information to embed in the generated object files (see GCC manual).</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>F_CPU</tt></td>\r
- * <td>Speed of the processor CPU clock, in Hz.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>C_FLAGS</tt></td>\r
- * <td>Flags to pass to the C compiler only, after the automatically generated flags.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>CPP_FLAGS</tt></td>\r
- * <td>Flags to pass to the C++ compiler only, after the automatically generated flags.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>ASM_FLAGS</tt></td>\r
- * <td>Flags to pass to the assembler only, after the automatically generated flags.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>CC_FLAGS</tt></td>\r
- * <td>Common flags to pass to the C/C++ compiler and assembler, after the automatically generated flags.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>COMPILER_PATH</tt></td>\r
- * <td>Directory where the C/C++ toolchain is located, if not available in the system <tt>PATH</tt>.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>LD_FLAGS</tt></td>\r
- * <td>Flags to pass to the linker, after the automatically generated flags.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>LINKER_RELAXATIONS</tt></td>\r
- * <td>Enables or disables linker relaxations when linking the application binary. This can reduce the total size\r
- * of the application by replacing full \c CALL instructions with smaller \c RCALL instructions where possible.\r
- * \note On some unpatched versions of binutils, this can cause link failures in some circumstances. If you\r
- * receive a link error <tt>relocation truncated to fit: R_AVR_13_PCREL</tt>, disable this setting.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>OBJDIR</tt></td>\r
- * <td>Directory to place the generated object and dependency files. If set to "." the same folder as the source file will be used.\r
- * \note When this option is enabled, all source filenames <b>must</b> be unique.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>OBJECT_FILES</tt></td>\r
- * <td>List of additional object files that should be linked into the resulting binary.</td>\r
- * </tr>\r
- * </table>\r
- *\r
- * \section SSec_BuildModule_BUILD_ProvidedVariables Module Provided Variables\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><i>None</i></td>\r
- * </tr>\r
- * </table>\r
- *\r
- * \section SSec_BuildModule_BUILD_ProvidedMacros Module Provided Macros\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><i>None</i></td>\r
- * </tr>\r
- * </table>\r
- */\r
-\r
-/** \page Page_BuildModule_CORE The CORE build module\r
- *\r
- * The core LUFA build system module, providing common build system help and information targets.\r
- *\r
- * To use this module in your application makefile, add the following code:\r
- * \code\r
- * include $(LUFA_PATH)/Build/lufa_core.mk\r
- * \endcode\r
- *\r
- * \section SSec_BuildModule_CORE_Requirements Requirements\r
- * This module has no requirements outside a standard *nix shell like environment; the <tt>sh</tt>\r
- * shell, GNU <tt>make</tt> and *nix CoreUtils (<tt>echo</tt>, <tt>printf</tt>, etc.).\r
- *\r
- * \section SSec_BuildModule_CORE_Targets Targets\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><tt>help</tt></td>\r
- * <td>Display build system help and configuration information.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>list_targets</tt></td>\r
- * <td>List all available build targets from the build system.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>list_modules</tt></td>\r
- * <td>List all available build modules from the build system.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>list_mandatory</tt></td>\r
- * <td>List all mandatory parameters required by the included modules.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>list_optional</tt></td>\r
- * <td>List all optional parameters required by the included modules.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>list_provided</tt></td>\r
- * <td>List all variables provided by the included modules.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>list_macros</tt></td>\r
- * <td>List all macros provided by the included modules.</td>\r
- * </tr>\r
- * </table>\r
- *\r
- * \section SSec_BuildModule_CORE_MandatoryParams Mandatory Parameters\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><i>None</i></td>\r
- * </tr>\r
- * </table>\r
- *\r
- * \section SSec_BuildModule_CORE_OptionalParams Optional Parameters\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><i>None</i></td>\r
- * </tr>\r
- * </table>\r
- *\r
- * \section SSec_BuildModule_CORE_ProvidedVariables Module Provided Variables\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><i>None</i></td>\r
- * </tr>\r
- * </table>\r
- *\r
- * \section SSec_BuildModule_CORE_ProvidedMacros Module Provided Macros\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><i>None</i></td>\r
- * </tr>\r
- * </table>\r
- */\r
-\r
-/** \page Page_BuildModule_ATPROGRAM The ATPROGRAM build module\r
- *\r
- * The ATPROGRAM programming utility LUFA build system module, providing targets to reprogram an\r
- * Atmel processor FLASH and EEPROM memories with a project's compiled binary output files.\r
- *\r
- * To use this module in your application makefile, add the following code:\r
- * \code\r
- * include $(LUFA_PATH)/Build/lufa_atprogram.mk\r
- * \endcode\r
- *\r
- * \section SSec_BuildModule_ATPROGRAM_Requirements Requirements\r
- * This module requires the <tt>atprogram.exe</tt> utility to be available in your system's <b>PATH</b>\r
- * variable. The <tt>atprogram.exe</tt> utility is distributed in Atmel AVR Studio 5.x and Atmel Studio 6.x\r
- * inside the application install folder's "\atbackend" subdirectory.\r
- *\r
- * \section SSec_BuildModule_ATPROGRAM_Targets Targets\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><tt>atprogram</tt></td>\r
- * <td>Program the device FLASH memory with the application's executable data.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>atprogram-ee</tt></td>\r
- * <td>Program the device EEPROM memory with the application's EEPROM data.</td>\r
- * </tr>\r
- * </table>\r
- *\r
- * \section SSec_BuildModule_ATPROGRAM_MandatoryParams Mandatory Parameters\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><tt>MCU</tt></td>\r
- * <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>TARGET</tt></td>\r
- * <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>\r
- * </tr>\r
- * </table>\r
- *\r
- * \section SSec_BuildModule_ATPROGRAM_OptionalParams Optional Parameters\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><tt>ATPROGRAM_PROGRAMMER</tt></td>\r
- * <td>Name of the Atmel programmer or debugger tool to communicate with (e.g. <tt>jtagice3</tt>).</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>ATPROGRAM_INTERFACE</tt></td>\r
- * <td>Name of the programming interface to use when programming the target (e.g. <tt>spi</tt>).</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>ATPROGRAM_PORT</tt></td>\r
- * <td>Name of the communication port to use when when programming with a serially connected tool (e.g. <tt>COM2</tt>).</td>\r
- * </tr>\r
- * </table>\r
- *\r
- * \section SSec_BuildModule_ATPROGRAM_ProvidedVariables Module Provided Variables\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><i>None</i></td>\r
- * </tr>\r
- * </table>\r
- *\r
- * \section SSec_BuildModule_ATPROGRAM_ProvidedMacros Module Provided Macros\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><i>None</i></td>\r
- * </tr>\r
- * </table>\r
- */\r
-\r
-/** \page Page_BuildModule_AVRDUDE The AVRDUDE build module\r
- *\r
- * The AVRDUDE programming utility LUFA build system module, providing targets to reprogram an\r
- * Atmel processor FLASH and EEPROM memories with a project's compiled binary output files.\r
- *\r
- * To use this module in your application makefile, add the following code:\r
- * \code\r
- * include $(LUFA_PATH)/Build/lufa_avrdude.mk\r
- * \endcode\r
- *\r
- * \section SSec_BuildModule_AVRDUDE_Requirements Requirements\r
- * This module requires the <tt>avrdude</tt> utility to be available in your system's <b>PATH</b>\r
- * variable. The <tt>avrdude</tt> utility is distributed in the old WinAVR project releases for\r
- * Windows (<a>http://winavr.sourceforge.net</a>) or can be installed on *nix systems via the project's\r
- * source code (<a>https://savannah.nongnu.org/projects/avrdude</a>) or through the package manager.\r
- *\r
- * \section SSec_BuildModule_AVRDUDE_Targets Targets\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><tt>avrdude</tt></td>\r
- * <td>Program the device FLASH memory with the application's executable data.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>avrdude-ee</tt></td>\r
- * <td>Program the device EEPROM memory with the application's EEPROM data.</td>\r
- * </tr>\r
- * </table>\r
- *\r
- * \section SSec_BuildModule_AVRDUDE_MandatoryParams Mandatory Parameters\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><tt>MCU</tt></td>\r
- * <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>TARGET</tt></td>\r
- * <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>\r
- * </tr>\r
- * </table>\r
- *\r
- * \section SSec_BuildModule_AVRDUDE_OptionalParams Optional Parameters\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><tt>AVRDUDE_PROGRAMMER</tt></td>\r
- * <td>Name of the programmer or debugger tool to communicate with (e.g. <tt>jtagicemkii</tt>).</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>AVRDUDE_PORT</tt></td>\r
- * <td>Name of the communication port to use when when programming with the connected tool (e.g. <tt>COM2</tt>, <tt>/dev/ttyUSB0</tt> or <tt>usb</tt>).</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>AVRDUDE_FLAGS</tt></td>\r
- * <td>Additional flags to pass to avrdude when programming, applied after the automatically generated flags.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>AVRDUDE_MEMORY</tt></td>\r
- * <td>Main memory space used when programming in an application *e.g. <tt>application</tt> for a DFU bootloader, or <tt>flash</tt> for a regular programmer).</td>\r
- * </tr>\r
- * </table>\r
- *\r
- * \section SSec_BuildModule_AVRDUDE_ProvidedVariables Module Provided Variables\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><i>None</i></td>\r
- * </tr>\r
- * </table>\r
- *\r
- * \section SSec_BuildModule_AVRDUDE_ProvidedMacros Module Provided Macros\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><i>None</i></td>\r
- * </tr>\r
- * </table>\r
- */\r
-\r
- /** \page Page_BuildModule_CPPCHECK The CPPCHECK build module\r
- *\r
- * The CPPCHECK programming utility LUFA build system module, providing targets to statically\r
- * analyze C and C++ source code for errors and performance/style issues.\r
- *\r
- * To use this module in your application makefile, add the following code:\r
- * \code\r
- * include $(LUFA_PATH)/Build/lufa_cppcheck.mk\r
- * \endcode\r
- *\r
- * \section SSec_BuildModule_CPPCHECK_Requirements Requirements\r
- * This module requires the <tt>cppcheck</tt> utility to be available in your system's <b>PATH</b>\r
- * variable. The <tt>cppcheck</tt> utility is distributed through the project's home page\r
- * (<a>http://cppcheck.sourceforge.net</a>) for Windows, and can be installed on *nix systems via\r
- * the project's source code or through the package manager.\r
- *\r
- * \section SSec_BuildModule_CPPCHECK_Targets Targets\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><tt>cppcheck</tt></td>\r
- * <td>Statically analyze the project source code for issues.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>cppcheck-config</tt></td>\r
- * <td>Check the <tt>cppcheck</tt> configuration - scan source code and warn about missing header files and other issues.</td>\r
- * </tr>\r
- * </table>\r
- *\r
- * \section SSec_BuildModule_CPPCHECK_MandatoryParams Mandatory Parameters\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><tt>SRC</tt></td>\r
- * <td>List of source files to statically analyze.</td>\r
- * </tr>\r
- * </table>\r
- *\r
- * \section SSec_BuildModule_CPPCHECK_OptionalParams Optional Parameters\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><tt>CPPCHECK_INCLUDES</tt></td>\r
- * <td>Path of extra directories to check when attemting to resolve C/C++ header file includes.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>CPPCHECK_EXCLUDES</tt></td>\r
- * <td>Paths or path fragments to exclude when analyzing.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>CPPCHECK_MSG_TEMPLATE</tt></td>\r
- * <td>Output message template to use when printing errors, warnings and information (see <tt>cppcheck</tt> documentation).</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>CPPCHECK_ENABLE</tt></td>\r
- * <td>Analysis rule categories to enable (see <tt>cppcheck</tt> documentation).</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>CPPCHECK_SUPPRESS</tt></td>\r
- * <td>Specific analysis rules to suppress (see <tt>cppcheck</tt> documentation).</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>CPPCHECK_FAIL_ON_WARNING</tt></td>\r
- * <td>Set to <b>Y</b> to fail the analysis job with an error exit code if warnings are found, <b>N</b> to continue without failing.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>CPPCHECK_QUIET</tt></td>\r
- * <td>Set to <b>Y</b> to suppress all output except warnings and errors, <b>N</b> to show verbose output information.</td>\r
- * </tr>\r
- * <tr>\r
- * <td><tt>CPPCHECK_FLAGS</tt></td>\r
- * <td>Extra flags to pass to <tt>cppcheck</tt>, after the automatically generated flags.</td>\r
- * </tr>\r
- * </table>\r
- *\r
- * \section SSec_BuildModule_CPPCHECK_ProvidedVariables Module Provided Variables\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><i>None</i></td>\r
- * </tr>\r
- * </table>\r
- *\r
- * \section SSec_BuildModule_CPPCHECK_ProvidedMacros Module Provided Macros\r
- *\r
- * <table>\r
- * <tr>\r
- * <td><i>None</i></td>\r
- * </tr>\r
- * </table>\r
projects / pub / USBasp.git / commitdiff
