Renesas X 600 Series User manual

APPLICATION NOTE
R01AN0513EJ0110 Rev.1.10 Page 1 of 55
Aug 10, 2011
Renesas USB Device
USB Host Mass Storage Class Driver (HMSC)
Introduction
This document is a manual describing use of the USB host mass storage class driver with Renesas USB Device.
Target Device
RX62N Group, R8A66597
This application note also applies to other microcontrollers in the RX 600 Series that have the same USB module as
the RX62N Group microcontrollers. When using this code in an end product or other application, its operation must be
tested and evaluated thoroughly.
Contents
1. Overview ...........................................................................................................................................2
2. Device Class Driver (HDCD).............................................................................................................4
3. USB Mass Storage Class Driver (HMSCD) ....................................................................................12
4. Host Control Driver Interface(HCI) Functions .................................................................................21
5. Device Driver Interface(DDI) Functions ..........................................................................................26
6. File System Interface (FSI) .............................................................................................................31
7. Sample Device Driver (HMSDD).....................................................................................................34
8. Sample Application Program (APL) ................................................................................................42
9. Including Resources in µITRON and Non-OS Versions .................................................................50
10. Limitations.......................................................................................................................................54
R01AN0513EJ0110
Rev.1.10
Aug 10, 2011

Renesas USB Device USB Host Mass Storage Class Driver(HMSC)
R01AN0513EJ0110 Rev.1.10 Page 2 of 55
Aug 10, 2011
1. Overview
1.1 Overview
This document is a manual describing use of the USB host mass storage class driver (HMSC) and Sample driver with
Renesas USB Device.
1.2 Functions and Features
The USB host mass storage class driver comprises a USB mass storage class Bulk-Only Transport (BOT) protocol.
When combined with a file system and storage device driver, it enables communication with a BOT-compatible USB
storage device.
1.3 Related Documents
[1] USB Revision 2.0 Specification
[2] USB Mass Storage Class Specification Overview Revision 1.1
[3] USB Mass Storage Class Bulk-Only Transport Revision 1.0 [http://www.usb.org/developers/docs/]
[4] RX62N Group, RX621 Group User’s Manual: Hardware (Document No.R01UH0033EJ)
[5] R8A66597 Datasheet (Document No. REJ03F0229)
[6] Renesas USB Device USB Basic Firmware Application note (Document No.R01AN0512EJ)
[7] RX600 Series USB Host Mass Storage Class Driver Installation Guide (Document No R01AN0523EJ)
Renesas Electronics Website
[http:// www.renesas.com/]
USB Devices Page
[http://www.renesas.com/prod/usb/]
1.4 Terms and Abbreviations
USB: Universal Serial Bus
USB-BASIC-F/W: USB basic firmware for Renesas USB Device
Hardware: Renesas USB Device
HEW High-performance Embedded Workshop
RX62N-RSK Renesas Starter Kit + for RX62N
non-OS USB Basic firmware for OS less system
µITRON USB Basic firmware for µITRON system
HCD: Host control driver of Renesas USB Device (USB-BASIC-F/W)
MGR: Peripheral device state manager of HCD
HUBCD: Sample USB hub class driver
HMSCD: USB host mass storage class driver
HMSDD: Sample host mass storage device driver
HDCD: Host device class driver (HMSDD + HMSCD)
MSDCD: Mass storage device class driver (HDCD)
BOT: USB mass storage class bulk only transport
APL: User application program
FSL: FAT file system library
TFAT: FAT File System Software for Microcontrollers (M3S-TFAT-Tiny-RX)

Renesas USB Device USB Host Mass Storage Class Driver(HMSC)
R01AN0513EJ0110 Rev.1.10 Page 3 of 55
Aug 10, 2011
Task : Processing unit
Scheduler Macro : Macro for calling the scheduler function (non-OS only)
SW1/SW2/SW3 : User switches on the RX62N-RSK (Caution 1)
****(): Function call
****(capital letter) command: Storage device control command
(Caution 1) When RX62N-RSK used in conjunction with the R8A66597, SW1 is allocated to the port used by the
interruption. Therefore please do not uses SW1.

Renesas USB Device USB Host Mass Storage Class Driver(HMSC)
R01AN0513EJ0110 Rev.1.10 Page 4 of 55
Aug 10, 2011
2. Device Class Driver (HDCD)
2.1 Basic Functions
The term HDCD refers collectively to HMSDD (host mass storage device driver) and HMSCD (USB host mass storage
class driver). Its main functions are as follows.
1. Activating HMSCD
2. Verifying connected devices
3. Checking drive information
4. Mounting drives
5. Accessing USB mass storage devices
2.2 Functions and Features
HDCD runs in uITRON as a task of the application program (APL). HDCD comprises three layers: wrapper layer for
FSL (FSI functions), HMSDD, and HMSCD. The APL accesses the USB storage device via FSL, HMSDD, HMSCD,
and HCD.

Renesas USB Device USB Host Mass Storage Class Driver(HMSC)
R01AN0513EJ0110 Rev.1.10 Page 5 of 55
Aug 10, 2011
2.3 Software Configuration
Figure 2.1 shows the configuration of HDCD, and table 2.1 lists the modules.
User Application (APL)
File System Library (FSL)
File System Interface (FSI)
Mass Storage Device Driver (HMSDD)
Device Driver Interface (DDI)
HCD Interface (HCI)
Media Driver USB Host Control Driver (HCD)
Media USB Host Controller (Hardware)
Mass
Storage
Class Driver
(HMSCD)
Device
Class
Driver
(HDCD)
MGR / HUB
(USB manager)
(HUB driver)
Figure 2.1 Software Configuration Diagram
Table 2.1 Modules
Module Description
APL Calls FSL functions to implement storage functionality.
Created by the customer to match the system specifications.
FSL FAT file system with specifications defined by the user.
FSI FSL-HMSDD interface functions.
They should be modified to match FSL.
HMSDD Sample HMSDD.
It should be created (modified) by the customer to match the system specifications.
DDI HMSDD-HMSCD interface functions.
They should be modified to match HMSDD.
HMSCD The USB host mass storage class driver. It appends BOT protocol information to storage
commands and sends requests to HCD. It also manages the BOT sequence.
The storage commands should be added (modified) by the customer to match the system
specifications.
HCI HMSCD-HCD interface functions.
MGR/HUB Enumerates the connected devices and starts HMSCD. Also performs device state
management.
HCD USB host hardware control driver.
Media Driver Driver for non-USB storage devices.

Renesas USB Device USB Host Mass Storage Class Driver(HMSC)
R01AN0513EJ0110 Rev.1.10 Page 6 of 55
Aug 10, 2011
PowerON_Reset_PC
H/W reset
InitializeMCU
Initializesection
Initializelibrary
Setstack
usbc_cstd_
MainTask
usbc_cstd_
MainTask
usb_hmsc_
MainInit
usb_hmsc_
MainLoop
usb_hmsc_MainInit
Initialize target
system
Initialize USB
function
Initialize scheduler
function
Set priority
Register driver
Return
usb_hmsc_
MainLoop
Taskprocessing
flagset?
HCDtask
MGRtask
HUBtask
HMSCtask
Scheduler
Application
Return
No
Yes
For non-OS
For uITRON
usb_hmsc_
MainLoop
Return
Devicedriver
Application
Figure 2.2 Software Configuration Diagram

Renesas USB Device USB Host Mass Storage Class Driver(HMSC)
R01AN0513EJ0110 Rev.1.10 Page 7 of 55
Aug 10, 2011
2.4 File Structure
2.4.1 Folder Structure
The folder structure in which the files are provided in HDCD is shown below.
<HEW WorkSpace>
+---WorkSpace
+---MSCFW For USB0
| +---HMSC Host MSC Driver
| +---include Host MSC header file
| +---TFAT FAT File System library
+---MSCCFW Common for USB0 and USB1
| +---include HMSC Common header file (common header file for MSCFW and MSC2FW)
+---MSC2FW For USB1 (Configuration is the same as MSCFW)
+---RI600_4 ITRON Folder (not included in non-OS version）
| +---config_Hmsc uITRON configuration file for HMSC "r_usb_RX62N.cfg"/"r_usb_RX630.cfg"
+---SmplMain
| +---APL Sample Application
<USB-BASIC-F/W is shown below.>
+---USB2STDFW For USB1
+---USBCSTDFW Common file for USB0 and USB1
| +---include Common header file (common header file for USB2STDFW and USBSTDFW)
+---USBSTDFW For USB0
+---HwResourceForUSB
* USB2STDFW folder and MSC2FW folder are used when there are two USB-IP.

Renesas USB Device USB Host Mass Storage Class Driver(HMSC)
R01AN0513EJ0110 Rev.1.10 Page 8 of 55
Aug 10, 2011
2.4.2 File Structure
Table 2.2 File Structure
Folder Name File Name Description Note
APL r_usb_HMSC_apl.c Sample application Sample
MSCFW r_usb_HMSCfsi.c FSL interface functions Sample
MSCFW r_usb_hStorageDriver.c Device driver (HMSDD) Sample
MSCFW r_usb_HMSCddi.c HMSDD interface functions (DDI)
MSCFW r_usb_HMSCdriver.c
USB class driver (host mass storage
class)
MSCFW r_usb_HMSChci.c HCD interface functions (HCI)
include r_usb_cATAPIdefine.h MSDD common header file
include r_usb_cMSCdefine.h MSDCD common header file
include r_usb_hMSCdefine.h HMSCD header file
include r_usb_hMSCextern.h External reference header file
TFAT/lib_src r_tfat_drv_if.c TFAT interface functions Sample
* skip USB1
2.5 System Resources
2.5.1 System Resource Definitions when Running µITRON Version
The uITRON resources used by HDCD are listed below. They are defined in the r_usb_cKernelId.h header file.
Table 2.3 uITRON Resources
Name Description
usb_hstd_MainTask Application task
(Files can be manipulated by relevant task.)
Task_ID: USB_HSMP_TSK
Task priority: USB_HSMP_PRI
Task stack size: USB_TSK_STK
(0x0600)
Main_Task Main task
Task_ID: USB_SMP_TSK
Task priority: USB_SMP_PRI
USB_HMSCD_MBX2 HMSCD mailbox IDMailbox max. priority: 1
Waiting task queue: FIFO order
Message queue: FIFO order USB_HSMP_MBX Application mailbox ID
USB_HMSCD_MPL HMSCD memory pool ID
Fixed length memory pool block
count: 10
Block size: 64
Waiting task queue: FIFO order USB_HSMP_MPL Application memory pool ID
OS base timer Hardware timer 1 ms

Renesas USB Device USB Host Mass Storage Class Driver(HMSC)
R01AN0513EJ0110 Rev.1.10 Page 9 of 55
Aug 10, 2011
2.5.2 System Resource Definitions when Running Non-OS Version
The non-OS resources used by HDCD are listed below. They are defined in the r_usb_cKernelId.h header file.
Table 2.4 Non-OS Resources
Name Description
USB_HMSC_TSK
(usb_hmsc_Task) Mass Storage Class task Task ID default value: USBC_TID_4
Task priority: USB_HMSC_PRI
(default value: USBC_PRI_3 = 3)
Scheduler registration task
USB_HMSCSMP_TSK
(usb_hmsc_SampleAplTask) Storage Device Driver Task Task ID default value: USBC_TID_5
Task priority: USB_HSTRG_PRI
(default value: USBC_PRI_3)
USB_HMSCSMP_TSK
(usb_hmsc_SampleAplTask) APL Task Task ID default value: USBC_TID_6
Task priority: USB_HMSCSMP_PRI
(default value: USBC_PRI_4)
USB_HMSCD_MBX2 HMSCD Mailbox IDMailbox ID
priority: 1
Waiting task queue: FIFO
order
Message queue: FIFO
order
USB_HSMP_MBX APL mailbox ID
Fixed length memory pool
ID USB_HMSCD_MPL
HMSCD memory pool ID
Fixed-length memory pool
block
count:USBC_BLKMAX:10
Waiting task queue: FIFO
order
USB_HSMP_MPL
APL memory pool ID

Renesas USB Device USB Host Mass Storage Class Driver(HMSC)
R01AN0513EJ0110 Rev.1.10 Page 10 of 55
Aug 10, 2011
2.6 Accessing USB Storage Devices
FSI converts sector numbers to logical block addresses and sector counts to transfer data sizes. From the drive number,
HMSDD determines if a USB storage device is being accessed. HMSCD converts drive numbers to unit numbers and
accesses USB storage devices via HCD according to the BOT protocol.
Figure 2.3 shows the UBS storage device access sequence.
APL FSL FSI HMSDD HMSCD HCD
read_sector() R_usb_hmsc_
StrgReadSector() R_usb_hmsc_
Read10()
Read sector
R_usb_hstd_
SetPipeRegistration()
transmission
usb_hmsc_Submitutr()
CBW
R_usb_hstd_
SetPipeRegistration()
recipition
usb_hmsc_Submitutr()
Data
R_usb_hstd_
SetPipeRegistration()
transmission
usb_hmsc_Submitutr()
CSW
returnreturnsector
data
write_sector() R_usb_hmsc_
StrgWriteSector() R_usb_hmsc_
Write10()
Write sector
R_usb_hstd_
SetPipeRegistration()
transmission
usb_hmsc_Submitutr()
CBW
R_usb_hstd_
SetPipeRegistration()
usb_hmsc_Submitutr()
Data
R_usb_hstd_
SetPipeRegistration()
transmission
usb_hmsc_Submitutr()
CSW
returnreturn
return return
transmission
ʻreadʼprocess R_tfat_disk_read()
ʻwriteʼprocess R_tfat_disk_write()
Figure 2.3 USB Storage Device Access Sequence