Add MS OS Compatibility descriptors to RNDIS demos for driverless install on Windows.

[pub/USBasp.git] / LUFA / DoxygenPages / BuildSystem.txt

diff --git a/LUFA/DoxygenPages/BuildSystem.txt b/LUFA/DoxygenPages/BuildSystem.txt
index fe29aeb..ef57fcf 100644 (file)
--- a/LUFA/DoxygenPages/BuildSystem.txt
+++ b/LUFA/DoxygenPages/BuildSystem.txt
@@ -6,252 +6,107 @@
 \r
 /** \page Page_BuildSystem The LUFA Build System\r
  *\r
 \r
 /** \page Page_BuildSystem The LUFA Build System\r
  *\r

- *  \section Sec_BuildSystemOverview Overview of the LUFA Build System\r
- *  The LUFA build system is an attempt at making a set of re-usable, modular build make files which\r
- *  can be referenced in a LUFA powered project, to minimise the amount of code required in an\r
- *  application makefile. The system is written in GNU Make, and each module is independant of\r
- *  one-another.\r
+ *  \section Sec_BuildSystem_Overview Overview of the LUFA Build System\r
+ *  The LUFA build system was originally an attempt at making a set of\r
+ *  re-usable, modular build make files which could be referenced in a LUFA\r
+ *  powered project, to minimize the amount of code required in an\r
+ *  application makefile.\r

  *\r
  *\r

- *  To use a LUFA build system module, simply add an include to your project makefile:\r
- *  \code\r
- *  include $(LUFA_PATH)/Build/lufa.core.in\r
- *  \endcode\r
- *\r
- *  And the associated build module targets will be added to your project's build makefile automatically.\r
- *  To call a build target, run <tt>make {TARGET_NAME}</tt> from the command line, substituting in\r
- *  the appropriate target name.\r
+ *  As it turned out to be fairly generic in nature, it was split out into its\r
+ *  own separate project, called DMBS (<i>Dean's Makefile Build System</i>)\r
+ *  which is released into the public domain. LUFA-specific portions of the\r
+ *  LUFA build system extend DMBS, and provide a universal build system for all\r
+ *  LUFA projects.\r

  *\r
  *\r

- *  \see \ref Sec_AppConfigParams for a copy of the sample LUFA project makefile.\r
+ *  The latest DMBS project information and documentation can be found at:\r
+ *  https://github.com/abcminiuser/dmbs\r

  *\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
+ *  DMBS is written in GNU Make, and each module is independent of one-another.\r

  *\r
  *\r

- *  \section SSec_BuildSystemModules Available Modules\r
+ *  LUFA now uses DMBS for its build system, with some LUFA specific extension\r
+ *  modules.\r

  *\r
  *\r

- *  The following modules are included in this LUFA release:\r
+ *  If you have problems building using LUFA, see \subpage Page_BuildTroubleshooting for resolution steps.\r

  *\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_SOURCES - LUFA Module Source Code Variables\r
+ *  \li \subpage Page_BuildModule_LUFA_SOURCES - The LUFA SOURCES extension module for DMBS\r
+ *  \li \subpage Page_BuildModule_LUFA_GCC - The LUFA GCC extension module for DMBS\r

  */\r
  */\r

- \r
- /** \page Page_BuildModule_BUILD The BUILD build module\r
+\r
+/** \page Page_BuildModule_LUFA_SOURCES LUFA SOURCES extension module for DMBS\r

  *\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.\r
+ *  The LUFA SOURCES extension more for DMBS provides LUFA specific variables\r
+ *  listing the various LUFA source files required to be build by a project for\r
+ *  a given LUFA module. This module gives a way to reference LUFA source files\r
+ *  symbolically, so that changes to the library structure do not break the\r
+ *  library makefile.\r

  *\r
  *  To use this module in your application makefile, add the following code:\r
  *  \code\r
  *\r
  *  To use this module in your application makefile, add the following code:\r
  *  \code\r

- *  include $(LUFA_PATH)/Build/lufa.build.in\r
+ *  include $(LUFA_PATH)/Build/LUFA/lufa-sources.mk\r

  *  \endcode\r
  *\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
+ *  \section SSec_BuildModule_LUFA_SOURCES_Requirements Requirements\r
+ *  None.\r

  *\r
  *\r

- *  \section SSec_BuildModule_BUILD_Targets Targets\r
+ *  \section SSec_BuildModule_LUFA_SOURCES_Targets Targets\r

  *\r
  *  <table>\r
  *   <tr>\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>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>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 intermediatary files and binary output files.</td>\r
+ *    <td><i>None</i></td>\r

  *   </tr>\r
  *  </table>\r
  *\r
  *   </tr>\r
  *  </table>\r
  *\r

- *  \section SSec_BuildModule_BUILD_MandatoryParams Mandatory Parameters\r
+ *  \section SSec_BuildModule_LUFA_SOURCES_MandatoryParams Mandatory Parameters\r

  *\r
  *  <table>\r
  *   <tr>\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
  *    <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
  *   <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>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 compiler, assembler and linker, after the automatically generated flags.</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
+ *    <td><tt>ARCH</tt></td>\r
+ *    <td>Architecture of the target processor (see \ref Page_DeviceSupport).</td>\r

  *   </tr>\r
  *  </table>\r
  *\r
  *   </tr>\r
  *  </table>\r
  *\r

- *  \section SSec_BuildModule_BUILD_ProvideVariables 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
+ *  \section SSec_BuildModule_LUFA_SOURCES_OptionalParams Optional Parameters\r

  *\r
  *  <table>\r
  *   <tr>\r
  *    <td><i>None</i></td>\r
  *   </tr>\r
  *  </table>\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.in\r
- *  \endcode\r

  *\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
+ *  \section SSec_BuildModule_LUFA_SOURCES_ProvidedVariables Module Provided Variables\r

  *\r
  *  <table>\r
  *   <tr>\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
+ *    <td><tt>LUFA_SRC_USB</tt></td>\r
+ *    <td>List of LUFA USB driver source files.</td>\r

  *   </tr>\r
  *   <tr>\r
  *   </tr>\r
  *   <tr>\r

- *    <td><tt>list_mandatory</tt></td>\r
- *    <td>List all mandatory parameters required by the included modules.</td>\r
+ *    <td><tt>LUFA_SRC_USBCLASS</tt></td>\r
+ *    <td>List of LUFA USB Class driver source files.</td>\r

  *   </tr>\r
  *   <tr>\r
  *   </tr>\r
  *   <tr>\r

- *    <td><tt>list_optional</tt></td>\r
- *    <td>List all optional parameters required by the included modules.</td>\r
+ *    <td><tt>LUFA_SRC_TEMPERATURE</tt></td>\r
+ *    <td>List of LUFA temperature sensor driver source files.</td>\r

  *   </tr>\r
  *   <tr>\r
  *   </tr>\r
  *   <tr>\r

- *    <td><tt>list_provided</tt></td>\r
- *    <td>List all variables provided by the included modules.</td>\r
+ *    <td><tt>LUFA_SRC_SERIAL</tt></td>\r
+ *    <td>List of LUFA Serial U(S)ART driver source files.</td>\r

  *   </tr>\r
  *   <tr>\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
+ *    <td><tt>LUFA_SRC_TWI</tt></td>\r
+ *    <td>List of LUFA TWI driver source files.</td>\r

  *   </tr>\r
  *   </tr>\r

- *  </table>\r
- *\r
- *  \section SSec_BuildModule_CORE_OptionalParams Optional Parameters\r
- *\r
- *  <table>\r

  *   <tr>\r
  *   <tr>\r

- *    <td><i>None</i></td>\r
+ *    <td><tt>LUFA_SRC_PLATFORM</tt></td>\r
+ *    <td>List of LUFA architecture specific platform management source files.</td>\r

  *   </tr>\r
  *  </table>\r
  *\r
  *   </tr>\r
  *  </table>\r
  *\r

- *  \section SSec_BuildModule_CORE_ProvideVariables 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
+ *  \section SSec_BuildModule_LUFA_SOURCES_ProvidedMacros Module Provided Macros\r

  *\r
  *  <table>\r
  *   <tr>\r
  *\r
  *  <table>\r
  *   <tr>\r


@@ -260,241 +115,56 @@
  *  </table>\r
  */\r
 \r
  *  </table>\r
  */\r
 \r

-/** \page Page_BuildModule_ATPROGRAM The ATPROGRAM build module\r
+/** \page Page_BuildModule_LUFA_GCC LUFA GCC extension module for DMBS\r

  *\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
+ *  The LUFA GCC extension module for the standard DMBS GCC module extends the\r
+ *  latter to support the compilation of LUFA powered projects. It should be\r
+ *  imported into your LUFA powered project makefiles to ensure that the correct\r
+ *  build settings are used for the project's configuration.\r

  *\r
  *  To use this module in your application makefile, add the following code:\r
  *  \code\r
  *\r
  *  To use this module in your application makefile, add the following code:\r
  *  \code\r

- *  include $(LUFA_PATH)/Build/lufa.atprogram.in\r
+ *  include $(LUFA_PATH)/Build/LUFA/lufa-gcc.mk\r

  *  \endcode\r
  *\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 "\avrdbg" subdirectory.\r
- *\r
- *  \section SSec_BuildModule_ATPROGRAM_Targets Targets\r
+ *  \section SSec_BuildModule_LUFA_GCC_Requirements Requirements\r
+ *  This module should be included in your makefile *after* the DMBS GCC module.\r

  *\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_ProvideVariables 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
+ *  \section SSec_BuildModule_LUFA_GCC_Targets Targets\r

  *\r
  *  <table>\r
  *   <tr>\r
  *    <td><i>None</i></td>\r
  *   </tr>\r
  *  </table>\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.in\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>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
  *\r

- *  \section SSec_BuildModule_AVRDUDE_Targets Targets\r
+ *  \section SSec_BuildModule_LUFA_GCC_MandatoryParams Mandatory Parameters\r

  *\r
  *  <table>\r
  *   <tr>\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</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
+ *    <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
  *   </tr>\r
  *  </table>\r
  *\r

- *  \section SSec_BuildModule_AVRDUDE_OptionalParams Optional Parameters\r
+ *  \section SSec_BuildModule_LUFA_GCC_OptionalParams Optional Parameters\r

  *\r
  *  <table>\r
  *   <tr>\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>ATPROGRAM_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>ATPROGRAM_FLAGS</tt></td>\r
- *    <td>Additional flags to pass to avrdude when programming, applied after the automatically generated flags.</td>\r
+ *    <td><tt>BOARD</tt></td>\r
+ *    <td>LUFA board hardware drivers to use (see \ref Page_DeviceSupport).</td>\r

  *   </tr>\r
  *  </table>\r
  *\r
  *   </tr>\r
  *  </table>\r
  *\r

- *  \section SSec_BuildModule_AVRDUDE_ProvideVariables Module Provided Variables\r
+ *  \section SSec_BuildModule_LUFA_GCC_ProvidedVariables Module Provided Variables\r

  *\r
  *  <table>\r
  *   <tr>\r
  *    <td><i>None</i></td>\r
  *   </tr>\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.in\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
  *  </table>\r
  *\r

- *  \section SSec_BuildModule_CPPCHECK_ProvideVariables 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
+ *  \section SSec_BuildModule_LUFA_GCC_ProvidedMacros Module Provided Macros\r

  *\r
  *  <table>\r
  *   <tr>\r
  *\r
  *  <table>\r
  *   <tr>\r


@@ -502,230 +172,110 @@
  *   </tr>\r
  *  </table>\r
  */\r
  *   </tr>\r
  *  </table>\r
  */\r

- \r
- /** \page Page_BuildModule_DFU The DFU build module\r
- *\r
- *  The DFU 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
- *  This module requires a DFU class bootloader to be running in the target.\r
- *\r
- *  To use this module in your application makefile, add the following code:\r
- *  \code\r
- *  include $(LUFA_PATH)/Build/lufa.dfu.in\r
- *  \endcode\r
- *\r
- *  \section SSec_BuildModule_DFU_Requirements Requirements\r
- *  This module requires either the <tt>batchisp</tt> utility from Atmel's FLIP utility, or the open\r
- *  source <tt>dfu-programmer</tt> utility (<a>http://dfu-programmer.sourceforge.net/</a>) to be\r
- *  available in your system's <b>PATH</b> variable. On *nix systems the <tt>dfu-programmer</tt> utility\r
- *  can be installed via the project's source code or through the package manager.\r
+\r
+/** \page Page_BuildTroubleshooting Troubleshooting Information\r

  *\r
  *\r

- *  \section SSec_BuildModule_DFU_Targets Targets\r
+ *  LUFA uses a lot of advanced features of the AVR-GCC compiler, linker, and\r
+ *  surrounding binaries. This can sometimes lead to problems compiling\r
+ *  applications if one of these features is buggy in the version of the tools\r
+ *  used in a build environment. Missing utilities and incorrectly set makefile\r
+ *  configuration options can also result in different errors being produced\r
+ *  when compilation or other operations are attempted. The table below lists a\r
+ *  set of commonly encountered errors and their resolutions.\r

  *\r
  *  <table>\r
  *\r
  *  <table>\r

- *   <tr>\r
- *    <td><tt>dfu</tt></td>\r
- *    <td>Program the device FLASH memory with the application's executable data using <tt>dfu-programmer</tt>.</td>\r
+ *    <tr>\r
+ *    <th>Problem</th>\r
+ *    <th>Resolution</th>\r

  *   </tr>\r
  *   <tr>\r
  *   </tr>\r
  *   <tr>\r

- *    <td><tt>dfu-ee</tt></td>\r
- *    <td>Program the device EEPROM memory with the application's EEPROM data using <tt>dfu-programmer</tt>.</td>\r
+ *    <td>Error &quot;<b><tt>relocation truncated to fit: R_AVR_13_PCREL against symbol <i>{X}</i></tt></b>&quot; shown when compiling.</td>\r
+ *    <td>Try compiling with the setting <tt>LINKER_RELAXATIONS=N</tt> in your LUFA Build System 2.0 makefile, or remove the line <tt>-Wl,--relax</tt>\r
+ *        from other makefiles. Alternatively, make sure you have the latest version of the Atmel Toolchain installed for your system.</td>\r

  *   </tr>\r
  *   <tr>\r
  *   </tr>\r
  *   <tr>\r

- *    <td><tt>flip</tt></td>\r
- *    <td>Program the device FLASH memory with the application's executable data using <tt>batchisp</tt>.</td>\r
+ *    <td>Error &quot;<b><tt>error: ld terminated with signal 11 [Segmentation fault]</tt></b>&quot; shown when compiling.</td>\r
+ *    <td>Try compiling with the setting <tt>DEBUG_LEVEL=2</tt> in your LUFA Build System 2.0 makefile, or make sure you are using <tt>binutils</tt> version 2.22 or later.</td>\r

  *   </tr>\r
  *   <tr>\r
  *   </tr>\r
  *   <tr>\r

- *    <td><tt>flip-ee</tt></td>\r
- *    <td>Program the device EEPROM memory with the application's EEPROM data using <tt>batchisp</tt>.</td>\r
+ *    <td>Error &quot;<b><tt>EMERGENCY ABORT: INFINITE RECURSION DETECTED</tt></b>&quot; shown when compiling.</td>\r
+ *    <td>Make sure you are using an up to date version of GNU Make when compiling. This error is a safety system added to the mid-level makefiles, to prevent an issue with\r
+ *        GNU make or other variants of Make causing an infinitely recursive build.</td>\r

  *   </tr>\r
  *   </tr>\r

- *  </table>\r
- *\r
- *  \section SSec_BuildModule_DFU_MandatoryParams Mandatory Parameters\r
- *\r
- *  <table>\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
+ *    <td>Error &quot;<b><tt>Unsupported architecture &quot;<i>{X}</i>&quot;</tt></b>&quot; shown when compiling.</td>\r
+ *    <td>Ensure your makefile's <tt>ARCH</tt> setting is set to one of the architecture names (case-sensitive) supported by the version of LUFA you are compiling against.</td>\r

  *   </tr>\r
  *   <tr>\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
+ *    <td>Error &quot;<b><tt>Makefile <i>{X}</i> value not set</tt></b>&quot; shown when compiling.</td>\r
+ *    <td>The specified Makefile value was not configured in your project's makefile or on the command line, and the nominated setting is required by one or more LUFA\r
+ *        build system modules. Define the value in your project makefile and try again.</td>\r

  *   </tr>\r
  *   </tr>\r

- *  </table>\r
- *\r
- *  \section SSec_BuildModule_DFU_OptionalParams Optional Parameters\r
- *\r
- *  <table>\r
- *   <tr>\r
- *    <td><i>None</i></td>\r
- *   </tr>\r
- *  </table>\r
- *\r
- *  \section SSec_BuildModule_DFU_ProvideVariables Module Provided Variables\r
- *\r
- *  <table>\r
- *   <tr>\r
- *    <td><i>None</i></td>\r
- *   </tr>\r
- *  </table> \r
- *\r
- *  \section SSec_BuildModule_DFU_ProvidedMacros Module Provided Macros\r
- *\r
- *  <table>\r

  *   <tr>\r
  *   <tr>\r

- *    <td><i>None</i></td>\r
+ *    <td>Error &quot;<b><tt>Makefile <i>{X}</i> option cannot be blank</tt></b>&quot; shown when compiling.</td>\r
+ *    <td>The specified Makefile value was configured in your project's makefile or on the command line, but was set to an empty value. For the nominated configuration\r
+ *        option, an empty value is not allowed. Define the nominated setting to a correct non-blank value and try again.</td>\r

  *   </tr>\r
  *   </tr>\r

- *  </table>\r
- */\r
- \r
- /** \page Page_BuildModule_DOXYGEN The DOXYGEN build module\r
- *\r
- *  The DOXYGEN code documentation utility LUFA build system module, providing targets to generate\r
- *  project HTML and other format documentation from a set of source files that include special\r
- *  Doxygen comments.\r
- *\r
- *  To use this module in your application makefile, add the following code:\r
- *  \code\r
- *  include $(LUFA_PATH)/Build/lufa.doxygen.in\r
- *  \endcode\r
- *\r
- *  \section SSec_BuildModule_DOXYGEN_Requirements Requirements\r
- *  This module requires the <tt>doxygen</tt> utility from the Doxygen website\r
- *  (<a>http://www.stack.nl/~dimitri/doxygen/</a>) to be available in your system's <b>PATH</b>\r
- *  variable. On *nix systems the <tt>doxygen</tt> utility can be installed via the project's source\r
- *  code or through the package manager.\r
- *\r
- *  \section SSec_BuildModule_DOXYGEN_Targets Targets\r
- *\r
- *  <table>\r

  *   <tr>\r
  *   <tr>\r

- *    <td><tt>doxygen</tt></td>\r
- *    <td>Generate project documentation.</td>\r
+ *    <td>Error &quot;<b><tt>Makefile <i>{X}</i> option must be Y or N</tt></b>&quot; shown when compiling.</td>\r
+ *    <td>The specified Makefile value was configured in your project's makefile or on the command line, but was set to a value other than a Y (for "Yes") or "N" (for "No").\r
+ *        This configuration option is required to be one of the aforementioned boolean values, and other values are invalid. Set this option to either Y or N and try again.</td>\r

  *   </tr>\r
  *   </tr>\r

- *  </table>\r
- *\r
- *  \section SSec_BuildModule_DOXYGEN_MandatoryParams Mandatory Parameters\r
- *\r
- *  <table>\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
+ *    <td>Error &quot;<b><tt>Unknown input source file formats: <i>{X}</i></tt></b>&quot; shown when compiling.</td>\r
+ *    <td>The nominated source files, specified in your project's makefile in the <tt>SRC</tt> configuration option, has an extension that the LUFA build system does not\r
+ *        recognise. The file extensions are case sensitive, and must be one of the supported formats (<tt>*.c</tt>, <tt>*.cpp</tt> or <tt>*.S</tt>).</td>\r

  *   </tr>\r
  *   </tr>\r

- *  </table>\r
- *\r
- *  \section SSec_BuildModule_DOXYGEN_OptionalParams Optional Parameters\r
- *\r
- *  <table>\r

  *   <tr>\r
  *   <tr>\r

- *    <td><tt>DOXYGEN_CONF</tt></td>\r
- *    <td>Name and path of the base Doxygen configuration file for the project.</td>\r
+ *    <td>Error &quot;<b><tt>Cannot build with OBJDIR parameter set - one or more object file name is not unique</tt></b>&quot; shown when compiling.</td>\r
+ *    <td>When a project is built with a non-empty <tt>OBJDIR</tt> object directory name set, all input source files must have unique names, excluding extension and path.\r
+ *        This means that input files that are named identically and differ only by their path or extension are invalid when this mode is used.</td>\r

  *   </tr>\r
  *   <tr>\r
  *   </tr>\r
  *   <tr>\r

- *    <td><tt>DOXYGEN_FAIL_ON_WARNING</tt></td>\r
- *    <td>Set to <b>Y</b> to fail the generation with an error exit code if warnings are found other than unsupported configuration parameters, <b>N</b> to continue without failing.</td>\r
+ *    <td>Error &quot;<b><tt>Source file does not exist: <i>{X}</i></tt></b>&quot; shown when compiling.</td>\r
+ *    <td>The nominated input source file, specified in the user project's <tt>SRC</tt> parameter, could not be found. Ensure the source file exists and the absolute or\r
+ *        relative path given in the user project makefile is correct and try again.</td>\r

  *   </tr>\r
  *   <tr>\r
  *   </tr>\r
  *   <tr>\r

- *    <td><tt>DOXYGEN_OVERRIDE_PARAMS</tt></td>\r
- *    <td>Extra Doxygen configuration parameters to apply, overriding the corresponding config entry in the project's configuration file (e.g. <tt>QUIET=YES</tt>).</td>\r
+ *    <td>Error &quot;<b><tt>Doxygen configuration file <i>{X}</i> does not exist</tt></b>&quot; shown when upgrading a Doxygen configuration file.</td>\r
+ *    <td>The nominated Doxygen configuration file, specified in the user project's <tt>DOXYGEN_CONF</tt> parameter, could not be found. Ensure the configuration file exists\r
+ *        and the absolute or relative path given in the user project makefile is correct and try again, or run the appropriate makefile target to generate a new configuration\r
+ *        file.</td>\r

  *   </tr>\r
  *   </tr>\r

- *  </table>\r
- *\r
- *  \section SSec_BuildModule_DOXYGEN_ProvideVariables Module Provided Variables\r
- *\r
- *  <table>\r

  *   <tr>\r
  *   <tr>\r

- *    <td><i>None</i></td>\r
+ *    <td>Error &quot;<b><tt>avr-gcc: error: unrecognized option '<i>{X}</i>'</tt></b>&quot; shown when compiling.</td>\r
+ *    <td>An unrecognised option was supplied to the compiler, usually in the <tt>C_FLAGS</tt>, <tt>CPP_FLAGS</tt>, <tt>ASM_FLAGS</tt> or <tt>CC_FLAGS</tt> configuration\r
+ *        options. The nominated compiler switch may be invalid, or unsupported by the version of AVR-GCC on the host system. Remove the unrecognised flag if invalid, or\r
+ *        upgrade to the latest AVR-GCC. If the option is a valid linker option, use the prefix "-Wl," to ensure it is passed to the linker correctly.</td>\r

  *   </tr>\r
  *   </tr>\r

- *  </table> \r
- *\r
- *  \section SSec_BuildModule_DOXYGEN_ProvidedMacros Module Provided Macros\r
- *\r
- *  <table>\r

  *   <tr>\r
  *   <tr>\r

- *    <td><i>None</i></td>\r
+ *    <td>Error &quot;<b><tt>makefile:{X}: {Y}.mk: No such file or directory</tt></b>&quot; shown when make is invoked.</td>\r
+ *    <td>The path to the nominated makefile module was incorrect. This usually indicates that the makefile <tt>LUFA_PATH</tt> option is not set to a valid relative or\r
+ *        absolute path to the LUFA library core.</td>\r

  *   </tr>\r
  *   </tr>\r

- *  </table>\r
- */\r
- \r
- /** \page Page_BuildModule_SOURCES The SOURCES build module\r
- *\r
- *  The SOURCES LUFA build system module, providing variables listing the various LUFA source files\r
- *  required to be build by a project for a given LUFA module. This module gives a way to reference\r
- *  LUFA source files symbollically, so that changes to the library structure do not break the library\r
- *  makefile.\r
- *\r
- *  To use this module in your application makefile, add the following code:\r
- *  \code\r
- *  include $(LUFA_PATH)/Build/lufa.sources.in\r
- *  \endcode\r
- *\r
- *  \section SSec_BuildModule_SOURCES_Requirements Requirements\r
- *  None.\r
- *\r
- *  \section SSec_BuildModule_SOURCES_Targets Targets\r
- *\r
- *  <table>\r

  *   <tr>\r
  *   <tr>\r

- *    <td><i>None</i></td>\r
+ *    <td>Error &quot;<b><tt>fatal error: LUFAConfig.h: No such file or directory</tt></b>&quot; shown when compiling.</td>\r
+ *    <td>The <tt>USE_LUFA_CONFIG_HEADER</tt> compile time option was set in the user project makefile, but the user supplied <tt>LUFAConfig.h</tt> header could not be\r
+ *        found. Ensure that the directory that contains this configuration file is correctly passed to the compiler via the -I switch in the makefile <tt>CC_FLAGS</tt>\r
+ *        parameter.</td>\r

  *   </tr>\r
  *   </tr>\r

- *  </table>\r
- *\r
- *  \section SSec_BuildModule_SOURCES_MandatoryParams Mandatory Parameters\r
- *\r
- *  <table>\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
+ *    <td>Error &quot;<b><tt>ld.exe: section .apitable_trampolines loaded at <i>{X}</i> overlaps section .text</tt></b>&quot; shown when compiling a bootloader.</td>\r
+ *    <td>The bootloader is compiling too large for the given <tt>FLASH_SIZE_KB</tt> and <tt>BOOT_SECTION_SIZE_KB</tt> parameters set in the bootloader makefile. This\r
+ *        usually indicates that these values are incorrect for the specified device the bootloader is targeting. If these values are correct, a newer version of the\r
+ *        compiler may need to be used to ensure that the bootloader is built within the section size constraints of the target device.</td>\r

  *   </tr>\r
  *   <tr>\r
  *   </tr>\r
  *   <tr>\r

- *    <td><tt>ARCH</tt></td>\r
- *    <td>Architecture of the target processor (see \ref Page_DeviceSupport).</td>\r
+ *    <td>Error &quot;<b><tt>unknown MCU '<i>{X}</i>' specified</tt></b>&quot; shown when compiling.</td>\r
+ *    <td>The specified microcontroller device model name set in the user application's makefile as the <tt>MCU</tt> parameter is incorrect, or unsupported by the\r
+ *        version of the compiler being used. Make sure the model name is correct, or upgrade to the latest Atmel Toolchain to obtain newer device support.</td>\r

  *   </tr>\r
  *   </tr>\r

- *  </table>\r
- *\r
- *  \section SSec_BuildModule_SOURCES_OptionalParams Optional Parameters\r
- *\r
- *  <table>\r

  *   <tr>\r
  *   <tr>\r

- *    <td><i>None</i></td>\r
+ *    <td>Error &quot;<b><tt>undefined reference to `<i>{X}</i>'</tt></b>&quot; shown when compiling.</td>\r
+ *    <td>This is usually caused by a missing source file in the user application's <tt>SRC</tt> configuration parameter. If the indicated symbol is one from the LUFA\r
+ *        library, you may be missing a LUFA source makefile module (see \ref Page_BuildModule_LUFA_SOURCES).</td>\r

  *   </tr>\r
  *  </table>\r
  *\r
  *   </tr>\r
  *  </table>\r
  *\r

- *  \section SSec_BuildModule_SOURCES_ProvideVariables Module Provided Variables\r
- *\r
- *  <table>\r
- *   <tr>\r
- *    <td><tt>LUFA_SRC_USB</tt></td>\r
- *    <td>List of LUFA USB driver source files.</td>\r
- *   </tr>\r
- *   <tr>\r
- *    <td><tt>LUFA_SRC_USBCLASS</tt></td>\r
- *    <td>List of LUFA USB Class driver source files.</td>\r
- *   </tr>\r
- *   <tr>\r
- *    <td><tt>LUFA_SRC_TEMPERATURE</tt></td>\r
- *    <td>List of LUFA temperature sensor driver source files.</td>\r
- *   </tr>\r
- *   <tr>\r
- *    <td><tt>LUFA_SRC_SERIAL</tt></td>\r
- *    <td>List of LUFA Serial U(S)ART driver source files.</td>\r
- *   </tr>\r
- *   <tr>\r
- *    <td><tt>LUFA_SRC_TWI</tt></td>\r
- *    <td>List of LUFA TWI driver source files.</td>\r
- *   </tr>\r
- *   <tr>\r
- *    <td><tt>LUFA_SRC_PLATFORM</tt></td>\r
- *    <td>List of LUFA architecture specific platform management source files.</td>\r
- *   </tr> \r
- *  </table> \r
- *\r
- *  \section SSec_BuildModule_SOURCES_ProvidedMacros Module Provided Macros\r
- *\r
- *  <table>\r
- *   <tr>\r
- *    <td><i>None</i></td>\r
- *   </tr>\r
- *  </table>\r
+ *  For troubleshooting other errors you encounter, please see \ref Sec_ProjectHelp.\r

  */\r
  */\r