3.6.4.19 USB SPI Click Example on SAM E51 Curiosity Nano Evaluation Kit

Description

This example demonstrates how to use the SERCOM-SPI peripheral in client mode on SAM E51 Curiosity Nano Evaluation Kit using USB SPI Click board.

This example uses the SPI peripheral library in client mode and emulates an EEPROM of 512 bytes. The emulated EEPROM consists of two pages, each of size 256 bytes. The SPI client expects two bytes of memory address from the SPI host (USB SPI Click) and the memory address can range from 0x00 to 0x1FF. The following operation can be made on the SPI client (emulated EEPROM).

Data Write: The SPI host sends the client address, followed by two bytes of the memory address, and followed by the data. The client writes the data at the requested memory address.

Data Read: Reads the requested number of bytes from the start address of emulated EEPROM in two steps:

SPI host sends the sends the client address, followed by two bytes of the memory address (read location), and followed by the number of bytes read.
SPI host sends the dummy bytes (0x00s) to read the data from the client and the count of dummy bytes to send is equal to the number of bytes read.

Modules/Technology Used

Peripheral Modules:
- PORT
- SERCOM (SPI)

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.
Download and Install MCP2210 SPI Terminal in the PC.

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.
Mount MikroElektronika USB SPI Click over mikroBUS socket #1 on the SAM E51 Curiosity Nano Evaluation Kit.
Connect the MikroElektronika USB SPI Click to the Host PC as a USB Device through a Type-A male to mini-B USB cable connected to mini-B 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,
1. 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.
2. Select Project Name and Folder,
  - Select appropriate project name and folder and click on Finish button.
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 (apps/sam_e51_cnano/same51n_mikroe_click/usb_spi/firmware/sam_e51_cnano.X) in MPLAB X IDE
Ensure SAM E51 Curiosity Nano Evaluation Kit 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

Open MCP2210 SPI Terminal Application. If the MCP2210 board is recognized, the user should see the MCP2210 Status: Connected on the far down-left corner of the window.
Configure the MCP2210 SPI Terminal as below.
Data write to emulated EEPROM (SPI Client)
Example: Write the data "0x99 and 0xAA" to emulated EEPROM at "0x000A" address location by transferring "0x02 0x00 0x0A 0x99 0xAA".
Follow the below protocol to write the data to emulated EEPROM using MCP2210 SPI Terminal.
[WR_CMD (0x02) | ADDR1 (MSB) | ADDR0 (LSB) | DATA0 | DATA1 | .. | DATAN]
Data read from emulated EEPROM (SPI Client)

Example: Read the two bytes of data from emulated EEPROM at "0x000A" address location by transferring "0x03 0x00 0x0A 0x02" and "0x00 0x00".

Follow the below protocol to initiate the data read from emulated EEPROM using MCP2210 SPI Terminal.

[RD_CMD (0x03) | ADDR1 (MSB) | ADDR0 (LSB) | Number of bytes read]

Follow the below protocol to read the data from emulated EEPROM using MCP2210 SPI Terminal.

[DUMMY | DUMMY | .. | DUMMY]

See the received data on Rx Data section on MCP2210 SPI Terminal.

Note: Make sure the dummy byte not be a read or write command value, i.e., 0x02 or 0x03.

Instructions to Add USB SPI Functionality to the Application

The user could use this demonstration as an example to add USB SPI functionality to the MPLAB Harmony v3 based application. Follow the below steps.

If the user has not downloaded the USB SPI demo yet Click Here to download, otherwise go to next step.
Unzip the downloaded .zip file.
From the unzipped folder usb_spi/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 USB SPI 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 USB SPI click example source files gets added to the project.
The USB SPI click example uses the SPI peripheral. The configuration of this peripheral 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 USB SPI click board
      Example: The USB SPI click example on SAM E51 Curiosity Nano Evaluation Kit uses mikroBUS socket #1 on the Curiosity Nano Base for Click boards to mount the USB SPI click board. The SPI lines from MCU coming to this socket are from the SERCOM1 peripheral on the MCU.
      Figure 3-65. MCC Project Graph - SPI Configuration
      
      Figure 3-66. MCC Pin Configurator - SPI Pin Configuration
- Map Generic Macros:
  - After generating the project, following the above configuration, map the generic macros used in the click routines to the Harmony PLIB APIs of the 32-bit MCU the project is running on.
  - The generic macros should be mapped in the header file click_interface.h.
  Example: The USB SPI click routines for the example on SAM E51 Curiosity Nano Evaluation Kit uses the following Harmony PLIB APIs.
The click_routines folder contain an example C source file usb_spi_example.c. The user could use usb_spi_example.c as a reference to add USB SPI functionality to the application.