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

Renesas USB Device USB Host Mass Storage Class Driver(HMSC)
R01AN0513EJ0110 Rev.1.10 Page 11 of 55
Aug 10, 2011
2.7 HMSCD activation
HMSCD determines if USB communication is possible from the descriptor information of the connected device.
Figure 2.4 shows the operation sequence at HMSCD activation.
APL
Activate
HMSDD
Search for
drive
HMSCDHMSDD HCD
MGR
Enumeration
Interpret descriptors
Update pipe table
usb_smp_hmsc_Dev
CheckBootRecord()
Count drives
usb_smp_hmsc_Dev
CheckBootRecord()
Count drives
Drive number?
All drives?
All units?
Unit count?
FSL FSI
Drive mount
R_usb_hmsc_
StrgTaskOpen() R_usb_hmsc_
TaskOpen()
R_usb_hmsc_StorageOpen()
callback devconfig
R_usb_hmsc_
StrgDriveSearch()
Initialize variables
R_usb_hmsc_
GetMaxUnit()
Read unit count
Confirm unit ready
R_usb_hmsc_
Inquiry()
R_usb_hmsc_
Read10()
Read sector
R_usb_hmsc_
Registration()
R_usb_hstd_DriverRegistration
callback.classinit
callback classcheck
usb_hmsc_Submitutr()
usb_hmsc_Submitutr()
usb_hmsc_Submitutr()
Initialize
global variables
Mount
dev_open()
Set drive information
R_usb_hmsc_StrgDriveOpen()
R_usb_hmsc_Read10()
Read sector usb_hmsc_Submitutr()
usb_smp_hmsc_
FsiFileSystemInitialized()
Figure 2.4 HMSCD Activation Sequence

Renesas USB Device USB Host Mass Storage Class Driver(HMSC)
R01AN0513EJ0110 Rev.1.10 Page 12 of 55
Aug 10, 2011
3. USB Mass Storage Class Driver (HMSCD)
3.1 Basic Functions
HMSCD is registered in HCD when the application (APL) starts the device driver. The functions of HMSCD are as
follows.
1. Verifying devices (determining if USB storage devices are ready to operate)
2. Communicating storage commands using the BOT protocol
3.2 Issuing Requests to HMSCD
The interface functions described below are used when accessing USB storage devices. In response to requests from a
higher layer, HMSCD sends notification of results by means of function return values.
3.3 Functions and Features
HMSCD comprises three layers: wrapper layer for HMSDD (DDI functions), wrapper layer for HCD (HCI functions),
and HMSCD itself. The DDI function is modified when HMSDD is changed, and the HCI function is modified when
HCD is changed. This can use Host mass storage class driver without changing it.HMSCD supports storage commands
necessary for accessing USB storage devices and sample storage commands.
HMSCD has the following features.
Support for USB mass storage class BOT.
Support for SFF-8070i (ATAPI) and SCSI USB mass storage subclasses.
Sharing of a single pipe for IN/OUT directions or multiple devices.
Sample device driver (HMSDD) provided.
Specific indication of interface (connection example) with FAT file system library.
Specific indication of interface (connection example) with HCD of USB-BASIC-F/W.
3.4 Pipe Information Table
Table 3.1 lists details of the HMSCD pipe information table.
Table 3.1 Pipe Information Table
Register PIPE1 (receive pipe setting) PIPE1 (transmit pipe setting)
1 PIPECFG BFRE = 0, DBLB = 1, SHTNAK = 1
Settings other than the above obtained
from descriptor.
BFRE = 0, DBLB = 1,
Settings other than the above obtained from
descriptor.
2 PIPEMAX None (Obtained from descriptor.) None (Obtained from descriptor.)
3 PIPEPERI None None
4 FIFOPORT CPU access to CFIFO CPU access to CFIFO

Renesas USB Device USB Host Mass Storage Class Driver(HMSC)
R01AN0513EJ0110 Rev.1.10 Page 13 of 55
Aug 10, 2011
3.5 HMSCD Global Area
Table 3.2 lists details of the HMSCD global area.
Table 3.2 HMSCD Global Area
Format Variable Name Description
1 uint16_t usb_ghmsc_AttSts HMSCD operation state
2 USBC_MSC_CBW_t usb_ghmsc_Cbw[USBC_MAXSTRAGE] CBW transmit structure
3 USBC_MSC_CSW_t usb_ghmsc_Csw[USBC_MAXSTRAGE] CSW receive structure
4 uint32_t usb_ghmsc_CswDataResidue[USBC_MAXSTRA
GE] BOT protocol operation result
5 uint32_t usb_ghmsc_CbwTagNo[USBC_MAXSTRAGE] CBW tag data
6 uint8_t usb_ghmsc_AtapiFlag[USBC_MAXSTRAGE] ATAPI/SCSI operation flag
3.6 HMSCD Functions
Table 3.3 lists the functions of HMSCD.
Table 3.3 HMSCD Functions
Function Name Description
1 usb_hmsc_SmpBotDescriptor() Confirms mass storage class and BOT protocol.
2 usb_hmsc_SmpPipeInfo() Makes pipe information table settings.
3 usb_hmsc_NoData() NO DATA command Execution.
4 usb_hmsc_DataIn() RECEIVE DATA command Execution.
5 usb_hmsc_DataOut() TRANSMIT DATA command Execution.
6 usb_hmsc_SetRwCbw() Initializes CBW parameters for READ10 and WRITE10
commands.
7 usb_hmsc_SetElsCbw() Initializes CBW parameters for other commands.
8 usb_hmsc_CbwTagCount() Updates tag information.
9 usb_hmsc_CheckCsw() Checks if new CSW received.
10 R_usb_hmsc_SetDevSts() Sets HMSCD operation state.
11 R_usb_hmsc_GetDevSts() Returns HMSCD operation state.
12 R_usb_hmsc_Information() Checks pipe information table.
13 usb_hmsc_Task HMSC Task

Renesas USB Device USB Host Mass Storage Class Driver(HMSC)
R01AN0513EJ0110 Rev.1.10 Page 14 of 55
Aug 10, 2011
3.7 HMSCD Structures
Tables 3.4 and 3.5 show the contents of the HMSCD structures.
Table 3.4 USBC_MSC_CBW_t Structure
Member Name Description Remarks
uint32_t dCBWSignature CBW Signature 0x55534243: USBC
uint32_t dCBWTag CBW Tag Tag corresponding to CSW
uint8_t dCBWDTL_Lo
uint8_t dCBWDTL_ML
uint8_t dCBWDTL_MH
uint8_t dCBWDTL_Hi
CBW DataTransfer Length Data length of transmit/receive data
uint8_t bmCBWFlags CBW Direction Data transmit/receive direction
uint8_t bCBWLUN Logical Unit Number Unit number
uint8_t bCBWCBLength CBWCB Length Command length
uint8_t CBWCB[16] CBWCB Command block
Table 3.5 USBC_MSC_CSW_t Structure
Member Name Description Remarks
uint32_t dCSWSignature CSW Signature 0x55534253: USBS
uint32_t dCSWTag CSW Tag Tag corresponding to CBW
uint8_t dCSWDataResidue_Lo
uint8_t dCSWDataResidue_ML
uint8_t dCSWDataResidue_MH
uint8_t dCSWDataResidue_Hi
CSW DataResidue Data length used
uint8_t bCSWStatus CSW Status Command status
uint8_t dummy Dummy Even number adjustment

Renesas USB Device USB Host Mass Storage Class Driver(HMSC)
R01AN0513EJ0110 Rev.1.10 Page 15 of 55
Aug 10, 2011
3.8 HMSCD Constant Definitions
Tables 3.6 and 3.7 list the HMSCD constant definitions.
Table 3.6 HMSCD Constant Definitions (MSDCD Common Macro Definitions)
Description Definition Name Value
BOT wrapper
CBW data length USBC_MSC_CBWLENGTH 31
CBW signature USBC_MSC_CBW_SIGNATURE 0x55534243
CSW signature USBC_MSC_CSW_SIGNATURE 0x55534253
CBWCB data length
(fixed length for ATAPI specification) USBC_MSC_CBWCB_LENGTH 12
1
CSW data length USBC_MSC_CSW_LENGTH 13
CSW status
Storage command OK USBC_MSC_CSW_OK 0x00
Storage command FAIL USBC_MSC_CSW_NG 0x01
2
Phase error USBC_MSC_CSW_PHASE_ERR 0x02
Descriptor check USBC_ATAPI 0x05USB subclass code USBC_SCSI 0x06
USB protocol code USBC_BOTP 0x50
3
Endpoint total USBC_TOTALEP 0x02
Storage command USBC_ATAPI_TEST_UNIT_READY 0x00
USBC_ATAPI_REQUEST_SENSE 0x03
USBC_ATAPI_FORMAT_UNIT 0x04
USBC_ATAPI_INQUIRY 0x12
USBC_ATAPI_MODE_SELECT6 0x15
USBC_ATAPI_MODE_SENSE6 0x1A
USBC_ATAPI_START_STOP_UNIT 0x1B
USBC_ATAPI_PREVENT_ALLOW 0x1E
USBC_ATAPI_READ_FORMAT_CAPACITY 0x23
USBC_ATAPI_READ_CAPACITY 0x25
USBC_ATAPI_READ10 0x28
USBC_ATAPI_WRITE10 0x2A
USBC_ATAPI_SEEK 0x2B
USBC_ATAPI_WRITE_AND_VERIFY 0x2E
USBC_ATAPI_VERIFY10 0x2F
4
USBC_ATAPI_MODE_SELECT10 0x55
USBC_ATAPI_MODE_SENSE10 0x5A

Renesas USB Device USB Host Mass Storage Class Driver(HMSC)
R01AN0513EJ0110 Rev.1.10 Page 16 of 55
Aug 10, 2011
Table 3.7 HMSCD Constant Definitions (HDCD Dedicated Macro Definitions)
Description Value
HMSCD connection state
Device not connected USBC_HMSC_DEV_DET 0x00
1
Device connected USBC_HMSC_DEV_ATT 0x01
Device type
Direct access device USBC_PDT_DIRECT 0x00
Sequential device USBC_PDT_SEQUENTIAL 0x01
Write-once device USBC_PDT_WRITEONCE 0x04
CD-ROM device USBC_PDT_CDROM 0x05
Optical device USBC_PDT_OPTICAL 0x07
2
Undefined device USBC_PDT_UNKNOWN 0x1F
User macro definitions
Max. unit count USBC_MAXUNITNUM 4
Max. boot partition count USBC_BOOTPARNUM 4
Max. drive count USBC_MAXDRIVE 10
Max. device count USBC_MAXSTRAGE 2
Drive start number USBC_DRIVE 0
3
Internal memory drive number USBC_MEDIADRIVE 0
Record code
PBR record code USBC_PBR_ADDR 0x01
MBR record code USBC_MBR_ADDR 0x02
EMBR record code USBC_EMBR_ADDR 0x03
4
Boot record error code USBC_BOOT_ERROR 0x05
Boot record
Recorder identification signature code USBC_BOOTRECORD_SIG 0xAA55
USBC_STARTDISK 0x80MBR identification start code USBC_NOTSTARTDISK 0x00
PBR identification nop code USBC_NOPCODE 0x90
USBC_JMPCODE1 0xEB
5
PBR identification jmp code USBC_JMPCODE2 0xE9
Partition type
No partition USBC_PT_NONE 0x00
FAT12 USBC_PT_FAT12/USBC_PT_FAT12A 0x01
FAT16 USBC_PT_FAT16/USBC_PT_FAT16A 0x04
FAT16 USBC_PT_FAT16B 0x06
FAT16 USBC_PT_FAT16X 0x0E
FAT32 USBC_PT_FAT32/USBC_PT_FAT32A 0x0B
FAT32 USBC_PT_FAT32X 0x0C
Extended partition USBC_PT_EPRT/USBC_PT_EPRTA 0x05
Extended partition USBC_PT_EPRTB 0x0F
6
Extended partition (not supported) USBC_PT_EPRTC 0x85
7 Transfer end notification
Transfer end USBC_HMSC_OK 0x00
CBW transfer error USBC_HMSC_CBW_ERR -2
Read data error USBC_HMSC_DAT_RD_ERR -3
Write data error USBC_HMSC_DAT_WR_ERR -4
CSW error USBC_HMSC_CSW_ERR -5
Phase error USBC_HMSC_CSW_PHASE_ERR -6
Submit error USBC_HMSC_SUBMIT_ERR -7

Renesas USB Device USB Host Mass Storage Class Driver(HMSC)
R01AN0513EJ0110 Rev.1.10 Page 17 of 55
Aug 10, 2011
3.9 HMSCD Function Details
Table 3.8 usb_hmsc_SmpBotDescriptor()
Name Check Descriptor
Call format nit16_t usb_hmsc_SmpBotDescriptor(uint8_t *table, uint16_t msgnum)
uint8_t *table Interface descriptor table address
Arguments uint16_t msgnum Driver number
Return values uint16_t USBC_DONE Normal end
USBC_ERROR Error end
Description
Checks the following contents in the specified table.
a) Interface descriptor table
b) bInterfaceClass = USBC_IFCLS_MAS (mass storage class)
c) bInterfaceSubClass = USBC_ATAPI / USBC_SCSI
d) bInterfaceProtocol = USBC_BOTP
e) bNumEndpoint > USBC_TOTALEP
Notes
Table 3.9 usb_hmsc_SmpPipeInfo()
Name Pipe Information Table Settings
Call format uint16_t usb_hmsc_SmpPipeInfo(uint8_t *table, uint16_t msgnum, uint16_t speed, uint16_t
length)
uint8_t *table Interface descriptor table address
uint16_t msgnum Pipe information table offset
uint16_t speed Communication speed
Arguments
uint16_t length Configuration descriptor table length
Return values USBC_DONE Normal end
USBC_ERROR Error end
Description
Makes the following settings, considering the first bulk endpoint after the interface
descriptor as PIPE1/3 and the next bulk endpoint as PIPE2/4.
a) Endpoint address (endpoint number + direction)
b) Transfer type
c) Max packet size
d) Interval
When the transfer direction IN (receive direction), SHTNAK is set to 1.
For DMA/DTC access, BFRE is set to 1.
USBC_ERROR is returned in the following cases.
When a standard descriptor other than an endpoint is detected before two bulk endpoints
are found (except for a vendor descriptor or device class descriptor, in which case no
error occurs).
When the two bulk endpoints found first have the same transfer direction.
Notes

Renesas USB Device USB Host Mass Storage Class Driver(HMSC)
R01AN0513EJ0110 Rev.1.10 Page 18 of 55
Aug 10, 2011
Table 3.10 usb_hmsc_NoData()
Name NO DATA Command Execution
Call format uint16_t usb_hmsc_NoData(uint16_t drvnum)
Arguments uint16_t drvnum Drive number
Return values uint16_t Transfer end notification: See HMSCD constant
definitions.
Description The NO DATA command is executed.
Notes
Table 3.11 usb_hmsc_DataIn()
Name RECEIVE DATA command Execution.
Call format uint16_t usb_hmsc_DataIn(uint16_t drvnum, uint8_t *buff, uint32_t size)
uint16_t drvnum Drive number
uint8_t *buff Receive data storage area address
Arguments uint32_t size Data size to be received
Return values uint16_t Transfer end notification: See HMSCD constant
definitions.
Description The RECEIVE DATA command is executed.
Notes
Table 3.12 usb_hmsc_DataOut()
Name TRANSMIT DATA Command Execution
Call format uint16_t usb_hmsc_DataOut(uint16_t drvnum, uint8_t *buff, uint32_t size)
uint16_t drvnum Drive number
uint8_t *buff Transmit data storage area address
Arguments uint32_t size Data size to be transmitted
Return values uint16_t Transfer end notification: See constant definitions.
Description The TRANSMIT DATA command is executed.
Notes
Table 3.13 usb_hmsc_SetRwCbw)
Name Initialize CBW Parameters for READ10/WRITE10 Command
Call format void usb_hmsc_SetRwCbw(uint16_t command, uint32_t secno, uint16_t seccnt, uint32_t
trans_byte, uint16_t side)
uint16_t command Storage command
uint32_t secno Sector number
uint16_t seccnt Sector count
uint32_t trans_byte Transfer data size
Arguments
uint16_t side Drive number
Return values void
Description Generates the CBW for the READ10 or WRITE10 command.
Note that the LUN field in CBWCB is set to 0 (storage command specification).
Notes Updates usb_ghmsc_Cbw in the global area.

Renesas USB Device USB Host Mass Storage Class Driver(HMSC)
R01AN0513EJ0110 Rev.1.10 Page 19 of 55
Aug 10, 2011
Table 3.14 usb_hmsc_SetElsCbw()
Name Initialize CBW Parameters for Other Commands
Call format void usb_hmsc_SetElsCbw(uint8_t *data, uint32_t trans_byte, uint16_t side)
uint8_t *data Command data address
uint32_t trans_byte Transfer data size
Arguments uint16_t side Drive number
Return values void
Description
Generates the CBW for commands other than READ10 and WRITE10.
Set the command field before calling the function and the fields other than the following
either before or after calling the function.
dCBWTag, dCBWDTL, bmCBWFlags.CBWdir, bmCBWFlags.reserved7,
bCBWLUN.bCBWLUN, bCBWLUN.reserved4, bCBWCBLength.reserved3
Notes Updates usb_ghmsc_Cbw in the global area.
The command data is generated with a fixed length of 12 bytes.
Table 3.15 usb_hmsc_CbwTagCount()
Name Update Tag Information
Call format void usb_hmsc_CbwTagCount(uint16_t msgnum)
Arguments uint16_t msgnum Driver number
Return values void
Description Updates usb_ghmsc_CbwTagNo in the global area.
Notes When usb_ghmsc_CbwTagNo = 0, the value is incremented by 1.
Table 3.16 usb_hmsc_CheckCsw()
Name Check CSW
Call format uint16_t usb_hmsc_CheckCsw(uint16_t drvnum)
Arguments uint16_t drvnum Drive number
Return values uint16_t USBC_HMSC_OK CSW-OK received USBC_HMSC_CSW_ERR CSW-NG (fail) received
USBC_HMSC_CSW_PHASE_ERR Phase error
Description Checks the following contents in the in the received CSW.
a) dCSWSignature in received CSW
Notes In case of a phase error, MassStorageReset is executed.
Table 3.17 R_usb hmsc_SetDevSts()
Name Set HMSCD Operation State
Call format uint16_t R_usb_hmsc_SetDevSts(uint16_t data)
Arguments uint16_t data Operation State
Return values uint16_t USBC_DONE Normal end
Description Updates the HMSCD operation state to the value specified by the argument.
Notes Updates usb_ghmsc_AttSts in the global area.
Table 3.18 R_usb_hmsc_GetDevSts()
Name Check HMSCD Operation State
Call format uint16_t R_usb_hmsc_GetDevSts(void)
Arguments void
Return values uint16_t USBC_HMSC_DEV_DET Detach
USBC_HMSC_DEV_ATT Attach
Description Returns the HMSCD operation state.
Notes

Renesas USB Device USB Host Mass Storage Class Driver(HMSC)
R01AN0513EJ0110 Rev.1.10 Page 20 of 55
Aug 10, 2011
Table 3.19 R_usb_hmsc_Information()
Name Check HMSCD Operation State
Call format uint16_t R_usb_ hmsc_Information(uint16_t pipe_offset)
Arguments uint16_t pipe_offset
Return values uint16_t Pipe information table
Description Returns the value of the pipe information table.
Notes
Table 3.20 usb_hmsc_Task()
Name HMSC Task
Call format void usb_hmsc_Task(void)
Arguments void
Return values void
Description Task of HMSC
Notes