X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/d3e00ce1eca6a7736f30b2e93992d0d5a6161de6..a69a0cbeb88f0e81bd32b4381489d50c008c34e4:/Projects/AVRISP-MKII/AVRISP-MKII.txt diff --git a/Projects/AVRISP-MKII/AVRISP-MKII.txt b/Projects/AVRISP-MKII/AVRISP-MKII.txt index c4ba43ccc..2cf8ceb47 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) + * \li Series 7 USB AVRs (AT90USBxxx7) + * \li Series 6 USB AVRs (AT90USBxxx6) + * \li Series 4 USB AVRs (ATMEGAxxU4) + * \li 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 * @@ -37,30 +37,30 @@ * Atmel AVRISP MKII Protocol Specification * * - * Usable Speeds: + * Supported USB Speeds: * Full Speed Mode * * * - * \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 - * most basic form, it allows for the programming of 5V AVRs from within AVRStudio with no special hardware other than - * the USB AVR and the parts needed for the USB interface. If the user desires, more advanced circuits incorporating - * level conversion can be made to allow for the programming of 3.3V AVR designs. + * Firmware for an Atmel Studio/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 + * Atmel Studio/AVRStudio or with any software capable of driving a real Atmel AVRISP-MKII programmer. In its most + * basic form, it allows for the programming of AVRs at the programmer's VCC voltage from within Atmel Studio/AVRStudio + * with no special hardware other than the USB AVR and the parts needed for the USB interface. If the user desires, more + * advanced circuits incorporating level conversion can be made to allow for the programming of 3.3V AVR designs. * * This device spoofs Atmel's official AVRISP-MKII device PID so that it remains compatible with Atmel's AVRISP-MKII - * drivers. When prompted, direct your OS to install Atmel's AVRISP-MKII drivers provided with AVRStudio. + * drivers. When prompted, direct your OS to install Atmel's AVRISP-MKII drivers provided with Atmel Studio/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 + * On AVR models with an ADC converter, AVCC should be tied to 5V (e.g. VBUS) and the \c 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 - * without an ADC converter, VTARGET will report a fixed 5V level at all times. + * without an ADC converter, VTARGET will report a fixed 3.3V level at all times. * * While this application can be compiled for USB AVRs with as little as 8KB of FLASH, for full functionality 16KB or more * of FLASH is required. On 8KB devices, ISP or PDI/TPI programming support can be disabled to reduce program size. @@ -106,12 +106,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 +154,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 +198,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 +214,119 @@ * * * AUX_LINE_PORT - * Makefile CDEFS + * AppConfig.h * 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. + * but is generally used for the target's /RESET line. + * \n \n Ignored when compiled for the XPLAIN board. * * * AUX_LINE_PIN - * Makefile CDEFS + * AppConfig.h * 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. + * but is generally used for the target's /RESET line. + * \n \n Ignored when compiled for the XPLAIN board. * * * AUX_LINE_DDR - * Makefile CDEFS + * AppConfig.h * 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. + * but is generally used for the target's /RESET line. + * \n \n Ignored when compiled for the XPLAIN board. * * * AUX_LINE_MASK - * Makefile CDEFS + * AppConfig.h * 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. + * but is generally used for the target's /RESET line. Must not be the AVR's /SS pin. + * \n \n Ignored when compiled for the XPLAIN board. * * * VTARGET_ADC_CHANNEL - * Makefile CDEFS + * AppConfig.h * 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. + * \n \n 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. + * AppConfig.h + * Define to enable SPI programming protocol support. + * \n \n 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. + * AppConfig.h + * Define to enable PDI and TPI programming protocol support. + * \n \n Ignored when compiled for the XPLAIN board. * * * NO_VTARGET_DETECT - * Makefile CDEFS + * AppConfig.h * 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. + * to report a fixed 3.3V target voltage to the host regardless of the real target voltage. + * \n \n Ignored when compiled for targets lacking an ADC. * * * VTARGET_REF_VOLTS - * Makefile CDEFS + * AppConfig.h * 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. + * \n \n Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined. + * + * + * VTARGET_USE_INTERNAL_REF + * AppConfig.h + * Selects the internal 2.56V ADC reference voltage, instead of using the AVR's VREF pin. When enabled, this option will + * override the VTARGET_REF_VOLTS configuration option. + * \n \n Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined. * * * VTARGET_SCALE_FACTOR - * Makefile CDEFS + * AppConfig.h * 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. + * \n \n Ignored when compiled for targets lacking an ADC, or when NO_VTARGET_DETECT is defined. + * * * LIBUSB_DRIVER_COMPAT - * Makefile CDEFS + * AppConfig.h * 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. + * + * \note This option is incompatible with \c RESET_TOGGLES_LIBUSB_COMPAT. + * + * + * RESET_TOGGLES_LIBUSB_COMPAT + * AppConfig.h + * Define to make the /RESET line of the AVR toggle between Jungo and libUSB driver compatibility modes. Each time the AVR is + * reset externally via the reset pin, the compatibility mode will be toggled. The compatibility mode is preserved between + * power cycles and is not toggled via other forms of reset such as Watchdog or Brown Out. + * + * When this option is enabled, all board LEDs will flash twice on startup for Jungo compatibility mode, and five times for + * libUSB compatibility mode. + * + * \note This option is incompatible with \c LIBUSB_DRIVER_COMPAT. + * + * + * XCK_RESCUE_CLOCK_ENABLE + * AppConfig.h + * 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. + * + * + * INVERTED_ISP_MISO + * AppConfig.h + * Define to invert the received data on the ISP MISO line. This is sometimes needed depending on the level translation hardware used, + * if the translator hardware inverts the received logic level. + * + * + * FIRMWARE_VERSION_MINOR + * AppConfig.h + * Define to set the minor firmware revision nunber reported to the host on request. By default this will use a firmware version compatible + * with the latest Atmel IDE version, however if desired the reported minor value can be adjusted here. * * */ +