Texas Instruments BIOSUSB User manual

Template Version 1.4
User Guide
BIOSUSB User Guide
01.10.01

Page 2 of 21
BIOSUSB Release Notes
This page has been intentionally left blank.

Page 3 of 21
BIOSUSB Release Notes
IMPORTANT NOTICE
Texas Instruments Incorporated and its subsidiaries (TI) reserve the right to make
corrections, modifications, enhancements, improvements, and other changes to its products
and services at any time and to discontinue any product or service without notice.
Customers should obtain the latest relevant information before placing orders and should
verify that such information is current and complete. All products are sold subject to TI’s
terms and conditions of sale supplied at the time of order acknowledgment.
TI warrants performance of its hardware products to the specifications applicable at the
time of sale in accordance with TI’s standard warranty. Testing and other quality control
techniques are used to the extent TI deems necessary to support this warranty. Except
where mandated by government requirements, testing of all parameters of each product is
not necessarily performed.
TI assumes no liability for applications assistance or customer product design. Customers
are responsible for their products and applications using TI components. To minimize the
risks associated with customer products and applications, customers should provide
adequate design and operating safeguards.
TI does not warrant or represent that any license, either express or implied, is granted
under any TI patent right, copyright, mask work right, or other TI intellectual property right
relating to any combination, machine, or process in which TI products or services are used.
Information published by TI regarding third–party products or services does not constitute a
license from TI to use such products or services or a warranty or endorsement thereof. Use
of such information may require a license from a third party under the patents or other
intellectual property of the third party, or a license from TI under the patents or other
intellectual property of TI.
Reproduction of information in TI data books or data sheets is permissible only if
reproduction is without alteration and is accompanied by all associated warranties,
conditions, limitations, and notices. Reproduction of this information with alteration is an
unfair and deceptive business practice. TI is not responsible or liable for such altered
documentation.
Resale of TI products or services with statements different from or beyond the parameters
stated by TI for that product or service voids all express and any implied warranties for the
associated TI product or service and is an unfair and deceptive business practice. TI is not
responsible or liable for any such statements.
Mailing Address:
Texas Instruments
Post Office Box 655303
Dallas, Texas 75265
Copyright ©2008, Texas Instruments Incorporated

Page 4 of 21
BIOSUSB User Guide
This page has been intentionally left blank.

Page 5 of 21
BIOSUSB User Guide
TABLE OF CONTENTS
1 Introduction................................................................................................. 7
1.1 Terms & Abbreviations............................................................................7
1.2 References ............................................................................................7
2 Installation Guide......................................................................................... 8
2.1 System Requirements.............................................................................8
2.2 Installation and configuration of dependent packages. ................................8
3 Folder Structure ......................................................................................... 10
4 USB Host Stack Architecture ...................................................................... 12
4.1 Host Core Stack ...................................................................................12
4.2 Host Class (MSC) Driver........................................................................12
4.3 Host Class (HID) Driver.........................................................................12
4.4 Host Generic Services ...........................................................................13
4.5 Platform Abstraction and Native OS Abstraction .......................................13
4.6 Host Stack Component Libraries and Dependencies ..................................13
4.7 Host Stack Component Build Options ......................................................13
4.8 Platform specific library.........................................................................14
4.9 Use Case: USB Host Mass Storage Functionality.......................................14
4.10 Use Case: USB Host HID Functionality ....................................................14
5 USB Device Stack Architecture ................................................................... 15
5.1 Device Core Stack ................................................................................15
5.2 Device (MSC) Function Driver ................................................................15
5.3 Device (HID) Function Driver.................................................................15
5.4 Device Generic Services ........................................................................15
5.5 Platform Abstraction and Native OS Abstraction .......................................16
5.6 Device Stack Component Libraries and Dependencies ...............................16
5.7 Device Stack Component Build Options ...................................................16
5.8 Use Case: USB Device Mass Storage Functionality....................................17
5.9 Use Case: USB Device HID Functionality .................................................17
6 Building and Running USB Application Example ......................................... 18
6.1 Building the USB MSC Device example for NAND OR MMC/SD OR
SATA. .................................................................................................18
6.2 Building the USB HID (keyboard) Device example. ...................................19
6.3 Building the USB Host Mass Storage example. .........................................19
6.4 Building the USB Host HID (keyboard/mouse) example.............................20
7 Technical Support BIOSUSB ....................................................................... 21

Page 6 of 21
BIOSUSB User Guide

Page 7 of 21
BIOSUSB User Guide
1 Introduction
The BIOS USB Package (based on JUNGO USB stack) provides capability to incorporate a
USB host or USB device functionality for an embedded device. This document describes the
USB host and device stack architecture, installation procedure and example use cases in TI
BIOS environment.
The BIOSUSB package supports both CCS3 and CCS4 for the following platforms
C6747/OMAPL137
C6748/OMAPL138
1.1 Terms & Abbreviations
Term Description
API Application Programming Interface
Port Platform and Operating system abstraction layer
JOS USB general services module
USB Device Platform capable of performing USB device functionality
USB Host Platform capable of performing USB host functionality
MSC Mass Storage Class
USB Universal Serial Bus
USBware Product name of Jungo’s USB host and device stack
1.2 References
#Document Description
1usb_device_stack.pdf USBware device stack details
2usb_host_stack.pdf USBware host stack details
3mass_storage_class_driver.pdf USBware mass storage driver details
4mass_storage_fd.pdf USBware mass storage function driver details
5hid_class_driver.pdf HID Class driver details
6hid_keyboard_fd.pdf HID keyboard function driver details
7hid_fd_lib.pdf HID function driver library reference

Page 8 of 21
BIOSUSB User Guide
2 Installation Guide
This chapter discusses the BIOS USB package installation procedure and how to
configure and run the usb host or device sample example provided along with the
package, refer to section-6.
2.1 System Requirements
The following products are required to be installed prior to using the BIOSUSB
Package for C6747/OMAPL37 and C6748/OMAPL138 platform:
For CCS3 Environment
CCS 3.3.80.11 (service release 10)
DSP-BIOS versioned 5.41.02.14
Code Generation Tools 6.1.9
EVM C6747/OMAPL37 (Rev-D recommended) or C6748/OMAPL138 Board
(Beta- version recommended)
XDS 510 USB Emulator (Optional) – EVM has on board emulator
For CCS4 Environment
CCS4 version 4.0.0.16000
DSP-BIOS versioned 5.41.02.14
XDS 510 USB Emulator (Optional) – EVM has on board emulator
Dependent Packages
EDMA 3 LLD – versioned 01.11.00.02
ERTFS File System package versioned 1.10.00.30 or higher version
PSP_DRIVERS Package - The BIOSPSP GA Package with versioned 1.30.00
2.2 Installation and configuration of dependent packages.
BIOS USB package is dependent on the following packages and as such expects
these packages to be installed and configured correctly prior to its installation and
usage.
I. EDMA3 LLD Driver package
II. RTFS package – Required for BIOS USB Host functionality. RTFS package is
needed for supporting MSC devices such as USB sticks, USB HDD’s etc.
III. PSP_DRIVERS Package
1. Install EDMA-3 LLD Driver into preferred drive/folder. Please refer the EDMA3
package installation guide. The environment variable ‘
EDMA3LLD_BIOS5_INSTALLDIR’ is used in the sample application projects for
referring to the EDMA3 driver libraries. This environment variable is created and
updated by the EDMA3 LLD driver during its installation. Please ensure that this
environment variable is pointing to the EDMA3 LLD install directory intended to be
used along with this package. This is more important when there are multiple EDMA
LLD installations as the installer updates this environment variable with latest
installation version. (eg. If EDMA LLD driver is installed into c:\edma3_lld\ the
environment variable is set to EDMA3LLD_BIOS5_INSTALLDIR=c:\edma3_lld).

Page 9 of 21
BIOSUSB User Guide
2. Install the RTFS Driver into preferred drive/folder. Please refer to the RTFS package
installation guide. The environment variable ‘RTFS_INSTALL_DIR’ is used in the
sample application project for referring to RTFS driver libraries. Please ensure that
this environment variable is pointing to the RTFS install directory intended to be used
along with this package.
3. Install BIOSPSP Package Driver into preferred drive/folder. Please refer to PSP
driver’s installation procedure. The environment variable
‘PSP_DRIVERS_INSTALL_DIR’ is used in the sample application project for referring
to libraries of PSP components like block media, PSC, platforms, MMC/SD, NAND, I2C
etc. Please ensure that this environment variable is pointing to the install directory of
PSP component intended to be used along with this package. (eg. If BIOSPSP
package is installed into c:\pspdrivers_1_30_00_06\ the environment variable is set
to PSP_DRIVERS_INSTALL_DIR = c:\pspdrivers_1_30_00_06).
4. Install the BIOS USB package using the self extracting installer. Figure-1 shows the
directory structure of BIOS USB Package after the installation. The installer will
create BIOSUSB_INSTALL_DIR environment variable pointing to BIOSUSB
installation directory. This environment variable is used in USB Host MSC application
examples of RTFS package.

Page 10 of 21
BIOSUSB User Guide
3 Folder Structure
Figure 1 illustrates the folder structure and placement of the BIOS USB package.
Figure 1: BIOSUSB directory structure
The folder ‘biosusb’ contains the following components