2 FreeRTOS V6.0.2 - Copyright (C) 2010 Real Time Engineers Ltd.
\r
4 ***************************************************************************
\r
8 * + New to FreeRTOS, *
\r
9 * + Wanting to learn FreeRTOS or multitasking in general quickly *
\r
10 * + Looking for basic training, *
\r
11 * + Wanting to improve your FreeRTOS skills and productivity *
\r
13 * then take a look at the FreeRTOS eBook *
\r
15 * "Using the FreeRTOS Real Time Kernel - a Practical Guide" *
\r
16 * http://www.FreeRTOS.org/Documentation *
\r
18 * A pdf reference manual is also available. Both are usually delivered *
\r
19 * to your inbox within 20 minutes to two hours when purchased between 8am *
\r
20 * and 8pm GMT (although please allow up to 24 hours in case of *
\r
21 * exceptional circumstances). Thank you for your support! *
\r
23 ***************************************************************************
\r
25 This file is part of the FreeRTOS distribution.
\r
27 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
28 the terms of the GNU General Public License (version 2) as published by the
\r
29 Free Software Foundation AND MODIFIED BY the FreeRTOS exception.
\r
30 ***NOTE*** The exception to the GPL is included to allow you to distribute
\r
31 a combined work that includes FreeRTOS without being obliged to provide the
\r
32 source code for proprietary components outside of the FreeRTOS kernel.
\r
33 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT
\r
34 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
\r
35 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
\r
36 more details. You should have received a copy of the GNU General Public
\r
37 License and the FreeRTOS license exception along with FreeRTOS; if not it
\r
38 can be viewed here: http://www.freertos.org/a00114.html and also obtained
\r
39 by writing to Richard Barry, contact details for whom are available on the
\r
44 http://www.FreeRTOS.org - Documentation, latest information, license and
\r
47 http://www.SafeRTOS.com - A version that is certified for use in safety
\r
50 http://www.OpenRTOS.com - Commercial support, development, porting,
\r
51 licensing and training services.
\r
56 * Creates all the demo application tasks, then starts the scheduler. The WEB
\r
57 * documentation provides more details of the standard demo application tasks.
\r
58 * In addition to the standard demo tasks, the following tasks and tests are
\r
59 * defined and/or created within this file:
\r
61 * "Fast Interrupt Test" - A high frequency periodic interrupt is generated
\r
62 * using a free running timer to demonstrate the use of the
\r
63 * configKERNEL_INTERRUPT_PRIORITY configuration constant. The interrupt
\r
64 * service routine measures the number of processor clocks that occur between
\r
65 * each interrupt - and in so doing measures the jitter in the interrupt timing.
\r
66 * The maximum measured jitter time is latched in the ulMaxJitter variable, and
\r
67 * displayed on the OLED display by the 'OLED' task as described below. The
\r
68 * fast interrupt is configured and handled in the timertest.c source file.
\r
70 * "OLED" task - the OLED task is a 'gatekeeper' task. It is the only task that
\r
71 * is permitted to access the display directly. Other tasks wishing to write a
\r
72 * message to the OLED send the message on a queue to the OLED task instead of
\r
73 * accessing the OLED themselves. The OLED task just blocks on the queue waiting
\r
74 * for messages - waking and displaying the messages as they arrive.
\r
76 * "Check" hook - This only executes every five seconds from the tick hook.
\r
77 * Its main function is to check that all the standard demo tasks are still
\r
78 * operational. Should any unexpected behaviour within a demo task be discovered
\r
79 * the tick hook will write an error to the OLED (via the OLED task). If all the
\r
80 * demo tasks are executing with their expected behaviour then the check task
\r
81 * writes PASS to the OLED (again via the OLED task), as described above.
\r
83 * "uIP" task - This is the task that handles the uIP stack. All TCP/IP
\r
84 * processing is performed in this task.
\r
90 /*************************************************************************
\r
91 * Please ensure to read http://www.freertos.org/portlm3sx965.html
\r
92 * which provides information on configuring and running this demo for the
\r
93 * various Luminary Micro EKs.
\r
94 *************************************************************************/
\r
96 /* Set the following option to 1 to include the WEB server in the build. By
\r
97 default the WEB server is excluded to keep the compiled code size under the 32K
\r
98 limit imposed by the KickStart version of the IAR compiler. The graphics
\r
99 libraries take up a lot of ROM space, hence including the graphics libraries
\r
100 and the TCP/IP stack together cannot be accommodated with the 32K size limit. */
\r
101 #define mainINCLUDE_WEB_SERVER 0
\r
104 /* Standard includes. */
\r
107 /* Scheduler includes. */
\r
108 #include "FreeRTOS.h"
\r
111 #include "semphr.h"
\r
113 /* Hardware library includes. */
\r
114 #include "hw_memmap.h"
\r
115 #include "hw_types.h"
\r
116 #include "hw_sysctl.h"
\r
117 #include "sysctl.h"
\r
120 #include "rit128x96x4.h"
\r
121 #include "osram128x64x4.h"
\r
122 #include "formike128x128x16.h"
\r
124 /* Demo app includes. */
\r
125 #include "BlockQ.h"
\r
127 #include "integer.h"
\r
128 #include "blocktim.h"
\r
130 #include "partest.h"
\r
131 #include "semtest.h"
\r
133 #include "lcd_message.h"
\r
134 #include "bitmap.h"
\r
135 #include "GenQTest.h"
\r
137 #include "recmutex.h"
\r
138 #include "IntQueue.h"
\r
140 /*-----------------------------------------------------------*/
\r
142 /* The time between cycles of the 'check' functionality (defined within the
\r
144 #define mainCHECK_DELAY ( ( portTickType ) 5000 / portTICK_RATE_MS )
\r
146 /* Size of the stack allocated to the uIP task. */
\r
147 #define mainBASIC_WEB_STACK_SIZE ( configMINIMAL_STACK_SIZE * 3 )
\r
149 /* The OLED task uses the sprintf function so requires a little more stack too. */
\r
150 #define mainOLED_TASK_STACK_SIZE ( configMINIMAL_STACK_SIZE + 50 )
\r
152 /* Task priorities. */
\r
153 #define mainQUEUE_POLL_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
154 #define mainCHECK_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
155 #define mainSEM_TEST_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
156 #define mainBLOCK_Q_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
157 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
158 #define mainINTEGER_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
159 #define mainGEN_QUEUE_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
161 /* The maximum number of message that can be waiting for display at any one
\r
163 #define mainOLED_QUEUE_SIZE ( 3 )
\r
165 /* Dimensions the buffer into which the jitter time is written. */
\r
166 #define mainMAX_MSG_LEN 25
\r
168 /* The period of the system clock in nano seconds. This is used to calculate
\r
169 the jitter time in nano seconds. */
\r
170 #define mainNS_PER_CLOCK ( ( unsigned portLONG ) ( ( 1.0 / ( double ) configCPU_CLOCK_HZ ) * 1000000000.0 ) )
\r
172 /* Constants used when writing strings to the display. */
\r
173 #define mainCHARACTER_HEIGHT ( 9 )
\r
174 #define mainMAX_ROWS_128 ( mainCHARACTER_HEIGHT * 14 )
\r
175 #define mainMAX_ROWS_96 ( mainCHARACTER_HEIGHT * 10 )
\r
176 #define mainMAX_ROWS_64 ( mainCHARACTER_HEIGHT * 7 )
\r
177 #define mainFULL_SCALE ( 15 )
\r
178 #define ulSSI_FREQUENCY ( 3500000UL )
\r
180 /*-----------------------------------------------------------*/
\r
183 * The task that handles the uIP stack. All TCP/IP processing is performed in
\r
186 extern void vuIP_Task( void *pvParameters );
\r
189 * The display is written two by more than one task so is controlled by a
\r
190 * 'gatekeeper' task. This is the only task that is actually permitted to
\r
191 * access the display directly. Other tasks wanting to display a message send
\r
192 * the message to the gatekeeper.
\r
194 static void vOLEDTask( void *pvParameters );
\r
197 * Configure the hardware for the demo.
\r
199 static void prvSetupHardware( void );
\r
202 * Configures the high frequency timers - those used to measure the timing
\r
203 * jitter while the real time kernel is executing.
\r
205 extern void vSetupHighFrequencyTimer( void );
\r
208 * Hook functions that can get called by the kernel.
\r
210 void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed portCHAR *pcTaskName );
\r
211 void vApplicationTickHook( void );
\r
214 /*-----------------------------------------------------------*/
\r
216 /* The queue used to send messages to the OLED task. */
\r
217 xQueueHandle xOLEDQueue;
\r
219 /* The welcome text. */
\r
220 const portCHAR * const pcWelcomeMessage = " www.FreeRTOS.org";
\r
222 /*-----------------------------------------------------------*/
\r
225 /*************************************************************************
\r
226 * Please ensure to read http://www.freertos.org/portlm3sx965.html
\r
227 * which provides information on configuring and running this demo for the
\r
228 * various Luminary Micro EKs.
\r
229 *************************************************************************/
\r
232 prvSetupHardware();
\r
234 /* Create the queue used by the OLED task. Messages for display on the OLED
\r
235 are received via this queue. */
\r
236 xOLEDQueue = xQueueCreate( mainOLED_QUEUE_SIZE, sizeof( xOLEDMessage ) );
\r
238 /* Start the standard demo tasks. */
\r
239 vStartIntegerMathTasks( mainINTEGER_TASK_PRIORITY );
\r
240 vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );
\r
241 vStartInterruptQueueTasks();
\r
242 vStartRecursiveMutexTasks();
\r
243 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
244 vCreateBlockTimeTasks();
\r
245 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
246 vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );
\r
247 vStartQueuePeekTasks();
\r
249 /* Exclude some tasks if using the kickstart version to ensure we stay within
\r
250 the 32K code size limit. */
\r
251 #if mainINCLUDE_WEB_SERVER != 0
\r
253 /* Create the uIP task if running on a processor that includes a MAC and
\r
255 if( SysCtlPeripheralPresent( SYSCTL_PERIPH_ETH ) )
\r
257 xTaskCreate( vuIP_Task, ( signed portCHAR * ) "uIP", mainBASIC_WEB_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY - 1, NULL );
\r
264 /* Start the tasks defined within this file/specific to this demo. */
\r
265 xTaskCreate( vOLEDTask, ( signed portCHAR * ) "OLED", mainOLED_TASK_STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );
\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
272 /* Configure the high frequency interrupt used to measure the interrupt
\r
274 vSetupHighFrequencyTimer();
\r
276 /* Start the scheduler. */
\r
277 vTaskStartScheduler();
\r
279 /* Will only get here if there was insufficient memory to create the idle
\r
283 /*-----------------------------------------------------------*/
\r
285 void prvSetupHardware( void )
\r
287 /* If running on Rev A2 silicon, turn the LDO voltage up to 2.75V. This is
\r
288 a workaround to allow the PLL to operate reliably. */
\r
289 if( DEVICE_IS_REVA2 )
\r
291 SysCtlLDOSet( SYSCTL_LDO_2_75V );
\r
294 /* Set the clocking to run from the PLL at 50 MHz */
\r
295 SysCtlClockSet( SYSCTL_SYSDIV_4 | SYSCTL_USE_PLL | SYSCTL_OSC_MAIN | SYSCTL_XTAL_8MHZ );
\r
297 /* Enable Port F for Ethernet LEDs
\r
299 LED1 Bit 2 Output */
\r
300 SysCtlPeripheralEnable( SYSCTL_PERIPH_GPIOF );
\r
301 GPIODirModeSet( GPIO_PORTF_BASE, (GPIO_PIN_2 | GPIO_PIN_3), GPIO_DIR_MODE_HW );
\r
302 GPIOPadConfigSet( GPIO_PORTF_BASE, (GPIO_PIN_2 | GPIO_PIN_3 ), GPIO_STRENGTH_2MA, GPIO_PIN_TYPE_STD );
\r
304 vParTestInitialise();
\r
306 /*-----------------------------------------------------------*/
\r
308 void vApplicationTickHook( void )
\r
310 static xOLEDMessage xMessage = { "PASS" };
\r
311 static unsigned portLONG ulTicksSinceLastDisplay = 0;
\r
312 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;
\r
314 /* Called from every tick interrupt. Have enough ticks passed to make it
\r
315 time to perform our health status check again? */
\r
316 ulTicksSinceLastDisplay++;
\r
317 if( ulTicksSinceLastDisplay >= mainCHECK_DELAY )
\r
319 ulTicksSinceLastDisplay = 0;
\r
321 /* Has an error been found in any task? */
\r
322 if( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
324 xMessage.pcMessage = "ERROR IN GEN Q";
\r
326 else if( xIsCreateTaskStillRunning() != pdTRUE )
\r
328 xMessage.pcMessage = "ERROR IN CREATE";
\r
330 else if( xAreIntegerMathsTaskStillRunning() != pdTRUE )
\r
332 xMessage.pcMessage = "ERROR IN MATH";
\r
334 else if( xAreIntQueueTasksStillRunning() != pdTRUE )
\r
336 xMessage.pcMessage = "ERROR IN INT QUEUE";
\r
338 else if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
340 xMessage.pcMessage = "ERROR IN BLOCK Q";
\r
342 else if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
344 xMessage.pcMessage = "ERROR IN BLOCK TIME";
\r
346 else if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
348 xMessage.pcMessage = "ERROR IN SEMAPHORE";
\r
350 else if( xArePollingQueuesStillRunning() != pdTRUE )
\r
352 xMessage.pcMessage = "ERROR IN POLL Q";
\r
354 else if( xAreQueuePeekTasksStillRunning() != pdTRUE )
\r
356 xMessage.pcMessage = "ERROR IN PEEK Q";
\r
358 else if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
360 xMessage.pcMessage = "ERROR IN REC MUTEX";
\r
363 /* Send the message to the OLED gatekeeper for display. */
\r
364 xHigherPriorityTaskWoken = pdFALSE;
\r
365 xQueueSendFromISR( xOLEDQueue, &xMessage, &xHigherPriorityTaskWoken );
\r
368 /*-----------------------------------------------------------*/
\r
370 void vOLEDTask( void *pvParameters )
\r
372 xOLEDMessage xMessage;
\r
373 unsigned portLONG ulY, ulMaxY;
\r
374 static portCHAR cMessage[ mainMAX_MSG_LEN ];
\r
375 extern volatile unsigned portLONG ulMaxJitter;
\r
376 unsigned portBASE_TYPE uxUnusedStackOnEntry;
\r
377 const unsigned portCHAR *pucImage;
\r
379 /* Functions to access the OLED. The one used depends on the dev kit
\r
381 void ( *vOLEDInit )( unsigned portLONG ) = NULL;
\r
382 void ( *vOLEDStringDraw )( const portCHAR *, unsigned portLONG, unsigned portLONG, unsigned portCHAR ) = NULL;
\r
383 void ( *vOLEDImageDraw )( const unsigned portCHAR *, unsigned portLONG, unsigned portLONG, unsigned portLONG, unsigned portLONG ) = NULL;
\r
384 void ( *vOLEDClear )( void ) = NULL;
\r
386 /* Just for demo purposes. */
\r
387 uxUnusedStackOnEntry = uxTaskGetStackHighWaterMark( NULL );
\r
389 /* Map the OLED access functions to the driver functions that are appropriate
\r
390 for the evaluation kit being used. */
\r
391 switch( HWREG( SYSCTL_DID1 ) & SYSCTL_DID1_PRTNO_MASK )
\r
393 case SYSCTL_DID1_PRTNO_6965 :
\r
394 case SYSCTL_DID1_PRTNO_2965 : vOLEDInit = OSRAM128x64x4Init;
\r
395 vOLEDStringDraw = OSRAM128x64x4StringDraw;
\r
396 vOLEDImageDraw = OSRAM128x64x4ImageDraw;
\r
397 vOLEDClear = OSRAM128x64x4Clear;
\r
398 ulMaxY = mainMAX_ROWS_64;
\r
399 pucImage = pucBasicBitmap;
\r
402 case SYSCTL_DID1_PRTNO_1968 :
\r
403 case SYSCTL_DID1_PRTNO_8962 : vOLEDInit = RIT128x96x4Init;
\r
404 vOLEDStringDraw = RIT128x96x4StringDraw;
\r
405 vOLEDImageDraw = RIT128x96x4ImageDraw;
\r
406 vOLEDClear = RIT128x96x4Clear;
\r
407 ulMaxY = mainMAX_ROWS_96;
\r
408 pucImage = pucBasicBitmap;
\r
411 default : vOLEDInit = vFormike128x128x16Init;
\r
412 vOLEDStringDraw = vFormike128x128x16StringDraw;
\r
413 vOLEDImageDraw = vFormike128x128x16ImageDraw;
\r
414 vOLEDClear = vFormike128x128x16Clear;
\r
415 ulMaxY = mainMAX_ROWS_128;
\r
416 pucImage = pucGrLibBitmap;
\r
423 /* Initialise the OLED and display a startup message. */
\r
424 vOLEDInit( ulSSI_FREQUENCY );
\r
425 vOLEDStringDraw( "POWERED BY FreeRTOS", 0, 0, mainFULL_SCALE );
\r
426 vOLEDImageDraw( pucImage, 0, mainCHARACTER_HEIGHT + 1, bmpBITMAP_WIDTH, bmpBITMAP_HEIGHT );
\r
430 /* Wait for a message to arrive that requires displaying. */
\r
431 xQueueReceive( xOLEDQueue, &xMessage, portMAX_DELAY );
\r
433 /* Write the message on the next available row. */
\r
434 ulY += mainCHARACTER_HEIGHT;
\r
435 if( ulY >= ulMaxY )
\r
437 ulY = mainCHARACTER_HEIGHT;
\r
439 vOLEDStringDraw( pcWelcomeMessage, 0, 0, mainFULL_SCALE );
\r
442 /* Display the message along with the maximum jitter time from the
\r
443 high priority time test. */
\r
444 sprintf( cMessage, "%s [%uns]", xMessage.pcMessage, ulMaxJitter * mainNS_PER_CLOCK );
\r
445 vOLEDStringDraw( cMessage, 0, ulY, mainFULL_SCALE );
\r
448 /*-----------------------------------------------------------*/
\r
450 void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed portCHAR *pcTaskName )
\r
453 ( void ) pcTaskName;
\r