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