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