3.6.4.23 microSD Click Example on SAM E51 Curiosity Nano Evaluation Kit
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"
- 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.
Because Microchip regularly updates tools, occasionally issue(s) could be discovered while using the newer versions of the tools. If the project does not 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 (DS90003305).
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.
- 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,
- Create Prebuilt
Project,
- Click the Browse button to select the prebuilt hex file.
- Select Device as ATSAME51J20A.
- Ensure the proper tool is selected under Hardware Tool and click on Next button.
- Select Project
Name and Folder,
- Select appropriate project name and folder and click on Finish button
- Create Prebuilt
Project,
- In MPLAB X IDE, click on Make and Program Device button to program the device.
- 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 the Application
The user could use this demonstration as an example to add microSD Click functionality to the MPLAB Harmony v3 based application. Follow the below steps.
- If the user has not 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 the MPLAB Harmony v3 application project.
- Open MPLAB X IDE.
- Open the 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 the 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 the project.
- The microSD Click example uses the SPI, SDSPI
Driver,TC0 peripherals and PORT pins. The
configuration of these peripherals for the application depends on the 32-bit
MCU and development board the user is 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 the user has 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.
Figure 3-77. MCC Project Graph - SPI Configuration Figure 3-78. 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.
Figure 3-79. MCC Project Graph - SDSPI Configuration - Configure File
System:
- Add the File System block to the MCC project graph.
Figure 3-80. 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.
Figure 3-81. MCC Project Graph - TC0 Configuration Figure 3-82. MCC Project Graph - Timer Configuration
- 32-bit MCU
- Configure
Timer peripheral block in the MCC project graph.
- Configure
Core:
- Add the Core
block to the MCC project graph.
Figure 3-83. MCC Project Graph - Core configuration
- Add the Core
block to the MCC project graph.
- 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 the user has mounted the
microSD-click board
Example: The PORT pin configuration for the microSD-click example on SAM E51 Curiosity Nano Evaluation Kit is below.
Figure 3-84. MCC Pin Configurator - PORT Pin Configuration
- Configure
PORT pins needed by microSD-click in the MCC Pin
Configurator.
The click_routines folder contain an example C source file microsd_example.c. The user could use microsd_example.c as a reference to add microSD-click functionality to the application.
- Configure
SPI:
Comments
- Reference Training Module:
- This application demo
builds and works out of box by following the instructions above in
Running the Demo section. If the user needs to
enhance/customize this application demo, should use the MPLAB Harmony v3
Software framework. Refer links below to setup and build the
applications using MPLAB Harmony.
- How to Setup MPLAB Harmony v3 Software Development Framework (DS90003232).
- How to Build an Application by Adding a New PLIB, Driver, or Middleware to an Existing MPLAB Harmony v3 Project (DS90003253).
- MPLAB Harmony v3 is configurable through MPLAB Code Configurator (MCC). Refer to the below links for specific instructions to use MPLAB Harmony v3 with MCC.