2 FreeRTOS V8.2.2 - Copyright (C) 2015 Real Time Engineers Ltd.
\r
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 This file is part of the FreeRTOS distribution.
\r
9 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
10 the terms of the GNU General Public License (version 2) as published by the
\r
11 Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.
\r
13 ***************************************************************************
\r
14 >>! NOTE: The modification to the GPL is included to allow you to !<<
\r
15 >>! distribute a combined work that includes FreeRTOS without being !<<
\r
16 >>! obliged to provide the source code for proprietary components !<<
\r
17 >>! outside of the FreeRTOS kernel. !<<
\r
18 ***************************************************************************
\r
20 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
21 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
22 FOR A PARTICULAR PURPOSE. Full license text is available on the following
\r
23 link: http://www.freertos.org/a00114.html
\r
25 ***************************************************************************
\r
27 * FreeRTOS provides completely free yet professionally developed, *
\r
28 * robust, strictly quality controlled, supported, and cross *
\r
29 * platform software that is more than just the market leader, it *
\r
30 * is the industry's de facto standard. *
\r
32 * Help yourself get started quickly while simultaneously helping *
\r
33 * to support the FreeRTOS project by purchasing a FreeRTOS *
\r
34 * tutorial book, reference manual, or both: *
\r
35 * http://www.FreeRTOS.org/Documentation *
\r
37 ***************************************************************************
\r
39 http://www.FreeRTOS.org/FAQHelp.html - Having a problem? Start by reading
\r
40 the FAQ page "My application does not run, what could be wrong?". Have you
\r
41 defined configASSERT()?
\r
43 http://www.FreeRTOS.org/support - In return for receiving this top quality
\r
44 embedded software for free we request you assist our global community by
\r
45 participating in the support forum.
\r
47 http://www.FreeRTOS.org/training - Investing in training allows your team to
\r
48 be as productive as possible as early as possible. Now you can receive
\r
49 FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers
\r
50 Ltd, and the world's leading authority on the world's leading RTOS.
\r
52 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
53 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
54 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
56 http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
\r
57 Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
\r
59 http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
\r
60 Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
61 licenses offer ticketed support, indemnification and commercial middleware.
\r
63 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
64 engineered and independently SIL3 certified version for use in safety and
\r
65 mission critical applications that require provable dependability.
\r
72 * Creates all the demo application tasks, then starts the scheduler. The WEB
\r
73 * documentation provides more details of the standard demo application tasks.
\r
74 * In addition to the standard demo tasks, the following tasks and tests are
\r
75 * defined and/or created within this file:
\r
77 * "Fast Interrupt Test" - A high frequency periodic interrupt is generated
\r
78 * using a free running timer to demonstrate the use of the
\r
79 * configKERNEL_INTERRUPT_PRIORITY configuration constant. The interrupt
\r
80 * service routine measures the number of processor clocks that occur between
\r
81 * each interrupt - and in so doing measures the jitter in the interrupt timing.
\r
82 * The maximum measured jitter time is latched in the ulMaxJitter variable, and
\r
83 * displayed on the OLED display by the 'OLED' task as described below. The
\r
84 * fast interrupt is configured and handled in the timertest.c source file.
\r
86 * "OLED" task - the OLED task is a 'gatekeeper' task. It is the only task that
\r
87 * is permitted to access the display directly. Other tasks wishing to write a
\r
88 * message to the OLED send the message on a queue to the OLED task instead of
\r
89 * accessing the OLED themselves. The OLED task just blocks on the queue waiting
\r
90 * for messages - waking and displaying the messages as they arrive.
\r
92 * "Check" hook - This only executes every five seconds from the tick hook.
\r
93 * Its main function is to check that all the standard demo tasks are still
\r
94 * operational. Should any unexpected behaviour within a demo task be discovered
\r
95 * the tick hook will write an error to the OLED (via the OLED task). If all the
\r
96 * demo tasks are executing with their expected behaviour then the check task
\r
97 * writes PASS to the OLED (again via the OLED task), as described above.
\r
99 * "uIP" task - This is the task that handles the uIP stack. All TCP/IP
\r
100 * processing is performed in this task.
\r
106 /*************************************************************************
\r
107 * Please ensure to read http://www.freertos.org/portLM3Sxxxx_Eclipse.html
\r
108 * which provides information on configuring and running this demo for the
\r
109 * various Luminary Micro EKs.
\r
110 *************************************************************************/
\r
115 /* Standard includes. */
\r
118 /* Scheduler includes. */
\r
119 #include "FreeRTOS.h"
\r
122 #include "semphr.h"
\r
124 /* Hardware library includes. */
\r
125 #include "hw_memmap.h"
\r
126 #include "hw_types.h"
\r
127 #include "hw_sysctl.h"
\r
128 #include "sysctl.h"
\r
131 #include "rit128x96x4.h"
\r
132 #include "osram128x64x4.h"
\r
133 #include "formike128x128x16.h"
\r
135 /* Demo app includes. */
\r
136 #include "BlockQ.h"
\r
138 #include "integer.h"
\r
139 #include "blocktim.h"
\r
141 #include "partest.h"
\r
142 #include "semtest.h"
\r
144 #include "lcd_message.h"
\r
145 #include "bitmap.h"
\r
146 #include "GenQTest.h"
\r
148 #include "recmutex.h"
\r
149 #include "IntQueue.h"
\r
150 #include "QueueSet.h"
\r
152 /*-----------------------------------------------------------*/
\r
154 /* The time between cycles of the 'check' functionality (defined within the
\r
156 #define mainCHECK_DELAY ( ( TickType_t ) 5000 / portTICK_PERIOD_MS )
\r
158 /* Size of the stack allocated to the uIP task. */
\r
159 #define mainBASIC_WEB_STACK_SIZE ( configMINIMAL_STACK_SIZE * 3 )
\r
161 /* The OLED task uses the sprintf function so requires a little more stack too. */
\r
162 #define mainOLED_TASK_STACK_SIZE ( configMINIMAL_STACK_SIZE + 50 )
\r
164 /* Task priorities. */
\r
165 #define mainQUEUE_POLL_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
166 #define mainCHECK_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
167 #define mainSEM_TEST_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
168 #define mainBLOCK_Q_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
169 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
170 #define mainINTEGER_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
171 #define mainGEN_QUEUE_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
173 /* The maximum number of message that can be waiting for display at any one
\r
175 #define mainOLED_QUEUE_SIZE ( 3 )
\r
177 /* Dimensions the buffer into which the jitter time is written. */
\r
178 #define mainMAX_MSG_LEN 25
\r
180 /* The period of the system clock in nano seconds. This is used to calculate
\r
181 the jitter time in nano seconds. */
\r
182 #define mainNS_PER_CLOCK ( ( unsigned long ) ( ( 1.0 / ( double ) configCPU_CLOCK_HZ ) * 1000000000.0 ) )
\r
184 /* Constants used when writing strings to the display. */
\r
185 #define mainCHARACTER_HEIGHT ( 9 )
\r
186 #define mainMAX_ROWS_128 ( mainCHARACTER_HEIGHT * 14 )
\r
187 #define mainMAX_ROWS_96 ( mainCHARACTER_HEIGHT * 10 )
\r
188 #define mainMAX_ROWS_64 ( mainCHARACTER_HEIGHT * 7 )
\r
189 #define mainFULL_SCALE ( 15 )
\r
190 #define ulSSI_FREQUENCY ( 3500000UL )
\r
192 /*-----------------------------------------------------------*/
\r
195 * The task that handles the uIP stack. All TCP/IP processing is performed in
\r
198 extern void vuIP_Task( void *pvParameters );
\r
201 * The display is written two by more than one task so is controlled by a
\r
202 * 'gatekeeper' task. This is the only task that is actually permitted to
\r
203 * access the display directly. Other tasks wanting to display a message send
\r
204 * the message to the gatekeeper.
\r
206 static void vOLEDTask( void *pvParameters );
\r
209 * Configure the hardware for the demo.
\r
211 static void prvSetupHardware( void );
\r
214 * Configures the high frequency timers - those used to measure the timing
\r
215 * jitter while the real time kernel is executing.
\r
217 extern void vSetupHighFrequencyTimer( void );
\r
220 * The idle hook is used to run a test of the scheduler context switch
\r
223 void vApplicationIdleHook( void ) __attribute__((naked));
\r
224 /*-----------------------------------------------------------*/
\r
226 /* The queue used to send messages to the OLED task. */
\r
227 QueueHandle_t xOLEDQueue;
\r
229 /* The welcome text. */
\r
230 const char * const pcWelcomeMessage = " www.FreeRTOS.org";
\r
232 /* Variables used to detect the test in the idle hook failing. */
\r
233 unsigned long ulIdleError = pdFALSE;
\r
235 /*-----------------------------------------------------------*/
\r
237 /*************************************************************************
\r
238 * Please ensure to read http://www.freertos.org/portLM3Sxxxx_Eclipse.html
\r
239 * which provides information on configuring and running this demo for the
\r
240 * various Luminary Micro EKs.
\r
241 *************************************************************************/
\r
244 prvSetupHardware();
\r
246 /* Create the queue used by the OLED task. Messages for display on the OLED
\r
247 are received via this queue. */
\r
248 xOLEDQueue = xQueueCreate( mainOLED_QUEUE_SIZE, sizeof( xOLEDMessage ) );
\r
250 /* Create the uIP task if running on a processor that includes a MAC and
\r
252 if( SysCtlPeripheralPresent( SYSCTL_PERIPH_ETH ) )
\r
254 xTaskCreate( vuIP_Task, "uIP", mainBASIC_WEB_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY - 1, NULL );
\r
257 /* Start the standard demo tasks. */
\r
258 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
259 vCreateBlockTimeTasks();
\r
260 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
261 vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );
\r
262 vStartIntegerMathTasks( mainINTEGER_TASK_PRIORITY );
\r
263 vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );
\r
264 vStartQueuePeekTasks();
\r
265 vStartRecursiveMutexTasks();
\r
266 vStartInterruptQueueTasks();
\r
267 vStartQueueSetTasks();
\r
269 /* Start the tasks defined within this file/specific to this demo. */
\r
270 xTaskCreate( vOLEDTask, "OLED", mainOLED_TASK_STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );
\r
272 /* The suicide tasks must be created last as they need to know how many
\r
273 tasks were running prior to their creation in order to ascertain whether
\r
274 or not the correct/expected number of tasks are running at any given time. */
\r
275 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
277 /* Configure the high frequency interrupt used to measure the interrupt
\r
279 vSetupHighFrequencyTimer();
\r
281 /* Start the scheduler. */
\r
282 vTaskStartScheduler();
\r
284 /* Will only get here if there was insufficient memory to create the idle
\r
289 /*-----------------------------------------------------------*/
\r
291 void prvSetupHardware( void )
\r
293 /* If running on Rev A2 silicon, turn the LDO voltage up to 2.75V. This is
\r
294 a workaround to allow the PLL to operate reliably. */
\r
295 if( DEVICE_IS_REVA2 )
\r
297 SysCtlLDOSet( SYSCTL_LDO_2_75V );
\r
300 /* Set the clocking to run from the PLL at 50 MHz */
\r
301 SysCtlClockSet( SYSCTL_SYSDIV_4 | SYSCTL_USE_PLL | SYSCTL_OSC_MAIN | SYSCTL_XTAL_8MHZ );
\r
303 /* Enable Port F for Ethernet LEDs
\r
305 LED1 Bit 2 Output */
\r
306 SysCtlPeripheralEnable( SYSCTL_PERIPH_GPIOF );
\r
307 GPIODirModeSet( GPIO_PORTF_BASE, (GPIO_PIN_2 | GPIO_PIN_3), GPIO_DIR_MODE_HW );
\r
308 GPIOPadConfigSet( GPIO_PORTF_BASE, (GPIO_PIN_2 | GPIO_PIN_3 ), GPIO_STRENGTH_2MA, GPIO_PIN_TYPE_STD );
\r
310 vParTestInitialise();
\r
312 /*-----------------------------------------------------------*/
\r
314 void vApplicationTickHook( void )
\r
316 static xOLEDMessage xMessage = { "PASS" };
\r
317 static unsigned long ulTicksSinceLastDisplay = 0;
\r
318 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;
\r
320 /* Called from every tick interrupt. Have enough ticks passed to make it
\r
321 time to perform our health status check again? */
\r
322 ulTicksSinceLastDisplay++;
\r
323 if( ulTicksSinceLastDisplay >= mainCHECK_DELAY )
\r
325 ulTicksSinceLastDisplay = 0;
\r
327 /* Has an error been found in any task? */
\r
328 if( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
330 xMessage.pcMessage = "ERROR IN GEN Q";
\r
332 else if( xAreQueuePeekTasksStillRunning() != pdTRUE )
\r
334 xMessage.pcMessage = "ERROR IN PEEK Q";
\r
336 else if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
338 xMessage.pcMessage = "ERROR IN BLOCK Q";
\r
340 else if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
342 xMessage.pcMessage = "ERROR IN BLOCK TIME";
\r
344 else if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
346 xMessage.pcMessage = "ERROR IN SEMAPHORE";
\r
348 else if( xArePollingQueuesStillRunning() != pdTRUE )
\r
350 xMessage.pcMessage = "ERROR IN POLL Q";
\r
352 else if( xIsCreateTaskStillRunning() != pdTRUE )
\r
354 xMessage.pcMessage = "ERROR IN CREATE";
\r
356 else if( xAreIntegerMathsTaskStillRunning() != pdTRUE )
\r
358 xMessage.pcMessage = "ERROR IN MATH";
\r
360 else if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
362 xMessage.pcMessage = "ERROR IN REC MUTEX";
\r
364 else if( ulIdleError != pdFALSE )
\r
366 xMessage.pcMessage = "ERROR IN HOOK";
\r
368 else if( xAreIntQueueTasksStillRunning() != pdTRUE )
\r
370 xMessage.pcMessage = "ERROR IN INT QUEUE";
\r
372 else if( xAreQueueSetTasksStillRunning() != pdTRUE )
\r
374 xMessage.pcMessage = "ERROR IN QUEUE SET";
\r
377 /* Send the message to the OLED gatekeeper for display. */
\r
378 xHigherPriorityTaskWoken = pdFALSE;
\r
379 xQueueSendFromISR( xOLEDQueue, &xMessage, &xHigherPriorityTaskWoken );
\r
382 /* Exercise the queue sets from an ISR. */
\r
383 vQueueSetAccessQueueSetFromISR();
\r
385 /*-----------------------------------------------------------*/
\r
387 void vOLEDTask( void *pvParameters )
\r
389 xOLEDMessage xMessage;
\r
390 unsigned long ulY, ulMaxY;
\r
391 static char cMessage[ mainMAX_MSG_LEN ];
\r
392 extern volatile unsigned long ulMaxJitter;
\r
393 unsigned portBASE_TYPE uxUnusedStackOnEntry;
\r
394 const unsigned char *pucImage;
\r
396 /* Functions to access the OLED. The one used depends on the dev kit
\r
398 void ( *vOLEDInit )( unsigned long ) = NULL;
\r
399 void ( *vOLEDStringDraw )( const char *, unsigned long, unsigned long, unsigned char ) = NULL;
\r
400 void ( *vOLEDImageDraw )( const unsigned char *, unsigned long, unsigned long, unsigned long, unsigned long ) = NULL;
\r
401 void ( *vOLEDClear )( void ) = NULL;
\r
403 /* Just for demo purposes. */
\r
404 uxUnusedStackOnEntry = uxTaskGetStackHighWaterMark( NULL );
\r
406 /* Map the OLED access functions to the driver functions that are appropriate
\r
407 for the evaluation kit being used. */
\r
408 switch( HWREG( SYSCTL_DID1 ) & SYSCTL_DID1_PRTNO_MASK )
\r
410 case SYSCTL_DID1_PRTNO_6965 :
\r
411 case SYSCTL_DID1_PRTNO_2965 : vOLEDInit = OSRAM128x64x4Init;
\r
412 vOLEDStringDraw = OSRAM128x64x4StringDraw;
\r
413 vOLEDImageDraw = OSRAM128x64x4ImageDraw;
\r
414 vOLEDClear = OSRAM128x64x4Clear;
\r
415 ulMaxY = mainMAX_ROWS_64;
\r
416 pucImage = pucBasicBitmap;
\r
419 case SYSCTL_DID1_PRTNO_1968 :
\r
420 case SYSCTL_DID1_PRTNO_8962 : vOLEDInit = RIT128x96x4Init;
\r
421 vOLEDStringDraw = RIT128x96x4StringDraw;
\r
422 vOLEDImageDraw = RIT128x96x4ImageDraw;
\r
423 vOLEDClear = RIT128x96x4Clear;
\r
424 ulMaxY = mainMAX_ROWS_96;
\r
425 pucImage = pucBasicBitmap;
\r
428 default : vOLEDInit = vFormike128x128x16Init;
\r
429 vOLEDStringDraw = vFormike128x128x16StringDraw;
\r
430 vOLEDImageDraw = vFormike128x128x16ImageDraw;
\r
431 vOLEDClear = vFormike128x128x16Clear;
\r
432 ulMaxY = mainMAX_ROWS_128;
\r
433 pucImage = pucGrLibBitmap;
\r
439 /* Initialise the OLED and display a startup message. */
\r
440 vOLEDInit( ulSSI_FREQUENCY );
\r
441 vOLEDStringDraw( "POWERED BY FreeRTOS", 0, 0, mainFULL_SCALE );
\r
442 vOLEDImageDraw( pucImage, 0, mainCHARACTER_HEIGHT + 1, bmpBITMAP_WIDTH, bmpBITMAP_HEIGHT );
\r
446 /* Wait for a message to arrive that requires displaying. */
\r
447 xQueueReceive( xOLEDQueue, &xMessage, portMAX_DELAY );
\r
449 /* Write the message on the next available row. */
\r
450 ulY += mainCHARACTER_HEIGHT;
\r
451 if( ulY >= ulMaxY )
\r
453 ulY = mainCHARACTER_HEIGHT;
\r
455 vOLEDStringDraw( pcWelcomeMessage, 0, 0, mainFULL_SCALE );
\r
458 /* Display the message along with the maximum jitter time from the
\r
459 high priority time test. */
\r
460 sprintf( cMessage, "%s [%uns]", xMessage.pcMessage, ulMaxJitter * mainNS_PER_CLOCK );
\r
461 vOLEDStringDraw( cMessage, 0, ulY, mainFULL_SCALE );
\r
464 /*-----------------------------------------------------------*/
\r
466 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName )
\r
470 /*-----------------------------------------------------------*/
\r
472 void vApplicationMallocFailedHook( void )
\r
476 /*-----------------------------------------------------------*/
\r
478 /* Just to keep the linker happy. */
\r
479 void __error__( char *pcFilename, unsigned long ulLine )
\r
484 int uipprintf( const char *fmt, ... )
\r