Add HID bootloader build module (thanks to Stefan Hellermann).

[pub/lufa.git] / LUFA / DoxygenPages / BuildSystem.txt

diff --git a/LUFA/DoxygenPages/BuildSystem.txt b/LUFA/DoxygenPages/BuildSystem.txt
index 61087a5..0d7d6be 100644 (file)
--- a/LUFA/DoxygenPages/BuildSystem.txt
+++ b/LUFA/DoxygenPages/BuildSystem.txt
@@ -38,6 +38,7 @@
  *  \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_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
  *  \li \subpage Page_BuildModule_SOURCES - LUFA Module Source Code Variables\r
  */\r
  \r


@@ -512,11 +513,12 @@
  *\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
  *\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
  *\r
  *  To use this module in your application makefile, add the following code:\r
  *  \code\r

- *  include $(LUFA_PATH)/Build/lufa.dfu.in\r
+ *  include $(LUFA_PATH)/Build/lufa.dfu.in

  *  \endcode\r
  *\r
  *  \section SSec_BuildModule_DFU_Requirements Requirements\r
  *  \endcode\r
  *\r
  *  \section SSec_BuildModule_DFU_Requirements Requirements\r


@@ -653,6 +655,75 @@
  *  </table>\r
  */\r
  \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 EEPROM 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
  /** \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