]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Demo/CORTEX_Kinetis_K60_Tower_IAR/main_blinky.c
Ensure both one-shot and auto-reload are written consistently with a hyphen in comments.
[freertos] / FreeRTOS / Demo / CORTEX_Kinetis_K60_Tower_IAR / main_blinky.c
index aedca411e6c46862feb198ac395c2e891d9a354f..4493b0e5881cd55cdd65bd99a892b1a894d9007a 100644 (file)
@@ -1,76 +1,29 @@
 /*\r
-    FreeRTOS V7.4.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
-\r
-    FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
-    http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
-\r
-    ***************************************************************************\r
-     *                                                                       *\r
-     *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
-     *    Complete, revised, and edited pdf reference manuals are also       *\r
-     *    available.                                                         *\r
-     *                                                                       *\r
-     *    Purchasing FreeRTOS documentation will not only help you, by       *\r
-     *    ensuring you get running as quickly as possible and with an        *\r
-     *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
-     *    the FreeRTOS project to continue with its mission of providing     *\r
-     *    professional grade, cross platform, de facto standard solutions    *\r
-     *    for microcontrollers - completely free of charge!                  *\r
-     *                                                                       *\r
-     *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
-     *                                                                       *\r
-     *    Thank you for using FreeRTOS, and thank you for your support!      *\r
-     *                                                                       *\r
-    ***************************************************************************\r
-\r
-\r
-    This file is part of the FreeRTOS distribution.\r
-\r
-    FreeRTOS is free software; you can redistribute it and/or modify it under\r
-    the terms of the GNU General Public License (version 2) as published by the\r
-    Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
-\r
-    >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
-    distribute a combined work that includes FreeRTOS without being obliged to\r
-    provide the source code for proprietary components outside of the FreeRTOS\r
-    kernel.\r
-\r
-    FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
-    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
-    FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
-    details. You should have received a copy of the GNU General Public License\r
-    and the FreeRTOS license exception along with FreeRTOS; if not it can be\r
-    viewed here: http://www.freertos.org/a00114.html and also obtained by\r
-    writing to Real Time Engineers Ltd., contact details for whom are available\r
-    on the FreeRTOS WEB site.\r
-\r
-    1 tab == 4 spaces!\r
-\r
-    ***************************************************************************\r
-     *                                                                       *\r
-     *    Having a problem?  Start by reading the FAQ "My application does   *\r
-     *    not run, what could be wrong?"                                     *\r
-     *                                                                       *\r
-     *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
-     *                                                                       *\r
-    ***************************************************************************\r
-\r
-\r
-    http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
-    license and Real Time Engineers Ltd. contact details.\r
-\r
-    http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
-    including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
-    fully thread aware and reentrant UDP/IP stack.\r
-\r
-    http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
-    Integrity Systems, who sell the code with commercial support, \r
-    indemnification and middleware, under the OpenRTOS brand.\r
-    \r
-    http://www.SafeRTOS.com - High Integrity Systems also provide a safety \r
-    engineered and independently SIL3 certified version for use in safety and \r
-    mission critical applications that require provable dependability.\r
-*/\r
+ * FreeRTOS Kernel V10.2.1\r
+ * Copyright (C) 2019 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
  * main-blinky.c is included when the "Blinky" build configuration is used.\r
  * in this file.  prvQueueReceiveTask() sits in a loop that causes it to\r
  * repeatedly attempt to read data from the queue that was created within\r
  * main().  When data is received, the task checks the value of the data, and\r
- * if the value equals the expected 100, toggles the blue LED.  The 'block \r
- * time' parameter passed to the queue receive function specifies that the task \r
- * should be held in the Blocked state indefinitely to wait for data to be \r
- * available on the queue.  The queue receive task will only leave the Blocked \r
- * state when the queue send task writes to the queue.  As the queue send task \r
- * writes to the queue every 200 milliseconds, the queue receive task leaves the \r
- * Blocked state every 200 milliseconds, and therefore toggles the blue LED \r
+ * if the value equals the expected 100, toggles the blue LED.  The 'block\r
+ * time' parameter passed to the queue receive function specifies that the task\r
+ * should be held in the Blocked state indefinitely to wait for data to be\r
+ * available on the queue.  The queue receive task will only leave the Blocked\r
+ * state when the queue send task writes to the queue.  As the queue send task\r
+ * writes to the queue every 200 milliseconds, the queue receive task leaves the\r
+ * Blocked state every 200 milliseconds, and therefore toggles the blue LED\r
  * every 200 milliseconds.\r
  *\r
  * The LED Software Timer and the Button Interrupt:\r
  * The user button SW2 is configured to generate an interrupt each time it is\r
- * pressed.  The interrupt service routine switches the green LED on, and \r
- * resets the LED software timer.  The LED timer has a 5000 millisecond (5 \r
- * second) period, and uses a callback function that is defined to just turn the \r
- * LED off again.  Therefore, pressing the user button will turn the LED on, and \r
- * the LED will remain on until a full five seconds pass without the button \r
+ * pressed.  The interrupt service routine switches the green LED on, and\r
+ * resets the LED software timer.  The LED timer has a 5000 millisecond (5\r
+ * second) period, and uses a callback function that is defined to just turn the\r
+ * LED off again.  Therefore, pressing the user button will turn the LED on, and\r
+ * the LED will remain on until a full five seconds pass without the button\r
  * being pressed.\r
  */\r
 \r
 #define        mainQUEUE_SEND_TASK_PRIORITY            ( tskIDLE_PRIORITY + 1 )\r
 \r
 /* The rate at which data is sent to the queue, specified in milliseconds, and\r
-converted to ticks using the portTICK_RATE_MS constant. */\r
-#define mainQUEUE_SEND_FREQUENCY_MS                    ( 200 / portTICK_RATE_MS )\r
+converted to ticks using the portTICK_PERIOD_MS constant. */\r
+#define mainQUEUE_SEND_FREQUENCY_MS                    ( 200 / portTICK_PERIOD_MS )\r
 \r
 /* The LED will remain on until the button has not been pushed for a full\r
 5000ms. */\r
-#define mainBUTTON_LED_TIMER_PERIOD_MS         ( 5000UL / portTICK_RATE_MS )\r
+#define mainBUTTON_LED_TIMER_PERIOD_MS         ( 5000UL / portTICK_PERIOD_MS )\r
 \r
 /* The number of items the queue can hold.  This is 1 as the receive task\r
 will remove items as they are added, meaning the send task should always find\r
@@ -180,16 +133,16 @@ static void prvQueueSendTask( void *pvParameters );
  * The LED timer callback function.  This does nothing but switch off the\r
  * LED defined by the mainTIMER_CONTROLLED_LED constant.\r
  */\r
-static void prvButtonLEDTimerCallback( xTimerHandle xTimer );\r
+static void prvButtonLEDTimerCallback( TimerHandle_t xTimer );\r
 \r
 /*-----------------------------------------------------------*/\r
 \r
 /* The queue used by both tasks. */\r
-static xQueueHandle xQueue = NULL;\r
+static QueueHandle_t xQueue = NULL;\r
 \r
 /* The LED software timer.  This uses prvButtonLEDTimerCallback() as its callback\r
 function. */\r
-static xTimerHandle xButtonLEDTimer = NULL;\r
+static TimerHandle_t xButtonLEDTimer = NULL;\r
 \r
 /*-----------------------------------------------------------*/\r
 \r
@@ -205,17 +158,17 @@ void main( void )
        {\r
                /* Start the two tasks as described in the comments at the top of this\r
                file. */\r
-               xTaskCreate( prvQueueReceiveTask, ( signed char * ) "Rx", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_RECEIVE_TASK_PRIORITY, NULL );\r
-               xTaskCreate( prvQueueSendTask, ( signed char * ) "TX", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_SEND_TASK_PRIORITY, NULL );\r
+               xTaskCreate( prvQueueReceiveTask, "Rx", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_RECEIVE_TASK_PRIORITY, NULL );\r
+               xTaskCreate( prvQueueSendTask, "TX", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_SEND_TASK_PRIORITY, NULL );\r
 \r
                /* Create the software timer that is responsible for turning off the LED\r
                if the button is not pushed within 5000ms, as described at the top of\r
                this file. */\r
-               xButtonLEDTimer = xTimerCreate( ( const signed char * ) "ButtonLEDTimer", /* A text name, purely to help debugging. */\r
-                                                                       mainBUTTON_LED_TIMER_PERIOD_MS,                 /* The timer period, in this case 5000ms (5s). */\r
-                                                                       pdFALSE,                                                                /* This is a one shot timer, so xAutoReload is set to pdFALSE. */\r
-                                                                       ( void * ) 0,                                                   /* The ID is not used, so can be set to anything. */\r
-                                                                       prvButtonLEDTimerCallback                               /* The callback function that switches the LED off. */\r
+               xButtonLEDTimer = xTimerCreate( "ButtonLEDTimer",                       /* A text name, purely to help debugging. */\r
+                                                                       mainBUTTON_LED_TIMER_PERIOD_MS, /* The timer period, in this case 5000ms (5s). */\r
+                                                                       pdFALSE,                                                /* This is a one-shot timer, so xAutoReload is set to pdFALSE. */\r
+                                                                       ( void * ) 0,                                   /* The ID is not used, so can be set to anything. */\r
+                                                                       prvButtonLEDTimerCallback               /* The callback function that switches the LED off. */\r
                                                                );\r
 \r
                /* Start the tasks and timer running. */\r
@@ -231,7 +184,7 @@ void main( void )
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-static void prvButtonLEDTimerCallback( xTimerHandle xTimer )\r
+static void prvButtonLEDTimerCallback( TimerHandle_t xTimer )\r
 {\r
        /* The timer has expired - so no button pushes have occurred in the last\r
        five seconds - turn the LED off. */\r
@@ -268,7 +221,7 @@ portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;
 \r
 static void prvQueueSendTask( void *pvParameters )\r
 {\r
-portTickType xNextWakeTime;\r
+TickType_t xNextWakeTime;\r
 const unsigned long ulValueToSend = 100UL;\r
 \r
        /* Initialise xNextWakeTime - this only needs to be done once. */\r
@@ -317,20 +270,20 @@ static void prvSetupHardware( void )
        /* Enable the interrupt on SW1. */\r
        PORTE_PCR26 = PORT_PCR_MUX( 1 ) | PORT_PCR_IRQC( 0xA ) | PORT_PCR_PE_MASK | PORT_PCR_PS_MASK;\r
        enable_irq( mainGPIO_E_VECTOR );\r
-       \r
+\r
        /* The interrupt calls an interrupt safe API function - so its priority must\r
        be equal to or lower than configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY. */\r
        set_irq_priority( mainGPIO_E_VECTOR, configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY );\r
-       \r
+\r
        /* Set PTA10, PTA11, PTA28, and PTA29 (connected to LED's) for GPIO\r
        functionality. */\r
        PORTA_PCR10 = ( 0 | PORT_PCR_MUX( 1 ) );\r
        PORTA_PCR11 = ( 0 | PORT_PCR_MUX( 1 ) );\r
        PORTA_PCR28 = ( 0 | PORT_PCR_MUX( 1 ) );\r
        PORTA_PCR29 = ( 0 | PORT_PCR_MUX( 1 ) );\r
-       \r
+\r
        /* Change PTA10, PTA29 to outputs. */\r
-       GPIOA_PDDR=GPIO_PDDR_PDD( mainTASK_CONTROLLED_LED | mainTIMER_CONTROLLED_LED ); \r
+       GPIOA_PDDR=GPIO_PDDR_PDD( mainTASK_CONTROLLED_LED | mainTIMER_CONTROLLED_LED );\r
 \r
        /* Start with LEDs off. */\r
        GPIOA_PTOR = ~0U;\r
@@ -349,7 +302,7 @@ void vApplicationMallocFailedHook( void )
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-void vApplicationStackOverflowHook( xTaskHandle pxTask, signed char *pcTaskName )\r
+void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName )\r
 {\r
        ( void ) pcTaskName;\r
        ( void ) pxTask;\r
@@ -396,9 +349,9 @@ linker happy. */
 void vMainConfigureTimerForRunTimeStats( void ) {}\r
 unsigned long ulMainGetRunTimeCounterValue( void ) { return 0UL; }\r
 \r
-/* A tick hook is used by the "Full" build configuration.  The Full and blinky \r
-build configurations share a FreeRTOSConfig.h header file, so this simple build \r
-configuration also has to define a tick hook - even though it does not actually \r
+/* A tick hook is used by the "Full" build configuration.  The Full and blinky\r
+build configurations share a FreeRTOSConfig.h header file, so this simple build\r
+configuration also has to define a tick hook - even though it does not actually\r
 use it for anything. */\r
 void vApplicationTickHook( void ) {}\r
 \r