git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M4_ATSAM4E_Atmel_Studio/src/main_blinky.c

   1 /*\r
   2     FreeRTOS V7.6.0 - Copyright (C) 2013 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     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS provides completely free yet professionally developed,    *\r
  10      *    robust, strictly quality controlled, supported, and cross          *\r
  11      *    platform software that has become a de facto standard.             *\r
  12      *                                                                       *\r
  13      *    Help yourself get started quickly and support the FreeRTOS         *\r
  14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \r
  23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  24     the terms of the GNU General Public License (version 2) as published by the\r
  25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  26 \r
  27     >>! NOTE: The modification to the GPL is included to allow you to distribute\r
  28     >>! a combined work that includes FreeRTOS without being obliged to provide\r
  29     >>! the source code for proprietary components outside of the FreeRTOS\r
  30     >>! kernel.\r
  31 \r
  32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  35     link: http://www.freertos.org/a00114.html\r
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \r
  51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  54 \r
  55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  57     licenses offer ticketed support, indemnification and middleware.\r
  58 \r
  59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  60     engineered and independently SIL3 certified version for use in safety and\r
  61     mission critical applications that require provable dependability.\r
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 /******************************************************************************\r
  67  * NOTE 1:  This project provides two demo applications.  A simple blinky style\r
  68  * project, and a more comprehensive demo application that makes use of some\r
  69  * add-on components.  The mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting in main.c \r
  70  * is used to select between the two.  See the notes on using \r
  71  * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY in main.c.  This file implements the \r
  72  * simply blinky style version.\r
  73  *\r
  74  * NOTE 2:  This file only contains the source code that is specific to the\r
  75  * basic demo.  Generic functions, such FreeRTOS hook functions, and functions\r
  76  * required to configure the hardware, are defined in main.c.\r
  77  ******************************************************************************\r
  78  *\r
  79  * main_blinky() creates one queue, and two tasks and one software timer.  It \r
  80  * then starts the scheduler.\r
  81  *\r
  82  * The Queue Send Task:\r
  83  * The queue send task is implemented by the prvQueueSendTask() function in\r
  84  * this file.  The task sits in a loop that sends a value to the queue every\r
  85  * 200 milliseconds.\r
  86  *\r
  87  * The Queue Receive Task:\r
  88  * The queue receive task is implemented by the prvQueueReceiveTask() function\r
  89  * in this file.  The task sits in a loop that blocks on the queue to wait for\r
  90  * data to arrive (it does not use any CPU time while it is in the Blocked\r
  91  * state), toggling an LED each time it receives the value sent by the queue\r
  92  * send task.  As the queue send task writes to the queue every 200 milliseconds\r
  93  * the LED will toggle every 200 milliseconds.\r
  94  */\r
  95 \r
  96 \r
  97 /* Kernel includes. */\r
  98 #include "FreeRTOS.h"\r
  99 #include "task.h"\r
 100 #include "queue.h"\r
 101 #include "timers.h"\r
 102 \r
 103 /* Demo application includes. */\r
 104 #include "partest.h"\r
 105 \r
 106 /* Priorities at which the tasks are created. */\r
 107 #define mainQUEUE_RECEIVE_TASK_PRIORITY         ( tskIDLE_PRIORITY + 2 )\r
 108 #define mainQUEUE_SEND_TASK_PRIORITY            ( tskIDLE_PRIORITY + 1 )\r
 109 \r
 110 /* The rate at which data is sent to the queue.  The 200ms value is converted\r
 111 to ticks using the portTICK_RATE_MS constant. */\r
 112 #define mainQUEUE_SEND_FREQUENCY_MS                     ( 200 / portTICK_RATE_MS )\r
 113 \r
 114 /* The number of items the queue can hold.  This is 1 as the receive task\r
 115 will remove items as they are added, meaning the send task should always find\r
 116 the queue empty. */\r
 117 #define mainQUEUE_LENGTH                                        ( 1 )\r
 118 \r
 119 /* Values passed to the two tasks just to check the task parameter\r
 120 functionality. */\r
 121 #define mainQUEUE_SEND_PARAMETER                        ( 0x1111UL )\r
 122 #define mainQUEUE_RECEIVE_PARAMETER                     ( 0x22UL )\r
 123 \r
 124 /* The period of the blinky software timer.  The period is specified in ms and\r
 125 converted to ticks using the portTICK_RATE_MS constant. */\r
 126 #define mainBLINKY_TIMER_PERIOD                         ( 50 / portTICK_RATE_MS )\r
 127 \r
 128 /* A block time of zero simply means "don't block". */\r
 129 #define mainDONT_BLOCK                                          ( 0 )\r
 130 \r
 131 /* The LEDs toggled by the timer and queue receive task respectively. */\r
 132 #define mainTIMER_LED                                           0\r
 133 #define mainTASK_LED                                            1\r
 134 \r
 135 /*-----------------------------------------------------------*/\r
 136 \r
 137 /*\r
 138  * The tasks as described in the comments at the top of this file.\r
 139  */\r
 140 static void prvQueueReceiveTask( void *pvParameters );\r
 141 static void prvQueueSendTask( void *pvParameters );\r
 142 \r
 143 /*\r
 144  * The callback function for the blinky software timer, as described at the top\r
 145  * of this file.\r
 146  */\r
 147 static void prvBlinkyTimerCallback( xTimerHandle xTimer );\r
 148 \r
 149 /*\r
 150  * Called by main() to create the simply blinky style application if\r
 151  * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 1.\r
 152  */\r
 153 void main_blinky( void );\r
 154 \r
 155 /*-----------------------------------------------------------*/\r
 156 \r
 157 /* The queue used by both tasks. */\r
 158 static xQueueHandle xQueue = NULL;\r
 159 \r
 160 /*-----------------------------------------------------------*/\r
 161 \r
 162 void main_blinky( void )\r
 163 {\r
 164 xTimerHandle xTimer;\r
 165 \r
 166         /* Create the queue. */\r
 167         xQueue = xQueueCreate( mainQUEUE_LENGTH, sizeof( unsigned long ) );\r
 168 \r
 169         if( xQueue != NULL )\r
 170         {\r
 171                 /* Start the two tasks as described in the comments at the top of this\r
 172                 file. */\r
 173                 xTaskCreate( prvQueueReceiveTask,                                       /* The function that implements the task. */\r
 174                                         ( signed char * ) "Rx",                                 /* The text name assigned to the task - for debug only as it is not used by the kernel. */\r
 175                                         configMINIMAL_STACK_SIZE,                               /* The size of the stack to allocate to the task. */\r
 176                                         ( void * ) mainQUEUE_RECEIVE_PARAMETER, /* The parameter passed to the task - just to check the functionality. */\r
 177                                         mainQUEUE_RECEIVE_TASK_PRIORITY,                /* The priority assigned to the task. */\r
 178                                         NULL );                                                                 /* The task handle is not required, so NULL is passed. */\r
 179 \r
 180                 xTaskCreate( prvQueueSendTask, ( signed char * ) "TX", configMINIMAL_STACK_SIZE, ( void * ) mainQUEUE_SEND_PARAMETER, mainQUEUE_SEND_TASK_PRIORITY, NULL );\r
 181 \r
 182                 /* Create the blinky software timer as described at the top of this \r
 183                 file. */\r
 184                 xTimer = xTimerCreate(  ( const signed char * ) "Blinky",/* A text name, purely to help debugging. */\r
 185                                                                 ( mainBLINKY_TIMER_PERIOD ),    /* The timer period. */\r
 186                                                                 pdTRUE,                                                 /* This is an auto-reload timer, so xAutoReload is set to pdTRUE. */\r
 187                                                                 ( void * ) 0,                                   /* The ID is not used, so can be set to anything. */\r
 188                                                                 prvBlinkyTimerCallback );               /* The callback function that inspects the status of all the other tasks. */\r
 189 \r
 190                 configASSERT( xTimer );\r
 191 \r
 192                 if( xTimer != NULL )\r
 193                 {\r
 194                         xTimerStart( xTimer, mainDONT_BLOCK );\r
 195                 }\r
 196 \r
 197                 /* Start the tasks and timer running. */\r
 198                 vTaskStartScheduler();\r
 199         }\r
 200 \r
 201         /* If all is well, the scheduler will now be running, and the following\r
 202         line will never be reached.  If the following line does execute, then\r
 203         there was insufficient FreeRTOS heap memory available for the idle and/or\r
 204         timer tasks     to be created.  See the memory management section on the\r
 205         FreeRTOS web site for more details. */\r
 206         for( ;; );\r
 207 }\r
 208 /*-----------------------------------------------------------*/\r
 209 \r
 210 static void prvQueueSendTask( void *pvParameters )\r
 211 {\r
 212 portTickType xNextWakeTime;\r
 213 const unsigned long ulValueToSend = 100UL;\r
 214 \r
 215         /* Check the task parameter is as expected. */\r
 216         configASSERT( ( ( unsigned long ) pvParameters ) == mainQUEUE_SEND_PARAMETER );\r
 217 \r
 218         /* Initialise xNextWakeTime - this only needs to be done once. */\r
 219         xNextWakeTime = xTaskGetTickCount();\r
 220 \r
 221         for( ;; )\r
 222         {\r
 223                 /* Place this task in the blocked state until it is time to run again.\r
 224                 The block time is specified in ticks, the constant used converts ticks\r
 225                 to ms.  While in the Blocked state this task will not consume any CPU\r
 226                 time. */\r
 227                 vTaskDelayUntil( &xNextWakeTime, mainQUEUE_SEND_FREQUENCY_MS );\r
 228 \r
 229                 /* Send to the queue - causing the queue receive task to unblock and\r
 230                 toggle the LED.  0 is used as the block time so the sending operation\r
 231                 will not block - it shouldn't need to block as the queue should always\r
 232                 be empty at this point in the code. */\r
 233                 xQueueSend( xQueue, &ulValueToSend, 0U );\r
 234         }\r
 235 }\r
 236 /*-----------------------------------------------------------*/\r
 237 \r
 238 static void prvQueueReceiveTask( void *pvParameters )\r
 239 {\r
 240 unsigned long ulReceivedValue;\r
 241 \r
 242         /* Check the task parameter is as expected. */\r
 243         configASSERT( ( ( unsigned long ) pvParameters ) == mainQUEUE_RECEIVE_PARAMETER );\r
 244 \r
 245         for( ;; )\r
 246         {\r
 247                 /* Wait until something arrives in the queue - this task will block\r
 248                 indefinitely provided INCLUDE_vTaskSuspend is set to 1 in\r
 249                 FreeRTOSConfig.h. */\r
 250                 xQueueReceive( xQueue, &ulReceivedValue, portMAX_DELAY );\r
 251 \r
 252                 /*  To get here something must have been received from the queue, but\r
 253                 is it the expected value?  If it is, toggle the LED. */\r
 254                 if( ulReceivedValue == 100UL )\r
 255                 {\r
 256                         vParTestToggleLED( mainTASK_LED );\r
 257                         ulReceivedValue = 0U;\r
 258                 }\r
 259         }\r
 260 }\r
 261 /*-----------------------------------------------------------*/\r
 262 \r
 263 static void prvBlinkyTimerCallback( xTimerHandle xTimer )\r
 264 {\r
 265         /* Avoid compiler warnings. */\r
 266         ( void ) xTimer;\r
 267 \r
 268         /* This function is called when the blinky software time expires.  All the\r
 269         function does is toggle the LED.  LED mainTIMER_LED should therefore toggle\r
 270         with the period set by mainBLINKY_TIMER_PERIOD. */\r
 271         vParTestToggleLED( mainTIMER_LED );\r
 272 }\r
 273 /*-----------------------------------------------------------*/\r
 274 \r