]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Demo/Common/Minimal/flash_timer.c
Ensure both one-shot and auto-reload are written consistently with a hyphen in comments.
[freertos] / FreeRTOS / Demo / Common / Minimal / flash_timer.c
index cefc622e3238c713bb27528c4d0e8c861b7f02c1..5a244ba65d1c709971ce892b1ea5eef76bb0fea4 100644 (file)
@@ -1,73 +1,35 @@
 /*\r
-    FreeRTOS V7.5.3 - Copyright (C) 2013 Real Time Engineers Ltd. \r
-    All rights reserved\r
-\r
-    VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
-\r
-    ***************************************************************************\r
-     *                                                                       *\r
-     *    FreeRTOS provides completely free yet professionally developed,    *\r
-     *    robust, strictly quality controlled, supported, and cross          *\r
-     *    platform software that has become a de facto standard.             *\r
-     *                                                                       *\r
-     *    Help yourself get started quickly and support the FreeRTOS         *\r
-     *    project by purchasing a FreeRTOS tutorial book, reference          *\r
-     *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
-     *                                                                       *\r
-     *    Thank you!                                                         *\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 distribute\r
-    >>! a combined work that includes FreeRTOS without being obliged to provide\r
-    >>! 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.  Full license text is available from the following\r
-    link: http://www.freertos.org/a00114.html\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
-    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, a DOS\r
-    compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
-\r
-    http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
-    Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
-    licenses offer ticketed support, indemnification and middleware.\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
-    1 tab == 4 spaces!\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
  * Repeatedly toggles one or more LEDs using software timers - one timer per\r
  * LED.\r
  */\r
\r
+\r
 /* Scheduler include files. */\r
 #include "FreeRTOS.h"\r
 #include "timers.h"\r
 #include "flash_timer.h"\r
 \r
 /* The toggle rates are all a multple of ledFLASH_RATE_BASE. */\r
-#define ledFLASH_RATE_BASE     ( ( ( portTickType ) 333 ) / portTICK_RATE_MS )\r
+#define ledFLASH_RATE_BASE     ( ( ( TickType_t ) 333 ) / portTICK_PERIOD_MS )\r
 \r
 /* A block time of zero simple means "don't block". */\r
-#define ledDONT_BLOCK          ( ( portTickType ) 0 )\r
+#define ledDONT_BLOCK          ( ( TickType_t ) 0 )\r
 \r
 /*-----------------------------------------------------------*/\r
 \r
  * this function, and the timer ID is used within the function to determine\r
  * which timer has actually expired.\r
  */\r
-static void prvLEDTimerCallback( xTimerHandle xTimer );\r
+static void prvLEDTimerCallback( TimerHandle_t xTimer );\r
 \r
 /*-----------------------------------------------------------*/\r
 \r
-void vStartLEDFlashTimers( unsigned portBASE_TYPE uxNumberOfLEDs )\r
+void vStartLEDFlashTimers( UBaseType_t uxNumberOfLEDs )\r
 {\r
-unsigned portBASE_TYPE uxLEDTimer;\r
-xTimerHandle xTimer;\r
+UBaseType_t uxLEDTimer;\r
+TimerHandle_t xTimer;\r
 \r
        /* Create and start the requested number of timers. */\r
        for( uxLEDTimer = 0; uxLEDTimer < uxNumberOfLEDs; ++uxLEDTimer )\r
        {\r
                /* Create the timer. */\r
-               xTimer = xTimerCreate(  ( const signed char * const ) "Flasher",/* A text name, purely to help debugging. */\r
-                                                               ledFLASH_RATE_BASE * ( uxLEDTimer + 1 ),        /* The timer period, which is a multiple of ledFLASH_RATE_BASE. */\r
+               xTimer = xTimerCreate(  "Flasher",                                                              /* A text name, purely to help debugging. */\r
+                                                               ledFLASH_RATE_BASE * ( uxLEDTimer + 1 ),/* The timer period, which is a multiple of ledFLASH_RATE_BASE. */\r
                                                                pdTRUE,                                                                 /* This is an auto-reload timer, so xAutoReload is set to pdTRUE. */\r
                                                                ( void * ) uxLEDTimer,                                  /* The ID is used to identify the timer within the timer callback function, as each timer uses the same callback. */\r
                                                                prvLEDTimerCallback                                             /* Each timer uses the same callback. */\r
                                                          );\r
-                               \r
+\r
                /* If the timer was created successfully, attempt to start it.  If the\r
                scheduler has not yet been started then the timer command queue must\r
                be long enough to hold each command sent to it until such time that the\r
@@ -117,19 +79,19 @@ xTimerHandle xTimer;
                if( xTimer != NULL )\r
                {\r
                        xTimerStart( xTimer, ledDONT_BLOCK );\r
-               }                                                         \r
+               }\r
        }\r
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-static void prvLEDTimerCallback( xTimerHandle xTimer )\r
+static void prvLEDTimerCallback( TimerHandle_t xTimer )\r
 {\r
-portBASE_TYPE xTimerID;\r
+BaseType_t xTimerID;\r
 \r
        /* The timer ID is used to identify the timer that has actually expired as\r
        each timer uses the same callback.  The ID is then also used as the number\r
        of the LED that is to be toggled. */\r
-       xTimerID = ( portBASE_TYPE ) pvTimerGetTimerID( xTimer );\r
+       xTimerID = ( BaseType_t ) pvTimerGetTimerID( xTimer );\r
        vParTestToggleLED( xTimerID );\r
 }\r
 \r