X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/d3e00ce1eca6a7736f30b2e93992d0d5a6161de6..70d55f6e0ca1f262bd8811ad8d4149e33125819a:/Projects/AVRISP-MKII/AVRISP-MKII.txt diff --git a/Projects/AVRISP-MKII/AVRISP-MKII.txt b/Projects/AVRISP-MKII/AVRISP-MKII.txt index c4ba43ccc..fb6411b58 100644 --- a/Projects/AVRISP-MKII/AVRISP-MKII.txt +++ b/Projects/AVRISP-MKII/AVRISP-MKII.txt @@ -3,19 +3,19 @@ * 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: + * \section Sec_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) - 8KB versions with reduced features only * - * \section SSec_Info USB Information: + * \section Sec_Info USB Information: * * The following table gives a rundown of the USB utilization of this project. * @@ -28,7 +28,7 @@ * USB Class: * Vendor Specific Class * - * + * * USB Subclass: * N/A * @@ -42,7 +42,7 @@ * * * - * \section SSec_Description Project Description: + * \section Sec_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 @@ -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: - * - 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 + * - 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 @@ -106,12 +105,12 @@ * * * - * In addition, the AVR's XCK pin will generate a .5MHz clock when SPI programming is used, to act as an external - * device clock if the fuses have been mis-set. To use the recovery clock, connect XCK to the target AVR's XTAL1 - * pin, and set the ISP programming speed to 125KHz or below. + * In addition, the AVR's OCR1A pin will generate a 4MHz clock, to act as an external rescue device clock if the + * fuses have been mis-set. To use the recovery clock, connect the OCR1A pin of the USB AVR to the target AVR's + * XTAL1 pin, and set the ISP programming speed to 125KHz (note: other ISP speeds will not work correctly). * - * 1 Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only \n - * 2 See AUX line related tokens in the \ref SSec_Options section + * 1 Optional, see \ref Sec_Options section - for USB AVRs with ADC modules only \n + * 2 See AUX line related tokens in the \ref Sec_Options section * * \section Sec_PDI PDI Connections * Connections to the device for PDI programming (when enabled): @@ -154,7 +153,7 @@ * * * - * 1 Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only \n + * 1 Optional, see \ref Sec_Options section - for USB AVRs with ADC modules only \n * 2 The AVR's Tx and Rx become the DATA line when connected together via a pair of 220 ohm resistors \n * * \section Sec_TPI TPI Connections @@ -198,11 +197,11 @@ * * * - * 1 Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only \n + * 1 Optional, see \ref Sec_Options section - for USB AVRs with ADC modules only \n * 2 The AVR's Tx and Rx become the DATA line when connected together via a pair of 220 ohm resistors \n - * 3 See AUX line related tokens in the \ref SSec_Options section + * 3 See AUX line related tokens in the \ref Sec_Options section * - * \section SSec_Options Project Options + * \section Sec_Options Project Options * * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value. * @@ -214,72 +213,79 @@ * * * AUX_LINE_PORT - * Makefile CDEFS + * Makefile LUFA_OPTS * 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. Ignored when compiled for the XPLAIN board. * * * AUX_LINE_PIN - * Makefile CDEFS + * Makefile LUFA_OPTS * 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. Ignored when compiled for the XPLAIN board. * * * AUX_LINE_DDR - * Makefile CDEFS + * Makefile LUFA_OPTS * 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. Ignored when compiled for the XPLAIN board. * * * AUX_LINE_MASK - * Makefile CDEFS + * Makefile LUFA_OPTS * 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. Must not be the AVR's /SS pin. Ignored when * compiled for the XPLAIN board. * * * VTARGET_ADC_CHANNEL - * Makefile CDEFS + * Makefile LUFA_OPTS * ADC channel number (on supported AVRs) to use for VTARGET level detection, if NO_VTARGET_DETECT is not defined. - * Ignored when compiled for targets lacking an ADC. + * Ignored when compiled for targets lacking an ADC. * * * ENABLE_ISP_PROTOCOL - * Makefile CDEFS - * Define to enable SPI programming protocol support. Ignored when compiled for the XPLAIN board. + * Makefile LUFA_OPTS + * Define to enable SPI programming protocol support. Ignored when compiled for the XPLAIN board. * * * ENABLE_XPROG_PROTOCOL - * Makefile CDEFS - * Define to enable PDI and TPI programming protocol support. Ignored when compiled for the XPLAIN board. + * Makefile LUFA_OPTS + * Define to enable PDI and TPI programming protocol support. Ignored when compiled for the XPLAIN board. * * * NO_VTARGET_DETECT - * Makefile CDEFS + * Makefile LUFA_OPTS * 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. Ignored when compiled for - * targets lacking an ADC. + * targets lacking an ADC. * * * VTARGET_REF_VOLTS - * Makefile CDEFS + * Makefile LUFA_OPTS * 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. Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined. + * to the ADC. Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined. * * * VTARGET_SCALE_FACTOR - * Makefile CDEFS + * Makefile LUFA_OPTS * 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. Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined. - * + * to 2. Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined. + * * * LIBUSB_DRIVER_COMPAT - * Makefile CDEFS + * Makefile LUFA_OPTS * 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. * + * + * XCK_RESCUE_CLOCK_ENABLE + * Makefile LUFA_OPTS + * Define to move the ISP rescue clock to the AVR's XCK pin instead of the OCR1A output pin. This is useful for existing programming + * hardware that does not expose the OCR1A pin of the AVR, but *may* cause some issues with PDI programming mode. + * * */ +