protocol/lufa/LUFA-120730/LUFA/DoxygenPages/BuildSystem.txt

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