OSPlus USB 2.0 extension Data brief Application VFS FAT Ext2 LVM Device layer Device drivers TCP/IP stack NexGenOS NexGenIP NexGenRemote NexGenResolve NexGenBoot NexGenPPP USB stack OSPlus interface Class drivers Protocol stack Host controller Registry Hardware Description The OSPlus USB 2.0 extension supports STMicroelectronics ST20, ST40 and ST200 based devices that have an integrated USB controller. Compatible with the ST operating systems OS20 and OS21 it enables USB devices to be hot plugged into embedded systems. Low speed (1 Mbits/s, USB 1.0), full speed (12 Mbit/s, USB 1.1) and high speed (480 Mbit/s, USB 2.0) transmission protocols are supported. A single function call is used to initialize the ST USB 2.0 extension. Devices connected to the USB bus are automatically detected by the extension. Features Supports OS20/OS21 with OSPlus Supports ST20/ST40/ST200 based devices with onboard EHCI and OHCI USB controllers Supports USB control, bulk, isochronous and interrupt transfers Built-in support for: hubs human interface devices (HIDs) for example, mouse, keyboard and joystick mass storage communications (host-to-host, Ethernet, serial, cable modem) other devices supportable through user written class drivers 16 February 2011 7801961 Rev E 1/9 For further information contact your local STMicroelectronics sales office. www.st.com 9
Contents 1 Introduction................................................ 3 1.1 Data transfer................................................ 3 1.2 Prerequisites............................................... 3 2 OSPlus base package and optional extensions................... 4 3 ST USB 2.0 extension functionality............................. 5 4 Ordering information........................................ 6 Acknowledgements................................................... 7 Revision history..................................................... 8 2/9 7801961 Rev E
1 Introduction The ST USB 2.0 extension supports STMicroelectronics ST20, ST40 and ST200 based devices that have integrated USB controllers. It enables hot-plugging of USB devices in embedded systems that are running OS20 or OS21 together with the OSPlus base package. The ST USB 2.0 extension supports low speed (1 Mbit/s), full speed (12 Mbit/s) and high speed (480 Mbit/s) transmission protocols. Support is provided for many common USB peripherals. It is also possible to write new device drivers to enable unsupported devices. 1.1 Data transfer Data transfer between the host and the devices attached to it, is managed by a packetbased signaling protocol that defines four types of data transfer. Control transfers, used to configure newly attached devices, and may be used for implementation of specific tasks. Bulk transfers, used for sequential, high volume data exchanges with data intensive devices that have no specific scheduling or transfer-rate requirements. Interrupt transfers for limited latency transfers of interrupt orientated devices such as keyboards and mice. Isochronous transfers for data that requires timing and a constant delivery rate. USB is designed to give such transfers high priority. 1.2 Prerequisites An ST20, ST40 or ST200 based device with an integrated USB host controller (compliant with the relevant standard). OSPlus base package (provided free of charge, packaged with the TCP/IP extension). OS20 or OS21 operating system and appropriate toolset. 7801961 Rev E 3/9
2 OSPlus base package and optional extensions The extension package requires the OSPlus base package. The base package is supplied free of charge with the extension package. For details of the base package, see OSPlus Enhancement package for OS20/OS21 data brief (ADCS 7813502). For details of the TCP/IP optional extension package, see TCP/IP Extension for OSPlus data brief (ADCS 7816153). 4/9 7801961 Rev E
3 ST USB 2.0 extension functionality The ST USB 2.0 software extension provides three layers of functionality. Class module layer Core USB protocol layer Hardware interface layer This topmost layer is responsible for controlling specific types, or classes of devices. It manages device transfer requests and performs services such as device-driver configuration management and class-driver selection. It also handles protocol interpretation and responds to application software requests. This layer is responsible for scheduling and USB protocol management functions. It also determines how efficiently the product architecture carries out key USB management tasks, such as host-state handling and isochronous prioritization. All USB protocols are supported, as are complex USB devices that contain multiple configurations/interfaces and alternate settings. This lowest layer is the hardware controller driver, which interfaces with the hardware controllers. On initialization the extension locates all host controllers and initializes them. A separate device instance is registered for each supported USB device found on the bus. As each host controller is initialized, any devices attached to the USB are enumerated. This process involves querying the device to determine what it is and selecting an appropriate class driver to manage the device. When an appropriate class driver is found, the device interface and endpoints are configured. If no appropriate class driver can be found, then the device is ignored until it is removed. When a supported device is configured ready for use, it is registered with the device library. This allows user code to open the device and perform I/O. When a supported device is removed from the USB, the class driver managing the device is stopped and the device is unregistered from the device library. Any I/O being performed on the extracted device (and any future I/O) fails. The only permitted operation on an open device that has been extracted is closing the device. The following device classes are supported: hubs human interface devices (HIDs) for example, mouse, keyboard and joystick mass storage communications (host-to-host, Ethernet, serial, cable modem) Other devices are supportable through user written class drivers. 7801961 Rev E 5/9
4 Ordering information Table 1. Order numbers Description Order number OSPlus ST20 USB Extension. OSPlus ST40 USB Extension. STORM-USB20/20 STORM-USB20/40 Please contact your nearest STMicroelectronics regional sales office or local FAE. 6/9 7801961 Rev E
Acknowledgements The ST TCP/IP extension is based on technology developed by NexGen. NexGen is a registered trademark of NexGen Software. 7801961 Rev E 7/9
Revision history Table 2. Document revision history Date Revision Changes 15-Feb-2011 E Update to latest template. Minor changes to formatting 17-Mar-2010 D Minor changes to formatting 5-Nov-2007 C Updated to new template 3-Oct-2006 B 14-Feb-2005 A Initial release. Throughout: Updated built-in support Introduction: USB low speed (1 Mbit/s) added 8/9 7801961 Rev E
Please Read Carefully: Information in this document is provided solely in connection with ST products. STMicroelectronics NV and its subsidiaries ( ST ) reserve the right to make changes, corrections, modifications or improvements, to this document, and the products and services described herein at any time, without notice. All ST products are sold pursuant to ST s terms and conditions of sale. Purchasers are solely responsible for the choice, selection and use of the ST products and services described herein, and ST assumes no liability whatsoever relating to the choice, selection or use of the ST products and services described herein. No license, express or implied, by estoppel or otherwise, to any intellectual property rights is granted under this document. If any part of this document refers to any third party products or services it shall not be deemed a license grant by ST for the use of such third party products or services, or any intellectual property contained therein or considered as a warranty covering the use in any manner whatsoever of such third party products or services or any intellectual property contained therein. UNLESS OTHERWISE SET FORTH IN ST S TERMS AND CONDITIONS OF SALE ST DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY WITH RESPECT TO THE USE AND/OR SALE OF ST PRODUCTS INCLUDING WITHOUT LIMITATION IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE (AND THEIR EQUIVALENTS UNDER THE LAWS OF ANY JURISDICTION), OR INFRINGEMENT OF ANY PATENT, COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT. UNLESS EXPRESSLY APPROVED IN WRITING BY AN AUTHORIZED ST REPRESENTATIVE, ST PRODUCTS ARE NOT RECOMMENDED, AUTHORIZED OR WARRANTED FOR USE IN MILITARY, AIR CRAFT, SPACE, LIFE SAVING, OR LIFE SUSTAINING APPLICATIONS, NOR IN PRODUCTS OR SYSTEMS WHERE FAILURE OR MALFUNCTION MAY RESULT IN PERSONAL INJURY, DEATH, OR SEVERE PROPERTY OR ENVIRONMENTAL DAMAGE. ST PRODUCTS WHICH ARE NOT SPECIFIED AS "AUTOMOTIVE GRADE" MAY ONLY BE USED IN AUTOMOTIVE APPLICATIONS AT USER S OWN RISK. Resale of ST products with provisions different from the statements and/or technical features set forth in this document shall immediately void any warranty granted by ST for the ST product or service described herein and shall not create or extend in any manner whatsoever, any liability of ST. ST and the ST logo are trademarks or registered trademarks of ST in various countries. Information in this document supersedes and replaces all information previously supplied. The ST logo is a registered trademark of STMicroelectronics. All other names are the property of their respective owners. 2011 STMicroelectronics - All rights reserved STMicroelectronics group of companies Australia - Belgium - Brazil - Canada - China - Czech Republic - Finland - France - Germany - Hong Kong - India - Israel - Italy - Japan - Malaysia - Malta - Morocco - Philippines - Singapore - Spain - Sweden - Switzerland - United Kingdom - United States of America www.st.com 7801961 Rev E 9/9