2 FreeRTOS V7.4.1 - Copyright (C) 2013 Real Time Engineers Ltd.
\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
7 ***************************************************************************
\r
9 * FreeRTOS tutorial books are available in pdf and paperback. *
\r
10 * Complete, revised, and edited pdf reference manuals are also *
\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
20 * >>> See http://www.FreeRTOS.org/Documentation for details. <<< *
\r
22 * Thank you for using FreeRTOS, and thank you for your support! *
\r
24 ***************************************************************************
\r
27 This file is part of the FreeRTOS distribution.
\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
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
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 it can 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
49 ***************************************************************************
\r
51 * Having a problem? Start by reading the FAQ "My application does *
\r
52 * not run, what could be wrong?" *
\r
54 * http://www.FreeRTOS.org/FAQHelp.html *
\r
56 ***************************************************************************
\r
59 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
60 license and Real Time Engineers Ltd. contact details.
\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
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
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
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
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
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
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
104 * "uIP" task - This is the task that handles the uIP stack. All TCP/IP
\r
105 * processing is performed in this task.
\r
111 /*************************************************************************
\r
112 * Please ensure to read http://www.freertos.org/portlm3sx965.html
\r
113 * which provides information on configuring and running this demo for the
\r
114 * various Luminary Micro EKs.
\r
115 *************************************************************************/
\r
117 /* Set the following option to 1 to include the WEB server in the build. By
\r
118 default the WEB server is excluded to keep the compiled code size under the 32K
\r
119 limit imposed by the KickStart version of the IAR compiler. The graphics
\r
120 libraries take up a lot of ROM space, hence including the graphics libraries
\r
121 and the TCP/IP stack together cannot be accommodated with the 32K size limit. */
\r
122 #define mainINCLUDE_WEB_SERVER 0
\r
125 /* Standard includes. */
\r
127 #include <string.h>
\r
129 /* Scheduler includes. */
\r
130 #include "FreeRTOS.h"
\r
133 #include "semphr.h"
\r
135 /* Hardware library includes. */
\r
136 #include "hw_memmap.h"
\r
137 #include "hw_types.h"
\r
138 #include "hw_sysctl.h"
\r
139 #include "sysctl.h"
\r
142 #include "rit128x96x4.h"
\r
143 #include "osram128x64x4.h"
\r
144 #include "formike128x128x16.h"
\r
146 /* Demo app includes. */
\r
147 #include "BlockQ.h"
\r
149 #include "integer.h"
\r
150 #include "blocktim.h"
\r
152 #include "partest.h"
\r
153 #include "semtest.h"
\r
155 #include "lcd_message.h"
\r
156 #include "bitmap.h"
\r
157 #include "GenQTest.h"
\r
159 #include "recmutex.h"
\r
160 #include "IntQueue.h"
\r
161 #include "QueueSet.h"
\r
163 /*-----------------------------------------------------------*/
\r
165 /* The time between cycles of the 'check' functionality (defined within the
\r
167 #define mainCHECK_DELAY ( ( portTickType ) 5000 / portTICK_RATE_MS )
\r
169 /* Size of the stack allocated to the uIP task. */
\r
170 #define mainBASIC_WEB_STACK_SIZE ( configMINIMAL_STACK_SIZE * 3 )
\r
172 /* The OLED task uses the sprintf function so requires a little more stack too. */
\r
173 #define mainOLED_TASK_STACK_SIZE ( configMINIMAL_STACK_SIZE + 50 )
\r
175 /* Task priorities. */
\r
176 #define mainQUEUE_POLL_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
177 #define mainCHECK_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
178 #define mainSEM_TEST_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
179 #define mainBLOCK_Q_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
180 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
181 #define mainINTEGER_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
182 #define mainGEN_QUEUE_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
184 /* The maximum number of message that can be waiting for display at any one
\r
186 #define mainOLED_QUEUE_SIZE ( 3 )
\r
188 /* Dimensions the buffer into which the jitter time is written. */
\r
189 #define mainMAX_MSG_LEN 25
\r
191 /* The period of the system clock in nano seconds. This is used to calculate
\r
192 the jitter time in nano seconds. */
\r
193 #define mainNS_PER_CLOCK ( ( unsigned portLONG ) ( ( 1.0 / ( double ) configCPU_CLOCK_HZ ) * 1000000000.0 ) )
\r
195 /* Constants used when writing strings to the display. */
\r
196 #define mainCHARACTER_HEIGHT ( 9 )
\r
197 #define mainMAX_ROWS_128 ( mainCHARACTER_HEIGHT * 14 )
\r
198 #define mainMAX_ROWS_96 ( mainCHARACTER_HEIGHT * 10 )
\r
199 #define mainMAX_ROWS_64 ( mainCHARACTER_HEIGHT * 7 )
\r
200 #define mainFULL_SCALE ( 15 )
\r
201 #define ulSSI_FREQUENCY ( 3500000UL )
\r
203 /*-----------------------------------------------------------*/
\r
206 * The task that handles the uIP stack. All TCP/IP processing is performed in
\r
209 extern void vuIP_Task( void *pvParameters );
\r
212 * The display is written two by more than one task so is controlled by a
\r
213 * 'gatekeeper' task. This is the only task that is actually permitted to
\r
214 * access the display directly. Other tasks wanting to display a message send
\r
215 * the message to the gatekeeper.
\r
217 static void vOLEDTask( void *pvParameters );
\r
220 * Configure the hardware for the demo.
\r
222 static void prvSetupHardware( void );
\r
225 * Configures the high frequency timers - those used to measure the timing
\r
226 * jitter while the real time kernel is executing.
\r
228 extern void vSetupHighFrequencyTimer( void );
\r
231 * Hook functions that can get called by the kernel.
\r
233 void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed portCHAR *pcTaskName );
\r
234 void vApplicationTickHook( void );
\r
237 /*-----------------------------------------------------------*/
\r
239 /* The queue used to send messages to the OLED task. */
\r
240 xQueueHandle xOLEDQueue;
\r
242 /* The welcome text. */
\r
243 const portCHAR * const pcWelcomeMessage = " www.FreeRTOS.org";
\r
245 /*-----------------------------------------------------------*/
\r
248 /*************************************************************************
\r
249 * Please ensure to read http://www.freertos.org/portlm3sx965.html
\r
250 * which provides information on configuring and running this demo for the
\r
251 * various Luminary Micro EKs.
\r
252 *************************************************************************/
\r
255 prvSetupHardware();
\r
257 /* Create the queue used by the OLED task. Messages for display on the OLED
\r
258 are received via this queue. */
\r
259 xOLEDQueue = xQueueCreate( mainOLED_QUEUE_SIZE, sizeof( xOLEDMessage ) );
\r
261 /* Start the standard demo tasks. */
\r
262 vStartIntegerMathTasks( mainINTEGER_TASK_PRIORITY );
\r
263 vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );
\r
264 vStartInterruptQueueTasks();
\r
265 vStartRecursiveMutexTasks();
\r
266 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
267 vCreateBlockTimeTasks();
\r
268 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
269 vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );
\r
270 vStartQueuePeekTasks();
\r
271 vStartQueueSetTasks();
\r
273 /* Exclude some tasks if using the kickstart version to ensure we stay within
\r
274 the 32K code size limit. */
\r
275 #if mainINCLUDE_WEB_SERVER != 0
\r
277 /* Create the uIP task if running on a processor that includes a MAC and
\r
279 if( SysCtlPeripheralPresent( SYSCTL_PERIPH_ETH ) )
\r
281 xTaskCreate( vuIP_Task, ( signed portCHAR * ) "uIP", mainBASIC_WEB_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY - 1, NULL );
\r
288 /* Start the tasks defined within this file/specific to this demo. */
\r
289 xTaskCreate( vOLEDTask, ( signed portCHAR * ) "OLED", mainOLED_TASK_STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );
\r
291 /* The suicide tasks must be created last as they need to know how many
\r
292 tasks were running prior to their creation in order to ascertain whether
\r
293 or not the correct/expected number of tasks are running at any given time. */
\r
294 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
296 /* Configure the high frequency interrupt used to measure the interrupt
\r
298 vSetupHighFrequencyTimer();
\r
300 /* Start the scheduler. */
\r
301 vTaskStartScheduler();
\r
303 /* Will only get here if there was insufficient memory to create the idle
\r
307 /*-----------------------------------------------------------*/
\r
309 void prvSetupHardware( void )
\r
311 /* If running on Rev A2 silicon, turn the LDO voltage up to 2.75V. This is
\r
312 a workaround to allow the PLL to operate reliably. */
\r
313 if( DEVICE_IS_REVA2 )
\r
315 SysCtlLDOSet( SYSCTL_LDO_2_75V );
\r
318 /* Set the clocking to run from the PLL at 50 MHz */
\r
319 SysCtlClockSet( SYSCTL_SYSDIV_4 | SYSCTL_USE_PLL | SYSCTL_OSC_MAIN | SYSCTL_XTAL_8MHZ );
\r
321 /* Enable Port F for Ethernet LEDs
\r
323 LED1 Bit 2 Output */
\r
324 SysCtlPeripheralEnable( SYSCTL_PERIPH_GPIOF );
\r
325 GPIODirModeSet( GPIO_PORTF_BASE, (GPIO_PIN_2 | GPIO_PIN_3), GPIO_DIR_MODE_HW );
\r
326 GPIOPadConfigSet( GPIO_PORTF_BASE, (GPIO_PIN_2 | GPIO_PIN_3 ), GPIO_STRENGTH_2MA, GPIO_PIN_TYPE_STD );
\r
328 vParTestInitialise();
\r
330 /*-----------------------------------------------------------*/
\r
332 void vApplicationTickHook( void )
\r
334 static xOLEDMessage xMessage = { "PASS" };
\r
335 static unsigned portLONG ulTicksSinceLastDisplay = 0;
\r
336 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;
\r
338 /* Called from every tick interrupt. Have enough ticks passed to make it
\r
339 time to perform our health status check again? */
\r
340 ulTicksSinceLastDisplay++;
\r
341 if( ulTicksSinceLastDisplay >= mainCHECK_DELAY )
\r
343 ulTicksSinceLastDisplay = 0;
\r
345 /* Has an error been found in any task? */
\r
346 if( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
348 xMessage.pcMessage = "ERROR IN GEN Q";
\r
350 else if( xIsCreateTaskStillRunning() != pdTRUE )
\r
352 xMessage.pcMessage = "ERROR IN CREATE";
\r
354 else if( xAreIntegerMathsTaskStillRunning() != pdTRUE )
\r
356 xMessage.pcMessage = "ERROR IN MATH";
\r
358 else if( xAreIntQueueTasksStillRunning() != pdTRUE )
\r
360 xMessage.pcMessage = "ERROR IN INT QUEUE";
\r
362 else if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
364 xMessage.pcMessage = "ERROR IN BLOCK Q";
\r
366 else if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
368 xMessage.pcMessage = "ERROR IN BLOCK TIME";
\r
370 else if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
372 xMessage.pcMessage = "ERROR IN SEMAPHORE";
\r
374 else if( xArePollingQueuesStillRunning() != pdTRUE )
\r
376 xMessage.pcMessage = "ERROR IN POLL Q";
\r
378 else if( xAreQueuePeekTasksStillRunning() != pdTRUE )
\r
380 xMessage.pcMessage = "ERROR IN PEEK Q";
\r
382 else if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
384 xMessage.pcMessage = "ERROR IN REC MUTEX";
\r
386 else if( xAreQueueSetTasksStillRunning() != pdPASS )
\r
388 xMessage.pcMessage = "ERROR IN Q SET";
\r
391 configASSERT( strcmp( ( const char * ) xMessage.pcMessage, "PASS" ) == 0 );
\r
393 /* Send the message to the OLED gatekeeper for display. */
\r
394 xHigherPriorityTaskWoken = pdFALSE;
\r
395 xQueueSendFromISR( xOLEDQueue, &xMessage, &xHigherPriorityTaskWoken );
\r
398 /* Write to a queue that is in use as part of the queue set demo to
\r
399 demonstrate using queue sets from an ISR. */
\r
400 vQueueSetAccessQueueSetFromISR();
\r
402 /*-----------------------------------------------------------*/
\r
404 void vOLEDTask( void *pvParameters )
\r
406 xOLEDMessage xMessage;
\r
407 unsigned portLONG ulY, ulMaxY;
\r
408 static portCHAR cMessage[ mainMAX_MSG_LEN ];
\r
409 extern volatile unsigned portLONG ulMaxJitter;
\r
410 const unsigned portCHAR *pucImage;
\r
412 /* Functions to access the OLED. The one used depends on the dev kit
\r
414 void ( *vOLEDInit )( unsigned portLONG ) = NULL;
\r
415 void ( *vOLEDStringDraw )( const portCHAR *, unsigned portLONG, unsigned portLONG, unsigned portCHAR ) = NULL;
\r
416 void ( *vOLEDImageDraw )( const unsigned portCHAR *, unsigned portLONG, unsigned portLONG, unsigned portLONG, unsigned portLONG ) = NULL;
\r
417 void ( *vOLEDClear )( void ) = NULL;
\r
419 /* Map the OLED access functions to the driver functions that are appropriate
\r
420 for the evaluation kit being used. */
\r
421 switch( HWREG( SYSCTL_DID1 ) & SYSCTL_DID1_PRTNO_MASK )
\r
423 case SYSCTL_DID1_PRTNO_6965 :
\r
424 case SYSCTL_DID1_PRTNO_2965 : vOLEDInit = OSRAM128x64x4Init;
\r
425 vOLEDStringDraw = OSRAM128x64x4StringDraw;
\r
426 vOLEDImageDraw = OSRAM128x64x4ImageDraw;
\r
427 vOLEDClear = OSRAM128x64x4Clear;
\r
428 ulMaxY = mainMAX_ROWS_64;
\r
429 pucImage = pucBasicBitmap;
\r
432 case SYSCTL_DID1_PRTNO_1968 :
\r
433 case SYSCTL_DID1_PRTNO_8962 : vOLEDInit = RIT128x96x4Init;
\r
434 vOLEDStringDraw = RIT128x96x4StringDraw;
\r
435 vOLEDImageDraw = RIT128x96x4ImageDraw;
\r
436 vOLEDClear = RIT128x96x4Clear;
\r
437 ulMaxY = mainMAX_ROWS_96;
\r
438 pucImage = pucBasicBitmap;
\r
441 default : vOLEDInit = vFormike128x128x16Init;
\r
442 vOLEDStringDraw = vFormike128x128x16StringDraw;
\r
443 vOLEDImageDraw = vFormike128x128x16ImageDraw;
\r
444 vOLEDClear = vFormike128x128x16Clear;
\r
445 ulMaxY = mainMAX_ROWS_128;
\r
446 pucImage = pucGrLibBitmap;
\r
453 /* Initialise the OLED and display a startup message. */
\r
454 vOLEDInit( ulSSI_FREQUENCY );
\r
455 vOLEDStringDraw( "POWERED BY FreeRTOS", 0, 0, mainFULL_SCALE );
\r
456 vOLEDImageDraw( pucImage, 0, mainCHARACTER_HEIGHT + 1, bmpBITMAP_WIDTH, bmpBITMAP_HEIGHT );
\r
460 /* Wait for a message to arrive that requires displaying. */
\r
461 xQueueReceive( xOLEDQueue, &xMessage, portMAX_DELAY );
\r
463 /* Write the message on the next available row. */
\r
464 ulY += mainCHARACTER_HEIGHT;
\r
465 if( ulY >= ulMaxY )
\r
467 ulY = mainCHARACTER_HEIGHT;
\r
469 vOLEDStringDraw( pcWelcomeMessage, 0, 0, mainFULL_SCALE );
\r
472 /* Display the message along with the maximum jitter time from the
\r
473 high priority time test. */
\r
474 sprintf( cMessage, "%s [%uns]", xMessage.pcMessage, ulMaxJitter * mainNS_PER_CLOCK );
\r
475 vOLEDStringDraw( cMessage, 0, ulY, mainFULL_SCALE );
\r
478 /*-----------------------------------------------------------*/
\r
480 void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed portCHAR *pcTaskName )
\r
483 ( void ) pcTaskName;
\r
487 /*-----------------------------------------------------------*/
\r
489 void vAssertCalled( const char *pcFile, unsigned long ulLine )
\r
491 volatile unsigned long ulSetTo1InDebuggerToExit = 0;
\r
493 taskENTER_CRITICAL();
\r
495 while( ulSetTo1InDebuggerToExit == 0 )
\r
497 /* Nothing do do here. Set the loop variable to a non zero value in
\r
498 the debugger to step out of this function to the point that caused
\r
504 taskEXIT_CRITICAL();
\r