* 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.
*
* <td>1) Communications Device Class (CDC)</td>
* <td>2) Vendor Specific Class</td>
* </tr>
- * <tr>
+ * <tr>
* <td><b>USB Subclass:</b></td>
* <td>1) Abstract Control Model (ACM)</td>
* <td>2) N/A</td>
* <td>2) Atmel AVRISP MKII Protocol Specification</td>
* </tr>
* <tr>
- * <td><b>Usable Speeds:</b></td>
+ * <td><b>Supported USB Speeds:</b></td>
* <td>1) Full Speed Mode</td>
* <td>2) Full Speed Mode</td>
* </tr>
* </table>
*
- * \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.
*
* <td><b>Description:</b></td>
* </tr>
* <tr>
- * <td>BUFF_STATICSIZE</td>
- * <td>RingBuff.h</td>
- * <td>Defines the maximum number of bytes which can be buffered in each Ring Buffer.</td>
+ * <td>LIBUSB_DRIVER_COMPAT</td>
+ * <td>AppConfig.h</td>
+ * <td>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.</td>
* </tr>
* <tr>
- * <td>LIBUSB_FILTERDRV_COMPAT</td>
- * <td>Makefile CDEFS</td>
- * <td>Define to switch to a non-standard endpoint scheme, breaking compatibility with AVRStudio under Windows but making
- * the code compatible with Windows builds of avrdude using the libUSB driver. Linux platforms are not affected by this
- * option.
+ * <td>RESET_TOGGLES_LIBUSB_COMPAT</td>
+ * <td>Makefile LUFA_OPTS</td>
+ * <td>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.</td>
+ * </tr>
+ * <tr>
+ * <td>FIRMWARE_VERSION_MINOR</td>
+ * <td>AppConfig.h</td>
+ * <td>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.</td>
* </tr>
* </table>
- */
\ No newline at end of file
+ */
+
projects / pub / USBasp.git / blobdiff