]> git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_LM3Sxxxx_IAR_Keil/main.c
Replace use of legacy portTYPE macros from old demos and standard demo files.
[freertos] / FreeRTOS / Demo / CORTEX_LM3Sxxxx_IAR_Keil / main.c
1 /*\r
2     FreeRTOS V7.6.0 - Copyright (C) 2013 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 distribute\r
28     >>! a combined work that includes FreeRTOS without being obliged to provide\r
29     >>! the source code for proprietary components outside of the FreeRTOS\r
30     >>! kernel.\r
31 \r
32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
35     link: http://www.freertos.org/a00114.html\r
36 \r
37     1 tab == 4 spaces!\r
38 \r
39     ***************************************************************************\r
40      *                                                                       *\r
41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
42      *    not run, what could be wrong?"                                     *\r
43      *                                                                       *\r
44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
45      *                                                                       *\r
46     ***************************************************************************\r
47 \r
48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
49     license and Real Time Engineers Ltd. contact details.\r
50 \r
51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
54 \r
55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
57     licenses offer ticketed support, indemnification and middleware.\r
58 \r
59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
60     engineered and independently SIL3 certified version for use in safety and\r
61     mission critical applications that require provable dependability.\r
62 \r
63     1 tab == 4 spaces!\r
64 */\r
65 \r
66 \r
67 /*\r
68  * Creates all the demo application tasks, then starts the scheduler.  The WEB\r
69  * documentation provides more details of the standard demo application tasks.\r
70  * In addition to the standard demo tasks, the following tasks and tests are\r
71  * defined and/or created within this file:\r
72  *\r
73  * "Fast Interrupt Test" - A high frequency periodic interrupt is generated\r
74  * using a free running timer to demonstrate the use of the\r
75  * configKERNEL_INTERRUPT_PRIORITY configuration constant.  The interrupt\r
76  * service routine measures the number of processor clocks that occur between\r
77  * each interrupt - and in so doing measures the jitter in the interrupt timing.\r
78  * The maximum measured jitter time is latched in the ulMaxJitter variable, and\r
79  * displayed on the OLED display by the 'OLED' task as described below.  The\r
80  * fast interrupt is configured and handled in the timertest.c source file.\r
81  *\r
82  * "OLED" task - the OLED task is a 'gatekeeper' task.  It is the only task that\r
83  * is permitted to access the display directly.  Other tasks wishing to write a\r
84  * message to the OLED send the message on a queue to the OLED task instead of\r
85  * accessing the OLED themselves.  The OLED task just blocks on the queue waiting\r
86  * for messages - waking and displaying the messages as they arrive.\r
87  *\r
88  * "Check" hook -  This only executes every five seconds from the tick hook.\r
89  * Its main function is to check that all the standard demo tasks are still\r
90  * operational.  Should any unexpected behaviour within a demo task be discovered\r
91  * the tick hook will write an error to the OLED (via the OLED task).  If all the\r
92  * demo tasks are executing with their expected behaviour then the check task\r
93  * writes PASS to the OLED (again via the OLED task), as described above.\r
94  *\r
95  * "uIP" task -  This is the task that handles the uIP stack.  All TCP/IP\r
96  * processing is performed in this task.\r
97  */\r
98 \r
99 \r
100 \r
101 \r
102 /*************************************************************************\r
103  * Please ensure to read http://www.freertos.org/portlm3sx965.html\r
104  * which provides information on configuring and running this demo for the\r
105  * various Luminary Micro EKs.\r
106  *************************************************************************/\r
107 \r
108 /* Set the following option to 1 to include the WEB server in the build.  By\r
109 default the WEB server is excluded to keep the compiled code size under the 32K\r
110 limit imposed by the KickStart version of the IAR compiler.  The graphics\r
111 libraries take up a lot of ROM space, hence including the graphics libraries\r
112 and the TCP/IP stack together cannot be accommodated with the 32K size limit. */\r
113 #define mainINCLUDE_WEB_SERVER          0\r
114 \r
115 \r
116 /* Standard includes. */\r
117 #include <stdio.h>\r
118 #include <string.h>\r
119 \r
120 /* Scheduler includes. */\r
121 #include "FreeRTOS.h"\r
122 #include "task.h"\r
123 #include "queue.h"\r
124 #include "semphr.h"\r
125 \r
126 /* Hardware library includes. */\r
127 #include "hw_memmap.h"\r
128 #include "hw_types.h"\r
129 #include "hw_sysctl.h"\r
130 #include "sysctl.h"\r
131 #include "gpio.h"\r
132 #include "grlib.h"\r
133 #include "rit128x96x4.h"\r
134 #include "osram128x64x4.h"\r
135 #include "formike128x128x16.h"\r
136 \r
137 /* Demo app includes. */\r
138 #include "BlockQ.h"\r
139 #include "death.h"\r
140 #include "integer.h"\r
141 #include "blocktim.h"\r
142 #include "flash.h"\r
143 #include "partest.h"\r
144 #include "semtest.h"\r
145 #include "PollQ.h"\r
146 #include "lcd_message.h"\r
147 #include "bitmap.h"\r
148 #include "GenQTest.h"\r
149 #include "QPeek.h"\r
150 #include "recmutex.h"\r
151 #include "IntQueue.h"\r
152 #include "QueueSet.h"\r
153 \r
154 /*-----------------------------------------------------------*/\r
155 \r
156 /* The time between cycles of the 'check' functionality (defined within the\r
157 tick hook. */\r
158 #define mainCHECK_DELAY                                         ( ( portTickType ) 5000 / portTICK_RATE_MS )\r
159 \r
160 /* Size of the stack allocated to the uIP task. */\r
161 #define mainBASIC_WEB_STACK_SIZE            ( configMINIMAL_STACK_SIZE * 3 )\r
162 \r
163 /* The OLED task uses the sprintf function so requires a little more stack too. */\r
164 #define mainOLED_TASK_STACK_SIZE                        ( configMINIMAL_STACK_SIZE + 50 )\r
165 \r
166 /* Task priorities. */\r
167 #define mainQUEUE_POLL_PRIORITY                         ( tskIDLE_PRIORITY + 2 )\r
168 #define mainCHECK_TASK_PRIORITY                         ( tskIDLE_PRIORITY + 3 )\r
169 #define mainSEM_TEST_PRIORITY                           ( tskIDLE_PRIORITY + 1 )\r
170 #define mainBLOCK_Q_PRIORITY                            ( tskIDLE_PRIORITY + 2 )\r
171 #define mainCREATOR_TASK_PRIORITY           ( tskIDLE_PRIORITY + 3 )\r
172 #define mainINTEGER_TASK_PRIORITY           ( tskIDLE_PRIORITY )\r
173 #define mainGEN_QUEUE_TASK_PRIORITY                     ( tskIDLE_PRIORITY )\r
174 \r
175 /* The maximum number of message that can be waiting for display at any one\r
176 time. */\r
177 #define mainOLED_QUEUE_SIZE                                     ( 3 )\r
178 \r
179 /* Dimensions the buffer into which the jitter time is written. */\r
180 #define mainMAX_MSG_LEN                                         25\r
181 \r
182 /* The period of the system clock in nano seconds.  This is used to calculate\r
183 the jitter time in nano seconds. */\r
184 #define mainNS_PER_CLOCK                                        ( ( unsigned long ) ( ( 1.0 / ( double ) configCPU_CLOCK_HZ ) * 1000000000.0 ) )\r
185 \r
186 /* Constants used when writing strings to the display. */\r
187 #define mainCHARACTER_HEIGHT                            ( 9 )\r
188 #define mainMAX_ROWS_128                                        ( mainCHARACTER_HEIGHT * 14 )\r
189 #define mainMAX_ROWS_96                                         ( mainCHARACTER_HEIGHT * 10 )\r
190 #define mainMAX_ROWS_64                                         ( mainCHARACTER_HEIGHT * 7 )\r
191 #define mainFULL_SCALE                                          ( 15 )\r
192 #define ulSSI_FREQUENCY                                         ( 3500000UL )\r
193 \r
194 /*-----------------------------------------------------------*/\r
195 \r
196 /*\r
197  * The task that handles the uIP stack.  All TCP/IP processing is performed in\r
198  * this task.\r
199  */\r
200 extern void vuIP_Task( void *pvParameters );\r
201 \r
202 /*\r
203  * The display is written two by more than one task so is controlled by a\r
204  * 'gatekeeper' task.  This is the only task that is actually permitted to\r
205  * access the display directly.  Other tasks wanting to display a message send\r
206  * the message to the gatekeeper.\r
207  */\r
208 static void vOLEDTask( void *pvParameters );\r
209 \r
210 /*\r
211  * Configure the hardware for the demo.\r
212  */\r
213 static void prvSetupHardware( void );\r
214 \r
215 /*\r
216  * Configures the high frequency timers - those used to measure the timing\r
217  * jitter while the real time kernel is executing.\r
218  */\r
219 extern void vSetupHighFrequencyTimer( void );\r
220 \r
221 /*\r
222  * Hook functions that can get called by the kernel.\r
223  */\r
224 void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed char *pcTaskName );\r
225 void vApplicationTickHook( void );\r
226 \r
227 \r
228 /*-----------------------------------------------------------*/\r
229 \r
230 /* The queue used to send messages to the OLED task. */\r
231 xQueueHandle xOLEDQueue;\r
232 \r
233 /* The welcome text. */\r
234 const char * const pcWelcomeMessage = "   www.FreeRTOS.org";\r
235 \r
236 /*-----------------------------------------------------------*/\r
237 \r
238 \r
239 /*************************************************************************\r
240  * Please ensure to read http://www.freertos.org/portlm3sx965.html\r
241  * which provides information on configuring and running this demo for the\r
242  * various Luminary Micro EKs.\r
243  *************************************************************************/\r
244 int main( void )\r
245 {\r
246         prvSetupHardware();\r
247 \r
248         /* Create the queue used by the OLED task.  Messages for display on the OLED\r
249         are received via this queue. */\r
250         xOLEDQueue = xQueueCreate( mainOLED_QUEUE_SIZE, sizeof( xOLEDMessage ) );\r
251 \r
252         /* Start the standard demo tasks. */\r
253     vStartIntegerMathTasks( mainINTEGER_TASK_PRIORITY );\r
254     vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );\r
255     vStartInterruptQueueTasks();\r
256         vStartRecursiveMutexTasks();\r
257         vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );\r
258         vCreateBlockTimeTasks();\r
259         vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );\r
260         vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );\r
261         vStartQueuePeekTasks();\r
262         vStartQueueSetTasks();\r
263 \r
264         /* Exclude some tasks if using the kickstart version to ensure we stay within\r
265         the 32K code size limit. */\r
266         #if mainINCLUDE_WEB_SERVER != 0\r
267         {\r
268                 /* Create the uIP task if running on a processor that includes a MAC and\r
269                 PHY. */\r
270                 if( SysCtlPeripheralPresent( SYSCTL_PERIPH_ETH ) )\r
271                 {\r
272                         xTaskCreate( vuIP_Task, "uIP", mainBASIC_WEB_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY - 1, NULL );\r
273                 }\r
274         }\r
275         #endif\r
276 \r
277 \r
278 \r
279         /* Start the tasks defined within this file/specific to this demo. */\r
280         xTaskCreate( vOLEDTask, "OLED", mainOLED_TASK_STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );\r
281 \r
282         /* The suicide tasks must be created last as they need to know how many\r
283         tasks were running prior to their creation in order to ascertain whether\r
284         or not the correct/expected number of tasks are running at any given time. */\r
285     vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );\r
286 \r
287         /* Configure the high frequency interrupt used to measure the interrupt\r
288         jitter time. */\r
289         vSetupHighFrequencyTimer();\r
290 \r
291         /* Start the scheduler. */\r
292         vTaskStartScheduler();\r
293 \r
294     /* Will only get here if there was insufficient memory to create the idle\r
295     task. */\r
296         return 0;\r
297 }\r
298 /*-----------------------------------------------------------*/\r
299 \r
300 void prvSetupHardware( void )\r
301 {\r
302     /* If running on Rev A2 silicon, turn the LDO voltage up to 2.75V.  This is\r
303     a workaround to allow the PLL to operate reliably. */\r
304     if( DEVICE_IS_REVA2 )\r
305     {\r
306         SysCtlLDOSet( SYSCTL_LDO_2_75V );\r
307     }\r
308 \r
309         /* Set the clocking to run from the PLL at 50 MHz */\r
310         SysCtlClockSet( SYSCTL_SYSDIV_4 | SYSCTL_USE_PLL | SYSCTL_OSC_MAIN | SYSCTL_XTAL_8MHZ );\r
311 \r
312         /*      Enable Port F for Ethernet LEDs\r
313                 LED0        Bit 3   Output\r
314                 LED1        Bit 2   Output */\r
315         SysCtlPeripheralEnable( SYSCTL_PERIPH_GPIOF );\r
316         GPIODirModeSet( GPIO_PORTF_BASE, (GPIO_PIN_2 | GPIO_PIN_3), GPIO_DIR_MODE_HW );\r
317         GPIOPadConfigSet( GPIO_PORTF_BASE, (GPIO_PIN_2 | GPIO_PIN_3 ), GPIO_STRENGTH_2MA, GPIO_PIN_TYPE_STD );\r
318 \r
319         vParTestInitialise();\r
320 }\r
321 /*-----------------------------------------------------------*/\r
322 \r
323 void vApplicationTickHook( void )\r
324 {\r
325 static xOLEDMessage xMessage = { "PASS" };\r
326 static unsigned long ulTicksSinceLastDisplay = 0;\r
327 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
328 \r
329         /* Called from every tick interrupt.  Have enough ticks passed to make it\r
330         time to perform our health status check again? */\r
331         ulTicksSinceLastDisplay++;\r
332         if( ulTicksSinceLastDisplay >= mainCHECK_DELAY )\r
333         {\r
334                 ulTicksSinceLastDisplay = 0;\r
335 \r
336                 /* Has an error been found in any task? */\r
337                 if( xAreGenericQueueTasksStillRunning() != pdTRUE )\r
338                 {\r
339                         xMessage.pcMessage = "ERROR IN GEN Q";\r
340                 }\r
341             else if( xIsCreateTaskStillRunning() != pdTRUE )\r
342             {\r
343                 xMessage.pcMessage = "ERROR IN CREATE";\r
344             }\r
345             else if( xAreIntegerMathsTaskStillRunning() != pdTRUE )\r
346             {\r
347                 xMessage.pcMessage = "ERROR IN MATH";\r
348             }\r
349                 else if( xAreIntQueueTasksStillRunning() != pdTRUE )\r
350                 {\r
351                         xMessage.pcMessage = "ERROR IN INT QUEUE";\r
352                 }\r
353                 else if( xAreBlockingQueuesStillRunning() != pdTRUE )\r
354                 {\r
355                         xMessage.pcMessage = "ERROR IN BLOCK Q";\r
356                 }\r
357                 else if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )\r
358                 {\r
359                         xMessage.pcMessage = "ERROR IN BLOCK TIME";\r
360                 }\r
361                 else if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
362                 {\r
363                         xMessage.pcMessage = "ERROR IN SEMAPHORE";\r
364                 }\r
365                 else if( xArePollingQueuesStillRunning() != pdTRUE )\r
366                 {\r
367                         xMessage.pcMessage = "ERROR IN POLL Q";\r
368                 }\r
369                 else if( xAreQueuePeekTasksStillRunning() != pdTRUE )\r
370                 {\r
371                         xMessage.pcMessage = "ERROR IN PEEK Q";\r
372                 }\r
373                 else if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )\r
374                 {\r
375                         xMessage.pcMessage = "ERROR IN REC MUTEX";\r
376                 }\r
377                 else if( xAreQueueSetTasksStillRunning() != pdPASS )\r
378                 {\r
379                         xMessage.pcMessage = "ERROR IN Q SET";\r
380                 }\r
381 \r
382                 configASSERT( strcmp( ( const char * ) xMessage.pcMessage, "PASS" ) == 0 );\r
383 \r
384                 /* Send the message to the OLED gatekeeper for display. */\r
385                 xHigherPriorityTaskWoken = pdFALSE;\r
386                 xQueueSendFromISR( xOLEDQueue, &xMessage, &xHigherPriorityTaskWoken );\r
387         }\r
388 \r
389         /* Write to a queue that is in use as part of the queue set demo to\r
390         demonstrate using queue sets from an ISR. */\r
391         vQueueSetAccessQueueSetFromISR();\r
392 }\r
393 /*-----------------------------------------------------------*/\r
394 \r
395 void vOLEDTask( void *pvParameters )\r
396 {\r
397 xOLEDMessage xMessage;\r
398 unsigned long ulY, ulMaxY;\r
399 static char cMessage[ mainMAX_MSG_LEN ];\r
400 extern volatile unsigned long ulMaxJitter;\r
401 const unsigned char *pucImage;\r
402 \r
403 /* Functions to access the OLED.  The one used depends on the dev kit\r
404 being used. */\r
405 void ( *vOLEDInit )( unsigned long ) = NULL;\r
406 void ( *vOLEDStringDraw )( const char *, unsigned long, unsigned long, unsigned char ) = NULL;\r
407 void ( *vOLEDImageDraw )( const unsigned char *, unsigned long, unsigned long, unsigned long, unsigned long ) = NULL;\r
408 void ( *vOLEDClear )( void ) = NULL;\r
409 \r
410         /* Map the OLED access functions to the driver functions that are appropriate\r
411         for the evaluation kit being used. */\r
412         switch( HWREG( SYSCTL_DID1 ) & SYSCTL_DID1_PRTNO_MASK )\r
413         {\r
414                 case SYSCTL_DID1_PRTNO_6965     :\r
415                 case SYSCTL_DID1_PRTNO_2965     :       vOLEDInit = OSRAM128x64x4Init;\r
416                                                                                 vOLEDStringDraw = OSRAM128x64x4StringDraw;\r
417                                                                                 vOLEDImageDraw = OSRAM128x64x4ImageDraw;\r
418                                                                                 vOLEDClear = OSRAM128x64x4Clear;\r
419                                                                                 ulMaxY = mainMAX_ROWS_64;\r
420                                                                                 pucImage = pucBasicBitmap;\r
421                                                                                 break;\r
422 \r
423                 case SYSCTL_DID1_PRTNO_1968     :\r
424                 case SYSCTL_DID1_PRTNO_8962 :   vOLEDInit = RIT128x96x4Init;\r
425                                                                                 vOLEDStringDraw = RIT128x96x4StringDraw;\r
426                                                                                 vOLEDImageDraw = RIT128x96x4ImageDraw;\r
427                                                                                 vOLEDClear = RIT128x96x4Clear;\r
428                                                                                 ulMaxY = mainMAX_ROWS_96;\r
429                                                                                 pucImage = pucBasicBitmap;\r
430                                                                                 break;\r
431 \r
432                 default                                         :       vOLEDInit = vFormike128x128x16Init;\r
433                                                                                 vOLEDStringDraw = vFormike128x128x16StringDraw;\r
434                                                                                 vOLEDImageDraw = vFormike128x128x16ImageDraw;\r
435                                                                                 vOLEDClear = vFormike128x128x16Clear;\r
436                                                                                 ulMaxY = mainMAX_ROWS_128;\r
437                                                                                 pucImage = pucGrLibBitmap;\r
438                                                                                 break;\r
439 \r
440         }\r
441 \r
442         ulY = ulMaxY;\r
443 \r
444         /* Initialise the OLED and display a startup message. */\r
445         vOLEDInit( ulSSI_FREQUENCY );\r
446         vOLEDStringDraw( "POWERED BY FreeRTOS", 0, 0, mainFULL_SCALE );\r
447         vOLEDImageDraw( pucImage, 0, mainCHARACTER_HEIGHT + 1, bmpBITMAP_WIDTH, bmpBITMAP_HEIGHT );\r
448 \r
449         for( ;; )\r
450         {\r
451                 /* Wait for a message to arrive that requires displaying. */\r
452                 xQueueReceive( xOLEDQueue, &xMessage, portMAX_DELAY );\r
453 \r
454                 /* Write the message on the next available row. */\r
455                 ulY += mainCHARACTER_HEIGHT;\r
456                 if( ulY >= ulMaxY )\r
457                 {\r
458                         ulY = mainCHARACTER_HEIGHT;\r
459                         vOLEDClear();\r
460                         vOLEDStringDraw( pcWelcomeMessage, 0, 0, mainFULL_SCALE );\r
461                 }\r
462 \r
463                 /* Display the message along with the maximum jitter time from the\r
464                 high priority time test. */\r
465                 sprintf( cMessage, "%s [%uns]", xMessage.pcMessage, ulMaxJitter * mainNS_PER_CLOCK );\r
466                 vOLEDStringDraw( cMessage, 0, ulY, mainFULL_SCALE );\r
467         }\r
468 }\r
469 /*-----------------------------------------------------------*/\r
470 \r
471 void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed char *pcTaskName )\r
472 {\r
473         ( void ) pxTask;\r
474         ( void ) pcTaskName;\r
475 \r
476         for( ;; );\r
477 }\r
478 /*-----------------------------------------------------------*/\r
479 \r
480 void vAssertCalled( const char *pcFile, unsigned long ulLine )\r
481 {\r
482 volatile unsigned long ulSetTo1InDebuggerToExit = 0;\r
483 \r
484         taskENTER_CRITICAL();\r
485         {\r
486                 while( ulSetTo1InDebuggerToExit == 0 )\r
487                 {\r
488                         /* Nothing do do here.  Set the loop variable to a non zero value in\r
489                         the debugger to step out of this function to the point that caused\r
490                         the assertion. */\r
491                         ( void ) pcFile;\r
492                         ( void ) ulLine;\r
493                 }\r
494         }\r
495         taskEXIT_CRITICAL();\r
496 }\r