X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/44ff0af68cbb67b060f89c3d7142af4f02b28f2f..6f90d45684206e5dfca3c4554a14a5784da49d92:/LUFA/DoxygenPages/BuildSystem.txt

diff --git a/LUFA/DoxygenPages/BuildSystem.txt b/LUFA/DoxygenPages/BuildSystem.txt
index fe29aeb00..1b26381bc 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 @@
  *    <td>Display a size-sorted list of symbols from the compiled application, in decimal bytes.</td>
  *   </tr>
  *   <tr>
+ *    <td><tt>check-source</tt></td>
+ *    <td>Display a list of input SRC source files which cannot be found (if any).</td>
+ *   </tr>
+ *   <tr>
+ *    <td><tt>lib</tt></td>
+ *    <td>Build and archive all source files into a library A binary file.</td>
+ *   </tr>
+ *   <tr>
  *    <td><tt>all</tt></td>
  *    <td>Build and link the application into ELF debug and HEX binary files.</td>
  *   </tr>
@@ -88,6 +100,10 @@
  *    <td><tt>clean</tt></td>
  *    <td>Remove all intermediatary files and binary output files.</td>
  *   </tr>
+ *   <tr>
+ *    <td><tt>mostlyclean</tt></td>
+ *    <td>Remove all intermediatary files but preserve any binary output files.</td>
+ *   </tr>
  *  </table>
  *
  *  \section SSec_BuildModule_BUILD_MandatoryParams Mandatory Parameters
@@ -162,6 +178,11 @@
  *    <td><tt>LD_FLAGS</tt></td>
  *    <td>Flags to pass to the linker, after the automatically generated flags.</td>
  *   </tr>
+ *   <tr>
+ *    <td><tt>OBJDIR</tt></td>
+ *    <td>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.</td>
+ *   </tr>
  *  </table>
  *
  *  \section SSec_BuildModule_BUILD_ProvideVariables Module Provided Variables
@@ -507,7 +528,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
@@ -648,6 +670,75 @@
  *  </table>
  */
  
+ /** \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 (<a>http://www.pjrc.com/teensy/halfkay_protocol.html</a>).
+ *
+ *  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 <tt>hid_bootloader_cli</tt> utility from the included LUFA HID
+ *  class bootloader API subdirectory, or the <tt>teensy_loader_cli</tt> utility from PJRC
+ *  (<a>http://www.pjrc.com/teensy/loader_cli.html</a>) to be available in your system's <b>PATH</b>
+ *  variable.
+ *
+ *  \section SSec_BuildModule_HID_Targets Targets
+ *
+ *  <table>
+ *   <tr>
+ *    <td><tt>hid</tt></td>
+ *    <td>Program the device FLASH memory with the application's executable data using <tt>hid_bootloader_cli</tt>.</td>
+ *   </tr>
+ *   <tr>
+ *    <td><tt>hid-teensy</tt></td>
+ *    <td>Program the device FLASH memory with the application's executable data using <tt>teensy_loader_cli</tt>.</td>
+ *   </tr>
+ *  </table>
+ *
+ *  \section SSec_BuildModule_HID_MandatoryParams Mandatory Parameters
+ *
+ *  <table>
+ *   <tr>
+ *    <td><tt>MCU</tt></td>
+ *    <td>Name of the Atmel processor model (e.g. <tt>at90usb1287</tt>).</td>
+ *   </tr>
+ *   <tr>
+ *    <td><tt>TARGET</tt></td>
+ *    <td>Name of the application output file prefix (e.g. <tt>TestApplication</tt>).</td>
+ *   </tr>
+ *  </table>
+ *
+ *  \section SSec_BuildModule_HID_OptionalParams Optional Parameters
+ *
+ *  <table>
+ *   <tr>
+ *    <td><i>None</i></td>
+ *   </tr>
+ *  </table>
+ *
+ *  \section SSec_BuildModule_HID_ProvideVariables Module Provided Variables
+ *
+ *  <table>
+ *   <tr>
+ *    <td><i>None</i></td>
+ *   </tr>
+ *  </table> 
+ *
+ *  \section SSec_BuildModule_HID_ProvidedMacros Module Provided Macros
+ *
+ *  <table>
+ *   <tr>
+ *    <td><i>None</i></td>
+ *   </tr>
+ *  </table>
+ */
+ 
  /** \page Page_BuildModule_SOURCES The SOURCES build module
  *
  *  The SOURCES LUFA build system module, providing variables listing the various LUFA source files