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