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.
7 /** \page Page_BuildSystem The LUFA Build System
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
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.
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:
21 * include $(LUFA_PATH)/Build/lufa_core.mk
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.
28 * \see \ref Sec_AppMakefileParams for a copy of the sample LUFA project makefile.
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.
34 * \section SSec_BuildSystemModules Available Modules
36 * The following modules are included in this LUFA release:
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
49 /** \page Page_BuildModule_BUILD The BUILD build module
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.
55 * To use this module in your application makefile, add the following code:
57 * include $(LUFA_PATH)/Build/lufa_build.mk
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.
65 * \section SSec_BuildModule_BUILD_Targets Targets
69 * <td><tt>size</tt></td>
70 * <td>Display size of the compiled application FLASH and SRAM segments.</td>
73 * <td><tt>symbol-sizes</tt></td>
74 * <td>Display a size-sorted list of symbols from the compiled application, in decimal bytes.</td>
77 * <td><tt>lib</tt></td>
78 * <td>Build and archive all source files into a library A binary file.</td>
81 * <td><tt>all</tt></td>
82 * <td>Build and link the application into ELF debug and HEX binary files.</td>
85 * <td><tt>elf</tt></td>
86 * <td>Build and link the application into an ELF debug file.</td>
89 * <td><tt>hex</tt></td>
90 * <td>Build and link the application and produce HEX and EEP binary files.</td>
93 * <td><tt>lss</tt></td>
94 * <td>Build and link the application and produce a LSS source code/assembly code mixed listing file.</td>
97 * <td><tt>clean</tt></td>
98 * <td>Remove all intermediatary files and binary output files.</td>
101 * <td><tt>mostlyclean</tt></td>
102 * <td>Remove all intermediatary files but preserve any binary output files.</td>
105 * <td><tt><i><filename></i>.s</tt></td>
106 * <td>Create an assembly listing of a given input C/C++ source file.</td>
110 * \section SSec_BuildModule_BUILD_MandatoryParams Mandatory Parameters
114 * <td><tt>TARGET</tt></td>
115 * <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
118 * <td><tt>ARCH</tt></td>
119 * <td>Architecture of the target processor (see \ref Page_DeviceSupport).</td>
122 * <td><tt>MCU</tt></td>
123 * <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
126 * <td><tt>SRC</tt></td>
127 * <td>List of relative or absolute paths to the application C (.c), C++ (.cpp) and Assembly (.S) source files.</td>
130 * <td><tt>F_USB</tt></td>
131 * <td>Speed in Hz of the input clock frequency to the target's USB controller.</td>
134 * <td><tt>LUFA_PATH</tt></td>
135 * <td>Path to the LUFA library core, either relative or absolute (e.g. <tt>../LUFA-000000/LUFA/</tt>).</td>
139 * \section SSec_BuildModule_BUILD_OptionalParams Optional Parameters
143 * <td><tt>BOARD</tt></td>
144 * <td>LUFA board hardware drivers to use (see \ref Page_DeviceSupport).</td>
147 * <td><tt>OPTIMIZATION</tt></td>
148 * <td>Optimization level to use when compiling source files (see GCC manual).</td>
151 * <td><tt>C_STANDARD</tt></td>
152 * <td>Version of the C standard to apply when compiling C++ source files (see GCC manual).</td>
155 * <td><tt>CPP_STANDARD</tt></td>
156 * <td>Version of the C++ standard to apply when compiling C++ source files (see GCC manual).</td>
159 * <td><tt>DEBUG_FORMAT</tt></td>
160 * <td>Format of the debug information to embed in the generated object files (see GCC manual).</td>
163 * <td><tt>DEBUG_LEVEL</tt></td>
164 * <td>Level of the debugging information to embed in the generated object files (see GCC manual).</td>
167 * <td><tt>F_CPU</tt></td>
168 * <td>Speed of the processor CPU clock, in Hz.</td>
171 * <td><tt>C_FLAGS</tt></td>
172 * <td>Flags to pass to the C compiler only, after the automatically generated flags.</td>
175 * <td><tt>CPP_FLAGS</tt></td>
176 * <td>Flags to pass to the C++ compiler only, after the automatically generated flags.</td>
179 * <td><tt>ASM_FLAGS</tt></td>
180 * <td>Flags to pass to the assembler only, after the automatically generated flags.</td>
183 * <td><tt>CC_FLAGS</tt></td>
184 * <td>Common flags to pass to the C/C++ compiler and assembler, after the automatically generated flags.</td>
187 * <td><tt>LD_FLAGS</tt></td>
188 * <td>Flags to pass to the linker, after the automatically generated flags.</td>
191 * <td><tt>LINKER_RELAXATIONS</tt></td>
192 * <td>Enables or disables linker relaxations when linking the application binary. This can reduce the total size
193 * of the application by replacing full \c CALL instructions with smaller \c RCALL instructions where possible.
194 * \note On some unpatched versions of binutils, this can cause link failures in some circumstances. If you
195 * receive a link error <tt>relocation truncated to fit: R_AVR_13_PCREL</tt>, disable this setting.</td>
198 * <td><tt>OBJDIR</tt></td>
199 * <td>Directory to place the generated object and dependency files. If set to "." the same folder as the source file will be used.
200 * \note When this option is enabled, all source filenames <b>must</b> be unique.</td>
203 * <td><tt>OBJECT_FILES</tt></td>
204 * <td>List of additional object files that should be linked into the resulting binary.</td>
208 * \section SSec_BuildModule_BUILD_ProvidedVariables Module Provided Variables
212 * <td><i>None</i></td>
216 * \section SSec_BuildModule_BUILD_ProvidedMacros Module Provided Macros
220 * <td><i>None</i></td>
225 /** \page Page_BuildModule_CORE The CORE build module
227 * The core LUFA build system module, providing common build system help and information targets.
229 * To use this module in your application makefile, add the following code:
231 * include $(LUFA_PATH)/Build/lufa_core.mk
234 * \section SSec_BuildModule_CORE_Requirements Requirements
235 * This module has no requirements outside a standard *nix shell like environment; the <tt>sh</tt>
236 * shell, GNU <tt>make</tt> and *nix CoreUtils (<tt>echo</tt>, <tt>printf</tt>, etc.).
238 * \section SSec_BuildModule_CORE_Targets Targets
242 * <td><tt>help</tt></td>
243 * <td>Display build system help and configuration information.</td>
246 * <td><tt>list_targets</tt></td>
247 * <td>List all available build targets from the build system.</td>
250 * <td><tt>list_modules</tt></td>
251 * <td>List all available build modules from the build system.</td>
254 * <td><tt>list_mandatory</tt></td>
255 * <td>List all mandatory parameters required by the included modules.</td>
258 * <td><tt>list_optional</tt></td>
259 * <td>List all optional parameters required by the included modules.</td>
262 * <td><tt>list_provided</tt></td>
263 * <td>List all variables provided by the included modules.</td>
266 * <td><tt>list_macros</tt></td>
267 * <td>List all macros provided by the included modules.</td>
271 * \section SSec_BuildModule_CORE_MandatoryParams Mandatory Parameters
275 * <td><i>None</i></td>
279 * \section SSec_BuildModule_CORE_OptionalParams Optional Parameters
283 * <td><i>None</i></td>
287 * \section SSec_BuildModule_CORE_ProvidedVariables Module Provided Variables
291 * <td><i>None</i></td>
295 * \section SSec_BuildModule_CORE_ProvidedMacros Module Provided Macros
299 * <td><i>None</i></td>
304 /** \page Page_BuildModule_ATPROGRAM The ATPROGRAM build module
306 * The ATPROGRAM programming utility LUFA build system module, providing targets to reprogram an
307 * Atmel processor FLASH and EEPROM memories with a project's compiled binary output files.
309 * To use this module in your application makefile, add the following code:
311 * include $(LUFA_PATH)/Build/lufa_atprogram.mk
314 * \section SSec_BuildModule_ATPROGRAM_Requirements Requirements
315 * This module requires the <tt>atprogram.exe</tt> utility to be available in your system's <b>PATH</b>
316 * variable. The <tt>atprogram.exe</tt> utility is distributed in Atmel AVR Studio 5.x and Atmel Studio 6.x
317 * inside the application install folder's "\avrdbg" subdirectory.
319 * \section SSec_BuildModule_ATPROGRAM_Targets Targets
323 * <td><tt>atprogram</tt></td>
324 * <td>Program the device FLASH memory with the application's executable data.</td>
327 * <td><tt>atprogram-ee</tt></td>
328 * <td>Program the device EEPROM memory with the application's EEPROM data.</td>
332 * \section SSec_BuildModule_ATPROGRAM_MandatoryParams Mandatory Parameters
336 * <td><tt>MCU</tt></td>
337 * <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
340 * <td><tt>TARGET</tt></td>
341 * <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
345 * \section SSec_BuildModule_ATPROGRAM_OptionalParams Optional Parameters
349 * <td><tt>ATPROGRAM_PROGRAMMER</tt></td>
350 * <td>Name of the Atmel programmer or debugger tool to communicate with (e.g. <tt>jtagice3</tt>).</td>
353 * <td><tt>ATPROGRAM_INTERFACE</tt></td>
354 * <td>Name of the programming interface to use when programming the target (e.g. <tt>spi</tt>).</td>
357 * <td><tt>ATPROGRAM_PORT</tt></td>
358 * <td>Name of the communication port to use when when programming with a serially connected tool (e.g. <tt>COM2</tt>).</td>
362 * \section SSec_BuildModule_ATPROGRAM_ProvidedVariables Module Provided Variables
366 * <td><i>None</i></td>
370 * \section SSec_BuildModule_ATPROGRAM_ProvidedMacros Module Provided Macros
374 * <td><i>None</i></td>
379 /** \page Page_BuildModule_AVRDUDE The AVRDUDE build module
381 * The AVRDUDE programming utility LUFA build system module, providing targets to reprogram an
382 * Atmel processor FLASH and EEPROM memories with a project's compiled binary output files.
384 * To use this module in your application makefile, add the following code:
386 * include $(LUFA_PATH)/Build/lufa_avrdude.mk
389 * \section SSec_BuildModule_AVRDUDE_Requirements Requirements
390 * This module requires the <tt>avrdude</tt> utility to be available in your system's <b>PATH</b>
391 * variable. The <tt>avrdude</tt> utility is distributed in the old WinAVR project releases for
392 * Windows (<a>http://winavr.sourceforge.net</a>) or can be installed on *nix systems via the project's
393 * source code (<a>https://savannah.nongnu.org/projects/avrdude</a>) or through the package manager.
395 * \section SSec_BuildModule_AVRDUDE_Targets Targets
399 * <td><tt>avrdude</tt></td>
400 * <td>Program the device FLASH memory with the application's executable data.</td>
403 * <td><tt>avrdude-ee</tt></td>
404 * <td>Program the device EEPROM memory with the application's EEPROM data.</td>
408 * \section SSec_BuildModule_AVRDUDE_MandatoryParams Mandatory Parameters
412 * <td><tt>MCU</tt></td>
413 * <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
416 * <td><tt>TARGET</tt></td>
417 * <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
421 * \section SSec_BuildModule_AVRDUDE_OptionalParams Optional Parameters
425 * <td><tt>AVRDUDE_PROGRAMMER</tt></td>
426 * <td>Name of the programmer or debugger tool to communicate with (e.g. <tt>jtagicemkii</tt>).</td>
429 * <td><tt>AVRDUDE_PORT</tt></td>
430 * <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>
433 * <td><tt>AVRDUDE_FLAGS</tt></td>
434 * <td>Additional flags to pass to avrdude when programming, applied after the automatically generated flags.</td>
438 * \section SSec_BuildModule_AVRDUDE_ProvidedVariables Module Provided Variables
442 * <td><i>None</i></td>
446 * \section SSec_BuildModule_AVRDUDE_ProvidedMacros Module Provided Macros
450 * <td><i>None</i></td>
455 /** \page Page_BuildModule_CPPCHECK The CPPCHECK build module
457 * The CPPCHECK programming utility LUFA build system module, providing targets to statically
458 * analyze C and C++ source code for errors and performance/style issues.
460 * To use this module in your application makefile, add the following code:
462 * include $(LUFA_PATH)/Build/lufa_cppcheck.mk
465 * \section SSec_BuildModule_CPPCHECK_Requirements Requirements
466 * This module requires the <tt>cppcheck</tt> utility to be available in your system's <b>PATH</b>
467 * variable. The <tt>cppcheck</tt> utility is distributed through the project's home page
468 * (<a>http://cppcheck.sourceforge.net</a>) for Windows, and can be installed on *nix systems via
469 * the project's source code or through the package manager.
471 * \section SSec_BuildModule_CPPCHECK_Targets Targets
475 * <td><tt>cppcheck</tt></td>
476 * <td>Statically analyze the project source code for issues.</td>
479 * <td><tt>cppcheck-config</tt></td>
480 * <td>Check the <tt>cppcheck</tt> configuration - scan source code and warn about missing header files and other issues.</td>
484 * \section SSec_BuildModule_CPPCHECK_MandatoryParams Mandatory Parameters
488 * <td><tt>SRC</tt></td>
489 * <td>List of source files to statically analyze.</td>
493 * \section SSec_BuildModule_CPPCHECK_OptionalParams Optional Parameters
497 * <td><tt>CPPCHECK_INCLUDES</tt></td>
498 * <td>Path of extra directories to check when attemting to resolve C/C++ header file includes.</td>
501 * <td><tt>CPPCHECK_EXCLUDES</tt></td>
502 * <td>Paths or path fragments to exclude when analyzing.</td>
505 * <td><tt>CPPCHECK_MSG_TEMPLATE</tt></td>
506 * <td>Output message template to use when printing errors, warnings and information (see <tt>cppcheck</tt> documentation).</td>
509 * <td><tt>CPPCHECK_ENABLE</tt></td>
510 * <td>Analysis rule categories to enable (see <tt>cppcheck</tt> documentation).</td>
513 * <td><tt>CPPCHECK_SUPPRESS</tt></td>
514 * <td>Specific analysis rules to suppress (see <tt>cppcheck</tt> documentation).</td>
517 * <td><tt>CPPCHECK_FAIL_ON_WARNING</tt></td>
518 * <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>
521 * <td><tt>CPPCHECK_QUIET</tt></td>
522 * <td>Set to <b>Y</b> to suppress all output except warnings and errors, <b>N</b> to show verbose output information.</td>
525 * <td><tt>CPPCHECK_FLAGS</tt></td>
526 * <td>Extra flags to pass to <tt>cppcheck</tt>, after the automatically generated flags.</td>
530 * \section SSec_BuildModule_CPPCHECK_ProvidedVariables Module Provided Variables
534 * <td><i>None</i></td>
538 * \section SSec_BuildModule_CPPCHECK_ProvidedMacros Module Provided Macros
542 * <td><i>None</i></td>
547 /** \page Page_BuildModule_DFU The DFU build module
549 * The DFU programming utility LUFA build system module, providing targets to reprogram an
550 * Atmel processor FLASH and EEPROM memories with a project's compiled binary output files.
551 * This module requires a DFU class bootloader to be running in the target, compatible with
552 * the DFU bootloader protocol as published by Atmel.
554 * To use this module in your application makefile, add the following code:
556 * include $(LUFA_PATH)/Build/lufa_dfu.mk
559 * \section SSec_BuildModule_DFU_Requirements Requirements
560 * This module requires either the <tt>batchisp</tt> utility from Atmel's FLIP utility, or the open
561 * source <tt>dfu-programmer</tt> utility (<a>http://dfu-programmer.sourceforge.net/</a>) to be
562 * available in your system's <b>PATH</b> variable. On *nix systems the <tt>dfu-programmer</tt> utility
563 * can be installed via the project's source code or through the package manager.
565 * \section SSec_BuildModule_DFU_Targets Targets
569 * <td><tt>dfu</tt></td>
570 * <td>Program the device FLASH memory with the application's executable data using <tt>dfu-programmer</tt>.</td>
573 * <td><tt>dfu-ee</tt></td>
574 * <td>Program the device EEPROM memory with the application's EEPROM data using <tt>dfu-programmer</tt>.</td>
577 * <td><tt>flip</tt></td>
578 * <td>Program the device FLASH memory with the application's executable data using <tt>batchisp</tt>.</td>
581 * <td><tt>flip-ee</tt></td>
582 * <td>Program the device EEPROM memory with the application's EEPROM data using <tt>batchisp</tt>.</td>
586 * \section SSec_BuildModule_DFU_MandatoryParams Mandatory Parameters
590 * <td><tt>MCU</tt></td>
591 * <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
594 * <td><tt>TARGET</tt></td>
595 * <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
599 * \section SSec_BuildModule_DFU_OptionalParams Optional Parameters
603 * <td><i>None</i></td>
607 * \section SSec_BuildModule_DFU_ProvidedVariables Module Provided Variables
611 * <td><i>None</i></td>
615 * \section SSec_BuildModule_DFU_ProvidedMacros Module Provided Macros
619 * <td><i>None</i></td>
624 /** \page Page_BuildModule_DOXYGEN The DOXYGEN build module
626 * The DOXYGEN code documentation utility LUFA build system module, providing targets to generate
627 * project HTML and other format documentation from a set of source files that include special
630 * To use this module in your application makefile, add the following code:
632 * include $(LUFA_PATH)/Build/lufa_doxygen.mk
635 * \section SSec_BuildModule_DOXYGEN_Requirements Requirements
636 * This module requires the <tt>doxygen</tt> utility from the Doxygen website
637 * (<a>http://www.doxygen.org/</a>) to be available in your system's <b>PATH</b> variable. On *nix
638 * systems the <tt>doxygen</tt> utility can be installed via the project's source code or through
639 * the package manager.
641 * \section SSec_BuildModule_DOXYGEN_Targets Targets
645 * <td><tt>doxygen</tt></td>
646 * <td>Generate project documentation.</td>
649 * <td><tt>doxygen_create</tt></td>
650 * <td>Create a new Doxygen configuration file using the latest template.</td>
653 * <td><tt>doxygen_upgrade</tt></td>
654 * <td>Upgrade an existing Doxygen configuration file to the latest template</td>
658 * \section SSec_BuildModule_DOXYGEN_MandatoryParams Mandatory Parameters
662 * <td><tt>LUFA_PATH</tt></td>
663 * <td>Path to the LUFA library core, either relative or absolute (e.g. <tt>../LUFA-000000/LUFA/</tt>).</td>
667 * \section SSec_BuildModule_DOXYGEN_OptionalParams Optional Parameters
671 * <td><tt>DOXYGEN_CONF</tt></td>
672 * <td>Name and path of the base Doxygen configuration file for the project.</td>
675 * <td><tt>DOXYGEN_FAIL_ON_WARNING</tt></td>
676 * <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>
679 * <td><tt>DOXYGEN_OVERRIDE_PARAMS</tt></td>
680 * <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>
684 * \section SSec_BuildModule_DOXYGEN_ProvidedVariables Module Provided Variables
688 * <td><i>None</i></td>
692 * \section SSec_BuildModule_DOXYGEN_ProvidedMacros Module Provided Macros
696 * <td><i>None</i></td>
701 /** \page Page_BuildModule_HID The HID build module
703 * The HID programming utility LUFA build system module, providing targets to reprogram an
704 * Atmel processor's FLASH memory with a project's compiled binary output file. This module
705 * requires a HID class bootloader to be running in the target, using a protocol compatible
706 * with the PJRC "HalfKay" protocol (<a>http://www.pjrc.com/teensy/halfkay_protocol.html</a>).
708 * To use this module in your application makefile, add the following code:
710 * include $(LUFA_PATH)/Build/lufa_hid.mk
713 * \section SSec_BuildModule_HID_Requirements Requirements
714 * This module requires either the <tt>hid_bootloader_cli</tt> utility from the included LUFA HID
715 * class bootloader API subdirectory, or the <tt>teensy_loader_cli</tt> utility from PJRC
716 * (<a>http://www.pjrc.com/teensy/loader_cli.html</a>) to be available in your system's <b>PATH</b>
719 * \section SSec_BuildModule_HID_Targets Targets
723 * <td><tt>hid</tt></td>
724 * <td>Program the device FLASH memory with the application's executable data using <tt>hid_bootloader_cli</tt>.</td>
727 * <td><tt>hid-ee</tt></td>
728 * <td>Program the device EEPROM memory with the application's EEPROM data using <tt>hid_bootloader_cli</tt> and
729 * a temporary AVR application programmed into the target's FLASH.
730 * \note This will erase the currently loaded application in the target.</td>
733 * <td><tt>teensy</tt></td>
734 * <td>Program the device FLASH memory with the application's executable data using <tt>teensy_loader_cli</tt>.</td>
737 * <td><tt>teensy-ee</tt></td>
738 * <td>Program the device EEPROM memory with the application's EEPROM data using <tt>teensy_loader_cli</tt> and
739 * a temporary AVR application programmed into the target's FLASH.
740 * \note This will erase the currently loaded application in the target.</td>
744 * \section SSec_BuildModule_HID_MandatoryParams Mandatory Parameters
748 * <td><tt>MCU</tt></td>
749 * <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
752 * <td><tt>TARGET</tt></td>
753 * <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
757 * \section SSec_BuildModule_HID_OptionalParams Optional Parameters
761 * <td><i>None</i></td>
765 * \section SSec_BuildModule_HID_ProvidedVariables Module Provided Variables
769 * <td><i>None</i></td>
773 * \section SSec_BuildModule_HID_ProvidedMacros Module Provided Macros
777 * <td><i>None</i></td>
782 /** \page Page_BuildModule_SOURCES The SOURCES build module
784 * The SOURCES LUFA build system module, providing variables listing the various LUFA source files
785 * required to be build by a project for a given LUFA module. This module gives a way to reference
786 * LUFA source files symbollically, so that changes to the library structure do not break the library
789 * To use this module in your application makefile, add the following code:
791 * include $(LUFA_PATH)/Build/lufa_sources.mk
794 * \section SSec_BuildModule_SOURCES_Requirements Requirements
797 * \section SSec_BuildModule_SOURCES_Targets Targets
801 * <td><i>None</i></td>
805 * \section SSec_BuildModule_SOURCES_MandatoryParams Mandatory Parameters
809 * <td><tt>LUFA_PATH</tt></td>
810 * <td>Path to the LUFA library core, either relative or absolute (e.g. <tt>../LUFA-000000/LUFA/</tt>).</td>
813 * <td><tt>ARCH</tt></td>
814 * <td>Architecture of the target processor (see \ref Page_DeviceSupport).</td>
818 * \section SSec_BuildModule_SOURCES_OptionalParams Optional Parameters
822 * <td><i>None</i></td>
826 * \section SSec_BuildModule_SOURCES_ProvidedVariables Module Provided Variables
830 * <td><tt>LUFA_SRC_USB</tt></td>
831 * <td>List of LUFA USB driver source files.</td>
834 * <td><tt>LUFA_SRC_USBCLASS</tt></td>
835 * <td>List of LUFA USB Class driver source files.</td>
838 * <td><tt>LUFA_SRC_TEMPERATURE</tt></td>
839 * <td>List of LUFA temperature sensor driver source files.</td>
842 * <td><tt>LUFA_SRC_SERIAL</tt></td>
843 * <td>List of LUFA Serial U(S)ART driver source files.</td>
846 * <td><tt>LUFA_SRC_TWI</tt></td>
847 * <td>List of LUFA TWI driver source files.</td>
850 * <td><tt>LUFA_SRC_PLATFORM</tt></td>
851 * <td>List of LUFA architecture specific platform management source files.</td>
855 * \section SSec_BuildModule_SOURCES_ProvidedMacros Module Provided Macros
859 * <td><i>None</i></td>