LUFA/DoxygenPages/BuildSystem.txt

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