Projects/AVRISP/AVRISP.txt

   1 /** \file
   2  *
   3  *  This file contains special DoxyGen information for the generation of the main page and other special
   4  *  documentation pages. It is not a project source file.
   5  */
   6
   7 /** \mainpage AVRISP MKII Programmer Project
   8  *
   9  *  \section SSec_Compat Demo Compatibility:
  10  *
  11  *  The following table indicates what microcontrollers are compatible with this demo.
  12  *
  13  *  - AT90USB1287
  14  *  - AT90USB1286
  15  *  - AT90USB647
  16  *  - AT90USB646
  17  *  - ATMEGA32U6
  18  *  - ATMEGA32U4
  19  *  - ATMEGA16U4
  20  *  - AT90USB162
  21  *  - AT90USB82
  22  *
  23  *  \section SSec_Info USB Information:
  24  *
  25  *  The following table gives a rundown of the USB utilization of this demo.
  26  *
  27  * <table>
  28  *  <tr>
  29  *   <td><b>USB Mode:</b></td>
  30  *   <td>Device</td>
  31  *  </tr>
  32  *  <tr>
  33  *   <td><b>USB Class:</b></td>
  34  *   <td>Vendor Specific Class</td>
  35  *  </tr>
  36  *  <tr>
  37  *   <td><b>USB Subclass:</b></td>
  38  *   <td>N/A</td>
  39  *  </tr>
  40  *  <tr>
  41  *   <td><b>Relevant Standards:</b></td>
  42  *   <td>Atmel AVRISP MKII Protocol Specification</td>
  43  *  </tr>
  44  *  <tr>
  45  *   <td><b>Usable Speeds:</b></td>
  46  *   <td>Full Speed Mode</td>
  47  *  </tr>
  48  * </table>
  49  *
  50  *  \section SSec_Description Project Description:
  51  *
  52  *  Firmware for an AVRStudio compatible AVRISP-MKII clone programmer. This project will enable the USB AVR series of
  53  *  microcontrollers to act as a clone of the official Atmel AVRISP-MKII programmer, usable within AVRStudio. In its
  54  *  most basic form, it allows for the programming of 5V AVRs from within AVRStudio with no special hardware other than
  55  *  the USB AVR and the parts needed for the USB interface. If the user desires, more advanced circuits incorporating
  56  *  level conversion can be made to allow for the programming of 3.3V AVR designs.
  57  *
  58  *  This device spoofs Atmel's official AVRISP-MKII device PID so that it remains compatible with Atmel's AVRISP-MKII
  59  *  drivers. When promted, direct your OS to install Atmel's AVRISP-MKII drivers provided with AVRStudio.
  60  *
  61  *  Note that this design currently has several limitations:
  62  *    - Minimum target clock speed of 500KHz due to hardware SPI used
  63  *    - No reversed/shorted target connector detection and notification
  64  *
  65  *  On AVR models with an ADC converter, ACC should be tied to 5V (e.g. VBUS) and the VTARGET_ADC_CHANNEL token should be
  66  *  set to an appropriate ADC channel number in the project makefile for VTARGET detection to operate correctly. On models
  67  *  without an ADC converter, VTARGET will report at a fixed 5V level.
  68  *
  69  *  Connections to the device are simple:
  70  *
  71  *  <table>
  72  *   <tr>
  73  *    <td><b>Programmer Pin:</b></td>
  74  *    <td><b>Target Device Pin:</b></td>
  75  *   </tr>
  76  *   <tr>
  77  *    <td>MOSI</td>
  78  *    <td>PDI</td>
  79  *   </tr>
  80  *   <tr>
  81  *    <td>MISO</td>
  82  *    <td>PDO</td>
  83  *   </tr>
  84  *   <tr>
  85  *    <td>SCLK</td>
  86  *    <td>SCLK</td>
  87  *   </tr>
  88  *   <tr>
  89  *    <td>GND</td>
  90  *    <td>GND</td>
  91  *   </tr>
  92  *   <tr>
  93  *    <td>ADCx <b><sup>1</sup></b></td>
  94  *    <td>VTARGET</td>
  95  *   </tr>
  96  *   <tr>
  97  *    <td>PORTx.y <b><sup>2</sup></b></td>
  98  *    <td>/RESET</td>
  99  *   </tr>
 100  *  </table>
 101  *
 102  *  <b><sup>1</sup></b> <i>Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only</i> \n
 103  *  <b><sup>2</sup></b> <i>See \ref SSec_Options section</i>
 104  *
 105  *  \section SSec_Options Project Options
 106  *
 107  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
 108  *
 109  *  <table>
 110  *   <tr>
 111  *    <td><b>Define Name:</b></td>
 112  *    <td><b>Location:</b></td>
 113  *    <td><b>Description:</b></td>
 114  *   </tr>
 115  *   <tr>
 116  *    <td>RESET_LINE_PORT</td>
 117  *    <td>Makefile CDEFS</td>
 118  *    <td>PORT register for the programmer's target RESET line.</td>
 119  *   </tr>
 120  *   <tr>
 121  *    <td>RESET_LINE_DDR</td>
 122  *    <td>Makefile CDEFS</td>
 123  *    <td>DDR register for the programmer's target RESET line.</td>
 124  *   </tr>
 125  *   <tr>
 126  *    <td>RESET_LINE_MASK</td>
 127  *    <td>Makefile CDEFS</td>
 128  *    <td>Mask for the programmer's target RESET line on the chosen port. <b>Must not be the AVR's /SS pin.</b></td>
 129  *   </tr>
 130  *   <tr>
 131  *    <td>VTARGET_ADC_CHANNEL</td>
 132  *    <td>Makefile CDEFS</td>
 133  *    <td>ADC channel number (on supported AVRs) to use for VTARGET level detection.</td>
 134  *   </tr>
 135  *  </table>
 136  */