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_BuildSystem_Overview Overview of the LUFA Build System
  10  *  The LUFA build system was originally an attempt at making a set of
  11  *  re-usable, modular build make files which could be referenced in a LUFA
  12  *  powered project, to minimize the amount of code required in an
  13  *  application makefile.
  14  *
  15  *  As it turned out to be fairly generic in nature, it was split out into its
  16  *  own separate project, called DMBS (<i>Dean's Makefile Build System</i>)
  17  *  which is released into the public domain. LUFA specific portions of the
  18  *  LUFA build system extend DMBS, and provide a universal build system for all
  19  *  LUFA projects.
  20  *
  21  *  The latest DMBS project information can be found at:
  22  *  https://github.com/abcminiuser/dmbs
  23  *
  24  *  DMBS is written in GNU Make, and each module is independent of one-another.
  25  *
  26  *  \section SSec_BuildSystem_Using Using the LUFA Build System
  27  *
  28  *  For details on the prerequisites needed for Linux and Windows machines to be able to use the LUFA
  29  *  build system, see \ref Sec_CompilingApps_Prerequisites.
  30  *
  31  *  To use a LUFA build system module, simply add an include to your project makefile. All user projects
  32  *  should at a minimum include \ref Page_BuildModule_CORE for base functionality:
  33  *  \code
  34  *  include $(LUFA_PATH)/Build/lufa_core.mk
  35  *  \endcode
  36  *
  37  *  Once included in your project makefile, the associated build module targets will be added to your
  38  *  project's build makefile targets automatically. To call a build target, run <tt>make {TARGET_NAME}</tt>
  39  *  from the command line, substituting in the appropriate target name.
  40  *
  41  *  \see \ref Sec_ConfiguringApps_AppMakefileParams for a copy of the sample LUFA project makefile.
  42  *
  43  *  Each build module may have one or more mandatory parameters (GNU Make variables) which <i>must</i>
  44  *  be supplied in the project makefile for the module to work, and one or more optional parameters which
  45  *  may be defined and which will assume a sensible default if not.
  46  *
  47  *  \section SSec_BuildSystem_Modules Available Modules
  48  *
  49  *  The following modules are included in this LUFA release:
  50  *
  51  *  \li \subpage Page_BuildModule_ATPROGRAM - Device Programming
  52  *  \li \subpage Page_BuildModule_AVRDUDE - Device Programming
  53  *  \li \subpage Page_BuildModule_BUILD - Compiling/Assembling/Linking
  54  *  \li \subpage Page_BuildModule_CORE - Core Build System Functions
  55  *  \li \subpage Page_BuildModule_CPPCHECK - Static Code Analysis
  56  *  \li \subpage Page_BuildModule_DFU - Device Programming
  57  *  \li \subpage Page_BuildModule_DOXYGEN - Automated Source Code Documentation
  58  *  \li \subpage Page_BuildModule_HID - Device Programming
  59  *  \li \subpage Page_BuildModule_SOURCES - LUFA Module Source Code Variables
  60  *
  61  *  If you have problems building using the LUFA build system, see \subpage Page_BuildTroubleshooting for resolution steps.
  62  */
  63
  64  /** \page Page_BuildModule_BUILD The BUILD build module
  65  *
  66  *  The BUILD LUFA build system module, providing targets for the compilation,
  67  *  assembling and linking of an application from source code into binary files
  68  *  suitable for programming into a target device, using the GCC compiler.
  69  *
  70  *  To use this module in your application makefile, add the following code:
  71  *  \code
  72  *  include $(LUFA_PATH)/Build/lufa_build.mk
  73  *  \endcode
  74  *
  75  *  \section SSec_BuildModule_BUILD_Requirements Requirements
  76  *  This module requires the the architecture appropriate binaries of the GCC compiler are available in your
  77  *  system's <b>PATH</b> variable. The GCC compiler and associated toolchain is distributed in Atmel AVR Studio
  78  *  5.x and Atmel Studio 6.x installation directories, as well as in many third party distribution packages.
  79  *
  80  *  \section SSec_BuildModule_BUILD_Targets Targets
  81  *
  82  *  <table>
  83  *   <tr>
  84  *    <td><tt>size</tt></td>
  85  *    <td>Display size of the compiled application FLASH and SRAM segments.</td>
  86  *   </tr>
  87  *   <tr>
  88  *    <td><tt>symbol-sizes</tt></td>
  89  *    <td>Display a size-sorted list of symbols from the compiled application, in decimal bytes.</td>
  90  *   </tr>
  91  *   <tr>
  92  *    <td><tt>lib</tt></td>
  93  *    <td>Build and archive all source files into a library A binary file.</td>
  94  *   </tr>
  95  *   <tr>
  96  *    <td><tt>all</tt></td>
  97  *    <td>Build and link the application into ELF debug and HEX binary files.</td>
  98  *   </tr>
  99  *   <tr>
 100  *    <td><tt>elf</tt></td>
 101  *    <td>Build and link the application into an ELF debug file.</td>
 102  *   </tr>
 103  *   <tr>
 104  *    <td><tt>bin</tt></td>
 105  *    <td>Build and link the application and produce a BIN binary file.</td>
 106  *   </tr>
 107  *   <tr>
 108  *    <td><tt>hex</tt></td>
 109  *    <td>Build and link the application and produce HEX and EEP binary files.</td>
 110  *   </tr>
 111  *   <tr>
 112  *    <td><tt>lss</tt></td>
 113  *    <td>Build and link the application and produce a LSS source code/assembly code mixed listing file.</td>
 114  *   </tr>
 115  *   <tr>
 116  *    <td><tt>clean</tt></td>
 117  *    <td>Remove all intermediary files and binary output files.</td>
 118  *   </tr>
 119  *   <tr>
 120  *    <td><tt>mostlyclean</tt></td>
 121  *    <td>Remove all intermediary files but preserve any binary output files.</td>
 122  *   </tr>
 123  *   <tr>
 124  *    <td><tt><i>&lt;filename&gt;</i>.s</tt></td>
 125  *    <td>Create an assembly listing of a given input C/C++ source file.</td>
 126  *   </tr>
 127  *  </table>
 128  *
 129  *  \section SSec_BuildModule_BUILD_MandatoryParams Mandatory Parameters
 130  *
 131  *  <table>
 132  *   <tr>
 133  *    <td><tt>TARGET</tt></td>
 134  *    <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
 135  *   </tr>
 136  *   <tr>
 137  *    <td><tt>ARCH</tt></td>
 138  *    <td>Architecture of the target processor (see \ref Page_DeviceSupport).</td>
 139  *   </tr>
 140  *   <tr>
 141  *    <td><tt>MCU</tt></td>
 142  *    <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
 143  *   </tr>
 144  *   <tr>
 145  *    <td><tt>SRC</tt></td>
 146  *    <td>List of relative or absolute paths to the application C (.c), C++ (.cpp) and Assembly (.S) source files.</td>
 147  *   </tr>
 148  *   <tr>
 149  *    <td><tt>F_USB</tt></td>
 150  *    <td>Speed in Hz of the input clock frequency to the target's USB controller.</td>
 151  *   </tr>
 152  *   <tr>
 153  *    <td><tt>LUFA_PATH</tt></td>
 154  *    <td>Path to the LUFA library core, either relative or absolute (e.g. <tt>../LUFA-000000/LUFA/</tt>).</td>
 155  *   </tr>
 156  *  </table>
 157  *
 158  *  \section SSec_BuildModule_BUILD_OptionalParams Optional Parameters
 159  *
 160  *  <table>
 161  *   <tr>
 162  *    <td><tt>BOARD</tt></td>
 163  *    <td>LUFA board hardware drivers to use (see \ref Page_DeviceSupport).</td>
 164  *   </tr>
 165  *   <tr>
 166  *    <td><tt>OPTIMIZATION</tt></td>
 167  *    <td>Optimization level to use when compiling source files (see GCC manual).</td>
 168  *   </tr>
 169  *   <tr>
 170  *    <td><tt>C_STANDARD</tt></td>
 171  *    <td>Version of the C standard to apply when compiling C++ source files (see GCC manual).</td>
 172  *   </tr>
 173  *   <tr>
 174  *    <td><tt>CPP_STANDARD</tt></td>
 175  *    <td>Version of the C++ standard to apply when compiling C++ source files (see GCC manual).</td>
 176  *   </tr>
 177  *   <tr>
 178  *    <td><tt>DEBUG_FORMAT</tt></td>
 179  *    <td>Format of the debug information to embed in the generated object files (see GCC manual).</td>
 180  *   </tr>
 181  *   <tr>
 182  *    <td><tt>DEBUG_LEVEL</tt></td>
 183  *    <td>Level of the debugging information to embed in the generated object files (see GCC manual).</td>
 184  *   </tr>
 185  *   <tr>
 186  *    <td><tt>F_CPU</tt></td>
 187  *    <td>Speed of the processor CPU clock, in Hz.</td>
 188  *   </tr>
 189  *   <tr>
 190  *    <td><tt>C_FLAGS</tt></td>
 191  *    <td>Flags to pass to the C compiler only, after the automatically generated flags.</td>
 192  *   </tr>
 193  *   <tr>
 194  *    <td><tt>CPP_FLAGS</tt></td>
 195  *    <td>Flags to pass to the C++ compiler only, after the automatically generated flags.</td>
 196  *   </tr>
 197  *   <tr>
 198  *    <td><tt>ASM_FLAGS</tt></td>
 199  *    <td>Flags to pass to the assembler only, after the automatically generated flags.</td>
 200  *   </tr>
 201  *   <tr>
 202  *    <td><tt>CC_FLAGS</tt></td>
 203  *    <td>Common flags to pass to the C/C++ compiler and assembler, after the automatically generated flags.</td>
 204  *   </tr>
 205  *   <tr>
 206  *    <td><tt>COMPILER_PATH</tt></td>
 207  *    <td>Directory where the C/C++ toolchain is located, if not available in the system <tt>PATH</tt>.</td>
 208  *   </tr>
 209  *   <tr>
 210  *    <td><tt>LD_FLAGS</tt></td>
 211  *    <td>Flags to pass to the linker, after the automatically generated flags.</td>
 212  *   </tr>
 213  *   <tr>
 214  *    <td><tt>LINKER_RELAXATIONS</tt></td>
 215  *    <td>Enables or disables linker relaxations when linking the application binary. This can reduce the total size
 216  *        of the application by replacing full \c CALL instructions with smaller \c RCALL instructions where possible.
 217  *        \note On some unpatched versions of binutils, this can cause link failures in some circumstances. If you
 218  *              receive a link error <tt>relocation truncated to fit: R_AVR_13_PCREL</tt>, disable this setting.</td>
 219  *   </tr>
 220  *   <tr>
 221  *    <td><tt>OBJDIR</tt></td>
 222  *    <td>Directory to place the generated object and dependency files. If set to "." the same folder as the source file will be used.
 223  *        \note When this option is enabled, all source filenames <b>must</b> be unique.</td>
 224  *   </tr>
 225  *   <tr>
 226  *    <td><tt>OBJECT_FILES</tt></td>
 227  *    <td>List of additional object files that should be linked into the resulting binary.</td>
 228  *   </tr>
 229  *  </table>
 230  *
 231  *  \section SSec_BuildModule_BUILD_ProvidedVariables Module Provided Variables
 232  *
 233  *  <table>
 234  *   <tr>
 235  *    <td><i>None</i></td>
 236  *   </tr>
 237  *  </table>
 238  *
 239  *  \section SSec_BuildModule_BUILD_ProvidedMacros Module Provided Macros
 240  *
 241  *  <table>
 242  *   <tr>
 243  *    <td><i>None</i></td>
 244  *   </tr>
 245  *  </table>
 246  */
 247
 248 /** \page Page_BuildModule_CORE The CORE build module
 249  *
 250  *  The core LUFA build system module, providing common build system help and information targets.
 251  *
 252  *  To use this module in your application makefile, add the following code:
 253  *  \code
 254  *  include $(LUFA_PATH)/Build/lufa_core.mk
 255  *  \endcode
 256  *
 257  *  \section SSec_BuildModule_CORE_Requirements Requirements
 258  *  This module has no requirements outside a standard *nix shell like environment; the <tt>sh</tt>
 259  *  shell, GNU <tt>make</tt> and *nix CoreUtils (<tt>echo</tt>, <tt>printf</tt>, etc.).
 260  *
 261  *  \section SSec_BuildModule_CORE_Targets Targets
 262  *
 263  *  <table>
 264  *   <tr>
 265  *    <td><tt>help</tt></td>
 266  *    <td>Display build system help and configuration information.</td>
 267  *   </tr>
 268  *   <tr>
 269  *    <td><tt>list_targets</tt></td>
 270  *    <td>List all available build targets from the build system.</td>
 271  *   </tr>
 272  *   <tr>
 273  *    <td><tt>list_modules</tt></td>
 274  *    <td>List all available build modules from the build system.</td>
 275  *   </tr>
 276  *   <tr>
 277  *    <td><tt>list_mandatory</tt></td>
 278  *    <td>List all mandatory parameters required by the included modules.</td>
 279  *   </tr>
 280  *   <tr>
 281  *    <td><tt>list_optional</tt></td>
 282  *    <td>List all optional parameters required by the included modules.</td>
 283  *   </tr>
 284  *   <tr>
 285  *    <td><tt>list_provided</tt></td>
 286  *    <td>List all variables provided by the included modules.</td>
 287  *   </tr>
 288  *   <tr>
 289  *    <td><tt>list_macros</tt></td>
 290  *    <td>List all macros provided by the included modules.</td>
 291  *   </tr>
 292  *  </table>
 293  *
 294  *  \section SSec_BuildModule_CORE_MandatoryParams Mandatory Parameters
 295  *
 296  *  <table>
 297  *   <tr>
 298  *    <td><i>None</i></td>
 299  *   </tr>
 300  *  </table>
 301  *
 302  *  \section SSec_BuildModule_CORE_OptionalParams Optional Parameters
 303  *
 304  *  <table>
 305  *   <tr>
 306  *    <td><i>None</i></td>
 307  *   </tr>
 308  *  </table>
 309  *
 310  *  \section SSec_BuildModule_CORE_ProvidedVariables Module Provided Variables
 311  *
 312  *  <table>
 313  *   <tr>
 314  *    <td><i>None</i></td>
 315  *   </tr>
 316  *  </table>
 317  *
 318  *  \section SSec_BuildModule_CORE_ProvidedMacros Module Provided Macros
 319  *
 320  *  <table>
 321  *   <tr>
 322  *    <td><i>None</i></td>
 323  *   </tr>
 324  *  </table>
 325  */
 326
 327 /** \page Page_BuildModule_ATPROGRAM The ATPROGRAM build module
 328  *
 329  *  The ATPROGRAM programming utility LUFA build system module, providing targets to reprogram an
 330  *  Atmel processor FLASH and EEPROM memories with a project's compiled binary output files.
 331  *
 332  *  To use this module in your application makefile, add the following code:
 333  *  \code
 334  *  include $(LUFA_PATH)/Build/lufa_atprogram.mk
 335  *  \endcode
 336  *
 337  *  \section SSec_BuildModule_ATPROGRAM_Requirements Requirements
 338  *  This module requires the <tt>atprogram.exe</tt> utility to be available in your system's <b>PATH</b>
 339  *  variable. The <tt>atprogram.exe</tt> utility is distributed in Atmel AVR Studio 5.x and Atmel Studio 6.x
 340  *  inside the application install folder's "\atbackend" subdirectory.
 341  *
 342  *  \section SSec_BuildModule_ATPROGRAM_Targets Targets
 343  *
 344  *  <table>
 345  *   <tr>
 346  *    <td><tt>atprogram</tt></td>
 347  *    <td>Program the device FLASH memory with the application's executable data.</td>
 348  *   </tr>
 349  *   <tr>
 350  *    <td><tt>atprogram-ee</tt></td>
 351  *    <td>Program the device EEPROM memory with the application's EEPROM data.</td>
 352  *   </tr>
 353  *  </table>
 354  *
 355  *  \section SSec_BuildModule_ATPROGRAM_MandatoryParams Mandatory Parameters
 356  *
 357  *  <table>
 358  *   <tr>
 359  *    <td><tt>MCU</tt></td>
 360  *    <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
 361  *   </tr>
 362  *   <tr>
 363  *    <td><tt>TARGET</tt></td>
 364  *    <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
 365  *   </tr>
 366  *  </table>
 367  *
 368  *  \section SSec_BuildModule_ATPROGRAM_OptionalParams Optional Parameters
 369  *
 370  *  <table>
 371  *   <tr>
 372  *    <td><tt>ATPROGRAM_PROGRAMMER</tt></td>
 373  *    <td>Name of the Atmel programmer or debugger tool to communicate with (e.g. <tt>jtagice3</tt>).</td>
 374  *   </tr>
 375  *   <tr>
 376  *    <td><tt>ATPROGRAM_INTERFACE</tt></td>
 377  *    <td>Name of the programming interface to use when programming the target (e.g. <tt>spi</tt>).</td>
 378  *   </tr>
 379  *   <tr>
 380  *    <td><tt>ATPROGRAM_PORT</tt></td>
 381  *    <td>Name of the communication port to use when when programming with a serially connected tool (e.g. <tt>COM2</tt>).</td>
 382  *   </tr>
 383  *  </table>
 384  *
 385  *  \section SSec_BuildModule_ATPROGRAM_ProvidedVariables Module Provided Variables
 386  *
 387  *  <table>
 388  *   <tr>
 389  *    <td><i>None</i></td>
 390  *   </tr>
 391  *  </table>
 392  *
 393  *  \section SSec_BuildModule_ATPROGRAM_ProvidedMacros Module Provided Macros
 394  *
 395  *  <table>
 396  *   <tr>
 397  *    <td><i>None</i></td>
 398  *   </tr>
 399  *  </table>
 400  */
 401
 402 /** \page Page_BuildModule_AVRDUDE The AVRDUDE build module
 403  *
 404  *  The AVRDUDE programming utility LUFA build system module, providing targets to reprogram an
 405  *  Atmel processor FLASH and EEPROM memories with a project's compiled binary output files.
 406  *
 407  *  To use this module in your application makefile, add the following code:
 408  *  \code
 409  *  include $(LUFA_PATH)/Build/lufa_avrdude.mk
 410  *  \endcode
 411  *
 412  *  \section SSec_BuildModule_AVRDUDE_Requirements Requirements
 413  *  This module requires the <tt>avrdude</tt> utility to be available in your system's <b>PATH</b>
 414  *  variable. The <tt>avrdude</tt> utility is distributed in the old WinAVR project releases for
 415  *  Windows (<a>http://winavr.sourceforge.net</a>) or can be installed on *nix systems via the project's
 416  *  source code (<a>https://savannah.nongnu.org/projects/avrdude</a>) or through the package manager.
 417  *
 418  *  \section SSec_BuildModule_AVRDUDE_Targets Targets
 419  *
 420  *  <table>
 421  *   <tr>
 422  *    <td><tt>avrdude</tt></td>
 423  *    <td>Program the device FLASH memory with the application's executable data.</td>
 424  *   </tr>
 425  *   <tr>
 426  *    <td><tt>avrdude-ee</tt></td>
 427  *    <td>Program the device EEPROM memory with the application's EEPROM data.</td>
 428  *   </tr>
 429  *  </table>
 430  *
 431  *  \section SSec_BuildModule_AVRDUDE_MandatoryParams Mandatory Parameters
 432  *
 433  *  <table>
 434  *   <tr>
 435  *    <td><tt>MCU</tt></td>
 436  *    <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
 437  *   </tr>
 438  *   <tr>
 439  *    <td><tt>TARGET</tt></td>
 440  *    <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
 441  *   </tr>
 442  *  </table>
 443  *
 444  *  \section SSec_BuildModule_AVRDUDE_OptionalParams Optional Parameters
 445  *
 446  *  <table>
 447  *   <tr>
 448  *    <td><tt>AVRDUDE_PROGRAMMER</tt></td>
 449  *    <td>Name of the programmer or debugger tool to communicate with (e.g. <tt>jtagicemkii</tt>).</td>
 450  *   </tr>
 451  *   <tr>
 452  *    <td><tt>AVRDUDE_PORT</tt></td>
 453  *    <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>
 454  *   </tr>
 455  *   <tr>
 456  *    <td><tt>AVRDUDE_FLAGS</tt></td>
 457  *    <td>Additional flags to pass to avrdude when programming, applied after the automatically generated flags.</td>
 458  *   </tr>
 459  *   <tr>
 460  *    <td><tt>AVRDUDE_MEMORY</tt></td>
 461  *    <td>Main memory space used when programming in an application *e.g. <tt>application</tt> for a DFU bootloader, or <tt>flash</tt> for a regular programmer).</td>
 462  *   </tr>
 463  *  </table>
 464  *
 465  *  \section SSec_BuildModule_AVRDUDE_ProvidedVariables Module Provided Variables
 466  *
 467  *  <table>
 468  *   <tr>
 469  *    <td><i>None</i></td>
 470  *   </tr>
 471  *  </table>
 472  *
 473  *  \section SSec_BuildModule_AVRDUDE_ProvidedMacros Module Provided Macros
 474  *
 475  *  <table>
 476  *   <tr>
 477  *    <td><i>None</i></td>
 478  *   </tr>
 479  *  </table>
 480  */
 481
 482  /** \page Page_BuildModule_CPPCHECK The CPPCHECK build module
 483  *
 484  *  The CPPCHECK programming utility LUFA build system module, providing targets to statically
 485  *  analyze C and C++ source code for errors and performance/style issues.
 486  *
 487  *  To use this module in your application makefile, add the following code:
 488  *  \code
 489  *  include $(LUFA_PATH)/Build/lufa_cppcheck.mk
 490  *  \endcode
 491  *
 492  *  \section SSec_BuildModule_CPPCHECK_Requirements Requirements
 493  *  This module requires the <tt>cppcheck</tt> utility to be available in your system's <b>PATH</b>
 494  *  variable. The <tt>cppcheck</tt> utility is distributed through the project's home page
 495  *  (<a>http://cppcheck.sourceforge.net</a>) for Windows, and can be installed on *nix systems via
 496  *  the project's source code or through the package manager.
 497  *
 498  *  \section SSec_BuildModule_CPPCHECK_Targets Targets
 499  *
 500  *  <table>
 501  *   <tr>
 502  *    <td><tt>cppcheck</tt></td>
 503  *    <td>Statically analyze the project source code for issues.</td>
 504  *   </tr>
 505  *   <tr>
 506  *    <td><tt>cppcheck-config</tt></td>
 507  *    <td>Check the <tt>cppcheck</tt> configuration - scan source code and warn about missing header files and other issues.</td>
 508  *   </tr>
 509  *  </table>
 510  *
 511  *  \section SSec_BuildModule_CPPCHECK_MandatoryParams Mandatory Parameters
 512  *
 513  *  <table>
 514  *   <tr>
 515  *    <td><tt>SRC</tt></td>
 516  *    <td>List of source files to statically analyze.</td>
 517  *   </tr>
 518  *  </table>
 519  *
 520  *  \section SSec_BuildModule_CPPCHECK_OptionalParams Optional Parameters
 521  *
 522  *  <table>
 523  *   <tr>
 524  *    <td><tt>CPPCHECK_INCLUDES</tt></td>
 525  *    <td>Path of extra directories to check when attemting to resolve C/C++ header file includes.</td>
 526  *   </tr>
 527  *   <tr>
 528  *    <td><tt>CPPCHECK_EXCLUDES</tt></td>
 529  *    <td>Paths or path fragments to exclude when analyzing.</td>
 530  *   </tr>
 531  *   <tr>
 532  *    <td><tt>CPPCHECK_MSG_TEMPLATE</tt></td>
 533  *    <td>Output message template to use when printing errors, warnings and information (see <tt>cppcheck</tt> documentation).</td>
 534  *   </tr>
 535  *   <tr>
 536  *    <td><tt>CPPCHECK_ENABLE</tt></td>
 537  *    <td>Analysis rule categories to enable (see <tt>cppcheck</tt> documentation).</td>
 538  *   </tr>
 539  *   <tr>
 540  *    <td><tt>CPPCHECK_SUPPRESS</tt></td>
 541  *    <td>Specific analysis rules to suppress (see <tt>cppcheck</tt> documentation).</td>
 542  *   </tr>
 543  *   <tr>
 544  *    <td><tt>CPPCHECK_FAIL_ON_WARNING</tt></td>
 545  *    <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>
 546  *   </tr>
 547  *   <tr>
 548  *    <td><tt>CPPCHECK_QUIET</tt></td>
 549  *    <td>Set to <b>Y</b> to suppress all output except warnings and errors, <b>N</b> to show verbose output information.</td>
 550  *   </tr>
 551  *   <tr>
 552  *    <td><tt>CPPCHECK_FLAGS</tt></td>
 553  *    <td>Extra flags to pass to <tt>cppcheck</tt>, after the automatically generated flags.</td>
 554  *   </tr>
 555  *  </table>
 556  *
 557  *  \section SSec_BuildModule_CPPCHECK_ProvidedVariables Module Provided Variables
 558  *
 559  *  <table>
 560  *   <tr>
 561  *    <td><i>None</i></td>
 562  *   </tr>
 563  *  </table>
 564  *
 565  *  \section SSec_BuildModule_CPPCHECK_ProvidedMacros Module Provided Macros
 566  *
 567  *  <table>
 568  *   <tr>
 569  *    <td><i>None</i></td>
 570  *   </tr>
 571  *  </table>
 572  */
 573
 574  /** \page Page_BuildModule_DFU The DFU build module
 575  *
 576  *  The DFU programming utility LUFA build system module, providing targets to reprogram an
 577  *  Atmel processor FLASH and EEPROM memories with a project's compiled binary output files.
 578  *  This module requires a DFU class bootloader to be running in the target, compatible with
 579  *  the DFU bootloader protocol as published by Atmel.
 580  *
 581  *  To use this module in your application makefile, add the following code:
 582  *  \code
 583  *  include $(LUFA_PATH)/Build/lufa_dfu.mk
 584  *  \endcode
 585  *
 586  *  \section SSec_BuildModule_DFU_Requirements Requirements
 587  *  This module requires either the <tt>batchisp</tt> utility from Atmel's FLIP utility, or the open
 588  *  source <tt>dfu-programmer</tt> utility (<a>http://dfu-programmer.sourceforge.net/</a>) to be
 589  *  available in your system's <b>PATH</b> variable. On *nix systems the <tt>dfu-programmer</tt> utility
 590  *  can be installed via the project's source code or through the package manager.
 591  *
 592  *  \section SSec_BuildModule_DFU_Targets Targets
 593  *
 594  *  <table>
 595  *   <tr>
 596  *    <td><tt>dfu</tt></td>
 597  *    <td>Program the device FLASH memory with the application's executable data using <tt>dfu-programmer</tt>.</td>
 598  *   </tr>
 599  *   <tr>
 600  *    <td><tt>dfu-ee</tt></td>
 601  *    <td>Program the device EEPROM memory with the application's EEPROM data using <tt>dfu-programmer</tt>.</td>
 602  *   </tr>
 603  *   <tr>
 604  *    <td><tt>flip</tt></td>
 605  *    <td>Program the device FLASH memory with the application's executable data using <tt>batchisp</tt>.</td>
 606  *   </tr>
 607  *   <tr>
 608  *    <td><tt>flip-ee</tt></td>
 609  *    <td>Program the device EEPROM memory with the application's EEPROM data using <tt>batchisp</tt>.</td>
 610  *   </tr>
 611  *  </table>
 612  *
 613  *  \section SSec_BuildModule_DFU_MandatoryParams Mandatory Parameters
 614  *
 615  *  <table>
 616  *   <tr>
 617  *    <td><tt>MCU</tt></td>
 618  *    <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
 619  *   </tr>
 620  *   <tr>
 621  *    <td><tt>TARGET</tt></td>
 622  *    <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
 623  *   </tr>
 624  *  </table>
 625  *
 626  *  \section SSec_BuildModule_DFU_OptionalParams Optional Parameters
 627  *
 628  *  <table>
 629  *   <tr>
 630  *    <td><i>None</i></td>
 631  *   </tr>
 632  *  </table>
 633  *
 634  *  \section SSec_BuildModule_DFU_ProvidedVariables Module Provided Variables
 635  *
 636  *  <table>
 637  *   <tr>
 638  *    <td><i>None</i></td>
 639  *   </tr>
 640  *  </table>
 641  *
 642  *  \section SSec_BuildModule_DFU_ProvidedMacros Module Provided Macros
 643  *
 644  *  <table>
 645  *   <tr>
 646  *    <td><i>None</i></td>
 647  *   </tr>
 648  *  </table>
 649  */
 650
 651  /** \page Page_BuildModule_DOXYGEN The DOXYGEN build module
 652  *
 653  *  The DOXYGEN code documentation utility LUFA build system module, providing targets to generate
 654  *  project HTML and other format documentation from a set of source files that include special
 655  *  Doxygen comments.
 656  *
 657  *  To use this module in your application makefile, add the following code:
 658  *  \code
 659  *  include $(LUFA_PATH)/Build/lufa_doxygen.mk
 660  *  \endcode
 661  *
 662  *  \section SSec_BuildModule_DOXYGEN_Requirements Requirements
 663  *  This module requires the <tt>doxygen</tt> utility from the Doxygen website
 664  *  (<a>http://www.doxygen.org/</a>) to be available in your system's <b>PATH</b> variable. On *nix
 665  *  systems the <tt>doxygen</tt> utility can be installed via the project's source code or through
 666  *  the package manager.
 667  *
 668  *  \section SSec_BuildModule_DOXYGEN_Targets Targets
 669  *
 670  *  <table>
 671  *   <tr>
 672  *    <td><tt>doxygen</tt></td>
 673  *    <td>Generate project documentation.</td>
 674  *   </tr>
 675  *   <tr>
 676  *    <td><tt>doxygen_create</tt></td>
 677  *    <td>Create a new Doxygen configuration file using the latest template.</td>
 678  *   </tr>
 679  *   <tr>
 680  *    <td><tt>doxygen_upgrade</tt></td>
 681  *    <td>Upgrade an existing Doxygen configuration file to the latest template</td>
 682  *   </tr>
 683  *  </table>
 684  *
 685  *  \section SSec_BuildModule_DOXYGEN_MandatoryParams Mandatory Parameters
 686  *
 687  *  <table>
 688  *   <tr>
 689  *    <td><tt>LUFA_PATH</tt></td>
 690  *    <td>Path to the LUFA library core, either relative or absolute (e.g. <tt>../LUFA-000000/LUFA/</tt>).</td>
 691  *   </tr>
 692  *  </table>
 693  *
 694  *  \section SSec_BuildModule_DOXYGEN_OptionalParams Optional Parameters
 695  *
 696  *  <table>
 697  *   <tr>
 698  *    <td><tt>DOXYGEN_CONF</tt></td>
 699  *    <td>Name and path of the base Doxygen configuration file for the project.</td>
 700  *   </tr>
 701  *   <tr>
 702  *    <td><tt>DOXYGEN_FAIL_ON_WARNING</tt></td>
 703  *    <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>
 704  *   </tr>
 705  *   <tr>
 706  *    <td><tt>DOXYGEN_OVERRIDE_PARAMS</tt></td>
 707  *    <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>
 708  *   </tr>
 709  *  </table>
 710  *
 711  *  \section SSec_BuildModule_DOXYGEN_ProvidedVariables Module Provided Variables
 712  *
 713  *  <table>
 714  *   <tr>
 715  *    <td><i>None</i></td>
 716  *   </tr>
 717  *  </table>
 718  *
 719  *  \section SSec_BuildModule_DOXYGEN_ProvidedMacros Module Provided Macros
 720  *
 721  *  <table>
 722  *   <tr>
 723  *    <td><i>None</i></td>
 724  *   </tr>
 725  *  </table>
 726  */
 727
 728  /** \page Page_BuildModule_HID The HID build module
 729  *
 730  *  The HID programming utility LUFA build system module, providing targets to reprogram an
 731  *  Atmel processor's FLASH memory with a project's compiled binary output file. This module
 732  *  requires a HID class bootloader to be running in the target, using a protocol compatible
 733  *  with the PJRC "HalfKay" protocol (<a>http://www.pjrc.com/teensy/halfkay_protocol.html</a>).
 734  *
 735  *  To use this module in your application makefile, add the following code:
 736  *  \code
 737  *  include $(LUFA_PATH)/Build/lufa_hid.mk
 738  *  \endcode
 739  *
 740  *  \section SSec_BuildModule_HID_Requirements Requirements
 741  *  This module requires either the <tt>hid_bootloader_cli</tt> utility from the included LUFA HID
 742  *  class bootloader API subdirectory, or the <tt>teensy_loader_cli</tt> utility from PJRC
 743  *  (<a>http://www.pjrc.com/teensy/loader_cli.html</a>) to be available in your system's <b>PATH</b>
 744  *  variable.
 745  *
 746  *  \section SSec_BuildModule_HID_Targets Targets
 747  *
 748  *  <table>
 749  *   <tr>
 750  *    <td><tt>hid</tt></td>
 751  *    <td>Program the device FLASH memory with the application's executable data using <tt>hid_bootloader_cli</tt>.</td>
 752  *   </tr>
 753  *   <tr>
 754  *    <td><tt>hid-ee</tt></td>
 755  *    <td>Program the device EEPROM memory with the application's EEPROM data using <tt>hid_bootloader_cli</tt> and
 756  *        a temporary AVR application programmed into the target's FLASH.
 757  *        \note This will erase the currently loaded application in the target.</td>
 758  *   </tr>
 759  *   <tr>
 760  *    <td><tt>teensy</tt></td>
 761  *    <td>Program the device FLASH memory with the application's executable data using <tt>teensy_loader_cli</tt>.</td>
 762  *   </tr>
 763  *   <tr>
 764  *    <td><tt>teensy-ee</tt></td>
 765  *    <td>Program the device EEPROM memory with the application's EEPROM data using <tt>teensy_loader_cli</tt> and
 766  *        a temporary AVR application programmed into the target's FLASH.
 767  *        \note This will erase the currently loaded application in the target.</td>
 768  *   </tr>
 769  *  </table>
 770  *
 771  *  \section SSec_BuildModule_HID_MandatoryParams Mandatory Parameters
 772  *
 773  *  <table>
 774  *   <tr>
 775  *    <td><tt>MCU</tt></td>
 776  *    <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
 777  *   </tr>
 778  *   <tr>
 779  *    <td><tt>TARGET</tt></td>
 780  *    <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
 781  *   </tr>
 782  *  </table>
 783  *
 784  *  \section SSec_BuildModule_HID_OptionalParams Optional Parameters
 785  *
 786  *  <table>
 787  *   <tr>
 788  *    <td><i>None</i></td>
 789  *   </tr>
 790  *  </table>
 791  *
 792  *  \section SSec_BuildModule_HID_ProvidedVariables Module Provided Variables
 793  *
 794  *  <table>
 795  *   <tr>
 796  *    <td><i>None</i></td>
 797  *   </tr>
 798  *  </table>
 799  *
 800  *  \section SSec_BuildModule_HID_ProvidedMacros Module Provided Macros
 801  *
 802  *  <table>
 803  *   <tr>
 804  *    <td><i>None</i></td>
 805  *   </tr>
 806  *  </table>
 807  */
 808
 809  /** \page Page_BuildModule_SOURCES The SOURCES build module
 810  *
 811  *  The SOURCES LUFA build system module, providing variables listing the various LUFA source files
 812  *  required to be build by a project for a given LUFA module. This module gives a way to reference
 813  *  LUFA source files symbolically, so that changes to the library structure do not break the library
 814  *  makefile.
 815  *
 816  *  To use this module in your application makefile, add the following code:
 817  *  \code
 818  *  include $(LUFA_PATH)/Build/lufa_sources.mk
 819  *  \endcode
 820  *
 821  *  \section SSec_BuildModule_SOURCES_Requirements Requirements
 822  *  None.
 823  *
 824  *  \section SSec_BuildModule_SOURCES_Targets Targets
 825  *
 826  *  <table>
 827  *   <tr>
 828  *    <td><i>None</i></td>
 829  *   </tr>
 830  *  </table>
 831  *
 832  *  \section SSec_BuildModule_SOURCES_MandatoryParams Mandatory Parameters
 833  *
 834  *  <table>
 835  *   <tr>
 836  *    <td><tt>LUFA_PATH</tt></td>
 837  *    <td>Path to the LUFA library core, either relative or absolute (e.g. <tt>../LUFA-000000/LUFA/</tt>).</td>
 838  *   </tr>
 839  *   <tr>
 840  *    <td><tt>ARCH</tt></td>
 841  *    <td>Architecture of the target processor (see \ref Page_DeviceSupport).</td>
 842  *   </tr>
 843  *  </table>
 844  *
 845  *  \section SSec_BuildModule_SOURCES_OptionalParams Optional Parameters
 846  *
 847  *  <table>
 848  *   <tr>
 849  *    <td><i>None</i></td>
 850  *   </tr>
 851  *  </table>
 852  *
 853  *  \section SSec_BuildModule_SOURCES_ProvidedVariables Module Provided Variables
 854  *
 855  *  <table>
 856  *   <tr>
 857  *    <td><tt>LUFA_SRC_USB</tt></td>
 858  *    <td>List of LUFA USB driver source files.</td>
 859  *   </tr>
 860  *   <tr>
 861  *    <td><tt>LUFA_SRC_USBCLASS</tt></td>
 862  *    <td>List of LUFA USB Class driver source files.</td>
 863  *   </tr>
 864  *   <tr>
 865  *    <td><tt>LUFA_SRC_TEMPERATURE</tt></td>
 866  *    <td>List of LUFA temperature sensor driver source files.</td>
 867  *   </tr>
 868  *   <tr>
 869  *    <td><tt>LUFA_SRC_SERIAL</tt></td>
 870  *    <td>List of LUFA Serial U(S)ART driver source files.</td>
 871  *   </tr>
 872  *   <tr>
 873  *    <td><tt>LUFA_SRC_TWI</tt></td>
 874  *    <td>List of LUFA TWI driver source files.</td>
 875  *   </tr>
 876  *   <tr>
 877  *    <td><tt>LUFA_SRC_PLATFORM</tt></td>
 878  *    <td>List of LUFA architecture specific platform management source files.</td>
 879  *   </tr>
 880  *  </table>
 881  *
 882  *  \section SSec_BuildModule_SOURCES_ProvidedMacros Module Provided Macros
 883  *
 884  *  <table>
 885  *   <tr>
 886  *    <td><i>None</i></td>
 887  *   </tr>
 888  *  </table>
 889  */
 890
 891 /** \page Page_BuildTroubleshooting Troubleshooting Information
 892  *
 893  *  LUFA uses a lot of advanced features of the AVR-GCC compiler, linker, and surrounding binaries. This can sometimes lead to problems compiling applications if one of these
 894  *  features is buggy in the version of the tools used in a build environment. Missing utilities and incorrectly set makefile configuration options can also result in different
 895  *  errors being produced when compilation or other operations are attempted. The table below lists a set of commonly encountered errors and their resolutions.
 896  *
 897  *  <table>
 898  *    <tr>
 899  *    <th>Problem</th>
 900  *    <th>Resolution</th>
 901  *   </tr>
 902  *   <tr>
 903  *    <td>Error &quot;<b><tt>relocation truncated to fit: R_AVR_13_PCREL against symbol <i>{X}</i></tt></b>&quot; shown when compiling.</td>
 904  *    <td>Try compiling with the setting <tt>LINKER_RELAXATIONS=N</tt> in your LUFA Build System 2.0 makefile, or remove the line <tt>-Wl,--relax</tt>
 905  *        from other makefiles. Alternatively, make sure you have the latest version of the Atmel Toolchain installed for your system.</td>
 906  *   </tr>
 907  *   <tr>
 908  *    <td>Error &quot;<b><tt>error: ld terminated with signal 11 [Segmentation fault]</tt></b>&quot; shown when compiling.</td>
 909  *    <td>Try compiling with the setting <tt>DEBUG_LEVEL=2</tt> in your LUFA Build System 2.0 makefile, or make sure you are using <tt>binutils</tt> version 2.22 or later.</td>
 910  *   </tr>
 911  *   <tr>
 912  *    <td>Error &quot;<b><tt>EMERGENCY ABORT: INFINITE RECURSION DETECTED</tt></b>&quot; shown when compiling.</td>
 913  *    <td>Make sure you are using an up to date version of GNU Make when compiling. This error is a safety system added to the mid-level makefiles, to prevent an issue with
 914  *        GNU make or other variants of Make causing an infinitely recursive build.</td>
 915  *   </tr>
 916  *   <tr>
 917  *    <td>Error &quot;<b><tt>Unsupported architecture &quot;<i>{X}</i>&quot;</tt></b>&quot; shown when compiling.</td>
 918  *    <td>Ensure your makefile's <tt>ARCH</tt> setting is set to one of the architecture names (case-sensitive) supported by the version of LUFA you are compiling against.</td>
 919  *   </tr>
 920  *   <tr>
 921  *    <td>Error &quot;<b><tt>Makefile <i>{X}</i> value not set</tt></b>&quot; shown when compiling.</td>
 922  *    <td>The specified Makefile value was not configured in your project's makefile or on the command line, and the nominated setting is required by one or more LUFA
 923  *        build system modules. Define the value in your project makefile and try again.</td>
 924  *   </tr>
 925  *   <tr>
 926  *    <td>Error &quot;<b><tt>Makefile <i>{X}</i> option cannot be blank</tt></b>&quot; shown when compiling.</td>
 927  *    <td>The specified Makefile value was configured in your project's makefile or on the command line, but was set to an empty value. For the nominated configuration
 928  *        option, an empty value is not allowed. Define the nominated setting to a correct non-blank value and try again.</td>
 929  *   </tr>
 930  *   <tr>
 931  *    <td>Error &quot;<b><tt>Makefile <i>{X}</i> option must be Y or N</tt></b>&quot; shown when compiling.</td>
 932  *    <td>The specified Makefile value was configured in your project's makefile or on the command line, but was set to a value other than a Y (for "Yes") or "N" (for "No").
 933  *        This configuration option is required to be one of the aforementioned boolean values, and other values are invalid. Set this option to either Y or N and try again.</td>
 934  *   </tr>
 935  *   <tr>
 936  *    <td>Error &quot;<b><tt>Unknown input source file formats: <i>{X}</i></tt></b>&quot; shown when compiling.</td>
 937  *    <td>The nominated source files, specified in your project's makefile in the <tt>SRC</tt> configuration option, has an extension that the LUFA build system does not
 938  *        recognise. The file extensions are case sensitive, and must be one of the supported formats (<tt>*.c</tt>, <tt>*.cpp</tt> or <tt>*.S</tt>).</td>
 939  *   </tr>
 940  *   <tr>
 941  *    <td>Error &quot;<b><tt>Cannot build with OBJDIR parameter set - one or more object file name is not unique</tt></b>&quot; shown when compiling.</td>
 942  *    <td>When a project is built with a non-empty <tt>OBJDIR</tt> object directory name set, all input source files must have unique names, excluding extension and path.
 943  *        This means that input files that are named identically and differ only by their path or extension are invalid when this mode is used.</td>
 944  *   </tr>
 945  *   <tr>
 946  *    <td>Error &quot;<b><tt>Source file does not exist: <i>{X}</i></tt></b>&quot; shown when compiling.</td>
 947  *    <td>The nominated input source file, specified in the user project's <tt>SRC</tt> parameter, could not be found. Ensure the source file exists and the absolute or
 948  *        relative path given in the user project makefile is correct and try again.</td>
 949  *   </tr>
 950  *   <tr>
 951  *    <td>Error &quot;<b><tt>Doxygen configuration file <i>{X}</i> does not exist</tt></b>&quot; shown when upgrading a Doxygen configuration file.</td>
 952  *    <td>The nominated Doxygen configuration file, specified in the user project's <tt>DOXYGEN_CONF</tt> parameter, could not be found. Ensure the configuration file exists
 953  *        and the absolute or relative path given in the user project makefile is correct and try again, or run the appropriate makefile target to generate a new configuration
 954  *        file.</td>
 955  *   </tr>
 956  *   <tr>
 957  *    <td>Error &quot;<b><tt>avr-gcc: error: unrecognized option '<i>{X}</i>'</tt></b>&quot; shown when compiling.</td>
 958  *    <td>An unrecognised option was supplied to the compiler, usually in the <tt>C_FLAGS</tt>, <tt>CPP_FLAGS</tt>, <tt>ASM_FLAGS</tt> or <tt>CC_FLAGS</tt> configuration
 959  *        options. The nominated compiler switch may be invalid, or unsupported by the version of AVR-GCC on the host system. Remove the unrecognised flag if invalid, or
 960  *        upgrade to the latest AVR-GCC. If the option is a valid linker option, use the prefix "-Wl," to ensure it is passed to the linker correctly.</td>
 961  *   </tr>
 962  *   <tr>
 963  *    <td>Error &quot;<b><tt>makefile:{X}: {Y}.mk: No such file or directory</tt></b>&quot; shown when make is invoked.</td>
 964  *    <td>The path to the nominated makefile module was incorrect. This usually indicates that the makefile <tt>LUFA_PATH</tt> option is not set to a valid relative or
 965  *        absolute path to the LUFA library core.</td>
 966  *   </tr>
 967  *   <tr>
 968  *    <td>Error &quot;<b><tt>fatal error: LUFAConfig.h: No such file or directory</tt></b>&quot; shown when compiling.</td>
 969  *    <td>The <tt>USE_LUFA_CONFIG_HEADER</tt> compile time option was set in the user project makefile, but the user supplied <tt>LUFAConfig.h</tt> header could not be
 970  *        found. Ensure that the directory that contains this configuration file is correctly passed to the compiler via the -I switch in the makefile <tt>CC_FLAGS</tt>
 971  *        parameter.</td>
 972  *   </tr>
 973  *   <tr>
 974  *    <td>Error &quot;<b><tt>ld.exe: section .apitable_trampolines loaded at <i>{X}</i> overlaps section .text</tt></b>&quot; shown when compiling a bootloader.</td>
 975  *    <td>The bootloader is compiling too large for the given <tt>FLASH_SIZE_KB</tt> and <tt>BOOT_SECTION_SIZE_KB</tt> parameters set in the bootloader makefile. This
 976  *        usually indicates that these values are incorrect for the specified device the bootloader is targeting. If these values are correct, a newer version of the
 977  *        compiler may need to be used to ensure that the bootloader is built within the section size constraints of the target device.</td>
 978  *   </tr>
 979  *   <tr>
 980  *    <td>Error &quot;<b><tt>unknown MCU '<i>{X}</i>' specified</tt></b>&quot; shown when compiling.</td>
 981  *    <td>The specified microcontroller device model name set in the user application's makefile as the <tt>MCU</tt> parameter is incorrect, or unsupported by the
 982  *        version of the compiler being used. Make sure the model name is correct, or upgrade to the latest Atmel Toolchain to obtain newer device support.</td>
 983  *   </tr>
 984  *   <tr>
 985  *    <td>Error &quot;<b><tt>undefined reference to `<i>{X}</i>'</tt></b>&quot; shown when compiling.</td>
 986  *    <td>This is usually caused by a missing source file in the user application's <tt>SRC</tt> configuration parameter. If the indicated symbol is one from the LUFA
 987  *        library, you may be missing a LUFA source makefile module (see \ref Page_BuildModule_SOURCES).</td>
 988  *   </tr>
 989  *  </table>
 990  *
 991  *  For troubleshooting other errors you encounter, please see \ref Sec_ProjectHelp.
 992  */