Fixed incorrect definition of HID_ALIGN_DATA() causing incorrect HID report item...

[pub/USBasp.git] / Projects / AVRISP-MKII / AVRISP.txt

diff --git a/Projects/AVRISP-MKII/AVRISP.txt b/Projects/AVRISP-MKII/AVRISP.txt
index 9bed59e..feccfca 100644 (file)
--- a/Projects/AVRISP-MKII/AVRISP.txt
+++ b/Projects/AVRISP-MKII/AVRISP.txt
@@ -53,7 +53,7 @@
  *  This device spoofs Atmel's official AVRISP-MKII device PID so that it remains compatible with Atmel's AVRISP-MKII\r
  *  drivers. When prompted, direct your OS to install Atmel's AVRISP-MKII drivers provided with AVRStudio.\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 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
+ *  Note that this design currently has the following limitations:\r

  *    - Minimum ISP target clock speed of 500KHz due to hardware SPI module prescaler limitations\r
  *    - No reversed/shorted target connector detection and notification\r
  *\r
  *    - Minimum ISP target clock speed of 500KHz due to hardware SPI module prescaler limitations\r
  *    - No reversed/shorted target connector detection and notification\r
  *\r


@@ -62,7 +62,9 @@
  *  without an ADC converter, VTARGET will report a fixed 5V level at all times.\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 a fixed 5V level at all times.\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 PDI/TPI only programming support (since ISP mode is not needed).\r
+ *  XPLAIN's XMEGA AVR, and will enable PDI/TPI only programming support (since ISP mode is not needed). Note that the\r
+ *  first revision XPLAIN board lacks a bootloader on the AT90USB1287, and thus for this firmware to be loaded, an external\r
+ *  programmer will be required.\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, ISP or PDI/TPI programming support can be disabled to reduce program size.\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, ISP or PDI/TPI programming support can be disabled to reduce program size.\r


@@ -108,6 +110,10 @@
  *   </tr>\r
  *  </table>\r
  *\r
  *   </tr>\r
  *  </table>\r
  *\r

+ *  In addition, the AVR's XCK pin will generate a .5MHz clock when SPI programming is used, to act as an external\r
+ *  device clock if the fuses have been mis-set. To use the recovery clock, connect XCK to the target AVR's XTAL1\r
+ *  pin, and set the ISP programming speed to 125KHz or below.\r
+ *\r

  *  <b><sup>1</sup></b> <i>Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only</i> \n\r
  *  <b><sup>2</sup></b> <i>See AUX line related tokens in the \ref SSec_Options section</i>\r
  *\r
  *  <b><sup>1</sup></b> <i>Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only</i> \n\r
  *  <b><sup>2</sup></b> <i>See AUX line related tokens in the \ref SSec_Options section</i>\r
  *\r


@@ -121,7 +127,7 @@
  *    <td><b>PDI 6 Pin Layout:</b></td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td><b>PDI 6 Pin Layout:</b></td>\r
  *   </tr>\r
  *   <tr>\r

- *    <td>MISO</td>\r
+ *    <td>MISO <b><sup>2</sup></b></td>\r

  *    <td>DATA</td>\r
  *    <td>1</td>\r
  *   </tr>\r
  *    <td>DATA</td>\r
  *    <td>1</td>\r
  *   </tr>\r


@@ -141,7 +147,7 @@
  *    <td>4</td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td>4</td>\r
  *   </tr>\r
  *   <tr>\r

- *    <td>PORTx.y <b><sup>2</sup></b></td>\r
+ *    <td>PORTx.y <b><sup>2, 3</sup></b></td>\r

  *    <td>CLOCK</td>\r
  *    <td>5</td>\r
  *   </tr>\r
  *    <td>CLOCK</td>\r
  *    <td>5</td>\r
  *   </tr>\r


@@ -152,9 +158,10 @@
  *   </tr>\r
  *  </table>\r
  *\r
  *   </tr>\r
  *  </table>\r
  *\r

- *  <b><sup>1</sup></b> <i>When XPROG_VIA_HARDWARE_USART is set, the AVR's Tx and Rx become the DATA line when connected together\r
- *                         via a pair of 300 ohm resistors, and the AVR's XCK pin becomes CLOCK.</i> \n\r
- *  <b><sup>2</sup></b> <i>See AUX line related tokens in the \ref SSec_Options section</i>\r
+ *  <b><sup>1</sup></b> <i>Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only</i> \n\r
+ *  <b><sup>2</sup></b> <i>When XPROG_VIA_HARDWARE_USART is set, the AVR's Tx and Rx become the DATA line when connected together\r
+ *                         via a pair of 220 ohm resistors, and the AVR's XCK pin becomes CLOCK.</i> \n\r
+ *  <b><sup>3</sup></b> <i>See AUX line related tokens in the \ref SSec_Options section</i>\r

  *\r
  *  \section Sec_TPI TPI Connections\r
  *  Connections to the device for TPI programming<b><sup>1</sup></b> (when enabled):\r
  *\r
  *  \section Sec_TPI TPI Connections\r
  *  Connections to the device for TPI programming<b><sup>1</sup></b> (when enabled):\r


@@ -166,7 +173,7 @@
  *    <td><b>TPI 6 Pin Layout:</b></td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td><b>TPI 6 Pin Layout:</b></td>\r
  *   </tr>\r
  *   <tr>\r

- *    <td>MISO</td>\r
+ *    <td>MISO <b><sup>2</sup></b></td>\r

  *    <td>DATA</td>\r
  *    <td>1</td>\r
  *   </tr>\r
  *    <td>DATA</td>\r
  *    <td>1</td>\r
  *   </tr>\r


@@ -176,7 +183,7 @@
  *    <td>2</td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td>2</td>\r
  *   </tr>\r
  *   <tr>\r

- *    <td>SCLK</td>\r
+ *    <td>SCLK <b><sup>2</sup></b></td>\r

  *    <td>CLOCK</td>\r
  *    <td>3</td>\r
  *   </tr>\r
  *    <td>CLOCK</td>\r
  *    <td>3</td>\r
  *   </tr>\r


@@ -186,7 +193,7 @@
  *    <td>4</td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td>4</td>\r
  *   </tr>\r
  *   <tr>\r

- *    <td>PORTx.y <b><sup>2</sup></b></td>\r
+ *    <td>PORTx.y <b><sup>3</sup></b></td>\r

  *    <td>/RESET</td>\r
  *    <td>5</td>\r
  *   </tr>\r
  *    <td>/RESET</td>\r
  *    <td>5</td>\r
  *   </tr>\r


@@ -197,9 +204,10 @@
  *   </tr>\r
  *  </table>\r
  *\r
  *   </tr>\r
  *  </table>\r
  *\r

- *  <b><sup>1</sup></b> <i>When XPROG_VIA_HARDWARE_USART is set, the AVR's Tx and Rx become the DATA line when connected together\r
- *                         via a pair of 300 ohm resistors, and the AVR's XCK pin becomes CLOCK.</i> \n\r
- *  <b><sup>2</sup></b> <i>See AUX line related tokens in the \ref SSec_Options section</i>\r
+ *  <b><sup>1</sup></b> <i>Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only</i> \n\r
+ *  <b><sup>2</sup></b> <i>When XPROG_VIA_HARDWARE_USART is set, the AVR's Tx and Rx become the DATA line when connected together\r
+ *                         via a pair of 220 ohm resistors, and the AVR's XCK pin becomes CLOCK.</i> \n\r
+ *  <b><sup>3</sup></b> <i>See AUX line related tokens in the \ref SSec_Options section</i>\r

  *\r
  *  \section SSec_Options Project Options\r
  *\r
  *\r
  *  \section SSec_Options Project Options\r
  *\r


@@ -239,7 +247,7 @@
  *   <tr>\r
  *    <td>VTARGET_ADC_CHANNEL</td>\r
  *    <td>Makefile CDEFS</td>\r
  *   <tr>\r
  *    <td>VTARGET_ADC_CHANNEL</td>\r
  *    <td>Makefile CDEFS</td>\r

- *    <td>ADC channel number (on supported AVRs) to use for VTARGET level detection.</td> \r
+ *    <td>ADC channel number (on supported AVRs) to use for VTARGET level detection, if NO_VTARGET_DETECT is not defined.</td> \r

  *   </tr>\r
  *   <tr>\r
  *    <td>ENABLE_ISP_PROTOCOL</td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td>ENABLE_ISP_PROTOCOL</td>\r


@@ -259,5 +267,11 @@
  *        seperate ISP, PDI, and TPI programming headers) but increases programming speed dramatically.\r
  *        <i>Ignored when compiled for the XPLAIN board.</i></td>  \r
  *   </tr>\r
  *        seperate ISP, PDI, and TPI programming headers) but increases programming speed dramatically.\r
  *        <i>Ignored when compiled for the XPLAIN board.</i></td>  \r
  *   </tr>\r

+ *   <tr>\r
+ *    <td>NO_VTARGET_DETECT</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>Define to disable VTARGET sampling and reporting on AVR models with an ADC converter. This will cause the programmer\r
+ *        to report a fixed 5V target voltage to the host regardless of the real target voltage.</td>  \r
+ *   </tr>\r

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