3.6.4.26 Flash 2 Click Example on SAM E51 Curiosity Nano Evaluation Kit
Description
This application uses the SST26 driver to Erase/Write/Read on the Mikroe Flash 2 Click SST26 Flash memory using the SERCOM peripheral library configured in SPI mode.
Modules/Technology Used
- Peripheral Modules:
- NVMCTRL
- EVSYS
- DFP
- CMSIS Pack
- PORT
- SERCOM (USART)
- SERCOM (SPI)
- Board Support Packages:
- SAM E51 Cuirosity Nano BSP
- Drivers:
- SST26 Driver
- System Services:
- STDIO
- Middleware Libraries:
- Harmony Core
- Harmony Core
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 Mikroe Flash 2 Click and SAM E51 Curiosity Nano Evaluation Kit to the Curiosity Nano Base Board.
- 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 (flash_2/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 button in MPLAB X IDE tool bar
- Follow the steps in Running the Demo section below
Running the Demo
- Reset the device by power cycle.
- LED0 is turned ON when the data read
from SST26 Flash matches with the data written using SAM E51 Curiosity Nano Evaluation
Kit.
Instructions to Add Flash 2 Click Functionality to the Application
The user could use this demonstration as an example to add Flash 2 Click functionality to the MPLAB Harmony v3 based application. Follow the below steps.
- If the user has not downloaded the Flash 2 Click demo yet Click Here to download, otherwise go to next step.
- Unzip the downloaded .zip file.
- From the unzipped folder flash_2/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 Flash 2 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 Flash 2 Click example source files
gets added to the project.
- The Flash 2 Click example uses the
SPI, SST26 Driver, USART 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 SERCOM 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 Flash 2 Click board
Example: The Flash 2 Click example on SAM E51 Curiosity Nano Evaluation Kit uses mikroBUS socket #1 on the Curiosity Nano Base for Click boards to mount the Flash 2 Click board. The SPI lines from MCU coming to this socket are from the SERCOM1 peripheral on the MCU.
Figure 3-92. MCC Project Graph - SPI Configuration Figure 3-93. MCC Pin Configurator - SPI Pin Configuration
- Configure USART:
- Add the SERCOM peripheral block to the MCC project graph.
- Configure USART Pins using MCC
Pin configuration Window.The USART configuration depends on:
- 32-bit MCU
- 32-bit MCU development board
- The socket on which the
user has mounted the Flash 2 Click board
Example: The Flash 2 Click example on SAM E51 Curiosity Nano Evaluation Kit uses mikroBUS socket #1 on the Curiosity Nano Base for Click boards to mount the Flash 2 Click board. The USART lines from MCU coming to this socket are from the SERCOM1 peripheral on the MCU.
Figure 3-94. MCC Project Graph - USART Configuration Figure 3-95. MCC Pin Configurator - USART Pin Configuration
- Configure SST26 Driver:
- Add the SST26 Driver peripheral block to the MCC project graph.
- Connect SERCOM 1 to SST26
Driver block.
Figure 3-96. MCC Project Graph - SST26 Configuration
- Configure BSP:
- Add the SAM E51 Curiosity Nano
BSP (Board Support packages).
- Add the SAM E51 Curiosity Nano
BSP (Board Support packages).
- Configure Core:
- Add the Core block to the MCC
project graph.
Figure 3-97. MCC Project Graph - Core Configuration
- Add the Core block to the MCC
project graph.
The click_routines folder contain an example C source file flash_2_example.c. The user could use flash_2_example.c as a reference to add Flash 2 Click functionality to the application.
- Configure SPI:
Comments
- Reference Training Module: Getting Started Application on SAM E51 Curiosity Nano Evaluation Kit.
- 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, the user needs to 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)
- Video - How to Set up the Tools Required to Get Started with MPLAB® Harmony v3 and MCC
- Create a new MPLAB Harmony v3 project using MCC
- Update and Configure an Existing MHC-based MPLAB Harmony v3 Project to MCC-based Project