-
NuttX RTOS Porting Guide
-Last Updated: February 24, 2011
+Last Updated: February 25, 2011
Last Updated: February 24, 2011
+Last Updated: February 25, 2011
-
Last Updated: February 24, 2011
+Last Updated: February 25, 2011
+ include/nuttx/usb/usbdev_trace.h.
+ Declarations needed to work the the NuttX USB device driver trace capability.
+ That USB trace capability is detailed in separate document.
+
struct usbdev_s.
diff --git a/Documentation/UsbTrace.html b/Documentation/UsbTrace.html
new file mode 100755
index 0000000000..ac1a7e7507
--- /dev/null
+++ b/Documentation/UsbTrace.html
@@ -0,0 +1,332 @@
+
+
+ NuttX USB Device Trace+Last Updated: February 25, 2010 + |
+
USB Device Tracing Controls. + The NuttX USB device subsystem supports a fairly sophisticated tracing facility. + The basic trace cabability is controlled by these NuttX configuration settings: +
+CONFIG_USBDEV_TRACE: Enables USB tracingCONFIG_USBDEV_TRACE_NRECORDS: Number of trace entries to rememberTrace IDs.
+ The trace facility works like this:
+ When enabled, USB events that occur in either the USB device driver or in the USB class driver are logged.
+ These events are described in include/nuttx/usb/usbdev_trace.h.
+ The logged events are identified by a set of event IDs:
+
TRACE_INIT_ID |
+ Initialization events | +
TRACE_EP_ID |
+ Endpoint API calls | +
TRACE_DEV_ID |
+ USB device API calls | +
TRACE_CLASS_ID |
+ USB class driver API calls | +
TRACE_CLASSAPI_ID |
+ Other class driver system API calls | +
TRACE_CLASSSTATE_ID |
+ Track class driver state changes | +
TRACE_INTENTRY_ID |
+ Interrupt handler entry | +
TRACE_INTDECODE_ID |
+ Decoded interrupt event | +
TRACE_INTEXIT_ID |
+ Interrupt handler exit | +
TRACE_OUTREQQUEUED_ID |
+ Request queued for OUT endpoint | +
TRACE_INREQQUEUED_ID |
+ Request queued for IN endpoint | +
TRACE_READ_ID |
+ Read (OUT) action | +
TRACE_WRITE_ID |
+ Write (IN) action | +
TRACE_COMPLETE_ID |
+ Request completed | +
TRACE_DEVERROR_ID |
+ USB controller driver error event | +
TRACE_CLSERROR_ID |
+ USB class driver error event | +
Logged Events. + Each logged event is 32-bits in size and includes +
+8-bit Trace Data + The 8-bit trace data depends on the specific event ID. As examples, +
+include/nuttx/usb/usbdev_trace.h.
+ arch/arm/src/lpc17xx/lpc17_usbdev.c.
+ 16-bit Trace Data. + The 16-bit trace data provided additional context data relevant to the specific logged event. +
+Trace Control Interfaces.
+ Logging of each of these kinds events can be enabled or disabled using the interfaces described in include/nuttx/usb/usbdev_trace.h.
+
Enabling USB Device Tracing.
+ USB device tracing will be configured if CONFIG_USBDEV and either of the following are set in the NuttX configuration file:
+
CONFIG_USBDEV_TRACE, orCONFIG_DEBUG and CONFIG_DEBUG_USBLog Data Sink.
+ The logged data itself may go to either (1) an internal circular buffer, or (2) may be provided on the console.
+ If CONFIG_USBDEV_TRACE is defined, then the trace data will go to the circular buffer.
+ The size of the circular buffer is determined by CONFIG_USBDEV_TRACE_NRECORDS.
+ Otherwise, the trace data goes to console.
+
+
Example.
+ Here is an example of USB trace output using examples/usbserial for an LPC1768 platform with the following NuttX configuration settings:
+
CONFIG_DEBUG, CONFIG_DEBUG_VERBOSE, CONFIG_USB
+ CONFIG_EXAMPLES_USBSERIAL_TRACEINIT, CONFIG_EXAMPLES_USBSERIAL_TRACECLASS,
+ CONFIG_EXAMPLES_USBSERIAL_TRACETRANSFERS, CONFIG_EXAMPLES_USBSERIAL_TRACECONTROLLER,
+ CONFIG_EXAMPLES_USBSERIAL_TRACEINTERRUPTS
+Console Output:
+| + | ABDE |
+
| + | user_start: Registering USB serial driver |
+
| + | uart_register: Registering /dev/ttyUSB0 |
+
| + | user_start: Successfully registered the serial driver |
+
| 1 | +Class API call 1: 0000 |
+
| 2 | +Class error: 19:0000 |
+
| + | user_start: ERROR: Failed to open /dev/ttyUSB0 for reading: 107 |
+
| + | user_start: Not connected. Wait and try again. |
+
| 3 | +Interrupt 1 entry: 0039 |
+
| 4 | +Interrupt decode 7: 0019 |
+
| 5 | +Interrupt decode 32: 0019 |
+
| 6 | +Interrupt decode 6: 0019 |
+
| 7 | +Class disconnect(): 0000 |
+
| 8 | +Device pullup(): 0001 |
+
| 9 | +Interrupt 1 exit: 0000 |
+
+ The numbered items are USB USB trace output.
+ You can look in the file drivers/usbdev/usbdev_trprintf.c to see examctly how each output line is formatted.
+ Here is how each line should be interpreted:
+
| + | USB EVENT ID | +8-bit EVENT DATA |
+ MEANING | +16-bit EVENT DATA |
+
|---|---|---|---|---|
| 1 | +TRACE_CLASSAPI_ID1 |
+ 1 | +USBSER_TRACECLASSAPI_SETUP1 |
+ 0000 | +
| 2 | +TRACE_CLSERROR_ID1 |
+ 19 | +USBSER_TRACEERR_SETUPNOTCONNECTED1 |
+ 0000 | +
| 3 | +TRACE_INTENTRY_ID1 |
+ 1 | +LPC17_TRACEINTID_USB2 |
+ 0039 | +
| 4 | +TRACE_INTDECODE_ID2 |
+ 7 | +LPC17_TRACEINTID_DEVSTAT2 |
+ 0019 | +
| 5 | +TRACE_INTDECODE_ID2 |
+ 32 | +LPC17_TRACEINTID_SUSPENDCHG2 |
+ 0019 | +
| 6 | +TRACE_INTDECODE_ID2 |
+ 6 | +LPC17_TRACEINTID_DEVRESET2 |
+ 0019 | +
| 7 | +TRACE_CLASS_ID1 |
+ 3 | +(See TRACE_CLASSDISCONNECT1) |
+ 0000 | +
| 8 | +TRACE_DEV_ID1 |
+ 6 | +(See TRACE_DEVPULLUP1) |
+ 0001 | +
| 9 | +TRACE_INTEXIT_ID1 |
+ 1 | +LPC17_TRACEINTID_USB2 |
+ 0000 | +
NOTES:
+ 1See include/nuttx/usb/usbdev_trace.h
+ 2See arch/arm/src/lpc17xx/lpc17_usbdev.c
+
+ In the above example you can see that: +
+drivers/usbdev/usbdev_serial.c:
+
+static int usbser_setup(FAR struct uart_dev_s *dev)
+{
+ ...
+ usbtrace(USBSER_CLASSAPI_SETUP, 0);
+ ...
+drivers/usbdev/usbdev_serial.c:
+
+static int usbser_setup(FAR struct uart_dev_s *dev)
+{
+ ...
+ /* Check if we have been configured */
+
+ if (priv->config == USBSER_CONFIGIDNONE)
+ {
+ usbtrace(TRACE_CLSERROR(USBSER_TRACEERR_SETUPNOTCONNECTED), 0);
+ return -ENOTCONN;
+ }
+ ...
+
+