2 FreeRTOS V7.2.0 - Copyright (C) 2012 Real Time Engineers Ltd.
\r
5 ***************************************************************************
\r
7 * FreeRTOS tutorial books are available in pdf and paperback. *
\r
8 * Complete, revised, and edited pdf reference manuals are also *
\r
11 * Purchasing FreeRTOS documentation will not only help you, by *
\r
12 * ensuring you get running as quickly as possible and with an *
\r
13 * in-depth knowledge of how to use FreeRTOS, it will also help *
\r
14 * the FreeRTOS project to continue with its mission of providing *
\r
15 * professional grade, cross platform, de facto standard solutions *
\r
16 * for microcontrollers - completely free of charge! *
\r
18 * >>> See http://www.FreeRTOS.org/Documentation for details. <<< *
\r
20 * Thank you for using FreeRTOS, and thank you for your support! *
\r
22 ***************************************************************************
\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 modification to the GPL is included to allow you to
\r
31 distribute a combined work that includes FreeRTOS without being obliged to
\r
32 provide the source code for proprietary components outside of the FreeRTOS
\r
33 kernel. FreeRTOS is distributed in the hope that it will be useful, but
\r
34 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
\r
35 or 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 ***************************************************************************
\r
46 * Having a problem? Start by reading the FAQ "My application does *
\r
47 * not run, what could be wrong? *
\r
49 * http://www.FreeRTOS.org/FAQHelp.html *
\r
51 ***************************************************************************
\r
54 http://www.FreeRTOS.org - Documentation, training, latest information,
\r
55 license and contact details.
\r
57 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
58 including FreeRTOS+Trace - an indispensable productivity tool.
\r
60 Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell
\r
61 the code with commercial support, indemnification, and middleware, under
\r
62 the OpenRTOS brand: http://www.OpenRTOS.com. High Integrity Systems also
\r
63 provide a safety engineered and independently SIL3 certified version under
\r
64 the SafeRTOS brand: http://www.SafeRTOS.com.
\r
69 * Creates all the demo application tasks, then starts the scheduler. The WEB
\r
70 * documentation provides more details of the standard demo application tasks.
\r
71 * In addition to the standard demo tasks, the following tasks and tests are
\r
72 * defined and/or created within this file:
\r
74 * "Fast Interrupt Test" - A high frequency periodic interrupt is generated
\r
75 * using a free running timer to demonstrate the use of the
\r
76 * configKERNEL_INTERRUPT_PRIORITY configuration constant. The interrupt
\r
77 * service routine measures the number of processor clocks that occur between
\r
78 * each interrupt - and in so doing measures the jitter in the interrupt timing.
\r
79 * The maximum measured jitter time is latched in the ulMaxJitter variable, and
\r
80 * displayed on the OLED display by the 'OLED' task as described below. The
\r
81 * fast interrupt is configured and handled in the timertest.c source file.
\r
83 * "OLED" task - the OLED task is a 'gatekeeper' task. It is the only task that
\r
84 * is permitted to access the display directly. Other tasks wishing to write a
\r
85 * message to the OLED send the message on a queue to the OLED task instead of
\r
86 * accessing the OLED themselves. The OLED task just blocks on the queue waiting
\r
87 * for messages - waking and displaying the messages as they arrive.
\r
89 * "Check" hook - This only executes every five seconds from the tick hook.
\r
90 * Its main function is to check that all the standard demo tasks are still
\r
91 * operational. Should any unexpected behaviour within a demo task be discovered
\r
92 * the tick hook will write an error to the OLED (via the OLED task). If all the
\r
93 * demo tasks are executing with their expected behaviour then the check task
\r
94 * writes PASS to the OLED (again via the OLED task), as described above.
\r
96 * "uIP" task - This is the task that handles the uIP stack. All TCP/IP
\r
97 * processing is performed in this task.
\r
103 /*************************************************************************
\r
104 * Please ensure to read http://www.freertos.org/portLM3Sxxxx_Eclipse.html
\r
105 * which provides information on configuring and running this demo for the
\r
106 * various Luminary Micro EKs.
\r
107 *************************************************************************/
\r
112 /* Standard includes. */
\r
115 /* Scheduler includes. */
\r
116 #include "FreeRTOS.h"
\r
119 #include "semphr.h"
\r
121 /* Hardware library includes. */
\r
122 #include "hw_memmap.h"
\r
123 #include "hw_types.h"
\r
124 #include "hw_sysctl.h"
\r
125 #include "sysctl.h"
\r
128 #include "rit128x96x4.h"
\r
129 #include "osram128x64x4.h"
\r
130 #include "formike128x128x16.h"
\r
132 /* Demo app includes. */
\r
133 #include "BlockQ.h"
\r
135 #include "integer.h"
\r
136 #include "blocktim.h"
\r
138 #include "partest.h"
\r
139 #include "semtest.h"
\r
141 #include "lcd_message.h"
\r
142 #include "bitmap.h"
\r
143 #include "GenQTest.h"
\r
145 #include "recmutex.h"
\r
146 #include "IntQueue.h"
\r
148 /*-----------------------------------------------------------*/
\r
150 /* The time between cycles of the 'check' functionality (defined within the
\r
152 #define mainCHECK_DELAY ( ( portTickType ) 5000 / portTICK_RATE_MS )
\r
154 /* Size of the stack allocated to the uIP task. */
\r
155 #define mainBASIC_WEB_STACK_SIZE ( configMINIMAL_STACK_SIZE * 3 )
\r
157 /* The OLED task uses the sprintf function so requires a little more stack too. */
\r
158 #define mainOLED_TASK_STACK_SIZE ( configMINIMAL_STACK_SIZE + 50 )
\r
160 /* Task priorities. */
\r
161 #define mainQUEUE_POLL_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
162 #define mainCHECK_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
163 #define mainSEM_TEST_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
164 #define mainBLOCK_Q_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
165 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
166 #define mainINTEGER_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
167 #define mainGEN_QUEUE_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
169 /* The maximum number of message that can be waiting for display at any one
\r
171 #define mainOLED_QUEUE_SIZE ( 3 )
\r
173 /* Dimensions the buffer into which the jitter time is written. */
\r
174 #define mainMAX_MSG_LEN 25
\r
176 /* The period of the system clock in nano seconds. This is used to calculate
\r
177 the jitter time in nano seconds. */
\r
178 #define mainNS_PER_CLOCK ( ( unsigned long ) ( ( 1.0 / ( double ) configCPU_CLOCK_HZ ) * 1000000000.0 ) )
\r
180 /* Constants used when writing strings to the display. */
\r
181 #define mainCHARACTER_HEIGHT ( 9 )
\r
182 #define mainMAX_ROWS_128 ( mainCHARACTER_HEIGHT * 14 )
\r
183 #define mainMAX_ROWS_96 ( mainCHARACTER_HEIGHT * 10 )
\r
184 #define mainMAX_ROWS_64 ( mainCHARACTER_HEIGHT * 7 )
\r
185 #define mainFULL_SCALE ( 15 )
\r
186 #define ulSSI_FREQUENCY ( 3500000UL )
\r
188 /*-----------------------------------------------------------*/
\r
191 * The task that handles the uIP stack. All TCP/IP processing is performed in
\r
194 extern void vuIP_Task( void *pvParameters );
\r
197 * The display is written two by more than one task so is controlled by a
\r
198 * 'gatekeeper' task. This is the only task that is actually permitted to
\r
199 * access the display directly. Other tasks wanting to display a message send
\r
200 * the message to the gatekeeper.
\r
202 static void vOLEDTask( void *pvParameters );
\r
205 * Configure the hardware for the demo.
\r
207 static void prvSetupHardware( void );
\r
210 * Configures the high frequency timers - those used to measure the timing
\r
211 * jitter while the real time kernel is executing.
\r
213 extern void vSetupHighFrequencyTimer( void );
\r
216 * The idle hook is used to run a test of the scheduler context switch
\r
219 void vApplicationIdleHook( void ) __attribute__((naked));
\r
220 /*-----------------------------------------------------------*/
\r
222 /* The queue used to send messages to the OLED task. */
\r
223 xQueueHandle xOLEDQueue;
\r
225 /* The welcome text. */
\r
226 const char * const pcWelcomeMessage = " www.FreeRTOS.org";
\r
228 /* Variables used to detect the test in the idle hook failing. */
\r
229 unsigned long ulIdleError = pdFALSE;
\r
231 /*-----------------------------------------------------------*/
\r
233 /*************************************************************************
\r
234 * Please ensure to read http://www.freertos.org/portLM3Sxxxx_Eclipse.html
\r
235 * which provides information on configuring and running this demo for the
\r
236 * various Luminary Micro EKs.
\r
237 *************************************************************************/
\r
240 prvSetupHardware();
\r
242 /* Create the queue used by the OLED task. Messages for display on the OLED
\r
243 are received via this queue. */
\r
244 xOLEDQueue = xQueueCreate( mainOLED_QUEUE_SIZE, sizeof( xOLEDMessage ) );
\r
246 /* Create the uIP task if running on a processor that includes a MAC and
\r
248 if( SysCtlPeripheralPresent( SYSCTL_PERIPH_ETH ) )
\r
250 xTaskCreate( vuIP_Task, ( signed char * ) "uIP", mainBASIC_WEB_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY - 1, NULL );
\r
253 /* Start the standard demo tasks. */
\r
254 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
255 vCreateBlockTimeTasks();
\r
256 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
257 vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );
\r
258 vStartIntegerMathTasks( mainINTEGER_TASK_PRIORITY );
\r
259 vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );
\r
260 vStartQueuePeekTasks();
\r
261 vStartRecursiveMutexTasks();
\r
262 vStartInterruptQueueTasks();
\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
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
284 /*-----------------------------------------------------------*/
\r
286 void prvSetupHardware( void )
\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
292 SysCtlLDOSet( SYSCTL_LDO_2_75V );
\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
298 /* Enable Port F for Ethernet LEDs
\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
305 vParTestInitialise();
\r
307 /*-----------------------------------------------------------*/
\r
309 void vApplicationTickHook( void )
\r
311 static xOLEDMessage xMessage = { "PASS" };
\r
312 static unsigned long ulTicksSinceLastDisplay = 0;
\r
313 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;
\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
320 ulTicksSinceLastDisplay = 0;
\r
322 /* Has an error been found in any task? */
\r
323 if( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
325 xMessage.pcMessage = "ERROR IN GEN Q";
\r
327 else if( xAreQueuePeekTasksStillRunning() != pdTRUE )
\r
329 xMessage.pcMessage = "ERROR IN PEEK Q";
\r
331 else if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
333 xMessage.pcMessage = "ERROR IN BLOCK Q";
\r
335 else if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
337 xMessage.pcMessage = "ERROR IN BLOCK TIME";
\r
339 else if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
341 xMessage.pcMessage = "ERROR IN SEMAPHORE";
\r
343 else if( xArePollingQueuesStillRunning() != pdTRUE )
\r
345 xMessage.pcMessage = "ERROR IN POLL Q";
\r
347 else if( xIsCreateTaskStillRunning() != pdTRUE )
\r
349 xMessage.pcMessage = "ERROR IN CREATE";
\r
351 else if( xAreIntegerMathsTaskStillRunning() != pdTRUE )
\r
353 xMessage.pcMessage = "ERROR IN MATH";
\r
355 else if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
357 xMessage.pcMessage = "ERROR IN REC MUTEX";
\r
359 else if( ulIdleError != pdFALSE )
\r
361 xMessage.pcMessage = "ERROR IN HOOK";
\r
363 else if( xAreIntQueueTasksStillRunning() != pdTRUE )
\r
365 xMessage.pcMessage = "ERROR IN INT QUEUE";
\r
369 /* Send the message to the OLED gatekeeper for display. */
\r
370 xHigherPriorityTaskWoken = pdFALSE;
\r
371 xQueueSendFromISR( xOLEDQueue, &xMessage, &xHigherPriorityTaskWoken );
\r
374 /*-----------------------------------------------------------*/
\r
376 void vOLEDTask( void *pvParameters )
\r
378 xOLEDMessage xMessage;
\r
379 unsigned long ulY, ulMaxY;
\r
380 static char cMessage[ mainMAX_MSG_LEN ];
\r
381 extern volatile unsigned long ulMaxJitter;
\r
382 unsigned portBASE_TYPE uxUnusedStackOnEntry, uxUnusedStackNow;
\r
383 const unsigned char *pucImage;
\r
385 /* Functions to access the OLED. The one used depends on the dev kit
\r
387 void ( *vOLEDInit )( unsigned long ) = NULL;
\r
388 void ( *vOLEDStringDraw )( const char *, unsigned long, unsigned long, unsigned char ) = NULL;
\r
389 void ( *vOLEDImageDraw )( const unsigned char *, unsigned long, unsigned long, unsigned long, unsigned long ) = NULL;
\r
390 void ( *vOLEDClear )( void ) = NULL;
\r
392 /* Just for demo purposes. */
\r
393 uxUnusedStackOnEntry = uxTaskGetStackHighWaterMark( NULL );
\r
395 /* Map the OLED access functions to the driver functions that are appropriate
\r
396 for the evaluation kit being used. */
\r
397 switch( HWREG( SYSCTL_DID1 ) & SYSCTL_DID1_PRTNO_MASK )
\r
399 case SYSCTL_DID1_PRTNO_6965 :
\r
400 case SYSCTL_DID1_PRTNO_2965 : vOLEDInit = OSRAM128x64x4Init;
\r
401 vOLEDStringDraw = OSRAM128x64x4StringDraw;
\r
402 vOLEDImageDraw = OSRAM128x64x4ImageDraw;
\r
403 vOLEDClear = OSRAM128x64x4Clear;
\r
404 ulMaxY = mainMAX_ROWS_64;
\r
405 pucImage = pucBasicBitmap;
\r
408 case SYSCTL_DID1_PRTNO_1968 :
\r
409 case SYSCTL_DID1_PRTNO_8962 : vOLEDInit = RIT128x96x4Init;
\r
410 vOLEDStringDraw = RIT128x96x4StringDraw;
\r
411 vOLEDImageDraw = RIT128x96x4ImageDraw;
\r
412 vOLEDClear = RIT128x96x4Clear;
\r
413 ulMaxY = mainMAX_ROWS_96;
\r
414 pucImage = pucBasicBitmap;
\r
417 default : vOLEDInit = vFormike128x128x16Init;
\r
418 vOLEDStringDraw = vFormike128x128x16StringDraw;
\r
419 vOLEDImageDraw = vFormike128x128x16ImageDraw;
\r
420 vOLEDClear = vFormike128x128x16Clear;
\r
421 ulMaxY = mainMAX_ROWS_128;
\r
422 pucImage = pucGrLibBitmap;
\r
428 /* Initialise the OLED and display a startup message. */
\r
429 vOLEDInit( ulSSI_FREQUENCY );
\r
430 vOLEDStringDraw( "POWERED BY FreeRTOS", 0, 0, mainFULL_SCALE );
\r
431 vOLEDImageDraw( pucImage, 0, mainCHARACTER_HEIGHT + 1, bmpBITMAP_WIDTH, bmpBITMAP_HEIGHT );
\r
435 /* Wait for a message to arrive that requires displaying. */
\r
436 xQueueReceive( xOLEDQueue, &xMessage, portMAX_DELAY );
\r
438 /* Write the message on the next available row. */
\r
439 ulY += mainCHARACTER_HEIGHT;
\r
440 if( ulY >= ulMaxY )
\r
442 ulY = mainCHARACTER_HEIGHT;
\r
444 vOLEDStringDraw( pcWelcomeMessage, 0, 0, mainFULL_SCALE );
\r
447 /* Display the message along with the maximum jitter time from the
\r
448 high priority time test. */
\r
449 sprintf( cMessage, "%s [%uns]", xMessage.pcMessage, ulMaxJitter * mainNS_PER_CLOCK );
\r
450 vOLEDStringDraw( cMessage, 0, ulY, mainFULL_SCALE );
\r
453 /*-----------------------------------------------------------*/
\r
455 void vApplicationStackOverflowHook( xTaskHandle pxTask, signed char *pcTaskName )
\r
459 /*-----------------------------------------------------------*/
\r
461 void vApplicationMallocFailedHook( void )
\r
465 /*-----------------------------------------------------------*/
\r
467 /* Just to keep the linker happy. */
\r
468 void __error__( char *pcFilename, unsigned long ulLine )
\r
473 int uipprintf( const char *fmt, ... )
\r