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