openmv/lib/alif/Boards/DevKit-e7/Templates/FreeRTOS/CRC_testApp.c
iabdalkader daf2bb30da misc: Restructure repo.
Signed-off-by: iabdalkader <i.abdalkader@gmail.com>
2025-04-13 08:28:34 +02:00

388 lines
12 KiB
C

/* Copyright (C) 2022 Alif Semiconductor - All Rights Reserved.
* Use, distribution and modification of this code is permitted under the
* terms stated in the Alif Semiconductor Software License Agreement
*
* You should have received a copy of the Alif Semiconductor Software
* License Agreement with this file. If not, please write to:
* contact@alifsemi.com, or visit: https://alifsemi.com/license
*
*/
/**************************************************************************//**
* @file CRC_testapp.c
* @author Nisarga A M
* @email nisarga.am@alifsemi.com
* @version V1.0.0
* @date 18-July-2023
* @brief TestApp to verify CRC(Cyclic Redundancy Check) interface using
* FreeRTOS as an operating system.
* -> Callback is not mandatory for CRC. It would be beneficial if
DMA is enabled and the length of the data items are more than
1000 bytes.
******************************************************************************/
/* System Includes */
#include <stdio.h>
/* Project Includes */
/* include for CRC Driver */
#include "Driver_CRC.h"
#include "FreeRTOS.h"
#include "FreeRTOSConfig.h"
#include "task.h"
#include "RTE_Components.h"
#include "system_utils.h"
#if defined(RTE_Compiler_IO_STDOUT)
#include "retarget_stdout.h"
#endif /* RTE_Compiler_IO_STDOUT */
/* CRC driver instance */
extern ARM_DRIVER_CRC Driver_CRC0;
static ARM_DRIVER_CRC *CRCdrv = &Driver_CRC0;
/*Define for FreeRTOS*/
#define STACK_SIZE 1024
#define TIMER_SERVICE_TASK_STACK_SIZE configTIMER_TASK_STACK_DEPTH
#define IDLE_TASK_STACK_SIZE configMINIMAL_STACK_SIZE
StackType_t IdleStack[2 * IDLE_TASK_STACK_SIZE];
StaticTask_t IdleTcb;
StackType_t TimerStack[2 * TIMER_SERVICE_TASK_STACK_SIZE];
StaticTask_t TimerTcb;
/****************************** FreeRTOS functions **********************/
void vApplicationGetIdleTaskMemory(StaticTask_t **ppxIdleTaskTCBBuffer,
StackType_t **ppxIdleTaskStackBuffer, uint32_t *pulIdleTaskStackSize) {
*ppxIdleTaskTCBBuffer = &IdleTcb;
*ppxIdleTaskStackBuffer = IdleStack;
*pulIdleTaskStackSize = IDLE_TASK_STACK_SIZE;
}
void vApplicationStackOverflowHook(TaskHandle_t pxTask, char *pcTaskName)
{
(void) pxTask;
for (;;);
}
void vApplicationGetTimerTaskMemory(StaticTask_t **ppxTimerTaskTCBBuffer,
StackType_t **ppxTimerTaskStackBuffer, uint32_t *pulTimerTaskStackSize)
{
*ppxTimerTaskTCBBuffer = &TimerTcb;
*ppxTimerTaskStackBuffer = TimerStack;
*pulTimerTaskStackSize = TIMER_SERVICE_TASK_STACK_SIZE;
}
void vApplicationIdleHook(void)
{
for (;;);
}
TaskHandle_t crc_xHandle;
#define CRC_CALLBACK_EVENT_SUCCESS 0x01
/* Select the CRC algorithm */
#define CRC_8_BIT 1
#define CRC_16_BIT 0
#define CRC_32_BIT 0
#define CRC_CUSTOM_32_BIT 0
/* Select the type of input */
#define INPUT_HEX_VALUE 1
#define INPUT_STRING_VALUE 0
#if INPUT_HEX_VALUE
uint8_t input_value[] = {0x67, 0x3F, 0x90, 0xC9, 0x25, 0xF0, 0x4A, 0xB1,0x12 };
#endif
#if INPUT_STRING_VALUE
uint8_t input_value[] = {"Hello"};
#endif
uint32_t seed_value_8_bit = (0x00000000); /* Seed value for 8 bit */
uint32_t seed_value_16_bit = (0x00000000); /* Seed value for 16 bit */
uint32_t seed_value_32_bit = (0xFFFFFFFF); /* Seed value for 32 bit */
uint32_t seed_value_32C_bit = (0xFFFFFFFF); /* Seed value for 32 bit custom polynomial */
uint32_t polynomial = 0x2CEEA6C8; /* polynomial value for 32 bit custom polynomial */
/*
* @func : void crc_compute_callback(uint32_t event)
* @brief : CRC compute callback event
*.@return : NONE
*/
static void crc_compute_callback(uint32_t event)
{
BaseType_t xHigherPriorityTaskWoken = pdFALSE, xResult = pdFALSE;
/* Save received events */
/* Optionally, user can define specific actions for an event */
if(event & ARM_CRC_COMPUTE_EVENT_DONE)
{
xTaskNotifyFromISR(crc_xHandle, CRC_CALLBACK_EVENT_SUCCESS, eSetBits, &xHigherPriorityTaskWoken);
if (xResult == pdTRUE) { portYIELD_FROM_ISR( xHigherPriorityTaskWoken ); }
}
}
/**
* @fn :void crc_demo_Thread_entry(void *pvParameters)
* @brief :crc_demo_Thread_entry :
- This initialize the CRC.
- For 8 bit, 16 bit and 32 bit,the seed value will be added
into the Seed register.
- If user provides 8 bit or 16 bit or 32 bit or 32 bit custom
polynomial input , according to that 8 bit or 16 bit or 32
bit output will be printed.
- For 8 bit and 16 bit CRC the input will be added to DATA_IN_8
register and for 32 bit CRC the input will be added to the
DATA_IN_32 register.
* @return : none
*/
void crc_demo_Thread_entry(void *pvParameters)
{
int32_t ret = 0;
uint8_t len;
uint32_t crc_output ;
ARM_DRIVER_VERSION version;
BaseType_t xReturned;
printf("\r\n >>> Demo FreeRTOS app using CRC is starting <<< \r\n");
version = CRCdrv->GetVersion();
printf("\r\n CRC version api:%X driver:%X...\r\n", version.api, version.drv);
/* Initialize CRC driver */
ret = CRCdrv->Initialize(crc_compute_callback);
if(ret != ARM_DRIVER_OK){
printf("\r\n Error: CRC init failed\n");
return;
}
/* Enable the power for CRC */
ret = CRCdrv->PowerControl(ARM_POWER_FULL);
if(ret != ARM_DRIVER_OK){
printf("\r\n Error: CRC Power up failed\n");
goto error_uninitialize;
}
#if INPUT_HEX_VALUE
len = sizeof(input_value) / sizeof(input_value[0]);
#endif
#if INPUT_STRING_VALUE
len = strlen(( char *)input_value);
#endif
/* For 8 bit */
#if CRC_8_BIT
/* To disable the Reflect, Invert, Bit, Byte, Custom polynomial bit of CRC */
ret = CRCdrv->Control(ARM_CRC_CONTROL_MASK, DISABLE);
if(ret != ARM_DRIVER_OK){
printf("\r\n Error: CRC Control mask for 8 bit data failed\n");
goto error_poweroff;
}
/* To select the 8_BIT_CCITT */
ret= CRCdrv->Control(ARM_CRC_ALGORITHM_SEL, ARM_CRC_ALGORITHM_SEL_8_BIT_CCITT);
if(ret != ARM_DRIVER_OK){
printf("\r\n Error: CRC Control Algorithm for 8 bit data failed\n");
goto error_poweroff;
}
/* Adding 8 bit seed value to the seed register */
ret = CRCdrv->Seed(seed_value_8_bit);
if(ret != ARM_DRIVER_OK){
printf("\r\n Error:CRC Seed value for 8 bit failed\n");
goto error_uninitialize;
}
/*sending User input */
ret = CRCdrv->Compute(input_value, len, &crc_output);
printf("8 bit output : %x\n", crc_output);
if(ret != ARM_DRIVER_OK){
printf("\r\n Error: CRC 8 bit data sending failed\n");
goto error_send;
}
/* For 16 bit CRC*/
#elif CRC_16_BIT
/* To disable the Reflect, Invert, Bit, Byte, Custom polynomial bit of CRC */
ret = CRCdrv->Control(ARM_CRC_CONTROL_MASK, DISABLE);
if(ret != ARM_DRIVER_OK){
printf("\r\n Error: CRC Control mask for 16 bit data failed\n");
goto error_poweroff;
}
/* To select the 16_BIT_CCITT */
ret= CRCdrv->Control(ARM_CRC_ALGORITHM_SEL, ARM_CRC_ALGORITHM_SEL_16_BIT_CCITT);
if(ret != ARM_DRIVER_OK){
printf("\r\n Error: CRC Control Algorithm for 16 bit data failed\n");
goto error_poweroff;
}
/* Adding 16 bit seed value to the seed register */
ret = CRCdrv->Seed(seed_value_16_bit);
if(ret != ARM_DRIVER_OK){
printf("\r\n Error: CRC Seed value for 16 bit data failed\n");
goto error_uninitialize;
}
/*sending user input */
ret = CRCdrv->Compute (input_value, len, &crc_output);
printf("16 bit output : %x\n", crc_output);
if(ret != ARM_DRIVER_OK){
printf("\r\n Error: CRC 16 bit data sending failed\n");
goto error_send;
}
/* For 32 bit CRC */
#elif CRC_32_BIT
/* To Enable the Reflect, Invert, Bit swap and Byte swap of CRC control register */
ret = CRCdrv->Control(ARM_CRC_ENABLE_BIT_SWAP |
ARM_CRC_ENABLE_BYTE_SWAP |
ARM_CRC_ENABLE_INVERT_OUTPUT |
ARM_CRC_ENABLE_REFLECT_OUTPUT, ENABLE);
if(ret != ARM_DRIVER_OK){
printf("\r\n Error: CRC Control for 32 bit failed\n");
goto error_poweroff;
}
/* To select the 32_BIT CRC algorithm */
ret= CRCdrv->Control(ARM_CRC_ALGORITHM_SEL, ARM_CRC_ALGORITHM_SEL_32_BIT);
if(ret != ARM_DRIVER_OK){
printf("\r\n Error: CRC Control Algorithm for 32 bit data failed\n");
goto error_poweroff;
}
/* Adding 32 bit seed value to the seed register */
ret = CRCdrv->Seed(seed_value_32_bit);
if(ret != ARM_DRIVER_OK){
printf("\r\n Error: CRC Seed value for 32 bit failed\n");
goto error_uninitialize;
}
/*sending user input */
ret = CRCdrv->Compute(input_value, len, &crc_output);
printf("32 bit output : %x\n", crc_output);
if(ret != ARM_DRIVER_OK){
printf("\r\n Error: CRC 32 bit data sending failed\n");
goto error_send;
}
/* For 32 bit Custom polynomial */
#elif CRC_CUSTOM_32_BIT
/* Adding polynomial value */
ret = CRCdrv->PolyCustom(polynomial);
if(ret != ARM_DRIVER_OK){
printf("\r\n Error: CRC PolyCustom value failed\n");
goto error_uninitialize;
}
/* To enable the CRC custom polynomial */
ret = CRCdrv->Control(ARM_CRC_ENABLE_CUSTOM_POLY, ENABLE);
if(ret != ARM_DRIVER_OK){
printf("\r\n Error: CRC Control custom polynomial value failed\n");
goto error_poweroff;
}
/* To select the 32_BIT_CUSTOM_POLY crc algorithm */
ret= CRCdrv->Control(ARM_CRC_ALGORITHM_SEL, ARM_CRC_ALGORITHM_SEL_32_BIT_CUSTOM_POLY);
if(ret != ARM_DRIVER_OK){
printf("\r\n Error: CRC Control Algorithm for 32 bit data custom polynomial failed\n");
goto error_poweroff;
}
/* To enable the Invert, Bit swap, Byte swap of CRC control register */
ret = CRCdrv->Control(ARM_CRC_ENABLE_BYTE_SWAP |
ARM_CRC_ENABLE_BIT_SWAP |
ARM_CRC_ENABLE_INVERT_OUTPUT, ENABLE);
if(ret != ARM_DRIVER_OK){
printf("\r\n Error: CRC Control for 32 bit custom polynomial failed\n");
goto error_poweroff;
}
/* Adding 32 bit poly custom seed value to the seed register */
ret = CRCdrv->Seed(seed_value_32C_bit);
if(ret != ARM_DRIVER_OK){
printf("\r\n Error: CRC Seed value for 32 bit data custom polynomial failed\n");
goto error_uninitialize;
}
/*sending user input */
ret = CRCdrv->Compute (input_value, len, &crc_output);
printf("32 bit CUSTOM POLY output value: %x\n", crc_output);
if(ret != ARM_DRIVER_OK){
printf("\r\n Error: CRC 32 bit custom polynomial data sending failed\n");
goto error_send;
}
#endif
/* wait for CRC callback */
xReturned = xTaskNotifyWait(NULL,CRC_CALLBACK_EVENT_SUCCESS,NULL, portMAX_DELAY);
if (xReturned != pdTRUE) {
printf("Error: RTC tx_event_flags_get\n");
goto error_poweroff;
}
printf("\n >>> CRC Compute done \n");
error_send:
error_poweroff:
/* Power off CRC peripheral */
ret = CRCdrv->PowerControl(ARM_POWER_OFF);
if(ret != ARM_DRIVER_OK)
{
printf("\r\n Error: CRC Power OFF failed.\r\n");
}
error_uninitialize:
/* UnInitialize CRC driver */
ret = CRCdrv->Uninitialize();
if(ret != ARM_DRIVER_OK){
printf("\r\n Error: CRC Uninitialize failed.\r\n");
}
}
/*----------------------------------------------------------------------------
* Main: Initialize and start the FreeRTOS Kernel
*---------------------------------------------------------------------------*/
int main(void)
{
#if defined(RTE_Compiler_IO_STDOUT_User)
int32_t ret;
ret = stdout_init();
if(ret != ARM_DRIVER_OK)
{
while(1)
{
}
}
#endif
/* System Initialization */
SystemCoreClockUpdate();
/* Create application main thread */
BaseType_t xReturned = xTaskCreate(crc_demo_Thread_entry, "CRCFreertos", 256, NULL,configMAX_PRIORITIES-1, &crc_xHandle);
if (xReturned != pdPASS)
{
vTaskDelete(crc_xHandle);
return -1;
}
/* Start thread execution */
vTaskStartScheduler();
}