* application makefile. The system is written in GNU Make, and each module is independant of\r
* one-another.\r
*\r
+ * For details on the prerequisites needed for Linux and Windows machines to be able to use the LUFA\r
+ * build system, see \ref Sec_Prerequisites.\r
+ *\r
* To use a LUFA build system module, simply add an include to your project makefile:\r
* \code\r
* include $(LUFA_PATH)/Build/lufa.core.in\r
* \li \subpage Page_BuildModule_CPPCHECK - Static Code Analysis\r
* \li \subpage Page_BuildModule_DFU - Device Programming\r
* \li \subpage Page_BuildModule_DOXYGEN - Automated Source Code Documentation\r
+ * \li \subpage Page_BuildModule_HID - Device Programming\r
* \li \subpage Page_BuildModule_SOURCES - LUFA Module Source Code Variables\r
*/\r
\r
* <td>Display a size-sorted list of symbols from the compiled application, in decimal bytes.</td>\r
* </tr>\r
* <tr>\r
+ * <td><tt>check-source</tt></td>\r
+ * <td>Display a list of input SRC source files which cannot be found (if any).</td>\r
+ * </tr>\r
+ * <tr>\r
+ * <td><tt>lib</tt></td>\r
+ * <td>Build and archive all source files into a library A binary file.</td>\r
+ * </tr>\r
+ * <tr>\r
* <td><tt>all</tt></td>\r
* <td>Build and link the application into ELF debug and HEX binary files.</td>\r
* </tr>\r
* <td><tt>clean</tt></td>\r
* <td>Remove all intermediatary files and binary output files.</td>\r
* </tr>\r
+ * <tr>\r
+ * <td><tt>mostlyclean</tt></td>\r
+ * <td>Remove all intermediatary files but preserve any binary output files.</td>\r
+ * </tr>\r
* </table>\r
*\r
* \section SSec_BuildModule_BUILD_MandatoryParams Mandatory Parameters\r
* <td><tt>LD_FLAGS</tt></td>\r
* <td>Flags to pass to the linker, after the automatically generated flags.</td>\r
* </tr>\r
+ * <tr>\r
+ * <td><tt>OBJDIR</tt></td>\r
+ * <td>Directory to place the generated object and dependency files. If set to "." the same folder as the source file will be used.\r
+ * \note When this option is enabled, all source filenames must be unique.</td>\r
+ * </tr>\r
* </table>\r
*\r
* \section SSec_BuildModule_BUILD_ProvideVariables Module Provided Variables\r
*\r
* The DFU programming utility LUFA build system module, providing targets to reprogram an\r
* Atmel processor FLASH and EEPROM memories with a project's compiled binary output files.\r
- * This module requires a DFU class bootloader to be running in the target.\r
+ * This module requires a DFU class bootloader to be running in the target, compatible with\r
+ * the DFU bootloader protocol as published by Atmel.\r
*\r
* To use this module in your application makefile, add the following code:\r
* \code\r
* </table>\r
*/\r
\r
+ /** \page Page_BuildModule_HID The HID build module\r
+ *\r
+ * The HID programming utility LUFA build system module, providing targets to reprogram an\r
+ * Atmel processor's FLASH memory with a project's compiled binary output file. This module\r
+ * requires a HID class bootloader to be running in the target, using a protocol compatible\r
+ * with the PJRC "HalfKay" protocol (<a>http://www.pjrc.com/teensy/halfkay_protocol.html</a>).\r
+ *\r
+ * To use this module in your application makefile, add the following code:\r
+ * \code\r
+ * include $(LUFA_PATH)/Build/lufa.hid.in\r
+ * \endcode\r
+ *\r
+ * \section SSec_BuildModule_HID_Requirements Requirements\r
+ * This module requires either the <tt>hid_bootloader_cli</tt> utility from the included LUFA HID\r
+ * class bootloader API subdirectory, or the <tt>teensy_loader_cli</tt> utility from PJRC\r
+ * (<a>http://www.pjrc.com/teensy/loader_cli.html</a>) to be available in your system's <b>PATH</b>\r
+ * variable.\r
+ *\r
+ * \section SSec_BuildModule_HID_Targets Targets\r
+ *\r
+ * <table>\r
+ * <tr>\r
+ * <td><tt>hid</tt></td>\r
+ * <td>Program the device FLASH memory with the application's executable data using <tt>hid_bootloader_cli</tt>.</td>\r
+ * </tr>\r
+ * <tr>\r
+ * <td><tt>hid-teensy</tt></td>\r
+ * <td>Program the device FLASH memory with the application's executable data using <tt>teensy_loader_cli</tt>.</td>\r
+ * </tr>\r
+ * </table>\r
+ *\r
+ * \section SSec_BuildModule_HID_MandatoryParams Mandatory Parameters\r
+ *\r
+ * <table>\r
+ * <tr>\r
+ * <td><tt>MCU</tt></td>\r
+ * <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>\r
+ * </tr>\r
+ * <tr>\r
+ * <td><tt>TARGET</tt></td>\r
+ * <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>\r
+ * </tr>\r
+ * </table>\r
+ *\r
+ * \section SSec_BuildModule_HID_OptionalParams Optional Parameters\r
+ *\r
+ * <table>\r
+ * <tr>\r
+ * <td><i>None</i></td>\r
+ * </tr>\r
+ * </table>\r
+ *\r
+ * \section SSec_BuildModule_HID_ProvideVariables Module Provided Variables\r
+ *\r
+ * <table>\r
+ * <tr>\r
+ * <td><i>None</i></td>\r
+ * </tr>\r
+ * </table> \r
+ *\r
+ * \section SSec_BuildModule_HID_ProvidedMacros Module Provided Macros\r
+ *\r
+ * <table>\r
+ * <tr>\r
+ * <td><i>None</i></td>\r
+ * </tr>\r
+ * </table>\r
+ */\r
+ \r
/** \page Page_BuildModule_SOURCES The SOURCES build module\r
*\r
* The SOURCES LUFA build system module, providing variables listing the various LUFA source files\r
projects / pub / USBasp.git / blobdiff