]> git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_MPU_LM3Sxxxx_Rowley/main.c
5127ac9c774a779fd79a7868571620e8694a613a
[freertos] / FreeRTOS / Demo / CORTEX_MPU_LM3Sxxxx_Rowley / main.c
1 /*\r
2     FreeRTOS V7.5.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
3 \r
4     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
5 \r
6     ***************************************************************************\r
7      *                                                                       *\r
8      *    FreeRTOS provides completely free yet professionally developed,    *\r
9      *    robust, strictly quality controlled, supported, and cross          *\r
10      *    platform software that has become a de facto standard.             *\r
11      *                                                                       *\r
12      *    Help yourself get started quickly and support the FreeRTOS         *\r
13      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
14      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
15      *                                                                       *\r
16      *    Thank you!                                                         *\r
17      *                                                                       *\r
18     ***************************************************************************\r
19 \r
20     This file is part of the FreeRTOS distribution.\r
21 \r
22     FreeRTOS is free software; you can redistribute it and/or modify it under\r
23     the terms of the GNU General Public License (version 2) as published by the\r
24     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
25 \r
26     >>! NOTE: The modification to the GPL is included to allow you to distribute\r
27     >>! a combined work that includes FreeRTOS without being obliged to provide\r
28     >>! the source code for proprietary components outside of the FreeRTOS\r
29     >>! kernel.\r
30 \r
31     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
32     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
33     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
34     link: http://www.freertos.org/a00114.html\r
35 \r
36     1 tab == 4 spaces!\r
37 \r
38     ***************************************************************************\r
39      *                                                                       *\r
40      *    Having a problem?  Start by reading the FAQ "My application does   *\r
41      *    not run, what could be wrong?"                                     *\r
42      *                                                                       *\r
43      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
44      *                                                                       *\r
45     ***************************************************************************\r
46 \r
47     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
48     license and Real Time Engineers Ltd. contact details.\r
49 \r
50     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
51     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
52     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
53 \r
54     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
55     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
56     licenses offer ticketed support, indemnification and middleware.\r
57 \r
58     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
59     engineered and independently SIL3 certified version for use in safety and\r
60     mission critical applications that require provable dependability.\r
61 \r
62     1 tab == 4 spaces!\r
63 */\r
64 \r
65 \r
66 /*\r
67  * This file demonstrates the use of FreeRTOS-MPU.  It creates tasks in both\r
68  * User mode and Privileged mode, and using both the original xTaskCreate() and\r
69  * the new xTaskCreateRestricted() API functions.  The purpose of each created\r
70  * task is documented in the comments above the task function prototype (in\r
71  * this file), with the task behaviour demonstrated and documented within the\r
72  * task function itself.  In addition a queue is used to demonstrate passing\r
73  * data between protected/restricted tasks as well as passing data between an\r
74  * interrupt and a protected/restricted task.\r
75  */\r
76 \r
77 \r
78 \r
79 /* Standard includes. */\r
80 #include <string.h>\r
81 #include <__cross_studio_io.h>\r
82 \r
83 /* Scheduler includes. */\r
84 #include "FreeRTOS.h"\r
85 #include "task.h"\r
86 #include "queue.h"\r
87 #include "semphr.h"\r
88 \r
89 /* Hardware library includes. */\r
90 #include "hw_types.h"\r
91 #include "hw_sysctl.h"\r
92 #include "sysctl.h"\r
93 \r
94 /*-----------------------------------------------------------*/\r
95 \r
96 /* Misc constants. */\r
97 #define mainDONT_BLOCK                                  ( 0 )\r
98 \r
99 /* Definitions for the messages that can be sent to the check task. */\r
100 #define mainREG_TEST_1_STILL_EXECUTING  ( 0 )\r
101 #define mainREG_TEST_2_STILL_EXECUTING  ( 1 )\r
102 #define mainPRINT_SYSTEM_STATUS                 ( 2 )\r
103 \r
104 /* GCC specifics. */\r
105 #define mainALIGN_TO( x )                               __attribute__((aligned(x)))\r
106 \r
107 \r
108 /*-----------------------------------------------------------*/\r
109 /* Prototypes for functions that implement tasks. -----------*/\r
110 /*-----------------------------------------------------------*/\r
111 \r
112 /*\r
113  * Prototype for the reg test tasks.  Amongst other things, these fill the CPU\r
114  * registers with known values before checking that the registers still contain\r
115  * the expected values.  Each of the two tasks use different values so an error\r
116  * in the context switch mechanism can be caught.  Both reg test tasks execute\r
117  * at the idle priority so will get preempted regularly.  Each task repeatedly\r
118  * sends a message on a queue so long as it remains functioning correctly.  If\r
119  * an error is detected within the task the task is simply deleted.\r
120  */\r
121 static void prvRegTest1Task( void *pvParameters );\r
122 static void prvRegTest2Task( void *pvParameters );\r
123 \r
124 /*\r
125  * Prototype for the check task.  The check task demonstrates various features\r
126  * of the MPU before entering a loop where it waits for messages to arrive on a\r
127  * queue.\r
128  *\r
129  * Two types of messages can be processes:\r
130  *\r
131  * 1) "I'm Alive" messages sent from the reg test tasks, indicating that the\r
132  *    task is still operational.\r
133  *\r
134  * 2) "Print Status commands" sent periodically by the tick hook function (and\r
135  *    therefore from within an interrupt) which command the check task to write\r
136  *    either pass or fail to the terminal, depending on the status of the reg\r
137  *    test tasks.\r
138  */\r
139 static void prvCheckTask( void *pvParameters );\r
140 \r
141 /*\r
142  * Prototype for a task created in User mode using the original vTaskCreate()\r
143  * API function.  The task demonstrates the characteristics of such a task,\r
144  * before simply deleting itself.\r
145  */\r
146 static void prvOldStyleUserModeTask( void *pvParameters );\r
147 \r
148 /*\r
149  * Prototype for a task created in Privileged mode using the original\r
150  * vTaskCreate() API function.  The task demonstrates the characteristics of\r
151  * such a task, before simply deleting itself.\r
152  */\r
153 static void prvOldStylePrivilegedModeTask( void *pvParameters );\r
154 \r
155 \r
156 /*-----------------------------------------------------------*/\r
157 /* Prototypes for other misc functions.  --------------------*/\r
158 /*-----------------------------------------------------------*/\r
159 \r
160 /*\r
161  * Just configures any clocks and IO necessary.\r
162  */\r
163 static void prvSetupHardware( void );\r
164 \r
165 /*\r
166  * Simply deletes the calling task.  The function is provided only because it\r
167  * is simpler to call from asm code than the normal vTaskDelete() API function.\r
168  * It has the noinline attribute because it is called from asm code.\r
169  */\r
170 static void prvDeleteMe( void ) __attribute__((noinline));\r
171 \r
172 /*\r
173  * Used by both reg test tasks to send messages to the check task.  The message\r
174  * just lets the check task know that the task is still functioning correctly.\r
175  * If a reg test task detects an error it will delete itself, and in so doing\r
176  * prevent itself from sending any more 'I'm Alive' messages to the check task.\r
177  */\r
178 static void prvSendImAlive( xQueueHandle xHandle, unsigned long ulTaskNumber );\r
179 \r
180 /*\r
181  * The check task is created with access to three memory regions (plus its\r
182  * stack).  Each memory region is configured with different parameters and\r
183  * prvTestMemoryRegions() demonstrates what can and cannot be accessed for each\r
184  * region.  prvTestMemoryRegions() also demonstrates a task that was created\r
185  * as a privileged task settings its own privilege level down to that of a user\r
186  * task.\r
187  */\r
188 static void prvTestMemoryRegions( void );\r
189 \r
190 /*-----------------------------------------------------------*/\r
191 \r
192 /* The handle of the queue used to communicate between tasks and between tasks\r
193 and interrupts.  Note that this is a file scope variable that falls outside of\r
194 any MPU region.  As such other techniques have to be used to allow the tasks\r
195 to gain access to the queue.  See the comments in the tasks themselves for\r
196 further information. */\r
197 static xQueueHandle xFileScopeCheckQueue = NULL;\r
198 \r
199 \r
200 /*-----------------------------------------------------------*/\r
201 /* Data used by the 'check' task. ---------------------------*/\r
202 /*-----------------------------------------------------------*/\r
203 \r
204 /* Define the constants used to allocate the check task stack.  Note that the\r
205 stack size is defined in words, not bytes. */\r
206 #define mainCHECK_TASK_STACK_SIZE_WORDS 128\r
207 #define mainCHECK_TASK_STACK_ALIGNMENT ( mainCHECK_TASK_STACK_SIZE_WORDS * sizeof( portSTACK_TYPE ) )\r
208 \r
209 /* Declare the stack that will be used by the check task.  The kernel will\r
210  automatically create an MPU region for the stack.  The stack alignment must\r
211  match its size, so if 128 words are reserved for the stack then it must be\r
212  aligned to ( 128 * 4 ) bytes. */\r
213 static portSTACK_TYPE xCheckTaskStack[ mainCHECK_TASK_STACK_SIZE_WORDS ] mainALIGN_TO( mainCHECK_TASK_STACK_ALIGNMENT );\r
214 \r
215 /* Declare three arrays - an MPU region will be created for each array\r
216 using the xTaskParameters structure below.  THIS IS JUST TO DEMONSTRATE THE\r
217 MPU FUNCTIONALITY, the data is not used by the check tasks primary function\r
218 of monitoring the reg test tasks and printing out status information.\r
219 \r
220 Note that the arrays allocate slightly more RAM than is actually assigned to\r
221 the MPU region.  This is to permit writes off the end of the array to be\r
222 detected even when the arrays are placed in adjacent memory locations (with no\r
223 gaps between them).  The align size must be a power of two. */\r
224 #define mainREAD_WRITE_ARRAY_SIZE 130\r
225 #define mainREAD_WRITE_ALIGN_SIZE 128\r
226 char cReadWriteArray[ mainREAD_WRITE_ARRAY_SIZE ] mainALIGN_TO( mainREAD_WRITE_ALIGN_SIZE );\r
227 \r
228 #define mainREAD_ONLY_ARRAY_SIZE 260\r
229 #define mainREAD_ONLY_ALIGN_SIZE 256\r
230 char cReadOnlyArray[ mainREAD_ONLY_ARRAY_SIZE ] mainALIGN_TO( mainREAD_ONLY_ALIGN_SIZE );\r
231 \r
232 #define mainPRIVILEGED_ONLY_ACCESS_ARRAY_SIZE 130\r
233 #define mainPRIVILEGED_ONLY_ACCESS_ALIGN_SIZE 128\r
234 char cPrivilegedOnlyAccessArray[ mainPRIVILEGED_ONLY_ACCESS_ALIGN_SIZE ] mainALIGN_TO( mainPRIVILEGED_ONLY_ACCESS_ALIGN_SIZE );\r
235 \r
236 /* Fill in a xTaskParameters structure to define the check task - this is the\r
237 structure passed to the xTaskCreateRestricted() function. */\r
238 static const xTaskParameters xCheckTaskParameters =\r
239 {\r
240         prvCheckTask,                                                           /* pvTaskCode - the function that implements the task. */\r
241         ( signed char * ) "Check",                                      /* pcName                       */\r
242         mainCHECK_TASK_STACK_SIZE_WORDS,                        /* usStackDepth - defined in words, not bytes. */\r
243         ( void * ) 0x12121212,                                          /* pvParameters - this value is just to test that the parameter is being passed into the task correctly. */\r
244         ( tskIDLE_PRIORITY + 1 ) | portPRIVILEGE_BIT,/* uxPriority - this is the highest priority task in the system.  The task is created in privileged mode to demonstrate accessing the privileged only data. */\r
245         xCheckTaskStack,                                                        /* puxStackBuffer - the array to use as the task stack, as declared above. */\r
246 \r
247         /* xRegions - In this case the xRegions array is used to create MPU regions\r
248         for all three of the arrays declared directly above.  Each MPU region is\r
249         created with different parameters.  Again, THIS IS JUST TO DEMONSTRATE THE\r
250         MPU FUNCTIONALITY, the data is not used by the check tasks primary function\r
251         of monitoring the reg test tasks and printing out status information.*/\r
252         {\r
253                 /* Base address                                 Length                                                                  Parameters */\r
254         { cReadWriteArray,                              mainREAD_WRITE_ALIGN_SIZE,                              portMPU_REGION_READ_WRITE },\r
255         { cReadOnlyArray,                               mainREAD_ONLY_ALIGN_SIZE,                               portMPU_REGION_READ_ONLY },\r
256         { cPrivilegedOnlyAccessArray,   mainPRIVILEGED_ONLY_ACCESS_ALIGN_SIZE,  portMPU_REGION_PRIVILEGED_READ_WRITE }\r
257         }\r
258 };\r
259 \r
260 \r
261 \r
262 /*-----------------------------------------------------------*/\r
263 /* Data used by the 'reg test' tasks. -----------------------*/\r
264 /*-----------------------------------------------------------*/\r
265 \r
266 /* Define the constants used to allocate the reg test task stacks.  Note that\r
267 that stack size is defined in words, not bytes. */\r
268 #define mainREG_TEST_STACK_SIZE_WORDS   128\r
269 #define mainREG_TEST_STACK_ALIGNMENT    ( mainREG_TEST_STACK_SIZE_WORDS * sizeof( portSTACK_TYPE ) )\r
270 \r
271 /* Declare the stacks that will be used by the reg test tasks.  The kernel will\r
272 automatically create an MPU region for the stack.  The stack alignment must\r
273 match its size, so if 128 words are reserved for the stack then it must be\r
274 aligned to ( 128 * 4 ) bytes. */\r
275 static portSTACK_TYPE xRegTest1Stack[ mainREG_TEST_STACK_SIZE_WORDS ] mainALIGN_TO( mainREG_TEST_STACK_ALIGNMENT );\r
276 static portSTACK_TYPE xRegTest2Stack[ mainREG_TEST_STACK_SIZE_WORDS ] mainALIGN_TO( mainREG_TEST_STACK_ALIGNMENT );\r
277 \r
278 /* Fill in a xTaskParameters structure per reg test task to define the tasks. */\r
279 static const xTaskParameters xRegTest1Parameters =\r
280 {\r
281         prvRegTest1Task,                                                /* pvTaskCode - the function that implements the task. */\r
282         ( signed char * ) "RegTest1",                   /* pcName                       */\r
283         mainREG_TEST_STACK_SIZE_WORDS,                  /* usStackDepth         */\r
284         ( void * ) 0x12345678,                                  /* pvParameters - this value is just to test that the parameter is being passed into the task correctly. */\r
285         tskIDLE_PRIORITY | portPRIVILEGE_BIT,   /* uxPriority - note that this task is created with privileges to demonstrate one method of passing a queue handle into the task. */\r
286         xRegTest1Stack,                                                 /* puxStackBuffer - the array to use as the task stack, as declared above. */\r
287         {                                                                               /* xRegions - this task does not use any non-stack data hence all members are zero. */\r
288                 /* Base address         Length          Parameters */\r
289         { 0x00,                         0x00,                   0x00 },\r
290         { 0x00,                         0x00,                   0x00 },\r
291         { 0x00,                         0x00,                   0x00 }\r
292         }\r
293 };\r
294 /*-----------------------------------------------------------*/\r
295 \r
296 static xTaskParameters xRegTest2Parameters =\r
297 {\r
298         prvRegTest2Task,                                /* pvTaskCode - the function that implements the task. */\r
299         ( signed char * ) "RegTest2",   /* pcName                       */\r
300         mainREG_TEST_STACK_SIZE_WORDS,  /* usStackDepth         */\r
301         ( void * ) NULL,                                /* pvParameters - this task uses the parameter to pass in a queue handle, but the queue is not created yet. */\r
302         tskIDLE_PRIORITY,                               /* uxPriority           */\r
303         xRegTest2Stack,                                 /* puxStackBuffer - the array to use as the task stack, as declared above. */\r
304         {                                                               /* xRegions - this task does not use any non-stack data hence all members are zero. */\r
305                 /* Base address         Length          Parameters */\r
306         { 0x00,                         0x00,                   0x00 },\r
307         { 0x00,                         0x00,                   0x00 },\r
308         { 0x00,                         0x00,                   0x00 }\r
309         }\r
310 };\r
311 \r
312 /*-----------------------------------------------------------*/\r
313 \r
314 int main( void )\r
315 {\r
316         prvSetupHardware();\r
317 \r
318         /* Create the queue used to pass "I'm alive" messages to the check task. */\r
319         xFileScopeCheckQueue = xQueueCreate( 1, sizeof( unsigned long ) );\r
320 \r
321         /* One check task uses the task parameter to receive the queue handle.\r
322         This allows the file scope variable to be accessed from within the task.\r
323         The pvParameters member of xRegTest2Parameters can only be set after the\r
324         queue has been created so is set here. */\r
325         xRegTest2Parameters.pvParameters = xFileScopeCheckQueue;\r
326 \r
327         /* Create the three test tasks.  Handles to the created tasks are not\r
328         required, hence the second parameter is NULL. */\r
329         xTaskCreateRestricted( &xRegTest1Parameters, NULL );\r
330     xTaskCreateRestricted( &xRegTest2Parameters, NULL );\r
331         xTaskCreateRestricted( &xCheckTaskParameters, NULL );\r
332 \r
333         /* Create the tasks that are created using the original xTaskCreate() API\r
334         function. */\r
335         xTaskCreate(    prvOldStyleUserModeTask,        /* The function that implements the task. */\r
336                                         ( signed char * ) "Task1",      /* Text name for the task. */\r
337                                         100,                                            /* Stack depth in words. */\r
338                                         NULL,                                           /* Task parameters. */\r
339                                         3,                                                      /* Priority and mode (user in this case). */\r
340                                         NULL                                            /* Handle. */\r
341                                 );\r
342 \r
343         xTaskCreate(    prvOldStylePrivilegedModeTask,  /* The function that implements the task. */\r
344                                         ( signed char * ) "Task2",              /* Text name for the task. */\r
345                                         100,                                                    /* Stack depth in words. */\r
346                                         NULL,                                                   /* Task parameters. */\r
347                                         ( 3 | portPRIVILEGE_BIT ),              /* Priority and mode. */\r
348                                         NULL                                                    /* Handle. */\r
349                                 );\r
350 \r
351         /* Start the scheduler. */\r
352         vTaskStartScheduler();\r
353 \r
354         /* Will only get here if there was insufficient memory to create the idle\r
355         task. */\r
356         for( ;; );\r
357         return 0;\r
358 }\r
359 /*-----------------------------------------------------------*/\r
360 \r
361 static void prvCheckTask( void *pvParameters )\r
362 {\r
363 /* This task is created in privileged mode so can access the file scope\r
364 queue variable.  Take a stack copy of this before the task is set into user\r
365 mode.  Once that task is in user mode the file scope queue variable will no\r
366 longer be accessible but the stack copy will. */\r
367 xQueueHandle xQueue = xFileScopeCheckQueue;\r
368 long lMessage;\r
369 unsigned long ulStillAliveCounts[ 2 ] = { 0 };\r
370 const char *pcStatusMessage = "PASS\r\n";\r
371 \r
372 /* The debug_printf() function uses RAM that is outside of the control of the\r
373 application writer.  Therefore the application_defined_privileged_functions.h\r
374 header file is used to provide a version that executes with privileges. */\r
375 extern int MPU_debug_printf( const char *pcMessage );\r
376 \r
377         /* Just to remove compiler warning. */\r
378         ( void ) pvParameters;\r
379 \r
380         /* Demonstrate how the various memory regions can and can't be accessed.\r
381         The task privilege level is set down to user mode within this function. */\r
382         prvTestMemoryRegions();\r
383 \r
384         /* Tests are done so lower the privilege status. */\r
385         portSWITCH_TO_USER_MODE();\r
386 \r
387         /* This loop performs the main function of the task, which is blocking\r
388         on a message queue then processing each message as it arrives. */\r
389         for( ;; )\r
390         {\r
391                 /* Wait for the next message to arrive. */\r
392                 xQueueReceive( xQueue, &lMessage, portMAX_DELAY );\r
393 \r
394                 switch( lMessage )\r
395                 {\r
396                         case mainREG_TEST_1_STILL_EXECUTING     :\r
397                                         /* Message from task 1, so task 1 must still be executing. */\r
398                                         ( ulStillAliveCounts[ 0 ] )++;\r
399                                         break;\r
400 \r
401                         case mainREG_TEST_2_STILL_EXECUTING     :\r
402                                         /* Message from task 2, so task 2 must still be executing. */\r
403                                         ( ulStillAliveCounts[ 1 ] )++;\r
404                                         break;\r
405 \r
406                         case mainPRINT_SYSTEM_STATUS            :\r
407                                         /* Message from tick hook, time to print out the system\r
408                                         status.  If messages has stopped arriving from either reg\r
409                                         test task then the status must be set to fail. */\r
410                                         if( ( ulStillAliveCounts[ 0 ] == 0 ) || ( ulStillAliveCounts[ 1 ] == 0 )  )\r
411                                         {\r
412                                                 /* One or both of the test tasks are no longer sending\r
413                                                 'still alive' messages. */\r
414                                                 pcStatusMessage = "FAIL\r\n";\r
415                                         }\r
416 \r
417                                         /* Print a pass/fail message to the terminal.  This will be\r
418                                         visible in the CrossWorks IDE. */\r
419                                         MPU_debug_printf( pcStatusMessage );\r
420 \r
421                                         /* Reset the count of 'still alive' messages. */\r
422                                         memset( ulStillAliveCounts, 0x00, sizeof( ulStillAliveCounts ) );\r
423                                         break;\r
424 \r
425                 default :\r
426                                         /* Something unexpected happened.  Delete this task so the\r
427                                         error is apparent (no output will be displayed). */\r
428                                         prvDeleteMe();\r
429                                         break;\r
430                 }\r
431         }\r
432 }\r
433 /*-----------------------------------------------------------*/\r
434 \r
435 static void prvTestMemoryRegions( void )\r
436 {\r
437 long l;\r
438 char cTemp;\r
439 \r
440         /* The check task (from which this function is called) is created in the\r
441         Privileged mode.  The privileged array can be both read from and written\r
442         to while this task is privileged. */\r
443         cPrivilegedOnlyAccessArray[ 0 ] = 'a';\r
444         if( cPrivilegedOnlyAccessArray[ 0 ] != 'a' )\r
445         {\r
446                 /* Something unexpected happened.  Delete this task so the error is\r
447                 apparent (no output will be displayed). */\r
448                 prvDeleteMe();\r
449         }\r
450 \r
451         /* Writing off the end of the RAM allocated to this task will *NOT* cause a\r
452         protection fault because the task is still executing in a privileged mode.\r
453         Uncomment the following to test. */\r
454         /*cPrivilegedOnlyAccessArray[ mainPRIVILEGED_ONLY_ACCESS_ALIGN_SIZE ] = 'a';*/\r
455 \r
456         /* Now set the task into user mode. */\r
457         portSWITCH_TO_USER_MODE();\r
458 \r
459         /* Accessing the privileged only array will now cause a fault.  Uncomment\r
460         the following line to test. */\r
461         /*cPrivilegedOnlyAccessArray[ 0 ] = 'a';*/\r
462 \r
463         /* The read/write array can still be successfully read and written. */\r
464         for( l = 0; l < mainREAD_WRITE_ALIGN_SIZE; l++ )\r
465         {\r
466                 cReadWriteArray[ l ] = 'a';\r
467                 if( cReadWriteArray[ l ] != 'a' )\r
468                 {\r
469                         /* Something unexpected happened.  Delete this task so the error is\r
470                         apparent (no output will be displayed). */\r
471                         prvDeleteMe();\r
472                 }\r
473         }\r
474 \r
475         /* But attempting to read or write off the end of the RAM allocated to this\r
476         task will cause a fault.  Uncomment either of the following two lines to\r
477         test. */\r
478         /* cReadWriteArray[ 0 ] = cReadWriteArray[ -1 ]; */\r
479         /* cReadWriteArray[ mainREAD_WRITE_ALIGN_SIZE ] = 0x00; */\r
480 \r
481         /* The read only array can be successfully read... */\r
482         for( l = 0; l < mainREAD_ONLY_ALIGN_SIZE; l++ )\r
483         {\r
484                 cTemp = cReadOnlyArray[ l ];\r
485         }\r
486 \r
487         /* ...but cannot be written.  Uncomment the following line to test. */\r
488         /* cReadOnlyArray[ 0 ] = 'a'; */\r
489 \r
490         /* Writing to the first and last locations in the stack array should not\r
491         cause a protection fault.  Note that doing this will cause the kernel to\r
492         detect a stack overflow if configCHECK_FOR_STACK_OVERFLOW is greater than\r
493         1. */\r
494     xCheckTaskStack[ 0 ] = 0;\r
495     xCheckTaskStack[ mainCHECK_TASK_STACK_SIZE_WORDS - 1 ] = 0;\r
496 \r
497         /* Writing off either end of the stack array should cause a protection\r
498         fault, uncomment either of the following two lines to test. */\r
499         /* xCheckTaskStack[ -1 ] = 0; */\r
500     /* xCheckTaskStack[ mainCHECK_TASK_STACK_SIZE_WORDS ] = 0; */\r
501 \r
502         ( void ) cTemp;\r
503 }\r
504 /*-----------------------------------------------------------*/\r
505 \r
506 static void prvRegTest1Task( void *pvParameters )\r
507 {\r
508 /* This task is created in privileged mode so can access the file scope\r
509 queue variable.  Take a stack copy of this before the task is set into user\r
510 mode.  Once this task is in user mode the file scope queue variable will no\r
511 longer be accessible but the stack copy will. */\r
512 xQueueHandle xQueue = xFileScopeCheckQueue;\r
513 \r
514         /* Now the queue handle has been obtained the task can switch to user\r
515         mode.  This is just one method of passing a handle into a protected\r
516         task, the other reg test task uses the task parameter instead. */\r
517     portSWITCH_TO_USER_MODE();\r
518 \r
519         /* First check that the parameter value is as expected. */\r
520         if( pvParameters != ( void * ) 0x12345678 )\r
521         {\r
522                 /* Error detected.  Delete the task so it stops communicating with\r
523                 the check task. */\r
524                 prvDeleteMe();\r
525         }\r
526 \r
527 \r
528         for( ;; )\r
529         {\r
530                 /* This task tests the kernel context switch mechanism by reading and\r
531                 writing directly to registers - which requires the test to be written\r
532                 in assembly code. */\r
533                 __asm volatile\r
534                 (\r
535                         "               MOV     R4, #104                        \n" /* Set registers to a known value.  R0 to R1 are done in the loop below. */\r
536                         "               MOV     R5, #105                        \n"\r
537                         "               MOV     R6, #106                        \n"\r
538                         "               MOV     R8, #108                        \n"\r
539                         "               MOV     R9, #109                        \n"\r
540                         "               MOV     R10, #110                       \n"\r
541                         "               MOV     R11, #111                       \n"\r
542                         "reg1loop:                                              \n"\r
543                         "               MOV     R0, #100                        \n" /* Set the scratch registers to known values - done inside the loop as they get clobbered. */\r
544                         "               MOV     R1, #101                        \n"\r
545                         "               MOV     R2, #102                        \n"\r
546                         "               MOV R3, #103                    \n"\r
547                         "               MOV     R12, #112                       \n"\r
548                         "               SVC #1                                  \n" /* Yield just to increase test coverage. */\r
549                         "               CMP     R0, #100                        \n" /* Check all the registers still contain their expected values. */\r
550                         "               BNE     prvDeleteMe                     \n" /* Value was not as expected, delete the task so it stops communicating with the check task. */\r
551                         "               CMP     R1, #101                        \n"\r
552                         "               BNE     prvDeleteMe                     \n"\r
553                         "               CMP     R2, #102                        \n"\r
554                         "               BNE     prvDeleteMe                     \n"\r
555                         "               CMP R3, #103                    \n"\r
556                         "               BNE     prvDeleteMe                     \n"\r
557                         "               CMP     R4, #104                        \n"\r
558                         "               BNE     prvDeleteMe                     \n"\r
559                         "               CMP     R5, #105                        \n"\r
560                         "               BNE     prvDeleteMe                     \n"\r
561                         "               CMP     R6, #106                        \n"\r
562                         "               BNE     prvDeleteMe                     \n"\r
563                         "               CMP     R8, #108                        \n"\r
564                         "               BNE     prvDeleteMe                     \n"\r
565                         "               CMP     R9, #109                        \n"\r
566                         "               BNE     prvDeleteMe                     \n"\r
567                         "               CMP     R10, #110                       \n"\r
568                         "               BNE     prvDeleteMe                     \n"\r
569                         "               CMP     R11, #111                       \n"\r
570                         "               BNE     prvDeleteMe                     \n"\r
571                         "               CMP     R12, #112                       \n"\r
572                         "               BNE     prvDeleteMe                     \n"\r
573                         :::"r0", "r1", "r2", "r3", "r4", "r5", "r6", "r8", "r9", "r10", "r11", "r12"\r
574                 );\r
575 \r
576                 /* Send mainREG_TEST_1_STILL_EXECUTING to the check task to indicate that this\r
577                 task is still functioning. */\r
578                 prvSendImAlive( xQueue, mainREG_TEST_1_STILL_EXECUTING );\r
579 \r
580                 /* Go back to check all the register values again. */\r
581                 __asm volatile( "               B reg1loop      " );\r
582         }\r
583 }\r
584 /*-----------------------------------------------------------*/\r
585 \r
586 static void prvRegTest2Task( void *pvParameters )\r
587 {\r
588 /* The queue handle is passed in as the task parameter.  This is one method of\r
589 passing data into a protected task, the other reg test task uses a different\r
590 method. */\r
591 xQueueHandle xQueue = ( xQueueHandle ) pvParameters;\r
592 \r
593         for( ;; )\r
594         {\r
595                 /* This task tests the kernel context switch mechanism by reading and\r
596                 writing directly to registers - which requires the test to be written\r
597                 in assembly code. */\r
598                 __asm volatile\r
599                 (\r
600                         "               MOV     R4, #4                          \n" /* Set registers to a known value.  R0 to R1 are done in the loop below. */\r
601                         "               MOV     R5, #5                          \n"\r
602                         "               MOV     R6, #6                          \n"\r
603                         "               MOV     R8, #8                          \n" /* Frame pointer is omitted as it must not be changed. */\r
604                         "               MOV     R9, #9                          \n"\r
605                         "               MOV     R10, 10                         \n"\r
606                         "               MOV     R11, #11                        \n"\r
607                         "reg2loop:                                              \n"\r
608                         "               MOV     R0, #13                         \n" /* Set the scratch registers to known values - done inside the loop as they get clobbered. */\r
609                         "               MOV     R1, #1                          \n"\r
610                         "               MOV     R2, #2                          \n"\r
611                         "               MOV R3, #3                              \n"\r
612                         "               MOV     R12, #12                        \n"\r
613                         "               CMP     R0, #13                         \n" /* Check all the registers still contain their expected values. */\r
614                         "               BNE     prvDeleteMe                     \n" /* Value was not as expected, delete the task so it stops communicating with the check task */\r
615                         "               CMP     R1, #1                          \n"\r
616                         "               BNE     prvDeleteMe                     \n"\r
617                         "               CMP     R2, #2                          \n"\r
618                         "               BNE     prvDeleteMe                     \n"\r
619                         "               CMP R3, #3                              \n"\r
620                         "               BNE     prvDeleteMe                     \n"\r
621                         "               CMP     R4, #4                          \n"\r
622                         "               BNE     prvDeleteMe                     \n"\r
623                         "               CMP     R5, #5                          \n"\r
624                         "               BNE     prvDeleteMe                     \n"\r
625                         "               CMP     R6, #6                          \n"\r
626                         "               BNE     prvDeleteMe                     \n"\r
627                         "               CMP     R8, #8                          \n"\r
628                         "               BNE     prvDeleteMe                     \n"\r
629                         "               CMP     R9, #9                          \n"\r
630                         "               BNE     prvDeleteMe                     \n"\r
631                         "               CMP     R10, #10                        \n"\r
632                         "               BNE     prvDeleteMe                     \n"\r
633                         "               CMP     R11, #11                        \n"\r
634                         "               BNE     prvDeleteMe                     \n"\r
635                         "               CMP     R12, #12                        \n"\r
636                         "               BNE     prvDeleteMe                     \n"\r
637             :::"r0", "r1", "r2", "r3", "r4", "r5", "r6", "r8", "r9", "r10", "r11", "r12"\r
638                 );\r
639 \r
640                 /* Send mainREG_TEST_2_STILL_EXECUTING to the check task to indicate that this\r
641                 task is still functioning. */\r
642                 prvSendImAlive( xQueue, mainREG_TEST_2_STILL_EXECUTING );\r
643 \r
644                 /* Go back to check all the register values again. */\r
645                 __asm volatile( "               B reg2loop      " );\r
646         }\r
647 }\r
648 /*-----------------------------------------------------------*/\r
649 \r
650 void vApplicationIdleHook( void )\r
651 {\r
652 extern unsigned long __SRAM_segment_end__[];\r
653 extern unsigned long __privileged_data_start__[];\r
654 extern unsigned long __privileged_data_end__[];\r
655 extern unsigned long __FLASH_segment_start__[];\r
656 extern unsigned long __FLASH_segment_end__[];\r
657 volatile unsigned long *pul;\r
658 volatile unsigned long ulReadData;\r
659 \r
660         /* The idle task, and therefore this function, run in Supervisor mode and\r
661         can therefore access all memory.  Try reading from corners of flash and\r
662         RAM to ensure a memory fault does not occur.\r
663 \r
664         Start with the edges of the privileged data area. */\r
665         pul = __privileged_data_start__;\r
666         ulReadData = *pul;\r
667         pul = __privileged_data_end__ - 1;\r
668         ulReadData = *pul;\r
669 \r
670         /* Next the standard SRAM area. */\r
671         pul = __SRAM_segment_end__ - 1;\r
672         ulReadData = *pul;\r
673 \r
674         /* And the standard Flash area - the start of which is marked for\r
675         privileged access only. */\r
676         pul = __FLASH_segment_start__;\r
677         ulReadData = *pul;\r
678         pul = __FLASH_segment_end__ - 1;\r
679         ulReadData = *pul;\r
680 \r
681         /* Reading off the end of Flash or SRAM space should cause a fault.\r
682         Uncomment one of the following two pairs of lines to test. */\r
683 \r
684         /* pul = __FLASH_segment_end__ + 4;\r
685         ulReadData = *pul; */\r
686 \r
687         /* pul = __SRAM_segment_end__ + 1;\r
688         ulReadData = *pul; */\r
689 \r
690         ( void ) ulReadData;\r
691 }\r
692 /*-----------------------------------------------------------*/\r
693 \r
694 static void prvOldStyleUserModeTask( void *pvParameters )\r
695 {\r
696 extern unsigned long __privileged_data_start__[];\r
697 extern unsigned long __privileged_data_end__[];\r
698 extern unsigned long __SRAM_segment_end__[];\r
699 extern unsigned long __privileged_functions_end__[];\r
700 extern unsigned long __FLASH_segment_start__[];\r
701 extern unsigned long __FLASH_segment_end__[];\r
702 const volatile unsigned long *pulStandardPeripheralRegister = ( volatile unsigned long * ) 0x400FC0C4; /* PCONP */\r
703 volatile unsigned long *pul;\r
704 volatile unsigned long ulReadData;\r
705 \r
706 /* The following lines are commented out to prevent the unused variable\r
707 compiler warnings when the tests that use the variable are also commented out.\r
708 extern unsigned long __privileged_functions_start__[];\r
709 const volatile unsigned long *pulSystemPeripheralRegister = ( volatile unsigned long * ) 0xe000e014; */\r
710 \r
711         ( void ) pvParameters;\r
712 \r
713         /* This task is created in User mode using the original xTaskCreate() API\r
714         function.  It should have access to all Flash and RAM except that marked\r
715         as Privileged access only.  Reading from the start and end of the non-\r
716         privileged RAM should not cause a problem (the privileged RAM is the first\r
717         block at the bottom of the RAM memory). */\r
718         pul = __privileged_data_end__ + 1;\r
719         ulReadData = *pul;\r
720         pul = __SRAM_segment_end__ - 1;\r
721         ulReadData = *pul;\r
722 \r
723         /* Likewise reading from the start and end of the non-privileged Flash\r
724         should not be a problem (the privileged Flash is the first block at the\r
725         bottom of the Flash memory). */\r
726         pul = __privileged_functions_end__ + 1;\r
727         ulReadData = *pul;\r
728         pul = __FLASH_segment_end__ - 1;\r
729         ulReadData = *pul;\r
730 \r
731         /* Standard peripherals are accessible. */\r
732         ulReadData = *pulStandardPeripheralRegister;\r
733 \r
734         /* System peripherals are not accessible.  Uncomment the following line\r
735         to test.  Also uncomment the declaration of pulSystemPeripheralRegister\r
736         at the top of this function. */\r
737     /* ulReadData = *pulSystemPeripheralRegister; */\r
738 \r
739         /* Reading from anywhere inside the privileged Flash or RAM should cause a\r
740         fault.  This can be tested by uncommenting any of the following pairs of\r
741         lines.  Also uncomment the declaration of __privileged_functions_start__\r
742         at the top of this function. */\r
743 \r
744         /* pul = __privileged_functions_start__;\r
745         ulReadData = *pul; */\r
746 \r
747         /* pul = __privileged_functions_end__ - 1;\r
748         ulReadData = *pul; */\r
749 \r
750         /* pul = __privileged_data_start__;\r
751         ulReadData = *pul; */\r
752 \r
753         /* pul = __privileged_data_end__ - 1;\r
754         ulReadData = *pul; */\r
755 \r
756         /* Must not just run off the end of a task function, so delete this task.\r
757         Note that because this task was created using xTaskCreate() the stack was\r
758         allocated dynamically and I have not included any code to free it again. */\r
759         vTaskDelete( NULL );\r
760 \r
761         ( void ) ulReadData;\r
762 }\r
763 /*-----------------------------------------------------------*/\r
764 \r
765 static void prvOldStylePrivilegedModeTask( void *pvParameters )\r
766 {\r
767 extern unsigned long __privileged_data_start__[];\r
768 extern unsigned long __privileged_data_end__[];\r
769 extern unsigned long __SRAM_segment_end__[];\r
770 extern unsigned long __privileged_functions_start__[];\r
771 extern unsigned long __privileged_functions_end__[];\r
772 extern unsigned long __FLASH_segment_start__[];\r
773 extern unsigned long __FLASH_segment_end__[];\r
774 volatile unsigned long *pul;\r
775 volatile unsigned long ulReadData;\r
776 const volatile unsigned long *pulSystemPeripheralRegister = ( volatile unsigned long * ) 0xe000e014; /* Systick */\r
777 const volatile unsigned long *pulStandardPeripheralRegister = ( volatile unsigned long * ) 0x400FC0C4; /* PCONP */\r
778 \r
779         ( void ) pvParameters;\r
780 \r
781         /* This task is created in Privileged mode using the original xTaskCreate()\r
782         API     function.  It should have access to all Flash and RAM including that\r
783         marked as Privileged access only.  So reading from the start and end of the\r
784         non-privileged RAM should not cause a problem (the privileged RAM is the\r
785         first block at the bottom of the RAM memory). */\r
786         pul = __privileged_data_end__ + 1;\r
787         ulReadData = *pul;\r
788         pul = __SRAM_segment_end__ - 1;\r
789         ulReadData = *pul;\r
790 \r
791         /* Likewise reading from the start and end of the non-privileged Flash\r
792         should not be a problem (the privileged Flash is the first block at the\r
793         bottom of the Flash memory). */\r
794         pul = __privileged_functions_end__ + 1;\r
795         ulReadData = *pul;\r
796         pul = __FLASH_segment_end__ - 1;\r
797         ulReadData = *pul;\r
798 \r
799         /* Reading from anywhere inside the privileged Flash or RAM should also\r
800         not be a problem. */\r
801         pul = __privileged_functions_start__;\r
802         ulReadData = *pul;\r
803         pul = __privileged_functions_end__ - 1;\r
804         ulReadData = *pul;\r
805         pul = __privileged_data_start__;\r
806         ulReadData = *pul;\r
807         pul = __privileged_data_end__ - 1;\r
808         ulReadData = *pul;\r
809 \r
810         /* Finally, accessing both System and normal peripherals should both be\r
811         possible. */\r
812     ulReadData = *pulSystemPeripheralRegister;\r
813         ulReadData = *pulStandardPeripheralRegister;\r
814 \r
815         /* Must not just run off the end of a task function, so delete this task.\r
816         Note that because this task was created using xTaskCreate() the stack was\r
817         allocated dynamically and I have not included any code to free it again. */\r
818         vTaskDelete( NULL );\r
819 \r
820         ( void ) ulReadData;\r
821 }\r
822 /*-----------------------------------------------------------*/\r
823 \r
824 static void prvDeleteMe( void )\r
825 {\r
826         vTaskDelete( NULL );\r
827 }\r
828 /*-----------------------------------------------------------*/\r
829 \r
830 static void prvSendImAlive( xQueueHandle xHandle, unsigned long ulTaskNumber )\r
831 {\r
832         if( xHandle != NULL )\r
833         {\r
834                 xQueueSend( xHandle, &ulTaskNumber, mainDONT_BLOCK );\r
835         }\r
836 }\r
837 /*-----------------------------------------------------------*/\r
838 \r
839 static void prvSetupHardware( void )\r
840 {\r
841         /* If running on Rev A2 silicon, turn the LDO voltage up to 2.75V.  This is\r
842         a workaround to allow the PLL to operate reliably. */\r
843         if( DEVICE_IS_REVA2 )\r
844         {\r
845                 SysCtlLDOSet( SYSCTL_LDO_2_75V );\r
846         }\r
847 \r
848         /* Set the clocking to run from the PLL at 50 MHz */\r
849         SysCtlClockSet( SYSCTL_SYSDIV_4 | SYSCTL_USE_PLL | SYSCTL_OSC_MAIN | SYSCTL_XTAL_8MHZ );\r
850 }\r
851 /*-----------------------------------------------------------*/\r
852 \r
853 void vApplicationTickHook( void )\r
854 {\r
855 static unsigned long ulCallCount;\r
856 const unsigned long ulCallsBetweenSends = 5000 / portTICK_RATE_MS;\r
857 const unsigned long ulMessage = mainPRINT_SYSTEM_STATUS;\r
858 portBASE_TYPE xDummy;\r
859 \r
860         /* If configUSE_TICK_HOOK is set to 1 then this function will get called\r
861         from each RTOS tick.  It is called from the tick interrupt and therefore\r
862         will be executing in the privileged state. */\r
863 \r
864         ulCallCount++;\r
865 \r
866         /* Is it time to print out the pass/fail message again? */\r
867         if( ulCallCount >= ulCallsBetweenSends )\r
868         {\r
869                 ulCallCount = 0;\r
870 \r
871                 /* Send a message to the check task to command it to check that all\r
872                 the tasks are still running then print out the status.\r
873 \r
874                 This is running in an ISR so has to use the "FromISR" version of\r
875                 xQueueSend().  Because it is in an ISR it is running with privileges\r
876                 so can access xFileScopeCheckQueue directly. */\r
877                 xQueueSendFromISR( xFileScopeCheckQueue, &ulMessage, &xDummy );\r
878         }\r
879 }\r
880 /*-----------------------------------------------------------*/\r
881 \r
882 void vApplicationStackOverflowHook( xTaskHandle pxTask, signed char *pcTaskName )\r
883 {\r
884         /* If configCHECK_FOR_STACK_OVERFLOW is set to either 1 or 2 then this\r
885         function will automatically get called if a task overflows its stack. */\r
886         ( void ) pxTask;\r
887         ( void ) pcTaskName;\r
888         for( ;; );\r
889 }\r
890 /*-----------------------------------------------------------*/\r
891 \r
892 void vApplicationMallocFailedHook( void )\r
893 {\r
894         /* If configUSE_MALLOC_FAILED_HOOK is set to 1 then this function will\r
895         be called automatically if a call to pvPortMalloc() fails.  pvPortMalloc()\r
896         is called automatically when a task, queue or semaphore is created. */\r
897         for( ;; );\r
898 }\r
899 /*-----------------------------------------------------------*/\r
900 \r
901 /* Just to keep the linker happy. */\r
902 void __error__( char *pcFilename, unsigned long ulLine )\r
903 {\r
904         ( void ) pcFilename;\r
905         ( void ) ulLine;\r
906         for( ;; );\r
907 }\r
908 /*-----------------------------------------------------------*/\r
909 \r
910 /* Just to keep the linker happy. */\r
911 int uipprintf( const char *fmt, ... )\r
912 {\r
913         ( void ) fmt;\r
914         return( 0 );\r
915 }\r
916 /*-----------------------------------------------------------*/\r
917 \r
918 void hard_fault_handler(unsigned int * hardfault_args)\r
919 {\r
920 volatile unsigned int stacked_r0;\r
921 volatile unsigned int stacked_r1;\r
922 volatile unsigned int stacked_r2;\r
923 volatile unsigned int stacked_r3;\r
924 volatile unsigned int stacked_r12;\r
925 volatile unsigned int stacked_lr;\r
926 volatile unsigned int stacked_pc;\r
927 volatile unsigned int stacked_psr;\r
928 \r
929         stacked_r0 = ((unsigned long) hardfault_args[0]);\r
930         stacked_r1 = ((unsigned long) hardfault_args[1]);\r
931         stacked_r2 = ((unsigned long) hardfault_args[2]);\r
932         stacked_r3 = ((unsigned long) hardfault_args[3]);\r
933 \r
934         stacked_r12 = ((unsigned long) hardfault_args[4]);\r
935         stacked_lr = ((unsigned long) hardfault_args[5]);\r
936         stacked_pc = ((unsigned long) hardfault_args[6]);\r
937         stacked_psr = ((unsigned long) hardfault_args[7]);\r
938 \r
939         /* Inspect stacked_pc to locate the offending instruction. */\r
940         for( ;; );\r
941 \r
942         ( void ) stacked_psr;\r
943         ( void ) stacked_pc;\r
944         ( void ) stacked_lr;\r
945         ( void ) stacked_r12;\r
946     ( void ) stacked_r0;\r
947     ( void ) stacked_r1;\r
948     ( void ) stacked_r2;\r
949     ( void ) stacked_r3;\r
950 }\r
951 /*-----------------------------------------------------------*/\r
952 \r
953 void Fault_ISR( void ) __attribute__((naked));\r
954 void Fault_ISR( void )\r
955 {\r
956         __asm volatile\r
957         (\r
958                 " tst lr, #4                                                                            \n"\r
959                 " ite eq                                                                                        \n"\r
960                 " mrseq r0, msp                                                                         \n"\r
961                 " mrsne r0, psp                                                                         \n"\r
962                 " ldr r1, [r0, #24]                                                                     \n"\r
963                 " ldr r2, handler_address_const                                         \n"\r
964                 " bx r2                                                                                         \n"\r
965                 " handler_address_const: .word hard_fault_handler       \n"\r
966         );\r
967 }\r
968 /*-----------------------------------------------------------*/\r
969 \r
970 void MPU_Fault_ISR( void ) __attribute__((naked));\r
971 void MPU_Fault_ISR( void )\r
972 {\r
973         __asm volatile\r
974         (\r
975                 " tst lr, #4                                                                            \n"\r
976                 " ite eq                                                                                        \n"\r
977                 " mrseq r0, msp                                                                         \n"\r
978                 " mrsne r0, psp                                                                         \n"\r
979                 " ldr r1, [r0, #24]                                                                     \n"\r
980                 " ldr r2, handler_address_const                                         \n"\r
981                 " bx r2                                                                                         \n"\r
982                 " handler2_address_const: .word hard_fault_handler      \n"\r
983         );\r
984 }\r
985 /*-----------------------------------------------------------*/