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