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

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