USB config options

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@971 42af7a65-404d-4744-a932-0658087f49c3

Documentation/NuttxPortingGuide.html

@@ -16,7 +16,7 @@
   </b></big></h1>
   <p><small>by</small></p>
   <p>Gregory Nutt</p>
-  <p><small>Last Update: September 17, 2008</small></p>
+  <p><small>Last Update: October 1, 2008</small></p>
 </center>
 
 <center><h1>Table of Contents</h1></center>
@@ -1627,6 +1627,31 @@ The system can be re-made subsequently by just typing <code>make</code>.
   </li>
 </ul>
 
+<h2>USB device controller driver</h2>
+<ul>
+  <li>
+    <code>CONFIG_USBDEV</code>: Enables USB device support
+  </li>
+  <li>
+    <code>CONFIG_USBDEV_ISOCHRONOUS</code>: Build in extra support for isochronous endpoints
+  </li>
+  <li>
+    <code>CONFIG_USBDEV_DUALSPEED</code>: Hardware handles high and full speed operation (USB 2.0)
+  </li>
+  <li>
+    <code>CONFIG_USBDEV_SELFPOWERED</code>: Will cause USB features to indicate that the device is self-powered
+  </li>
+  <li>
+    <code>CONFIG_USBDEV_MAXPOWER</code>: Maximum power consumption in mA
+  </li>
+  <li>
+    <code>CONFIG_USBDEV_TRACE</code>: Enables USB tracing for debug
+  </li>
+  <li>
+    <code>CONFIG_USBDEV_TRACE_NRECORDS</code>: Number of trace entries to remember
+  </li>
+</ul>
+
 <h2>Stack and heap information</h2>
 
 <ul>

configs/README.txt

@@ -290,6 +290,18 @@ defconfig -- This is a configuration file similar to the Linux
 		CONFIG_NET_DHCP_LIGHT - Reduces size of DHCP
 		CONFIG_NET_RESOLV_ENTRIES - Number of resolver entries
 
+	USB device controller driver
+		CONFIG_USBDEV - Enables USB device support
+		CONFIG_USBDEV_ISOCHRONOUS - Build in extra support for isochronous
+		  endpoints
+		CONFIG_USBDEV_DUALSPEED -Hardware handles high and full speed
+		  operation (USB 2.0)
+		CONFIG_USBDEV_SELFPOWERED - Will cause USB features to indicate
+		  that the device is self-powered
+		CONFIG_USBDEV_MAXPOWER - Maximum power consumption in mA
+		CONFIG_USBDEV_TRACE - Enables USB tracing for debug
+		CONFIG_USBDEV_TRACE_NRECORDS - Number of trace entries to remember
+
 	Stack and heap information
 
 		CONFIG_BOOT_FROM_FLASH - Some configurations support XIP

configs/mcu123-lpc214x/README.txt

@@ -30,11 +30,72 @@ Where <subdir> is one of the following:
 
 ostest
 ^^^^^^
+
 This configuration directory, performs a simple OS test using
 examples/ostest.
 
 nsh
 ^^^
+
 Configures the NuttShell (nsh) located at examples/nsh.  The
 Configuration enables only the serial NSH interfaces.
 
+Configuration Options
+^^^^^^^^^^^^^^^^^^^^^
+
+In additional to the common configuration options listed in the
+file configs/README.txt, there are other configuration options
+specific to the LPC214x:
+
+ CONFIG_ARCH - identifies the arch subdirectory and, hence, the
+   processor architecture.
+ CONFIG_ARCH_name - for use in C code.  This identifies the
+   particular chip or SoC that the architecture is implemented
+   in.
+ CONFIG_ARCH_CHIP - Identifies the arch/*/chip subdirectory
+ CONFIG_ARCH_CHIP_name - For use in C code
+ CONFIG_ARCH_BOARD - identifies the configs subdirectory and, hence,
+   the board that supports the particular chip or SoC.
+ CONFIG_ENDIAN_BIG - define if big endian (default is little endian)
+ CONFIG_ARCH_BOARD_name - for use in C code
+ CONFIG_BOARD_LOOPSPERMSEC - for delay loops
+ CONFIG_ARCH_LEDS - Use LEDs to show state. Unique to lpc2148.
+ CONFIG_DRAM_SIZE - Describes the internal DRAM.
+ CONFIG_DRAM_START - The start address of internal DRAM
+ CONFIG_ARCH_STACKDUMP - Do stack dumps after assertions
+
+LPC2148 specific chip initialization
+
+ CONFIG_EXTMEM_MODE, CONFIG_RAM_MODE. CONFIG_CODE_BASE, CONFIG_PLL_SETUP,
+ CONFIG_MAM_SETUP, CONFIG_APBDIV_SETUP, CONFIG_EMC_SETUP,. CONFIG_BCFG0_SETUP,
+ CONFIG_BCFG1_SETUP, CONFIG_BCFG2_SETUP, CONFIG_BCFG3_SETUP, CONFIG_ADC_SETUP
+
+LPC214X UART device driver settings
+
+ CONFIG_UARTn_SERIAL_CONSOLE - selects the UARTn for the
+   console and ttys0 (default is the UART0).
+ CONFIG_UARTn_RXBUFSIZE - Characters are buffered as received.
+   This specific the size of the receive buffer
+ CONFIG_UARTn_TXBUFSIZE - Characters are buffered before
+   being sent.  This specific the size of the transmit buffer
+ CONFIG_UARTn_BAUD - The configure BAUD of the UART.  Must be
+ CONFIG_UARTn_BITS - The number of bits.  Must be either 7 or 8.
+ CONFIG_UARTn_PARTIY - 0=no parity, 1=odd parity, 2=even parity, 3=mark 1, 4=space 0
+ CONFIG_UARTn_2STOP - Two stop bits
+
+LPC214X USB Configuration
+
+ CONFIG_LPC214X_USBDEV_FRAME_INTERRUPT
+   Handle USB Start-Of-Frame events.
+   Enable reading SOF from interrupt handler vs. simply reading on demand.
+   Probably a bad idea... Unless there is some issue with sampling the SOF
+   from hardware asynchronously.
+ CONFIG_LPC214X_USBDEV_EPFAST_INTERRUPT
+   Enable high priority interrupts.  I have no idea why you might want to
+   do that
+ CONFIG_LPC214X_USBDEV_NDMADESCRIPTORS
+   Number of DMA descriptors to allocate in the 8Kb USB RAM.  This is a
+   tradeoff between the number of DMA channels that can be supported vs
+   the size of the DMA buffers available.
+ CONFIG_LPC214X_USBDEV_DMA
+   Enable lpc214x-specific DMA support

configs/ntosd-dm320/README.txt

@@ -13,27 +13,77 @@ Where <subdir> is one of the following:
 
 ostest
 ^^^^^^
+
 This configuration directory, performs a simple OS test using
 examples/ostest.
 
 nsh
 ^^^
+
 Configures the NuttShell (nsh) located at examples/nsh.  The
 Configuration enables both the serial and telnetd NSH interfaces.
 
 nettest
 ^^^^^^^
+
 This alternative configuration directory may be used to
 enable networking using the OSDs DM9000A Ethernet interface.
 It uses examples/nettest to excercise the TCP/IP network.
 
 uip
 ^^^
+
 This configuration file demonstrates the tiny webserver
 at examples/uip.
 
 udp
 ^^^
+
 This alternative configuration directory is similar to nettest
 except that is use examples/upd to exercise UDP.
 
+Configuration Options
+^^^^^^^^^^^^^^^^^^^^^
+
+In additional to the common configuration options listed in the
+file configs/README.txt, there are other configuration options
+specific to the DM320:
+
+ CONFIG_ARCH - identifies the arch subdirectory and, hence, the
+   processor architecture.
+ CONFIG_ARCH_name - for use in C code.  This identifies the
+   particular chip or SoC that the architecture is implemented
+   in.
+ CONFIG_ARCH_CHIP - Identifies the arch/*/chip subdirectory
+ CONFIG_ARCH_CHIP_name - For use in C code
+ CONFIG_ARCH_BOARD - identifies the configs subdirectory and, hence,
+   the board that supports the particular chip or SoC.
+ CONFIG_ENDIAN_BIG - define if big endian (default is little endian)
+ CONFIG_ARCH_BOARD_name - for use in C code
+ CONFIG_BOARD_LOOPSPERMSEC - for delay loops
+ CONFIG_ARCH_LEDS - Use LEDs to show state. Unique to lpc2148.
+ CONFIG_DRAM_SIZE - Describes the internal DRAM.
+ CONFIG_DRAM_START - The start address of internal DRAM
+ CONFIG_ARCH_STACKDUMP - Do stack dumps after assertions
+
+DM320 specific device driver settings
+
+ CONFIG_UARTn_SERIAL_CONSOLE - selects the UARTn for the
+   console and ttys0 (default is the UART0).
+ CONFIG_UARTn_RXBUFSIZE - Characters are buffered as received.
+   This specific the size of the receive buffer
+ CONFIG_UARTn_TXBUFSIZE - Characters are buffered before
+   being sent.  This specific the size of the transmit buffer
+ CONFIG_UARTn_BAUD - The configure BAUD of the UART.  Must be
+ CONFIG_UARTn_BITS - The number of bits.  Must be either 7 or 8.
+ CONFIG_UARTn_PARTIY - 0=no parity, 1=odd parity, 2=even parity
+ CONFIG_UARTn_2STOP - Two stop bits
+
+DM320 USB Configuration
+
+ CONFIG_DM320_GIO_USBATTACH
+   GIO that detects USB attach/detach events
+ CONFIG_DM320_GIO_USBDPPULLUP
+   GIO connected to D+.  Support software connect/disconnect.
+ CONFIG_DMA320_USBDEV_DMA
+   Enable DM320-specific DMA support