Fix invalid Event name rule in demo/project makefiles.

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

diff --git a/Projects/AVRISP/AVRISP.txt b/Projects/AVRISP/AVRISP.txt
index 9e5a455..2499763 100644 (file)
--- a/Projects/AVRISP/AVRISP.txt
+++ b/Projects/AVRISP/AVRISP.txt
@@ -8,17 +8,12 @@
  *\r
  *  \section SSec_Compat Demo Compatibility:\r
  *\r
- *  The following table indicates what microcontrollers are compatible with this demo.\r
- *\r
- *  - AT90USB1287\r
- *  - AT90USB1286\r
- *  - AT90USB647\r
- *  - AT90USB646\r
- *  - ATMEGA32U6\r
- *  - ATMEGA32U4\r
- *  - ATMEGA16U4\r
- *  - AT90USB162\r
- *  - AT90USB82\r
+ *  The following list indicates what microcontrollers are compatible with this demo.\r
+ *\r
+ *  - Series 7 USB AVRs\r
+ *  - Series 6 USB AVRs\r
+ *  - Series 4 USB AVRs\r
+ *  - Series 2 USB AVRs\r
  *\r
  *  \section SSec_Info USB Information:\r
  *\r
@@ -50,20 +45,96 @@
  *  \section SSec_Description Project Description: \r
  *\r
  *  Firmware for an AVRStudio compatible AVRISP-MKII clone programmer. This project will enable the USB AVR series of\r
- *  microcontrollers to act as a clone of the official Atmel AVRISP-MKII programmer, usable within AVRStudio.\r
+ *  microcontrollers to act as a clone of the official Atmel AVRISP-MKII programmer, usable within AVRStudio. In its\r
+ *  most basic form, it allows for the programming of 5V AVRs from within AVRStudio with no special hardware other than\r
+ *  the USB AVR and the parts needed for the USB interface. If the user desires, more advanced circuits incorporating\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
  *\r
+ *  Note that this design currently has several limitations:\r
+ *    - Minimum target clock speed of 500KHz due to hardware SPI used\r
+ *    - No reversed/shorted target connector detection and notification\r
+ *\r
+ *  On AVR models with an ADC converter, ACC should be tied to 5V (e.g. VBUS) and the VTARGET_ADC_CHANNEL token should be\r
+ *  set to an appropriate ADC channel number in the project makefile for VTARGET detection to operate correctly. On models\r
+ *  without an ADC converter, VTARGET will report at a fixed 5V level.\r
+ *\r
+ *  Connections to the device are simple:\r
+ *\r
+ *  <table>\r
+ *   <tr>\r
+ *    <td><b>Programmer Pin:</b></td>\r
+ *    <td><b>Target Device Pin:</b></td>\r
+ *    <td><b>ISP 6 Pin Layout:</b></td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>MISO</td>\r
+ *    <td>PDO</td>\r
+ *    <td>1</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>ADCx <b><sup>1</sup></b></td>\r
+ *    <td>VTARGET</td>\r
+ *    <td>2</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>SCLK</td>\r
+ *    <td>SCLK</td>\r
+ *    <td>3</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>MOSI</td>\r
+ *    <td>PDI</td>\r
+ *    <td>4</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>PORTx.y <b><sup>2</sup></b></td>\r
+ *    <td>/RESET</td>\r
+ *    <td>5</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>GND</td>\r
+ *    <td>GND</td>\r
+ *    <td>6</td>\r
+ *   </tr>\r
+ *  </table>\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 \ref SSec_Options section</i>\r
+ *\r
  *  \section SSec_Options Project Options\r
  *\r
  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.\r
  *\r
  *  <table>\r
  *   <tr>\r
- *    <td>\r
- *     None\r
- *    </td>\r
+ *    <td><b>Define Name:</b></td>\r
+ *    <td><b>Location:</b></td>\r
+ *    <td><b>Description:</b></td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>RESET_LINE_PORT</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>PORT register for the programmer's target RESET line.</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>RESET_LINE_DDR</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>DDR register for the programmer's target RESET line.</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>RESET_LINE_MASK</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>Mask for the programmer's target RESET line on the chosen port. <b>Must not be the AVR's /SS pin</b>, as the\r
+ *        target pins are tri-stated when not in use, and low signals on the /SS pin will force SPI slave mode when the\r
+ *        pin is configured as an input.</td>\r
+ *   </tr>\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
  *   </tr>\r
  *  </table>\r
  */\r