1.6 HUB MSD Example (hub_msd)

This application demonstrates the ability of the MPLAB Harmony USB Host Stack to interact with more than one USB Mass Storage Device through a Hub.

Description

This application uses USB Host stack and the Harmony Filesystem Service to copy a file from a source USB pen drive to a target USB pen drive.

Downloading and building the application

To clone or download this application from Github, go to the main page of this repository and then click Clone button to clone this repository or download as zip file. This content can also be downloaded using content manager by following these instructions.

Path of the application within the repository is usb_apps_host/apps/hub_msd.

Following table gives the details of project configurations, target device used, hardware and its IDE. Open the project using the respective IDE and build it.


Project Name	IDE	Target Device	Hardware / Configuration
pic32mz_ef_curiosity_2_0.X	MPLABX	PIC32MZ2048EFM144	Curiosity PIC32MZ EF 2.0 Development Board
pic32mx470_curiosity.X	MPLABX	PIC32MX470F512H	PIC32MX Curiosity Development Board
pic32mz_ef_sk.X	MPLABX	PIC32MZ2048EFH144	PIC32MZ Embedded Connectivity with FPU (EF) Starter Kit
sam_9x60_ek.X	MPLABX	SAM9X60	SAM9X60-EK Evaluation Board
sam_9x60_curiosity.X	MPLABX	SAM9X60	SAM9X60 Curiosity Development Board
sam_9x60_curiosity_freertos.X	MPLABX	SAM9X60	SAM9X60 Curiosity Development Board
sam_a5d2_xult.X	MPLABX	ATSAMA5D27C	SAMA5D2 Xplained Ultra Board
sam_a5d27_som1_ek.X	MPLABX	ATSAMA5D27C	SAMA5D27 SOM1 Kit1
sam_a5d27_wlsom1_ek1.X	MPLABX	ATSAMA5D27C	ATSAMA5D27 WLSOM1 EK1
sam_a7g5_ek.X	MPLABX	SAMA7G54	SAMA7G5 EK Board
sam_d21_xpro.X	MPLABX	ATSAMD21J18A	SAMD21 Xplained Pro Board
sam_e54_xpro.X	MPLABX	ATSAME54P20A	SAME54 Xplained Pro Board
sam_g55_xpro.X	MPLABX	ATSAMG55J19	SAMG55 Xplained Pro Board
pic32cz_ca80_curiosity_ultra.X	MPLABX	PIC32CZ8110CA80208	PIC32CZ Curiosity Development Board
pic32ck_gc01_curiosity_ultra.X	MPLABX	PIC32CK2051GC01144	PIC32CK GC Curiosity Ultra Development Board
pic32cx_sg41_curiosity_ultra.X	MPLABX	PIC32CX1025SG41128	PIC32CX SG41 Curiosity Ultra Evaluation Board
sam_a5d29_curiosity.X	MPLABX	ATSAMA5D29	SAMA5D29 Curiosity Development Board
sam_9x75_curiosity.X	MPLABX	SAM9X75D2G	SAM9X75-Curiosity Development Board
sam_a7d65_curiosity.X	MPLABX	SAMA7D65	SAMA7D65 Curiosity Development Board
wbz653_curiosity.X	MPLABX	WBZ653	WBZ653 Curiosity Board

Configuring the Hardware

PIC32CZ CA80 Curiosity Development Board

An external power supply (6.5V to 14V) must be connected through the J100 connector.
Connect the USB Hub to the micro A/B connector (J102) using a USB Type-A Female to micro-B male cable (This cable is not included in the kit).
LED0 on the demonstration board will illuminate to indicate completion of the file transfer.

PIC32CX SG41 Curiosity Ultra Evaluation Board

An external power supply (6.5V to 14V) must be connected through the J201 connector.
Connect the USB Hub to the micro A/B connector (J200) using a USB Type-A Female to micro-B male cable (This cable is not included in the kit).
LED2 on the demonstration board will illuminate to indicate completion of the file transfer.

PIC32CK GC Curiosity Ultra Development Board

An external power supply (6.5V to 14V) must be connected through the J200 connector.
Connect the USB Hub to the micro C connector (J202). A USB Type-C to Type-A Female adapter is required to connect the USB device to the board. (This adapter is not included in the kit).
LED1 on the demonstration board will illuminate to indicate completion of the file transfer.

Curiosity PIC32MZ EF 2.0 Development Board

Connect the USB Hub to the "TARGET USB" connector (J201) using a USB Type-A Female to micro-B male cable (This cable is not included in the kit).
LED1 on the demonstration board will illuminate to indicate completion of the file transfer.

Curiosity PIC32MX470 Development Board

Install a jumper in the J13 header to drive the VBUS line in Host mode.
Connect the USB Hub to the USB micro-AB connector J12 using a USB Type-A Female to micro-B male cable (This cable is not included in the kit).
LED1 on the demonstration board will illuminate to indicate completion of the file transfer.

PIC32MZ Embedded Connectivity with FPU (EF) Starter Kit

Connect the USB Hub to the Type-A connector J5, which is located on the top side of the starter kit.
LED1 on the demonstration board will illuminate to indicate completion of the file transfer.

SAMD21 Xplained Pro Board

Connect the Debug USB port on the board to the computer using a micro USB cable
Jumper titled "PA03 SELECT" must be shorted between PA03 and USB_ID(positions 2 and 3)
Use "TARGET USB" connector on the board to connect the USB Device to the the USB Host. A USB micro AB to type A USB Host receptacle converter will be needed to connect the device.
LED0 on the demonstration board will illuminate to indicate completion of the file transfer.
Note: Note: An unexpected behavior may be observed if the attached USB device draws an excess amount of current from the board and the Vdd voltage drops below 2.7 volts. The demo has the wait states (NVM_CTRLB <RWS[3:0]>) value set to '1'.

SAME54 Xplained Pro Board

Connect the Debug USB port on the board to the computer using a micro USB cable
Use "TARGET USB" connector on the board to connect the USB Device to the the USB Host. A USB micro AB to type A USB Host receptacle converter will be needed to connect the device.
LED0 on the demonstration board will illuminate to indicate completion of the file transfer.

SAMG55 Xplained Pro Board

Chip Erase Jumper must be open.
Connect the USB device to the "TARGET USB" connector using a USB Type-A Female to micro-B male cable (This cable is not included in the kit).
LED0 on the demonstration board will illuminate to indicate completion of the file transfer.

SAM9X60-EK Evaluation Board

Setup the SD card (Note: exFAT formatted SD Cards are not supported)
- Download harmony MPU bootstrap loader from this location.
- Copy the downloaded boot loader binary (boot.bin) and generated application binary (harmony.bin) into the SD card.
- Insert the SD card into the SDMMC connector J4 on the board.
- Reset the board by pressing the Push Button SW3.
Jumpers J20, J21, and J13 must be open.
Jumper J2 and J3 must be shorted.
Connect the USB Micro-B port J22 on board to the computer using a micro USB cable (to enable debug com port).
Connect the USB Micro-B Connector (J7) on the board to the computer using a micro USB cable to power up the board.
Connect the USB Hub to the Type-A connector (J8).
LED D1 indicates that the file transfer is complete.

Note: Reset push button on SAM9X60 EK is labeled as SW3

SAM9X60-Curiosity Board

Setup the SD card (Note: exFAT formatted SD Cards are not supported)
- Download harmony MPU bootstrap loader from this location.
- Copy the downloaded boot loader binary (boot.bin) and generated application binary (harmony.bin) into the SD card.
- Insert the SD card into the SDMMC0 connector J3 on the board.
- Reset the board by pressing the Push Button RESET.
Jumper J4 must be shorted.
Connect the USB Micro-B Connector (J1) on the board to the computer using a micro USB cable to power up the board.
Connect the USB Hub to the Type-A connector (J10).
LED D1 indicates that the file transfer is complete.

SAMA5D2 Xplained Ultra Board

Setup the SD card (Note: exFAT formatted SD Cards are not supported)
- Download harmony MPU bootstrap loader from this location.
- Copy the downloaded boot loader binary (boot.bin) and generated application binary (harmony.bin) into the SD card.
- Insert the SD card into the SDMMC1 slot on the board.
- Reset the board by pressing the Push Button BP3.
Connect the EDBG USB Micro-B port J14 on the board to the computer using a micro USB cable.
Connect the USB Hub to the USB Type-A connector "A5-USB-B" (J13).
RGB LED turning to Green indicates the file write is complete.

SAMA5D27 SOM1 Kit1

Setup the SD card (Note: exFAT formatted SD Cards are not supported)
- Download harmony MPU bootstrap loader from this location.
- Copy the downloaded boot loader binary (boot.bin) and generated application binary (harmony.bin) into the SD card.
- Insert the SD card into the SDMMC0 slot (J12) on the board.
- Reset the board by pressing the Push Button PB1.
Connect the Debug USB port (J10) on the board to the computer using a micro USB cable.
Connect the USB Hub to the USB-B Type-C connector (J19) on the board.
RGB LED turning to Green indicates the file write is complete.

ATSAMA5D27-WLSOM1 Evaluation Kit

Setup the SD card (Note: exFAT formatted SD Cards are not supported)
- Download harmony MPU bootstrap loader from this location.
- Copy the downloaded boot loader binary (boot.bin) and generated application binary (harmony.bin) into the SD card.
- Insert the SD card into the SDMMC0 Card Connector (J9) on the board.
- Reset the board by pressing the Reset Button (SW2)
Connect the USB-A MicroAB connector (J10) on the board to the computer using a micro USB cable.
Press the "START_SOM" button to activate board start-up.
Connect the USB Hub to the USB Type-A connector (J11) on the board.
RGB LED turning to Green indicates the file write is complete.

SAMA7G5-EK Evaluation Kit

Powered the board with an external power supply (J1).
Setup the SD card (Note: exFAT formatted SD Cards are not supported)
- Download harmony MPU bootstrap loader from this location.
- Copy the downloaded boot loader binary (boot.bin) and generated application binary (harmony.bin) into the SD card.
- Insert the SD card into the SD Card Connector (J4) on the board.
- Reset the board by pressing the Reset Button (nRST)
Press the "nSTART" button to activate board start-up.
Connect the USB device to the USB Host Type-A connector (J9) on the board. Alternatively, the USB Device could be connected to the Type-C connector (J8) or micro A/B connector (J7).
RGB LED turning to Green indicates the file write is complete.

SAMA5D29 Curiosity Development Board

Setup the SD card (Note: exFAT formatted SD Cards are not supported)
- Download harmony MPU bootstrap loader from this location.
- Copy the downloaded boot loader binary (boot.bin) and generated application binary (harmony.bin) into the SD card.
- Insert the SD card into the μSD-CARD connector J6 on the board.(This connector is present on the bottom face of the board)
- Reset the board by pressing the Push Button RESET.
Press the "START" button to activate board start-up.
Connect the USB device to the USB_B Type-A connector (J11) on the board.
RGB LED (D5) turning to Green indicates the file write is complete.

SAM9X75-Curiosity Development Board

Setup the SD card (Note: exFAT formatted SD Cards are not supported)
- Download harmony MPU bootstrap loader from this location.
- Copy the downloaded boot loader binary (boot.bin) and generated application binary (harmony.bin) into the SD card.
- Insert the SD card into the μSD-CARD connector (J14) on the board.(This connector is present on the bottom face of the board)
- Reset the board by pressing the Push Button RESET.
Press the "START" button to activate board start-up.
Connect the USB device to the USB_B Type-A connector (J15) or USB_C Type-A connector (J16) on the board.
RGB LED (LD1) turning to Green indicates the file write is complete.

SAMA7D65 Curiosity Development Board

Setup the SD card (Note: exFAT formatted SD Cards are not supported)
- Download harmony MPU bootstrap loader from this location.
- Copy the downloaded boot loader binary (boot.bin) and generated application binary (harmony.bin) into the SD card.
- Insert the SD card into the SD-CARD connector (J10) on the board.
- Reset the board by pressing the Push Button RESET.

Press the "START" button to activate board start-up.
Connect the USB device to the USB_B Type-A connector (J23) or USB_C Type-A connector (J24) on the board.
RGB LED turning to Green indicates the file write is complete.

WBZ653 Curiosity Board

Connect a Type-C cable between the DBG USB (J100) port on the board and the PC to power up the board.
The Jumper J102 must be shorted between 5V and VBUS.
The Jumper J104 must be connected between VBUSON and EN (Positions 2 and 3).
Connect the USB Hub to the USB Type-C connector TARGET USB (J103). A USB Type-C to Type-A Female adapter is required to connect the USB device to the board (This adapter is not included in the kit).
The RGB_LED (D800) turing Green on the demonstration board will illuminate to indicate completion of the file transfer.

Running the Application

This application demonstrates the capability of the USB Host Stack to access and manage multiple USB Devices through a Hub. The demonstration application copies a file from one USB pen drive (i.e.,a USB Flash storage device) to another USB pen drive, where these pen drives are attached to a hub.

Open the project in the MPLAB X IDE. Refer to Building the Application section for available demo projects.
Build the code and program the device.
Connect a hub to the Host connector on the desired board.
Connect a USB Pen drive containing an arbitrary file named "file.txt" to a spare port on the hub.
Connect another USB pen drive to another spare port on the hub.
The application will copy the file "file.txt" from the drive containing this file to the other drive. The copied file will be renamed as "newfile.txt". LED on the demonstration board will illuminate to indicate completion of the file transfer.
Disconnect the drives and confirm demonstration success by inserting them into a personal computer and verifying the file transfer completed as expected.
The demonstration application will always be in state where it waits for two pen drives to be connected to the hub and at least one of these pen drives contains a file named "file.txt".