X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/44ff0af68cbb67b060f89c3d7142af4f02b28f2f..1faa5ba70aecc5a55ec198e2129181f5a79489d2:/LUFA/DoxygenPages/BuildSystem.txt?ds=sidebyside diff --git a/LUFA/DoxygenPages/BuildSystem.txt b/LUFA/DoxygenPages/BuildSystem.txt index fe29aeb00..2c42c7da8 100644 --- a/LUFA/DoxygenPages/BuildSystem.txt +++ b/LUFA/DoxygenPages/BuildSystem.txt @@ -12,6 +12,9 @@ * application makefile. The system is written in GNU Make, and each module is independant of * one-another. * + * For details on the prerequisites needed for Linux and Windows machines to be able to use the LUFA + * build system, see \ref Sec_Prerequisites. + * * To use a LUFA build system module, simply add an include to your project makefile: * \code * include $(LUFA_PATH)/Build/lufa.core.in @@ -38,6 +41,7 @@ * \li \subpage Page_BuildModule_CPPCHECK - Static Code Analysis * \li \subpage Page_BuildModule_DFU - Device Programming * \li \subpage Page_BuildModule_DOXYGEN - Automated Source Code Documentation + * \li \subpage Page_BuildModule_HID - Device Programming * \li \subpage Page_BuildModule_SOURCES - LUFA Module Source Code Variables */ @@ -69,6 +73,14 @@ * Display a size-sorted list of symbols from the compiled application, in decimal bytes. * * + * check-source + * Display a list of input SRC source files which cannot be found (if any). + * + * + * lib + * Build and archive all source files into a library A binary file. + * + * * all * Build and link the application into ELF debug and HEX binary files. * @@ -88,6 +100,10 @@ * clean * Remove all intermediatary files and binary output files. * + * + * mostlyclean + * Remove all intermediatary files but preserve any binary output files. + * * * * \section SSec_BuildModule_BUILD_MandatoryParams Mandatory Parameters @@ -162,9 +178,18 @@ * LD_FLAGS * Flags to pass to the linker, after the automatically generated flags. * + * + * OBJDIR + * Directory to place the generated object and dependency files. If set to "." the same folder as the source file will be used. + * \note When this option is enabled, all source filenames must be unique. + * + * + * OBJECT_FILES + * List of additional object files that should be linked into the resulting binary. + * * * - * \section SSec_BuildModule_BUILD_ProvideVariables Module Provided Variables + * \section SSec_BuildModule_BUILD_ProvidedVariables Module Provided Variables * * * @@ -243,7 +268,7 @@ * *
* - * \section SSec_BuildModule_CORE_ProvideVariables Module Provided Variables + * \section SSec_BuildModule_CORE_ProvidedVariables Module Provided Variables * * * @@ -318,7 +343,7 @@ * *
* - * \section SSec_BuildModule_ATPROGRAM_ProvideVariables Module Provided Variables + * \section SSec_BuildModule_ATPROGRAM_ProvidedVariables Module Provided Variables * * * @@ -394,7 +419,7 @@ * *
* - * \section SSec_BuildModule_AVRDUDE_ProvideVariables Module Provided Variables + * \section SSec_BuildModule_AVRDUDE_ProvidedVariables Module Provided Variables * * * @@ -486,7 +511,7 @@ * *
* - * \section SSec_BuildModule_CPPCHECK_ProvideVariables Module Provided Variables + * \section SSec_BuildModule_CPPCHECK_ProvidedVariables Module Provided Variables * * * @@ -507,7 +532,8 @@ * * The DFU programming utility LUFA build system module, providing targets to reprogram an * Atmel processor FLASH and EEPROM memories with a project's compiled binary output files. - * This module requires a DFU class bootloader to be running in the target. + * This module requires a DFU class bootloader to be running in the target, compatible with + * the DFU bootloader protocol as published by Atmel. * * To use this module in your application makefile, add the following code: * \code @@ -562,7 +588,7 @@ * *
* - * \section SSec_BuildModule_DFU_ProvideVariables Module Provided Variables + * \section SSec_BuildModule_DFU_ProvidedVariables Module Provided Variables * * * @@ -631,7 +657,7 @@ * *
* - * \section SSec_BuildModule_DOXYGEN_ProvideVariables Module Provided Variables + * \section SSec_BuildModule_DOXYGEN_ProvidedVariables Module Provided Variables * * * @@ -648,6 +674,87 @@ *
*/ + /** \page Page_BuildModule_HID The HID build module + * + * The HID programming utility LUFA build system module, providing targets to reprogram an + * Atmel processor's FLASH memory with a project's compiled binary output file. This module + * requires a HID class bootloader to be running in the target, using a protocol compatible + * with the PJRC "HalfKay" protocol (http://www.pjrc.com/teensy/halfkay_protocol.html). + * + * To use this module in your application makefile, add the following code: + * \code + * include $(LUFA_PATH)/Build/lufa.hid.in + * \endcode + * + * \section SSec_BuildModule_HID_Requirements Requirements + * This module requires either the hid_bootloader_cli utility from the included LUFA HID + * class bootloader API subdirectory, or the teensy_loader_cli utility from PJRC + * (http://www.pjrc.com/teensy/loader_cli.html) to be available in your system's PATH + * variable. + * + * \section SSec_BuildModule_HID_Targets Targets + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
hidProgram the device FLASH memory with the application's executable data using hid_bootloader_cli.
hid-eeProgram the device EEPROM memory with the application's EEPROM data using hid_bootloader_cli and + * a temporary AVR application programmed into the target's FLASH. + * \note This will erase the currently loaded application in the target.
hid-teensyProgram the device FLASH memory with the application's executable data using teensy_loader_cli.
hid-teensy-eeProgram the device EEPROM memory with the application's EEPROM data using teensy_loader_cli and + * a temporary AVR application programmed into the target's FLASH. + * \note This will erase the currently loaded application in the target.
+ * + * \section SSec_BuildModule_HID_MandatoryParams Mandatory Parameters + * + * + * + * + * + * + * + * + * + * + *
MCUName of the Atmel processor model (e.g. at90usb1287).
TARGETName of the application output file prefix (e.g. TestApplication).
+ * + * \section SSec_BuildModule_HID_OptionalParams Optional Parameters + * + * + * + * + * + *
None
+ * + * \section SSec_BuildModule_HID_ProvidedVariables Module Provided Variables + * + * + * + * + * + *
None
+ * + * \section SSec_BuildModule_HID_ProvidedMacros Module Provided Macros + * + * + * + * + * + *
None
+ */ + /** \page Page_BuildModule_SOURCES The SOURCES build module * * The SOURCES LUFA build system module, providing variables listing the various LUFA source files @@ -692,7 +799,7 @@ * * * - * \section SSec_BuildModule_SOURCES_ProvideVariables Module Provided Variables + * \section SSec_BuildModule_SOURCES_ProvidedVariables Module Provided Variables * * *