USB Developer's Kit

Release Notes

1.1.2

The Universal Serial Bus (USB) provides hosts and devices with a versatile channel for communication at low to moderate speeds. The USB Developer's Kit, also referred to as the USB Kit, shows you how to write your own USB host controller driver and USB device drivers. It is designed to allow the following:

• Easy portability to RTOSs other than VxWorks.

• Fast development of new host controller drivers.

• Easy portability to many BSPs.

Documentation for the USB Kit consists of the following manuals:

• USB Developer's Kit Release Notes, 1.1.2 (this document)

• USB Developer's Kit Programmer's Guide, 1.1.2

The USB Kit is available for the following combinations of hosts and targets:

Table 1:   Supported Hosts and Targets

Target Architecture	BSP	Host System PC (Windows)                                   UNIX (Sun-4)
PowerPC	mcp750	x                                                                    x
	mtx604	x                                                                    x
x86	pcPentium	x                                                                    x
MIPS	ddb5476 malta4kc malta4kec malta5kc	x                                                                    x

The following devices have been tested with the Wind River USB driver stack:

VxWorks board support packages (BSPs)

For a list of supported BSPs, see 3. Supported Hosts and Targets.

USB host controllers

Intel PIIX-3 (UHCI)
Via Technology 82C586 (UHCI)
SIIG PCI-to-USB add-in card (OHCI based on OPTi FireLink 82C861)
Lucent USS344S Quadrabus OHCI card (tested on pcPentium only)

USB hubs

Entrega hub 2U1S1P
SIIG USB MiniHub 4000P (Model No. US2228)

USB keyboards

Belkin USB keyboard
BTC Model 7932M
QTRONIX Scorpius 980NPIUS/980

USB mice

Belkin Mouse (Model No. F8E201-USB)
Kensington Mouse-in-a-Box USB (Model #MOSUU B)

USB printers

Epson Stylus Color 740
Hewlett-Packard DeskJet 812C

USB speakers

Philips DSS330
Lab-Tech 1040A

USB Mass Storage Class devices

Castlewood ORB USB 2.2GB drive (Bulk-Only implementation)
VST Technologies USB Floppy Drive (CBI implementation)
M-Systems FlashOnChip (Bulk-Only implementation)
Universal Smart Drive (Bulk-Only implementation)

USB network devices

SOHOware 10/100 USB Network Adapter (Pegasus-ADM Tek AM896 chip)

See the Tornado Getting Started Guide for general instructions on how to install the USB Kit, and all other Wind River products.

Install the relevant parts from the following list, according to your development requirements:

• USB Library Source

• USB Support Library: pentiumX

• USB Support Library: ppcXXX

• USB Support Libraries: mti4kx
                                            mti5kx
                                            vr54xx

Source files are created in the Tornado tree as follows:

target/config/bsp

The BSP-specific stubs for host controller access routines. The files are located in the directory corresponding to the appropriate BSP. See 3. Supported Hosts and Targets, for a list of supported BSPs.

target/config/comps/src

Source files (configlettes) for BSP-specific OHCI, host, and device initialization; and the testing applications usbTool and usbAudio.

target/config/comps/src/unsupported

Source files (configlettes) for KLSI, NetChip, and ACM devices, and for USB/UGL initialization. Note that these components are no longer supported in the USB Developer's Kit.

target/config/comps/vxworks

The component description file (.cdf). For more information about components, see the Tornado BSP Developer's Kit for VxWorks User's Guide, Tornado 2.0: Components.

target/h/drv/usb

Header files pertaining to the device drivers (printer, mouse, keyboard, speaker, network devices, and mass storage devices) and host controller drivers (OHCI, UHCI).

target/h/usb

Header files pertaining to the USBD and the OS abstraction module.

target/src/drv/usb

Source files pertaining to the device drivers (printer, mouse, keyboard, speaker, network devices, and mass storage devices) and host controller drivers (OHCI, UHCI).

target/src/drv/usb/unsupported

Source files for the KLSI, NetChip, and ACM device drivers.

target/src/usb

Source files pertaining to the USBD and the OS abstraction module.

target/src/usb/tools

Source files pertaining to usbTool, a test utility that exercises the USB and supported devices.

Object archives (called libusb.a) are created in the appropriate architecture-specific directories under target/lib:

• target/lib/pentium/PENTIUMx/common

• target/lib/mips/MIPSxx/xxcommonxx

• target/lib/ppc/PPCxxx/common

Some run-time issues have been encountered with the following BSPs.

• ddb5476

The CBI floppy device and driver do not function correctly on this target.

• mcp750

• In order for your MCP750 target to work with USB, you must do the following:

1. Make sure your target board is Revision C or later. To ascertain your revision status, check the artwork on the bottom/backside of the board, next to the bottom ejector. For example, if the revision number is 84-W8288F01C Fab Rev A, it is the "C" that follows the 84-alphanumeric that indicates the revision.

2. Use a boot ROM that does not include USB in the exclude list. To do this, in the sysPciAutoConfigInclude( ) routine in the target/config/mcp750/sysBusPci.c file, change the return value of the PCI_ID_USB case from ERROR to OK. For more information and for instructions on building a new boot ROM, see target.nr.

Wind River is committed to meeting the needs of its customers. As part of that commitment, Wind River provides a variety of services, including training courses and contact with customer support engineers, along with a Web site containing the latest advisories, FAQ lists, known problems lists, and other valuable information resources.

Customer Support

For customers holding a maintenance contract, Wind River offers direct contact with a staff of software engineers experienced in Wind River products. A full description of the Customer Support program is described in the Customer Support User's Guide available at the following Web site:

http://www.windriver.com/support

The Customer Support User's Guide describes the services that Customer Support can provide, including assistance with installation problems, product software, documentation, and service errors.

You can reach Customer Support using either of the following methods:

• E-mail.  

You can contact Wind River Customer Support by sending e-mail to support@windriver.com.

• 1-800-872-4977  (1-800-USA-4WRS) .  

Within North America, you can contact Customer Support with a toll-free voice telephone call. For telephone access outside North America, see the Support Web site shown above.

For Customer Support contact information specific to your products, please visit the Support Web site.

WindSurf

Wind River Customer Services also provides WindSurf, an online support service available under the Support Web site. WindSurf offers basic services to all Wind River customers, including advisories, publications such as the Customer Support User's Guide, and a list of training courses and schedules. For maintenance contract holders, WindSurf also provides access to additional services, including known problems lists, available patches, answers to frequently asked questions, and demo code.