ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clean up of the altered XPLAINBridge project.

Browse source
This commit is contained in:
Dean Camera 2010-01-19 05:38:21 +00:00
parent 60fd0ff418
commit 1d2bc47eba
6 changed files with 30 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

27
Projects/XPLAINBridge/XPLAINBridge.txt
View file

@ -4,7 +4,7 @@
* documentation pages. It is not a project source file.
*/
/** \mainpage XPLAIN UART Bridge Project
/** \mainpage XPLAIN UART Bridge/PDI Programmer Project
*
* \section SSec_Compat Project Compatibility:
*
@ -20,37 +20,48 @@
* <tr>
* <td><b>USB Mode:</b></td>
* <td>Device</td>
* <td>Device</td>
* </tr>
* <tr>
* <td><b>USB Class:</b></td>
* <td>Communications Device Class (CDC)</td>
* <td>1) Communications Device Class (CDC)</td>
* <td>2) Vendor Specific Class</td>
* </tr>
* <tr>
* <td><b>USB Subclass:</b></td>
* <td>Abstract Control Model (ACM)</td>
* <td>1) Abstract Control Model (ACM)</td>
* <td>2) N/A</td>
* </tr>
* <tr>
* <td><b>Relevant Standards:</b></td>
* <td>USBIF CDC Class Standard</td>
* <td>1) USBIF CDC Class Standard</td>
* <td>2) Atmel AVRISP MKII Protocol Specification</td>
* </tr>
* <tr>
* <td><b>Usable Speeds:</b></td>
* <td>Full Speed Mode</td>
* <td>Full Speed Mode</td>
* </tr>
* </table>
*
* \section SSec_Description Project Description:
*
* This is a virtual serial port to soft-UART converter, for use on the Atmel XPLAIN boards. This project replaces the firmware
* preloaded onto the XPLAIN's onboard AT90USB1287 microcontroller to act as a a UART-to-USB bridge between the device and the
* host. When inserted, 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.
* 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 a PDI programmer for the XMEGA. This project replaces
* the firmware preloaded onto the XPLAIN's onboard AT90USB1287 microcontroller.
*
* When inserted, the JTAG port's TDI pin 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, 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.
*
* 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.
*
* This project relies on files from the LUFA AVRISP-MKII project.
*
* \section SSec_Options Project Options
*
* The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.