git.sur5r.net Git - freertos/blob - Demo/HCS12_GCC_banked/main.c

   1 \r
   2 /*\r
   3         FreeRTOS.org V5.1.2 - Copyright (C) 2003-2009 Richard Barry.\r
   4 \r
   5         This file is part of the FreeRTOS.org distribution.\r
   6 \r
   7         FreeRTOS.org is free software; you can redistribute it and/or modify\r
   8         it under the terms of the GNU General Public License as published by\r
   9         the Free Software Foundation; either version 2 of the License, or\r
  10         (at your option) any later version.\r
  11 \r
  12         FreeRTOS.org is distributed in the hope that it will be useful,\r
  13         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  14         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  15         GNU General Public License for more details.\r
  16 \r
  17         You should have received a copy of the GNU General Public License\r
  18         along with FreeRTOS.org; if not, write to the Free Software\r
  19         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  20 \r
  21         A special exception to the GPL can be applied should you wish to distribute\r
  22         a combined work that includes FreeRTOS.org, without being obliged to provide\r
  23         the source code for any proprietary components.  See the licensing section \r
  24         of http://www.FreeRTOS.org for full details of how and when the exception\r
  25         can be applied.\r
  26 \r
  27     ***************************************************************************\r
  28     ***************************************************************************\r
  29     *                                                                         *\r
  30     * Get the FreeRTOS eBook!  See http://www.FreeRTOS.org/Documentation      *\r
  31         *                                                                         *\r
  32         * This is a concise, step by step, 'hands on' guide that describes both   *\r
  33         * general multitasking concepts and FreeRTOS specifics. It presents and   *\r
  34         * explains numerous examples that are written using the FreeRTOS API.     *\r
  35         * Full source code for all the examples is provided in an accompanying    *\r
  36         * .zip file.                                                              *\r
  37     *                                                                         *\r
  38     ***************************************************************************\r
  39     ***************************************************************************\r
  40 \r
  41         Please ensure to read the configuration and relevant port sections of the\r
  42         online documentation.\r
  43 \r
  44         http://www.FreeRTOS.org - Documentation, latest information, license and \r
  45         contact details.\r
  46 \r
  47         http://www.SafeRTOS.com - A version that is certified for use in safety \r
  48         critical systems.\r
  49 \r
  50         http://www.OpenRTOS.com - Commercial support, development, porting, \r
  51         licensing and training services.\r
  52 */\r
  53 \r
  54 \r
  55 /*\r
  56  *\r
  57  * main() creates all the demo application tasks, then starts the scheduler.\r
  58  * The WEB      documentation provides more details of the demo application tasks.\r
  59  *\r
  60  * main.c also creates a task called "Check".  This only executes every three \r
  61  * seconds but has the highest priority so is guaranteed to get processor time.  \r
  62  * Its main function is to check that all the other tasks are still operational.\r
  63  * Each task (other than the "flash" tasks) maintains a unique count that is \r
  64  * incremented each time the task successfully completes its function.  Should \r
  65  * any error occur within such a task the count is permanently halted.  The \r
  66  * check task inspects the count of each task to ensure it has changed since\r
  67  * the last time the check task executed.  If all the count variables have \r
  68  * changed all the tasks are still executing error free, and the check task\r
  69  * toggles the onboard LED.  Should any task contain an error at any time \r
  70  * the LED toggle rate will change from 3 seconds to 500ms.\r
  71  *\r
  72  * This file also includes the functionality implemented within the \r
  73  * standard demo application file integer.c.  This is done to demonstrate the\r
  74  * use of an idle hook.  See the documentation within integer.c for the \r
  75  * rationale of the integer task functionality.\r
  76  * */\r
  77 \r
  78 /* Kernel includes. */\r
  79 #include "FreeRTOS.h"\r
  80 #include "task.h"\r
  81 #include "queue.h"\r
  82 \r
  83 #include "cpu.h"\r
  84 \r
  85 /* special prototypes for memory-banked functions */\r
  86 void vStartPolledQueueTasks( unsigned portBASE_TYPE uxPriority );\r
  87 portBASE_TYPE xArePollingQueuesStillRunning( void );\r
  88 \r
  89 /* Demo application includes. */\r
  90 #include "flash.h"\r
  91 #include "PollQ.h"\r
  92 #include "dynamic.h"\r
  93 #include "partest.h"\r
  94 #include "comtest2.h"\r
  95 #include "BlockQ.h"\r
  96 #include "integer.h"\r
  97 #include "death.h"\r
  98 \r
  99 \r
 100 /*-----------------------------------------------------------\r
 101         Definitions.\r
 102 -----------------------------------------------------------*/\r
 103 \r
 104 /* Priorities assigned to demo application tasks. */\r
 105 #define mainFLASH_PRIORITY                      ( tskIDLE_PRIORITY + 2 )\r
 106 #define mainCHECK_TASK_PRIORITY         ( tskIDLE_PRIORITY + 3 )\r
 107 #define mainQUEUE_POLL_PRIORITY         ( tskIDLE_PRIORITY + 1 )\r
 108 #define mainCOM_TEST_PRIORITY           ( tskIDLE_PRIORITY + 2 )\r
 109 #define mainBLOCK_Q_PRIORITY            ( tskIDLE_PRIORITY + 2 )\r
 110 #define mainDEATH_PRIORITY                      ( tskIDLE_PRIORITY + 1 )\r
 111 \r
 112 /* LED that is toggled by the check task.  The check task periodically checks\r
 113 that all the other tasks are operating without error.  If no errors are found\r
 114 the LED is toggled with mainCHECK_PERIOD frequency.  If an error is found \r
 115 then the toggle rate increases to mainERROR_CHECK_PERIOD. */\r
 116 #define mainCHECK_TASK_LED                      ( 7 )\r
 117 #define mainCHECK_PERIOD                        ( ( portTickType ) 3000 / portTICK_RATE_MS  )\r
 118 #define mainERROR_CHECK_PERIOD          ( ( portTickType ) 500 / portTICK_RATE_MS )\r
 119 \r
 120 /* The constants used in the idle task calculation. */\r
 121 #define intgCONST1                              ( ( portLONG ) 123 )\r
 122 #define intgCONST2                              ( ( portLONG ) 234567 )\r
 123 #define intgCONST3                              ( ( portLONG ) -3 )\r
 124 #define intgCONST4                              ( ( portLONG ) 7 )\r
 125 #define intgEXPECTED_ANSWER             ( ( ( intgCONST1 + intgCONST2 ) * intgCONST3 ) / intgCONST4 )\r
 126 \r
 127 \r
 128 /* Baud rate used by the serial port tasks (ComTest tasks).\r
 129 IMPORTANT:  The function COM0_SetBaudRateValue() which is generated by the\r
 130 Processor Expert is used to set the baud rate.  As configured in the FreeRTOS\r
 131 download this value must be one of the following:\r
 132 \r
 133 0 to configure for 38400 baud.\r
 134 1 to configure for 19200 baud.\r
 135 2 to configure for 9600 baud.\r
 136 3 to configure for 4800 baud. */\r
 137 #define mainCOM_TEST_BAUD_RATE                  ( ( unsigned portLONG ) 2 )\r
 138 \r
 139 /* LED used by the serial port tasks.  This is toggled on each character Tx,\r
 140 and mainCOM_TEST_LED + 1 is toggles on each character Rx. */\r
 141 #define mainCOM_TEST_LED                                ( 3 )\r
 142 \r
 143 /*-----------------------------------------------------------\r
 144         Local functions prototypes.\r
 145 -----------------------------------------------------------*/\r
 146 \r
 147 /*\r
 148  * The 'Check' task function.  See the explanation at the top of the file.\r
 149  */\r
 150 static void ATTR_BANK1 vErrorChecks( void* pvParameters );\r
 151 \r
 152 /*\r
 153  * The idle task hook - in which the integer task is implemented.  See the\r
 154  * explanation at the top of the file.\r
 155  */\r
 156 void ATTR_BANK0 vApplicationIdleHook( void );\r
 157 \r
 158 /*\r
 159  * Checks the unique counts of other tasks to ensure they are still operational.\r
 160  */\r
 161 static portLONG ATTR_BANK0 prvCheckOtherTasksAreStillRunning( void );\r
 162 \r
 163 \r
 164 \r
 165 /*-----------------------------------------------------------\r
 166         Local variables.\r
 167 -----------------------------------------------------------*/\r
 168 \r
 169 /* A few tasks are defined within this file.  This flag is used to indicate\r
 170 their status.  If an error is detected in one of the locally defined tasks then\r
 171 this flag is set to pdTRUE. */\r
 172 portBASE_TYPE xLocalError = pdFALSE;\r
 173 \r
 174 \r
 175 /*-----------------------------------------------------------*/\r
 176 \r
 177 /* This is called from startup. */\r
 178 int ATTR_BANK0 main ( void )\r
 179 {\r
 180         /* Start some of the standard demo tasks. */\r
 181         vStartLEDFlashTasks( mainFLASH_PRIORITY );\r
 182         vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );\r
 183         vStartDynamicPriorityTasks();\r
 184         vAltStartComTestTasks( mainCOM_TEST_PRIORITY, mainCOM_TEST_BAUD_RATE, mainCOM_TEST_LED );\r
 185         vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );\r
 186         vStartIntegerMathTasks( tskIDLE_PRIORITY );\r
 187         \r
 188         /* Start the locally defined tasks.  There is also a task implemented as\r
 189         the idle hook. */\r
 190         xTaskCreate( vErrorChecks, "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );\r
 191         \r
 192         /* Must be the last demo created. */\r
 193         vCreateSuicidalTasks( mainDEATH_PRIORITY );\r
 194 \r
 195         /* All the tasks have been created - start the scheduler. */\r
 196         vTaskStartScheduler();\r
 197         \r
 198         /* Should not reach here! */\r
 199         for( ;; );\r
 200         return 0;\r
 201 }\r
 202 /*-----------------------------------------------------------*/\r
 203 \r
 204 static void vErrorChecks( void *pvParameters )\r
 205 {\r
 206 portTickType xDelayPeriod = mainCHECK_PERIOD;\r
 207 portTickType xLastWakeTime;\r
 208 \r
 209         /* Initialise xLastWakeTime to ensure the first call to vTaskDelayUntil()\r
 210         functions correctly. */\r
 211         xLastWakeTime = xTaskGetTickCount();\r
 212 \r
 213         for( ;; )\r
 214         {\r
 215                 /* Delay until it is time to execute again.  The delay period is \r
 216                 shorter following an error. */\r
 217                 vTaskDelayUntil( &xLastWakeTime, xDelayPeriod );\r
 218 \r
 219                 /* Check all the demo application tasks are executing without \r
 220                 error. If an error is found the delay period is shortened - this\r
 221                 has the effect of increasing the flash rate of the 'check' task\r
 222                 LED. */\r
 223                 if( prvCheckOtherTasksAreStillRunning() == pdFAIL )\r
 224                 {\r
 225                         /* An error has been detected in one of the tasks - flash faster. */\r
 226                         xDelayPeriod = mainERROR_CHECK_PERIOD;\r
 227                 }\r
 228 \r
 229                 /* Toggle the LED each cycle round. */\r
 230                 vParTestToggleLED( mainCHECK_TASK_LED );\r
 231         }\r
 232 }\r
 233 /*-----------------------------------------------------------*/\r
 234 \r
 235 static portLONG prvCheckOtherTasksAreStillRunning( void )\r
 236 {\r
 237 portBASE_TYPE xAllTasksPassed = pdPASS;\r
 238 \r
 239         if( xArePollingQueuesStillRunning() != pdTRUE )\r
 240         {\r
 241                 xAllTasksPassed = pdFAIL;\r
 242         }\r
 243 \r
 244         if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )\r
 245         {\r
 246                 xAllTasksPassed = pdFAIL;\r
 247         }\r
 248 \r
 249         if( xAreComTestTasksStillRunning() != pdTRUE )\r
 250         {\r
 251                 xAllTasksPassed = pdFALSE;\r
 252         }\r
 253 \r
 254         if( xAreIntegerMathsTaskStillRunning() != pdTRUE )\r
 255         {\r
 256                 xAllTasksPassed = pdFALSE;\r
 257         }\r
 258         \r
 259         if( xAreBlockingQueuesStillRunning() != pdTRUE )\r
 260         {\r
 261                 xAllTasksPassed = pdFALSE;\r
 262         }       \r
 263 \r
 264     if( xIsCreateTaskStillRunning() != pdTRUE )\r
 265     {\r
 266         xAllTasksPassed = pdFALSE;\r
 267     }\r
 268 \r
 269         /* Also check the status flag for the tasks defined within this function. */\r
 270         if( xLocalError != pdFALSE )\r
 271         {\r
 272                 xAllTasksPassed = pdFAIL;\r
 273         }\r
 274         \r
 275         return xAllTasksPassed;\r
 276 }\r
 277 /*-----------------------------------------------------------*/\r
 278 \r
 279 void vApplicationIdleHook( void )\r
 280 {\r
 281 /* This variable is effectively set to a constant so it is made volatile to\r
 282 ensure the compiler does not just get rid of it. */\r
 283 volatile portLONG lValue;\r
 284 \r
 285         /* Keep performing a calculation and checking the result against a constant. */\r
 286 \r
 287         /* Perform the calculation.  This will store partial value in\r
 288         registers, resulting in a good test of the context switch mechanism. */\r
 289         lValue = intgCONST1;\r
 290         lValue += intgCONST2;\r
 291         lValue *= intgCONST3;\r
 292         lValue /= intgCONST4;\r
 293 \r
 294         /* Did we perform the calculation correctly with no corruption? */\r
 295         if( lValue != intgEXPECTED_ANSWER )\r
 296         {\r
 297                 /* Error! */\r
 298                 portENTER_CRITICAL();\r
 299                         xLocalError = pdTRUE;\r
 300                 portEXIT_CRITICAL();\r
 301         }\r
 302 \r
 303         /* Yield in case cooperative scheduling is being used. */\r
 304         #if configUSE_PREEMPTION == 0\r
 305         {\r
 306                 taskYIELD();\r
 307         }\r
 308         #endif          \r
 309 }\r
 310 /*-----------------------------------------------------------*/\r
 311 \r