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