]> git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_MPU_Simulator_Keil_GCC/main.c
Ensure both one-shot and auto-reload are written consistently with a hyphen in comments.
[freertos] / FreeRTOS / Demo / CORTEX_MPU_Simulator_Keil_GCC / main.c
1 /*\r
2  * FreeRTOS Kernel V10.2.1\r
3  * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
4  *\r
5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
6  * this software and associated documentation files (the "Software"), to deal in\r
7  * the Software without restriction, including without limitation the rights to\r
8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
10  * subject to the following conditions:\r
11  *\r
12  * The above copyright notice and this permission notice shall be included in all\r
13  * copies or substantial portions of the Software.\r
14  *\r
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
21  *\r
22  * http://www.FreeRTOS.org\r
23  * http://aws.amazon.com/freertos\r
24  *\r
25  * 1 tab == 4 spaces!\r
26  */\r
27 \r
28 \r
29 /*\r
30  * This file demonstrates the use of FreeRTOS-MPU.  It creates tasks in both\r
31  * User mode and Privileged mode, and using both the xTaskCreate() and\r
32  * xTaskCreateRestricted() API functions.  The purpose of each created task is\r
33  * documented in the comments above the task function prototype (in this file),\r
34  * with the task behaviour demonstrated and documented within the task function\r
35  * itself.\r
36  *\r
37  * In addition a queue is used to demonstrate passing data between\r
38  * protected/restricted tasks as well as passing data between an interrupt and\r
39  * a protected/restricted task.  A software timer is also used.\r
40  */\r
41 \r
42 /* Standard includes. */\r
43 #include "string.h"\r
44 \r
45 /* Scheduler includes. */\r
46 #include "FreeRTOS.h"\r
47 #include "task.h"\r
48 #include "queue.h"\r
49 #include "semphr.h"\r
50 #include "timers.h"\r
51 #include "event_groups.h"\r
52 #include "stream_buffer.h"\r
53 \r
54 /*-----------------------------------------------------------*/\r
55 \r
56 /* Misc constants. */\r
57 #define mainDONT_BLOCK                                  ( 0 )\r
58 \r
59 /* GCC specifics. */\r
60 #define mainALIGN_TO( x )                               __attribute__((aligned(x)))\r
61 \r
62 /* Hardware register addresses. */\r
63 #define mainVTOR                                                ( * ( volatile uint32_t * ) 0xE000ED08 )\r
64 \r
65 /* The period of the timer must be less than the rate at which\r
66 configPRINT_SYSTEM_STATUS messages are sent to the check task - otherwise the\r
67 check task will think the timer has stopped. */\r
68 #define mainTIMER_PERIOD                                pdMS_TO_TICKS( 200 )\r
69 \r
70 /* The name of the task that is deleted by the Idle task is used in a couple of\r
71 places, so is #defined. */\r
72 #define mainTASK_TO_DELETE_NAME                 "DeleteMe"\r
73 \r
74 /*-----------------------------------------------------------*/\r
75 /* Prototypes for functions that implement tasks. -----------*/\r
76 /*-----------------------------------------------------------*/\r
77 \r
78 /*\r
79  * NOTE:  The filling and checking of the registers in the following two tasks\r
80  *        is only actually performed when the GCC compiler is used.  Use of the\r
81  *        queue to communicate with the check task is done with all compilers.\r
82  *\r
83  * Prototype for the first two register test tasks, which execute in User mode.\r
84  * Amongst other things, these fill the CPU registers (other than the FPU\r
85  * registers) with known values before checking that the registers still contain\r
86  * the expected values.  Each of the two tasks use different values so an error\r
87  * in the context switch mechanism can be caught.  Both tasks execute at the\r
88  * idle priority so will get preempted regularly.  Each task repeatedly sends a\r
89  * message on a queue to a 'check' task so the check task knows the register\r
90  * check task is still executing and has not detected any errors.  If an error\r
91  * is detected within the task the task is simply deleted so it no longer sends\r
92  * messages.\r
93  *\r
94  * For demonstration and test purposes, both tasks obtain access to the queue\r
95  * handle in different ways; vRegTest1Implementation() is created in Privileged\r
96  * mode and copies the queue handle to its local stack before setting itself to\r
97  * User mode, and vRegTest2Implementation() receives the task handle using its\r
98  * parameter.\r
99  */\r
100 extern void vRegTest1Implementation( void *pvParameters );\r
101 extern void vRegTest2Implementation( void *pvParameters );\r
102 \r
103 /*\r
104  * The second two register test tasks are similar to the first two, but do test\r
105  * the floating point registers, execute in Privileged mode, and signal their\r
106  * execution status to the 'check' task by incrementing a loop counter on each\r
107  * iteration instead of sending a message on a queue.  The loop counters use a\r
108  * memory region to which the User mode 'check' task has read access.\r
109  *\r
110  * The functions ending 'Implementation' are called by the register check tasks.\r
111  */\r
112 static void prvRegTest3Task( void *pvParameters );\r
113 extern void vRegTest3Implementation( void );\r
114 static void prvRegTest4Task( void *pvParameters );\r
115 extern void vRegTest4Implementation( void );\r
116 \r
117 /*\r
118  * Prototype for the check task.  The check task demonstrates various features\r
119  * of the MPU before entering a loop where it waits for messages to arrive on a\r
120  * queue.\r
121  *\r
122  * Two types of messages can be processes:\r
123  *\r
124  * 1) "I'm Alive" messages sent from the first two register test tasks and a\r
125  *    software timer callback, as described above.\r
126  *\r
127  * 2) "Print Status commands" sent periodically by the tick hook function (and\r
128  *    therefore from within an interrupt) which commands the check task to write\r
129  *    either pass or fail to the terminal, depending on the status of the reg\r
130  *    test tasks (no write is performed in the simulator!).\r
131  */\r
132 static void prvCheckTask( void *pvParameters );\r
133 \r
134 /*\r
135  * Prototype for a task created in User mode using the original vTaskCreate()\r
136  * API function.  The task demonstrates the characteristics of such a task,\r
137  * before simply deleting itself.\r
138  */\r
139 static void prvOldStyleUserModeTask( void *pvParameters );\r
140 \r
141 /*\r
142  * Prototype for a task created in Privileged mode using the original\r
143  * vTaskCreate() API function.  The task demonstrates the characteristics of\r
144  * such a task, before simply deleting itself.\r
145  */\r
146 static void prvOldStylePrivilegedModeTask( void *pvParameters );\r
147 \r
148 /*\r
149  * A task that exercises the API of various RTOS objects before being deleted by\r
150  * the Idle task.  This is done for MPU API code coverage test purposes.\r
151  */\r
152 static void prvTaskToDelete( void *pvParameters );\r
153 \r
154 /*\r
155  * Functions called by prvTaskToDelete() to exercise the MPU API.\r
156  */\r
157 static void prvExerciseEventGroupAPI( void );\r
158 static void prvExerciseSemaphoreAPI( void );\r
159 static void prvExerciseTaskNotificationAPI( void );\r
160 static void prvExerciseStreamBufferAPI( void );\r
161 static void prvExerciseTimerAPI( void );\r
162 \r
163 /*\r
164  * Just configures any clocks and IO necessary.\r
165  */\r
166 static void prvSetupHardware( void );\r
167 \r
168 /*\r
169  * Simply deletes the calling task.  The function is provided only because it\r
170  * is simpler to call from asm code than the normal vTaskDelete() API function.\r
171  * It has the noinline attribute because it is called from asm code.\r
172  */\r
173 void vMainDeleteMe( void ) __attribute__((noinline));\r
174 \r
175 /*\r
176  * Used by the first two reg test tasks and a software timer callback function\r
177  * to send messages to the check task.  The message just lets the check task\r
178  * know that the tasks and timer are still functioning correctly.  If a reg test\r
179  * task detects an error it will delete itself, and in so doing prevent itself\r
180  * from sending any more 'I'm Alive' messages to the check task.\r
181  */\r
182 void vMainSendImAlive( QueueHandle_t xHandle, uint32_t ulTaskNumber );\r
183 \r
184 /*\r
185  * The check task is created with access to three memory regions (plus its\r
186  * stack).  Each memory region is configured with different parameters and\r
187  * prvTestMemoryRegions() demonstrates what can and cannot be accessed for each\r
188  * region.  prvTestMemoryRegions() also demonstrates a task that was created\r
189  * as a privileged task settings its own privilege level down to that of a user\r
190  * task.\r
191  */\r
192 static void prvTestMemoryRegions( void );\r
193 \r
194 /*\r
195  * Callback function used with the timer that uses the queue to send messages\r
196  * to the check task.\r
197  */\r
198 static void prvTimerCallback( TimerHandle_t xExpiredTimer );\r
199 \r
200 /*\r
201  * The callback function and a function that is pended used when exercising the\r
202  * timer API.\r
203  */\r
204 static void prvPendedFunctionCall( void *pvParameter1, uint32_t ulParameter2 );\r
205 static void prvTestTimerCallback( TimerHandle_t xTimer );\r
206 \r
207 /*-----------------------------------------------------------*/\r
208 \r
209 /* The handle of the queue used to communicate between tasks and between tasks\r
210 and interrupts.  Note that this is a global scope variable that falls outside of\r
211 any MPU region.  As such other techniques have to be used to allow the tasks\r
212 to gain access to the queue.  See the comments in the tasks themselves for\r
213 further information. */\r
214 QueueHandle_t xGlobalScopeCheckQueue = NULL;\r
215 \r
216 /* Holds the handle of a task that is deleted in the idle task hook - this is\r
217 done for code coverage test purposes only. */\r
218 static TaskHandle_t xTaskToDelete = NULL;\r
219 \r
220 /* The timer that periodically sends data to the check task on the queue. */\r
221 static TimerHandle_t xTimer = NULL;\r
222 \r
223 /* Just used to check start up code for initialised an uninitialised data. */\r
224 volatile uint32_t ul1 = 0x123, ul2 = 0;\r
225 \r
226 #if defined ( __GNUC__ )\r
227         /* Memory map read directl from linker variables. */\r
228         extern uint32_t __FLASH_segment_start__[];\r
229         extern uint32_t __FLASH_segment_end__[];\r
230         extern uint32_t __SRAM_segment_start__[];\r
231         extern uint32_t __SRAM_segment_end__[];\r
232         extern uint32_t __privileged_functions_start__[];\r
233         extern uint32_t __privileged_functions_end__[];\r
234         extern uint32_t __privileged_data_start__[];\r
235         extern uint32_t __privileged_data_end__[];\r
236         extern uint32_t __privileged_functions_actual_end__[];\r
237         extern uint32_t __privileged_data_actual_end__[];\r
238 #else\r
239         /* Must be set manually to match memory map. */\r
240         const uint32_t * __FLASH_segment_start__ = ( uint32_t * ) 0x00UL;\r
241         const uint32_t * __FLASH_segment_end__ = ( uint32_t * ) 0x00080000UL;\r
242         const uint32_t * __SRAM_segment_start__ = ( uint32_t * ) 0x20000000UL;\r
243         const uint32_t * __SRAM_segment_end__ = ( uint32_t * ) 0x20008000UL;\r
244         const uint32_t * __privileged_functions_start__ = ( uint32_t * ) 0x00UL;\r
245         const uint32_t * __privileged_functions_end__ = ( uint32_t * ) 0x8000UL;\r
246         const uint32_t * __privileged_data_start__ = ( uint32_t * ) 0x20000000UL;\r
247         const uint32_t * __privileged_data_end__ = ( uint32_t * ) 0x20000200UL;\r
248 #endif\r
249 /*-----------------------------------------------------------*/\r
250 /* Data used by the 'check' task. ---------------------------*/\r
251 /*-----------------------------------------------------------*/\r
252 \r
253 /* Define the constants used to allocate the check task stack.  Note that the\r
254 stack size is defined in words, not bytes. */\r
255 #define mainCHECK_TASK_STACK_SIZE_WORDS 128\r
256 #define mainCHECK_TASK_STACK_ALIGNMENT ( mainCHECK_TASK_STACK_SIZE_WORDS * sizeof( portSTACK_TYPE ) )\r
257 \r
258 /* Declare the stack that will be used by the check task.  The kernel will\r
259  automatically create an MPU region for the stack.  The stack alignment must\r
260  match its size, so if 128 words are reserved for the stack then it must be\r
261  aligned to ( 128 * 4 ) bytes. */\r
262 static portSTACK_TYPE xCheckTaskStack[ mainCHECK_TASK_STACK_SIZE_WORDS ] mainALIGN_TO( mainCHECK_TASK_STACK_ALIGNMENT );\r
263 \r
264 /* Declare three arrays - an MPU region will be created for each array\r
265 using the TaskParameters_t structure below.  THIS IS JUST TO DEMONSTRATE THE\r
266 MPU FUNCTIONALITY, the data is not used by the check tasks primary function\r
267 of monitoring the reg test tasks and printing out status information.\r
268 \r
269 Note that the arrays allocate slightly more RAM than is actually assigned to\r
270 the MPU region.  This is to permit writes off the end of the array to be\r
271 detected even when the arrays are placed in adjacent memory locations (with no\r
272 gaps between them).  The align size must be a power of two. */\r
273 #define mainREAD_WRITE_ARRAY_SIZE 130\r
274 #define mainREAD_WRITE_ALIGN_SIZE 128\r
275 char cReadWriteArray[ mainREAD_WRITE_ARRAY_SIZE ] mainALIGN_TO( mainREAD_WRITE_ALIGN_SIZE );\r
276 \r
277 #define mainREAD_ONLY_ARRAY_SIZE 260\r
278 #define mainREAD_ONLY_ALIGN_SIZE 256\r
279 char cReadOnlyArray[ mainREAD_ONLY_ARRAY_SIZE ] mainALIGN_TO( mainREAD_ONLY_ALIGN_SIZE );\r
280 \r
281 #define mainPRIVILEGED_ONLY_ACCESS_ARRAY_SIZE 130\r
282 #define mainPRIVILEGED_ONLY_ACCESS_ALIGN_SIZE 128\r
283 char cPrivilegedOnlyAccessArray[ mainPRIVILEGED_ONLY_ACCESS_ALIGN_SIZE ] mainALIGN_TO( mainPRIVILEGED_ONLY_ACCESS_ALIGN_SIZE );\r
284 \r
285 /* The following two variables are used to communicate the status of the second\r
286 two register check tasks (tasks 3 and 4) to the check task.  If the variables\r
287 keep incrementing, then the register check tasks have not discovered any errors.\r
288 If a variable stops incrementing, then an error has been found.  The variables\r
289 overlay the array that the check task has access to so they can be read by the\r
290 check task without causing a memory fault.  The check task has the highest\r
291 priority so will have finished with the array before the register test tasks\r
292 start to access it. */\r
293 volatile uint32_t *pulRegTest3LoopCounter = ( uint32_t * ) &( cReadWriteArray[ 0 ] ), *pulRegTest4LoopCounter = ( uint32_t * ) &( cReadWriteArray[ 4 ] );\r
294 \r
295 /* Fill in a TaskParameters_t structure to define the check task - this is the\r
296 structure passed to the xTaskCreateRestricted() function. */\r
297 static const TaskParameters_t xCheckTaskParameters =\r
298 {\r
299         prvCheckTask,                                                           /* pvTaskCode - the function that implements the task. */\r
300         "Check",                                                                        /* pcName */\r
301         mainCHECK_TASK_STACK_SIZE_WORDS,                        /* usStackDepth - defined in words, not bytes. */\r
302         ( void * ) 0x12121212,                                          /* pvParameters - this value is just to test that the parameter is being passed into the task correctly. */\r
303         ( 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
304         xCheckTaskStack,                                                        /* puxStackBuffer - the array to use as the task stack, as declared above. */\r
305 \r
306         /* xRegions - In this case the xRegions array is used to create MPU regions\r
307         for all three of the arrays declared directly above.  Each MPU region is\r
308         created with different parameters.  Again, THIS IS JUST TO DEMONSTRATE THE\r
309         MPU FUNCTIONALITY, the data is not used by the check tasks primary function\r
310         of monitoring the reg test tasks and printing out status information.*/\r
311         {\r
312                 /* Base address                                 Length                                                                  Parameters */\r
313                 { cReadWriteArray,                              mainREAD_WRITE_ALIGN_SIZE,                              portMPU_REGION_READ_WRITE },\r
314                 { cReadOnlyArray,                               mainREAD_ONLY_ALIGN_SIZE,                               portMPU_REGION_READ_ONLY },\r
315                 { cPrivilegedOnlyAccessArray,   mainPRIVILEGED_ONLY_ACCESS_ALIGN_SIZE,  portMPU_REGION_PRIVILEGED_READ_WRITE }\r
316         }\r
317 };\r
318 \r
319 \r
320 \r
321 /*-----------------------------------------------------------*/\r
322 /* Data used by the 'reg test' tasks. -----------------------*/\r
323 /*-----------------------------------------------------------*/\r
324 \r
325 /* Define the constants used to allocate the reg test task stacks.  Note that\r
326 that stack size is defined in words, not bytes. */\r
327 #define mainREG_TEST_STACK_SIZE_WORDS   128\r
328 #define mainREG_TEST_STACK_ALIGNMENT    ( mainREG_TEST_STACK_SIZE_WORDS * sizeof( portSTACK_TYPE ) )\r
329 \r
330 /* Declare the stacks that will be used by the reg test tasks.  The kernel will\r
331 automatically create an MPU region for the stack.  The stack alignment must\r
332 match its size, so if 128 words are reserved for the stack then it must be\r
333 aligned to ( 128 * 4 ) bytes. */\r
334 static portSTACK_TYPE xRegTest1Stack[ mainREG_TEST_STACK_SIZE_WORDS ] mainALIGN_TO( mainREG_TEST_STACK_ALIGNMENT );\r
335 static portSTACK_TYPE xRegTest2Stack[ mainREG_TEST_STACK_SIZE_WORDS ] mainALIGN_TO( mainREG_TEST_STACK_ALIGNMENT );\r
336 \r
337 /* Fill in a TaskParameters_t structure per reg test task to define the tasks. */\r
338 static const TaskParameters_t xRegTest1Parameters =\r
339 {\r
340         vRegTest1Implementation,                                                        /* pvTaskCode - the function that implements the task. */\r
341         "RegTest1",                                                                     /* pcName                       */\r
342         mainREG_TEST_STACK_SIZE_WORDS,                          /* usStackDepth         */\r
343         ( void * ) configREG_TEST_TASK_1_PARAMETER,     /* pvParameters - this value is just to test that the parameter is being passed into the task correctly. */\r
344         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
345         xRegTest1Stack,                                                         /* puxStackBuffer - the array to use as the task stack, as declared above. */\r
346         {                                                                                       /* xRegions - this task does not use any non-stack data hence all members are zero. */\r
347                 /* Base address         Length          Parameters */\r
348                 { 0x00,                         0x00,                   0x00 },\r
349                 { 0x00,                         0x00,                   0x00 },\r
350                 { 0x00,                         0x00,                   0x00 }\r
351         }\r
352 };\r
353 /*-----------------------------------------------------------*/\r
354 \r
355 static TaskParameters_t xRegTest2Parameters =\r
356 {\r
357         vRegTest2Implementation,                                /* pvTaskCode - the function that implements the task. */\r
358         "RegTest2",                                             /* pcName                       */\r
359         mainREG_TEST_STACK_SIZE_WORDS,  /* usStackDepth         */\r
360         ( void * ) NULL,                                /* pvParameters - this task uses the parameter to pass in a queue handle, but the queue is not created yet. */\r
361         tskIDLE_PRIORITY,                               /* uxPriority           */\r
362         xRegTest2Stack,                                 /* puxStackBuffer - the array to use as the task stack, as declared above. */\r
363         {                                                               /* xRegions - this task does not use any non-stack data hence all members are zero. */\r
364                 /* Base address         Length          Parameters */\r
365                 { 0x00,                         0x00,                   0x00 },\r
366                 { 0x00,                         0x00,                   0x00 },\r
367                 { 0x00,                         0x00,                   0x00 }\r
368         }\r
369 };\r
370 \r
371 /*-----------------------------------------------------------*/\r
372 /* Configures the task that is deleted. ---------------------*/\r
373 /*-----------------------------------------------------------*/\r
374 \r
375 /* Define the constants used to allocate the stack of the task that is\r
376 deleted.  Note that that stack size is defined in words, not bytes. */\r
377 #define mainDELETE_TASK_STACK_SIZE_WORDS        128\r
378 #define mainTASK_TO_DELETE_STACK_ALIGNMENT      ( mainDELETE_TASK_STACK_SIZE_WORDS * sizeof( portSTACK_TYPE ) )\r
379 \r
380 /* Declare the stack that will be used by the task that gets deleted.  The\r
381 kernel will automatically create an MPU region for the stack.  The stack\r
382 alignment must match its size, so if 128 words are reserved for the stack\r
383 then it must be aligned to ( 128 * 4 ) bytes. */\r
384 static portSTACK_TYPE xDeleteTaskStack[ mainDELETE_TASK_STACK_SIZE_WORDS ] mainALIGN_TO( mainTASK_TO_DELETE_STACK_ALIGNMENT );\r
385 \r
386 static TaskParameters_t xTaskToDeleteParameters =\r
387 {\r
388         prvTaskToDelete,                                        /* pvTaskCode - the function that implements the task. */\r
389         mainTASK_TO_DELETE_NAME,                        /* pcName */\r
390         mainDELETE_TASK_STACK_SIZE_WORDS,       /* usStackDepth */\r
391         ( void * ) NULL,                                        /* pvParameters - this task uses the parameter to pass in a queue handle, but the queue is not created yet. */\r
392         tskIDLE_PRIORITY + 1,                           /* uxPriority */\r
393         xDeleteTaskStack,                                       /* puxStackBuffer - the array to use as the task stack, as declared above. */\r
394         {                                                                       /* xRegions - this task does not use any non-stack data hence all members are zero. */\r
395                 /* Base address         Length          Parameters */\r
396                 { 0x00,                         0x00,                   0x00 },\r
397                 { 0x00,                         0x00,                   0x00 },\r
398                 { 0x00,                         0x00,                   0x00 }\r
399         }\r
400 };\r
401 \r
402 /*-----------------------------------------------------------*/\r
403 \r
404 int main( void )\r
405 {\r
406         /* Used to check linker configuration. */\r
407         configASSERT( ul1 == 0x123 );\r
408         configASSERT( ul2 == 0 );\r
409         prvSetupHardware();\r
410 \r
411         /* Create the queue used to pass "I'm alive" messages to the check task. */\r
412         xGlobalScopeCheckQueue = xQueueCreate( 1, sizeof( uint32_t ) );\r
413 \r
414         /* One check task uses the task parameter to receive the queue handle.\r
415         This allows the file scope variable to be accessed from within the task.\r
416         The pvParameters member of xRegTest2Parameters can only be set after the\r
417         queue has been created so is set here. */\r
418         xRegTest2Parameters.pvParameters = xGlobalScopeCheckQueue;\r
419 \r
420         /* Create three test tasks.  Handles to the created tasks are not required,\r
421         hence the second parameter is NULL. */\r
422         xTaskCreateRestricted( &xRegTest1Parameters, NULL );\r
423     xTaskCreateRestricted( &xRegTest2Parameters, NULL );\r
424         xTaskCreateRestricted( &xCheckTaskParameters, NULL );\r
425 \r
426         /* Create a task that does nothing but ensure some of the MPU API functions\r
427         can be called correctly, then get deleted.  This is done for code coverage\r
428         test purposes only.  The task's handle is saved in xTaskToDelete so it can\r
429         get deleted in the idle task hook. */\r
430         xTaskCreateRestricted( &xTaskToDeleteParameters, &xTaskToDelete );\r
431 \r
432         /* Create the tasks that are created using the original xTaskCreate() API\r
433         function. */\r
434         xTaskCreate(    prvOldStyleUserModeTask,        /* The function that implements the task. */\r
435                                         "Task1",                                        /* Text name for the task. */\r
436                                         100,                                            /* Stack depth in words. */\r
437                                         NULL,                                           /* Task parameters. */\r
438                                         3,                                                      /* Priority and mode (user in this case). */\r
439                                         NULL                                            /* Handle. */\r
440                                 );\r
441 \r
442         xTaskCreate(    prvOldStylePrivilegedModeTask,  /* The function that implements the task. */\r
443                                         "Task2",                                                /* Text name for the task. */\r
444                                         100,                                                    /* Stack depth in words. */\r
445                                         NULL,                                                   /* Task parameters. */\r
446                                         ( 3 | portPRIVILEGE_BIT ),              /* Priority and mode. */\r
447                                         NULL                                                    /* Handle. */\r
448                                 );\r
449 \r
450         /* Create the third and fourth register check tasks, as described at the top\r
451         of this file. */\r
452         xTaskCreate( prvRegTest3Task, "Reg3", configMINIMAL_STACK_SIZE, configREG_TEST_TASK_3_PARAMETER, tskIDLE_PRIORITY, NULL );\r
453         xTaskCreate( prvRegTest4Task, "Reg4", configMINIMAL_STACK_SIZE, configREG_TEST_TASK_4_PARAMETER, tskIDLE_PRIORITY, NULL );\r
454 \r
455         /* Create and start the software timer. */\r
456         xTimer = xTimerCreate( "Timer",                         /* Test name for the timer. */\r
457                                                         mainTIMER_PERIOD,       /* Period of the timer. */\r
458                                                         pdTRUE,                         /* The timer will auto-reload itself. */\r
459                                                         ( void * ) 0,           /* The timer's ID is used to count the number of times it expires - initialise this to 0. */\r
460                                                         prvTimerCallback );     /* The function called when the timer expires. */\r
461         configASSERT( xTimer );\r
462         xTimerStart( xTimer, mainDONT_BLOCK );\r
463 \r
464         /* Start the scheduler. */\r
465         vTaskStartScheduler();\r
466 \r
467         /* Will only get here if there was insufficient memory to create the idle\r
468         task. */\r
469         for( ;; );\r
470 }\r
471 /*-----------------------------------------------------------*/\r
472 \r
473 static void prvCheckTask( void *pvParameters )\r
474 {\r
475 /* This task is created in privileged mode so can access the file scope\r
476 queue variable.  Take a stack copy of this before the task is set into user\r
477 mode.  Once that task is in user mode the file scope queue variable will no\r
478 longer be accessible but the stack copy will. */\r
479 QueueHandle_t xQueue = xGlobalScopeCheckQueue;\r
480 int32_t lMessage;\r
481 uint32_t ulStillAliveCounts[ 3 ] = { 0 };\r
482 const char *pcStatusMessage = "PASS\r\n";\r
483 uint32_t ulLastRegTest3CountValue = 0, ulLastRegTest4Value = 0;\r
484 \r
485 /* The register test tasks that also test the floating point registers increment\r
486 a counter on each iteration of their loop.  The counters are inside the array\r
487 that this task has access to. */\r
488 volatile uint32_t *pulOverlaidCounter3 = ( uint32_t * ) &( cReadWriteArray[ 0 ] ), *pulOverlaidCounter4 = ( uint32_t * ) &( cReadWriteArray[ 4 ] );\r
489 \r
490 /* ulCycleCount is incremented on each cycle of the check task.  It can be\r
491 viewed updating in the Keil watch window as the simulator does not print to\r
492 the ITM port. */\r
493 volatile uint32_t ulCycleCount = 0;\r
494 \r
495         /* Just to remove compiler warning. */\r
496         ( void ) pvParameters;\r
497 \r
498         /* Demonstrate how the various memory regions can and can't be accessed.\r
499         The task privilege level is set down to user mode within this function. */\r
500         prvTestMemoryRegions();\r
501 \r
502         /* Clear overlaid reg test counters before entering the loop below. */\r
503         *pulOverlaidCounter3 = 0UL;\r
504         *pulOverlaidCounter4 = 0UL;\r
505 \r
506         /* This loop performs the main function of the task, which is blocking\r
507         on a message queue then processing each message as it arrives. */\r
508         for( ;; )\r
509         {\r
510                 /* Wait for the next message to arrive. */\r
511                 xQueueReceive( xQueue, &lMessage, portMAX_DELAY );\r
512 \r
513                 switch( lMessage )\r
514                 {\r
515                         case configREG_TEST_1_STILL_EXECUTING   :\r
516                         case configREG_TEST_2_STILL_EXECUTING   :\r
517                         case configTIMER_STILL_EXECUTING                :\r
518                                         /* Message from the first or second register check task, or\r
519                                         the timer callback function.  Increment the count of the\r
520                                         number of times the message source has sent the message as\r
521                                         the message source must still be executed. */\r
522                                         ( ulStillAliveCounts[ lMessage ] )++;\r
523                                         break;\r
524 \r
525                         case configPRINT_SYSTEM_STATUS          :\r
526                                         /* Message from tick hook, time to print out the system\r
527                                         status.  If messages have stopped arriving from either of\r
528                                         the first two reg test task or the timer callback then the\r
529                                         status must be set to fail. */\r
530                                         if( ( ulStillAliveCounts[ 0 ] == 0 ) || ( ulStillAliveCounts[ 1 ] == 0 ) || ( ulStillAliveCounts[ 2 ] == 0 ) )\r
531                                         {\r
532                                                 /* One or both of the test tasks are no longer sending\r
533                                                 'still alive' messages. */\r
534                                                 pcStatusMessage = "FAIL\r\n";\r
535                                         }\r
536                                         else\r
537                                         {\r
538                                                 /* Reset the count of 'still alive' messages. */\r
539                                                 memset( ( void * ) ulStillAliveCounts, 0x00, sizeof( ulStillAliveCounts ) );\r
540                                         }\r
541 \r
542                                         /* Check that the register test 3 task is still incrementing\r
543                                         its counter, and therefore still running. */\r
544                                         if( ulLastRegTest3CountValue == *pulOverlaidCounter3 )\r
545                                         {\r
546                                                 pcStatusMessage = "FAIL\r\n";\r
547                                         }\r
548                                         ulLastRegTest3CountValue = *pulOverlaidCounter3;\r
549 \r
550                                         /* Check that the register test 4 task is still incrementing\r
551                                         its counter, and therefore still running. */\r
552                                         if( ulLastRegTest4Value == *pulOverlaidCounter4 )\r
553                                         {\r
554                                                 pcStatusMessage = "FAIL\r\n";\r
555                                         }\r
556                                         ulLastRegTest4Value = *pulOverlaidCounter4;\r
557 \r
558                                         /**** Print pcStatusMessage here. ****/\r
559                                         ( void ) pcStatusMessage;\r
560 \r
561                                         /* The cycle count can be viewed updating in the Keil watch\r
562                                         window if ITM printf is not being used. */\r
563                                         ulCycleCount++;\r
564                                         break;\r
565 \r
566                 default :\r
567                                         /* Something unexpected happened.  Delete this task so the\r
568                                         error is apparent (no output will be displayed). */\r
569                                         vMainDeleteMe();\r
570                                         break;\r
571                 }\r
572         }\r
573 }\r
574 /*-----------------------------------------------------------*/\r
575 \r
576 static void prvTestMemoryRegions( void )\r
577 {\r
578 int32_t x;\r
579 char cTemp;\r
580 \r
581         /* The check task (from which this function is called) is created in the\r
582         Privileged mode.  The privileged array can be both read from and written\r
583         to while this task is privileged. */\r
584         cPrivilegedOnlyAccessArray[ 0 ] = 'a';\r
585         if( cPrivilegedOnlyAccessArray[ 0 ] != 'a' )\r
586         {\r
587                 /* Something unexpected happened.  Delete this task so the error is\r
588                 apparent (no output will be displayed). */\r
589                 vMainDeleteMe();\r
590         }\r
591 \r
592         /* Writing off the end of the RAM allocated to this task will *NOT* cause a\r
593         protection fault because the task is still executing in a privileged mode.\r
594         Uncomment the following to test. */\r
595         /*cPrivilegedOnlyAccessArray[ mainPRIVILEGED_ONLY_ACCESS_ALIGN_SIZE ] = 'a';*/\r
596 \r
597         /* Now set the task into user mode. */\r
598         portSWITCH_TO_USER_MODE();\r
599 \r
600         /* Accessing the privileged only array will now cause a fault.  Uncomment\r
601         the following line to test. */\r
602         /*cPrivilegedOnlyAccessArray[ 0 ] = 'a';*/\r
603 \r
604         /* The read/write array can still be successfully read and written. */\r
605         for( x = 0; x < mainREAD_WRITE_ALIGN_SIZE; x++ )\r
606         {\r
607                 cReadWriteArray[ x ] = 'a';\r
608                 if( cReadWriteArray[ x ] != 'a' )\r
609                 {\r
610                         /* Something unexpected happened.  Delete this task so the error is\r
611                         apparent (no output will be displayed). */\r
612                         vMainDeleteMe();\r
613                 }\r
614         }\r
615 \r
616         /* But attempting to read or write off the end of the RAM allocated to this\r
617         task will cause a fault.  Uncomment either of the following two lines to\r
618         test. */\r
619         /* cReadWriteArray[ 0 ] = cReadWriteArray[ -1 ]; */\r
620         /* cReadWriteArray[ mainREAD_WRITE_ALIGN_SIZE ] = 0x00; */\r
621 \r
622         /* The read only array can be successfully read... */\r
623         for( x = 0; x < mainREAD_ONLY_ALIGN_SIZE; x++ )\r
624         {\r
625                 cTemp = cReadOnlyArray[ x ];\r
626         }\r
627 \r
628         /* ...but cannot be written.  Uncomment the following line to test. */\r
629         /* cReadOnlyArray[ 0 ] = 'a'; */\r
630 \r
631         /* Writing to the first and last locations in the stack array should not\r
632         cause a protection fault.  Note that doing this will cause the kernel to\r
633         detect a stack overflow if configCHECK_FOR_STACK_OVERFLOW is greater than\r
634         1, hence the test is commented out by default. */\r
635         /* xCheckTaskStack[ 0 ] = 0;\r
636         xCheckTaskStack[ mainCHECK_TASK_STACK_SIZE_WORDS - 1 ] = 0; */\r
637 \r
638         /* Writing off either end of the stack array should cause a protection\r
639         fault, uncomment either of the following two lines to test. */\r
640         /* xCheckTaskStack[ -1 ] = 0; */\r
641         /* xCheckTaskStack[ mainCHECK_TASK_STACK_SIZE_WORDS ] = 0; */\r
642 \r
643         ( void ) cTemp;\r
644 }\r
645 /*-----------------------------------------------------------*/\r
646 \r
647 static void prvExerciseEventGroupAPI( void )\r
648 {\r
649 EventGroupHandle_t xEventGroup;\r
650 EventBits_t xBits;\r
651 const EventBits_t xBitsToWaitFor = ( EventBits_t ) 0xff, xBitToClear = ( EventBits_t ) 0x01;\r
652 \r
653         /* Exercise some event group functions. */\r
654         xEventGroup = xEventGroupCreate();\r
655         configASSERT( xEventGroup );\r
656 \r
657         /* No bits should be set. */\r
658         xBits = xEventGroupWaitBits( xEventGroup, xBitsToWaitFor, pdTRUE, pdFALSE, mainDONT_BLOCK );\r
659         configASSERT( xBits == ( EventBits_t ) 0 );\r
660 \r
661         /* Set bits and read back to ensure the bits were set. */\r
662         xEventGroupSetBits( xEventGroup, xBitsToWaitFor );\r
663         xBits = xEventGroupGetBits( xEventGroup );\r
664         configASSERT( xBits == xBitsToWaitFor );\r
665 \r
666         /* Clear a bit and read back again using a different API function. */\r
667         xEventGroupClearBits( xEventGroup, xBitToClear );\r
668         xBits = xEventGroupSync( xEventGroup, 0x00, xBitsToWaitFor, mainDONT_BLOCK );\r
669         configASSERT( xBits == ( xBitsToWaitFor & ~xBitToClear ) );\r
670 \r
671         /* Finished with the event group. */\r
672         vEventGroupDelete( xEventGroup );\r
673 }\r
674 /*-----------------------------------------------------------*/\r
675 \r
676 static void prvExerciseSemaphoreAPI( void )\r
677 {\r
678 SemaphoreHandle_t xSemaphore;\r
679 const UBaseType_t uxMaxCount = 5, uxInitialCount = 0;\r
680 \r
681         /* Most of the semaphore API is common to the queue API and is already being\r
682         used.  This function uses a few semaphore functions that are unique to the\r
683         RTOS objects, rather than generic and used by queues also.\r
684 \r
685         First create and use a counting semaphore. */\r
686         xSemaphore = xSemaphoreCreateCounting( uxMaxCount, uxInitialCount );\r
687         configASSERT( xSemaphore );\r
688 \r
689         /* Give the semaphore a couple of times and ensure the count is returned\r
690         correctly. */\r
691         xSemaphoreGive( xSemaphore );\r
692         xSemaphoreGive( xSemaphore );\r
693         configASSERT( uxSemaphoreGetCount( xSemaphore ) == 2 );\r
694         vSemaphoreDelete( xSemaphore );\r
695 \r
696         /* Create a recursive mutex, and ensure the mutex holder and count are\r
697         returned returned correctly. */\r
698         xSemaphore = xSemaphoreCreateRecursiveMutex();\r
699         configASSERT( uxSemaphoreGetCount( xSemaphore ) == 1 );\r
700         configASSERT( xSemaphore );\r
701         xSemaphoreTakeRecursive( xSemaphore, mainDONT_BLOCK );\r
702         xSemaphoreTakeRecursive( xSemaphore, mainDONT_BLOCK );\r
703         configASSERT( xSemaphoreGetMutexHolder( xSemaphore ) == xTaskGetCurrentTaskHandle() );\r
704         configASSERT( xSemaphoreGetMutexHolder( xSemaphore ) == xTaskGetHandle( mainTASK_TO_DELETE_NAME ) );\r
705         xSemaphoreGiveRecursive( xSemaphore );\r
706         configASSERT( uxSemaphoreGetCount( xSemaphore ) == 0 );\r
707         xSemaphoreGiveRecursive( xSemaphore );\r
708         configASSERT( uxSemaphoreGetCount( xSemaphore ) == 1 );\r
709         configASSERT( xSemaphoreGetMutexHolder( xSemaphore ) == NULL );\r
710         vSemaphoreDelete( xSemaphore );\r
711 \r
712         /* Create a normal mutex, and sure the mutex holder and count are returned\r
713         returned correctly. */\r
714         xSemaphore = xSemaphoreCreateMutex();\r
715         configASSERT( xSemaphore );\r
716         xSemaphoreTake( xSemaphore, mainDONT_BLOCK );\r
717         xSemaphoreTake( xSemaphore, mainDONT_BLOCK );\r
718         configASSERT( uxSemaphoreGetCount( xSemaphore ) == 0 ); /* Not recursive so can only be 1. */\r
719         configASSERT( xSemaphoreGetMutexHolder( xSemaphore ) == xTaskGetCurrentTaskHandle() );\r
720         xSemaphoreGive( xSemaphore );\r
721         configASSERT( uxSemaphoreGetCount( xSemaphore ) == 1 );\r
722         configASSERT( xSemaphoreGetMutexHolder( xSemaphore ) == NULL );\r
723         vSemaphoreDelete( xSemaphore );\r
724 }\r
725 /*-----------------------------------------------------------*/\r
726 \r
727 static void prvExerciseTaskNotificationAPI( void )\r
728 {\r
729 uint32_t ulNotificationValue;\r
730 BaseType_t xReturned;\r
731 \r
732         /* The task should not yet have a notification pending. */\r
733         xReturned = xTaskNotifyWait( 0, 0, &ulNotificationValue, mainDONT_BLOCK );\r
734         configASSERT( xReturned == pdFAIL );\r
735         configASSERT( ulNotificationValue == 0UL );\r
736 \r
737         /* Exercise the 'give' and 'take' versions of the notification API. */\r
738         xTaskNotifyGive( xTaskGetCurrentTaskHandle() );\r
739         xTaskNotifyGive( xTaskGetCurrentTaskHandle() );\r
740         ulNotificationValue = ulTaskNotifyTake( pdTRUE, mainDONT_BLOCK );\r
741         configASSERT( ulNotificationValue == 2 );\r
742 \r
743         /* Exercise the 'notify' and 'clear' API. */\r
744         ulNotificationValue = 20;\r
745         xTaskNotify( xTaskGetCurrentTaskHandle(), ulNotificationValue, eSetValueWithOverwrite );\r
746         ulNotificationValue = 0;\r
747         xReturned = xTaskNotifyWait( 0, 0, &ulNotificationValue, mainDONT_BLOCK );\r
748         configASSERT( xReturned == pdPASS );\r
749         configASSERT( ulNotificationValue == 20 );\r
750         xTaskNotify( xTaskGetCurrentTaskHandle(), ulNotificationValue, eSetValueWithOverwrite );\r
751         xReturned = xTaskNotifyStateClear( NULL );\r
752         configASSERT( xReturned == pdTRUE ); /* First time a notification was pending. */\r
753         xReturned = xTaskNotifyStateClear( NULL );\r
754         configASSERT( xReturned == pdFALSE ); /* Second time the notification was already clear. */\r
755 }\r
756 /*-----------------------------------------------------------*/\r
757 \r
758 static void prvTaskToDelete( void *pvParameters )\r
759 {\r
760         /* Remove compiler warnings about unused parameters. */\r
761         ( void ) pvParameters;\r
762 \r
763         /* Check the enter and exit critical macros are working correctly.  If the\r
764         SVC priority is below configMAX_SYSCALL_INTERRUPT_PRIORITY then this will\r
765         fault. */\r
766         taskENTER_CRITICAL();\r
767         taskEXIT_CRITICAL();\r
768 \r
769         /* Exercise the API of various RTOS objects. */\r
770         prvExerciseEventGroupAPI();\r
771         prvExerciseSemaphoreAPI();\r
772         prvExerciseTaskNotificationAPI();\r
773         prvExerciseStreamBufferAPI();\r
774         prvExerciseTimerAPI();\r
775 \r
776         /* For code coverage test purposes it is deleted by the Idle task. */\r
777         configASSERT( uxTaskGetStackHighWaterMark( NULL ) > 0 );\r
778         configASSERT( uxTaskGetStackHighWaterMark2( NULL ) > 0 );\r
779         /* Run time stats are not being gathered - this is just to exercise\r
780         API. */\r
781         configASSERT( xTaskGetIdleRunTimeCounter() == 0 ); \r
782         vTaskSuspend( NULL );\r
783 }\r
784 /*-----------------------------------------------------------*/\r
785 \r
786 static void prvPendedFunctionCall( void *pvParameter1, uint32_t ulParameter2 )\r
787 {\r
788 uint32_t *pulCounter = ( uint32_t * ) pvParameter1;\r
789 \r
790         /* Increment the paramater to show the pended function has executed. */\r
791         ( *pulCounter )++;\r
792 }\r
793 /*-----------------------------------------------------------*/\r
794 \r
795 static void prvTestTimerCallback( TimerHandle_t xTimer )\r
796 {\r
797 uint32_t ulTimerID;\r
798 \r
799         /* Increment the timer's ID to show the callback has executed. */\r
800         ulTimerID = ( uint32_t ) pvTimerGetTimerID( xTimer );\r
801         ulTimerID++;\r
802         vTimerSetTimerID( xTimer, ( void * ) ulTimerID );\r
803 }\r
804 /*-----------------------------------------------------------*/\r
805 \r
806 static void prvExerciseTimerAPI( void )\r
807 {\r
808 TimerHandle_t xTimer;\r
809 const char * const pcTimerName = "TestTimer";\r
810 const TickType_t x3ms = pdMS_TO_TICKS( 3 );\r
811 uint32_t ulValueForTesting = 0;\r
812 \r
813         xTimer = xTimerCreate(  pcTimerName,\r
814                                                         x3ms,\r
815                                                         pdFALSE, /* Created as a one-shot timer. */\r
816                                                         0,\r
817                                                         prvTestTimerCallback );\r
818         configASSERT( xTimer );\r
819         configASSERT( xTimerIsTimerActive( xTimer ) == pdFALSE );\r
820         configASSERT( xTimerGetTimerDaemonTaskHandle() != NULL );\r
821         configASSERT( strcmp( pcTimerName, pcTimerGetName( xTimer ) ) == 0 );\r
822         configASSERT( xTimerGetPeriod( xTimer ) == x3ms );\r
823 \r
824         /* Pend a function then wait for it to execute.  All it does is increment\r
825         its parameter. */\r
826         xTimerPendFunctionCall( prvPendedFunctionCall, &ulValueForTesting, 0, 0 );\r
827         vTaskDelay( x3ms );\r
828         configASSERT( ulValueForTesting == 1 );\r
829 \r
830         /* Timer was created as a one-shot timer.  Its callback just increments the\r
831         timer's ID - so set the ID to 0, let the timer run for a number of timeout\r
832         periods, then check the timer has only executed once. */\r
833         vTimerSetTimerID( xTimer, ( void * ) 0 );\r
834         xTimerStart( xTimer, 0 );\r
835         vTaskDelay( 3UL * x3ms );\r
836         configASSERT( ( ( uint32_t ) ( pvTimerGetTimerID( xTimer ) ) ) == 1UL );\r
837 \r
838         /* Now change the timer to be an auto-reload timer and check it executes\r
839         the expected number of times. */\r
840         vTimerSetReloadMode( xTimer, pdTRUE );\r
841         xTimerStart( xTimer, 0 );\r
842         vTaskDelay( 3UL * x3ms );\r
843         configASSERT( ( uint32_t ) ( pvTimerGetTimerID( xTimer ) ) > 3UL );\r
844         configASSERT( xTimerStop( xTimer, 0 ) != pdFAIL );\r
845 \r
846         /* Clean up at the end. */\r
847         xTimerDelete( xTimer, portMAX_DELAY );\r
848 }\r
849 /*-----------------------------------------------------------*/\r
850 \r
851 static void prvExerciseStreamBufferAPI( void )\r
852 {\r
853 uint8_t ucBuffer[ 10 ];\r
854 BaseType_t x, xRead;\r
855 size_t xReturned;\r
856 StreamBufferHandle_t xStreamBuffer;\r
857 \r
858         /* Just makes API calls to ensure the MPU versions are used. */\r
859 \r
860         xStreamBuffer = xStreamBufferCreate( sizeof( ucBuffer ) , 1 );\r
861         configASSERT( xStreamBuffer );\r
862 \r
863         for( x = 0; x < ( sizeof( ucBuffer ) * 2 ); x++ )\r
864         {\r
865                 /* Write and check the value is written, then read and check the value\r
866                 read is expected. */\r
867                 xReturned = xStreamBufferSend( xStreamBuffer,\r
868                                                                            ( void * ) &x,\r
869                                                                            sizeof( x ),\r
870                                                                            0 );\r
871                 configASSERT( xReturned == sizeof( x ) );\r
872 \r
873                 xReturned = xStreamBufferReceive( xStreamBuffer,\r
874                                                                                   ( void * ) &xRead,\r
875                                                                                   sizeof( xRead ),\r
876                                                                                   0 );\r
877                 configASSERT( xReturned == sizeof( xRead ) );\r
878                 configASSERT( xRead == x );\r
879                 configASSERT( xStreamBufferIsFull( xStreamBuffer ) == pdFALSE );\r
880                 configASSERT( xStreamBufferIsEmpty( xStreamBuffer ) == pdTRUE );\r
881                 configASSERT( xStreamBufferSpacesAvailable( xStreamBuffer ) == sizeof( ucBuffer ) );\r
882                 configASSERT( xStreamBufferBytesAvailable( xStreamBuffer ) == 0 );\r
883         }\r
884 \r
885         /* Call the functions that have not been exercised yet before finishing by\r
886         deleting the stream buffer. */\r
887         configASSERT( xStreamBufferSetTriggerLevel( xStreamBuffer, 0 ) == pdTRUE );\r
888         configASSERT( xStreamBufferReset( xStreamBuffer ) == pdPASS );\r
889         vStreamBufferDelete( xStreamBuffer );\r
890 }\r
891 /*-----------------------------------------------------------*/\r
892 \r
893 void vApplicationIdleHook( void )\r
894 {\r
895 volatile const uint32_t *pul;\r
896 volatile uint32_t ulReadData;\r
897 \r
898         /* The idle task, and therefore this function, run in Supervisor mode and\r
899         can therefore access all memory.  Try reading from corners of flash and\r
900         RAM to ensure a memory fault does not occur.\r
901 \r
902         Start with the edges of the privileged data area. */\r
903         pul = __privileged_data_start__;\r
904         ulReadData = *pul;\r
905         pul = __privileged_data_end__ - 1;\r
906         ulReadData = *pul;\r
907 \r
908         /* Next the standard SRAM area. */\r
909         pul = __SRAM_segment_end__ - 1;\r
910         ulReadData = *pul;\r
911 \r
912         /* And the standard Flash area - the start of which is marked for\r
913         privileged access only. */\r
914         pul = __FLASH_segment_start__;\r
915         ulReadData = *pul;\r
916         pul = __FLASH_segment_end__ - 1;\r
917         ulReadData = *pul;\r
918 \r
919         /* Reading off the end of Flash or SRAM space should cause a fault.\r
920         Uncomment one of the following two pairs of lines to test. */\r
921 \r
922         /* pul = __FLASH_segment_end__ + 4;\r
923         ulReadData = *pul; */\r
924 \r
925         /* pul = __SRAM_segment_end__ + 1;\r
926         ulReadData = *pul; */\r
927 \r
928         /* One task is created purely so it can be deleted - done for code coverage\r
929         test purposes. */\r
930         if( xTaskToDelete != NULL )\r
931         {\r
932                 if( eTaskGetState( xTaskToDelete ) == eSuspended )\r
933                 {\r
934                         /* The task has finished its tests and can be deleted. */\r
935                         vTaskDelete( xTaskToDelete );\r
936                         xTaskToDelete = NULL;\r
937                 }\r
938         }\r
939 \r
940         ( void ) ulReadData;\r
941 }\r
942 /*-----------------------------------------------------------*/\r
943 \r
944 static void prvOldStyleUserModeTask( void *pvParameters )\r
945 {\r
946 /*const volatile uint32_t *pulStandardPeripheralRegister = ( volatile uint32_t * ) 0x40000000;*/\r
947 volatile const uint32_t *pul;\r
948 volatile uint32_t ulReadData;\r
949 \r
950 /* The following lines are commented out to prevent the unused variable\r
951 compiler warnings when the tests that use the variable are also commented out. */\r
952 /* extern uint32_t __privileged_functions_start__[]; */\r
953 /* const volatile uint32_t *pulSystemPeripheralRegister = ( volatile uint32_t * ) 0xe000e014; */\r
954 \r
955         ( void ) pvParameters;\r
956 \r
957         /* This task is created in User mode using the original xTaskCreate() API\r
958         function.  It should have access to all Flash and RAM except that marked\r
959         as Privileged access only.  Reading from the start and end of the non-\r
960         privileged RAM should not cause a problem (the privileged RAM is the first\r
961         block at the bottom of the RAM memory). */\r
962         pul = __privileged_data_end__ + 1;\r
963         ulReadData = *pul;\r
964         pul = __SRAM_segment_end__ - 1;\r
965         ulReadData = *pul;\r
966 \r
967         /* Likewise reading from the start and end of the non-privileged Flash\r
968         should not be a problem (the privileged Flash is the first block at the\r
969         bottom of the Flash memory). */\r
970         pul = __privileged_functions_end__ + 1;\r
971         ulReadData = *pul;\r
972         pul = __FLASH_segment_end__ - 1;\r
973         ulReadData = *pul;\r
974 \r
975         /* Standard peripherals are accessible. */\r
976         /*ulReadData = *pulStandardPeripheralRegister;*/\r
977 \r
978         /* System peripherals are not accessible.  Uncomment the following line\r
979         to test.  Also uncomment the declaration of pulSystemPeripheralRegister\r
980         at the top of this function.\r
981         ulReadData = *pulSystemPeripheralRegister; */\r
982 \r
983         /* Reading from anywhere inside the privileged Flash or RAM should cause a\r
984         fault.  This can be tested by uncommenting any of the following pairs of\r
985         lines.  Also uncomment the declaration of __privileged_functions_start__\r
986         at the top of this function. */\r
987 \r
988         /*pul = __privileged_functions_start__;\r
989         ulReadData = *pul;*/\r
990 \r
991         /*pul = __privileged_functions_end__ - 1;\r
992         ulReadData = *pul;*/\r
993 \r
994         /*pul = __privileged_data_start__;\r
995         ulReadData = *pul;*/\r
996 \r
997         /*pul = __privileged_data_end__ - 1;\r
998         ulReadData = *pul;*/\r
999 \r
1000         /* Must not just run off the end of a task function, so delete this task.\r
1001         Note that because this task was created using xTaskCreate() the stack was\r
1002         allocated dynamically and I have not included any code to free it again. */\r
1003         vTaskDelete( NULL );\r
1004 \r
1005         ( void ) ulReadData;\r
1006 }\r
1007 /*-----------------------------------------------------------*/\r
1008 \r
1009 static void prvOldStylePrivilegedModeTask( void *pvParameters )\r
1010 {\r
1011 volatile const uint32_t *pul;\r
1012 volatile uint32_t ulReadData;\r
1013 const volatile uint32_t *pulSystemPeripheralRegister = ( volatile uint32_t * ) 0xe000e014; /* Systick */\r
1014 /*const volatile uint32_t *pulStandardPeripheralRegister = ( volatile uint32_t * ) 0x40000000;*/\r
1015 \r
1016         ( void ) pvParameters;\r
1017 \r
1018         /* This task is created in Privileged mode using the original xTaskCreate()\r
1019         API     function.  It should have access to all Flash and RAM including that\r
1020         marked as Privileged access only.  So reading from the start and end of the\r
1021         non-privileged RAM should not cause a problem (the privileged RAM is the\r
1022         first block at the bottom of the RAM memory). */\r
1023         pul = __privileged_data_end__ + 1;\r
1024         ulReadData = *pul;\r
1025         pul = __SRAM_segment_end__ - 1;\r
1026         ulReadData = *pul;\r
1027 \r
1028         /* Likewise reading from the start and end of the non-privileged Flash\r
1029         should not be a problem (the privileged Flash is the first block at the\r
1030         bottom of the Flash memory). */\r
1031         pul = __privileged_functions_end__ + 1;\r
1032         ulReadData = *pul;\r
1033         pul = __FLASH_segment_end__ - 1;\r
1034         ulReadData = *pul;\r
1035 \r
1036         /* Reading from anywhere inside the privileged Flash or RAM should also\r
1037         not be a problem. */\r
1038         pul = __privileged_functions_start__;\r
1039         ulReadData = *pul;\r
1040         pul = __privileged_functions_end__ - 1;\r
1041         ulReadData = *pul;\r
1042         pul = __privileged_data_start__;\r
1043         ulReadData = *pul;\r
1044         pul = __privileged_data_end__ - 1;\r
1045         ulReadData = *pul;\r
1046 \r
1047         /* Finally, accessing both System and normal peripherals should both be\r
1048         possible. */\r
1049         ulReadData = *pulSystemPeripheralRegister;\r
1050         /*ulReadData = *pulStandardPeripheralRegister;*/\r
1051 \r
1052         /* Must not just run off the end of a task function, so delete this task.\r
1053         Note that because this task was created using xTaskCreate() the stack was\r
1054         allocated dynamically and I have not included any code to free it again. */\r
1055         vTaskDelete( NULL );\r
1056 \r
1057         ( void ) ulReadData;\r
1058 }\r
1059 /*-----------------------------------------------------------*/\r
1060 \r
1061 void vMainDeleteMe( void )\r
1062 {\r
1063         vTaskDelete( NULL );\r
1064 }\r
1065 /*-----------------------------------------------------------*/\r
1066 \r
1067 void vMainSendImAlive( QueueHandle_t xHandle, uint32_t ulTaskNumber )\r
1068 {\r
1069         if( xHandle != NULL )\r
1070         {\r
1071                 xQueueSend( xHandle, &ulTaskNumber, mainDONT_BLOCK );\r
1072         }\r
1073 }\r
1074 /*-----------------------------------------------------------*/\r
1075 \r
1076 static void prvSetupHardware( void )\r
1077 {\r
1078 }\r
1079 /*-----------------------------------------------------------*/\r
1080 \r
1081 void vApplicationTickHook( void )\r
1082 {\r
1083 static uint32_t ulCallCount = 0;\r
1084 const uint32_t ulCallsBetweenSends = pdMS_TO_TICKS( 1000 );\r
1085 const uint32_t ulMessage = configPRINT_SYSTEM_STATUS;\r
1086 portBASE_TYPE xDummy;\r
1087 \r
1088         /* If configUSE_TICK_HOOK is set to 1 then this function will get called\r
1089         from each RTOS tick.  It is called from the tick interrupt and therefore\r
1090         will be executing in the privileged state. */\r
1091 \r
1092         ulCallCount++;\r
1093 \r
1094         /* Is it time to print out the pass/fail message again? */\r
1095         if( ulCallCount >= ulCallsBetweenSends )\r
1096         {\r
1097                 ulCallCount = 0;\r
1098 \r
1099                 /* Send a message to the check task to command it to check that all\r
1100                 the tasks are still running then print out the status.\r
1101 \r
1102                 This is running in an ISR so has to use the "FromISR" version of\r
1103                 xQueueSend().  Because it is in an ISR it is running with privileges\r
1104                 so can access xGlobalScopeCheckQueue directly. */\r
1105                 xQueueSendFromISR( xGlobalScopeCheckQueue, &ulMessage, &xDummy );\r
1106         }\r
1107 }\r
1108 /*-----------------------------------------------------------*/\r
1109 \r
1110 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName )\r
1111 {\r
1112         /* If configCHECK_FOR_STACK_OVERFLOW is set to either 1 or 2 then this\r
1113         function will automatically get called if a task overflows its stack. */\r
1114         ( void ) pxTask;\r
1115         ( void ) pcTaskName;\r
1116         for( ;; );\r
1117 }\r
1118 /*-----------------------------------------------------------*/\r
1119 \r
1120 void vApplicationMallocFailedHook( void )\r
1121 {\r
1122         /* If configUSE_MALLOC_FAILED_HOOK is set to 1 then this function will\r
1123         be called automatically if a call to pvPortMalloc() fails.  pvPortMalloc()\r
1124         is called automatically when a task, queue or semaphore is created. */\r
1125         for( ;; );\r
1126 }\r
1127 /*-----------------------------------------------------------*/\r
1128 \r
1129 static void prvTimerCallback( TimerHandle_t xExpiredTimer )\r
1130 {\r
1131 uint32_t ulCount;\r
1132 \r
1133         /* The count of the number of times this timer has expired is saved in the\r
1134         timer's ID.  Obtain the current count. */\r
1135         ulCount = ( uint32_t ) pvTimerGetTimerID( xTimer );\r
1136 \r
1137         /* Increment the count, and save it back into the timer's ID. */\r
1138         ulCount++;\r
1139         vTimerSetTimerID( xTimer, ( void * ) ulCount );\r
1140 \r
1141         /* Let the check task know the timer is still running. */\r
1142         vMainSendImAlive( xGlobalScopeCheckQueue, configTIMER_STILL_EXECUTING );\r
1143 }\r
1144 /*-----------------------------------------------------------*/\r
1145 \r
1146 /* configUSE_STATIC_ALLOCATION is set to 1, so the application must provide an\r
1147 implementation of vApplicationGetIdleTaskMemory() to provide the memory that is\r
1148 used by the Idle task. */\r
1149 void vApplicationGetIdleTaskMemory( StaticTask_t **ppxIdleTaskTCBBuffer, StackType_t **ppxIdleTaskStackBuffer, uint32_t *pulIdleTaskStackSize )\r
1150 {\r
1151 /* If the buffers to be provided to the Idle task are declared inside this\r
1152 function then they must be declared static - otherwise they will be allocated on\r
1153 the stack and so not exists after this function exits. */\r
1154 static StaticTask_t xIdleTaskTCB;\r
1155 static StackType_t uxIdleTaskStack[ configMINIMAL_STACK_SIZE ];\r
1156 \r
1157         /* Pass out a pointer to the StaticTask_t structure in which the Idle task's\r
1158         state will be stored. */\r
1159         *ppxIdleTaskTCBBuffer = &xIdleTaskTCB;\r
1160 \r
1161         /* Pass out the array that will be used as the Idle task's stack. */\r
1162         *ppxIdleTaskStackBuffer = uxIdleTaskStack;\r
1163 \r
1164         /* Pass out the size of the array pointed to by *ppxIdleTaskStackBuffer.\r
1165         Note that, as the array is necessarily of type StackType_t,\r
1166         configMINIMAL_STACK_SIZE is specified in words, not bytes. */\r
1167         *pulIdleTaskStackSize = configMINIMAL_STACK_SIZE;\r
1168 }\r
1169 /*-----------------------------------------------------------*/\r
1170 \r
1171 /* configUSE_STATIC_ALLOCATION and configUSE_TIMERS are both set to 1, so the\r
1172 application must provide an implementation of vApplicationGetTimerTaskMemory()\r
1173 to provide the memory that is used by the Timer service task. */\r
1174 void vApplicationGetTimerTaskMemory( StaticTask_t **ppxTimerTaskTCBBuffer, StackType_t **ppxTimerTaskStackBuffer, uint32_t *pulTimerTaskStackSize )\r
1175 {\r
1176 /* If the buffers to be provided to the Timer task are declared inside this\r
1177 function then they must be declared static - otherwise they will be allocated on\r
1178 the stack and so not exists after this function exits. */\r
1179 static StaticTask_t xTimerTaskTCB;\r
1180 static StackType_t uxTimerTaskStack[ configTIMER_TASK_STACK_DEPTH ];\r
1181 \r
1182         /* Pass out a pointer to the StaticTask_t structure in which the Timer\r
1183         task's state will be stored. */\r
1184         *ppxTimerTaskTCBBuffer = &xTimerTaskTCB;\r
1185 \r
1186         /* Pass out the array that will be used as the Timer task's stack. */\r
1187         *ppxTimerTaskStackBuffer = uxTimerTaskStack;\r
1188 \r
1189         /* Pass out the size of the array pointed to by *ppxTimerTaskStackBuffer.\r
1190         Note that, as the array is necessarily of type StackType_t,\r
1191         configMINIMAL_STACK_SIZE is specified in words, not bytes. */\r
1192         *pulTimerTaskStackSize = configTIMER_TASK_STACK_DEPTH;\r
1193 }\r
1194 /*-----------------------------------------------------------*/\r
1195 \r
1196 static void prvRegTest3Task( void *pvParameters )\r
1197 {\r
1198         /* Although the regtest task is written in assembler, its entry point is\r
1199         written in C for convenience of checking the task parameter is being passed\r
1200         in correctly. */\r
1201         if( pvParameters == configREG_TEST_TASK_3_PARAMETER )\r
1202         {\r
1203                 /* Start the part of the test that is written in assembler. */\r
1204                 vRegTest3Implementation();\r
1205         }\r
1206 \r
1207         /* The following line will only execute if the task parameter is found to\r
1208         be incorrect.  The check task will detect that the regtest loop counter is\r
1209         not being incremented and flag an error. */\r
1210         vTaskDelete( NULL );\r
1211 }\r
1212 /*-----------------------------------------------------------*/\r
1213 \r
1214 static void prvRegTest4Task( void *pvParameters )\r
1215 {\r
1216         /* Although the regtest task is written in assembler, its entry point is\r
1217         written in C for convenience of checking the task parameter is being passed\r
1218         in correctly. */\r
1219         if( pvParameters == configREG_TEST_TASK_4_PARAMETER )\r
1220         {\r
1221                 /* Start the part of the test that is written in assembler. */\r
1222                 vRegTest4Implementation();\r
1223         }\r
1224 \r
1225         /* The following line will only execute if the task parameter is found to\r
1226         be incorrect.  The check task will detect that the regtest loop counter is\r
1227         not being incremented and flag an error. */\r
1228         vTaskDelete( NULL );\r
1229 }\r
1230 /*-----------------------------------------------------------*/\r
1231 \r