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