git.sur5r.net Git - freertos/blob

   1 /*\r
   2     FreeRTOS V8.2.3 - Copyright (C) 2015 Real Time Engineers Ltd.\r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     This file is part of the FreeRTOS distribution.\r
   8 \r
   9     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  10     the terms of the GNU General Public License (version 2) as published by the\r
  11     Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.\r
  12 \r
  13     ***************************************************************************\r
  14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  15     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  16     >>!   obliged to provide the source code for proprietary components     !<<\r
  17     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  18     ***************************************************************************\r
  19 \r
  20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  23     link: http://www.freertos.org/a00114.html\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    FreeRTOS provides completely free yet professionally developed,    *\r
  28      *    robust, strictly quality controlled, supported, and cross          *\r
  29      *    platform software that is more than just the market leader, it     *\r
  30      *    is the industry's de facto standard.                               *\r
  31      *                                                                       *\r
  32      *    Help yourself get started quickly while simultaneously helping     *\r
  33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  34      *    tutorial book, reference manual, or both:                          *\r
  35      *    http://www.FreeRTOS.org/Documentation                              *\r
  36      *                                                                       *\r
  37     ***************************************************************************\r
  38 \r
  39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
  40     the FAQ page "My application does not run, what could be wrong?".  Have you\r
  41     defined configASSERT()?\r
  42 \r
  43     http://www.FreeRTOS.org/support - In return for receiving this top quality\r
  44     embedded software for free we request you assist our global community by\r
  45     participating in the support forum.\r
  46 \r
  47     http://www.FreeRTOS.org/training - Investing in training allows your team to\r
  48     be as productive as possible as early as possible.  Now you can receive\r
  49     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
  50     Ltd, and the world's leading authority on the world's leading RTOS.\r
  51 \r
  52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  54     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  55 \r
  56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  58 \r
  59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
  60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  61     licenses offer ticketed support, indemnification and commercial middleware.\r
  62 \r
  63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  64     engineered and independently SIL3 certified version for use in safety and\r
  65     mission critical applications that require provable dependability.\r
  66 \r
  67     1 tab == 4 spaces!\r
  68 */\r
  69 \r
  70 /******************************************************************************\r
  71  * NOTE 1:  This project provides two demo applications.  A simple blinky demo\r
  72  * that demonstrates tickless low power operation, and a more comprehensive\r
  73  * test and demo application.  The configCREATE_LOW_POWER_DEMO setting in\r
  74  * FreeRTOSConfig.h is used to select between the two, and to select the clock\r
  75  * used when tickless low power operation is demonstrated.  See the notes on\r
  76  * using configCREATE_LOW_POWER_DEMO in main.c.  This file implements the low\r
  77  * power version.\r
  78  *\r
  79  * NOTE 2:  This file only contains the source code that is specific to the\r
  80  * low power demo.  Generic functions, such FreeRTOS hook functions, and\r
  81  * functions required to configure the hardware are defined in main.c.\r
  82  ******************************************************************************\r
  83  *\r
  84  * main_low_power() creates one queue, and two tasks.  It then starts the\r
  85  * scheduler.\r
  86  *\r
  87  * TBD\r
  88  */\r
  89 \r
  90 #warning Description of demo in comments above is not correct.\r
  91 \r
  92 /* Kernel includes. */\r
  93 #include "FreeRTOS.h"\r
  94 #include "task.h"\r
  95 #include "semphr.h"\r
  96 \r
  97 /* SiLabs includes. */\r
  98 #include "bsp.h"\r
  99 \r
 100 /* Priorities at which the tasks are created. */\r
 101 #define mainQUEUE_RECEIVE_TASK_PRIORITY         ( tskIDLE_PRIORITY + 2 )\r
 102 #define mainQUEUE_SEND_TASK_PRIORITY            ( tskIDLE_PRIORITY + 1 )\r
 103 \r
 104 /* The rate at which data is sent to the queue.  The 200ms value is converted\r
 105 to ticks using the portTICK_PERIOD_MS constant. */\r
 106 #define mainQUEUE_SEND_FREQUENCY_MS                     pdMS_TO_TICKS( 1000 )\r
 107 \r
 108 /* The number of items the queue can hold.  This is 1 as the receive task\r
 109 will remove items as they are added, meaning the send task should always find\r
 110 the queue empty. */\r
 111 #define mainQUEUE_LENGTH                                        ( 1 )\r
 112 \r
 113 /* The LED toggled by the Rx task. */\r
 114 #define mainTASK_LED                                            ( 0 )\r
 115 \r
 116 /*-----------------------------------------------------------*/\r
 117 \r
 118 /*\r
 119  * Called by main when mainCREATE_LOW_POWER_DEMO is set to 1 in\r
 120  * main.c.\r
 121  */\r
 122 void main_low_power( void );\r
 123 \r
 124 /*\r
 125  * The tasks as described in the comments at the top of this file.\r
 126  */\r
 127 static void prvQueueReceiveTask( void *pvParameters );\r
 128 static void prvQueueSendTask( void *pvParameters );\r
 129 \r
 130 /*-----------------------------------------------------------*/\r
 131 \r
 132 /* The queue used by both tasks. */\r
 133 static QueueHandle_t xQueue = NULL;\r
 134 \r
 135 /*-----------------------------------------------------------*/\r
 136 \r
 137 void main_low_power( void )\r
 138 {\r
 139         /* Create the queue. */\r
 140         xQueue = xQueueCreate( mainQUEUE_LENGTH, sizeof( uint32_t ) );\r
 141 \r
 142         if( xQueue != NULL )\r
 143         {\r
 144                 /* Start the two tasks as described in the comments at the top of this\r
 145                 file. */\r
 146                 xTaskCreate( prvQueueReceiveTask,                               /* The function that implements the task. */\r
 147                                         "Rx",                                                           /* The text name assigned to the task - for debug only as it is not used by the kernel. */\r
 148                                         configMINIMAL_STACK_SIZE,                       /* The size of the stack to allocate to the task. */\r
 149                                         NULL,                                                           /* The parameter passed to the task - not used in this case. */\r
 150                                         mainQUEUE_RECEIVE_TASK_PRIORITY,        /* The priority assigned to the task. */\r
 151                                         NULL );                                                         /* The task handle is not required, so NULL is passed. */\r
 152 \r
 153                 xTaskCreate( prvQueueSendTask, "TX", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_SEND_TASK_PRIORITY, NULL );\r
 154 \r
 155                 /* Start the tasks and timer running. */\r
 156                 vTaskStartScheduler();\r
 157         }\r
 158 \r
 159         /* If all is well, the scheduler will now be running, and the following\r
 160         line will never be reached.  If the following line does execute, then\r
 161         there was insufficient FreeRTOS heap memory available for the Idle and/or\r
 162         timer tasks to be created.  See the memory management section on the\r
 163         FreeRTOS web site for more details on the FreeRTOS heap\r
 164         http://www.freertos.org/a00111.html. */\r
 165         for( ;; );\r
 166 }\r
 167 /*-----------------------------------------------------------*/\r
 168 \r
 169 static void prvQueueSendTask( void *pvParameters )\r
 170 {\r
 171 TickType_t xNextWakeTime;\r
 172 const uint32_t ulValueToSend = 100UL;\r
 173 \r
 174         /* Remove compiler warning about unused parameter. */\r
 175         ( void ) pvParameters;\r
 176 \r
 177         /* Initialise xNextWakeTime - this only needs to be done once. */\r
 178         xNextWakeTime = xTaskGetTickCount();\r
 179 \r
 180         for( ;; )\r
 181         {\r
 182                 /* Place this task in the blocked state until it is time to run again. */\r
 183                 vTaskDelayUntil( &xNextWakeTime, mainQUEUE_SEND_FREQUENCY_MS );\r
 184 \r
 185                 /* Send to the queue - causing the queue receive task to unblock and\r
 186                 toggle the LED.  0 is used as the block time so the sending operation\r
 187                 will not block - it shouldn't need to block as the queue should always\r
 188                 be empty at this point in the code. */\r
 189                 xQueueSend( xQueue, &ulValueToSend, 0U );\r
 190         }\r
 191 }\r
 192 /*-----------------------------------------------------------*/\r
 193 \r
 194 static void prvQueueReceiveTask( void *pvParameters )\r
 195 {\r
 196 uint32_t ulReceivedValue;\r
 197 const uint32_t ulExpectedValue = 100UL;\r
 198 const TickType_t xShortDelay = pdMS_TO_TICKS( 10 );\r
 199 \r
 200         /* Remove compiler warning about unused parameter. */\r
 201         ( void ) pvParameters;\r
 202 \r
 203         for( ;; )\r
 204         {\r
 205                 /* Wait until something arrives in the queue - this task will block\r
 206                 indefinitely provided INCLUDE_vTaskSuspend is set to 1 in\r
 207                 FreeRTOSConfig.h. */\r
 208                 xQueueReceive( xQueue, &ulReceivedValue, portMAX_DELAY );\r
 209 \r
 210                 /*  To get here something must have been received from the queue, but\r
 211                 is it the expected value?  If it is, toggle the LED. */\r
 212                 if( ulReceivedValue == ulExpectedValue )\r
 213                 {\r
 214                         /* Turn the LED on for a brief time only so it doens't distort the\r
 215                         energy reading. */\r
 216                         BSP_LedSet( mainTASK_LED );\r
 217                         vTaskDelay( xShortDelay );\r
 218                         BSP_LedClear( mainTASK_LED );\r
 219                         ulReceivedValue = 0U;\r
 220                 }\r
 221         }\r
 222 }\r
 223 /*-----------------------------------------------------------*/\r
 224 \r