MPLAB® Harmony v3 Drivers on SAM E70/S70/V70/V71 Using FreeRTOS™: Step 5

Last modified by Microchip on 2023/11/09 09:09

Add Application Code to the Project

The application is already developed and is available in the files:

  • app_sensor_thread.c,
  • app_sensor_thread.h,
  • app_eeprom_thread.c,
  • app_eeprom_thread.h,
  • app_user_input_thread.c, and
  • app_user_input_thread.h.

They are available under:
<your unzip folder>/getting_started_freertos/dev_files/sam_e70_xult.

The application files app_sensor_thread.c, app_eeprom_thread.c, and app_user_input_thread.c contain the application logic. They also contain placeholders that you will populate with the necessary code in the next step.

Go to the getting_started_freertos/dev_files/sam_e70_xult folder and copy the pre-developed files:

  • app_sensor_thread.c,
  • app_sensor_thread.h,
  • app_eeprom_thread.c,
  • app_eeprom_thread.h,
  • app_user_input_thread.c, and
  • app_user_input_thread.h.

Paste and replace (over-write) the files of your project available at <your project folder>/getting_started_freertos/firmware/src with the copied files.

The main_e70.c file calls the SYS_Tasks() routine, which creates the sensor, EEPROM, and user input threads and makes a call to FreeRTOS Application Programming Interface (API) vTaskStartScheduler() to start the scheduler.

SYS_Tasks() routine

Observe that each application task runs in its individual RTOS thread.

The app_sensor_thread.h, app_eeprom_thread.h, and app_user_input_thread.h files define the states and data structures of these application threads.

app_sensor_thread.h, app_eeprom_thread.h, and app_user_input_thread.h files

The APP_SENSOR_THREAD_Tasks() function in app_sensor_thread.c, the APP_EEPROM_THREAD_Tasks() function in app_eeprom_thread.c, and the APP_USER_INPUT_THREAD_Tasks() function in app_user_input_thread.c implements the application thread functionality.
The sensor application thread in app_sensor_thread.c and the EEPROM application thread in app_eeprom_thread.c acts as the two clients to the Synchronous I²C driver instance 0.

The sensor application thread in app_sensor_thread.c, EEPROM application thread in app_eeprom_thread.c, and user input application thread in app_user_input_thread.c act as the three clients to the synchronous Universal Synchronous Asynchronous Receiver Transmitter (USART) driver instance 0.

In the application source files, the code for the application threads is already developed. In the following steps, you will add the missing code snippets.

Back to Top

Open app_sensor_thread.c and add application code referring to the comments in the screenshots as shown in the following steps.

Open the I²C driver instance 0, which is associated with TWIHS0. The call to DRV_I2C_Open() API will associate the sensor client with the I²C driver instance 0. The returned handle will be used by the application in all the subsequent calls to the driver to read temperature values from the sensor.

app_sensorData.i2cHandle = DRV_I2C_Open( DRV_I2C_INDEX_0, DRV_IO_INTENT_READWRITE );

app_sensor_thread.c and add application code

Set the transfer parameters for the sensor application thread client after a valid handle to the driver is obtained. The transfer parameter sets the I²C clock speed to 100 kHz for this client.

DRV_I2C_TransferSetup(app_sensorData.i2cHandle, &app_sensorData.i2cSetup);

transfer parameters for the sensor application thread client

Open the USART synchronous driver instance 0 (which is associated with USART1). The call to DRV_USART_Open() API will return a handle to the USART driver instance 0. The returned handle will be used by the sensor application thread in all the subsequent calls to the driver to print the temperature values on the serial terminal kHz for this client.

app_sensorData.usartHandle = DRV_USART_Open(DRV_USART_INDEX_0, 0);

USART synchronous driver instance 0

Submit a call to the FreeRTOS™ API vTaskDelay() to yield CPU control to other threads in the application for a duration equal to the temperature sampling time of the application (one second).

vTaskDelay(APP_SENSOR_SAMPLING_RATE_IN_MSEC/portTICK_PERIOD_MS);

FreeRTOS API vTaskDelay()

Submit a blocking I²C request to read temperature from the sensor. The calling thread will be blocked until the request is completed thereby allowing other threads to run.

if (true == DRV_I2C_WriteReadTransfer(app_sensorData.i2cHandle, APP_SENSOR_I2C_SLAVE_ADDR, (void*)&registerAddr, 1, (void*)app_sensorData.i2cRxBuffer, 2))

blocking I²C request

Communicate the temperature ready event and the temperature value to the EEPROM thread using the RTOS queue. The EEPROM task unblocks when an event/data is available in the RTOS queue.

xQueueSend( eventQueue, (void*)&app_sensorData.eventInfo, portMAX_DELAY);

temperature ready event and the temperature value

Print the latest temperature value by making a call to DRV_USART_WriteBuffer() API, which submits a blocking USART write request.

DRV_USART_WriteBuffer(app_sensorData.usartHandle, app_sensorData.usartTxBuffer, strlen );

DRV_USART_WriteBuffer() API

Back to Top

Open app_eeprom_thread.c and add application code referring to the comments in the screenshots as shown in the following steps.

Associate the second client (EEPROM application thread client), with the I²C driver instance 0. This is done by opening the I²C driver instance 0 again. The call to DRV_I2C_Open () API will now associate the EEPROM application thread client with the I²C driver instance 0. The returned handle will be used by the application in all the subsequent calls (related to the EEPROM application thread client) to the driver to write/read temperature values to/from EEPROM.

app_eepromData.i2cHandle = DRV_I2C_Open( DRV_I2C_INDEX_0, DRV_IO_INTENT_READWRITE );

DRV_I2C_Open () API

Like the sensor application thread client, setup the transfer parameters for the EEPROM application thread client after a valid handle to the driver is obtained. The transfer parameters set the I²C clock speed to 400 kHz for this client.

DRV_I2C_TransferSetup(app_eepromData.i2cHandle, &app_eepromData.i2cSetup);

transfer parameters set the I²C clock speed to 400 kHz

The call to DRV_I2C_TransferSetup overrides the baud rate set in the I²C driver configuration using MPLAB® Code Configurator (MCC).
I²C was configured to run at 400 kHz using MCC. While in the application, the sensor thread has reconfigured it to run at 100 kHz and EEPROM thread configured it to run at 400 kHz. This illustrates how the Harmony I²C driver handles the peripheral module-specific configuration depending on the client accessing the peripheral.

Associate second client (EEPROM application thread client) to USART synchronous driver instance 0 (which is associated with USART1). The call to DRV_USART_Open() API will return a handle to the USART driver instance 0. The returned handle will be used by the EEPROM application thread in all the subsequent calls to the driver to print the temperature values from the EEPROM on the serial terminal.

app_eepromData.usartHandle = DRV_USART_Open(DRV_USART_INDEX_0, 0);

DRV_USART_Open() API

Block the EEPROM application thread until a request is available in the RTOS queue. The scheduler will unblock the EEPROM thread when an event/data is available in the RTOS queue. Depending on the event received in the RTOS queue, the EEPROM task either writes or reads temperature value from the EEPROM.

xQueueReceive( eventQueue, &app_eepromData.eventInfo, portMAX_DELAY );

xQueueReceive( eventQueue, &app_eepromData.eventInfo, portMAX_DELAY );

Submit blocking I²C requests to write temperature from the sensor to EEPROM. The calling thread will be blocked until the request is completed thereby allowing other threads to run.

 if (true == DRV_I2C_WriteTransfer(app_eepromData.i2cHandle, APP_EEPROM_I2C_SLAVE_ADDR, (void *)app_eepromData.i2cTxBuffer, 2))
        {                
           /* Check if EEPROM has completed the write operation */
           while (false == DRV_I2C_WriteTransfer(app_eepromData.i2cHandle, APP_EEPROM_I2C_SLAVE_ADDR, (void *)&dummyData, 1));
        }

blocking I²C requests to write temperature from the sensor to EEPROM

Submit blocking I²C request to read the temperature from the EEPROM to submit for printing on the serial terminal. The calling thread will be blocked until the request is completed thereby allowing other threads to run.

if (true == DRV_I2C_WriteReadTransfer(app_eepromData.i2cHandle, \
               APP_EEPROM_I2C_SLAVE_ADDR, app_eepromData.i2cTxBuffer, 1,\
               app_eepromData.i2cRxBuffer, 5))

blocking I²C request to read the temperature from the EEPROM

Print the logged temperature value from EEPROM by making a call to DRV_USART_WriteBuffer() API by calling the EPPROM application thread function APP_EEPROM_PrintTemperature(), which submits a blocking USART write request.

APP_EEPROM_PrintTemperature(app_eepromData.i2cRxBuffer, app_eepromData.wrIndex);

logged temperature value from EEPROM by making a call to DRV_USART_WriteBuffer() API

Back to Top

Open app_user_input_thread.c and add application code referring to the comments in the screenshots as shown in the following steps.

Associate third client (user input application thread client) to USART synchronous driver instance 0 (which is associated with USART1). The call to DRV_USART_Open() API will return a handle to the USART driver instance 0. The returned handle will be used by the user input application thread in all the subsequent calls to the driver to read a user key press on the serial terminal.

app_user_inputData.usartHandle = DRV_USART_Open(DRV_USART_INDEX_0, 0);

DRV_USART_Open() API

Submit a blocking USART read request. The user input thread will be unblocked when a character is received on the USART. After unblocking, it communicates the request to read data from EEPROM to the EEPROM thread via the RTOS queue.

if (DRV_USART_ReadBuffer(app_user_inputData.usartHandle, &usartData, 1 ) == true)

if (DRV_USART_ReadBuffer(app_user_inputData.usartHandle, &usartData, 1 ) == true)

xQueueSend( eventQueue, &app_user_inputData.eventInfo, portMAX_DELAY );

xQueueSend( eventQueue, &app_user_inputData.eventInfo, portMAX_DELAY );

Back to Top

If your I/O1 Xplained Pro Extension Kit device A2 GND Pin is soldered then the demo works out of the box.

If A2 GND Pin is not soldered, These changes are needed on a I/O1 Xplained Pro Extension Kit.

Open app_sensor_thread.c and add application code referring to the comments in the screenshots as shown in the following steps.

#define APP_SENSOR_I2C_SLAVE_ADDR      0x004F

sensor I2C slave address

Open app_eeprom_thread.c and add application code referring to the comments in the screenshots as shown in the following steps.

#define APP_EEPROM_I2C_SLAVE_ADDR      0x57

EEPROM I2C slave address

You have used FreeRTOS to implement your application. You are now ready to build and run your RTOS based application!

Back to Top