X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/3b95b8dedced6c118cfb2cd7fc72c696c076119e..5f709e281eec223c5de9766a99bdd54339e149cb:/Projects/XPLAINBridge/XPLAINBridge.txt diff --git a/Projects/XPLAINBridge/XPLAINBridge.txt b/Projects/XPLAINBridge/XPLAINBridge.txt index f22feca8e..bc0ca37d8 100644 --- a/Projects/XPLAINBridge/XPLAINBridge.txt +++ b/Projects/XPLAINBridge/XPLAINBridge.txt @@ -3,16 +3,16 @@ * 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 XPLAIN UART Bridge/PDI Programmer Project * - * \section SSec_Compat Project Compatibility: + * \section Sec_Compat Project Compatibility: * * The following list indicates what microcontrollers are compatible with this project. * - * - AT90USB1287 + * \li AT90USB1287 * - * \section SSec_Info USB Information: + * \section Sec_Info USB Information: * * The following table gives a rundown of the USB utilization of this project. * @@ -27,7 +27,7 @@ * 1) Communications Device Class (CDC) * 2) Vendor Specific Class * - * + * * USB Subclass: * 1) Abstract Control Model (ACM) * 2) N/A @@ -38,32 +38,37 @@ * 2) Atmel AVRISP MKII Protocol Specification * * - * Usable Speeds: + * Supported USB Speeds: * 1) Full Speed Mode * 2) Full Speed Mode * * * - * \section SSec_Description Project Description: + * \section Sec_Description Project Description: * * This project serves a dual purpose. When loaded into the USB AVR on the XPLAIN board, it will act as either a USB to Serial - * converter for the XPLAIN's hardware USART (at a speed of 9600 baud), or an AVRStudio compaible PDI programmer for the XMEGA. + * converter for the XPLAIN's hardware USART (at a speed of 9600 baud), or an AVRStudio compatible PDI programmer for the XMEGA. * This project replaces the firmware preloaded onto the XPLAIN's onboard AT90USB1287 microcontroller. * * When power to the board is applied, the TDI pin (pin 9) of the USB AVR's JTAG port is read. If the pin is left high, the device * will enumerate as a regular COM port on the host, which can then be opened and data exchanged between the XMEGA and Host as if * the XMEGA was connected directly to the host's serial port. If the pin is pulled low by shorting it to GND (pin 10), the device * will enumerate as an AVRISP-MKII to the host, so that the XMEGA can be reprogrammed by AVRStudio or other compatible software - * such as avrdude. + * such as avrdude by connecting to the board as if it was an Atmel AVRISP-MKII programmer. + * + * After running this project in serial bridge mode for the first time on a new computer, you will need to supply the .INF file + * located in this project project's directory as the device's driver when running under Windows. This will enable Windows to use + * its inbuilt CDC virtual serial drivers, negating the need for custom drivers for the device. Other Operating Systems should + * automatically use their own inbuilt CDC-ACM drivers. * - * After running this project for the first time on a new computer, you will need to supply the .INF file located in this project - * project's directory as the device's driver when running under Windows. This will enable Windows to use its inbuilt CDC drivers, - * negating the need for custom drivers for the device. Other Operating Systems should automatically use their own inbuilt CDC-ACM - * drivers. + * In serial bridge mode, the UART baud rate can be altered through the host terminal software to select a new baud rate - the default + * baud is 9600. Note that parity, data bits and stop bits are fixed at none, eight and one respectively can cannot be altered. Changes + * to the connection's parity, data bits or stop bits are ignored by the firmware. As the serial link between the controllers on the + * XPLAIN is software emulated by the USB AVR, not all baud rates will work correctly. * * This project relies on files from the LUFA AVRISP-MKII project for compilation. * - * \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. * @@ -74,15 +79,31 @@ * Description: * * - * BUFFER_SIZE - * LightweightRingBuff.h - * Defines the maximum number of bytes which can be buffered in each Ring Buffer when in serial bridge mode. - * - * * 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 + * Makefile LUFA_OPTS + * 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. + * + * + * 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. * * - */ \ No newline at end of file + */ +