Application Note
R11AN0173EU0104 Rev.1.04 Page 1 of 15
Sep.30.19
Renesas Synergy™ Platform
USBX™ Host Class M ass Storage M odu le Guid e
Introduction
This module guide will enable you to effectively use a module in your own design. Upon completion of this
guide, you will be able to add this module to your own design, configure it correctly for the target application,
and write code using the included application project code as a reference and an efficient starting point.
References to more detailed API descriptions and suggestions of other application projects that illustrate
more advanced uses of the module are included in this document and will be va luable resources for creating
more complex designs.
The USBX
™
Host Class Mass Storage module is a high-level API for USBX Host Class Mass Storage
applications and is implemented on g_ux_host. The USBX Host Class Mass Storage module uses the USB
and data-transfer peripherals on the Synergy MCU.
Contents
1. Features .................................................................................................................................. 2
2. Overview ................................................................................................................................. 2
3. Operational Overview .............................................................................................................. 2
3.1 Operational Notes and Limitations .......................................................................................................... 3
3.1.1 Operational notes .................................................................................................................................. 3
3.1.2 Limitations ............................................................................................................................................. 3
4. Including the USBX Host Class Mass Storage Module in an Application ................................. 3
5. Configuring the Storage Module .............................................................................................. 4
5.1 Configuration Settings for Low-Level Modules ........................................................................................ 5
5.2 Clock configuration .................................................................................................................................. 7
5.3 Pin configuration ...................................................................................................................................... 7
6. Using the USBX Host Class Mass Storage Module in an Application ...................................... 8
7. Application Project ................................................................................................................... 9
8. Customizing for a Target Application ..................................................................................... 12
9. Running the Application Project ............................................................................................. 12
10. Conclusion ............................................................................................................................. 13
11. Next Steps ............................................................................................................................. 13
12. Reference Information ........................................................................................................... 13
Revision History ............................................................................................................................ 15
Renesas Synergy™ Platform USBX™ Host Class Mass Storage Module Guide
R11AN0173EU0104 Rev.1.04 Page 2 of 15
Sep.30.19
1. Features
• Host controller for USB 2.0 with support for:
Root Hub
Power Manag ement
Endpoints
Transfers
• High-level APIs simplify storage operations
• Supports optional data transfers using MCU hardware for improved efficiency
Figure 1. USBX Host Class Mass Storage Module Organization, Options and Stack Implementations
2. Overview
The USBX Host Class Mass Storage module does not have a separate API available for user applications.
When a USB media is connected, it is attached to the FileX
®
member included in the USBX Host Class Mass
Storage instance. The user application uses this FileX member to access files on the USB media. For FileX
APIs, refer to the FileX User Guide for the Renesas Synergy™ Platform for more details. This document is
part of an X-Ware™ Component Documents for Renesas Synergy™ zip file available from the Renesas
Synergy Gallery (www.renesas.com/synergy/software
).
3. Operationa l Overview
Initial ization of USBX Resources
The USBX has its own memory manager. The memory needs to be allocated to the USBX before the host or
device side of the USBX is initialized. The USBX memory manager can accommodate systems where
memory can be cached.
Definition of USB Host Controllers
It is required to define at least one USB host controller for the USBX to operate in host mode. The application
initialization file should contain this definition.