Add Doxygen documentation to the completed portions of the PDI programming protocol...

[pub/lufa.git] / Projects / AVRISP / AVRISP.txt

diff --git a/Projects/AVRISP/AVRISP.txt b/Projects/AVRISP/AVRISP.txt
index 6eeef38..2de8dd2 100644 (file)
--- a/Projects/AVRISP/AVRISP.txt
+++ b/Projects/AVRISP/AVRISP.txt
@@ -13,7 +13,7 @@
  *  - Series 7 USB AVRs\r
  *  - Series 6 USB AVRs\r
  *  - Series 4 USB AVRs\r
  *  - Series 7 USB AVRs\r
  *  - Series 6 USB AVRs\r
  *  - Series 4 USB AVRs\r

- *  - Series 2 USB AVRs\r
+ *  - Series 2 USB AVRs (8KB versions with reduced features only)\r

  *\r
  *  \section SSec_Info USB Information:\r
  *\r
  *\r
  *  \section SSec_Info USB Information:\r
  *\r


@@ -51,7 +51,7 @@
  *  level conversion can be made to allow for the programming of 3.3V AVR designs.\r
  *\r
  *  This device spoofs Atmel's official AVRISP-MKII device PID so that it remains compatible with Atmel's AVRISP-MKII\r
  *  level conversion can be made to allow for the programming of 3.3V AVR designs.\r
  *\r
  *  This device spoofs Atmel's official AVRISP-MKII device PID so that it remains compatible with Atmel's AVRISP-MKII\r

- *  drivers. When promted, direct your OS to install Atmel's AVRISP-MKII drivers provided with AVRStudio.\r
+ *  drivers. When prompted, direct your OS to install Atmel's AVRISP-MKII drivers provided with AVRStudio.\r

  *\r
  *  Note that this design currently has several limitations:\r
  *    - Minimum ISP target clock speed of 500KHz due to hardware SPI used\r
  *\r
  *  Note that this design currently has several limitations:\r
  *    - Minimum ISP target clock speed of 500KHz due to hardware SPI used\r


@@ -62,7 +62,10 @@
  *  without an ADC converter, VTARGET will report at a fixed 5V level.\r
  *\r
  *  When compiled for the XPLAIN board target, this will automatically configure itself for the correct connections to the\r
  *  without an ADC converter, VTARGET will report at a fixed 5V level.\r
  *\r
  *  When compiled for the XPLAIN board target, this will automatically configure itself for the correct connections to the\r

- *  XPLAIN's XMEGA AVR, and will enable only PDI programming support.\r
+ *  XPLAIN's XMEGA AVR, and will enable PDI only programming support (since ISP mode is not needed).\r
+ *\r
+ *  While this application can be compiled for USB AVRs with as little as 8KB of FLASH, for full functionality 16KB or more\r
+ *  of FLASH is required. On 8KB devices, either ISP or PDI programming support can be disabled to reduce program size.\r

  *\r
  *\r
  *  Connections to the device for SPI programming (when enabled):\r
  *\r
  *\r
  *  Connections to the device for SPI programming (when enabled):\r


@@ -203,8 +206,10 @@
  *   <tr>\r
  *    <td>PDI_VIA_HARDWARE_USART</td>\r
  *    <td>Makefile CDEFS</td>\r
  *   <tr>\r
  *    <td>PDI_VIA_HARDWARE_USART</td>\r
  *    <td>Makefile CDEFS</td>\r

- *    <td>Define to force the PDI protocol (when enabled) to use the hardware USART instead of bit-banging to match the official\r
- *        AVRISP pinout. <i>Automatically set when compiled for the XPLAIN board.</i></td>  \r
+ *    <td>Define to force the PDI protocol (when enabled) to use the much faster hardware USART instead of bit-banging to\r
+ *        match the official AVRISP pinout. This breaks pinout compatibility with the official AVRISP MKII (and requires \r
+ *        seperate ISP and PDI programming headers) but increases programming speed dramatically.\r
+ *        <i>Ignored when compiled for the XPLAIN board.</i></td>  \r

  *   </tr>\r
  *  </table>\r
  */\r
  *   </tr>\r
  *  </table>\r
  */\r