Split out the RFCOMM Control Channel command processing code into a seperate set...

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

diff --git a/Projects/AVRISP-MKII/AVRISP.txt b/Projects/AVRISP-MKII/AVRISP.txt
index 38248a2..de08d5f 100644 (file)
--- a/Projects/AVRISP-MKII/AVRISP.txt
+++ b/Projects/AVRISP-MKII/AVRISP.txt
@@ -57,6 +57,7 @@
  *    - Minimum ISP target clock speed of 500KHz due to hardware SPI module prescaler limitations
  *    - No reversed/shorted target connector detection and notification
  *    - A seperate header is required for each of the ISP, PDI and TPI programming protocols that the user wishes to use
  *    - Minimum ISP target clock speed of 500KHz due to hardware SPI module prescaler limitations
  *    - No reversed/shorted target connector detection and notification
  *    - A seperate header is required for each of the ISP, PDI and TPI programming protocols that the user wishes to use

+ *    - XMEGA EEPROM erase section command does not work (but EEPROM read/write and chip erase does)

  *
  *  On AVR models with an ADC converter, AVCC should be tied to 5V (e.g. VBUS) and the VTARGET_ADC_CHANNEL token should be
  *  set to an appropriate ADC channel number in the project makefile for VTARGET detection to operate correctly. On models
  *
  *  On AVR models with an ADC converter, AVCC should be tied to 5V (e.g. VBUS) and the VTARGET_ADC_CHANNEL token should be
  *  set to an appropriate ADC channel number in the project makefile for VTARGET detection to operate correctly. On models


@@ -114,7 +115,7 @@
  *  <b><sup>2</sup></b> <i>See AUX line related tokens in the \ref SSec_Options section</i>
  *
  *  \section Sec_PDI PDI Connections
  *  <b><sup>2</sup></b> <i>See AUX line related tokens in the \ref SSec_Options section</i>
  *
  *  \section Sec_PDI PDI Connections

- *  Connections to the device for PDI programming<b><sup>1</sup></b> (when enabled):
+ *  Connections to the device for PDI programming (when enabled):

  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>


@@ -143,7 +144,7 @@
  *    <td>4</td>
  *   </tr>
  *   <tr>
  *    <td>4</td>
  *   </tr>
  *   <tr>

- *    <td>XCLK</td>
+ *    <td>XCK</td>

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


@@ -158,7 +159,7 @@
  *  <b><sup>2</sup></b> <i>The AVR's Tx and Rx become the DATA line when connected together via a pair of 220 ohm resistors</i> \n
  *
  *  \section Sec_TPI TPI Connections
  *  <b><sup>2</sup></b> <i>The AVR's Tx and Rx become the DATA line when connected together via a pair of 220 ohm resistors</i> \n
  *
  *  \section Sec_TPI TPI Connections

- *  Connections to the device for TPI programming<b><sup>1</sup></b> (when enabled):
+ *  Connections to the device for TPI programming (when enabled):

  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>


@@ -177,7 +178,7 @@
  *    <td>2</td>
  *   </tr>
  *   <tr>
  *    <td>2</td>
  *   </tr>
  *   <tr>

- *    <td>XCLK <b><sup>2</sup></b></td>
+ *    <td>XCK <b><sup>2</sup></b></td>

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


@@ -240,7 +241,8 @@
  *   <tr>
  *    <td>VTARGET_ADC_CHANNEL</td>
  *    <td>Makefile CDEFS</td>
  *   <tr>
  *    <td>VTARGET_ADC_CHANNEL</td>
  *    <td>Makefile CDEFS</td>

- *    <td>ADC channel number (on supported AVRs) to use for VTARGET level detection, if NO_VTARGET_DETECT is not defined.</td> 
+ *    <td>ADC channel number (on supported AVRs) to use for VTARGET level detection, if NO_VTARGET_DETECT is not defined.
+ *        <i>Ignored when compiled for targets lacking an ADC.</i></td> 

  *   </tr>
  *   <tr>
  *    <td>ENABLE_ISP_PROTOCOL</td>
  *   </tr>
  *   <tr>
  *    <td>ENABLE_ISP_PROTOCOL</td>


@@ -256,9 +258,25 @@
  *    <td>NO_VTARGET_DETECT</td>
  *    <td>Makefile CDEFS</td>
  *    <td>Define to disable VTARGET sampling and reporting on AVR models with an ADC converter. This will cause the programmer
  *    <td>NO_VTARGET_DETECT</td>
  *    <td>Makefile CDEFS</td>
  *    <td>Define to disable VTARGET sampling and reporting on AVR models with an ADC converter. This will cause the programmer

- *        to report a fixed 5V target voltage to the host regardless of the real target voltage.</td>  
+ *        to report a fixed 5V target voltage to the host regardless of the real target voltage. <i>Ignored when compiled for
+ *        targets lacking an ADC.</i></td>  

  *   </tr>
  *   <tr>
  *   </tr>
  *   <tr>

+ *    <td>VTARGET_REF_VOLTS</td>
+ *    <td>Makefile CDEFS</td>
+ *    <td>Indicates the programmer AVR's AVCC reference voltage when measuring the target's supply voltage. Note that the supply
+ *        voltage should never exceed the reference voltage on the programmer AVR without some form of protection to prevent damage
+ *        to the ADC. <i>Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined.</i></td>  
+ *   </tr>
+ *   <tr>
+ *    <td>VTARGET_SCALE_FACTOR</td>
+ *    <td>Makefile CDEFS</td>
+ *    <td>Indicates the target's supply voltage scale factor when applied to the ADC. A simple resistive divider can be used on the
+ *        ADC pin for measuring the target's supply voltage, so that voltages above the programmer AVR's AVCC reference voltage can be
+ *        measured. This should be the reciprocal of the division performed - e.g. if the VTARGET voltage is halved, this should be set
+ *        to 2. <i>Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined.</i></td>  
+ *   </tr> 
+ *   <tr>

  *    <td>LIBUSB_DRIVER_COMPAT</td>
  *    <td>Makefile CDEFS</td>
  *    <td>Define to switch to a non-standard endpoint scheme, breaking compatibility with AVRStudio under Windows but making
  *    <td>LIBUSB_DRIVER_COMPAT</td>
  *    <td>Makefile CDEFS</td>
  *    <td>Define to switch to a non-standard endpoint scheme, breaking compatibility with AVRStudio under Windows but making