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_BuildSystemOverview 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 minimise the amount of code required in an
  12  *  application makefile. The system is written in GNU Make, and each module is independant 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_Prerequisites.
  17  *
  18  *  To use a LUFA build system module, simply add an include to your project makefile:
  19  *  \code
  20  *  include $(LUFA_PATH)/Build/lufa.core.in
  21  *  \endcode
  22  *
  23  *  And the associated build module targets will be added to your project's build makefile automatically.
  24  *  To call a build target, run <tt>make {TARGET_NAME}</tt> from the command line, substituting in
  25  *  the appropriate target name.
  26  *
  27  *  \see \ref Sec_AppConfigParams for a copy of the sample LUFA project makefile.
  28  *
  29  *  Each build module may have one or more mandatory parameters (GNU Make variables) which <i>must</i>
  30  *  be supplied in the project makefile for the module to work, and one or more optional parameters which
  31  *  may be defined and which will assume a sensible default if not.
  32  *
  33  *  \section SSec_BuildSystemModules Available Modules
  34  *
  35  *  The following modules are included in this LUFA release:
  36  *
  37  *  \li \subpage Page_BuildModule_ATPROGRAM - Device Programming
  38  *  \li \subpage Page_BuildModule_AVRDUDE - Device Programming
  39  *  \li \subpage Page_BuildModule_BUILD - Compiling/Assembling/Linking
  40  *  \li \subpage Page_BuildModule_CORE - Core Build System Functions
  41  *  \li \subpage Page_BuildModule_CPPCHECK - Static Code Analysis
  42  *  \li \subpage Page_BuildModule_DFU - Device Programming
  43  *  \li \subpage Page_BuildModule_DOXYGEN - Automated Source Code Documentation
  44  *  \li \subpage Page_BuildModule_HID - Device Programming
  45  *  \li \subpage Page_BuildModule_SOURCES - LUFA Module Source Code Variables
  46  */
  47
  48  /** \page Page_BuildModule_BUILD The BUILD build module
  49  *
  50  *  The BUILD LUFA build system module, providing targets for the compilation,
  51  *  assembling and linking of an application from source code into binary files
  52  *  suitable for programming into a target device.
  53  *
  54  *  To use this module in your application makefile, add the following code:
  55  *  \code
  56  *  include $(LUFA_PATH)/Build/lufa.build.in
  57  *  \endcode
  58  *
  59  *  \section SSec_BuildModule_BUILD_Requirements Requirements
  60  *  This module requires the the architecture appropriate binaries of the GCC compiler are  available in your
  61  *  system's <b>PATH</b> variable. The GCC compiler and associated toolchain is distributed in Atmel AVR Studio
  62  *  5.x and Atmel Studio 6.x installation directories, as well as in many third party distribution packages.
  63  *
  64  *  \section SSec_BuildModule_BUILD_Targets Targets
  65  *
  66  *  <table>
  67  *   <tr>
  68  *    <td><tt>size</tt></td>
  69  *    <td>Display size of the compiled application FLASH and SRAM segments.</td>
  70  *   </tr>
  71  *   <tr>
  72  *    <td><tt>symbol-sizes</tt></td>
  73  *    <td>Display a size-sorted list of symbols from the compiled application, in decimal bytes.</td>
  74  *   </tr>
  75  *   <tr>
  76  *    <td><tt>check-source</tt></td>
  77  *    <td>Display a list of input SRC source files which cannot be found (if any).</td>
  78  *   </tr>
  79  *   <tr>
  80  *    <td><tt>lib</tt></td>
  81  *    <td>Build and archive all source files into a library A binary file.</td>
  82  *   </tr>
  83  *   <tr>
  84  *    <td><tt>all</tt></td>
  85  *    <td>Build and link the application into ELF debug and HEX binary files.</td>
  86  *   </tr>
  87  *   <tr>
  88  *    <td><tt>elf</tt></td>
  89  *    <td>Build and link the application into an ELF debug file.</td>
  90  *   </tr>
  91  *   <tr>
  92  *    <td><tt>hex</tt></td>
  93  *    <td>Build and link the application and produce HEX and EEP binary files.</td>
  94  *   </tr>
  95  *   <tr>
  96  *    <td><tt>lss</tt></td>
  97  *    <td>Build and link the application and produce a LSS source code/assembly code mixed listing file.</td>
  98  *   </tr>
  99  *   <tr>
 100  *    <td><tt>clean</tt></td>
 101  *    <td>Remove all intermediatary files and binary output files.</td>
 102  *   </tr>
 103  *   <tr>
 104  *    <td><tt>mostlyclean</tt></td>
 105  *    <td>Remove all intermediatary files but preserve any binary output files.</td>
 106  *   </tr>
 107  *  </table>
 108  *
 109  *  \section SSec_BuildModule_BUILD_MandatoryParams Mandatory Parameters
 110  *
 111  *  <table>
 112  *   <tr>
 113  *    <td><tt>TARGET</tt></td>
 114  *    <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
 115  *   </tr>
 116  *   <tr>
 117  *    <td><tt>ARCH</tt></td>
 118  *    <td>Architecture of the target processor (see \ref Page_DeviceSupport).</td>
 119  *   </tr>
 120  *   <tr>
 121  *    <td><tt>MCU</tt></td>
 122  *    <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
 123  *   </tr>
 124  *   <tr>
 125  *    <td><tt>SRC</tt></td>
 126  *    <td>List of relative or absolute paths to the application C (.c), C++ (.cpp) and Assembly (.S) source files.</td>
 127  *   </tr>
 128  *   <tr>
 129  *    <td><tt>F_USB</tt></td>
 130  *    <td>Speed in Hz of the input clock frequency to the target's USB controller.</td>
 131  *   </tr>
 132  *   <tr>
 133  *    <td><tt>LUFA_PATH</tt></td>
 134  *    <td>Path to the LUFA library core, either relative or absolute (e.g. <tt>../LUFA-000000/LUFA/</tt>).</td>
 135  *   </tr>
 136  *  </table>
 137  *
 138  *  \section SSec_BuildModule_BUILD_OptionalParams Optional Parameters
 139  *
 140  *  <table>
 141  *   <tr>
 142  *    <td><tt>BOARD</tt></td>
 143  *    <td>LUFA board hardware drivers to use (see \ref Page_DeviceSupport).</td>
 144  *   </tr>
 145  *   <tr>
 146  *    <td><tt>OPTIMIZATION</tt></td>
 147  *    <td>Optimization level to use when compiling source files (see GCC manual).</td>
 148  *   </tr>
 149  *   <tr>
 150  *    <td><tt>C_STANDARD</tt></td>
 151  *    <td>Version of the C standard to apply when compiling C++ source files (see GCC manual).</td>
 152  *   </tr>
 153  *   <tr>
 154  *    <td><tt>CPP_STANDARD</tt></td>
 155  *    <td>Version of the C++ standard to apply when compiling C++ source files (see GCC manual).</td>
 156  *   </tr>
 157  *   <tr>
 158  *    <td><tt>F_CPU</tt></td>
 159  *    <td>Speed of the processor CPU clock, in Hz.</td>
 160  *   </tr>
 161  *   <tr>
 162  *    <td><tt>C_FLAGS</tt></td>
 163  *    <td>Flags to pass to the C compiler only, after the automatically generated flags.</td>
 164  *   </tr>
 165  *   <tr>
 166  *    <td><tt>CPP_FLAGS</tt></td>
 167  *    <td>Flags to pass to the C++ compiler only, after the automatically generated flags.</td>
 168  *   </tr>
 169  *   <tr>
 170  *    <td><tt>ASM_FLAGS</tt></td>
 171  *    <td>Flags to pass to the assembler only, after the automatically generated flags.</td>
 172  *   </tr>
 173  *   <tr>
 174  *    <td><tt>CC_FLAGS</tt></td>
 175  *    <td>Common flags to pass to the compiler, assembler and linker, after the automatically generated flags.</td>
 176  *   </tr>
 177  *   <tr>
 178  *    <td><tt>LD_FLAGS</tt></td>
 179  *    <td>Flags to pass to the linker, after the automatically generated flags.</td>
 180  *   </tr>
 181  *   <tr>
 182  *    <td><tt>OBJDIR</tt></td>
 183  *    <td>Directory to place the generated object and dependency files. If set to "." the same folder as the source file will be used.
 184  *        \note When this option is enabled, all source filenames <b>must</b> be unique.</td>
 185  *   </tr>
 186  *   <tr>
 187  *    <td><tt>OBJECT_FILES</tt></td>
 188  *    <td>List of additional object files that should be linked into the resulting binary.</td>
 189  *   </tr>
 190  *  </table>
 191  *
 192  *  \section SSec_BuildModule_BUILD_ProvidedVariables Module Provided Variables
 193  *
 194  *  <table>
 195  *   <tr>
 196  *    <td><i>None</i></td>
 197  *   </tr>
 198  *  </table>
 199  *
 200  *  \section SSec_BuildModule_BUILD_ProvidedMacros Module Provided Macros
 201  *
 202  *  <table>
 203  *   <tr>
 204  *    <td><i>None</i></td>
 205  *   </tr>
 206  *  </table>
 207  */
 208
 209 /** \page Page_BuildModule_CORE The CORE build module
 210  *
 211  *  The core LUFA build system module, providing common build system help and information targets.
 212  *
 213  *  To use this module in your application makefile, add the following code:
 214  *  \code
 215  *  include $(LUFA_PATH)/Build/lufa.core.in
 216  *  \endcode
 217  *
 218  *  \section SSec_BuildModule_CORE_Requirements Requirements
 219  *  This module has no requirements outside a standard *nix shell like environment; the <tt>sh</tt>
 220  *  shell, GNU <tt>make</tt> and *nix CoreUtils (<tt>echo</tt>, <tt>printf</tt>, etc.).
 221  *
 222  *  \section SSec_BuildModule_CORE_Targets Targets
 223  *
 224  *  <table>
 225  *   <tr>
 226  *    <td><tt>help</tt></td>
 227  *    <td>Display build system help and configuration information.</td>
 228  *   </tr>
 229  *   <tr>
 230  *    <td><tt>list_targets</tt></td>
 231  *    <td>List all available build targets from the build system.</td>
 232  *   </tr>
 233  *   <tr>
 234  *    <td><tt>list_modules</tt></td>
 235  *    <td>List all available build modules from the build system.</td>
 236  *   </tr>
 237  *   <tr>
 238  *    <td><tt>list_mandatory</tt></td>
 239  *    <td>List all mandatory parameters required by the included modules.</td>
 240  *   </tr>
 241  *   <tr>
 242  *    <td><tt>list_optional</tt></td>
 243  *    <td>List all optional parameters required by the included modules.</td>
 244  *   </tr>
 245  *   <tr>
 246  *    <td><tt>list_provided</tt></td>
 247  *    <td>List all variables provided by the included modules.</td>
 248  *   </tr>
 249  *   <tr>
 250  *    <td><tt>list_macros</tt></td>
 251  *    <td>List all macros provided by the included modules.</td>
 252  *   </tr>
 253  *  </table>
 254  *
 255  *  \section SSec_BuildModule_CORE_MandatoryParams Mandatory Parameters
 256  *
 257  *  <table>
 258  *   <tr>
 259  *    <td><i>None</i></td>
 260  *   </tr>
 261  *  </table>
 262  *
 263  *  \section SSec_BuildModule_CORE_OptionalParams Optional Parameters
 264  *
 265  *  <table>
 266  *   <tr>
 267  *    <td><i>None</i></td>
 268  *   </tr>
 269  *  </table>
 270  *
 271  *  \section SSec_BuildModule_CORE_ProvidedVariables Module Provided Variables
 272  *
 273  *  <table>
 274  *   <tr>
 275  *    <td><i>None</i></td>
 276  *   </tr>
 277  *  </table>
 278  *
 279  *  \section SSec_BuildModule_CORE_ProvidedMacros Module Provided Macros
 280  *
 281  *  <table>
 282  *   <tr>
 283  *    <td><i>None</i></td>
 284  *   </tr>
 285  *  </table>
 286  */
 287
 288 /** \page Page_BuildModule_ATPROGRAM The ATPROGRAM build module
 289  *
 290  *  The ATPROGRAM programming utility LUFA build system module, providing targets to reprogram an
 291  *  Atmel processor FLASH and EEPROM memories with a project's compiled binary output files.
 292  *
 293  *  To use this module in your application makefile, add the following code:
 294  *  \code
 295  *  include $(LUFA_PATH)/Build/lufa.atprogram.in
 296  *  \endcode
 297  *
 298  *  \section SSec_BuildModule_ATPROGRAM_Requirements Requirements
 299  *  This module requires the <tt>atprogram.exe</tt> utility to be available in your system's <b>PATH</b>
 300  *  variable. The <tt>atprogram.exe</tt> utility is distributed in Atmel AVR Studio 5.x and Atmel Studio 6.x
 301  *  inside the application install folder's "\avrdbg" subdirectory.
 302  *
 303  *  \section SSec_BuildModule_ATPROGRAM_Targets Targets
 304  *
 305  *  <table>
 306  *   <tr>
 307  *    <td><tt>atprogram</tt></td>
 308  *    <td>Program the device FLASH memory with the application's executable data.</td>
 309  *   </tr>
 310  *   <tr>
 311  *    <td><tt>atprogram-ee</tt></td>
 312  *    <td>Program the device EEPROM memory with the application's EEPROM data.</td>
 313  *   </tr>
 314  *  </table>
 315  *
 316  *  \section SSec_BuildModule_ATPROGRAM_MandatoryParams Mandatory Parameters
 317  *
 318  *  <table>
 319  *   <tr>
 320  *    <td><tt>MCU</tt></td>
 321  *    <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
 322  *   </tr>
 323  *   <tr>
 324  *    <td><tt>TARGET</tt></td>
 325  *    <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
 326  *   </tr>
 327  *  </table>
 328  *
 329  *  \section SSec_BuildModule_ATPROGRAM_OptionalParams Optional Parameters
 330  *
 331  *  <table>
 332  *   <tr>
 333  *    <td><tt>ATPROGRAM_PROGRAMMER</tt></td>
 334  *    <td>Name of the Atmel programmer or debugger tool to communicate with (e.g. <tt>jtagice3</tt>).</td>
 335  *   </tr>
 336  *   <tr>
 337  *    <td><tt>ATPROGRAM_INTERFACE</tt></td>
 338  *    <td>Name of the programming interface to use when programming the target (e.g. <tt>spi</tt>).</td>
 339  *   </tr>
 340  *   <tr>
 341  *    <td><tt>ATPROGRAM_PORT</tt></td>
 342  *    <td>Name of the communication port to use when when programming with a serially connected tool (e.g. <tt>COM2</tt>).</td>
 343  *   </tr>
 344  *  </table>
 345  *
 346  *  \section SSec_BuildModule_ATPROGRAM_ProvidedVariables Module Provided Variables
 347  *
 348  *  <table>
 349  *   <tr>
 350  *    <td><i>None</i></td>
 351  *   </tr>
 352  *  </table>
 353  *
 354  *  \section SSec_BuildModule_ATPROGRAM_ProvidedMacros Module Provided Macros
 355  *
 356  *  <table>
 357  *   <tr>
 358  *    <td><i>None</i></td>
 359  *   </tr>
 360  *  </table>
 361  */
 362
 363 /** \page Page_BuildModule_AVRDUDE The AVRDUDE build module
 364  *
 365  *  The AVRDUDE programming utility LUFA build system module, providing targets to reprogram an
 366  *  Atmel processor FLASH and EEPROM memories with a project's compiled binary output files.
 367  *
 368  *  To use this module in your application makefile, add the following code:
 369  *  \code
 370  *  include $(LUFA_PATH)/Build/lufa.avrdude.in
 371  *  \endcode
 372  *
 373  *  \section SSec_BuildModule_AVRDUDE_Requirements Requirements
 374  *  This module requires the <tt>avrdude</tt> utility to be available in your system's <b>PATH</b>
 375  *  variable. The <tt>avrdude</tt> utility is distributed in the old WinAVR project releases for
 376  *  Windows (<a>winavr.sourceforge.net</a>) or can be installed on *nix systems via the project's
 377  *  source code (<a>https://savannah.nongnu.org/projects/avrdude</a>) or through the package manager.
 378  *
 379  *  \section SSec_BuildModule_AVRDUDE_Targets Targets
 380  *
 381  *  <table>
 382  *   <tr>
 383  *    <td><tt>avrdude</tt></td>
 384  *    <td>Program the device FLASH memory with the application's executable data.</td>
 385  *   </tr>
 386  *   <tr>
 387  *    <td><tt>avrdude</tt></td>
 388  *    <td>Program the device EEPROM memory with the application's EEPROM data.</td>
 389  *   </tr>
 390  *  </table>
 391  *
 392  *  \section SSec_BuildModule_AVRDUDE_MandatoryParams Mandatory Parameters
 393  *
 394  *  <table>
 395  *   <tr>
 396  *    <td><tt>MCU</tt></td>
 397  *    <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
 398  *   </tr>
 399  *   <tr>
 400  *    <td><tt>TARGET</tt></td>
 401  *    <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
 402  *   </tr>
 403  *  </table>
 404  *
 405  *  \section SSec_BuildModule_AVRDUDE_OptionalParams Optional Parameters
 406  *
 407  *  <table>
 408  *   <tr>
 409  *    <td><tt>AVRDUDE_PROGRAMMER</tt></td>
 410  *    <td>Name of the programmer or debugger tool to communicate with (e.g. <tt>jtagicemkii</tt>).</td>
 411  *   </tr>
 412  *   <tr>
 413  *    <td><tt>ATPROGRAM_PORT</tt></td>
 414  *    <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>
 415  *   </tr>
 416  *   <tr>
 417  *    <td><tt>ATPROGRAM_FLAGS</tt></td>
 418  *    <td>Additional flags to pass to avrdude when programming, applied after the automatically generated flags.</td>
 419  *   </tr>
 420  *  </table>
 421  *
 422  *  \section SSec_BuildModule_AVRDUDE_ProvidedVariables Module Provided Variables
 423  *
 424  *  <table>
 425  *   <tr>
 426  *    <td><i>None</i></td>
 427  *   </tr>
 428  *  </table>
 429  *
 430  *  \section SSec_BuildModule_AVRDUDE_ProvidedMacros Module Provided Macros
 431  *
 432  *  <table>
 433  *   <tr>
 434  *    <td><i>None</i></td>
 435  *   </tr>
 436  *  </table>
 437  */
 438
 439  /** \page Page_BuildModule_CPPCHECK The CPPCHECK build module
 440  *
 441  *  The CPPCHECK programming utility LUFA build system module, providing targets to statically
 442  *  analyze C and C++ source code for errors and performance/style issues.
 443  *
 444  *  To use this module in your application makefile, add the following code:
 445  *  \code
 446  *  include $(LUFA_PATH)/Build/lufa.cppcheck.in
 447  *  \endcode
 448  *
 449  *  \section SSec_BuildModule_CPPCHECK_Requirements Requirements
 450  *  This module requires the <tt>cppcheck</tt> utility to be available in your system's <b>PATH</b>
 451  *  variable. The <tt>cppcheck</tt> utility is distributed through the project's home page
 452  *  (<a>http://cppcheck.sourceforge.net</a>) for Windows, and can be installed on *nix systems via
 453  *  the project's source code or through the package manager.
 454  *
 455  *  \section SSec_BuildModule_CPPCHECK_Targets Targets
 456  *
 457  *  <table>
 458  *   <tr>
 459  *    <td><tt>cppcheck</tt></td>
 460  *    <td>Statically analyze the project source code for issues.</td>
 461  *   </tr>
 462  *   <tr>
 463  *    <td><tt>cppcheck-config</tt></td>
 464  *    <td>Check the <tt>cppcheck</tt> configuration - scan source code and warn about missing header files and other issues.</td>
 465  *   </tr>
 466  *  </table>
 467  *
 468  *  \section SSec_BuildModule_CPPCHECK_MandatoryParams Mandatory Parameters
 469  *
 470  *  <table>
 471  *   <tr>
 472  *    <td><tt>SRC</tt></td>
 473  *    <td>List of source files to statically analyze.</td>
 474  *   </tr>
 475  *  </table>
 476  *
 477  *  \section SSec_BuildModule_CPPCHECK_OptionalParams Optional Parameters
 478  *
 479  *  <table>
 480  *   <tr>
 481  *    <td><tt>CPPCHECK_INCLUDES</tt></td>
 482  *    <td>Path of extra directories to check when attemting to resolve C/C++ header file includes.</td>
 483  *   </tr>
 484  *   <tr>
 485  *    <td><tt>CPPCHECK_EXCLUDES</tt></td>
 486  *    <td>Paths or path fragments to exclude when analyzing.</td>
 487  *   </tr>
 488  *   <tr>
 489  *    <td><tt>CPPCHECK_MSG_TEMPLATE</tt></td>
 490  *    <td>Output message template to use when printing errors, warnings and information (see <tt>cppcheck</tt> documentation).</td>
 491  *   </tr>
 492  *   <tr>
 493  *    <td><tt>CPPCHECK_ENABLE</tt></td>
 494  *    <td>Analysis rule categories to enable (see <tt>cppcheck</tt> documentation).</td>
 495  *   </tr>
 496  *   <tr>
 497  *    <td><tt>CPPCHECK_SUPPRESS</tt></td>
 498  *    <td>Specific analysis rules to suppress (see <tt>cppcheck</tt> documentation).</td>
 499  *   </tr>
 500  *   <tr>
 501  *    <td><tt>CPPCHECK_FAIL_ON_WARNING</tt></td>
 502  *    <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>
 503  *   </tr>
 504  *   <tr>
 505  *    <td><tt>CPPCHECK_QUIET</tt></td>
 506  *    <td>Set to <b>Y</b> to suppress all output except warnings and errors, <b>N</b> to show verbose output information.</td>
 507  *   </tr>
 508  *   <tr>
 509  *    <td><tt>CPPCHECK_FLAGS</tt></td>
 510  *    <td>Extra flags to pass to <tt>cppcheck</tt>, after the automatically generated flags.</td>
 511  *   </tr>
 512  *  </table>
 513  *
 514  *  \section SSec_BuildModule_CPPCHECK_ProvidedVariables Module Provided Variables
 515  *
 516  *  <table>
 517  *   <tr>
 518  *    <td><i>None</i></td>
 519  *   </tr>
 520  *  </table>
 521  *
 522  *  \section SSec_BuildModule_CPPCHECK_ProvidedMacros Module Provided Macros
 523  *
 524  *  <table>
 525  *   <tr>
 526  *    <td><i>None</i></td>
 527  *   </tr>
 528  *  </table>
 529  */
 530
 531  /** \page Page_BuildModule_DFU The DFU build module
 532  *
 533  *  The DFU programming utility LUFA build system module, providing targets to reprogram an
 534  *  Atmel processor FLASH and EEPROM memories with a project's compiled binary output files.
 535  *  This module requires a DFU class bootloader to be running in the target, compatible with
 536  *  the DFU bootloader protocol as published by Atmel.
 537  *
 538  *  To use this module in your application makefile, add the following code:
 539  *  \code
 540  *  include $(LUFA_PATH)/Build/lufa.dfu.in
 541  *  \endcode
 542  *
 543  *  \section SSec_BuildModule_DFU_Requirements Requirements
 544  *  This module requires either the <tt>batchisp</tt> utility from Atmel's FLIP utility, or the open
 545  *  source <tt>dfu-programmer</tt> utility (<a>http://dfu-programmer.sourceforge.net/</a>) to be
 546  *  available in your system's <b>PATH</b> variable. On *nix systems the <tt>dfu-programmer</tt> utility
 547  *  can be installed via the project's source code or through the package manager.
 548  *
 549  *  \section SSec_BuildModule_DFU_Targets Targets
 550  *
 551  *  <table>
 552  *   <tr>
 553  *    <td><tt>dfu</tt></td>
 554  *    <td>Program the device FLASH memory with the application's executable data using <tt>dfu-programmer</tt>.</td>
 555  *   </tr>
 556  *   <tr>
 557  *    <td><tt>dfu-ee</tt></td>
 558  *    <td>Program the device EEPROM memory with the application's EEPROM data using <tt>dfu-programmer</tt>.</td>
 559  *   </tr>
 560  *   <tr>
 561  *    <td><tt>flip</tt></td>
 562  *    <td>Program the device FLASH memory with the application's executable data using <tt>batchisp</tt>.</td>
 563  *   </tr>
 564  *   <tr>
 565  *    <td><tt>flip-ee</tt></td>
 566  *    <td>Program the device EEPROM memory with the application's EEPROM data using <tt>batchisp</tt>.</td>
 567  *   </tr>
 568  *  </table>
 569  *
 570  *  \section SSec_BuildModule_DFU_MandatoryParams Mandatory Parameters
 571  *
 572  *  <table>
 573  *   <tr>
 574  *    <td><tt>MCU</tt></td>
 575  *    <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
 576  *   </tr>
 577  *   <tr>
 578  *    <td><tt>TARGET</tt></td>
 579  *    <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
 580  *   </tr>
 581  *  </table>
 582  *
 583  *  \section SSec_BuildModule_DFU_OptionalParams Optional Parameters
 584  *
 585  *  <table>
 586  *   <tr>
 587  *    <td><i>None</i></td>
 588  *   </tr>
 589  *  </table>
 590  *
 591  *  \section SSec_BuildModule_DFU_ProvidedVariables Module Provided Variables
 592  *
 593  *  <table>
 594  *   <tr>
 595  *    <td><i>None</i></td>
 596  *   </tr>
 597  *  </table>
 598  *
 599  *  \section SSec_BuildModule_DFU_ProvidedMacros Module Provided Macros
 600  *
 601  *  <table>
 602  *   <tr>
 603  *    <td><i>None</i></td>
 604  *   </tr>
 605  *  </table>
 606  */
 607
 608  /** \page Page_BuildModule_DOXYGEN The DOXYGEN build module
 609  *
 610  *  The DOXYGEN code documentation utility LUFA build system module, providing targets to generate
 611  *  project HTML and other format documentation from a set of source files that include special
 612  *  Doxygen comments.
 613  *
 614  *  To use this module in your application makefile, add the following code:
 615  *  \code
 616  *  include $(LUFA_PATH)/Build/lufa.doxygen.in
 617  *  \endcode
 618  *
 619  *  \section SSec_BuildModule_DOXYGEN_Requirements Requirements
 620  *  This module requires the <tt>doxygen</tt> utility from the Doxygen website
 621  *  (<a>http://www.stack.nl/~dimitri/doxygen/</a>) to be available in your system's <b>PATH</b>
 622  *  variable. On *nix systems the <tt>doxygen</tt> utility can be installed via the project's source
 623  *  code or through the package manager.
 624  *
 625  *  \section SSec_BuildModule_DOXYGEN_Targets Targets
 626  *
 627  *  <table>
 628  *   <tr>
 629  *    <td><tt>doxygen</tt></td>
 630  *    <td>Generate project documentation.</td>
 631  *   </tr>
 632  *  </table>
 633  *
 634  *  \section SSec_BuildModule_DOXYGEN_MandatoryParams Mandatory Parameters
 635  *
 636  *  <table>
 637  *   <tr>
 638  *    <td><tt>LUFA_PATH</tt></td>
 639  *    <td>Path to the LUFA library core, either relative or absolute (e.g. <tt>../LUFA-000000/LUFA/</tt>).</td>
 640  *   </tr>
 641  *  </table>
 642  *
 643  *  \section SSec_BuildModule_DOXYGEN_OptionalParams Optional Parameters
 644  *
 645  *  <table>
 646  *   <tr>
 647  *    <td><tt>DOXYGEN_CONF</tt></td>
 648  *    <td>Name and path of the base Doxygen configuration file for the project.</td>
 649  *   </tr>
 650  *   <tr>
 651  *    <td><tt>DOXYGEN_FAIL_ON_WARNING</tt></td>
 652  *    <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>
 653  *   </tr>
 654  *   <tr>
 655  *    <td><tt>DOXYGEN_OVERRIDE_PARAMS</tt></td>
 656  *    <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>
 657  *   </tr>
 658  *  </table>
 659  *
 660  *  \section SSec_BuildModule_DOXYGEN_ProvidedVariables Module Provided Variables
 661  *
 662  *  <table>
 663  *   <tr>
 664  *    <td><i>None</i></td>
 665  *   </tr>
 666  *  </table>
 667  *
 668  *  \section SSec_BuildModule_DOXYGEN_ProvidedMacros Module Provided Macros
 669  *
 670  *  <table>
 671  *   <tr>
 672  *    <td><i>None</i></td>
 673  *   </tr>
 674  *  </table>
 675  */
 676
 677  /** \page Page_BuildModule_HID The HID build module
 678  *
 679  *  The HID programming utility LUFA build system module, providing targets to reprogram an
 680  *  Atmel processor's FLASH memory with a project's compiled binary output file. This module
 681  *  requires a HID class bootloader to be running in the target, using a protocol compatible
 682  *  with the PJRC "HalfKay" protocol (<a>http://www.pjrc.com/teensy/halfkay_protocol.html</a>).
 683  *
 684  *  To use this module in your application makefile, add the following code:
 685  *  \code
 686  *  include $(LUFA_PATH)/Build/lufa.hid.in
 687  *  \endcode
 688  *
 689  *  \section SSec_BuildModule_HID_Requirements Requirements
 690  *  This module requires either the <tt>hid_bootloader_cli</tt> utility from the included LUFA HID
 691  *  class bootloader API subdirectory, or the <tt>teensy_loader_cli</tt> utility from PJRC
 692  *  (<a>http://www.pjrc.com/teensy/loader_cli.html</a>) to be available in your system's <b>PATH</b>
 693  *  variable.
 694  *
 695  *  \section SSec_BuildModule_HID_Targets Targets
 696  *
 697  *  <table>
 698  *   <tr>
 699  *    <td><tt>hid</tt></td>
 700  *    <td>Program the device FLASH memory with the application's executable data using <tt>hid_bootloader_cli</tt>.</td>
 701  *   </tr>
 702  *   <tr>
 703  *    <td><tt>hid-ee</tt></td>
 704  *    <td>Program the device EEPROM memory with the application's EEPROM data using <tt>hid_bootloader_cli</tt> and
 705  *        a temporary AVR application programmed into the target's FLASH.
 706  *        \note This will erase the currently loaded application in the target.</td>
 707  *   </tr>
 708  *   <tr>
 709  *    <td><tt>hid-teensy</tt></td>
 710  *    <td>Program the device FLASH memory with the application's executable data using <tt>teensy_loader_cli</tt>.</td>
 711  *   </tr>
 712  *   <tr>
 713  *    <td><tt>hid-teensy-ee</tt></td>
 714  *    <td>Program the device EEPROM memory with the application's EEPROM data using <tt>teensy_loader_cli</tt> and
 715  *        a temporary AVR application programmed into the target's FLASH.
 716  *        \note This will erase the currently loaded application in the target.</td>
 717  *   </tr>
 718  *  </table>
 719  *
 720  *  \section SSec_BuildModule_HID_MandatoryParams Mandatory Parameters
 721  *
 722  *  <table>
 723  *   <tr>
 724  *    <td><tt>MCU</tt></td>
 725  *    <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
 726  *   </tr>
 727  *   <tr>
 728  *    <td><tt>TARGET</tt></td>
 729  *    <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
 730  *   </tr>
 731  *  </table>
 732  *
 733  *  \section SSec_BuildModule_HID_OptionalParams Optional Parameters
 734  *
 735  *  <table>
 736  *   <tr>
 737  *    <td><i>None</i></td>
 738  *   </tr>
 739  *  </table>
 740  *
 741  *  \section SSec_BuildModule_HID_ProvidedVariables Module Provided Variables
 742  *
 743  *  <table>
 744  *   <tr>
 745  *    <td><i>None</i></td>
 746  *   </tr>
 747  *  </table>
 748  *
 749  *  \section SSec_BuildModule_HID_ProvidedMacros Module Provided Macros
 750  *
 751  *  <table>
 752  *   <tr>
 753  *    <td><i>None</i></td>
 754  *   </tr>
 755  *  </table>
 756  */
 757
 758  /** \page Page_BuildModule_SOURCES The SOURCES build module
 759  *
 760  *  The SOURCES LUFA build system module, providing variables listing the various LUFA source files
 761  *  required to be build by a project for a given LUFA module. This module gives a way to reference
 762  *  LUFA source files symbollically, so that changes to the library structure do not break the library
 763  *  makefile.
 764  *
 765  *  To use this module in your application makefile, add the following code:
 766  *  \code
 767  *  include $(LUFA_PATH)/Build/lufa.sources.in
 768  *  \endcode
 769  *
 770  *  \section SSec_BuildModule_SOURCES_Requirements Requirements
 771  *  None.
 772  *
 773  *  \section SSec_BuildModule_SOURCES_Targets Targets
 774  *
 775  *  <table>
 776  *   <tr>
 777  *    <td><i>None</i></td>
 778  *   </tr>
 779  *  </table>
 780  *
 781  *  \section SSec_BuildModule_SOURCES_MandatoryParams Mandatory Parameters
 782  *
 783  *  <table>
 784  *   <tr>
 785  *    <td><tt>LUFA_PATH</tt></td>
 786  *    <td>Path to the LUFA library core, either relative or absolute (e.g. <tt>../LUFA-000000/LUFA/</tt>).</td>
 787  *   </tr>
 788  *   <tr>
 789  *    <td><tt>ARCH</tt></td>
 790  *    <td>Architecture of the target processor (see \ref Page_DeviceSupport).</td>
 791  *   </tr>
 792  *  </table>
 793  *
 794  *  \section SSec_BuildModule_SOURCES_OptionalParams Optional Parameters
 795  *
 796  *  <table>
 797  *   <tr>
 798  *    <td><i>None</i></td>
 799  *   </tr>
 800  *  </table>
 801  *
 802  *  \section SSec_BuildModule_SOURCES_ProvidedVariables Module Provided Variables
 803  *
 804  *  <table>
 805  *   <tr>
 806  *    <td><tt>LUFA_SRC_USB</tt></td>
 807  *    <td>List of LUFA USB driver source files.</td>
 808  *   </tr>
 809  *   <tr>
 810  *    <td><tt>LUFA_SRC_USBCLASS</tt></td>
 811  *    <td>List of LUFA USB Class driver source files.</td>
 812  *   </tr>
 813  *   <tr>
 814  *    <td><tt>LUFA_SRC_TEMPERATURE</tt></td>
 815  *    <td>List of LUFA temperature sensor driver source files.</td>
 816  *   </tr>
 817  *   <tr>
 818  *    <td><tt>LUFA_SRC_SERIAL</tt></td>
 819  *    <td>List of LUFA Serial U(S)ART driver source files.</td>
 820  *   </tr>
 821  *   <tr>
 822  *    <td><tt>LUFA_SRC_TWI</tt></td>
 823  *    <td>List of LUFA TWI driver source files.</td>
 824  *   </tr>
 825  *   <tr>
 826  *    <td><tt>LUFA_SRC_PLATFORM</tt></td>
 827  *    <td>List of LUFA architecture specific platform management source files.</td>
 828  *   </tr>
 829  *  </table>
 830  *
 831  *  \section SSec_BuildModule_SOURCES_ProvidedMacros Module Provided Macros
 832  *
 833  *  <table>
 834  *   <tr>
 835  *    <td><i>None</i></td>
 836  *   </tr>
 837  *  </table>
 838  */