Getting Started with Harmony v3 Drivers and System Services on SAM E70/S70/V70/V71 MCUs

 Objective

MPLAB® Harmony v3 is a flexible, fully integrated embedded software development framework for 32-bit microcontrollers (MCUs) and microprocessors (MPUs).

MPLAB Harmony v3 includes the MPLAB Harmony Configurator (MHC) tool, a set of modular devices and middleware libraries. Additionally, there are numerous example applications, all of which are designed to help you quickly and easily develop powerful and efficient embedded software for Microchip’s 32-bit PIC® and SAM devices.

This tutorial shows you how to use MHC to create an application that gets you started in developing applications on SAM E70/S70/V70/V71 MCUs using MPLAB Harmony v3 software framework.

The application makes use of the SAM E70 Xplained Ultra Evaluation Kit and I/O1 Xplained Pro Extension Kit (sold separately).

The application reads the current room temperature from the temperature sensor on the I/O1 Xplained Pro Extension Kit. The temperature reading is displayed on a serial console periodically every second. Further, the application writes the temperature readings to EEPROM. When a character is entered on the console, the last five written temperature values are read from the EEPROM and displayed on the console. Also, an LED (LED3) is toggled every time the temperature is displayed on the serial console.

The application you create will utilize:

  • Two-Wire Interfaces (TWIHS) (I²C) Driver to read the temperature from a temperature sensor and store/retrieve to/from EEPROM.
  • Timer System Service to periodically sample temperature sensor data.
  • Universal Synchronous Asynchronous Receiver Transmitter (USART) Driver (in Direct Memory Access (DMA) mode) to print the temperature values on a COM (serial) port terminal application running on a PC.
  • PORTS Peripheral Library to toggle an LED.

In the process, the lab will also demonstrate the use of callback functions.

Two ways to use this tutorial:

  1. Create the project from scratch:
    • Use the provided source files and step-by-step instructions below.
  2. Use the solution project as an example:
    • Build the solution project and download it to the SAM E70 Xplained Ultra Evaluation Kit Board to observe the expected behavior.

Lab Objectives

  1. Create an MPLAB® X IDE Harmony v3 project for a SAM E70 microcontroller from scratch.
  2. Use MHC to configure and generate Harmony Driver code for I²C and USART peripherals.
  3. Along with the configuration of drivers for I²C and USART peripherals, use MHC to configure and generate Harmony v3 peripheral libraries for the I²C, USART, DMA, and PORTS peripherals.
  4. Use MHC to configure and generate the Harmony System Service code for the Timer peripheral.
  5. Along with the configuration of Timer System Service, use MHC to configure and generate Harmony v3 peripheral libraries for the TC peripheral.
  6. Use the Harmony v3 Driver, System Service and Peripheral Library Application Programming Interfaces (APIs) to implement the application.

 Materials

Hardware Tools

Tool About Purchase
board-50px.png
SAM E70 Xplained Ultra
Evaluation Kit
io1-xpro-extension-50px.png
I/O1 Xplained Pro
Extension Kit

The Xplained Pro series evaluation kits include an on-board Embedded Debugger (EDBG). No external tools are necessary to program or debug the ATSAME70Q21B. For programming/debugging, the EDBG connects to the host PC through the USB micro-B connector on the SAM E70 Xplained Ultra Evaluation Kit.

Connection Diagram

The application has the temperature sensor and EEPROM connected to the SAM E70 over I²C interface and the console (serial terminal) on a PC connected over USART interface (through USB to USART convertor).

connection_diagram.png

Software Tools

This project has been verified to work with the following versions of software tools:
MPLAB X IDE v5.20, MPLAB XC32 Compiler v2.20, MPLAB Harmony CSP v3.5.0, DEV_PACKS v3.5.0, MHC v3.3.2, CORE v3.5.0

Because we regularly update our tools, occasionally you may discover an issue while using the newer versions. If you suspect that to be the case, we recommend that you double-check and use the same versions that the project was tested with.

Tool About Installers
Installation
Instructions
Windows Linux Mac OSX
MPLAB® X
Integrated Development Environment
MPLAB® XC32
C/C++ Compiler

For this lab, download the following repositories from GitHub:

  • CSP: The following table shows the summary of contents.
Folder Description
apps Example applications for CSP library components
arch Initialization and starter code templates and data
docs CSP library help documentation
peripheral PLIB templates and configuration data
  • DEV_PACKS: The following table shows the summary of contents.
Folder Description
Microchip Peripheral register specific definitions
arm Core Specific Register Definitions (CMSIS)
  • MHC: The following table shows the summary of contents.
File/Folder Description
doc Help documentation and licenses for libraries used
np_templates New Project templates for supported toolchains
*.jar Java implementations of MHC modules
mhc.jar Main Java executable (run: java -jar mhc.jar -h)
runmhc.bat Windows cmd batch file to run standalone MHC Graphical User Interface (GUI)
  • CORE: The following table shows the summary of contents.
Folder Description
apps Example applications for core library components
config Core module configuration scripts
docs Core module library help documentation
driver Core module peripheral device drivers
osal MPLAB Harmony Operating System Abstraction Layer
system MPLAB Harmony system services
templates Application and system file templates

Overview

This lab shows you how to create an MPLAB Harmony v3 project from scratch, to configure and generate:

  • Harmony v3 Peripheral Libraries code for the TC, I²C, USART, DMA, and PORTS peripherals
  • Harmony v3 Driver code for the I²C and USART peripherals
  • Harmony v3 System Service code for the timer peripheral

It demonstrates the reading of temperature sensor values from the temperature sensor available on the I/O1 Xplained Pro Extension Kit periodically and displays it on a serial console. It further writes the temperature readings to EEPROM. When a character is entered on the console, the last five written temperature values are read from the EEPROM and displayed on the console. Also, an LED is toggled every time the temperature is displayed on the serial console.

The application is divided into two tasks: the Sensor task and the EEPROM task. Each runs its state machines. The Sensor and the EEPROM tasks are called from SYS_Tasks routine which is run in a while (1) loop.

task_state_machine.png
Figure 1.1 shows the Application Tasks' state machine.

After the initialization of the I²C sensor client and USART driver, the sensor task waits for the one-second periodic timer event. On every one-second periodic timer event, the sensor task submits a temperature sensor read request through the I²C interface. When a temperature sensor read is completed, the application submits a USART write request to transfer the read temperature values to a serial terminal on a PC, at the same time, the sensor task notifies the EEPROM task to store the read temperature value in the EEPROM.

sensor_task_state_machine.png
Figure 1.2 shows the Sensor Task state machine.

After the initialization of the I²C EEPROM client, the EEPROM task submits a USART read request to receive any user input. Parallelly, for every notification from the sensor task to store the values in the EEPROM, the EEPROM task writes the value to the EEPROM. When user input is received (as a character from the serial terminal on the PC), the EEPROM task submits an I²C request to read the stored (last five) temperature values. When the EEPROM read is completed, the EEPROM task prints the read temperature values on the serial terminal.

eeprom_task_state_machine1.png
Figure 1.3 shows the EEPROM Task state machine.

Lab Source Files and Solutions

This .zip file contains the completed solution project for this lab. It also contains the source files needed to perform the lab as per the following step-by-step instructions (see the "Procedure" section on this page).

The contents of this .zip file need to be placed in the folder below:

<Any directory of your choice>/training/
(example Directory = C:/microchip/harmony/v3_5_0)

Note:

  1. The project location of a Harmony v3 project is independent of the location of the Harmony Framework path (i.e., you do not need to create or place a Harmony v3 project in a relative path under the Harmony v3 framework folder). The project can be created or placed in any directory of your choice.
  2. The point above is true because when created, a Harmony v3 project generates all the referred source/header files and libraries (if any) under the project folder.
  3. Both points above contrast with Harmony v2 project location. In Harmony v2, the project was supposed to be created in a location under the Harmony framework.


Extracting the .zip file creates the following folders:

  • getting_started contains the lab solution (in the firmware folder) and source files (in the dev_files folder).
    • dev_files contains subfolder sam_e70_xult containing application source files and other support files (if any) required to perform the lab (see "Procedure" section below).
    • firmware contains the completed lab solution project. It can be directly built and downloaded on the hardware to observe expected behavior.

Procedure

All steps must be completed before you will be ready to build, download, and run the application.

Lab Index

Step 1: Create Project and Configure the SAM E70

  • Step 1.1 - Install the MPLAB Harmony Configurator (MHC) Plug-in in MPLAB X IDE
  • Step 1.2 - Create MPLAB Harmony v3 Project using MPLAB X IDE
  • Step 1.3 - Verify Clock Settings

Step 2: Configure I²C, USART Drivers and Timer System Service

  • Step 2.1 - Configure Timer System Service
  • Step 2.2 - Configure I²C Driver and I²C Pins
  • Step 2.3 - Configure USART Driver and USART Pins

Step 3: Configure Pin for LED

  • Step 3.1 - Configure LED Pin
  • Step 3.2 - Rename the Default Main File
  • Step 3.3 - Configure Application Tasks

Step 4: Generate Code

Step 5: Add Application Code to the Project

Step 6: Build, Program, and Observe the Outputs

© 2019 Microchip Technology, Inc.
Notice: ARM and Cortex are the registered trademarks of ARM Limited in the EU and other countries.
Information contained on this site regarding device applications and the like is provided only for your convenience and may be superseded by updates. It is your responsibility to ensure that your application meets with your specifications. MICROCHIP MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WHETHER EXPRESS OR IMPLIED, WRITTEN OR ORAL, STATUTORY OR OTHERWISE, RELATED TO THE INFORMATION, INCLUDING BUT NOT LIMITED TO ITS CONDITION, QUALITY, PERFORMANCE, MERCHANTABILITY OR FITNESS FOR PURPOSE. Microchip disclaims all liability arising from this information and its use. Use of Microchip devices in life support and/or safety applications is entirely at the buyer's risk, and the buyer agrees to defend, indemnify and hold harmless Microchip from any and all damages, claims, suits, or expenses resulting from such use. No licenses are conveyed, implicitly or otherwise, under any Microchip intellectual property rights.