]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Demo/CORTEX_STM32F100_Atollic/Simple_Demo_Source/main.c
Ensure both one-shot and auto-reload are written consistently with a hyphen in comments.
[freertos] / FreeRTOS / Demo / CORTEX_STM32F100_Atollic / Simple_Demo_Source / main.c
index d138157c8ab6d5588c59b644d0ec70917db228de..1b434fa6d3f89ec15265248585e66b60510950dd 100644 (file)
@@ -1,93 +1,46 @@
 /*\r
-    FreeRTOS V7.4.1 - 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
 This simple demo project runs on the STM32 Discovery board, which is\r
-populated with an STM32F100RB Cortex-M3 microcontroller.  The discovery board \r
+populated with an STM32F100RB Cortex-M3 microcontroller.  The discovery board\r
 makes an ideal low cost evaluation platform, but the 8K of RAM provided on the\r
-STM32F100RB does not allow the simple application to demonstrate all of all the \r
-FreeRTOS kernel features.  Therefore, this simple demo only actively \r
-demonstrates task, queue, timer and interrupt functionality.  In addition, the \r
-demo is configured to include malloc failure, idle and stack overflow hook \r
+STM32F100RB does not allow the simple application to demonstrate all of all the\r
+FreeRTOS kernel features.  Therefore, this simple demo only actively\r
+demonstrates task, queue, timer and interrupt functionality.  In addition, the\r
+demo is configured to include malloc failure, idle and stack overflow hook\r
 functions.\r
 \r
 The idle hook function:\r
 The idle hook function queries the amount of FreeRTOS heap space that is\r
-remaining (see vApplicationIdleHook() defined in this file).  The demo \r
-application is configured to use 7K of the available 8K of RAM as the FreeRTOS \r
-heap.  Memory is only allocated from this heap during initialisation, and this \r
-demo only actually uses 1.6K bytes of the configured 7K available - leaving 5.4K \r
+remaining (see vApplicationIdleHook() defined in this file).  The demo\r
+application is configured to use 7K of the available 8K of RAM as the FreeRTOS\r
+heap.  Memory is only allocated from this heap during initialisation, and this\r
+demo only actually uses 1.6K bytes of the configured 7K available - leaving 5.4K\r
 bytes of heap space unallocated.\r
 \r
 The main() Function:\r
@@ -95,31 +48,31 @@ main() creates one software timer, one queue, and two tasks.  It then starts the
 scheduler.\r
 \r
 The Queue Send Task:\r
-The queue send task is implemented by the prvQueueSendTask() function in this \r
-file.  prvQueueSendTask() sits in a loop that causes it to repeatedly block for \r
-200 milliseconds, before sending the value 100 to the queue that was created \r
+The queue send task is implemented by the prvQueueSendTask() function in this\r
+file.  prvQueueSendTask() sits in a loop that causes it to repeatedly block for\r
+200 milliseconds, before sending the value 100 to the queue that was created\r
 within main().  Once the value is sent, the task loops back around to block for\r
 another 200 milliseconds.\r
 \r
 The Queue Receive Task:\r
 The queue receive task is implemented by the prvQueueReceiveTask() function\r
-in this file.  prvQueueReceiveTask() sits in a loop where it repeatedly blocks \r
-on attempts to read data from the queue that was created within main().  When \r
-data is received, the task checks the value of the data, and if the value equals \r
-the expected 100, toggles the green LED.  The 'block time' parameter passed to \r
-the queue receive function specifies that the task should be held in the Blocked \r
-state indefinitely to wait for data to be available on the queue.  The queue \r
-receive task will only leave the Blocked state when the queue send task writes \r
-to the queue.  As the queue send task writes to the queue every 200 \r
-milliseconds, the queue receive task leaves the Blocked state every 200 \r
+in this file.  prvQueueReceiveTask() sits in a loop where it repeatedly blocks\r
+on attempts to read data from the queue that was created within main().  When\r
+data is received, the task checks the value of the data, and if the value equals\r
+the expected 100, toggles the green LED.  The 'block time' parameter passed to\r
+the queue receive function specifies that the task should be held in the Blocked\r
+state indefinitely to wait for data to be available on the queue.  The queue\r
+receive task will only leave the Blocked state when the queue send task writes\r
+to the queue.  As the queue send task writes to the queue every 200\r
+milliseconds, the queue receive task leaves the Blocked state every 200\r
 milliseconds, and therefore toggles the green LED every 200 milliseconds.\r
 \r
 The LED Software Timer and the Button Interrupt:\r
 The user button B1 is configured to generate an interrupt each time it is\r
-pressed.  The interrupt service routine switches the red LED on, and resets the \r
+pressed.  The interrupt service routine switches the red LED on, and resets the\r
 LED software timer.  The LED timer has a 5000 millisecond (5 second) period, and\r
-uses a callback function that is defined to just turn the red LED off.  \r
-Therefore, pressing the user button will turn the red LED on, and the LED will \r
+uses a callback function that is defined to just turn the red LED off.\r
+Therefore, pressing the user button will turn the red LED on, and the LED will\r
 remain on until a full five seconds pass without the button being pressed.\r
 */\r
 \r
@@ -139,8 +92,8 @@ remain on until a full five seconds pass without the button being pressed.
 #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 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
@@ -161,20 +114,20 @@ static void prvQueueReceiveTask( void *pvParameters );
 static void prvQueueSendTask( void *pvParameters );\r
 \r
 /*\r
- * The LED timer callback function.  This does nothing but switch the red LED \r
+ * The LED timer callback function.  This does nothing but switch the red LED\r
  * off.\r
  */\r
-static void vLEDTimerCallback( xTimerHandle xTimer );\r
+static void vLEDTimerCallback( 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 vLEDTimerCallback() as its callback\r
- * function. \r
+ * function.\r
  */\r
-static xTimerHandle xLEDTimer = NULL;\r
+static TimerHandle_t xLEDTimer = NULL;\r
 \r
 /*-----------------------------------------------------------*/\r
 \r
@@ -190,17 +143,17 @@ int 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
+               /* 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
-               xLEDTimer = xTimerCreate(       ( const signed char * ) "LEDTimer", /* A text name, purely to help debugging. */\r
-                                                                       ( 5000 / portTICK_RATE_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
-                                                                       vLEDTimerCallback                                       /* The callback function that switches the LED off. */\r
+               xLEDTimer = xTimerCreate(       "LEDTimer",                             /* A text name, purely to help debugging. */\r
+                                                                       ( 5000 / portTICK_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
+                                                                       vLEDTimerCallback                       /* The callback function that switches the LED off. */\r
                                                                );\r
 \r
                /* Start the tasks and timer running. */\r
@@ -216,7 +169,7 @@ int main(void)
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-static void vLEDTimerCallback( xTimerHandle xTimer )\r
+static void vLEDTimerCallback( 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.  NOTE - accessing the LED port should use\r
@@ -256,7 +209,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
@@ -295,8 +248,8 @@ unsigned long ulReceivedValue;
                if( ulReceivedValue == 100UL )\r
                {\r
                        /* NOTE - accessing the LED port should use a critical section\r
-                       because it is accessed from multiple tasks, and the button interrupt \r
-                       - in this trivial case, for simplicity, the critical section is \r
+                       because it is accessed from multiple tasks, and the button interrupt\r
+                       - in this trivial case, for simplicity, the critical section is\r
                        omitted. */\r
                        STM32vldiscovery_LEDToggle( LED3 );\r
                }\r
@@ -314,7 +267,7 @@ static void prvSetupHardware( void )
        STM32vldiscovery_LEDInit( LED3 );\r
        STM32vldiscovery_LEDInit( LED4 );\r
        STM32vldiscovery_PBInit( BUTTON_USER, BUTTON_MODE_EXTI );\r
-       \r
+\r
        /* Start with the LEDs off. */\r
        STM32vldiscovery_LEDOff( LED3 );\r
        STM32vldiscovery_LEDOff( LED4 );\r
@@ -325,14 +278,14 @@ void vApplicationMallocFailedHook( void )
 {\r
        /* Called if a call to pvPortMalloc() fails because there is insufficient\r
        free memory available in the FreeRTOS heap.  pvPortMalloc() is called\r
-       internally by FreeRTOS API functions that create tasks, queues, software \r
+       internally by FreeRTOS API functions that create tasks, queues, software\r
        timers, and semaphores.  The size of the FreeRTOS heap is set by the\r
        configTOTAL_HEAP_SIZE configuration constant in FreeRTOSConfig.h. */\r
        for( ;; );\r
 }\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
@@ -349,7 +302,7 @@ void vApplicationIdleHook( void )
 volatile size_t xFreeStackSpace;\r
 \r
        /* This function is called on each cycle of the idle task.  In this case it\r
-       does nothing useful, other than report the amout of FreeRTOS heap that \r
+       does nothing useful, other than report the amout of FreeRTOS heap that\r
        remains unallocated. */\r
        xFreeStackSpace = xPortGetFreeHeapSize();\r
 \r