Texas Instruments TUSB5052 User manual

  

  



February 2004 MSDS Bus Solutions

User’s Guide

SLLU021A

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,

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.

Following are URLs where you can obtain information on other Texas Instruments products and application

solutions:

Products Applications

Amplifiers amplifier.ti.com Audio www.ti.com/audio

Data Converters dataconverter.ti.com Automotive www.ti.com/automotive

DSP dsp.ti.com Broadband www.ti.com/broadband

Interface interface.ti.com Digital Control www.ti.com/digitalcontrol

Logic logic.ti.com Military www.ti.com/military

Power Mgmt power.ti.com Optical Networking www.ti.com/opticalnetwork

Microcontrollers microcontroller.ti.com Security www.ti.com/security

Telephony www.ti.com/telephony

Video & Imaging www.ti.com/video

Wireless www.ti.com/wireless

Mailing Address: Texas Instruments

Post Office Box 655303 Dallas, Texas 75265

Notational Conventions

iii

Preface



About This Manual

This user’s guide contains pertinent information about the bootcode process

of the TUSB5052.

How to Use This Manual

This document contains the following chapters:

-Chapter 1—Introduction

-Chapter 2—TUSB5052 USB Firmware Flow

-Chapter 3—Function

-Chapter 4—Bootcode Defaults

-Chapter 5—Header Format and Vendor USB Request

-Chapter 6—Programming Considerations and Bootcode File List

Notational Conventions

This document uses the following conventions.

-Program listings, program examples, and interactive displays are shown

in a special typeface similar to a typewriter’s. Examples use a bold

version of the special typeface for emphasis; interactive displays use a

bold version of the special typeface to distinguish commands that you

enter from items that the system displays (such as prompts, command

output, error messages, etc.).

Here is a sample program listing:

0011 0005 0001 .field 1, 2

0012 0005 0003 .field 3, 4

0013 0005 0006 .field 6, 3

0014 0006 .even

Here is an example of a system prompt and a command that you might

enter:

C: csr −a /user/ti/simuboard/utilities

FCC Warning

-In syntax descriptions, the instruction, command, or directive is in a bold

typeface font and parameters are in an italic typeface. Portions of a syntax

that are in bold should be entered as shown; portions of a syntax that are

in italics describe the type of information that should be entered. Here is

an example of a directive syntax:

.asect ”section name”, address

.asect is the directive. This directive has two parameters, indicated by sec-

tion name and address. When you use .asect, the first parameter must be

an actual section name, enclosed in double quotes; the second parameter

must be an address.

-Square brackets ( [and ]) identify an optional parameter. If you use an

optional parameter, you specify the information within the brackets; you

don’t enter the brackets themselves. Here’s an example of an instruction

that has an optional parameter:

LALK 16-bit constant [, shift]

The LALK instruction has two parameters. The first parameter,16-bit con-

stant, is required. The second parameter, shift, is optional. As this syntax

shows, if you use the optional second parameter, you must precede it with

a comma.

Square brackets are also used as part of the pathname specification for

VMS pathnames; in this case, the brackets are actually part of the path-

name (they are not optional).

-Braces ( { and } ) indicate a list. The symbol |(read as or) separates items

within the list. Here’s an example of a list:

{ * | *+ | *− }

This provides three choices: *, *+, or *−.

Unless the list is enclosed in square brackets, you must choose one item

from the list.

-Some directives can have a varying number of parameters. For example,

the .byte directive can have up to 100 parameters. The syntax for this di-

rective is:

.byte value1[, ... , valuen]

This syntax shows that .byte must have at least one value parameter, but

you have the option of supplying additional value parameters, separated

by commas.

FCC Warning

This equipment is intended for use in a laboratory test environment only. It gen-

erates, uses, and can radiate radio frequency energy and has not been tested

for compliance with the limits of computing devices pursuant to subpart J of

part 15 of FCC rules, which are designed to provide reasonable protection

against radio frequency interference. Operation of this equipment in other en-

vironments may cause interference with radio communications, in which case

the user at his own expense will be required to take whatever measures may

be required to correct this interference.

Contents



1 Introduction 1-1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.1 Bootcode Main Program 1-2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.2 Interrupt Service Routine 1-4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.3 Control (Setup) Endpoint Handler 1-6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.4 Input Endpoint 0 Interrupt Handler 1-6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.5 Output Endpoint 0 Handler 1-7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.6 Output Endpoint 1 Handler 1-7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2 TUSB5052 USB Firmware Flow 2-1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2.1 Control Write Transfer With Data 2-2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2.2 Control Write Without Data 2-2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2.3 Control Read Transfer 2-3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

3 Function 3-1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

3.1 Bootcode Functional Module List 3-2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

3.1.1 Bootcode.c File 3-2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

3.1.2 I2C.c File 3-3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

3.1.3 Header.c File 3-3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4 Bootcode Defaults 4-1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4.1 Default Hub Settings 4-2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4.2 Default Bootcode Settings 4-4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5 Header Format and Vendor USB Request 5-1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.1 Header Format 5-2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.1.1 Product Signature 5-2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.1.2 Descriptor 5-2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.1.3 Descriptor Prefix 5-2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.1.4 Descriptor Content 5-2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.2 Examples 5-3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.2.1 USB Info Basic Descriptor 5-3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.3 Built-In Vendor-Specific USB Requests 5-5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.3.1 Get Bootcode Status 5-5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.3.2 Execute Firmware 5-5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.3.3 Get Firmware Revision 5-5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.3.4 Prepare for Header Update 5-6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.4 Update Header 5-6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.5 Reboot 5-7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.6 Force Execute Firmware 5-7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.7 External Memory Read 5-7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Contents

5.8 External Memory Write 5-8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.9 I2C Memory Read 5-8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.10 I2C Memory Write 5-9. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.11 Internal ROM Memory Read 5-9. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6 Programming Considerations and Bootcode File List 6-1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6.1 Programming Considerations 6-2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6.1.1 USB Requests 6-2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6.1.2 Interrupt Handling Routine 6-2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6.2 File List 6-4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6.2.1 Bootcode.c Main Program 6-4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6.2.2 I2C.c I2C Routines 6-25. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6.3 header.c I2C Header Routines 6-32. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6.4 tusb5052.h UMP-Related Header File 6-38. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6.5 usb.h USB-Related Header File 6-52. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6.6 types.h Type Definition Header File 6-55. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6.7 i2c.h I2C-Related Header File 6-56. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6.8 header.h I2C Header-Process-Related Header File 6-58. . . . . . . . . . . . . . . . . . . . . . . . . .

Contents

vii



1−1 Main Routine 1-3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1−2 Interrupt Service Routine 1-5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1−3 Control (Setup) Endpoint Handler 1-6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1−4 Input Endpoint 0 Interrupt Handler 1-6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1−5 Output Endpoint 0 Interrupt Handler 1-7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1−6 Output Endpoint 1 Interrupt Handler 1-7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2−1 Control Write Transfer With Data 2-2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2−2 Control Read Without Data 2-3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2−3 Control Read 2-4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .



2−1 Boot Code Response to Control Write Without Data 2-2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2−2 Boot Code Response to Control Read 2-3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4−1 Hub Descriptor 4-2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4−2 Device Descriptor 4-2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4−3 Configuration Descriptor 4-3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4−4 Interface Descriptor 4-3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4−5 Interrupt Endpoint 1 Descriptor 4-4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4−6 Device Descriptor 4-4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4−7 Configuration Descriptor 4-5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4−8 Interface Descriptor 4-5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4−9 Output Endpoint 1 Descriptor 4-6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5−1 USB Info Basic Descriptor 5-3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5−2 USB Info Basic and Firmware Basic Descriptor 5-4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6−1 Vector Interrupt Values and Sources 6-2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

viii

1-1

Introduction



Chapter 1 illustrates the bootcode process with bootcode flow charts. It

contains a description of the TUSB5052 bootcode document main program

and a flow chart of the interrupt service routine, control (setup) endpoint

handler, input endpoint 0 interrupt handler, output endpoint 0 handler, and the

output endpoint 1 handler.

Topic Page

1.1 Bootcode Main Program 1-2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.2 Interrupt Service Routine 1-4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.3 Control (Setup) Endpoint Handler 1-6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.4 Input Endpoint 0 Interrupt Handler 1-6. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.5 Output Endpoint 0 Handler 1-7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.6 Output Endpoint 1 Handler 1-7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 1

Bootcode Main Program

1-2

1.1 Bootcode Main Program

After power-on reset, the bootcode copies predefined USB descriptors to the

shared RAM. The first USB descriptor is the device descriptor. It describes the

embedded function class, vendor ID, product ID, etc. The second USB

descriptor is the configuration descriptor, which contains information such as

how the device is powered, the number of configurations available, type and

number of interfaces, and end-point descriptors. From these two descriptors,

Windows loads the necessary device drivers and performs pertinent actions.

Vendor and product IDs are crucial to the bootcode. Windows gets VID and

PID through the standard USB device request and then tries to match the two

IDs with its own database. If Windows finds them in the database, it loads the

corresponding device driver. If it is not able to match the IDs it provides a

prompt directing the user to provide the driver disks, which contain the INF

files.

Once the bootcode finishes copying descriptors, it looks for the EEPROM on

the I2C port. If a valid signature is found, it reads the data type byte. If the data

type is application code, it downloads the code to an external data space. Once

the code is loaded and the checksum is correct, bootcode releases control to

the application code. If the data contains USB device information, the

bootcode interprets the data and copies it to hub registers and to the

embedded function device descriptor, if the checksum is correct. If the data

does not contain USB device information, bootcode restores predefined

settings to the hub register and device descriptor.

After the bootcode updates the hub register and device descriptor, it sets up

for a USB transaction and connects itself to the USB. It remains there until the

host drivers download the application code. Once complete, it disconnects

from the USB and releases control to the application code. Figure 1−1

illustrates bootcode operation.

Table of contents

Other Texas Instruments Controllers manuals

Texas Instruments

Texas Instruments TMS320C2000 User manual

Texas Instruments

Texas Instruments TPS70351EVM User manual

Texas Instruments

Texas Instruments LM10524EVM User manual

Texas Instruments

Texas Instruments TMS320C6000 DSP User manual

Texas Instruments

Texas Instruments UCC28600 User manual

Texas Instruments

Texas Instruments TMS320x2833x User manual

Texas Instruments

Texas Instruments TMS320C6455 User manual

Texas Instruments

Texas Instruments DM648 DSP User manual

Texas Instruments

Texas Instruments ATL431 User manual

Texas Instruments

Texas Instruments UCD90320 User manual

Texas Instruments

Texas Instruments TMS320C6457 User manual

Texas Instruments

Texas Instruments TPS53681EVM-002 User manual

Texas Instruments

Texas Instruments TIDA-00642 User manual

Texas Instruments

Texas Instruments TPS59640EVM-751 User manual

Texas Instruments

Texas Instruments C2000 Piccolo LaunchPad User manual

Texas Instruments

Texas Instruments TMS320C6452 DSP User manual

Texas Instruments

Texas Instruments TSB12LV26 Installation and user guide

Texas Instruments

Texas Instruments bq34z100 User manual

Texas Instruments

Texas Instruments UCC14240EVM-052 User manual

Texas Instruments

Texas Instruments TPS53647 User manual

Texas Instruments

Texas Instruments bq24013 User manual

Texas Instruments

Texas Instruments LM5160A User manual

Texas Instruments

Texas Instruments TCAN4550-Q1 User manual

Texas Instruments

Texas Instruments TMS320C2000 User manual

Popular Controllers manuals by other brands

Digiplex

Digiplex DGP-848 Programming guide

YASKAWA

YASKAWA SGM series user manual

Sinope

Sinope Calypso RM3500ZB installation guide

Isimet

Isimet DLA Series Style 2 Installation, Operations, Start-up and Maintenance Instructions

LSIS

LSIS sv-ip5a user manual

Rockwell Automation

Rockwell Automation 1769-L31 installation instructions

Airflow

Airflow Uno hab Installation and operating instructions

ABB

ABB ACS580-01 drives Hardware manual

Panasonic

Panasonic GM1 Series Reference manual

Emerson

Emerson SW93 owner's manual

AutoAqua

AutoAqua Smart ATO micro SATO-120P manual

Panasonic

Panasonic FP? Positioning Unit RTEX Technical manual

Samson

Samson Type 5824 Mounting and operating instructions

Alpha IP

Alpha IP MIOB 21001 manual

Siemens

Siemens OpenAir GMA 1 Series Mounting instructions

Surecom

Surecom SR-629 user manual

Fishman

Fishman TriplePlay installation guide

Regulus

Regulus SRS1 T Installation and operation manual