[freertos] / FreeRTOS / Demo / H8S / RTOSDemo / main.c

/*\r
 * FreeRTOS Kernel V10.3.0\r
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
 *\r
 * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
 * this software and associated documentation files (the "Software"), to deal in\r
 * the Software without restriction, including without limitation the rights to\r
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
 * the Software, and to permit persons to whom the Software is furnished to do so,\r
 * subject to the following conditions:\r
 *\r
 * The above copyright notice and this permission notice shall be included in all\r
 * copies or substantial portions of the Software.\r
 *\r
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
 *\r
 * http://www.FreeRTOS.org\r
 * http://aws.amazon.com/freertos\r
 *\r
 * 1 tab == 4 spaces!\r
 */\r
\r
/*\r
 * Creates all the demo application tasks, then starts the scheduler.  The WEB\r
 * documentation provides more details of the demo application tasks.\r
 *\r
 * Main.c also creates a task called "Check".  This only executes every three\r
 * seconds but has the highest priority so is guaranteed to get processor time.\r
 * Its main function is to check that all the other tasks are still operational.\r
 * Each task (other than the "flash" tasks) maintains a unique count that is\r
 * incremented each time the task successfully completes its function.  Should\r
 * any error occur within such a task the count is permanently halted.  The\r
 * check task inspects the count of each task to ensure it has changed since\r
 * the last time the check task executed.  If all the count variables have\r
 * changed all the tasks are still executing error free, and the check task\r
 * toggles the onboard LED.  Should any task contain an error at any time\r
 * the LED toggle rate will change from 3 seconds to 500ms.\r
 *\r
 * To check the operation of the memory allocator the check task also\r
 * dynamically creates a task before delaying, and deletes it again when it\r
 * wakes.  If memory cannot be allocated for the new task the call to xTaskCreate\r
 * will fail and an error is signalled.  The dynamically created task itself\r
 * allocates and frees memory just to give the allocator a bit more exercise.\r
 *\r
 */\r
\r
/* Standard includes. */\r
#include <stdlib.h>\r
#include <string.h>\r
\r
/* Scheduler include files. */\r
#include "FreeRTOS.h"\r
#include "task.h"\r
\r
/* Demo application file headers. */\r
#include "flash.h"\r
#include "integer.h"\r
#include "PollQ.h"\r
#include "comtest2.h"\r
#include "semtest.h"\r
#include "flop.h"\r
#include "dynamic.h"\r
#include "BlockQ.h"\r
#include "serial.h"\r
#include "partest.h"\r
\r
/* Priority definitions for most of the tasks in the demo application.  Some\r
tasks just use the idle priority. */\r
#define mainLED_TASK_PRIORITY                   ( tskIDLE_PRIORITY + 1 )\r
#define mainCOM_TEST_PRIORITY                   ( tskIDLE_PRIORITY + 2 )\r
#define mainQUEUE_POLL_PRIORITY                 ( tskIDLE_PRIORITY + 2 )\r
#define mainCHECK_TASK_PRIORITY                 ( tskIDLE_PRIORITY + 3 )\r
#define mainSEM_TEST_PRIORITY                   ( tskIDLE_PRIORITY + 1 )\r
#define mainBLOCK_Q_PRIORITY                    ( tskIDLE_PRIORITY + 2 )\r
\r
/* Baud rate used by the serial port tasks (ComTest tasks). */\r
#define mainCOM_TEST_BAUD_RATE                  ( ( unsigned long ) 115200 )\r
\r
/* LED used by the serial port tasks.  This is toggled on each character Tx,\r
and mainCOM_TEST_LED + 1 is toggles on each character Rx. */\r
#define mainCOM_TEST_LED                                ( 3 )\r
\r
/* LED that is toggled by the check task.  The check task periodically checks\r
that all the other tasks are operating without error.  If no errors are found\r
the LED is toggled with mainCHECK_PERIOD frequency.  If an error is found\r
the the toggle rate increases to mainERROR_CHECK_PERIOD. */\r
#define mainCHECK_TASK_LED                              ( 5 )\r
#define mainCHECK_PERIOD                                ( ( TickType_t ) 3000 / portTICK_PERIOD_MS  )\r
#define mainERROR_CHECK_PERIOD                  ( ( TickType_t ) 500 / portTICK_PERIOD_MS )\r
\r
/* Constants used by the vMemCheckTask() task. */\r
#define mainCOUNT_INITIAL_VALUE         ( ( unsigned long ) 0 )\r
#define mainNO_TASK                                     ( 0 )\r
\r
/* The size of the memory blocks allocated by the vMemCheckTask() task. */\r
#define mainMEM_CHECK_SIZE_1            ( ( size_t ) 51 )\r
#define mainMEM_CHECK_SIZE_2            ( ( size_t ) 52 )\r
#define mainMEM_CHECK_SIZE_3            ( ( size_t ) 151 )\r
\r
/*\r
 * The 'Check' task.\r
 */\r
static void vErrorChecks( void *pvParameters );\r
\r
/*\r
 * Checks the unique counts of other tasks to ensure they are still operational.\r
 */\r
static long prvCheckOtherTasksAreStillRunning( unsigned long ulMemCheckTaskCount );\r
\r
/*\r
 * Dynamically created and deleted during each cycle of the vErrorChecks()\r
 * task.  This is done to check the operation of the memory allocator.\r
 * See the top of vErrorChecks for more details.\r
 */\r
static void vMemCheckTask( void *pvParameters );\r
\r
/*-----------------------------------------------------------*/\r
\r
/*\r
 * Start all the tasks then start the scheduler.\r
 */\r
int main( void )\r
{\r
        /* Setup the LED's for output. */\r
        vParTestInitialise();\r
\r
        /* Start the various standard demo application tasks. */\r
        vStartIntegerMathTasks( tskIDLE_PRIORITY );\r
        vAltStartComTestTasks( mainCOM_TEST_PRIORITY, mainCOM_TEST_BAUD_RATE, mainCOM_TEST_LED );\r
        vStartLEDFlashTasks( mainLED_TASK_PRIORITY );\r
        vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );\r
        vStartMathTasks( tskIDLE_PRIORITY );\r
        vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );\r
        vStartDynamicPriorityTasks();\r
        vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );\r
\r
        /* Start the 'Check' task. */\r
        xTaskCreate( vErrorChecks, "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );\r
\r
        /* In this port, to use preemptive scheduler define configUSE_PREEMPTION\r
        as 1 in portmacro.h.  To use the cooperative scheduler define\r
        configUSE_PREEMPTION as 0. */\r
        vTaskStartScheduler();\r
\r
        /* Should never get here! */\r
        return 0;\r
}\r
/*-----------------------------------------------------------*/\r
\r
/*\r
 * Cycle for ever, delaying then checking all the other tasks are still\r
 * operating without error.  If an error is detected then the delay period\r
 * is decreased from mainCHECK_PERIOD to mainERROR_CHECK_PERIOD so\r
 * the on board LED flash rate will increase.\r
 *\r
 * In addition to the standard tests the memory allocator is tested through\r
 * the dynamic creation and deletion of a task each cycle.  Each time the\r
 * task is created memory must be allocated for its stack.  When the task is\r
 * deleted this memory is returned to the heap.  If the task cannot be created\r
 * then it is likely that the memory allocation failed.   In addition the\r
 * dynamically created task allocates and frees memory while it runs.\r
 */\r
static void vErrorChecks( void *pvParameters )\r
{\r
TickType_t xDelayPeriod = mainCHECK_PERIOD;\r
volatile unsigned long ulMemCheckTaskRunningCount;\r
TaskHandle_t xCreatedTask;\r
TickType_t xLastWakeTime;\r
\r
        /* Initialise xLastWakeTime to ensure the first call to vTaskDelayUntil()\r
        functions correctly. */\r
        xLastWakeTime = xTaskGetTickCount();\r
\r
        for( ;; )\r
        {\r
                /* Set ulMemCheckTaskRunningCount to a known value so we can check\r
                later that it has changed. */\r
                ulMemCheckTaskRunningCount = mainCOUNT_INITIAL_VALUE;\r
\r
                /* Dynamically create a task - passing ulMemCheckTaskRunningCount as a\r
                parameter. */\r
                xCreatedTask = mainNO_TASK;\r
                if( xTaskCreate( vMemCheckTask, "MEM_CHECK", configMINIMAL_STACK_SIZE, ( void * ) &ulMemCheckTaskRunningCount, tskIDLE_PRIORITY, &xCreatedTask ) != pdPASS )\r
                {\r
                        /* Could not create the task - we have probably run out of heap. */\r
                        xDelayPeriod = mainERROR_CHECK_PERIOD;\r
                }\r
\r
\r
                /* Delay until it is time to execute again.  The delay period is\r
                shorter following an error. */\r
                vTaskDelayUntil( &xLastWakeTime, xDelayPeriod );\r
\r
\r
                /* Delete the dynamically created task. */\r
                if( xCreatedTask != mainNO_TASK )\r
                {\r
                        vTaskDelete( xCreatedTask );\r
                }\r
\r
                /* Check all the standard demo application tasks are executing without\r
                error.  ulMemCheckTaskRunningCount is checked to ensure it was\r
                modified by the task just deleted. */\r
                if( prvCheckOtherTasksAreStillRunning( ulMemCheckTaskRunningCount ) != pdPASS )\r
                {\r
                        /* An error has been detected in one of the tasks - flash faster. */\r
                        xDelayPeriod = mainERROR_CHECK_PERIOD;\r
                }\r
\r
                vParTestToggleLED( mainCHECK_TASK_LED );\r
        }\r
}\r
/*-----------------------------------------------------------*/\r
\r
/*\r
 *      Check each set of tasks in turn to see if they have experienced any\r
 *      error conditions.\r
 */\r
static long prvCheckOtherTasksAreStillRunning( unsigned long ulMemCheckTaskCount )\r
{\r
long lNoErrorsDiscovered = ( long ) pdTRUE;\r
\r
        if( xAreIntegerMathsTaskStillRunning() != pdTRUE )\r
        {\r
                lNoErrorsDiscovered = pdFALSE;\r
        }\r
\r
        if( xAreComTestTasksStillRunning() != pdTRUE )\r
        {\r
                lNoErrorsDiscovered = pdFALSE;\r
        }\r
\r
        if( xArePollingQueuesStillRunning() != pdTRUE )\r
        {\r
                lNoErrorsDiscovered = pdFALSE;\r
        }\r
\r
        if( xAreMathsTaskStillRunning() != pdTRUE )\r
        {\r
                lNoErrorsDiscovered = pdFALSE;\r
        }\r
\r
        if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
        {\r
                lNoErrorsDiscovered = pdFALSE;\r
        }\r
\r
        if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )\r
        {\r
                lNoErrorsDiscovered = pdFALSE;\r
        }\r
\r
        if( xAreBlockingQueuesStillRunning() != pdTRUE )\r
        {\r
                lNoErrorsDiscovered = pdFALSE;\r
        }\r
\r
        if( ulMemCheckTaskCount == mainCOUNT_INITIAL_VALUE )\r
        {\r
                /* The vMemCheckTask task did not increment the counter - it must\r
                have failed. */\r
                lNoErrorsDiscovered = pdFALSE;\r
        }\r
\r
        return lNoErrorsDiscovered;\r
}\r
/*-----------------------------------------------------------*/\r
\r
static void vMemCheckTask( void *pvParameters )\r
{\r
unsigned long *pulMemCheckTaskRunningCounter;\r
void *pvMem1, *pvMem2, *pvMem3;\r
static long lErrorOccurred = pdFALSE;\r
\r
        /* This task is dynamically created then deleted during each cycle of the\r
        vErrorChecks task to check the operation of the memory allocator.  Each time\r
        the task is created memory is allocated for the stack and TCB.  Each time\r
        the task is deleted this memory is returned to the heap.  This task itself\r
        exercises the allocator by allocating and freeing blocks.\r
\r
        The task executes at the idle priority so does not require a delay.\r
\r
        pulMemCheckTaskRunningCounter is incremented each cycle to indicate to the\r
        vErrorChecks() task that this task is still executing without error. */\r
\r
        pulMemCheckTaskRunningCounter = ( unsigned long * ) pvParameters;\r
\r
        for( ;; )\r
        {\r
                if( lErrorOccurred == pdFALSE )\r
                {\r
                        /* We have never seen an error so increment the counter. */\r
                        ( *pulMemCheckTaskRunningCounter )++;\r
                }\r
                else\r
                {\r
                        /* Reset the count so an error is detected by the\r
                        prvCheckOtherTasksAreStillRunning() function. */\r
                        *pulMemCheckTaskRunningCounter = mainCOUNT_INITIAL_VALUE;\r
                }\r
\r
                /* Allocate some memory - just to give the allocator some extra\r
                exercise.  This has to be in a critical section to ensure the\r
                task does not get deleted while it has memory allocated. */\r
                vTaskSuspendAll();\r
                {\r
                        pvMem1 = pvPortMalloc( mainMEM_CHECK_SIZE_1 );\r
                        if( pvMem1 == NULL )\r
                        {\r
                                lErrorOccurred = pdTRUE;\r
                        }\r
                        else\r
                        {\r
                                memset( pvMem1, 0xaa, mainMEM_CHECK_SIZE_1 );\r
                                vPortFree( pvMem1 );\r
                        }\r
                }\r
                xTaskResumeAll();\r
\r
                /* Again - with a different size block. */\r
                vTaskSuspendAll();\r
                {\r
                        pvMem2 = pvPortMalloc( mainMEM_CHECK_SIZE_2 );\r
                        if( pvMem2 == NULL )\r
                        {\r
                                lErrorOccurred = pdTRUE;\r
                        }\r
                        else\r
                        {\r
                                memset( pvMem2, 0xaa, mainMEM_CHECK_SIZE_2 );\r
                                vPortFree( pvMem2 );\r
                        }\r
                }\r
                xTaskResumeAll();\r
\r
                /* Again - with a different size block. */\r
                vTaskSuspendAll();\r
                {\r
                        pvMem3 = pvPortMalloc( mainMEM_CHECK_SIZE_3 );\r
                        if( pvMem3 == NULL )\r
                        {\r
                                lErrorOccurred = pdTRUE;\r
                        }\r
                        else\r
                        {\r
                                memset( pvMem3, 0xaa, mainMEM_CHECK_SIZE_3 );\r
                                vPortFree( pvMem3 );\r
                        }\r
                }\r
                xTaskResumeAll();\r
        }\r
}\r
/*-----------------------------------------------------------*/\r
\r
/*\r
 * Called by the startup code.  Initial processor setup can be placed in this\r
 * function.\r
 */\r
void hw_initialise (void)\r
{\r
}\r
\r