Move RNDISConstants.h into the RNDIS class driver common definition header.

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

diff --git a/Projects/AVRISP-MKII/AVRISP-MKII.txt b/Projects/AVRISP-MKII/AVRISP-MKII.txt
index c4ba43c..e36ffe2 100644 (file)
--- a/Projects/AVRISP-MKII/AVRISP-MKII.txt
+++ b/Projects/AVRISP-MKII/AVRISP-MKII.txt
@@ -3,17 +3,17 @@
  *  This file contains special DoxyGen information for the generation of the main page and other special
  *  documentation pages. It is not a project source file.
  */
  *  This file contains special DoxyGen information for the generation of the main page and other special
  *  documentation pages. It is not a project source file.
  */

- 
+

 /** \mainpage AVRISP MKII Programmer Project
  *
  *  \section SSec_Compat Project Compatibility:
  *
  *  The following list indicates what microcontrollers are compatible with this project.
  *
 /** \mainpage AVRISP MKII Programmer Project
  *
  *  \section SSec_Compat Project Compatibility:
  *
  *  The following list indicates what microcontrollers are compatible with this project.
  *

- *  - Series 7 USB AVRs
- *  - Series 6 USB AVRs
- *  - Series 4 USB AVRs
- *  - Series 2 USB AVRs (8KB versions with reduced features only)
+ *  - Series 7 USB AVRs (AT90USBxxx7)
+ *  - Series 6 USB AVRs (AT90USBxxx6)
+ *  - Series 4 USB AVRs (ATMEGAxxU4)
+ *  - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) - <i>8KB versions with reduced features only</i>

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


@@ -28,7 +28,7 @@
  *   <td><b>USB Class:</b></td>
  *   <td>Vendor Specific Class</td>
  *  </tr>
  *   <td><b>USB Class:</b></td>
  *   <td>Vendor Specific Class</td>
  *  </tr>

- *  <tr> 
+ *  <tr>

  *   <td><b>USB Subclass:</b></td>
  *   <td>N/A</td>
  *  </tr>
  *   <td><b>USB Subclass:</b></td>
  *   <td>N/A</td>
  *  </tr>


@@ -42,7 +42,7 @@
  *  </tr>
  * </table>
  *
  *  </tr>
  * </table>
  *

- *  \section SSec_Description Project Description: 
+ *  \section SSec_Description Project Description:

  *
  *  Firmware for an AVRStudio compatible AVRISP-MKII clone programmer. This project will enable the USB AVR series of
  *  microcontrollers to act as a clone of the official Atmel AVRISP-MKII programmer, usable within AVRStudio. In its
  *
  *  Firmware for an AVRStudio compatible AVRISP-MKII clone programmer. This project will enable the USB AVR series of
  *  microcontrollers to act as a clone of the official Atmel AVRISP-MKII programmer, usable within AVRStudio. In its


@@ -54,9 +54,8 @@
  *  drivers. When prompted, direct your OS to install Atmel's AVRISP-MKII drivers provided with AVRStudio.
  *
  *  Note that this design currently has the following limitations:
  *  drivers. When prompted, direct your OS to install Atmel's AVRISP-MKII drivers provided with AVRStudio.
  *
  *  Note that this design currently has the following limitations:

- *    - Minimum ISP target clock speed of 500KHz due to hardware SPI module prescaler limitations

  *    - No reversed/shorted target connector detection and notification
  *    - 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
+ *    - A separate header is required for each of the ISP, PDI and TPI programming protocols that the user wishes to use

  *
  *  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


@@ -214,72 +213,73 @@
  *   </tr>
  *   <tr>
  *    <td>AUX_LINE_PORT</td>
  *   </tr>
  *   <tr>
  *    <td>AUX_LINE_PORT</td>

- *    <td>Makefile CDEFS</td>
+ *    <td>Makefile LUFA_OPTS</td>

  *    <td>PORT register for the programmer's AUX target line. The use of this line varies between the programming protocols,
  *        but is generally used for the target's /RESET line. <i>Ignored when compiled for the XPLAIN board.</i></td>
  *   </tr>
  *   <tr>
  *    <td>AUX_LINE_PIN</td>
  *    <td>PORT register for the programmer's AUX target line. The use of this line varies between the programming protocols,
  *        but is generally used for the target's /RESET line. <i>Ignored when compiled for the XPLAIN board.</i></td>
  *   </tr>
  *   <tr>
  *    <td>AUX_LINE_PIN</td>

- *    <td>Makefile CDEFS</td>
+ *    <td>Makefile LUFA_OPTS</td>

  *    <td>PIN register for the programmer's AUX target line. The use of this line varies between the programming protocols,
  *        but is generally used for the target's /RESET line. <i>Ignored when compiled for the XPLAIN board.</i></td>
  *   </tr>
  *   <tr>
  *    <td>AUX_LINE_DDR</td>
  *    <td>PIN register for the programmer's AUX target line. The use of this line varies between the programming protocols,
  *        but is generally used for the target's /RESET line. <i>Ignored when compiled for the XPLAIN board.</i></td>
  *   </tr>
  *   <tr>
  *    <td>AUX_LINE_DDR</td>

- *    <td>Makefile CDEFS</td>
+ *    <td>Makefile LUFA_OPTS</td>

  *    <td>DDR register for the programmer's AUX target line. The use of this line varies between the programming protocols,
  *        but is generally used for the target's /RESET line. <i>Ignored when compiled for the XPLAIN board.</i></td>
  *   </tr>
  *   <tr>
  *    <td>AUX_LINE_MASK</td>
  *    <td>DDR register for the programmer's AUX target line. The use of this line varies between the programming protocols,
  *        but is generally used for the target's /RESET line. <i>Ignored when compiled for the XPLAIN board.</i></td>
  *   </tr>
  *   <tr>
  *    <td>AUX_LINE_MASK</td>

- *    <td>Makefile CDEFS</td>
+ *    <td>Makefile LUFA_OPTS</td>

  *    <td>Mask for the programmer's AUX target line. The use of this line varies between the programming protocols,
  *        but is generally used for the target's /RESET line. <b>Must not be the AVR's /SS pin</b>. <i>Ignored when
  *        compiled for the XPLAIN board.</i></td>
  *   </tr>
  *   <tr>
  *    <td>VTARGET_ADC_CHANNEL</td>
  *    <td>Mask for the programmer's AUX target line. The use of this line varies between the programming protocols,
  *        but is generally used for the target's /RESET line. <b>Must not be the AVR's /SS pin</b>. <i>Ignored when
  *        compiled for the XPLAIN board.</i></td>
  *   </tr>
  *   <tr>
  *    <td>VTARGET_ADC_CHANNEL</td>

- *    <td>Makefile CDEFS</td>
+ *    <td>Makefile LUFA_OPTS</td>

  *    <td>ADC channel number (on supported AVRs) to use for VTARGET level detection, if NO_VTARGET_DETECT is not defined.
  *    <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> 
+ *        <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>

- *    <td>Makefile CDEFS</td>
- *    <td>Define to enable SPI programming protocol support. <i>Ignored when compiled for the XPLAIN board.</i></td>  
+ *    <td>Makefile LUFA_OPTS</td>
+ *    <td>Define to enable SPI programming protocol support. <i>Ignored when compiled for the XPLAIN board.</i></td>

  *   </tr>
  *   <tr>
  *    <td>ENABLE_XPROG_PROTOCOL</td>
  *   </tr>
  *   <tr>
  *    <td>ENABLE_XPROG_PROTOCOL</td>

- *    <td>Makefile CDEFS</td>
- *    <td>Define to enable PDI and TPI programming protocol support. <i>Ignored when compiled for the XPLAIN board.</i></td>  
+ *    <td>Makefile LUFA_OPTS</td>
+ *    <td>Define to enable PDI and TPI programming protocol support. <i>Ignored when compiled for the XPLAIN board.</i></td>

  *   </tr>
  *   <tr>
  *    <td>NO_VTARGET_DETECT</td>
  *   </tr>
  *   <tr>
  *    <td>NO_VTARGET_DETECT</td>

- *    <td>Makefile CDEFS</td>
+ *    <td>Makefile LUFA_OPTS</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. <i>Ignored when compiled for
  *    <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. <i>Ignored when compiled for

- *        targets lacking an ADC.</i></td>  
+ *        targets lacking an ADC.</i></td>

  *   </tr>
  *   <tr>
  *    <td>VTARGET_REF_VOLTS</td>
  *   </tr>
  *   <tr>
  *    <td>VTARGET_REF_VOLTS</td>

- *    <td>Makefile CDEFS</td>
+ *    <td>Makefile LUFA_OPTS</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
  *    <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>  
+ *        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>
  *   </tr>
  *   <tr>
  *    <td>VTARGET_SCALE_FACTOR</td>

- *    <td>Makefile CDEFS</td>
+ *    <td>Makefile LUFA_OPTS</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
  *    <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> 
+ *        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>
  *   <tr>
  *    <td>LIBUSB_DRIVER_COMPAT</td>

- *    <td>Makefile CDEFS</td>
+ *    <td>Makefile LUFA_OPTS</td>

  *    <td>Define to switch to a non-standard endpoint scheme, breaking compatibility with AVRStudio under Windows but making
  *        the code compatible with software such as avrdude (all platforms) that use the libUSB driver.
  *   </tr>
  *  </table>
  */
  *    <td>Define to switch to a non-standard endpoint scheme, breaking compatibility with AVRStudio under Windows but making
  *        the code compatible with software such as avrdude (all platforms) that use the libUSB driver.
  *   </tr>
  *  </table>
  */

+