LUFA/DoxygenPages/BuildSystem.txt

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