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