LUFA/DoxygenPages/BuildSystem.txt

   1 /** \file
   2  *
   3  *  This file contains special DoxyGen information for the generation of the main page and other special
   4  *  documentation pages. It is not a project source file.
   5  */
   6
   7 /** \page Page_BuildSystem The LUFA Build System
   8  *
   9  *  \section Sec_BuildSystem_Overview Overview of the LUFA Build System
  10  *  The LUFA build system is an attempt at making a set of re-usable, modular build make files which
  11  *  can be referenced in a LUFA powered project, to minimize the amount of code required in an
  12  *  application makefile. The system is written in GNU Make, and each module is independent of
  13  *  one-another.
  14  *
  15  *  For details on the prerequisites needed for Linux and Windows machines to be able to use the LUFA
  16  *  build system, see \ref Sec_CompilingApps_Prerequisites.
  17  *
  18  *  To use a LUFA build system module, simply add an include to your project makefile. All user projects
  19  *  should at a minimum include \ref Page_BuildModule_CORE for base functionality:
  20  *  \code
  21  *  include $(LUFA_PATH)/Build/lufa_core.mk
  22  *  \endcode
  23  *
  24  *  Once included in your project makefile, the associated build module targets will be added to your
  25  *  project's build makefile targets automatically. To call a build target, run <tt>make {TARGET_NAME}</tt>
  26  *  from the command line, substituting in the appropriate target name.
  27  *
  28  *  \see \ref Sec_ConfiguringApps_AppMakefileParams for a copy of the sample LUFA project makefile.
  29  *
  30  *  Each build module may have one or more mandatory parameters (GNU Make variables) which <i>must</i>
  31  *  be supplied in the project makefile for the module to work, and one or more optional parameters which
  32  *  may be defined and which will assume a sensible default if not.
  33  *
  34  *  \section SSec_BuildSystem_Modules Available Modules
  35  *
  36  *  The following modules are included in this LUFA release:
  37  *
  38  *  \li \subpage Page_BuildModule_ATPROGRAM - Device Programming
  39  *  \li \subpage Page_BuildModule_AVRDUDE - Device Programming
  40  *  \li \subpage Page_BuildModule_BUILD - Compiling/Assembling/Linking
  41  *  \li \subpage Page_BuildModule_CORE - Core Build System Functions
  42  *  \li \subpage Page_BuildModule_CPPCHECK - Static Code Analysis
  43  *  \li \subpage Page_BuildModule_DFU - Device Programming
  44  *  \li \subpage Page_BuildModule_DOXYGEN - Automated Source Code Documentation
  45  *  \li \subpage Page_BuildModule_HID - Device Programming
  46  *  \li \subpage Page_BuildModule_SOURCES - LUFA Module Source Code Variables
  47  *
  48  *  If you have problems building using the LUFA build system, see \subpage Page_BuildTroubleshooting for resolution steps.
  49  */
  50
  51  /** \page Page_BuildModule_BUILD The BUILD build module
  52  *
  53  *  The BUILD LUFA build system module, providing targets for the compilation,
  54  *  assembling and linking of an application from source code into binary files
  55  *  suitable for programming into a target device, using the GCC compiler.
  56  *
  57  *  To use this module in your application makefile, add the following code:
  58  *  \code
  59  *  include $(LUFA_PATH)/Build/lufa_build.mk
  60  *  \endcode
  61  *
  62  *  \section SSec_BuildModule_BUILD_Requirements Requirements
  63  *  This module requires the the architecture appropriate binaries of the GCC compiler are available in your
  64  *  system's <b>PATH</b> variable. The GCC compiler and associated toolchain is distributed in Atmel AVR Studio
  65  *  5.x and Atmel Studio 6.x installation directories, as well as in many third party distribution packages.
  66  *
  67  *  \section SSec_BuildModule_BUILD_Targets Targets
  68  *
  69  *  <table>
  70  *   <tr>
  71  *    <td><tt>size</tt></td>
  72  *    <td>Display size of the compiled application FLASH and SRAM segments.</td>
  73  *   </tr>
  74  *   <tr>
  75  *    <td><tt>symbol-sizes</tt></td>
  76  *    <td>Display a size-sorted list of symbols from the compiled application, in decimal bytes.</td>
  77  *   </tr>
  78  *   <tr>
  79  *    <td><tt>lib</tt></td>
  80  *    <td>Build and archive all source files into a library A binary file.</td>
  81  *   </tr>
  82  *   <tr>
  83  *    <td><tt>all</tt></td>
  84  *    <td>Build and link the application into ELF debug and HEX binary files.</td>
  85  *   </tr>
  86  *   <tr>
  87  *    <td><tt>elf</tt></td>
  88  *    <td>Build and link the application into an ELF debug file.</td>
  89  *   </tr>
  90  *   <tr>
  91  *    <td><tt>bin</tt></td>
  92  *    <td>Build and link the application and produce a BIN binary file.</td>
  93  *   </tr>
  94  *   <tr>
  95  *    <td><tt>hex</tt></td>
  96  *    <td>Build and link the application and produce HEX and EEP binary files.</td>
  97  *   </tr>
  98  *   <tr>
  99  *    <td><tt>lss</tt></td>
 100  *    <td>Build and link the application and produce a LSS source code/assembly code mixed listing file.</td>
 101  *   </tr>
 102  *   <tr>
 103  *    <td><tt>clean</tt></td>
 104  *    <td>Remove all intermediary files and binary output files.</td>
 105  *   </tr>
 106  *   <tr>
 107  *    <td><tt>mostlyclean</tt></td>
 108  *    <td>Remove all intermediary files but preserve any binary output files.</td>
 109  *   </tr>
 110  *   <tr>
 111  *    <td><tt><i>&lt;filename&gt;</i>.s</tt></td>
 112  *    <td>Create an assembly listing of a given input C/C++ source file.</td>
 113  *   </tr>
 114  *  </table>
 115  *
 116  *  \section SSec_BuildModule_BUILD_MandatoryParams Mandatory Parameters
 117  *
 118  *  <table>
 119  *   <tr>
 120  *    <td><tt>TARGET</tt></td>
 121  *    <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
 122  *   </tr>
 123  *   <tr>
 124  *    <td><tt>ARCH</tt></td>
 125  *    <td>Architecture of the target processor (see \ref Page_DeviceSupport).</td>
 126  *   </tr>
 127  *   <tr>
 128  *    <td><tt>MCU</tt></td>
 129  *    <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
 130  *   </tr>
 131  *   <tr>
 132  *    <td><tt>SRC</tt></td>
 133  *    <td>List of relative or absolute paths to the application C (.c), C++ (.cpp) and Assembly (.S) source files.</td>
 134  *   </tr>
 135  *   <tr>
 136  *    <td><tt>F_USB</tt></td>
 137  *    <td>Speed in Hz of the input clock frequency to the target's USB controller.</td>
 138  *   </tr>
 139  *   <tr>
 140  *    <td><tt>LUFA_PATH</tt></td>
 141  *    <td>Path to the LUFA library core, either relative or absolute (e.g. <tt>../LUFA-000000/LUFA/</tt>).</td>
 142  *   </tr>
 143  *  </table>
 144  *
 145  *  \section SSec_BuildModule_BUILD_OptionalParams Optional Parameters
 146  *
 147  *  <table>
 148  *   <tr>
 149  *    <td><tt>BOARD</tt></td>
 150  *    <td>LUFA board hardware drivers to use (see \ref Page_DeviceSupport).</td>
 151  *   </tr>
 152  *   <tr>
 153  *    <td><tt>OPTIMIZATION</tt></td>
 154  *    <td>Optimization level to use when compiling source files (see GCC manual).</td>
 155  *   </tr>
 156  *   <tr>
 157  *    <td><tt>C_STANDARD</tt></td>
 158  *    <td>Version of the C standard to apply when compiling C++ source files (see GCC manual).</td>
 159  *   </tr>
 160  *   <tr>
 161  *    <td><tt>CPP_STANDARD</tt></td>
 162  *    <td>Version of the C++ standard to apply when compiling C++ source files (see GCC manual).</td>
 163  *   </tr>
 164  *   <tr>
 165  *    <td><tt>DEBUG_FORMAT</tt></td>
 166  *    <td>Format of the debug information to embed in the generated object files (see GCC manual).</td>
 167  *   </tr>
 168  *   <tr>
 169  *    <td><tt>DEBUG_LEVEL</tt></td>
 170  *    <td>Level of the debugging information to embed in the generated object files (see GCC manual).</td>
 171  *   </tr>
 172  *   <tr>
 173  *    <td><tt>F_CPU</tt></td>
 174  *    <td>Speed of the processor CPU clock, in Hz.</td>
 175  *   </tr>
 176  *   <tr>
 177  *    <td><tt>C_FLAGS</tt></td>
 178  *    <td>Flags to pass to the C compiler only, after the automatically generated flags.</td>
 179  *   </tr>
 180  *   <tr>
 181  *    <td><tt>CPP_FLAGS</tt></td>
 182  *    <td>Flags to pass to the C++ compiler only, after the automatically generated flags.</td>
 183  *   </tr>
 184  *   <tr>
 185  *    <td><tt>ASM_FLAGS</tt></td>
 186  *    <td>Flags to pass to the assembler only, after the automatically generated flags.</td>
 187  *   </tr>
 188  *   <tr>
 189  *    <td><tt>CC_FLAGS</tt></td>
 190  *    <td>Common flags to pass to the C/C++ compiler and assembler, after the automatically generated flags.</td>
 191  *   </tr>
 192  *   <tr>
 193  *    <td><tt>LD_FLAGS</tt></td>
 194  *    <td>Flags to pass to the linker, after the automatically generated flags.</td>
 195  *   </tr>
 196  *   <tr>
 197  *    <td><tt>LINKER_RELAXATIONS</tt></td>
 198  *    <td>Enables or disables linker relaxations when linking the application binary. This can reduce the total size
 199  *        of the application by replacing full \c CALL instructions with smaller \c RCALL instructions where possible.
 200  *        \note On some unpatched versions of binutils, this can cause link failures in some circumstances. If you
 201  *              receive a link error <tt>relocation truncated to fit: R_AVR_13_PCREL</tt>, disable this setting.</td>
 202  *   </tr>
 203  *   <tr>
 204  *    <td><tt>OBJDIR</tt></td>
 205  *    <td>Directory to place the generated object and dependency files. If set to "." the same folder as the source file will be used.
 206  *        \note When this option is enabled, all source filenames <b>must</b> be unique.</td>
 207  *   </tr>
 208  *   <tr>
 209  *    <td><tt>OBJECT_FILES</tt></td>
 210  *    <td>List of additional object files that should be linked into the resulting binary.</td>
 211  *   </tr>
 212  *  </table>
 213  *
 214  *  \section SSec_BuildModule_BUILD_ProvidedVariables Module Provided Variables
 215  *
 216  *  <table>
 217  *   <tr>
 218  *    <td><i>None</i></td>
 219  *   </tr>
 220  *  </table>
 221  *
 222  *  \section SSec_BuildModule_BUILD_ProvidedMacros Module Provided Macros
 223  *
 224  *  <table>
 225  *   <tr>
 226  *    <td><i>None</i></td>
 227  *   </tr>
 228  *  </table>
 229  */
 230
 231 /** \page Page_BuildModule_CORE The CORE build module
 232  *
 233  *  The core LUFA build system module, providing common build system help and information targets.
 234  *
 235  *  To use this module in your application makefile, add the following code:
 236  *  \code
 237  *  include $(LUFA_PATH)/Build/lufa_core.mk
 238  *  \endcode
 239  *
 240  *  \section SSec_BuildModule_CORE_Requirements Requirements
 241  *  This module has no requirements outside a standard *nix shell like environment; the <tt>sh</tt>
 242  *  shell, GNU <tt>make</tt> and *nix CoreUtils (<tt>echo</tt>, <tt>printf</tt>, etc.).
 243  *
 244  *  \section SSec_BuildModule_CORE_Targets Targets
 245  *
 246  *  <table>
 247  *   <tr>
 248  *    <td><tt>help</tt></td>
 249  *    <td>Display build system help and configuration information.</td>
 250  *   </tr>
 251  *   <tr>
 252  *    <td><tt>list_targets</tt></td>
 253  *    <td>List all available build targets from the build system.</td>
 254  *   </tr>
 255  *   <tr>
 256  *    <td><tt>list_modules</tt></td>
 257  *    <td>List all available build modules from the build system.</td>
 258  *   </tr>
 259  *   <tr>
 260  *    <td><tt>list_mandatory</tt></td>
 261  *    <td>List all mandatory parameters required by the included modules.</td>
 262  *   </tr>
 263  *   <tr>
 264  *    <td><tt>list_optional</tt></td>
 265  *    <td>List all optional parameters required by the included modules.</td>
 266  *   </tr>
 267  *   <tr>
 268  *    <td><tt>list_provided</tt></td>
 269  *    <td>List all variables provided by the included modules.</td>
 270  *   </tr>
 271  *   <tr>
 272  *    <td><tt>list_macros</tt></td>
 273  *    <td>List all macros provided by the included modules.</td>
 274  *   </tr>
 275  *  </table>
 276  *
 277  *  \section SSec_BuildModule_CORE_MandatoryParams Mandatory Parameters
 278  *
 279  *  <table>
 280  *   <tr>
 281  *    <td><i>None</i></td>
 282  *   </tr>
 283  *  </table>
 284  *
 285  *  \section SSec_BuildModule_CORE_OptionalParams Optional Parameters
 286  *
 287  *  <table>
 288  *   <tr>
 289  *    <td><i>None</i></td>
 290  *   </tr>
 291  *  </table>
 292  *
 293  *  \section SSec_BuildModule_CORE_ProvidedVariables Module Provided Variables
 294  *
 295  *  <table>
 296  *   <tr>
 297  *    <td><i>None</i></td>
 298  *   </tr>
 299  *  </table>
 300  *
 301  *  \section SSec_BuildModule_CORE_ProvidedMacros Module Provided Macros
 302  *
 303  *  <table>
 304  *   <tr>
 305  *    <td><i>None</i></td>
 306  *   </tr>
 307  *  </table>
 308  */
 309
 310 /** \page Page_BuildModule_ATPROGRAM The ATPROGRAM build module
 311  *
 312  *  The ATPROGRAM programming utility LUFA build system module, providing targets to reprogram an
 313  *  Atmel processor FLASH and EEPROM memories with a project's compiled binary output files.
 314  *
 315  *  To use this module in your application makefile, add the following code:
 316  *  \code
 317  *  include $(LUFA_PATH)/Build/lufa_atprogram.mk
 318  *  \endcode
 319  *
 320  *  \section SSec_BuildModule_ATPROGRAM_Requirements Requirements
 321  *  This module requires the <tt>atprogram.exe</tt> utility to be available in your system's <b>PATH</b>
 322  *  variable. The <tt>atprogram.exe</tt> utility is distributed in Atmel AVR Studio 5.x and Atmel Studio 6.x
 323  *  inside the application install folder's "\atbackend" subdirectory.
 324  *
 325  *  \section SSec_BuildModule_ATPROGRAM_Targets Targets
 326  *
 327  *  <table>
 328  *   <tr>
 329  *    <td><tt>atprogram</tt></td>
 330  *    <td>Program the device FLASH memory with the application's executable data.</td>
 331  *   </tr>
 332  *   <tr>
 333  *    <td><tt>atprogram-ee</tt></td>
 334  *    <td>Program the device EEPROM memory with the application's EEPROM data.</td>
 335  *   </tr>
 336  *  </table>
 337  *
 338  *  \section SSec_BuildModule_ATPROGRAM_MandatoryParams Mandatory Parameters
 339  *
 340  *  <table>
 341  *   <tr>
 342  *    <td><tt>MCU</tt></td>
 343  *    <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
 344  *   </tr>
 345  *   <tr>
 346  *    <td><tt>TARGET</tt></td>
 347  *    <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
 348  *   </tr>
 349  *  </table>
 350  *
 351  *  \section SSec_BuildModule_ATPROGRAM_OptionalParams Optional Parameters
 352  *
 353  *  <table>
 354  *   <tr>
 355  *    <td><tt>ATPROGRAM_PROGRAMMER</tt></td>
 356  *    <td>Name of the Atmel programmer or debugger tool to communicate with (e.g. <tt>jtagice3</tt>).</td>
 357  *   </tr>
 358  *   <tr>
 359  *    <td><tt>ATPROGRAM_INTERFACE</tt></td>
 360  *    <td>Name of the programming interface to use when programming the target (e.g. <tt>spi</tt>).</td>
 361  *   </tr>
 362  *   <tr>
 363  *    <td><tt>ATPROGRAM_PORT</tt></td>
 364  *    <td>Name of the communication port to use when when programming with a serially connected tool (e.g. <tt>COM2</tt>).</td>
 365  *   </tr>
 366  *  </table>
 367  *
 368  *  \section SSec_BuildModule_ATPROGRAM_ProvidedVariables Module Provided Variables
 369  *
 370  *  <table>
 371  *   <tr>
 372  *    <td><i>None</i></td>
 373  *   </tr>
 374  *  </table>
 375  *
 376  *  \section SSec_BuildModule_ATPROGRAM_ProvidedMacros Module Provided Macros
 377  *
 378  *  <table>
 379  *   <tr>
 380  *    <td><i>None</i></td>
 381  *   </tr>
 382  *  </table>
 383  */
 384
 385 /** \page Page_BuildModule_AVRDUDE The AVRDUDE build module
 386  *
 387  *  The AVRDUDE programming utility LUFA build system module, providing targets to reprogram an
 388  *  Atmel processor FLASH and EEPROM memories with a project's compiled binary output files.
 389  *
 390  *  To use this module in your application makefile, add the following code:
 391  *  \code
 392  *  include $(LUFA_PATH)/Build/lufa_avrdude.mk
 393  *  \endcode
 394  *
 395  *  \section SSec_BuildModule_AVRDUDE_Requirements Requirements
 396  *  This module requires the <tt>avrdude</tt> utility to be available in your system's <b>PATH</b>
 397  *  variable. The <tt>avrdude</tt> utility is distributed in the old WinAVR project releases for
 398  *  Windows (<a>http://winavr.sourceforge.net</a>) or can be installed on *nix systems via the project's
 399  *  source code (<a>https://savannah.nongnu.org/projects/avrdude</a>) or through the package manager.
 400  *
 401  *  \section SSec_BuildModule_AVRDUDE_Targets Targets
 402  *
 403  *  <table>
 404  *   <tr>
 405  *    <td><tt>avrdude</tt></td>
 406  *    <td>Program the device FLASH memory with the application's executable data.</td>
 407  *   </tr>
 408  *   <tr>
 409  *    <td><tt>avrdude-ee</tt></td>
 410  *    <td>Program the device EEPROM memory with the application's EEPROM data.</td>
 411  *   </tr>
 412  *  </table>
 413  *
 414  *  \section SSec_BuildModule_AVRDUDE_MandatoryParams Mandatory Parameters
 415  *
 416  *  <table>
 417  *   <tr>
 418  *    <td><tt>MCU</tt></td>
 419  *    <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
 420  *   </tr>
 421  *   <tr>
 422  *    <td><tt>TARGET</tt></td>
 423  *    <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
 424  *   </tr>
 425  *  </table>
 426  *
 427  *  \section SSec_BuildModule_AVRDUDE_OptionalParams Optional Parameters
 428  *
 429  *  <table>
 430  *   <tr>
 431  *    <td><tt>AVRDUDE_PROGRAMMER</tt></td>
 432  *    <td>Name of the programmer or debugger tool to communicate with (e.g. <tt>jtagicemkii</tt>).</td>
 433  *   </tr>
 434  *   <tr>
 435  *    <td><tt>AVRDUDE_PORT</tt></td>
 436  *    <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>
 437  *   </tr>
 438  *   <tr>
 439  *    <td><tt>AVRDUDE_FLAGS</tt></td>
 440  *    <td>Additional flags to pass to avrdude when programming, applied after the automatically generated flags.</td>
 441  *   </tr>
 442  *  </table>
 443  *
 444  *  \section SSec_BuildModule_AVRDUDE_ProvidedVariables Module Provided Variables
 445  *
 446  *  <table>
 447  *   <tr>
 448  *    <td><i>None</i></td>
 449  *   </tr>
 450  *  </table>
 451  *
 452  *  \section SSec_BuildModule_AVRDUDE_ProvidedMacros Module Provided Macros
 453  *
 454  *  <table>
 455  *   <tr>
 456  *    <td><i>None</i></td>
 457  *   </tr>
 458  *  </table>
 459  */
 460
 461  /** \page Page_BuildModule_CPPCHECK The CPPCHECK build module
 462  *
 463  *  The CPPCHECK programming utility LUFA build system module, providing targets to statically
 464  *  analyze C and C++ source code for errors and performance/style issues.
 465  *
 466  *  To use this module in your application makefile, add the following code:
 467  *  \code
 468  *  include $(LUFA_PATH)/Build/lufa_cppcheck.mk
 469  *  \endcode
 470  *
 471  *  \section SSec_BuildModule_CPPCHECK_Requirements Requirements
 472  *  This module requires the <tt>cppcheck</tt> utility to be available in your system's <b>PATH</b>
 473  *  variable. The <tt>cppcheck</tt> utility is distributed through the project's home page
 474  *  (<a>http://cppcheck.sourceforge.net</a>) for Windows, and can be installed on *nix systems via
 475  *  the project's source code or through the package manager.
 476  *
 477  *  \section SSec_BuildModule_CPPCHECK_Targets Targets
 478  *
 479  *  <table>
 480  *   <tr>
 481  *    <td><tt>cppcheck</tt></td>
 482  *    <td>Statically analyze the project source code for issues.</td>
 483  *   </tr>
 484  *   <tr>
 485  *    <td><tt>cppcheck-config</tt></td>
 486  *    <td>Check the <tt>cppcheck</tt> configuration - scan source code and warn about missing header files and other issues.</td>
 487  *   </tr>
 488  *  </table>
 489  *
 490  *  \section SSec_BuildModule_CPPCHECK_MandatoryParams Mandatory Parameters
 491  *
 492  *  <table>
 493  *   <tr>
 494  *    <td><tt>SRC</tt></td>
 495  *    <td>List of source files to statically analyze.</td>
 496  *   </tr>
 497  *  </table>
 498  *
 499  *  \section SSec_BuildModule_CPPCHECK_OptionalParams Optional Parameters
 500  *
 501  *  <table>
 502  *   <tr>
 503  *    <td><tt>CPPCHECK_INCLUDES</tt></td>
 504  *    <td>Path of extra directories to check when attemting to resolve C/C++ header file includes.</td>
 505  *   </tr>
 506  *   <tr>
 507  *    <td><tt>CPPCHECK_EXCLUDES</tt></td>
 508  *    <td>Paths or path fragments to exclude when analyzing.</td>
 509  *   </tr>
 510  *   <tr>
 511  *    <td><tt>CPPCHECK_MSG_TEMPLATE</tt></td>
 512  *    <td>Output message template to use when printing errors, warnings and information (see <tt>cppcheck</tt> documentation).</td>
 513  *   </tr>
 514  *   <tr>
 515  *    <td><tt>CPPCHECK_ENABLE</tt></td>
 516  *    <td>Analysis rule categories to enable (see <tt>cppcheck</tt> documentation).</td>
 517  *   </tr>
 518  *   <tr>
 519  *    <td><tt>CPPCHECK_SUPPRESS</tt></td>
 520  *    <td>Specific analysis rules to suppress (see <tt>cppcheck</tt> documentation).</td>
 521  *   </tr>
 522  *   <tr>
 523  *    <td><tt>CPPCHECK_FAIL_ON_WARNING</tt></td>
 524  *    <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>
 525  *   </tr>
 526  *   <tr>
 527  *    <td><tt>CPPCHECK_QUIET</tt></td>
 528  *    <td>Set to <b>Y</b> to suppress all output except warnings and errors, <b>N</b> to show verbose output information.</td>
 529  *   </tr>
 530  *   <tr>
 531  *    <td><tt>CPPCHECK_FLAGS</tt></td>
 532  *    <td>Extra flags to pass to <tt>cppcheck</tt>, after the automatically generated flags.</td>
 533  *   </tr>
 534  *  </table>
 535  *
 536  *  \section SSec_BuildModule_CPPCHECK_ProvidedVariables Module Provided Variables
 537  *
 538  *  <table>
 539  *   <tr>
 540  *    <td><i>None</i></td>
 541  *   </tr>
 542  *  </table>
 543  *
 544  *  \section SSec_BuildModule_CPPCHECK_ProvidedMacros Module Provided Macros
 545  *
 546  *  <table>
 547  *   <tr>
 548  *    <td><i>None</i></td>
 549  *   </tr>
 550  *  </table>
 551  */
 552
 553  /** \page Page_BuildModule_DFU The DFU build module
 554  *
 555  *  The DFU programming utility LUFA build system module, providing targets to reprogram an
 556  *  Atmel processor FLASH and EEPROM memories with a project's compiled binary output files.
 557  *  This module requires a DFU class bootloader to be running in the target, compatible with
 558  *  the DFU bootloader protocol as published by Atmel.
 559  *
 560  *  To use this module in your application makefile, add the following code:
 561  *  \code
 562  *  include $(LUFA_PATH)/Build/lufa_dfu.mk
 563  *  \endcode
 564  *
 565  *  \section SSec_BuildModule_DFU_Requirements Requirements
 566  *  This module requires either the <tt>batchisp</tt> utility from Atmel's FLIP utility, or the open
 567  *  source <tt>dfu-programmer</tt> utility (<a>http://dfu-programmer.sourceforge.net/</a>) to be
 568  *  available in your system's <b>PATH</b> variable. On *nix systems the <tt>dfu-programmer</tt> utility
 569  *  can be installed via the project's source code or through the package manager.
 570  *
 571  *  \section SSec_BuildModule_DFU_Targets Targets
 572  *
 573  *  <table>
 574  *   <tr>
 575  *    <td><tt>dfu</tt></td>
 576  *    <td>Program the device FLASH memory with the application's executable data using <tt>dfu-programmer</tt>.</td>
 577  *   </tr>
 578  *   <tr>
 579  *    <td><tt>dfu-ee</tt></td>
 580  *    <td>Program the device EEPROM memory with the application's EEPROM data using <tt>dfu-programmer</tt>.</td>
 581  *   </tr>
 582  *   <tr>
 583  *    <td><tt>flip</tt></td>
 584  *    <td>Program the device FLASH memory with the application's executable data using <tt>batchisp</tt>.</td>
 585  *   </tr>
 586  *   <tr>
 587  *    <td><tt>flip-ee</tt></td>
 588  *    <td>Program the device EEPROM memory with the application's EEPROM data using <tt>batchisp</tt>.</td>
 589  *   </tr>
 590  *  </table>
 591  *
 592  *  \section SSec_BuildModule_DFU_MandatoryParams Mandatory Parameters
 593  *
 594  *  <table>
 595  *   <tr>
 596  *    <td><tt>MCU</tt></td>
 597  *    <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
 598  *   </tr>
 599  *   <tr>
 600  *    <td><tt>TARGET</tt></td>
 601  *    <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
 602  *   </tr>
 603  *  </table>
 604  *
 605  *  \section SSec_BuildModule_DFU_OptionalParams Optional Parameters
 606  *
 607  *  <table>
 608  *   <tr>
 609  *    <td><i>None</i></td>
 610  *   </tr>
 611  *  </table>
 612  *
 613  *  \section SSec_BuildModule_DFU_ProvidedVariables Module Provided Variables
 614  *
 615  *  <table>
 616  *   <tr>
 617  *    <td><i>None</i></td>
 618  *   </tr>
 619  *  </table>
 620  *
 621  *  \section SSec_BuildModule_DFU_ProvidedMacros Module Provided Macros
 622  *
 623  *  <table>
 624  *   <tr>
 625  *    <td><i>None</i></td>
 626  *   </tr>
 627  *  </table>
 628  */
 629
 630  /** \page Page_BuildModule_DOXYGEN The DOXYGEN build module
 631  *
 632  *  The DOXYGEN code documentation utility LUFA build system module, providing targets to generate
 633  *  project HTML and other format documentation from a set of source files that include special
 634  *  Doxygen comments.
 635  *
 636  *  To use this module in your application makefile, add the following code:
 637  *  \code
 638  *  include $(LUFA_PATH)/Build/lufa_doxygen.mk
 639  *  \endcode
 640  *
 641  *  \section SSec_BuildModule_DOXYGEN_Requirements Requirements
 642  *  This module requires the <tt>doxygen</tt> utility from the Doxygen website
 643  *  (<a>http://www.doxygen.org/</a>) to be available in your system's <b>PATH</b> variable. On *nix
 644  *  systems the <tt>doxygen</tt> utility can be installed via the project's source code or through
 645  *  the package manager.
 646  *
 647  *  \section SSec_BuildModule_DOXYGEN_Targets Targets
 648  *
 649  *  <table>
 650  *   <tr>
 651  *    <td><tt>doxygen</tt></td>
 652  *    <td>Generate project documentation.</td>
 653  *   </tr>
 654  *   <tr>
 655  *    <td><tt>doxygen_create</tt></td>
 656  *    <td>Create a new Doxygen configuration file using the latest template.</td>
 657  *   </tr>
 658  *   <tr>
 659  *    <td><tt>doxygen_upgrade</tt></td>
 660  *    <td>Upgrade an existing Doxygen configuration file to the latest template</td>
 661  *   </tr>
 662  *  </table>
 663  *
 664  *  \section SSec_BuildModule_DOXYGEN_MandatoryParams Mandatory Parameters
 665  *
 666  *  <table>
 667  *   <tr>
 668  *    <td><tt>LUFA_PATH</tt></td>
 669  *    <td>Path to the LUFA library core, either relative or absolute (e.g. <tt>../LUFA-000000/LUFA/</tt>).</td>
 670  *   </tr>
 671  *  </table>
 672  *
 673  *  \section SSec_BuildModule_DOXYGEN_OptionalParams Optional Parameters
 674  *
 675  *  <table>
 676  *   <tr>
 677  *    <td><tt>DOXYGEN_CONF</tt></td>
 678  *    <td>Name and path of the base Doxygen configuration file for the project.</td>
 679  *   </tr>
 680  *   <tr>
 681  *    <td><tt>DOXYGEN_FAIL_ON_WARNING</tt></td>
 682  *    <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>
 683  *   </tr>
 684  *   <tr>
 685  *    <td><tt>DOXYGEN_OVERRIDE_PARAMS</tt></td>
 686  *    <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>
 687  *   </tr>
 688  *  </table>
 689  *
 690  *  \section SSec_BuildModule_DOXYGEN_ProvidedVariables Module Provided Variables
 691  *
 692  *  <table>
 693  *   <tr>
 694  *    <td><i>None</i></td>
 695  *   </tr>
 696  *  </table>
 697  *
 698  *  \section SSec_BuildModule_DOXYGEN_ProvidedMacros Module Provided Macros
 699  *
 700  *  <table>
 701  *   <tr>
 702  *    <td><i>None</i></td>
 703  *   </tr>
 704  *  </table>
 705  */
 706
 707  /** \page Page_BuildModule_HID The HID build module
 708  *
 709  *  The HID programming utility LUFA build system module, providing targets to reprogram an
 710  *  Atmel processor's FLASH memory with a project's compiled binary output file. This module
 711  *  requires a HID class bootloader to be running in the target, using a protocol compatible
 712  *  with the PJRC "HalfKay" protocol (<a>http://www.pjrc.com/teensy/halfkay_protocol.html</a>).
 713  *
 714  *  To use this module in your application makefile, add the following code:
 715  *  \code
 716  *  include $(LUFA_PATH)/Build/lufa_hid.mk
 717  *  \endcode
 718  *
 719  *  \section SSec_BuildModule_HID_Requirements Requirements
 720  *  This module requires either the <tt>hid_bootloader_cli</tt> utility from the included LUFA HID
 721  *  class bootloader API subdirectory, or the <tt>teensy_loader_cli</tt> utility from PJRC
 722  *  (<a>http://www.pjrc.com/teensy/loader_cli.html</a>) to be available in your system's <b>PATH</b>
 723  *  variable.
 724  *
 725  *  \section SSec_BuildModule_HID_Targets Targets
 726  *
 727  *  <table>
 728  *   <tr>
 729  *    <td><tt>hid</tt></td>
 730  *    <td>Program the device FLASH memory with the application's executable data using <tt>hid_bootloader_cli</tt>.</td>
 731  *   </tr>
 732  *   <tr>
 733  *    <td><tt>hid-ee</tt></td>
 734  *    <td>Program the device EEPROM memory with the application's EEPROM data using <tt>hid_bootloader_cli</tt> and
 735  *        a temporary AVR application programmed into the target's FLASH.
 736  *        \note This will erase the currently loaded application in the target.</td>
 737  *   </tr>
 738  *   <tr>
 739  *    <td><tt>teensy</tt></td>
 740  *    <td>Program the device FLASH memory with the application's executable data using <tt>teensy_loader_cli</tt>.</td>
 741  *   </tr>
 742  *   <tr>
 743  *    <td><tt>teensy-ee</tt></td>
 744  *    <td>Program the device EEPROM memory with the application's EEPROM data using <tt>teensy_loader_cli</tt> and
 745  *        a temporary AVR application programmed into the target's FLASH.
 746  *        \note This will erase the currently loaded application in the target.</td>
 747  *   </tr>
 748  *  </table>
 749  *
 750  *  \section SSec_BuildModule_HID_MandatoryParams Mandatory Parameters
 751  *
 752  *  <table>
 753  *   <tr>
 754  *    <td><tt>MCU</tt></td>
 755  *    <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
 756  *   </tr>
 757  *   <tr>
 758  *    <td><tt>TARGET</tt></td>
 759  *    <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
 760  *   </tr>
 761  *  </table>
 762  *
 763  *  \section SSec_BuildModule_HID_OptionalParams Optional Parameters
 764  *
 765  *  <table>
 766  *   <tr>
 767  *    <td><i>None</i></td>
 768  *   </tr>
 769  *  </table>
 770  *
 771  *  \section SSec_BuildModule_HID_ProvidedVariables Module Provided Variables
 772  *
 773  *  <table>
 774  *   <tr>
 775  *    <td><i>None</i></td>
 776  *   </tr>
 777  *  </table>
 778  *
 779  *  \section SSec_BuildModule_HID_ProvidedMacros Module Provided Macros
 780  *
 781  *  <table>
 782  *   <tr>
 783  *    <td><i>None</i></td>
 784  *   </tr>
 785  *  </table>
 786  */
 787
 788  /** \page Page_BuildModule_SOURCES The SOURCES build module
 789  *
 790  *  The SOURCES LUFA build system module, providing variables listing the various LUFA source files
 791  *  required to be build by a project for a given LUFA module. This module gives a way to reference
 792  *  LUFA source files symbolically, so that changes to the library structure do not break the library
 793  *  makefile.
 794  *
 795  *  To use this module in your application makefile, add the following code:
 796  *  \code
 797  *  include $(LUFA_PATH)/Build/lufa_sources.mk
 798  *  \endcode
 799  *
 800  *  \section SSec_BuildModule_SOURCES_Requirements Requirements
 801  *  None.
 802  *
 803  *  \section SSec_BuildModule_SOURCES_Targets Targets
 804  *
 805  *  <table>
 806  *   <tr>
 807  *    <td><i>None</i></td>
 808  *   </tr>
 809  *  </table>
 810  *
 811  *  \section SSec_BuildModule_SOURCES_MandatoryParams Mandatory Parameters
 812  *
 813  *  <table>
 814  *   <tr>
 815  *    <td><tt>LUFA_PATH</tt></td>
 816  *    <td>Path to the LUFA library core, either relative or absolute (e.g. <tt>../LUFA-000000/LUFA/</tt>).</td>
 817  *   </tr>
 818  *   <tr>
 819  *    <td><tt>ARCH</tt></td>
 820  *    <td>Architecture of the target processor (see \ref Page_DeviceSupport).</td>
 821  *   </tr>
 822  *  </table>
 823  *
 824  *  \section SSec_BuildModule_SOURCES_OptionalParams Optional Parameters
 825  *
 826  *  <table>
 827  *   <tr>
 828  *    <td><i>None</i></td>
 829  *   </tr>
 830  *  </table>
 831  *
 832  *  \section SSec_BuildModule_SOURCES_ProvidedVariables Module Provided Variables
 833  *
 834  *  <table>
 835  *   <tr>
 836  *    <td><tt>LUFA_SRC_USB</tt></td>
 837  *    <td>List of LUFA USB driver source files.</td>
 838  *   </tr>
 839  *   <tr>
 840  *    <td><tt>LUFA_SRC_USBCLASS</tt></td>
 841  *    <td>List of LUFA USB Class driver source files.</td>
 842  *   </tr>
 843  *   <tr>
 844  *    <td><tt>LUFA_SRC_TEMPERATURE</tt></td>
 845  *    <td>List of LUFA temperature sensor driver source files.</td>
 846  *   </tr>
 847  *   <tr>
 848  *    <td><tt>LUFA_SRC_SERIAL</tt></td>
 849  *    <td>List of LUFA Serial U(S)ART driver source files.</td>
 850  *   </tr>
 851  *   <tr>
 852  *    <td><tt>LUFA_SRC_TWI</tt></td>
 853  *    <td>List of LUFA TWI driver source files.</td>
 854  *   </tr>
 855  *   <tr>
 856  *    <td><tt>LUFA_SRC_PLATFORM</tt></td>
 857  *    <td>List of LUFA architecture specific platform management source files.</td>
 858  *   </tr>
 859  *  </table>
 860  *
 861  *  \section SSec_BuildModule_SOURCES_ProvidedMacros Module Provided Macros
 862  *
 863  *  <table>
 864  *   <tr>
 865  *    <td><i>None</i></td>
 866  *   </tr>
 867  *  </table>
 868  */
 869
 870 /** \page Page_BuildTroubleshooting Troubleshooting Information
 871  *
 872  *  LUFA uses a lot of advanced features of the AVR-GCC compiler, linker, and surrounding binaries. This can sometimes lead to problems compiling applications if one of these
 873  *  features is buggy in the version of the tools used in a build environment. Missing utilities and incorrectly set makefile configuration options can also result in different
 874  *  errors being produced when compilation or other operations are attempted. The table below lists a set of commonly encountered errors and their resolutions.
 875  *
 876  *  <table>
 877  *    <tr>
 878  *    <th>Problem</th>
 879  *    <th>Resolution</th>
 880  *   </tr>
 881  *   <tr>
 882  *    <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>
 883  *    <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>
 884  *        from other makefiles. Alternatively, make sure you have the latest version of the Atmel Toolchain installed for your system.</td>
 885  *   </tr>
 886  *   <tr>
 887  *    <td>Error &quot;<b><tt>error: ld terminated with signal 11 [Segmentation fault]</tt></b>&quot; shown when compiling.</td>
 888  *    <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>
 889  *   </tr>
 890  *   <tr>
 891  *    <td>Error &quot;<b><tt>EMERGENCY ABORT: INFINITE RECURSION DETECTED</tt></b>&quot; shown when compiling.</td>
 892  *    <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
 893  *        GNU make or other variants of Make causing an infinitely recursive build.</td>
 894  *   </tr>
 895  *   <tr>
 896  *    <td>Error &quot;<b><tt>Unsupported architecture &quot;<i>{X}</i>&quot;</tt></b>&quot; shown when compiling.</td>
 897  *    <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>
 898  *   </tr>
 899  *   <tr>
 900  *    <td>Error &quot;<b><tt>Makefile <i>{X}</i> value not set</tt></b>&quot; shown when compiling.</td>
 901  *    <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
 902  *        build system modules. Define the value in your project makefile and try again.</td>
 903  *   </tr>
 904  *   <tr>
 905  *    <td>Error &quot;<b><tt>Makefile <i>{X}</i> option cannot be blank</tt></b>&quot; shown when compiling.</td>
 906  *    <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
 907  *        option, an empty value is not allowed. Define the nominated setting to a correct non-blank value and try again.</td>
 908  *   </tr>
 909  *   <tr>
 910  *    <td>Error &quot;<b><tt>Makefile <i>{X}</i> option must be Y or N</tt></b>&quot; shown when compiling.</td>
 911  *    <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").
 912  *        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>
 913  *   </tr>
 914  *   <tr>
 915  *    <td>Error &quot;<b><tt>Unknown input source file formats: <i>{X}</i></tt></b>&quot; shown when compiling.</td>
 916  *    <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
 917  *        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>
 918  *   </tr>
 919  *   <tr>
 920  *    <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>
 921  *    <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.
 922  *        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>
 923  *   </tr>
 924  *   <tr>
 925  *    <td>Error &quot;<b><tt>Source file does not exist: <i>{X}</i></tt></b>&quot; shown when compiling.</td>
 926  *    <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
 927  *        relative path given in the user project makefile is correct and try again.</td>
 928  *   </tr>
 929  *   <tr>
 930  *    <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>
 931  *    <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
 932  *        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
 933  *        file.</td>
 934  *   </tr>
 935  *   <tr>
 936  *    <td>Error &quot;<b><tt>avr-gcc: error: unrecognized option '<i>{X}</i>'</tt></b>&quot; shown when compiling.</td>
 937  *    <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
 938  *        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
 939  *        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>
 940  *   </tr>
 941  *   <tr>
 942  *    <td>Error &quot;<b><tt>makefile:{X}: {Y}.mk: No such file or directory</tt></b>&quot; shown when make is invoked.</td>
 943  *    <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
 944  *        absolute path to the LUFA library core.</td>
 945  *   </tr>
 946  *   <tr>
 947  *    <td>Error &quot;<b><tt>fatal error: LUFAConfig.h: No such file or directory</tt></b>&quot; shown when compiling.</td>
 948  *    <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
 949  *        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>
 950  *        parameter.</td>
 951  *   </tr>
 952  *   <tr>
 953  *    <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>
 954  *    <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
 955  *        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
 956  *        compiler may need to be used to ensure that the bootloader is built within the section size constraints of the target device.</td>
 957  *   </tr>
 958  *   <tr>
 959  *    <td>Error &quot;<b><tt>unknown MCU '<i>{X}</i>' specified</tt></b>&quot; shown when compiling.</td>
 960  *    <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
 961  *        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>
 962  *   </tr>
 963  *   <tr>
 964  *    <td>Error &quot;<b><tt>undefined reference to `<i>{X}</i>'</tt></b>&quot; shown when compiling.</td>
 965  *    <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
 966  *        library, you may be missing a LUFA source makefile module (see \ref Page_BuildModule_SOURCES).</td>
 967  *   </tr>
 968  *  </table>
 969  *
 970  *  For troubleshooting other errors you encounter, please see \ref Sec_ProjectHelp.
 971  */