infineon / mtb-example-psoc6-usb-msc-logger

This example demonstrates how to configure the USB block in a PSoC 6 MCU as a Mass Storage (MSC) device and emulate a file system in the SRAM memory.

This repository is deprecated. Use the code example available at https://github.com/Infineon/mtb-example-psoc6-usb-msc-filesystem-freertos.

PSoC 6 MCU: USB Mass Storage Logger

This example demonstrates how to configure the USB block in a PSoC® 6 MCU as a Mass Storage (MSC) device and emulate a file system in the SRAM memory.

Overview

In this project, PSoC 6 MCU USB block is configured for Mass Storage. This allows it to enumerate on the computer as a portable storage device. The firmware emulates a file system using the internal memory with one file, which is visible to the USB host. The content of the file changes every time the user presses the kit button.

To see the Mass Storage descriptor, use the usbdev-configurator tool located at <ModusToolbox_install_dir>/tools_/usbdev-configurator. In the tool, open the design.cyusbdev file located under the /COMPONENT_CUSTOM_DESIGN_MODUS/ folder.

Requirements

• ModusToolbox™ software v2.1
• Programming Language: C
• Associated Parts: All PSoC 6 MCU parts with USB

Supported Kits

• PSoC 6 Wi-Fi BT Prototyping Kit (CY8CPROTO-062-4343W) - Default target
• PSoC 6 WiFi-BT Pioneer Kit (CY8CKIT-062-WIFI-BT)
• PSoC 62S2 Wi-Fi BT Pioneer Kit (CY8CKIT-062S2-43012)
• PSoC 62S1 Wi-Fi BT Pioneer Kit (CYW9P62S1-43438EVB-01)
• PSoC 62S1 Wi-Fi BT Pioneer Kit (CYW9P62S1-43012EVB-01)
• PSoC 62S3 Wi-Fi BT Prototyping Kit (CY8CPROTO-062S3-4343W)

Hardware Setup

This example uses the board's default configuration. See the kit user guide to ensure that the board is configured correctly.

Note: The PSoC 6 BLE Pioneer Kit (CY8CKIT-062-BLE) and the PSoC 6 WiFi-BT Pioneer Kit (CY8CKIT-062-WIFI-BT) ship with KitProg2 installed. ModusToolbox software requires KitProg3. Before using this code example, make sure that the board is upgraded to KitProg3. The tool and instructions are available in the Firmware Loader GitHub repository. If you do not upgrade, you will see an error like "unable to find CMSIS-DAP device" or "KitProg firmware is out of date".

Software Setup

This example requires no additional software or tools.

Using the Code Example

In Eclipse IDE for ModusToolbox:

1. Click the New Application link in the Quick Panel (or, use File > New > ModusToolbox Application).

2. Pick a kit supported by the code example from the list shown in the Project Creator - Choose Board Support Package (BSP) dialog.

   When you select a supported kit, the example is reconfigured automatically to work with the kit. To work with a different supported kit later, use the Library Manager to choose the BSP for the supported kit. You can use the Library Manager to select or update the BSP and firmware libraries used in this application. To access the Library Manager, right-click the application name from the Project Workspace window in the IDE, and select ModusToolbox > Library Manager. You can also access it from the Quick Panel.

   You can also just start the application creation process again and select a different kit.

   If you want to use the application for a kit not listed here, you may need to update the source files. If the kit does not have the required resources, the application may not work.

3. In the Project Creator - Select Application dialog, choose the example.

4. Optionally, update the Application Name: and Location fields with the application name and local path where the application is created.

5. Click Create to complete the application creation process.

For more details, see the Eclipse IDE for ModusToolbox User Guide: {ModusToolbox install directory}/ide_{version}/docs/mt_ide_user_guide.pdf.

In Command-line Interface (CLI):

1. Download and unzip this repository onto your local machine, or clone the repository.

2. Open a CLI terminal and navigate to the application folder. On Linux and macOS, you can use any terminal application. On Windows, navigate to the modus-shell directory ({ModusToolbox install directory}/tools_<version>/modus-shell) and run Cygwin.bat.

3. Import the required libraries by executing the make getlibs command.

In Third-party IDEs:

1. Follow the instructions from the CLI section to download or clone the repository, and import the libraries using the make getlibs command.

2. Export the application to a supported IDE using the make <ide> command.

3. Follow the instructions displayed in the terminal to create or import the application as an IDE project.

For more details, see the "Exporting to IDEs" section of the ModusToolbox User Guide: {ModusToolbox install directory}/ide_{version}/docs/mtb_user_guide.pdf.

Operation

1. Connect the board to your PC using the provided USB cable through the KitProg3 USB connector.

2. Program the board.

   • Using Eclipse IDE for ModusToolbox:

     1. Select the application project in the Project Explorer.

     2. In the Quick Panel, scroll down, and click <Application Name> Program (KitProg3).

   • Using CLI:

     From the terminal, execute the make program command to build and program the application using the default toolchain to the default target. You can specify a target and toolchain manually:

     make program TARGET=<BSP> TOOLCHAIN=<toolchain>
     

     Example:

     make program TARGET=CY8CPROTO-062-4343W TOOLCHAIN=GCC_ARM
     

     Note: Before building the application, ensure that the deps folder contains the BSP file (TARGET_xxx.lib) corresponding to the TARGET. Execute the make getlibs command to fetch the BSP contents before building the application.

3. Connect another USB cable (or reuse the same cable to program the kit) to the USB device connector (see the kit user guide for its location).

4. On computer, verify that the OS recognizes a new portable device named PSoC Logger. Confirm that a file LOG.TXT is readable.

5. Open the LOG.TXT file and read the content. It should have the message:

   PSoC Logger Content:
   

6. Close the LOG.TXT file and press the kit user button multiple times. Disconnect and reconnect the USB cable to enumerate the device again.

7. Open the LOG.TXT file again and check whether new content was added to the file:

   PSoC Logger Content:
   > Button press 1 time(s)
   > Button press 2 time(s)
   

8. Alternatively, you can press the button five times. It will emulate the device being ejected and inserted back, forcing the OS to re-read changes in the mass storage.

Debugging

You can debug the example to step through the code. In the IDE, use the <Application Name> Debug (KitProg3) configuration in the Quick Panel. For more details, see the Program and Debug section in the Eclipse IDE for ModusToolbox User Guide: {ModusToolbox install directory}/ide_{version}/docs/mt_ide_user_guide.pdf.

Design and Implementation

In the main firmware routine, the USB Device block is configured to use the MSC Device Class. The firmware also creates a simple FAT file system placed on the internal SRAM. It creates a single file named LOG.TXT. The file size is configurable through a macro and the necessary memory is allocated automatically. The USB Host can only read the contents of the file. There is no write support.

Internally, the firmware can write data strings to the file system or erase the entire file content. As an example, the firmware writes a message every time the kit user button is pressed. To read the new file content, you must disconnect and reconnect the USB cable, so that the OS requests again for the content in the file system.

The firmware also emulates the device being ejected at every five user button presses. This forces the OS to re-read the contents of the file system.

The following list shows the files of this code example:

• config.h: Configures some global options for the application
• file_system.h/c: Implements the FAT file system
• usb_scsi.h/c: Implements the USB SCSI protocol, which is used by the USB MSC Device Class
• usb_comm.h/c: Implements the USB MSC Device Class requests
• cy_usb_dev_msc.h/c: Implements the USB Device Middleware for the USB MSC Device Class (these files will eventually move to usbdev.lib)

Resources and Settings

Table 1 lists the ModusToolbox resources used in this example, and how they are used in the design.

Table 1. Application Resources

Resource	Alias/Object	Purpose
USBDEV (PDL)	CYBSP_USBDEV	USB Device configured with Mass Storage Descriptor
GPIO (HAL)	CYBSP_USER_BTN	User Button

Related Resources

Application Notes
AN228571 – Getting Started with PSoC 6 MCU on ModusToolbox	Describes PSoC 6 MCU devices and how to build your first application with ModusToolbox
AN221774 – Getting Started with PSoC 6 MCU on PSoC Creator	Describes PSoC 6 MCU devices and how to build your first application with PSoC Creator
AN215656 – PSoC 6 MCU: Dual-CPU System Design	Describes the dual-CPU architecture in PSoC 6 MCU, and shows how to build a simple dual-CPU design
Code Examples
Using ModusToolbox	Using PSoC Creator
Device Documentation
PSoC 6 MCU Datasheets	PSoC 6 Technical Reference Manuals
Development Kits	Buy at www.cypress.com
CY8CPROTO-062-4343W PSoC 6 Wi-Fi BT Prototyping Kit	CY8CKIT-062-WiFi-BT PSoC 6 WiFi-BT Pioneer Kit
CY8CKIT-062S2-43012 PSoC 62S2 Wi-Fi BT Pioneer Kit	CY8CPROTO-062S3-4343W PSoC 62S3 Wi-Fi BT Prototyping Kit
CYW9P62S1-43438EVB-01 PSoC 62S1 Wi-Fi BT Pioneer Kit	CYW9P62S1-43012EVB-01 PSoC 62S1 Wi-Fi BT Pioneer Kit
Libraries
PSoC 6 Peripheral Driver Library (PDL) and docs	psoc6pdl on GitHub
Cypress Hardware Abstraction Layer (HAL) Library and docs	psoc6hal on GitHub
RetargetIO - A utility library to retarget the standard input/output (STDIO) messages to a UART port	retarget-io on GitHub
Middleware
CapSense library and docs	capsense on GitHub
Links to all PSoC 6 MCU Middleware	psoc6-middleware on GitHub
Tools
Eclipse IDE for ModusToolbox	The multi-platform, Eclipse-based Integrated Development Environment (IDE) that supports application configuration and development for PSoC 6 MCU and IoT designers.
PSoC Creator	The Cypress IDE for PSoC and FM0+ MCU development.

Other Resources

Cypress provides a wealth of data at www.cypress.com to help you select the right device, and quickly and effectively integrate it into your design.

For PSoC 6 MCU devices, see How to Design with PSoC 6 MCU - KBA223067 in the Cypress community.

Document History

Document Title: CE230169 - PSoC 6 MCU: USB Mass Storage Logger

Version	Description of Change
1.0.0	New code example

---

All other trademarks or registered trademarks referenced herein are the property of their respective owners.

---

© Cypress Semiconductor Corporation, 2020. This document is the property of Cypress Semiconductor Corporation and its subsidiaries ("Cypress"). This document, including any software or firmware included or referenced in this document ("Software"), is owned by Cypress under the intellectual property laws and treaties of the United States and other countries worldwide. Cypress reserves all rights under such laws and treaties and does not, except as specifically stated in this paragraph, grant any license under its patents, copyrights, trademarks, or other intellectual property rights. If the Software is not accompanied by a license agreement and you do not otherwise have a written agreement with Cypress governing the use of the Software, then Cypress hereby grants you a personal, non-exclusive, nontransferable license (without the right to sublicense) (1) under its copyright rights in the Software (a) for Software provided in source code form, to modify and reproduce the Software solely for use with Cypress hardware products, only internally within your organization, and (b) to distribute the Software in binary code form externally to end users (either directly or indirectly through resellers and distributors), solely for use on Cypress hardware product units, and (2) under those claims of Cypress's patents that are infringed by the Software (as provided by Cypress, unmodified) to make, use, distribute, and import the Software solely for use with Cypress hardware products. Any other use, reproduction, modification, translation, or compilation of the Software is prohibited.
TO THE EXTENT PERMITTED BY APPLICABLE LAW, CYPRESS MAKES NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH REGARD TO THIS DOCUMENT OR ANY SOFTWARE OR ACCOMPANYING HARDWARE, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. No computing device can be absolutely secure. Therefore, despite security measures implemented in Cypress hardware or software products, Cypress shall have no liability arising out of any security breach, such as unauthorized access to or use of a Cypress product. CYPRESS DOES NOT REPRESENT, WARRANT, OR GUARANTEE THAT CYPRESS PRODUCTS, OR SYSTEMS CREATED USING CYPRESS PRODUCTS, WILL BE FREE FROM CORRUPTION, ATTACK, VIRUSES, INTERFERENCE, HACKING, DATA LOSS OR THEFT, OR OTHER SECURITY INTRUSION (collectively, "Security Breach"). Cypress disclaims any liability relating to any Security Breach, and you shall and hereby do release Cypress from any claim, damage, or other liability arising from any Security Breach. In addition, the products described in these materials may contain design defects or errors known as errata which may cause the product to deviate from published specifications. To the extent permitted by applicable law, Cypress reserves the right to make changes to this document without further notice. Cypress does not assume any liability arising out of the application or use of any product or circuit described in this document. Any information provided in this document, including any sample design information or programming code, is provided only for reference purposes. It is the responsibility of the user of this document to properly design, program, and test the functionality and safety of any application made of this information and any resulting product. "High-Risk Device" means any device or system whose failure could cause personal injury, death, or property damage. Examples of High-Risk Devices are weapons, nuclear installations, surgical implants, and other medical devices. "Critical Component" means any component of a High-Risk Device whose failure to perform can be reasonably expected to cause, directly or indirectly, the failure of the High-Risk Device, or to affect its safety or effectiveness. Cypress is not liable, in whole or in part, and you shall and hereby do release Cypress from any claim, damage, or other liability arising from any use of a Cypress product as a Critical Component in a High-Risk Device. You shall indemnify and hold Cypress, its directors, officers, employees, agents, affiliates, distributors, and assigns harmless from and against all claims, costs, damages, and expenses, arising out of any claim, including claims for product liability, personal injury or death, or property damage arising from any use of a Cypress product as a Critical Component in a High-Risk Device. Cypress products are not intended or authorized for use as a Critical Component in any High-Risk Device except to the limited extent that (i) Cypress's published data sheet for the product explicitly states Cypress has qualified the product for use in a specific High-Risk Device, or (ii) Cypress has given you advance written authorization to use the product as a Critical Component in the specific High-Risk Device and you have signed a separate indemnification agreement.
Cypress, the Cypress logo, Spansion, the Spansion logo, and combinations thereof, WICED, PSoC, CapSense, EZ-USB, F-RAM, and Traveo are trademarks or registered trademarks of Cypress in the United States and other countries. For a more complete list of Cypress trademarks, visit cypress.com. Other names and brands may be claimed as property of their respective owners.