Minor documentation improvements.
[pub/USBasp.git] / LUFA / DoxygenPages / BuildSystem.txt
1 /** \file
2 *
3 * This file contains special DoxyGen information for the generation of the main page and other special
4 * documentation pages. It is not a project source file.
5 */
6
7 /** \page Page_BuildSystem The LUFA Build System
8 *
9 * \section Sec_BuildSystemOverview Overview of the LUFA Build System
10 * The LUFA build system is an attempt at making a set of re-usable, modular build make files which
11 * can be referenced in a LUFA powered project, to minimise the amount of code required in an
12 * application makefile. The system is written in GNU Make, and each module is independant of
13 * one-another.
14 *
15 * For details on the prerequisites needed for Linux and Windows machines to be able to use the LUFA
16 * build system, see \ref Sec_Prerequisites.
17 *
18 * To use a LUFA build system module, simply add an include to your project makefile. All user projects
19 * should at a minimum include \ref Page_BuildModule_CORE for base functionality:
20 * \code
21 * include $(LUFA_PATH)/Build/lufa_core.mk
22 * \endcode
23 *
24 * Once included in your project makefile, the associated build module targets will be added to your
25 * project's build makefile targets automatically. To call a build target, run <tt>make {TARGET_NAME}</tt>
26 * from the command line, substituting in the appropriate target name.
27 *
28 * \see \ref Sec_AppMakefileParams for a copy of the sample LUFA project makefile.
29 *
30 * Each build module may have one or more mandatory parameters (GNU Make variables) which <i>must</i>
31 * be supplied in the project makefile for the module to work, and one or more optional parameters which
32 * may be defined and which will assume a sensible default if not.
33 *
34 * \section SSec_BuildSystemModules Available Modules
35 *
36 * The following modules are included in this LUFA release:
37 *
38 * \li \subpage Page_BuildModule_ATPROGRAM - Device Programming
39 * \li \subpage Page_BuildModule_AVRDUDE - Device Programming
40 * \li \subpage Page_BuildModule_BUILD - Compiling/Assembling/Linking
41 * \li \subpage Page_BuildModule_CORE - Core Build System Functions
42 * \li \subpage Page_BuildModule_CPPCHECK - Static Code Analysis
43 * \li \subpage Page_BuildModule_DFU - Device Programming
44 * \li \subpage Page_BuildModule_DOXYGEN - Automated Source Code Documentation
45 * \li \subpage Page_BuildModule_HID - Device Programming
46 * \li \subpage Page_BuildModule_SOURCES - LUFA Module Source Code Variables
47 */
48
49 /** \page Page_BuildModule_BUILD The BUILD build module
50 *
51 * The BUILD LUFA build system module, providing targets for the compilation,
52 * assembling and linking of an application from source code into binary files
53 * suitable for programming into a target device, using the GCC compiler.
54 *
55 * To use this module in your application makefile, add the following code:
56 * \code
57 * include $(LUFA_PATH)/Build/lufa_build.mk
58 * \endcode
59 *
60 * \section SSec_BuildModule_BUILD_Requirements Requirements
61 * This module requires the the architecture appropriate binaries of the GCC compiler are available in your
62 * system's <b>PATH</b> variable. The GCC compiler and associated toolchain is distributed in Atmel AVR Studio
63 * 5.x and Atmel Studio 6.x installation directories, as well as in many third party distribution packages.
64 *
65 * \section SSec_BuildModule_BUILD_Targets Targets
66 *
67 * <table>
68 * <tr>
69 * <td><tt>size</tt></td>
70 * <td>Display size of the compiled application FLASH and SRAM segments.</td>
71 * </tr>
72 * <tr>
73 * <td><tt>symbol-sizes</tt></td>
74 * <td>Display a size-sorted list of symbols from the compiled application, in decimal bytes.</td>
75 * </tr>
76 * <tr>
77 * <td><tt>lib</tt></td>
78 * <td>Build and archive all source files into a library A binary file.</td>
79 * </tr>
80 * <tr>
81 * <td><tt>all</tt></td>
82 * <td>Build and link the application into ELF debug and HEX binary files.</td>
83 * </tr>
84 * <tr>
85 * <td><tt>elf</tt></td>
86 * <td>Build and link the application into an ELF debug file.</td>
87 * </tr>
88 * <tr>
89 * <td><tt>hex</tt></td>
90 * <td>Build and link the application and produce HEX and EEP binary files.</td>
91 * </tr>
92 * <tr>
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>
95 * </tr>
96 * <tr>
97 * <td><tt>clean</tt></td>
98 * <td>Remove all intermediatary files and binary output files.</td>
99 * </tr>
100 * <tr>
101 * <td><tt>mostlyclean</tt></td>
102 * <td>Remove all intermediatary files but preserve any binary output files.</td>
103 * </tr>
104 * <tr>
105 * <td><tt><i>&lt;filename&gt;</i>.s</tt></td>
106 * <td>Create an assembly listing of a given input C/C++ source file.</td>
107 * </tr>
108 * </table>
109 *
110 * \section SSec_BuildModule_BUILD_MandatoryParams Mandatory Parameters
111 *
112 * <table>
113 * <tr>
114 * <td><tt>TARGET</tt></td>
115 * <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
116 * </tr>
117 * <tr>
118 * <td><tt>ARCH</tt></td>
119 * <td>Architecture of the target processor (see \ref Page_DeviceSupport).</td>
120 * </tr>
121 * <tr>
122 * <td><tt>MCU</tt></td>
123 * <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
124 * </tr>
125 * <tr>
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>
128 * </tr>
129 * <tr>
130 * <td><tt>F_USB</tt></td>
131 * <td>Speed in Hz of the input clock frequency to the target's USB controller.</td>
132 * </tr>
133 * <tr>
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>
136 * </tr>
137 * </table>
138 *
139 * \section SSec_BuildModule_BUILD_OptionalParams Optional Parameters
140 *
141 * <table>
142 * <tr>
143 * <td><tt>BOARD</tt></td>
144 * <td>LUFA board hardware drivers to use (see \ref Page_DeviceSupport).</td>
145 * </tr>
146 * <tr>
147 * <td><tt>OPTIMIZATION</tt></td>
148 * <td>Optimization level to use when compiling source files (see GCC manual).</td>
149 * </tr>
150 * <tr>
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>
153 * </tr>
154 * <tr>
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>
157 * </tr>
158 * <tr>
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>
161 * </tr>
162 * <tr>
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>
165 * </tr>
166 * <tr>
167 * <td><tt>F_CPU</tt></td>
168 * <td>Speed of the processor CPU clock, in Hz.</td>
169 * </tr>
170 * <tr>
171 * <td><tt>C_FLAGS</tt></td>
172 * <td>Flags to pass to the C compiler only, after the automatically generated flags.</td>
173 * </tr>
174 * <tr>
175 * <td><tt>CPP_FLAGS</tt></td>
176 * <td>Flags to pass to the C++ compiler only, after the automatically generated flags.</td>
177 * </tr>
178 * <tr>
179 * <td><tt>ASM_FLAGS</tt></td>
180 * <td>Flags to pass to the assembler only, after the automatically generated flags.</td>
181 * </tr>
182 * <tr>
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>
185 * </tr>
186 * <tr>
187 * <td><tt>LD_FLAGS</tt></td>
188 * <td>Flags to pass to the linker, after the automatically generated flags.</td>
189 * </tr>
190 * <tr>
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>
196 * </tr>
197 * <tr>
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>
201 * </tr>
202 * <tr>
203 * <td><tt>OBJECT_FILES</tt></td>
204 * <td>List of additional object files that should be linked into the resulting binary.</td>
205 * </tr>
206 * </table>
207 *
208 * \section SSec_BuildModule_BUILD_ProvidedVariables Module Provided Variables
209 *
210 * <table>
211 * <tr>
212 * <td><i>None</i></td>
213 * </tr>
214 * </table>
215 *
216 * \section SSec_BuildModule_BUILD_ProvidedMacros Module Provided Macros
217 *
218 * <table>
219 * <tr>
220 * <td><i>None</i></td>
221 * </tr>
222 * </table>
223 */
224
225 /** \page Page_BuildModule_CORE The CORE build module
226 *
227 * The core LUFA build system module, providing common build system help and information targets.
228 *
229 * To use this module in your application makefile, add the following code:
230 * \code
231 * include $(LUFA_PATH)/Build/lufa_core.mk
232 * \endcode
233 *
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.).
237 *
238 * \section SSec_BuildModule_CORE_Targets Targets
239 *
240 * <table>
241 * <tr>
242 * <td><tt>help</tt></td>
243 * <td>Display build system help and configuration information.</td>
244 * </tr>
245 * <tr>
246 * <td><tt>list_targets</tt></td>
247 * <td>List all available build targets from the build system.</td>
248 * </tr>
249 * <tr>
250 * <td><tt>list_modules</tt></td>
251 * <td>List all available build modules from the build system.</td>
252 * </tr>
253 * <tr>
254 * <td><tt>list_mandatory</tt></td>
255 * <td>List all mandatory parameters required by the included modules.</td>
256 * </tr>
257 * <tr>
258 * <td><tt>list_optional</tt></td>
259 * <td>List all optional parameters required by the included modules.</td>
260 * </tr>
261 * <tr>
262 * <td><tt>list_provided</tt></td>
263 * <td>List all variables provided by the included modules.</td>
264 * </tr>
265 * <tr>
266 * <td><tt>list_macros</tt></td>
267 * <td>List all macros provided by the included modules.</td>
268 * </tr>
269 * </table>
270 *
271 * \section SSec_BuildModule_CORE_MandatoryParams Mandatory Parameters
272 *
273 * <table>
274 * <tr>
275 * <td><i>None</i></td>
276 * </tr>
277 * </table>
278 *
279 * \section SSec_BuildModule_CORE_OptionalParams Optional Parameters
280 *
281 * <table>
282 * <tr>
283 * <td><i>None</i></td>
284 * </tr>
285 * </table>
286 *
287 * \section SSec_BuildModule_CORE_ProvidedVariables Module Provided Variables
288 *
289 * <table>
290 * <tr>
291 * <td><i>None</i></td>
292 * </tr>
293 * </table>
294 *
295 * \section SSec_BuildModule_CORE_ProvidedMacros Module Provided Macros
296 *
297 * <table>
298 * <tr>
299 * <td><i>None</i></td>
300 * </tr>
301 * </table>
302 */
303
304 /** \page Page_BuildModule_ATPROGRAM The ATPROGRAM build module
305 *
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.
308 *
309 * To use this module in your application makefile, add the following code:
310 * \code
311 * include $(LUFA_PATH)/Build/lufa_atprogram.mk
312 * \endcode
313 *
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.
318 *
319 * \section SSec_BuildModule_ATPROGRAM_Targets Targets
320 *
321 * <table>
322 * <tr>
323 * <td><tt>atprogram</tt></td>
324 * <td>Program the device FLASH memory with the application's executable data.</td>
325 * </tr>
326 * <tr>
327 * <td><tt>atprogram-ee</tt></td>
328 * <td>Program the device EEPROM memory with the application's EEPROM data.</td>
329 * </tr>
330 * </table>
331 *
332 * \section SSec_BuildModule_ATPROGRAM_MandatoryParams Mandatory Parameters
333 *
334 * <table>
335 * <tr>
336 * <td><tt>MCU</tt></td>
337 * <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
338 * </tr>
339 * <tr>
340 * <td><tt>TARGET</tt></td>
341 * <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
342 * </tr>
343 * </table>
344 *
345 * \section SSec_BuildModule_ATPROGRAM_OptionalParams Optional Parameters
346 *
347 * <table>
348 * <tr>
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>
351 * </tr>
352 * <tr>
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>
355 * </tr>
356 * <tr>
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>
359 * </tr>
360 * </table>
361 *
362 * \section SSec_BuildModule_ATPROGRAM_ProvidedVariables Module Provided Variables
363 *
364 * <table>
365 * <tr>
366 * <td><i>None</i></td>
367 * </tr>
368 * </table>
369 *
370 * \section SSec_BuildModule_ATPROGRAM_ProvidedMacros Module Provided Macros
371 *
372 * <table>
373 * <tr>
374 * <td><i>None</i></td>
375 * </tr>
376 * </table>
377 */
378
379 /** \page Page_BuildModule_AVRDUDE The AVRDUDE build module
380 *
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.
383 *
384 * To use this module in your application makefile, add the following code:
385 * \code
386 * include $(LUFA_PATH)/Build/lufa_avrdude.mk
387 * \endcode
388 *
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.
394 *
395 * \section SSec_BuildModule_AVRDUDE_Targets Targets
396 *
397 * <table>
398 * <tr>
399 * <td><tt>avrdude</tt></td>
400 * <td>Program the device FLASH memory with the application's executable data.</td>
401 * </tr>
402 * <tr>
403 * <td><tt>avrdude-ee</tt></td>
404 * <td>Program the device EEPROM memory with the application's EEPROM data.</td>
405 * </tr>
406 * </table>
407 *
408 * \section SSec_BuildModule_AVRDUDE_MandatoryParams Mandatory Parameters
409 *
410 * <table>
411 * <tr>
412 * <td><tt>MCU</tt></td>
413 * <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
414 * </tr>
415 * <tr>
416 * <td><tt>TARGET</tt></td>
417 * <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
418 * </tr>
419 * </table>
420 *
421 * \section SSec_BuildModule_AVRDUDE_OptionalParams Optional Parameters
422 *
423 * <table>
424 * <tr>
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>
427 * </tr>
428 * <tr>
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>
431 * </tr>
432 * <tr>
433 * <td><tt>AVRDUDE_FLAGS</tt></td>
434 * <td>Additional flags to pass to avrdude when programming, applied after the automatically generated flags.</td>
435 * </tr>
436 * </table>
437 *
438 * \section SSec_BuildModule_AVRDUDE_ProvidedVariables Module Provided Variables
439 *
440 * <table>
441 * <tr>
442 * <td><i>None</i></td>
443 * </tr>
444 * </table>
445 *
446 * \section SSec_BuildModule_AVRDUDE_ProvidedMacros Module Provided Macros
447 *
448 * <table>
449 * <tr>
450 * <td><i>None</i></td>
451 * </tr>
452 * </table>
453 */
454
455 /** \page Page_BuildModule_CPPCHECK The CPPCHECK build module
456 *
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.
459 *
460 * To use this module in your application makefile, add the following code:
461 * \code
462 * include $(LUFA_PATH)/Build/lufa_cppcheck.mk
463 * \endcode
464 *
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.
470 *
471 * \section SSec_BuildModule_CPPCHECK_Targets Targets
472 *
473 * <table>
474 * <tr>
475 * <td><tt>cppcheck</tt></td>
476 * <td>Statically analyze the project source code for issues.</td>
477 * </tr>
478 * <tr>
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>
481 * </tr>
482 * </table>
483 *
484 * \section SSec_BuildModule_CPPCHECK_MandatoryParams Mandatory Parameters
485 *
486 * <table>
487 * <tr>
488 * <td><tt>SRC</tt></td>
489 * <td>List of source files to statically analyze.</td>
490 * </tr>
491 * </table>
492 *
493 * \section SSec_BuildModule_CPPCHECK_OptionalParams Optional Parameters
494 *
495 * <table>
496 * <tr>
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>
499 * </tr>
500 * <tr>
501 * <td><tt>CPPCHECK_EXCLUDES</tt></td>
502 * <td>Paths or path fragments to exclude when analyzing.</td>
503 * </tr>
504 * <tr>
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>
507 * </tr>
508 * <tr>
509 * <td><tt>CPPCHECK_ENABLE</tt></td>
510 * <td>Analysis rule categories to enable (see <tt>cppcheck</tt> documentation).</td>
511 * </tr>
512 * <tr>
513 * <td><tt>CPPCHECK_SUPPRESS</tt></td>
514 * <td>Specific analysis rules to suppress (see <tt>cppcheck</tt> documentation).</td>
515 * </tr>
516 * <tr>
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>
519 * </tr>
520 * <tr>
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>
523 * </tr>
524 * <tr>
525 * <td><tt>CPPCHECK_FLAGS</tt></td>
526 * <td>Extra flags to pass to <tt>cppcheck</tt>, after the automatically generated flags.</td>
527 * </tr>
528 * </table>
529 *
530 * \section SSec_BuildModule_CPPCHECK_ProvidedVariables Module Provided Variables
531 *
532 * <table>
533 * <tr>
534 * <td><i>None</i></td>
535 * </tr>
536 * </table>
537 *
538 * \section SSec_BuildModule_CPPCHECK_ProvidedMacros Module Provided Macros
539 *
540 * <table>
541 * <tr>
542 * <td><i>None</i></td>
543 * </tr>
544 * </table>
545 */
546
547 /** \page Page_BuildModule_DFU The DFU build module
548 *
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.
553 *
554 * To use this module in your application makefile, add the following code:
555 * \code
556 * include $(LUFA_PATH)/Build/lufa_dfu.mk
557 * \endcode
558 *
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.
564 *
565 * \section SSec_BuildModule_DFU_Targets Targets
566 *
567 * <table>
568 * <tr>
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>
571 * </tr>
572 * <tr>
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>
575 * </tr>
576 * <tr>
577 * <td><tt>flip</tt></td>
578 * <td>Program the device FLASH memory with the application's executable data using <tt>batchisp</tt>.</td>
579 * </tr>
580 * <tr>
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>
583 * </tr>
584 * </table>
585 *
586 * \section SSec_BuildModule_DFU_MandatoryParams Mandatory Parameters
587 *
588 * <table>
589 * <tr>
590 * <td><tt>MCU</tt></td>
591 * <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
592 * </tr>
593 * <tr>
594 * <td><tt>TARGET</tt></td>
595 * <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
596 * </tr>
597 * </table>
598 *
599 * \section SSec_BuildModule_DFU_OptionalParams Optional Parameters
600 *
601 * <table>
602 * <tr>
603 * <td><i>None</i></td>
604 * </tr>
605 * </table>
606 *
607 * \section SSec_BuildModule_DFU_ProvidedVariables Module Provided Variables
608 *
609 * <table>
610 * <tr>
611 * <td><i>None</i></td>
612 * </tr>
613 * </table>
614 *
615 * \section SSec_BuildModule_DFU_ProvidedMacros Module Provided Macros
616 *
617 * <table>
618 * <tr>
619 * <td><i>None</i></td>
620 * </tr>
621 * </table>
622 */
623
624 /** \page Page_BuildModule_DOXYGEN The DOXYGEN build module
625 *
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
628 * Doxygen comments.
629 *
630 * To use this module in your application makefile, add the following code:
631 * \code
632 * include $(LUFA_PATH)/Build/lufa_doxygen.mk
633 * \endcode
634 *
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.
640 *
641 * \section SSec_BuildModule_DOXYGEN_Targets Targets
642 *
643 * <table>
644 * <tr>
645 * <td><tt>doxygen</tt></td>
646 * <td>Generate project documentation.</td>
647 * </tr>
648 * <tr>
649 * <td><tt>doxygen_create</tt></td>
650 * <td>Create a new Doxygen configuration file using the latest template.</td>
651 * </tr>
652 * <tr>
653 * <td><tt>doxygen_upgrade</tt></td>
654 * <td>Upgrade an existing Doxygen configuration file to the latest template</td>
655 * </tr>
656 * </table>
657 *
658 * \section SSec_BuildModule_DOXYGEN_MandatoryParams Mandatory Parameters
659 *
660 * <table>
661 * <tr>
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>
664 * </tr>
665 * </table>
666 *
667 * \section SSec_BuildModule_DOXYGEN_OptionalParams Optional Parameters
668 *
669 * <table>
670 * <tr>
671 * <td><tt>DOXYGEN_CONF</tt></td>
672 * <td>Name and path of the base Doxygen configuration file for the project.</td>
673 * </tr>
674 * <tr>
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>
677 * </tr>
678 * <tr>
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>
681 * </tr>
682 * </table>
683 *
684 * \section SSec_BuildModule_DOXYGEN_ProvidedVariables Module Provided Variables
685 *
686 * <table>
687 * <tr>
688 * <td><i>None</i></td>
689 * </tr>
690 * </table>
691 *
692 * \section SSec_BuildModule_DOXYGEN_ProvidedMacros Module Provided Macros
693 *
694 * <table>
695 * <tr>
696 * <td><i>None</i></td>
697 * </tr>
698 * </table>
699 */
700
701 /** \page Page_BuildModule_HID The HID build module
702 *
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>).
707 *
708 * To use this module in your application makefile, add the following code:
709 * \code
710 * include $(LUFA_PATH)/Build/lufa_hid.mk
711 * \endcode
712 *
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>
717 * variable.
718 *
719 * \section SSec_BuildModule_HID_Targets Targets
720 *
721 * <table>
722 * <tr>
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>
725 * </tr>
726 * <tr>
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>
731 * </tr>
732 * <tr>
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>
735 * </tr>
736 * <tr>
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>
741 * </tr>
742 * </table>
743 *
744 * \section SSec_BuildModule_HID_MandatoryParams Mandatory Parameters
745 *
746 * <table>
747 * <tr>
748 * <td><tt>MCU</tt></td>
749 * <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
750 * </tr>
751 * <tr>
752 * <td><tt>TARGET</tt></td>
753 * <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
754 * </tr>
755 * </table>
756 *
757 * \section SSec_BuildModule_HID_OptionalParams Optional Parameters
758 *
759 * <table>
760 * <tr>
761 * <td><i>None</i></td>
762 * </tr>
763 * </table>
764 *
765 * \section SSec_BuildModule_HID_ProvidedVariables Module Provided Variables
766 *
767 * <table>
768 * <tr>
769 * <td><i>None</i></td>
770 * </tr>
771 * </table>
772 *
773 * \section SSec_BuildModule_HID_ProvidedMacros Module Provided Macros
774 *
775 * <table>
776 * <tr>
777 * <td><i>None</i></td>
778 * </tr>
779 * </table>
780 */
781
782 /** \page Page_BuildModule_SOURCES The SOURCES build module
783 *
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
787 * makefile.
788 *
789 * To use this module in your application makefile, add the following code:
790 * \code
791 * include $(LUFA_PATH)/Build/lufa_sources.mk
792 * \endcode
793 *
794 * \section SSec_BuildModule_SOURCES_Requirements Requirements
795 * None.
796 *
797 * \section SSec_BuildModule_SOURCES_Targets Targets
798 *
799 * <table>
800 * <tr>
801 * <td><i>None</i></td>
802 * </tr>
803 * </table>
804 *
805 * \section SSec_BuildModule_SOURCES_MandatoryParams Mandatory Parameters
806 *
807 * <table>
808 * <tr>
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>
811 * </tr>
812 * <tr>
813 * <td><tt>ARCH</tt></td>
814 * <td>Architecture of the target processor (see \ref Page_DeviceSupport).</td>
815 * </tr>
816 * </table>
817 *
818 * \section SSec_BuildModule_SOURCES_OptionalParams Optional Parameters
819 *
820 * <table>
821 * <tr>
822 * <td><i>None</i></td>
823 * </tr>
824 * </table>
825 *
826 * \section SSec_BuildModule_SOURCES_ProvidedVariables Module Provided Variables
827 *
828 * <table>
829 * <tr>
830 * <td><tt>LUFA_SRC_USB</tt></td>
831 * <td>List of LUFA USB driver source files.</td>
832 * </tr>
833 * <tr>
834 * <td><tt>LUFA_SRC_USBCLASS</tt></td>
835 * <td>List of LUFA USB Class driver source files.</td>
836 * </tr>
837 * <tr>
838 * <td><tt>LUFA_SRC_TEMPERATURE</tt></td>
839 * <td>List of LUFA temperature sensor driver source files.</td>
840 * </tr>
841 * <tr>
842 * <td><tt>LUFA_SRC_SERIAL</tt></td>
843 * <td>List of LUFA Serial U(S)ART driver source files.</td>
844 * </tr>
845 * <tr>
846 * <td><tt>LUFA_SRC_TWI</tt></td>
847 * <td>List of LUFA TWI driver source files.</td>
848 * </tr>
849 * <tr>
850 * <td><tt>LUFA_SRC_PLATFORM</tt></td>
851 * <td>List of LUFA architecture specific platform management source files.</td>
852 * </tr>
853 * </table>
854 *
855 * \section SSec_BuildModule_SOURCES_ProvidedMacros Module Provided Macros
856 *
857 * <table>
858 * <tr>
859 * <td><i>None</i></td>
860 * </tr>
861 * </table>
862 */