X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/025742fca89e78d33f37b229c97607460a3a78d5..a69a0cbeb88f0e81bd32b4381489d50c008c34e4:/Projects/AVRISP-MKII/AVRISP-MKII.txt
diff --git a/Projects/AVRISP-MKII/AVRISP-MKII.txt b/Projects/AVRISP-MKII/AVRISP-MKII.txt
index ab355bfac..2cf8ceb47 100644
--- a/Projects/AVRISP-MKII/AVRISP-MKII.txt
+++ b/Projects/AVRISP-MKII/AVRISP-MKII.txt
@@ -10,10 +10,10 @@
*
* The following list indicates what microcontrollers are compatible with this project.
*
- * - 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
+ * \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 Sec_Info USB Information:
*
@@ -37,29 +37,30 @@
*
Atmel AVRISP MKII Protocol Specification |
*
*
- * | Usable Speeds: |
+ * Supported USB Speeds: |
* Full Speed Mode |
*
*
*
* \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:
* - No reversed/shorted target connector detection and notification
* - 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.
@@ -213,84 +214,118 @@
*
*
* | AUX_LINE_PORT |
- * Makefile LUFA_OPTS |
+ * 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 LUFA_OPTS |
+ * 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 LUFA_OPTS |
+ * 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 LUFA_OPTS |
+ * 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 LUFA_OPTS |
+ * 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 LUFA_OPTS |
- * 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 LUFA_OPTS |
- * 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 LUFA_OPTS |
+ * 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 LUFA_OPTS |
+ * 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 |
- * Makefile LUFA_OPTS |
+ * 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. |
+ * 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 LUFA_OPTS |
+ * 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 LUFA_OPTS |
+ * 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 |
- * Makefile LUFA_OPTS |
+ * 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.
+ * 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. |
*
*
*/