ST STR9 User manual

November 2008 Rev 2 1/76

UM0290

User manual

STR7/STR9 USB developer kit

Introduction

The STR7/9 USB developer kit is a complete firmware and software package including

examples and demos for all USB transfer types (control, interrupt, bulk and isochronous). It

supports all ST 32-bit USB microcontrollers (STR71x, STR75x and STR91x).

The aim of the STR7/9 USB developer kit is to use the same certified USB library across the

STR7/STR9 microcontroller families and present for each at least one firmware demo per

USB transfer type.

This document presents a description of all the components of the STR7/9 USB Developer

kit, including:

■Common STR7/9 USB library: All processes related to default endpoint and standard

requests

■Joystick mouse demo: Interrupt transfer

■Custom HID: interrupt transfer

■Device Firmware Upgrade (DFU): control transfer

■Mass storage demo: Bulk transfer

■Virtual COM port: Bulk transfer

■USB voice demo (speaker and microphone): Isochronous transfer

www.st.com

Contents UM0290

2/76

Contents

1 STR7/STR9 USB firmware library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

1.1 USB application hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

1.2 USB library core . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

1.2.1 usb_type.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

1.2.2 usb_reg(.c, .h) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

1.2.3 usb_int (.c , .h) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

1.2.4 usb_core (.c , .h) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

1.3 Application interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

1.3.1 usb_istr(.c) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

1.3.2 usb_conf(.h) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

1.3.3 usb_endp (.c) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

1.3.4 usb_prop (.c , .h) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

1.3.5 usb_pwr (.c , .h) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

1.4 Implementing a USB application using the STR7/9 USB library . . . . . . . 21

1.4.1 Implementing a no data class specific request . . . . . . . . . . . . . . . . . . . 21

1.4.2 How to implement a data class specific request . . . . . . . . . . . . . . . . . . 21

1.4.3 How to manage data transfers in a non-control endpoint . . . . . . . . . . . 22

2 Joystick mouse demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

3 Custom HID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

3.1 General description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

3.2 Descriptor topology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

3.3 Custom HID implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

3.3.1 LEDs control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

3.3.2 Push button states report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

3.3.3 ADC converted data transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

4 Device firmware upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

4.1 General description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

4.2 DFU extension protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

4.2.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

4.2.2 Phases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

4.2.3 Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

UM0290 Contents

3/76

4.3 DFU mode selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

4.3.1 Run-time descriptor set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

4.3.2 DFU mode descriptor set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

4.4 Reconfiguration phase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

4.5 Transfer phase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

4.5.1 Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

4.5.2 Special command/protocol descriptions . . . . . . . . . . . . . . . . . . . . . . . . 34

4.5.3 DFU state diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

4.5.4 Downloading and uploading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

4.5.5 Manifestation phase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

4.6 DFU implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

4.6.1 DFU mode entry mechanism . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

4.6.2 Available DFU images in the STR7/9 USB development kit . . . . . . . . . 37

4.6.3 How to create a DFU Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

5 Mass storage demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

5.1 Mass storage demo overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

5.2 Mass storage protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

5.2.1 Bulk Only Transfer (BOT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

5.2.2 Small Computer System Interface (SCSI) . . . . . . . . . . . . . . . . . . . . . . . 42

5.3 Mass storage demo implementations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

5.3.1 Hardware configuration interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

5.3.2 Endpoint configurations and data management . . . . . . . . . . . . . . . . . . 44

5.3.3 Class specific requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

5.3.4 Standard request requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

5.3.5 BOT state machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

5.3.6 SCSI protocol implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

5.3.7 Memory management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

5.4 How to customize the mass storage demo . . . . . . . . . . . . . . . . . . . . . . . 49

6 Virtual COM port demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

6.1 Virtual COM port demo proposal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

6.2 Software driver installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

6.3 Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

6.3.1 Hardware implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

6.3.2 Firmware implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Contents UM0290

4/76

7 USB voice demos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

7.1 Isochronous transfer overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

7.2 Audio device class overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

7.3 STR7/9 USB audio speaker demo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

7.3.1 General characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

7.3.2 Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

7.3.3 STR91x USB audio speaker using the DMA . . . . . . . . . . . . . . . . . . . . . 62

7.4 STR7/9 USB microphone (only for STR75x and STR91x families) . . . . . 63

7.4.1 General characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

7.4.2 Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

8 Revision history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

UM0290 STR7/STR9 USB firmware library

5/76

1 STR7/STR9 USB firmware library

This section describes the firmware interface (called USB Library) used to manage the

STR7/9 USB 2.0 full-speed macrocell.

The main purpose of this firmware library is to provide resources to ease the development of

applications using the USB macrocell in all STR7/9 microcontrollers (STR71x, STR75x and

the STR91x families).

1.1 USB application hierarchy

Figure 1 shows the interaction between the different components of a typical USB

application and the USB library.

Figure 1. USB application hierarchy

The USB library is divided into two layers:

●USB Library Core layer: This layer manages the direct communication with the USB

IP hardware and the USB standard protocol. The USB Library Core is compliant with

the USB 2.0 specification and doesn’t have dependences with any Standard Software

Library of STR7/9 microcontrollers.

●Application Interface layer: This layer presents to the user a complete interface

between the library core and the final application.

Note: The application interface layer and the final application can communicate with the Standard

Software Library to manage the hardware needs of the application.

Hardware (STR microcontroller + Board)

USB IP

USB Application Standard

Library

usb_core

usb_init

usb_regs usb_memusb_int

usb_istr usb_prop usb_endp

Application Interface

USB Library

Core

usb_pwr usb_desc

STR7/STR9 USB firmware library UM0290

6/76

A detailed description of these two layers with coding rules is provided in the next two

sections.

1.2 USB library core

Table 1 presents the USB library core modules:

Table 1. USB library core modules

1.2.1 usb_type.h

This file provides the main types used in the library. These types are dependent on the used

microcontroller family.

Note: The type definitions used in the USB library are the same as those used in the STRxxx

Standard library to guarantee the autonomy of the whole code.

File Description

usb_type.h Types used in the library core. This file is used to guarantee the

independency of the USB library

usb_reg (.h, .c) Hardware abstraction layer

usb_int.c Correct transfer interrupt service routine

usb_init (.h,.c) USB initialization

usb_core (.h , .c) USB protocol management (compliant with chapter 9 of the USB 2.0

specification)

usb_mem(.h,.c) Data transfer management (from/to Packet Memory Area)

usb_def.h USB definitions

UM0290 STR7/STR9 USB firmware library

7/76

1.2.2 usb_reg(.c, .h)

The usb_regs module implements the hardware abstraction layer, it offers a set of basic

functions for accessing the USB macrocell registers.

Note: The available functions have two call versions:

- As a macro: the call is: _NameofFunction(parameter1,...)

- As a subroutine: the call is: NameofFunction(parameter1,...)

1. Common register functions: These functions can be used to set or to get the

common USB registers:

Table 2. Common register functions

CNTR

void SetCNTR (u16 wValue)

u16 GetCNTR (void)

ISTR

void SetISTR (u16 wValue)

u16 GetISTR (void)

FNR u16 GetFNR (void)

DADDR

void SetDADDR (u16 wValue)

u16 GetDADDR (void)

BTABLE

void SetBTABLE (u16 wValue)

u16 GetBTABLE (void)

STR7/STR9 USB firmware library UM0290

8/76

2. Endpoint register functions: All operations related to endpoint registers can be

performed with the SetENDPOINT and GetENDPOINT functions. However, several

functions are derived from these to permit direct action on a specific field.

a) Endpoint set/get value

SetENDPOINT : void SetENDPOINT(u8 bEpNum,u16 wRegValue)

bEpNum = Endpoint number, wRegValue = Value to write

GetENDPOINT : u16 GetENDPOINT(u8 bEpNum)

bEpNum = Endpoint number

return value: the endpoint register value

b) Endpoint TYPE field

The EP_TYPE field of the endpoint register could have these defined values:

#define EP_BULK (0x0000) // Endpoint BULK

#define EP_CONTROL (0x0200) // Endpoint CONTROL

#define EP_ISOCHRNOUS (0x0400) // Endpoint ISOCHRONOUS

#define EP_INTERRUPT (0x0600) // Endpoint INTERRUPT

SetEPType : void SetEPType (u8 bEpNum, u16 wtype)

bEpNum = Endpoint number, wtype = Endpoint type (value from the

above define’s)

GetEPType : u16 GetEPType (u8 bEpNum)

bEpNum = Endpoint number

return value: a value from the above define’s

c) Endpoint STATUS field

The STAT_TX / STAT_RX fields of the endpoint register could have these defined

values:

#define EP_TX_DIS (0x0000) // Endpoint TX DISabled

#define EP_TX_STALL (0x0010) // Endpoint TX STALLed

#define EP_TX_NAK (0x0020) // Endpoint TX NAKed

#define EP_TX_VALID (0x0030) // Endpoint TX VALID

#define EP_RX_DIS (0x0000) // Endpoint RX DISabled

#define EP_RX_STALL (0x1000) // Endpoint RX STALLed

#define EP_RX_NAK (0x2000) // Endpoint RX NAKed

#define EP_RX_VALID (0x3000) // Endpoint RX VALID

SetEPTxStatus : void SetEPTxStatus(u8 bEpNum,u16 wState)

SetEPRxStatus : void SetEPRxStatus(u8 bEpNum,u16 wState)

bEpNum = Endpoint number, wState = a value from the above define’s

GetEPTxStatus : u16 GetEPTxStatus(u8 bEpNum)

GetEPRxStatus : u16 GetEPRxStatus(u8 bEpNum)

bEpNum = endpoint number

return value:a value from the above define’s

d) Endpoint KIND field

SetEP_KIND : void SetEP_KIND(u8 bEpNum)

ClearEP_KIND : void ClearEP_KIND(u8 bEpNum)

bEpNum = endpoint number

Set_Status_Out : void Set_Status_Out(u8 bEpNum)

UM0290 STR7/STR9 USB firmware library

9/76

Clear_Status_Out : void Clear_Status_Out(u8 bEpNum)

bEpNum = endpoint number

SetEPDoubleBuff : void SetEPDoubleBuff(u8 bEpNum)

ClearEPDoubleBuff : void ClearEPDoubleBuff(u8 bEpNum)

bEpNum = endpoint number

e) Correct Transfer Rx/Tx fields

ClearEP_CTR_RX : void ClearEP_CTR_RX(u8 bEpNum)

ClearEP_CTR_TX : void ClearEP_CTR_TX(u8 bEpNum)

bEpNum = endpoint number

f) Data Toggle Rx/Tx fields

ToggleDTOG_RX : void ToggleDTOG_RX(u8 bEpNum)

ToggleDTOG_TX : void ToggleDTOG_TX(u8 bEpNum)

bEpNum = endpoint number

g) Address field

SetEPAdress : void SetEPAddress(u8 bEpNum,u8 bAddr)

bEpNum = endpoint number

bAddr = address to be set

GetEPAdress : BYTE GetEPAddress(u8 bEpNum)

bEpNum = endpoint number

3. Buffer description table functions: These functions are used to set or get the

endpoints’ receive and transmit buffer addresses and sizes.

a) Tx/Rx buffer address fields

SetEPTxAddr : void SetEPTxAddr(u8 bEpNum,u16 wAddr);

SetEPRxAddr : void SetEPRxAddr(u8 bEpNum,u16 wAddr);

bEpNum = endpoint number

wAddr = address to be set (expressed as PMA buffer address)

GetEPTxAddr : u16 GetEPTxAddr(u8 bEpNum);

GetEPRxAddr : u16 GetEPRxAddr(u8 bEpNum);

bEpNum = endpoint number

return value : address value (expressed as PMA buffer address)

b) Tx/Rx buffer counter fields

SetEPTxCount : void SetEPTxCount(u8 bEpNum,u16 wCount);

SetEPRxCount : void SetEPRxCount(u8 bEpNum,u16 wCount);

bEpNum = endpoint number

wCount = counter to be set

GetEPTxCount : u16 GetEPTxCount(u8 bEpNum);

GetEPRxCount : u16 GetEPRxCount(u8 bEpNum);

bEpNum = endpoint number

return value : counter value

STR7/STR9 USB firmware library UM0290

10/76

4. Double-buffered endpoint functions: To obtain high data transfer throughput in bulk

or isochronous modes, double-buffered mode has to be programmed.

In this operating mode some fields of the endpoint registers and buffer description table

cells have different meanings.

To ease the use of this feature, several functions have been developed.

SetEPDoubleBuff: An endpoint programmed to work in bulk mode can be set as

double-buffered by setting the EP-KIND bit. The function SetEPDoubleBuff()

accomplishes this task.

SetEPDoubleBuff : void SetEPDoubleBuff(u8 bEpNum);

bEpNum = endpoint number

FreeUserBuffer: In double-buffered mode the endpoints become mono-directional and

buffer description table cells of the unused direction are applied to handle a second

buffer.

Addresses and counters must be handled in a different way. Rx and Tx Addresses and

counter cells become Buffer0 and Buffer1 cells. Functions dedicated to this operating

mode are provided for in the library.

During a bulk transfer the line fills one buffer while the other buffer is reserved to the

application. A user application has to process data before the arrival of bulk needing a

buffer. The buffer reserved to the application has to be freed in time.

To free the buffer in use from the application the FreeUserBuffer function is

provided:

FreeUserBuffer: void FreeUserBuffer(u8 bEpNum, u8 bDir);

bEpNum = endpoint number

a) Double buffer addresses

These functions set or get the buffer address value in the buffer description table

for double buffered mode.

SetEPDblBuffAddr : void SetEPDblBuffAddr(u8 bEpNum,u16

wBuf0Addr,u16 wBuf1Addr);

SetEPDblbuf0Addr : void SetEPDblBuf0Addr(u8 bEpNum,u16 wBuf0Addr);

SetEPDblbuf1Addr : void SetEPDblBuf1Addr(u8 bEpNum,u16 wBuf1Addr);

bEpNum = endpoint number

wBuf0Addr, wBuf1Addr = buffer addresses (expressed as PMA buffer

addresses)

GetEPDblBuf0Addr : u16 GetEPDblBuf0Addr(u8 bEpNum);

GetEPDblbuf1Addr : u16 GetEPDblBuf1Addr(u8 bEpNum);

bEpNum = endpoint number

return value : buffer addresses

b) Double buffer counters

These functions set or get the buffer counter value in the buffer description table

for double buffered mode.

SetEPDblBuffCount: void SetEPDblBuffCount(u8 bEpNum, u8 bDir, u16

wCount);

SetEPDblBuf0Count: void SetEPDblBuf0Count(u8 bEpNum, u8 bDir, u16

wCount);

SetEPDblBuf1Count: void SetEPDblBuf1Count(u8 bEpNum, u8 bDir, u16

Other manuals for STR9

This manual suits for next models

Table of contents

Other ST Microcontroller manuals

Popular Microcontroller manuals by other brands

AMS

AMS AS7261 Demo Kit user guide

Novatek

Novatek NT6861 manual

Espressif Systems

Espressif Systems ESP8266 SDK AT Instruction Set

Nuvoton

Nuvoton ISD61S00 ChipCorder Design guide

STMicrolectronics

STMicrolectronics ST7 Assembler Linker user manual

Texas Instruments

Texas Instruments Chipcon CC2420DK user manual

Lantronix

Lantronix Intrinsyc Open-Q 865XR SOM user guide

NEC

NEC 78GK0S/K 1+ Series Application note

Mikroe

Mikroe SEMITECH N-PLC Click Application note

Intel

Intel Agilex user guide

Cypress

Cypress CY4607 HX2VL quick start guide

DIGITAL-LOGIC

DIGITAL-LOGIC MICROSPACE manual

Texas Instruments

Texas Instruments TMS320F2837 D Series Workshop Guide and Lab Manual

CYPRES

CYPRES CY14NVSRAMKIT-001 user guide

Texas Instruments

Texas Instruments INA-DUAL-2AMP-EVM user guide

Espressif Systems

Espressif Systems ESP8266EX Programming guide

Abov

Abov AC33M8128L user manual

Laird

Laird BL654PA user guide