git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M4_SimpleLink_CC3220SF_CCS/Simply_Blinky_Demo/main_blinky.c

   1 /*\r
   2     FreeRTOS V9.0.1 - Copyright (C) 2017 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  *\r
  72  * NOTE 1:  This project provides two demo applications.  A simple blinky style\r
  73  * project, and a more comprehensive test and demo application.  The\r
  74  * configCREATE_SIMPLE_TICKLESS_DEMO setting in FreeRTOSConfig.h is used to\r
  75  * select between the two.  See the notes on using\r
  76  * configCREATE_SIMPLE_TICKLESS_DEMO in main.c.  This file implements the\r
  77  * simply blinky style version.\r
  78  *\r
  79  * The blinky demo uses FreeRTOS's tickless idle mode to reduce power\r
  80  * consumption.  See the notes on the web page below regarding the difference\r
  81  * in power saving that can be achieved between using the generic tickless\r
  82  * implementation (as used by the blinky demo) and a tickless implementation\r
  83  * that is tailored specifically to the CC3220.\r
  84  *\r
  85  * NOTE 2:  This file only contains the source code that is specific to the\r
  86  * basic demo.  Generic functions, such FreeRTOS hook functions, and functions\r
  87  * required to configure the hardware, are defined in main.c.\r
  88  *\r
  89  * See http://www.FreeRTOS.org/TI_CC3220_SimpleLink_FreeRTOS_Demo.html for\r
  90  * instructions.\r
  91  *\r
  92  ******************************************************************************\r
  93  *\r
  94  * main_blinky() creates one queue, and two tasks.  It then starts the\r
  95  * scheduler.\r
  96  *\r
  97  * The Queue Send Task:\r
  98  * The queue send task is implemented by the prvQueueSendTask() function in\r
  99  * this file.  prvQueueSendTask() sits in a loop that causes it to repeatedly\r
 100  * block for 200 milliseconds, before sending the value 100 to the queue that\r
 101  * was created within main_blinky().  Once the value is sent, the task loops\r
 102  * back around to block for another 200 milliseconds.\r
 103  *\r
 104  * The Queue Receive Task:\r
 105  * The queue receive task is implemented by the prvQueueReceiveTask() function\r
 106  * in this file.  prvQueueReceiveTask() sits in a loop where it repeatedly\r
 107  * blocks on attempts to read data from the queue that was created within\r
 108  * main_blinky().  When data is received, the task checks the value of the\r
 109  * data, and if the value equals the expected 100, toggles the LED.  The 'block\r
 110  * time' parameter passed to the queue receive function specifies that the\r
 111  * task should be held in the Blocked state indefinitely to wait for data to\r
 112  * be available on the queue.  The queue receive task will only leave the\r
 113  * Blocked state when the queue send task writes to the queue.  As the queue\r
 114  * send task writes to the queue every 200 milliseconds, the queue receive\r
 115  * task leaves the Blocked state every 200 milliseconds, and therefore toggles\r
 116  * the LED every 200 milliseconds.\r
 117  */\r
 118 \r
 119 /* Standard includes. */\r
 120 #include <stdio.h>\r
 121 \r
 122 /* Kernel includes. */\r
 123 #include "FreeRTOS.h"\r
 124 #include "task.h"\r
 125 #include "semphr.h"\r
 126 \r
 127 /* Priorities at which the tasks are created. */\r
 128 #define mainQUEUE_RECEIVE_TASK_PRIORITY         ( tskIDLE_PRIORITY + 2 )\r
 129 #define mainQUEUE_SEND_TASK_PRIORITY            ( tskIDLE_PRIORITY + 1 )\r
 130 \r
 131 /* The rate at which data is sent to the queue.  The 200ms value is converted\r
 132 to ticks using the portTICK_PERIOD_MS constant. */\r
 133 #define mainQUEUE_SEND_FREQUENCY_MS                     ( pdMS_TO_TICKS( 1000UL ) )\r
 134 \r
 135 /* The number of items the queue can hold.  This is 1 as the receive task\r
 136 will remove items as they are added, meaning the send task should always find\r
 137 the queue empty. */\r
 138 #define mainQUEUE_LENGTH                                        ( 1 )\r
 139 \r
 140 /* Values passed to the two tasks just to check the task parameter\r
 141 functionality. */\r
 142 #define mainQUEUE_SEND_PARAMETER                        ( 0x1111UL )\r
 143 #define mainQUEUE_RECEIVE_PARAMETER                     ( 0x22UL )\r
 144 \r
 145 /*-----------------------------------------------------------*/\r
 146 \r
 147 /*\r
 148  * The tasks as described in the comments at the top of this file.\r
 149  */\r
 150 static void prvQueueReceiveTask( void *pvParameters );\r
 151 static void prvQueueSendTask( void *pvParameters );\r
 152 \r
 153 /*\r
 154  * Called by main() to create the simply blinky style application if\r
 155  * configCREATE_SIMPLE_TICKLESS_DEMO is set to 1.\r
 156  */\r
 157 void main_blinky( void );\r
 158 \r
 159 /*\r
 160  * The full demo configures the clocks for maximum frequency, wheras this blinky\r
 161  * demo uses a slower clock as it also uses low power features.\r
 162  */\r
 163 static void prvConfigureClocks( void );\r
 164 \r
 165 /*\r
 166  * Toggles the LED built onto the Launchpad hardware.\r
 167  */\r
 168 extern void vMainToggleLED( void );\r
 169 \r
 170 /*-----------------------------------------------------------*/\r
 171 \r
 172 /* The queue used by both tasks. */\r
 173 static QueueHandle_t xQueue = NULL;\r
 174 \r
 175 /*-----------------------------------------------------------*/\r
 176 \r
 177 void main_blinky( void )\r
 178 {\r
 179         /* See http://www.FreeRTOS.org/TI_MSP432_Free_RTOS_Demo.html for\r
 180         instructions and notes regarding the difference in power saving that can be\r
 181         achieved between using the generic tickless RTOS implementation (as used by\r
 182         the blinky demo) and a tickless RTOS implementation that is tailored\r
 183         specifically to the MSP432. */\r
 184 \r
 185         /* The full demo configures the clocks for maximum frequency, wheras this\r
 186         blinky demo uses a slower clock as it also uses low power features. */\r
 187         prvConfigureClocks();\r
 188 \r
 189         /* Create the queue. */\r
 190         xQueue = xQueueCreate( mainQUEUE_LENGTH, sizeof( uint32_t ) );\r
 191 \r
 192         if( xQueue != NULL )\r
 193         {\r
 194                 /* Start the two tasks as described in the comments at the top of this\r
 195                 file. */\r
 196                 xTaskCreate( prvQueueReceiveTask,                                       /* The function that implements the task. */\r
 197                                         "Rx",                                                                   /* The text name assigned to the task - for debug only as it is not used by the kernel. */\r
 198                                         configMINIMAL_STACK_SIZE,                               /* The size of the stack to allocate to the task. */\r
 199                                         ( void * ) mainQUEUE_RECEIVE_PARAMETER, /* The parameter passed to the task - just to check the functionality. */\r
 200                                         mainQUEUE_RECEIVE_TASK_PRIORITY,                /* The priority assigned to the task. */\r
 201                                         NULL );                                                                 /* The task handle is not required, so NULL is passed. */\r
 202 \r
 203                 xTaskCreate( prvQueueSendTask, "TX", configMINIMAL_STACK_SIZE, ( void * ) mainQUEUE_SEND_PARAMETER, mainQUEUE_SEND_TASK_PRIORITY, NULL );\r
 204 \r
 205                 /* Start the tasks and timer running. */\r
 206                 vTaskStartScheduler();\r
 207         }\r
 208 \r
 209         /* If all is well, the scheduler will now be running, and the following\r
 210         line will never be reached.  If the following line does execute, then\r
 211         there was insufficient FreeRTOS heap memory available for the idle and/or\r
 212         timer tasks     to be created.  See the memory management section on the\r
 213         FreeRTOS web site for more details. */\r
 214         for( ;; );\r
 215 }\r
 216 /*-----------------------------------------------------------*/\r
 217 \r
 218 static void prvQueueSendTask( void *pvParameters )\r
 219 {\r
 220 TickType_t xNextWakeTime;\r
 221 const unsigned long ulValueToSend = 100UL;\r
 222 \r
 223         /* Check the task parameter is as expected. */\r
 224         configASSERT( ( ( unsigned long ) pvParameters ) == mainQUEUE_SEND_PARAMETER );\r
 225 \r
 226         /* Initialise xNextWakeTime - this only needs to be done once. */\r
 227         xNextWakeTime = xTaskGetTickCount();\r
 228 \r
 229         for( ;; )\r
 230         {\r
 231                 /* Place this task in the blocked state until it is time to run again.\r
 232                 The block time is specified in ticks, the constant used converts ticks\r
 233                 to ms.  While in the Blocked state this task will not consume any CPU\r
 234                 time. */\r
 235                 vTaskDelayUntil( &xNextWakeTime, mainQUEUE_SEND_FREQUENCY_MS );\r
 236 \r
 237                 /* Send to the queue - causing the queue receive task to unblock and\r
 238                 toggle the LED.  0 is used as the block time so the sending operation\r
 239                 will not block - it shouldn't need to block as the queue should always\r
 240                 be empty at this point in the code. */\r
 241                 xQueueSend( xQueue, &ulValueToSend, 0U );\r
 242         }\r
 243 }\r
 244 /*-----------------------------------------------------------*/\r
 245 \r
 246 static void prvQueueReceiveTask( void *pvParameters )\r
 247 {\r
 248 unsigned long ulReceivedValue;\r
 249 static const TickType_t xShortBlock = pdMS_TO_TICKS( 50 );\r
 250 \r
 251         /* Check the task parameter is as expected. */\r
 252         configASSERT( ( ( unsigned long ) pvParameters ) == mainQUEUE_RECEIVE_PARAMETER );\r
 253 \r
 254         for( ;; )\r
 255         {\r
 256                 /* Wait until something arrives in the queue - this task will block\r
 257                 indefinitely provided INCLUDE_vTaskSuspend is set to 1 in\r
 258                 FreeRTOSConfig.h. */\r
 259                 xQueueReceive( xQueue, &ulReceivedValue, portMAX_DELAY );\r
 260 \r
 261                 /*  To get here something must have been received from the queue, but\r
 262                 is it the expected value?  If it is, toggle the LED. */\r
 263                 if( ulReceivedValue == 100UL )\r
 264                 {\r
 265                         /* Blip the LED for a short while so as not to use too much\r
 266                         power. */\r
 267                         vMainToggleLED();\r
 268                         vTaskDelay( xShortBlock );\r
 269                         vMainToggleLED();\r
 270                         ulReceivedValue = 0U;\r
 271                 }\r
 272         }\r
 273 }\r
 274 /*-----------------------------------------------------------*/\r
 275 \r
 276 static void prvConfigureClocks( void )\r
 277 {\r
 278 }\r
 279 /*-----------------------------------------------------------*/\r
 280 \r
 281 void vPreSleepProcessing( uint32_t ulExpectedIdleTime )\r
 282 {\r
 283 }\r
 284 /*-----------------------------------------------------------*/\r
 285 \r
 286 #if( configCREATE_SIMPLE_TICKLESS_DEMO == 1 )\r
 287 \r
 288         void vApplicationTickHook( void )\r
 289         {\r
 290                 /* This function will be called by each tick interrupt if\r
 291                 configUSE_TICK_HOOK is set to 1 in FreeRTOSConfig.h.  User code can be\r
 292                 added here, but the tick hook is called from an interrupt context, so\r
 293                 code must not attempt to block, and only the interrupt safe FreeRTOS API\r
 294                 functions can be used (those that end in FromISR()). */\r
 295 \r
 296                 /* Only the full demo uses the tick hook so there is no code is\r
 297                 executed here. */\r
 298         }\r
 299 \r
 300 #endif\r
 301 \r