Low Power Application on SAM L21 Using Harmony v3 Peripheral Libraries: Step 6


< Back to Lab Start


Step 6: Add application code to the project

The application is already developed and is available in the main.c file under <your unzip folder>/saml21_low_power/dev_files/sam_l21_xpro. The main.c file contains the application logic. It also contains placeholders that you will populate with necessary code in the next step.

  • Go to the saml21_low_power/dev_files/sam_l21_xpro folder and copy the pre-developed main.c file.
  • Replace (over-write) the main.c file of your project available at < Your project folder>/saml21_low_power/firmware/src with the copied file.
  • Open main.c in MPLAB® X IDE and add the application code by following the steps below:

1

Implement temperature sensor slave address by adding the following code before the int main (void) function in main.c.

#define TEMP_SENSOR_SLAVE_ADDR                         0x004F
#define TEMP_SENSOR_REG_ADDR                           0x00

2

Implement the registered callback interrupt handlers for DMA, I²C, ADC, and External Interrupt Controller (EIC) Peripheral Library (PLIBs) by adding the following code before the int main (void) function in main.c.

static void dmaChannel0Handler (DMAC_TRANSFER_EVENT event, uintptr_t contextHandle)
{
    if(event == DMAC_TRANSFER_EVENT_COMPLETE)
    {
        isDMATransferComplete = true;
    }
}

static void i2cEventHandler (uintptr_t contextHandle)
{
    if(SERCOM2_I2C_ErrorGet() == SERCOM_I2C_ERROR_NONE)
    {
        isTemperatureRead = true;
    }

    else
    {
        printf ("There were an error during I2C Transmit. Please ensure that the I/O1 Xplained Pro is connected to the board.\n\n\r");
    }
}

static void adcEventHandler (ADC_STATUS status, uintptr_t context)
{
    isADCWinMonitorEvent = true;
}

static void EIC_User_Handler (uintptr_t context)
{
    sleepMode = true;
}

3

Under the main.c file, in function main, notice the call to function SYS_Initialize. The generated function SYS_Initialize initializes all the peripheral modules configured through MHC and used in the application.

Tip: Press the CTRL key and left click on the SYS_Initialize function. This will open the implementation for the SYS_Initialize function as shown below.

sys_initialize_function.png

4

In the main.c function, below SYS_Initialize(), add the following code to register callback event handlers, enable the ADC, start the RTC timer, display message and enter Standby mode.

EIC_CallbackRegister (EIC_PIN_2, EIC_User_Handler, 0);

SERCOM2_I2C_CallbackRegister (i2cEventHandler, 0);

DMAC_ChannelCallbackRegister (DMAC_CHANNEL_0, dmaChannel0Handler, 0);

ADC_CallbackRegister (adcEventHandler, 0);

ADC_Enable ();

RTC_Timer32Start ();

printf ("\n\n\r---------------------------------------------------------");
printf ("\n\r           Low-power Application on SAM L21 Xpro           ");
printf ("\n\r---------------------------------------------------------\n\n\r");

printf ("Enter Standby sleep mode\n\n\r");
PM_StandbyModeEnter ();

Note:

a

The function call EIC_CallbackRegister registers an EIC callback interrupt handler with the EIC PLIB. The interrupt handler is called by EIC PLIB when switch button SW0 is pressed to enter into Idle mode.

b

The function call SERCOM2_I2C_CallbackRegister registers a callback interrupt handler with the I²C PLIB. The interrupt handler is called by the I²C PLIB when the I²C reads the temperature value from the temperature sensor.

c

The function call DMAC_ChannelCallbackRegister registers a callback interrupt handler with the Direct Memory Access (DMA) PLIB. The callback interrupt handler is called by the DMA PLIB when the DMA transfer (of temperature sensor data to the serial terminal) is complete.

d

The function call ADC_CallbackRegister registers an ADC callback interrupt handler with the ADC PLIB. The interrupt handler is called by the ADC PLIB when the ADC Window Monitor event occurs. The ADC Window Monitor event occurs when the ADC result exceeds the lower threshold value of 3000, set when configuring the ADC PLIB in MHC.

e

The function call ADC_Enable enables the ADC module. The ADC is used to sample the light sensor when a trigger is received from the Event System Channel 0, every 500 milliseconds.

f

The function call RTC_Timer32Start starts the Real-Time Clock (RTC) timer. The event output from RTC is fed as input to the Event System and is used to trigger the ADC conversion.

g

The function call PM_StandbyModeEnter moves the device to Standby mode. After a call to the PM_IdleModeEnter Application Programming Interface (API), the CPU will enter Idle Sleep mode. The ADC Window Monitor interrupt will bring the CPU out of the Sleep mode.

5

Inside the while loop, add the code below to unset the isADCWinMonitorEvent flag, turn on the LED0, print the message and submit an I²C transfer to read the temperature sensor value. When the submitted request is completed, the i2cEventHandler callback function declared in step 2 is called.

if (isADCWinMonitorEvent == true)
{            
    isADCWinMonitorEvent = false;
    LED0_Clear ();
    printf ("ADC_WINMON Interrupt Detected. Wake-up from sleep mode.\n\r");
    SERCOM2_I2C_WriteRead (TEMP_SENSOR_SLAVE_ADDR, &i2cWrData, 1, i2cRdData, 2);
}

6

Inside the while loop, add the code below to unset the isTemperatureRead flag, store the temperature read into the temperatureVal variable, fill uartTxBuffer with the converted temperature value in degrees Fahrenheit and transmit this value to the terminal through the SERCOM3 USART peripheral by using the DMA.

if (isTemperatureRead == true)
{
    isTemperatureRead = false;
    temperatureVal = getTemperature (i2cRdData);
    sprintf ((char*)uartTxBuffer, "Temperature = %02d F \r\n", temperatureVal);
    while (!SERCOM3_USART_TransmitterIsReady());
    DMAC_ChannelTransfer (DMAC_CHANNEL_0, uartTxBuffer, (const void*)&(SERCOM3_REGS->USART_INT.SERCOM_DATA), sizeof(uartTxBuffer));
}

7

Inside the while loop, add the code below to unset the isDMATransferComplete flag, print the message, turn off the LED0 and put the device in Standby mode by using the PM_StandbyModeEnter () function.

if (isDMATransferComplete == true)
{      
    isDMATransferComplete = false;
    printf("DMA transfer completed. Enter Standby sleep mode.\n\n\r");
    LED0_Set ();
    PM_StandbyModeEnter ();
}

8

Inside the while loop, add the code below to unset the sleepMode flag, toggle pin PB05, print the message, turn off the LED0 and put the device in Idle mode by using the PM_IdleModeEnter () function.

if (sleepMode == true)
{
    sleepMode = false;
    TEST_GPIO_Toggle ();
    printf ("SW0 button pressed. Enter Idle sleep mode.\n\n\r");
    LED0_Set ();
    PM_IdleModeEnter ();
}

9

In the plib_eic.c file, add #include "definitions.h" at the top and scroll down to the EIC_InterruptHandler function and add the following code at the top of it. This GPIO is toggled in the Interrupt Service Routine (ISR) of the SW0 press interrupt to measure wake-up time. The time between the switch press and the GPIO toggle in the ISR is the wake-up time.

TEST_GPIO_Toggle();
eic_interrupt_handler.png

You are now ready to build the code and observe the results!

DMA, I²C, and USART transfers can also be configured to run in Sleep mode using the Event System and Run in Standby options available in the peripheral.



< Back to Lab Start


© 2020 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.