X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/071e02c6b6b4837fa9cf0b6d4c749994e02638d7..4cc7f5200beef90c39c8c8310ed7c8b849afb4d9:/Projects/XPLAINBridge/XPLAINBridge.txt

diff --git a/Projects/XPLAINBridge/XPLAINBridge.txt b/Projects/XPLAINBridge/XPLAINBridge.txt
index 0c5635ac7..fe7e739f1 100644
--- a/Projects/XPLAINBridge/XPLAINBridge.txt
+++ b/Projects/XPLAINBridge/XPLAINBridge.txt
@@ -47,19 +47,24 @@
  *  \section SSec_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 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.
+ *  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.
+ *
+ *  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.
  *
@@ -74,16 +79,15 @@
  *    <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>BUFFER_SIZE</td>
+ *    <td>LightweightRingBuff.h</td>
+ *    <td>Defines the maximum number of bytes which can be buffered in each Ring Buffer when in serial bridge mode.</td>
  *   </tr>
  *   <tr>
- *    <td>LIBUSB_FILTERDRV_COMPAT</td>
- *    <td>Makefile CDEFS</td>
+ *    <td>LIBUSB_DRIVER_COMPAT</td>
+ *    <td>Makefile LUFA_OPTS</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.
+ *        the code compatible with software such as avrdude (all platforms) that use the libUSB driver.
  *   </tr>
  *  </table>
- */
\ No newline at end of file
+ */