* 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
* 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
* </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 \ref SSec_Options section</i>\r
+ * <b><sup>2</sup></b> <i>See AUX line related tokens in the \ref SSec_Options section</i>\r
*\r
* \section Sec_PDI PDI Connections\r
* Connections to the device for PDI programming<b><sup>1</sup></b> (when enabled):\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>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
* </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>\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
* <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>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>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
* </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>\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
* <td><b>Description:</b></td>\r
* </tr>\r
* <tr>\r
- * <td>RESET_LINE_PORT</td>\r
+ * <td>AUX_LINE_PORT</td>\r
* <td>Makefile CDEFS</td>\r
- * <td>PORT register for the programmer's target RESET line. <i>Ignored when compiled for the XPLAIN board.</i></td>\r
+ * <td>PORT register for the programmer's AUX target line. The use of this line varies between the programming protocols,\r
+ * but is generally used for the target's /RESET line. <i>Ignored when compiled for the XPLAIN board.</i></td>\r
* </tr>\r
* <tr>\r
- * <td>RESET_LINE_PIN</td>\r
+ * <td>AUX_LINE_PIN</td>\r
* <td>Makefile CDEFS</td>\r
- * <td>PIN register for the programmer's target RESET line. <i>Ignored when compiled for the XPLAIN board.</i></td>\r
+ * <td>PIN register for the programmer's AUX target line. The use of this line varies between the programming protocols,\r
+ * but is generally used for the target's /RESET line. <i>Ignored when compiled for the XPLAIN board.</i></td>\r
* </tr>\r
* <tr>\r
- * <td>RESET_LINE_DDR</td>\r
+ * <td>AUX_LINE_DDR</td>\r
* <td>Makefile CDEFS</td>\r
- * <td>DDR register for the programmer's target RESET line. <i>Ignored when compiled for the XPLAIN board.</i></td>\r
+ * <td>DDR register for the programmer's AUX target line. The use of this line varies between the programming protocols,\r
+ * but is generally used for the target's /RESET line. <i>Ignored when compiled for the XPLAIN board.</i></td>\r
* </tr>\r
* <tr>\r
- * <td>RESET_LINE_MASK</td>\r
+ * <td>AUX_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. When in PDI programming mode, this is the target clock pin.\r
- * <i>Ignored when compiled for the XPLAIN board.</i></td>\r
+ * <td>Mask for the programmer's AUX target line. The use of this line varies between the programming protocols,\r
+ * but is generally used for the target's /RESET line. <b>Must not be the AVR's /SS pin</b>. <i>Ignored when\r
+ * compiled for the XPLAIN board.</i></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
+ * <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
* <td>Makefile CDEFS</td>\r
* <td>Define to force the PDI and TPI protocols (when enabled) to use the much faster hardware USART instead of bit-banging\r
* to match the official AVRISP pinout. This breaks pinout compatibility with the official AVRISP MKII (and requires \r
- * seperate ISP and PDI/TPI programming headers) but increases programming speed dramatically.\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
+ * <tr>\r
+ * <td>LIBUSB_FILTERDRV_COMPAT</td>\r
+ * <td>Makefile CDEFS</td>\r
+ * <td>Define to switch to a non-standard endpoint scheme, breaking compatibility with AVRStudio under Windows but making\r
+ * the code compatible with Windows builds of avrdude using the libUSB driver. Linux platforms are not affected by this\r
+ * option.\r
+ * </tr>\r
* </table>\r
*/\r
projects / pub / USBasp.git / blobdiff