Add configuration for Future Electronics Group NE64 Badge board

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3316 42af7a65-404d-4744-a932-0658087f49c3
author: patacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3> 2011-02-25 18:46:06 +0000
committer: patacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3> 2011-02-25 18:46:06 +0000
commit: 0fc66dd545b21a2094f8d833955107d583bea953 (patch)
tree: 0a859a014dec148a9c95db3f148b808b9c02ad6f /nuttx/Documentation
parent: d7ddd75cbe92d10263edaf505f8569834bf35c6a (diff)
download: px4-nuttx-0fc66dd545b21a2094f8d833955107d583bea953.tar.gz
px4-nuttx-0fc66dd545b21a2094f8d833955107d583bea953.tar.bz2
px4-nuttx-0fc66dd545b21a2094f8d833955107d583bea953.zip
3 files changed, 348 insertions, 3 deletions
diff --git a/nuttx/Documentation/NuttX.html b/nuttx/Documentation/NuttX.html
index 897aa4887..b58bc9524 100644
--- a/nuttx/Documentation/NuttX.html
+++ b/nuttx/Documentation/NuttX.html
@@ -8,7 +8,7 @@
   <tr align="center" bgcolor="#e4e4e4">
     <td>
       <h1><big><font color="#3c34ec"><i>NuttX RTOS</i></font></big></h1>
-      <p>Last Updated: February 24, 2011</p>
+      <p>Last Updated: February 25, 2011</p>
     </td>
   </tr>
 </table>
@@ -582,7 +582,7 @@
   <td><br></td>
   <td>
     <p>
-      <li>Built-in USB trace functionality for USB debug.</li>
+      <li>Built-in <a href="UsbTrace.html">USB trace</a> functionality for USB debug.</li>
     </p>
 </tr>
 
@@ -2043,6 +2043,8 @@ nuttx-5.18 2011-xx-xx Gregory Nutt &lt;spudmonkey@racsa.co.cr&gt;
 	* examples/nsh -- Correct an usage of getopt(): If you stop calling getopt()
 	  before all parameters are parsed, you can leave getopt() in a strange state.
     * Rename arch/pjrc-8051 to arch/8051
+	* configs/ne64badge -- Add a configuration for the Future Electronics Group
+	  NE64 Badge development board (Freescale MC9S12NE64)
 
 pascal-2.1 2011-xx-xx Gregory Nutt &lt;spudmonkey@racsa.co.cr&gt;
 
@@ -2109,6 +2111,10 @@ buildroot-1.10 2011-xx-xx <spudmonkey@racsa.co.cr>
   <td valign="top" width="22"><img height="20" width="20" src="favicon.ico"></td>
   <td><a href="TODO.txt">To-Do List</a></td>
 </tr>
+<tr>
+  <td valign="top" width="22"><img height="20" width="20" src="favicon.ico"></td>
+  <td><a href="UsbTrace.html">USB Device Driver Tracing</a></td>
+</tr>
 </center></ul>
 
 <small>
diff --git a/nuttx/Documentation/NuttxPortingGuide.html b/nuttx/Documentation/NuttxPortingGuide.html
index 6c9de941f..5358f6797 100644
--- a/nuttx/Documentation/NuttxPortingGuide.html
+++ b/nuttx/Documentation/NuttxPortingGuide.html
@@ -12,7 +12,7 @@
       <h1><big><font color="#3c34ec">
         <i>NuttX RTOS Porting Guide</i>
       </font></big></h1>
-      <p>Last Updated: February 24, 2011</p>
+      <p>Last Updated: February 25, 2011</p>
     </td>
   </tr>
 </table>
@@ -2459,6 +2459,13 @@ extern void up_ledoff(int led);
   </li>
   <li>
     <p>
+      <b><code>include/nuttx/usb/usbdev_trace.h</code></b>.
+      Declarations needed to work the the NuttX USB device driver trace capability.
+      That USB trace capability is detailed in <a href="UsbTrace.html">separate document</a>.
+    </p>
+  </li>
+  <li>
+    <p>
       <b><code>struct usbdev_s</code></b>.
       Each USB device controller driver must implement an instance of <code>struct usbdev_s</code>.
       This structure is defined in <code>include/nuttx/usb/usbdev.h</code>.
diff --git a/nuttx/Documentation/UsbTrace.html b/nuttx/Documentation/UsbTrace.html
new file mode 100755
index 000000000..ac1a7e750
--- /dev/null
+++ b/nuttx/Documentation/UsbTrace.html
@@ -0,0 +1,332 @@
+<html>
+<head>
+<title>README Files</title>
+</head>
+
+<body background="backgd.gif">
+<hr><hr>
+<table width ="100%">
+  <tr align="center" bgcolor="#e4e4e4">
+    <td>
+      <h1><big><font color="#3c34ec"><i>NuttX USB Device Trace</i></font></big></h1>
+      <p>Last Updated: February 25, 2010</p>
+    </td>
+  </tr>
+</table>
+<hr><hr>
+<p><b>USB Device Tracing Controls</b>.
+  The NuttX USB device subsystem supports a fairly sophisticated tracing facility.
+  The basic trace cabability is controlled by these NuttX configuration settings:
+</p>
+<ul>
+  <li><code>CONFIG_USBDEV_TRACE</code>: Enables USB tracing</li>
+  <li><code>CONFIG_USBDEV_TRACE_NRECORDS</code>: Number of trace entries to remember</li>
+</ul>
+<p><b>Trace IDs</b>.
+  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 <code>include/nuttx/usb/usbdev_trace.h</code>.
+  The logged events are identified by a set of event IDs:
+</p>
+<ul><table>
+  <tr>
+    <td><code>TRACE_INIT_ID</code></td>
+    <td>Initialization events</td>
+  </tr>
+  <tr>
+    <td><code>TRACE_EP_ID</code></td>
+    <td>Endpoint API calls</td>
+  </tr>
+  <tr>
+    <td><code>TRACE_DEV_ID</code></td>
+    <td>USB device API calls</td>
+  </tr>
+  <tr>
+    <td><code>TRACE_CLASS_ID</code></td>
+    <td>USB class driver API calls</td>
+  </tr>
+  <tr>
+    <td><code>TRACE_CLASSAPI_ID</code></td>
+    <td>Other class driver system API calls</td>
+  </tr>
+  <tr>
+    <td><code>TRACE_CLASSSTATE_ID</code></td>
+    <td>Track class driver state changes</td>
+  </tr>
+  <tr>
+    <td><code>TRACE_INTENTRY_ID</code></td>
+    <td>Interrupt handler entry</td>
+  </tr>
+  <tr>
+    <td><code>TRACE_INTDECODE_ID</code></td>
+    <td>Decoded interrupt event</td>
+  </tr>
+  <tr>
+    <td><code>TRACE_INTEXIT_ID</code></td>
+    <td>Interrupt handler exit</td>
+  </tr>
+  <tr>
+    <td><code>TRACE_OUTREQQUEUED_ID</code></td>
+    <td>Request queued for OUT endpoint</td>
+  </tr>
+  <tr>
+    <td><code>TRACE_INREQQUEUED_ID</code></td>
+    <td>Request queued for IN endpoint</td>
+  </tr>
+  <tr>
+    <td><code>TRACE_READ_ID</code></td>
+    <td>Read (OUT) action</td>
+  </tr>
+  <tr>
+    <td><code>TRACE_WRITE_ID</code></td>
+    <td>Write (IN) action</td>
+  </tr>
+  <tr>
+    <td><code>TRACE_COMPLETE_ID</code></td>
+    <td>Request completed</td>
+  </tr>
+  <tr>
+    <td><code>TRACE_DEVERROR_ID</code></td>
+    <td>USB controller driver error event</td>
+  </tr>
+  <tr>
+    <td><code>TRACE_CLSERROR_ID</code></td>
+    <td>USB class driver error event</td>
+  </tr>
+</table></ul>
+<p><b>Logged Events</b>.
+  Each logged event is 32-bits in size and includes
+</p>
+<ol>
+  <li>8-bits of the trace ID (values associated with the above)</li>
+  <li>8-bits of additional trace ID data, and</li>
+  <li>16-bits of additonal data.</li>
+</ol>
+<p><b>8-bit Trace Data</b>
+  The 8-bit trace data depends on the specific event ID.  As examples,
+</p>
+<ul>
+  <li>
+    For the USB serial and mass storage class, the 8-bit event data is provided in <code>include/nuttx/usb/usbdev_trace.h</code>. 
+  </li>
+  <li>
+    For the USB device driver, that 8-bit event data is provided within the USB device driver itself.
+    So, for example, the 8-bit event data for the LPC1768 USB device driver is found in <code>arch/arm/src/lpc17xx/lpc17_usbdev.c</code>.
+  </li>
+</ul>
+<p><b>16-bit Trace Data</b>.
+  The 16-bit trace data provided additional context data relevant to the specific logged event.
+</p>
+<p><b>Trace Control Interfaces</b>.
+  Logging of each of these kinds events can be enabled or disabled using the interfaces described in <code>include/nuttx/usb/usbdev_trace.h</code>.
+</p>
+<p><b>Enabling USB Device Tracing</b>.
+  USB device tracing will be configured if <code>CONFIG_USBDEV</code> and either of the following are set in the NuttX configuration file:
+</p>
+<ul>
+  <li><code>CONFIG_USBDEV_TRACE</code>, or</li>
+  <li><code>CONFIG_DEBUG and CONFIG_DEBUG_USB</code></li>
+</ul>
+<p><b>Log Data Sink</b>.
+  The logged data itself may go to either (1) an internal circular buffer, or (2) may be provided on the console.
+  If <code>CONFIG_USBDEV_TRACE</code> is defined, then the trace data will go to the circular buffer.
+  The size of the circular buffer is determined by <code>CONFIG_USBDEV_TRACE_NRECORDS</code>.
+  Otherwise, the trace data goes to console.
+<p>
+<p><b>Example</b>.
+  Here is an example of USB trace output using <code>examples/usbserial</code> for an LPC1768 platform with the following NuttX configuration settings:
+</p>
+<ul>
+  <li><code>CONFIG_DEBUG</code>, <code>CONFIG_DEBUG_VERBOSE</code>, <code>CONFIG_USB</code>
+  <li><code>CONFIG_EXAMPLES_USBSERIAL_TRACEINIT</code>, <code>CONFIG_EXAMPLES_USBSERIAL_TRACECLASS</code>,
+    <code>CONFIG_EXAMPLES_USBSERIAL_TRACETRANSFERS</code>, <code>CONFIG_EXAMPLES_USBSERIAL_TRACECONTROLLER</code>,
+    <code>CONFIG_EXAMPLES_USBSERIAL_TRACEINTERRUPTS</code>
+</ul>
+<p>Console Output:</p>
+<ul><table>
+  <tr>
+    <td align="center">&nbsp;</td>
+    <td align="left"><code>ABDE</code></td>
+  </tr>
+  <tr>
+    <td align="center">&nbsp;</td>
+    <td align="left"><code>user_start: Registering USB serial driver</code></td>
+  </tr>
+  <tr>
+    <td align="center">&nbsp;</td>
+    <td align="left"><code>uart_register: Registering /dev/ttyUSB0</code></td>
+  </tr>
+  <tr>
+    <td align="center">&nbsp;</td>
+    <td align="left"><code>user_start: Successfully registered the serial driver</code></td>
+  </tr>
+  <tr>
+    <td align="center">1</td>
+    <td align="left"><code>Class API call 1: 0000</code></td>
+  </tr>
+  <tr>
+    <td align="center">2</td>
+    <td align="left"><code>Class error: 19:0000</code></td>
+  </tr>
+  <tr>
+    <td align="center">&nbsp;</td>
+    <td align="left"><code>user_start: ERROR: Failed to open /dev/ttyUSB0 for reading: 107</code></td>
+  </tr>
+  <tr>
+    <td align="center">&nbsp;</td>
+    <td align="left"><code>user_start: Not connected. Wait and try again.</code></td>
+  </tr>
+  <tr>
+    <td align="center">3</td>
+    <td align="left"><code>Interrupt 1 entry: 0039</code></td>
+  </tr>
+  <tr>
+    <td align="center">4</td>
+    <td align="left"><code>Interrupt decode 7: 0019</code></td>
+  </tr>
+  <tr>
+    <td align="center">5</td>
+    <td align="left"><code>Interrupt decode 32: 0019</code></td>
+  </tr>
+  <tr>
+    <td align="center">6</td>
+    <td align="left"><code>Interrupt decode 6: 0019</code></td>
+  </tr>
+  <tr>
+    <td align="center">7</td>
+    <td align="left"><code>Class disconnect(): 0000</code></td>
+  </tr>
+  <tr>
+    <td align="center">8</td>
+    <td align="left"><code>Device pullup(): 0001</code></td>
+  </tr>
+  <tr>
+    <td align="center">9</td>
+    <td align="left"><code>Interrupt 1 exit: 0000</code></td>
+  </tr>
+</table></ul>
+<p>
+  The numbered items are USB USB trace output.
+  You can look in the file <code>drivers/usbdev/usbdev_trprintf.c</code> to see examctly how each output line is formatted.
+  Here is how each line should be interpreted:
+</p>
+<ul><table>
+  <tr>
+    <th align="center">&nbsp</th>
+    <td align="left">USB EVENT ID</td>
+    <td align="right">8-bit<br>EVENT<br>DATA</td>
+    <td align="left">MEANING</td>
+    <td align="left">16-bit<br>EVENT<br>DATA</td>
+  </tr>
+  <tr>
+    <td align="center">1</td>
+    <td align="left"><code>TRACE_CLASSAPI_ID</code><sup>1</sup></td>
+    <td align="right">1</td>
+    <td align="left"><code>USBSER_TRACECLASSAPI_SETUP</code><sup>1</sup></td>
+    <td align="left">0000</td>
+  </tr>
+  <tr>
+    <td align="center">2</td>
+    <td align="left"><code>TRACE_CLSERROR_ID</code><sup>1</sup></td>
+    <td align="right">19</td>
+    <td align="left"><code>USBSER_TRACEERR_SETUPNOTCONNECTED</code><sup>1</sup></td>
+    <td align="left">0000</td>
+  </tr>
+  <tr>
+    <td align="center">3</td>
+    <td align="left"><code>TRACE_INTENTRY_ID</code><sup>1</sup></td>
+    <td align="right">1</td>
+    <td align="left"><code>LPC17_TRACEINTID_USB</code><sup>2</sup></td>
+    <td align="left">0039</td>
+  </tr>
+  <tr>
+    <td align="center">4</td>
+    <td align="left"><code>TRACE_INTDECODE_ID</code><sup>2</sup></td>
+    <td align="right">7</td>
+    <td align="left"><code>LPC17_TRACEINTID_DEVSTAT</code><sup>2</sup></td>
+    <td align="left">0019</td>
+  </tr>
+  <tr>
+    <td align="center">5</td>
+    <td align="left"><code>TRACE_INTDECODE_ID</code><sup>2</sup></td>
+    <td align="right">32</td>
+    <td align="left"><code>LPC17_TRACEINTID_SUSPENDCHG</code><sup>2</sup></td>
+    <td align="left">0019</td>
+  </tr>
+  <tr>
+    <td align="center">6</td>
+    <td align="left"><code>TRACE_INTDECODE_ID</code><sup>2</sup></td>
+    <td align="right">6</td>
+    <td align="left"><code>LPC17_TRACEINTID_DEVRESET</code><sup>2</sup></td>
+    <td align="left">0019</td>
+  </tr>
+  <tr>
+    <td align="center">7</td>
+    <td align="left"><code>TRACE_CLASS_ID</code><sup>1</sup></td>
+    <td align="right">3</td>
+    <td align="left"><code>(See TRACE_CLASSDISCONNECT</code><sup>1</sup>)</td>
+    <td align="left">0000</td>
+  </tr>
+  <tr>
+    <td align="center">8</td>
+    <td align="left"><code>TRACE_DEV_ID</code><sup>1</sup></td>
+    <td align="right">6</td>
+    <td align="left"><code>(See TRACE_DEVPULLUP</code><sup>1</sup>)</td>
+    <td align="left">0001</td>
+  </tr>
+  <tr>
+    <td align="center">9</td>
+    <td align="left"><code>TRACE_INTEXIT_ID</code><sup>1</sup></td>
+    <td align="right">1</td>
+    <td align="left"><code>LPC17_TRACEINTID_USB</code><sup>2</sup></td>
+    <td align="left">0000</td>
+  </tr>
+</table>
+<p><small><b>NOTES</b>:<br>
+  <sup>1</sup>See <code>include/nuttx/usb/usbdev_trace.h</code><br>
+  <sup>2</sup><code>See arch/arm/src/lpc17xx/lpc17_usbdev.c</code>
+</small></p>
+</ul>
+<p>
+  In the above example you can see that:
+</p>
+<ul>
+  <li><b>1</b>.
+    The serial class USB setup method was called for the USB serial class.
+    This is the corresponds to the following logic in <code>drivers/usbdev/usbdev_serial.c</code>:
+    <ul><pre>
+static int usbser_setup(FAR struct uart_dev_s *dev)
+{
+  ...
+  usbtrace(USBSER_CLASSAPI_SETUP, 0);
+  ...
+</pre></ul>
+  </li>
+  <li><b>2</b>.
+    An error occurred while processing the setup command because no configuration has yet been selected by the host.
+    This corresponds to the following logic in <code>drivers/usbdev/usbdev_serial.c</code>:
+    <ul><pre>
+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;
+    }
+  ...
+</pre></ul>
+  <li><b>3-6</b>.
+    Here is a USB interrupt that suspends and resets the device.
+  </li>
+  <li><b>7-8</b>.
+    During the interrupt processing the serial class is disconnected
+  </li>
+  <li><b>9</b>.
+    And the interrupt returns
+  </li>
+</ul>
+</body>
+</html>
author	patacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>	2011-02-25 18:46:06 +0000
committer	patacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>	2011-02-25 18:46:06 +0000
commit	0fc66dd545b21a2094f8d833955107d583bea953 (patch)
tree	0a859a014dec148a9c95db3f148b808b9c02ad6f /nuttx/Documentation
parent	d7ddd75cbe92d10263edaf505f8569834bf35c6a (diff)
download	px4-nuttx-0fc66dd545b21a2094f8d833955107d583bea953.tar.gz px4-nuttx-0fc66dd545b21a2094f8d833955107d583bea953.tar.bz2 px4-nuttx-0fc66dd545b21a2094f8d833955107d583bea953.zip