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