This is a FreeRTOS header, not RTX.

[cmsis-freertos] / Demo / CORTEX_LPC1768_GCC_Rowley / main.c

/*
 * FreeRTOS Kernel V10.0.1
 * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * http://www.FreeRTOS.org
 * http://aws.amazon.com/freertos
 *
 * 1 tab == 4 spaces!
 */


/*
 * Creates all the demo application tasks, then starts the scheduler.  The WEB
 * documentation provides more details of the standard demo application tasks
 * (which just exist to test the kernel port and provide an example of how to use
 * each FreeRTOS API function).
 *
 * In addition to the standard demo tasks, the following tasks and tests are
 * defined and/or created within this file:
 *
 * "Check" hook -  This only executes fully every five seconds from the tick
 * hook.  Its main function is to check that all the standard demo tasks are
 * still operational.  The status can be viewed using on the Task Stats page
 * served by the WEB server.
 *
 * "uIP" task -  This is the task that handles the uIP stack.  All TCP/IP
 * processing is performed in this task.
 *
 * "USB" task - Enumerates the USB device as a CDC class, then echoes back all
 * received characters with a configurable offset (for example, if the offset
 * is 1 and 'A' is received then 'B' will be sent back).  A dumb terminal such
 * as Hyperterminal can be used to talk to the USB task.
 */

/* Scheduler includes. */
#include "FreeRTOS.h"
#include "task.h"

/* Demo app includes. */
#include "BlockQ.h"
#include "integer.h"
#include "blocktim.h"
#include "flash.h"
#include "partest.h"
#include "semtest.h"
#include "PollQ.h"
#include "GenQTest.h"
#include "QPeek.h"
#include "recmutex.h"

/*-----------------------------------------------------------*/

/* The time between cycles of the 'check' functionality (defined within the
tick hook). */
#define mainCHECK_DELAY                                         ( ( TickType_t ) 5000 / portTICK_PERIOD_MS )

/* Task priorities. */
#define mainQUEUE_POLL_PRIORITY                         ( tskIDLE_PRIORITY + 2 )
#define mainSEM_TEST_PRIORITY                           ( tskIDLE_PRIORITY + 1 )
#define mainBLOCK_Q_PRIORITY                            ( tskIDLE_PRIORITY + 2 )
#define mainUIP_TASK_PRIORITY                           ( tskIDLE_PRIORITY + 3 )
#define mainINTEGER_TASK_PRIORITY           ( tskIDLE_PRIORITY )
#define mainGEN_QUEUE_TASK_PRIORITY                     ( tskIDLE_PRIORITY )
#define mainFLASH_TASK_PRIORITY                         ( tskIDLE_PRIORITY + 2 )

/* The WEB server has a larger stack as it utilises stack hungry string
handling library calls. */
#define mainBASIC_WEB_STACK_SIZE            ( configMINIMAL_STACK_SIZE * 4 )

/* The message displayed by the WEB server when all tasks are executing
without an error being reported. */
#define mainPASS_STATUS_MESSAGE                         "All tasks are executing without error."

/*-----------------------------------------------------------*/

/*
 * Configure the hardware for the demo.
 */
static void prvSetupHardware( void );

/*
 * The task that handles the uIP stack.  All TCP/IP processing is performed in
 * this task.
 */
extern void vuIP_Task( void *pvParameters );

/*
 * The task that handles the USB stack.
 */
extern void vUSBTask( void *pvParameters );

/*
 * Simply returns the current status message for display on served WEB pages.
 */
char *pcGetTaskStatusMessage( void );

/*-----------------------------------------------------------*/

/* Holds the status message displayed by the WEB server. */
static char *pcStatusMessage = mainPASS_STATUS_MESSAGE;

/*-----------------------------------------------------------*/

int main( void )
{
        /* Configure the hardware for use by this demo. */
        prvSetupHardware();

        /* Start the standard demo tasks.  These are just here to exercise the
        kernel port and provide examples of how the FreeRTOS API can be used. */
        vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
    vCreateBlockTimeTasks();
    vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
    vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );
    vStartIntegerMathTasks( mainINTEGER_TASK_PRIORITY );
    vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );
    vStartQueuePeekTasks();
    vStartRecursiveMutexTasks();
        vStartLEDFlashTasks( mainFLASH_TASK_PRIORITY );

    /* Create the USB task. */
    xTaskCreate( vUSBTask, "USB", configMINIMAL_STACK_SIZE, ( void * ) NULL, tskIDLE_PRIORITY, NULL );

        /* Create the uIP task.  The WEB server runs in this task. */
    xTaskCreate( vuIP_Task, "uIP", mainBASIC_WEB_STACK_SIZE, ( void * ) NULL, mainUIP_TASK_PRIORITY, NULL );

    /* Start the scheduler. */
        vTaskStartScheduler();

    /* Will only get here if there was insufficient memory to create the idle
    task.  The idle task is created within vTaskStartScheduler(). */
        for( ;; );
}
/*-----------------------------------------------------------*/

void vApplicationTickHook( void )
{
static unsigned long ulTicksSinceLastDisplay = 0;

        /* Called from every tick interrupt as described in the comments at the top
        of this file.

        Have enough ticks passed to make it     time to perform our health status
        check again? */
        ulTicksSinceLastDisplay++;
        if( ulTicksSinceLastDisplay >= mainCHECK_DELAY )
        {
                /* Reset the counter so these checks run again in mainCHECK_DELAY
                ticks time. */
                ulTicksSinceLastDisplay = 0;

                /* Has an error been found in any task? */
                if( xAreGenericQueueTasksStillRunning() != pdTRUE )
                {
                        pcStatusMessage = "An error has been detected in the Generic Queue test/demo.";
                }
                else if( xAreQueuePeekTasksStillRunning() != pdTRUE )
                {
                        pcStatusMessage = "An error has been detected in the Peek Queue test/demo.";
                }
                else if( xAreBlockingQueuesStillRunning() != pdTRUE )
                {
                        pcStatusMessage = "An error has been detected in the Block Queue test/demo.";
                }
                else if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
                {
                        pcStatusMessage = "An error has been detected in the Block Time test/demo.";
                }
            else if( xAreSemaphoreTasksStillRunning() != pdTRUE )
            {
                pcStatusMessage = "An error has been detected in the Semaphore test/demo.";
            }
            else if( xArePollingQueuesStillRunning() != pdTRUE )
            {
                pcStatusMessage = "An error has been detected in the Poll Queue test/demo.";
            }
            else if( xAreIntegerMathsTaskStillRunning() != pdTRUE )
            {
                pcStatusMessage = "An error has been detected in the Int Math test/demo.";
            }
            else if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
            {
                pcStatusMessage = "An error has been detected in the Mutex test/demo.";
            }
        }
}
/*-----------------------------------------------------------*/

char *pcGetTaskStatusMessage( void )
{
        /* Not bothered about a critical section here. */
        return pcStatusMessage;
}
/*-----------------------------------------------------------*/

void prvSetupHardware( void )
{
        /* Disable peripherals power. */
        SC->PCONP = 0;

        /* Enable GPIO power. */
        SC->PCONP = PCONP_PCGPIO;

        /* Disable TPIU. */
        PINCON->PINSEL10 = 0;

        /*  Setup the peripheral bus to be the same as the CPU output (100 MHz). */
        SC->PCLKSEL0 = 0x05555555;

        /* Configure the LEDs. */
        vParTestInitialise();
}
/*-----------------------------------------------------------*/

void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName )
{
        /* This function will get called if a task overflows its stack. */

        ( void ) pxTask;
        ( void ) pcTaskName;

        for( ;; );
}
/*-----------------------------------------------------------*/

void vConfigureTimerForRunTimeStats( void )
{
const unsigned long TCR_COUNT_RESET = 2, CTCR_CTM_TIMER = 0x00, TCR_COUNT_ENABLE = 0x01;

        /* This function configures a timer that is used as the time base when
        collecting run time statistical information - basically the percentage
        of CPU time that each task is utilising.  It is called automatically when
        the scheduler is started (assuming configGENERATE_RUN_TIME_STATS is set
        to 1). */

        /* Power up and feed the timer. */
        SC->PCONP |= 0x02UL;
        SC->PCLKSEL0 = (SC->PCLKSEL0 & (~(0x3<<2))) | (0x01 << 2);

        /* Reset Timer 0 */
        TIM0->TCR = TCR_COUNT_RESET;

        /* Just count up. */
        TIM0->CTCR = CTCR_CTM_TIMER;

        /* Prescale to a frequency that is good enough to get a decent resolution,
        but not too fast so as to overflow all the time. */
        TIM0->PR =  ( configCPU_CLOCK_HZ / 10000UL ) - 1UL;

        /* Start the counter. */
        TIM0->TCR = TCR_COUNT_ENABLE;
}
/*-----------------------------------------------------------*/