microSD Click example on SAM E51 Curiosity Nano Evaluation Kit

Download

Description:

This application showcases the capabilities of the microSD Click module. It demonstrates various file operations that can be performed on an SD card.

File Operations:

Creating a file
Writing data to the file
Reading data from the file
Creating a directory

These operations are accomplished using the MPLAB Harmony File System, SDSPI driver, and SPI PLIB.

File System Operations on the SD Card:

Create a file and write data to it
- The application creates a file named “mchp_sd.txt”
- The file is opened in write mode
- A text message is written to the file
Create a directory and read data from a file
- The application creates a directory named Dir1 in the root directory
- A new file named “mchp_sd2.txt” is created inside “Dir1”
- The content of “mchp_sd.txt” is read and copied into “mchp_sd2.txt”

File system layer uses:

SDSPI Driver to communicate to SD Card over SPI interface.

Modules/Technology Used:

Peripheral Modules
- Core
- GPIO
- SERCOM (SPI)
- TC0
- Timer System Service
- SDSPI Driver
- File System Service

Hardware Used:

Software/Tools Used:

This project has been verified to work with the following versions of software tools:

Refer Project Manifest present in harmony-manifest-success.yml under the project folder firmware/src/config/sam_e51_cnano

Refer the Release Notes to know the MPLAB X IDE and MCC Plugin version. Alternatively, Click Here.

Because Microchip regularly update tools, occasionally issue(s) could be discovered while using the newer versions of the tools. If the project doesn’t seem to work and version incompatibility is suspected, It is recommended to double-check and use the same versions that the project was tested with. To download original version of MPLAB Harmony v3 packages, refer to document How to Use the MPLAB Harmony v3 Project Manifest Feature

Setup:

Connect the SAM E51 Curiosity Nano Evaluation Kit to the Host PC as a USB Device through a Type-A male to micro-B USB cable connected to Micro-B USB (Debug USB) port

Programming hex file:

The pre-built hex file can be programmed by following the below steps.

Steps to program the hex file

Open MPLAB X IDE
Close all existing projects in IDE, if any project is opened.
Go to File -> Import -> Hex/ELF File
In the “Import Image File” window, Step 1 - Create Prebuilt Project, Click the “Browse” button to select the prebuilt hex file.
Select Device has “ATSAME51J20A”
Ensure the proper tool is selected under “Hardware Tool”
Click on Next button
In the “Import Image File” window, Step 2 - Select Project Name and Folder, select appropriate project name and folder
Click on Finish button
In MPLAB X IDE, click on “Make and Program Device” Button. The device gets programmed in sometime
Follow the steps in “Running the Demo” section below

Programming/Debugging Application Project:

Open the project (microsd/firmware/sam_e51_cnano.X) in MPLAB X IDE
Ensure “SAM E51 Curiosity Nano” is selected as hardware tool to program/debug the application
Build the code and program the device by clicking on the “Make and Program Device” button in MPLAB X IDE tool bar
Follow the steps in “Running the Demo” section below

Running the Demo:

After power up, when the demo is running, The microSD-click shows as below
Once the application successfully creates “mchp_sd.txt” and “Dir1/mchp_sd2.txt” LED0 on the board will light up

The success of the following file operations can be verified by connecting the SD card to a PC and examining the contents of “mchp_sd.txt” and “Dir1/mchp_sd2.txt.” The contents should match in order to consider them successful:

Creating a file
Writing data to the file
Reading data from the file
Creating a directory

Instructions to add microSD Click functionality to your application:

You could use this demonstration as an example to add microSD Click functionality to your MPLAB Harmony v3 based application. Follow the below steps.

If you haven’t downloaded the microSD Click demo yet Click Here to download, otherwise go to next step
Unzip the downloaded .zip file
From the unzipped folder microsd/firmware/src, copy the folder click_routines to the folder firmware/src under your MPLAB Harmony v3 application project
Open MPLAB X IDE
Open your application project
In the project explorer, Right click on folder Header Files
and add a sub folder click_routines by selecting “Add Existing Items from Folders…”

Click on “Add Folder…” button
Select the “click_routines” folder and select “Files of Types” as Header Files
Click on “Add” button to add the selected folder
The microSD-click example header files gets added to your project

In the project explorer, Right click on folder Source Files
and add a sub folder click_routines by selecting “Add Existing Items from Folders…”

Click on “Add Folder…” button
Select the “click_routines” folder and select “Files of Types” as Source Files
Click on “Add” button to add the selected folder
The microSD-click example source files gets added to your project

The microSD Click example uses the SPI, SDSPI Driver,TC0peripherals and PORT pins . The configuration of these peripherals for your application depends on the 32-bit MCU and development board you are using.
- Configure SPI: - Add the SPI peripheral block to the MCC project graph
  - Configure SPI Pins using MCC Pin configuration Window
    The SPI configuration depends on - 32-bit MCU - 32-bit MCU development board - The socket on which you have mounted the microSD-click board
    Example: The microSD-click example on SAM E51 Curiosity Nano Evaluation Kit uses mikroBUS socket #1 on the Curiosity Nano Base for Click boards to mount the microSD-click board. The SPI lines from MCU coming to this socket are from the SERCOM1 peripheral on the MCU.
    MCC Project Graph - SPI configuration
  MCC Pin Configurator - SPI pin configuration
- Configure SDSPI Driver: - Add the SDSPI Driver peripheral block to the MCC project graph
  - Add Instance 0 to the SDSPI Driver block and connect SERCOM 1 and File System to Instance 0
  MCC Project Graph - SDSPI configuration
- Configure File System: - Add the File System block to the MCC project graph
  
  MCC Project Graph - File System configuration
- Configure Timer:
  - Configure Timer peripheral block in the MCC project graph
    The Timer configuration depends on - 32-bit MCU
    Example: The microSD-click example on SAM E51 Curiosity Nano Evaluation Kit uses TC0 timer module on the MCU to implement the time requirement of microSD-click routines.
    MCC Project Graph - TC0 configuration
    
    MCC Project Graph - Timer configuration
- Configure Core:
  - Add the Core block to the MCC project graph MCC Project Graph - Core configuration
- Configure PORT Pins:
  - Configure PORT pins needed by microSD-click in the MCC Pin Configurator
    The PORT pin configuration depends on
    - 32-bit MCU
    - 32-bit MCU development board
    - The socket on which you have mounted the microSD-click board
      Example: The PORT pin configuration for the microSD-click example on SAM E51 Curiosity Nano Evaluation Kit is below.
      MCC Pin Configurator - PORT pin configuration
The click_routines folder contain an example C source file microsd_example.c. You could use microsd_example.c as a reference to add microSD-click functionality to your application.