USB Developer's Kit

Programmer's Guide

1.1.2

1 USB Host Stack

1.1 Introduction

1.1.1 System Requirements

1.1.2 Documentation

Reference Manual Entries

Related Documentation

1.2 Architecture Overview

Host Module Roadmap

1.3 The USB Host Driver (USBD)

1.3.1 Initializing the USBD

Attaching and Detaching HCDs

Order of Initialization

Bus Tasks

Registering Client Modules

Dynamic Attachment Registration

Device Configuration

Data Flow

1.3.2 USBD Internals

Hub Management

New Device Connections

1.4 The USB Host Controller Driver (HCD)

1.4.1 HCD Header File

1.4.2 HCD Entry Point

1.4.3 Host Request Blocks (HRB)

HCD_FNC_ATTACH

HCD_FNC_DETACH

HCD_FNC_BUS_RESET

HCD_FNC_SET_BUS_STATE

HCD_FNC_SOF_INTERVAL_GET and HCD_FNC_SOF_INTERVAL_SET

HCD_FNC_PIPE_CREATE

HCD_FNC_PIPE_DESTROY

HCD_FNC_PIPE_MODIFY

HCD_FNC_CURRENT_FRAME_GET

HCD_FNC_IRP_SUBMIT

HCD_FNC_IRP_CANCEL

1.4.4 Management Events

1.4.5 HCD Error Reporting Conventions

1.4.6 Root Emulation

1.4.7 IRP Timeouts

1.5 Keyboard Driver

1.5.1 SIO Driver Model

1.5.2 Dynamic Attachment

1.5.3 Initialization

1.5.4 ioctl Functions

1.5.5 Data Flow

1.5.6 Typematic Repeat

1.6 Mouse Driver

1.6.1 SIO Driver Model

1.6.2 Dynamic Attachment

1.6.3 Initialization

1.6.4 ioctl Functions

1.6.5 Data Flow

1.7 Printer Driver

1.7.1 SIO Driver Model

1.7.2 Dynamic Attachment

1.7.3 Initialization

1.7.4 ioctl Functions

1.7.5 Data Flow

1.8 Speaker Driver

1.8.1 SEQ_DEV Driver Model

1.8.2 Dynamic Attachment

1.8.3 Initialization

1.8.4 Recognizing and Handling USB Speakers

1.8.5 ioctl Functions

1.8.6 Data Flow

1.9 Mass Storage Class Driver

1.9.1 Block Device Driver Model

1.9.2 Dynamic Attachment

1.9.3 Initialization

1.9.4 Data Flow

1.10 Communication Class Drivers

1.10.1 Ethernet Networking Control Model Driver

Enhanced Network Driver Model

Dynamic Attachment

Initialization

Interrupt Behavior

ioctl Functions

Data Flow

1.10.2 Abstract Control Model Driver

SIO Driver Model

Dynamic Attachment

Initialization

Interrupt Behavior

ioctl Functions

Data Flow

Modem Control: Hayes Commands

1.11 Running the USB Kit

1.12 Initialization

1.12.1 Host Stack and Host Controller Initialization

1.12.2 Device Initialization

Keyboard, Mouse, Printer, and Speaker Initialization

Mass Storage Class Device Initialization

Communication Class Device Initialization

1.12.3 usbAudio Initialization

1.12.4 usbTool Code Exerciser

Running usbTool from the Shell

The usbTool Execution Sequence

1.13 Booting VxWorks Through a Communication Class Driver

1.14 Benchmarking Information

1.15 BSP Porting Issues

1.15.1 Configuring USB Hardware

BSPs with pciAutoConfigLib

BSPs Without pciAutoConfigLib

1.15.2 Configuring Memory Address Windows

1.15.3 Creating BSP-Specific Stub usbPciLib Files

2 USB Peripheral Stack

Tested Devices

2.1 Peripheral Stack Architecture

Peripheral Module Roadmap

2.2 USB Target Driver (usbTargLib)

2.2.1 Initializing usbTargLib

2.2.2 Attaching and Detaching TCDs

2.2.3 Enabling and Disabling TCDs

2.2.4 Target Application Callback Table

mngmtFunc( ) Callback

Control Pipe Request Callbacks

2.2.5 TCD Endpoints

2.2.6 Data Transfer

Control Pipe Data Transfers

General Data Transfers

2.2.7 Setting Endpoint Stall

2.2.8 Bus Frame Number

2.2.9 Resume Signaling

2.3 USB Target Controller Driver

2.3.1 TCD Header File

2.3.2 TCD Entry Point

2.3.3 Target Request Block (TRB)

TCD_FNC_ATTACH

TCD_FNC_DETACH

TCD_FNC_ENABLE

TCD_FNC_DISABLE

TCD_FNC_ADDRESS_SET

TCD_FNC_ENDPOINT_ASSIGN

TCD_FNC_ENDPOINT_RELEASE

TCD_FNC_SIGNAL_RESUME

TCD_FNC_ENDPOINT_STATE_SET

TCD_FNC_CURRENT_FRAME_GET

TCD_FNC_ERP_SUBMIT

TCD_FNC_ERP_CANCEL

2.3.4 TCD Management Events

2.3.5 TCD Error Reporting Conventions

2.4 Installing the USB Peripheral Stack

2.5 Running the USB Peripheral Stack

2.5.1 Creating a Downloadable VxWorks Image Including USB

2.5.2 Creating a Downloadable USB Application

2.6 Working with usbTool

The usbTool Execution Sequence

2.7 BSP-Specific Issues