From df03104253abf029febabecd177ef170dbc84cf8 Mon Sep 17 00:00:00 2001
From: patacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>
Date: Wed, 4 Nov 2009 14:54:12 +0000
Subject: USB serial update

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@2219 42af7a65-404d-4744-a932-0658087f49c3
---
 nuttx/examples/README.txt | 85 ++++++++++++++++++++++++++++++-----------------
 1 file changed, 55 insertions(+), 30 deletions(-)

(limited to 'nuttx/examples/README.txt')

diff --git a/nuttx/examples/README.txt b/nuttx/examples/README.txt
index 78d5ca764..20e64b47b 100644
--- a/nuttx/examples/README.txt
+++ b/nuttx/examples/README.txt
@@ -332,48 +332,73 @@ examples/uip
 examples/usbserial
 ^^^^^^^^^^^^^^^^^^
 
-  This is another implementation of "Hello, World" but this one uses
-  a USB serial driver.  Configuration options can be used to simply
-  the test. These options include:
-
-  CONFIG_EXAMPLES_USBSERIAL_INONLY
-     Only verify IN (device-to-host) data transfers.  Default: both
-  CONFIG_EXAMPLES_USBSERIAL_OUTONLY
-     Only verify OUT (host-to-device) data transfers.  Default: both
-  CONFIG_EXAMPLES_USBSERIAL_ONLYSMALL
-     Send only small, single packet messages.  Default: Send large and small.
-  CONFIG_EXAMPLES_USBSERIAL_ONLYBIG
-     Send only large, multi-packet messages.  Default: Send large and small.
+  TARGET CONFIGURATION:
 
-  In additional to the target device-side example, there is also
-  a host-side application in this directory.  It can be compiled under
-  Linux or Cygwin as follows:
+    This is another implementation of "Hello, World" but this one uses
+    a USB serial driver.  Configuration options can be used to simply
+    the test. These options include:
 
-    cd examples/usbserial
-    make -f Makefile.host TOPDIR=../../.
+    CONFIG_EXAMPLES_USBSERIAL_INONLY
+       Only verify IN (device-to-host) data transfers.  Default: both
+    CONFIG_EXAMPLES_USBSERIAL_OUTONLY
+       Only verify OUT (host-to-device) data transfers.  Default: both
+    CONFIG_EXAMPLES_USBSERIAL_ONLYSMALL
+       Send only small, single packet messages.  Default: Send large and small.
+    CONFIG_EXAMPLES_USBSERIAL_ONLYBIG
+       Send only large, multi-packet messages.  Default: Send large and small.
 
-  This will generate a small program called 'host'.  Usage:
+    If CONFIG_USBDEV_TRACE is enabled (or CONFIG_DEBUG and CONFIG_DEBUG_USB), then
+    the example code will also manage the USB trace output.  The amount of trace output
+    can be controlled using:
 
-  1. Build the examples/usbserial target program and start the target.
+    CONFIG_EXAMPLES_USBSERIAL_TRACEINIT
+      Show initialization events
+    CONFIG_EXAMPLES_USBSERIAL_TRACECLASS
+      Show class driver events
+    CONFIG_EXAMPLES_USBSERIAL_TRACETRANSFERS
+      Show data transfer events
+    CONFIG_EXAMPLES_USBSERIAL_TRACECONTROLLER
+      Show controller events
+    CONFIG_EXAMPLES_USBSERIAL_TRACEINTERRUPTS
+      Show interrupt-related events.
 
-  2. Wait a bit, then do enter:
+    Error results are always shown in the trace output
 
-     dmesg
+  HOST-SIDE TEST PROGRAM
 
-     At the end of the dmesg output, you should see the serial
-     device was successfully idenfied and assigned to a tty device,
-     probably /dev/ttyUSB0.
+    In additional to the target device-side example, there is also a
+    host-side application in this directory.  This host side application
+    must be executed on a Linux host in order to perform the USBSERIAL
+    test.  The host application can be compiled under Linux (or Cygwin?)
+    as follows:
 
-  3. Then start the host application:
+      cd examples/usbserial
+      make -f Makefile.host TOPDIR=../../.
+
+  RUNNING THE TEST
+
+    This will generate a small program called 'host'.  Usage:
+
+    1. Build the examples/usbserial target program and start the target.
+
+    2. Wait a bit, then do enter:
+
+       dmesg
+
+       At the end of the dmesg output, you should see the serial
+       device was successfully idenfied and assigned to a tty device,
+       probably /dev/ttyUSB0.
+
+    3. Then start the host application:
 
-       ./host [<tty-dev>]
+         ./host [<tty-dev>]
 
-     Where:
+       Where:
 
-       <tty-dev> is the USB TTY device to use.  The default is /dev/ttyUSB0.
+         <tty-dev> is the USB TTY device to use.  The default is /dev/ttyUSB0.
 
-  The host and target will exchange are variety of very small and very large
-  serial messages.
+    The host and target will exchange are variety of very small and very large
+    serial messages.
 
 examples/usbstorage
 ^^^^^^^^^^^^^^^^^^^
-- 
cgit v1.2.3