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

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