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