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