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
7 /** \page Page_BuildSystem The LUFA Build System
\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
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
18 * To use a LUFA build system module, simply add an include to your project makefile:
\r
20 * include $(LUFA_PATH)/Build/lufa_core.mk
\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
27 * \see \ref Sec_AppConfigParams for a copy of the sample LUFA project makefile.
\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
33 * \section SSec_BuildSystemModules Available Modules
\r
35 * The following modules are included in this LUFA release:
\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
48 /** \page Page_BuildModule_BUILD The BUILD build module
\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
54 * To use this module in your application makefile, add the following code:
\r
56 * include $(LUFA_PATH)/Build/lufa_build.mk
\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
64 * \section SSec_BuildModule_BUILD_Targets Targets
\r
68 * <td><tt>size</tt></td>
\r
69 * <td>Display size of the compiled application FLASH and SRAM segments.</td>
\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
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
80 * <td><tt>lib</tt></td>
\r
81 * <td>Build and archive all source files into a library A binary file.</td>
\r
84 * <td><tt>all</tt></td>
\r
85 * <td>Build and link the application into ELF debug and HEX binary files.</td>
\r
88 * <td><tt>elf</tt></td>
\r
89 * <td>Build and link the application into an ELF debug file.</td>
\r
92 * <td><tt>hex</tt></td>
\r
93 * <td>Build and link the application and produce HEX and EEP binary files.</td>
\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
100 * <td><tt>clean</tt></td>
\r
101 * <td>Remove all intermediatary files and binary output files.</td>
\r
104 * <td><tt>mostlyclean</tt></td>
\r
105 * <td>Remove all intermediatary files but preserve any binary output files.</td>
\r
109 * \section SSec_BuildModule_BUILD_MandatoryParams Mandatory Parameters
\r
113 * <td><tt>TARGET</tt></td>
\r
114 * <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
\r
117 * <td><tt>ARCH</tt></td>
\r
118 * <td>Architecture of the target processor (see \ref Page_DeviceSupport).</td>
\r
121 * <td><tt>MCU</tt></td>
\r
122 * <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
\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
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
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
138 * \section SSec_BuildModule_BUILD_OptionalParams Optional Parameters
\r
142 * <td><tt>BOARD</tt></td>
\r
143 * <td>LUFA board hardware drivers to use (see \ref Page_DeviceSupport).</td>
\r
146 * <td><tt>OPTIMIZATION</tt></td>
\r
147 * <td>Optimization level to use when compiling source files (see GCC manual).</td>
\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
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
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
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
166 * <td><tt>F_CPU</tt></td>
\r
167 * <td>Speed of the processor CPU clock, in Hz.</td>
\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
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
178 * <td><tt>ASM_FLAGS</tt></td>
\r
179 * <td>Flags to pass to the assembler only, after the automatically generated flags.</td>
\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
186 * <td><tt>LD_FLAGS</tt></td>
\r
187 * <td>Flags to pass to the linker, after the automatically generated flags.</td>
\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
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
200 * \section SSec_BuildModule_BUILD_ProvidedVariables Module Provided Variables
\r
204 * <td><i>None</i></td>
\r
208 * \section SSec_BuildModule_BUILD_ProvidedMacros Module Provided Macros
\r
212 * <td><i>None</i></td>
\r
217 /** \page Page_BuildModule_CORE The CORE build module
\r
219 * The core LUFA build system module, providing common build system help and information targets.
\r
221 * To use this module in your application makefile, add the following code:
\r
223 * include $(LUFA_PATH)/Build/lufa_core.mk
\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
230 * \section SSec_BuildModule_CORE_Targets Targets
\r
234 * <td><tt>help</tt></td>
\r
235 * <td>Display build system help and configuration information.</td>
\r
238 * <td><tt>list_targets</tt></td>
\r
239 * <td>List all available build targets from the build system.</td>
\r
242 * <td><tt>list_modules</tt></td>
\r
243 * <td>List all available build modules from the build system.</td>
\r
246 * <td><tt>list_mandatory</tt></td>
\r
247 * <td>List all mandatory parameters required by the included modules.</td>
\r
250 * <td><tt>list_optional</tt></td>
\r
251 * <td>List all optional parameters required by the included modules.</td>
\r
254 * <td><tt>list_provided</tt></td>
\r
255 * <td>List all variables provided by the included modules.</td>
\r
258 * <td><tt>list_macros</tt></td>
\r
259 * <td>List all macros provided by the included modules.</td>
\r
263 * \section SSec_BuildModule_CORE_MandatoryParams Mandatory Parameters
\r
267 * <td><i>None</i></td>
\r
271 * \section SSec_BuildModule_CORE_OptionalParams Optional Parameters
\r
275 * <td><i>None</i></td>
\r
279 * \section SSec_BuildModule_CORE_ProvidedVariables Module Provided Variables
\r
283 * <td><i>None</i></td>
\r
287 * \section SSec_BuildModule_CORE_ProvidedMacros Module Provided Macros
\r
291 * <td><i>None</i></td>
\r
296 /** \page Page_BuildModule_ATPROGRAM The ATPROGRAM build module
\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
301 * To use this module in your application makefile, add the following code:
\r
303 * include $(LUFA_PATH)/Build/lufa_atprogram.mk
\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
311 * \section SSec_BuildModule_ATPROGRAM_Targets Targets
\r
315 * <td><tt>atprogram</tt></td>
\r
316 * <td>Program the device FLASH memory with the application's executable data.</td>
\r
319 * <td><tt>atprogram-ee</tt></td>
\r
320 * <td>Program the device EEPROM memory with the application's EEPROM data.</td>
\r
324 * \section SSec_BuildModule_ATPROGRAM_MandatoryParams Mandatory Parameters
\r
328 * <td><tt>MCU</tt></td>
\r
329 * <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
\r
332 * <td><tt>TARGET</tt></td>
\r
333 * <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
\r
337 * \section SSec_BuildModule_ATPROGRAM_OptionalParams Optional Parameters
\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
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
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
354 * \section SSec_BuildModule_ATPROGRAM_ProvidedVariables Module Provided Variables
\r
358 * <td><i>None</i></td>
\r
362 * \section SSec_BuildModule_ATPROGRAM_ProvidedMacros Module Provided Macros
\r
366 * <td><i>None</i></td>
\r
371 /** \page Page_BuildModule_AVRDUDE The AVRDUDE build module
\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
376 * To use this module in your application makefile, add the following code:
\r
378 * include $(LUFA_PATH)/Build/lufa_avrdude.mk
\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
387 * \section SSec_BuildModule_AVRDUDE_Targets Targets
\r
391 * <td><tt>avrdude</tt></td>
\r
392 * <td>Program the device FLASH memory with the application's executable data.</td>
\r
395 * <td><tt>avrdude</tt></td>
\r
396 * <td>Program the device EEPROM memory with the application's EEPROM data.</td>
\r
400 * \section SSec_BuildModule_AVRDUDE_MandatoryParams Mandatory Parameters
\r
404 * <td><tt>MCU</tt></td>
\r
405 * <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
\r
408 * <td><tt>TARGET</tt></td>
\r
409 * <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
\r
413 * \section SSec_BuildModule_AVRDUDE_OptionalParams Optional Parameters
\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
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
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
430 * \section SSec_BuildModule_AVRDUDE_ProvidedVariables Module Provided Variables
\r
434 * <td><i>None</i></td>
\r
438 * \section SSec_BuildModule_AVRDUDE_ProvidedMacros Module Provided Macros
\r
442 * <td><i>None</i></td>
\r
447 /** \page Page_BuildModule_CPPCHECK The CPPCHECK build module
\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
452 * To use this module in your application makefile, add the following code:
\r
454 * include $(LUFA_PATH)/Build/lufa_cppcheck.mk
\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
463 * \section SSec_BuildModule_CPPCHECK_Targets Targets
\r
467 * <td><tt>cppcheck</tt></td>
\r
468 * <td>Statically analyze the project source code for issues.</td>
\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
476 * \section SSec_BuildModule_CPPCHECK_MandatoryParams Mandatory Parameters
\r
480 * <td><tt>SRC</tt></td>
\r
481 * <td>List of source files to statically analyze.</td>
\r
485 * \section SSec_BuildModule_CPPCHECK_OptionalParams Optional Parameters
\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
493 * <td><tt>CPPCHECK_EXCLUDES</tt></td>
\r
494 * <td>Paths or path fragments to exclude when analyzing.</td>
\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
501 * <td><tt>CPPCHECK_ENABLE</tt></td>
\r
502 * <td>Analysis rule categories to enable (see <tt>cppcheck</tt> documentation).</td>
\r
505 * <td><tt>CPPCHECK_SUPPRESS</tt></td>
\r
506 * <td>Specific analysis rules to suppress (see <tt>cppcheck</tt> documentation).</td>
\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
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
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
522 * \section SSec_BuildModule_CPPCHECK_ProvidedVariables Module Provided Variables
\r
526 * <td><i>None</i></td>
\r
530 * \section SSec_BuildModule_CPPCHECK_ProvidedMacros Module Provided Macros
\r
534 * <td><i>None</i></td>
\r
539 /** \page Page_BuildModule_DFU The DFU build module
\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
546 * To use this module in your application makefile, add the following code:
\r
548 * include $(LUFA_PATH)/Build/lufa_dfu.mk
\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
557 * \section SSec_BuildModule_DFU_Targets Targets
\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
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
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
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
578 * \section SSec_BuildModule_DFU_MandatoryParams Mandatory Parameters
\r
582 * <td><tt>MCU</tt></td>
\r
583 * <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
\r
586 * <td><tt>TARGET</tt></td>
\r
587 * <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
\r
591 * \section SSec_BuildModule_DFU_OptionalParams Optional Parameters
\r
595 * <td><i>None</i></td>
\r
599 * \section SSec_BuildModule_DFU_ProvidedVariables Module Provided Variables
\r
603 * <td><i>None</i></td>
\r
607 * \section SSec_BuildModule_DFU_ProvidedMacros Module Provided Macros
\r
611 * <td><i>None</i></td>
\r
616 /** \page Page_BuildModule_DOXYGEN The DOXYGEN build module
\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
622 * To use this module in your application makefile, add the following code:
\r
624 * include $(LUFA_PATH)/Build/lufa_doxygen.mk
\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
633 * \section SSec_BuildModule_DOXYGEN_Targets Targets
\r
637 * <td><tt>doxygen</tt></td>
\r
638 * <td>Generate project documentation.</td>
\r
642 * \section SSec_BuildModule_DOXYGEN_MandatoryParams Mandatory Parameters
\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
651 * \section SSec_BuildModule_DOXYGEN_OptionalParams Optional Parameters
\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
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
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
668 * \section SSec_BuildModule_DOXYGEN_ProvidedVariables Module Provided Variables
\r
672 * <td><i>None</i></td>
\r
676 * \section SSec_BuildModule_DOXYGEN_ProvidedMacros Module Provided Macros
\r
680 * <td><i>None</i></td>
\r
685 /** \page Page_BuildModule_HID The HID build module
\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
692 * To use this module in your application makefile, add the following code:
\r
694 * include $(LUFA_PATH)/Build/lufa_hid.mk
\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
703 * \section SSec_BuildModule_HID_Targets Targets
\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
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
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
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
728 * \section SSec_BuildModule_HID_MandatoryParams Mandatory Parameters
\r
732 * <td><tt>MCU</tt></td>
\r
733 * <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
\r
736 * <td><tt>TARGET</tt></td>
\r
737 * <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
\r
741 * \section SSec_BuildModule_HID_OptionalParams Optional Parameters
\r
745 * <td><i>None</i></td>
\r
749 * \section SSec_BuildModule_HID_ProvidedVariables Module Provided Variables
\r
753 * <td><i>None</i></td>
\r
757 * \section SSec_BuildModule_HID_ProvidedMacros Module Provided Macros
\r
761 * <td><i>None</i></td>
\r
766 /** \page Page_BuildModule_SOURCES The SOURCES build module
\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
773 * To use this module in your application makefile, add the following code:
\r
775 * include $(LUFA_PATH)/Build/lufa_sources.mk
\r
778 * \section SSec_BuildModule_SOURCES_Requirements Requirements
\r
781 * \section SSec_BuildModule_SOURCES_Targets Targets
\r
785 * <td><i>None</i></td>
\r
789 * \section SSec_BuildModule_SOURCES_MandatoryParams Mandatory Parameters
\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
797 * <td><tt>ARCH</tt></td>
\r
798 * <td>Architecture of the target processor (see \ref Page_DeviceSupport).</td>
\r
802 * \section SSec_BuildModule_SOURCES_OptionalParams Optional Parameters
\r
806 * <td><i>None</i></td>
\r
810 * \section SSec_BuildModule_SOURCES_ProvidedVariables Module Provided Variables
\r
814 * <td><tt>LUFA_SRC_USB</tt></td>
\r
815 * <td>List of LUFA USB driver source files.</td>
\r
818 * <td><tt>LUFA_SRC_USBCLASS</tt></td>
\r
819 * <td>List of LUFA USB Class driver source files.</td>
\r
822 * <td><tt>LUFA_SRC_TEMPERATURE</tt></td>
\r
823 * <td>List of LUFA temperature sensor driver source files.</td>
\r
826 * <td><tt>LUFA_SRC_SERIAL</tt></td>
\r
827 * <td>List of LUFA Serial U(S)ART driver source files.</td>
\r
830 * <td><tt>LUFA_SRC_TWI</tt></td>
\r
831 * <td>List of LUFA TWI driver source files.</td>
\r
834 * <td><tt>LUFA_SRC_PLATFORM</tt></td>
\r
835 * <td>List of LUFA architecture specific platform management source files.</td>
\r
839 * \section SSec_BuildModule_SOURCES_ProvidedMacros Module Provided Macros
\r
843 * <td><i>None</i></td>
\r