OptionRomPkg: Added bus driver for FTDI USB to serial adapters

[mirror_edk2.git] / OptionRomPkg / Bus / Usb / FtdiUsbSerialDxe / ReadMe.txt

diff --git a/OptionRomPkg/Bus/Usb/FtdiUsbSerialDxe/ReadMe.txt b/OptionRomPkg/Bus/Usb/FtdiUsbSerialDxe/ReadMe.txt
new file mode 100644 (file)
index 0000000..d8ca227
--- /dev/null
+++ b/OptionRomPkg/Bus/Usb/FtdiUsbSerialDxe/ReadMe.txt
@@ -0,0 +1,32 @@
+\r
+=== FTDI USB SERIAL OVERVIEW ===\r
+\r
+This is a bus driver that enables the EfiSerialIoProtocol interface\r
+for FTDI8U232AM based USB-to-Serial adapters.\r
+\r
+=== STATUS ===\r
+\r
+Serial Input: Functional on real hardware.\r
+Serial Output: Functional on real hardware.\r
+\r
+Operating Modes: Currently the user is able to change all operating modes\r
+except timeout and FIFO depth.\r
+The default operating mode is:\r
+       Baudrate:     115200\r
+       Parity:       None\r
+       Flow Control: None\r
+       Data Bits:    8\r
+       Stop Bits:    1\r
+Notes: \r
+       Data Bits setting of 6,7,8 can not be combined with a Stop Bits setting of 1.5\r
+\r
+        At baudrates less than 9600 some of the characters may be transmitted incorrectly.\r
+\r
+=== COMPATIBILITY ===\r
+\r
+Tested with:\r
+An FTDI8U232AM based USB-To-Serial adapter, the UEFI Shell, and the SerialTest application \r
+using a PuTTY Terminal\r
+\r
+See CompatibleDevices.txt for a list of devices which have been confirmed to work with this \r
+driver.
\ No newline at end of file