2 FreeRTOS V8.2.0rc1 - Copyright (C) 2014 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 >>! NOTE: The modification to the GPL is included to allow you to !<<
\r
14 >>! distribute a combined work that includes FreeRTOS without being !<<
\r
15 >>! obliged to provide the source code for proprietary components !<<
\r
16 >>! outside of the FreeRTOS kernel. !<<
\r
18 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
19 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
20 FOR A PARTICULAR PURPOSE. Full license text is available on the following
\r
21 link: http://www.freertos.org/a00114.html
\r
25 ***************************************************************************
\r
27 * Having a problem? Start by reading the FAQ "My application does *
\r
28 * not run, what could be wrong?". Have you defined configASSERT()? *
\r
30 * http://www.FreeRTOS.org/FAQHelp.html *
\r
32 ***************************************************************************
\r
34 ***************************************************************************
\r
36 * FreeRTOS provides completely free yet professionally developed, *
\r
37 * robust, strictly quality controlled, supported, and cross *
\r
38 * platform software that is more than just the market leader, it *
\r
39 * is the industry's de facto standard. *
\r
41 * Help yourself get started quickly while simultaneously helping *
\r
42 * to support the FreeRTOS project by purchasing a FreeRTOS *
\r
43 * tutorial book, reference manual, or both: *
\r
44 * http://www.FreeRTOS.org/Documentation *
\r
46 ***************************************************************************
\r
48 ***************************************************************************
\r
50 * Investing in training allows your team to be as productive as *
\r
51 * possible as early as possible, lowering your overall development *
\r
52 * cost, and enabling you to bring a more robust product to market *
\r
53 * earlier than would otherwise be possible. Richard Barry is both *
\r
54 * the architect and key author of FreeRTOS, and so also the world's *
\r
55 * leading authority on what is the world's most popular real time *
\r
56 * kernel for deeply embedded MCU designs. Obtaining your training *
\r
57 * from Richard ensures your team will gain directly from his in-depth *
\r
58 * product knowledge and years of usage experience. Contact Real Time *
\r
59 * Engineers Ltd to enquire about the FreeRTOS Masterclass, presented *
\r
60 * by Richard Barry: http://www.FreeRTOS.org/contact
\r
62 ***************************************************************************
\r
64 ***************************************************************************
\r
66 * You are receiving this top quality software for free. Please play *
\r
67 * fair and reciprocate by reporting any suspected issues and *
\r
68 * participating in the community forum: *
\r
69 * http://www.FreeRTOS.org/support *
\r
73 ***************************************************************************
\r
75 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
76 license and Real Time Engineers Ltd. contact details.
\r
78 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
79 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
80 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
82 http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
\r
83 Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
\r
85 http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
\r
86 Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
87 licenses offer ticketed support, indemnification and commercial middleware.
\r
89 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
90 engineered and independently SIL3 certified version for use in safety and
\r
91 mission critical applications that require provable dependability.
\r
98 * Creates all the demo application tasks, then starts the scheduler. The WEB
\r
99 * documentation provides more details of the standard demo application tasks.
\r
100 * In addition to the standard demo tasks, the following tasks and tests are
\r
101 * defined and/or created within this file:
\r
103 * "Fast Interrupt Test" - A high frequency periodic interrupt is generated
\r
104 * using a free running timer to demonstrate the use of the
\r
105 * configKERNEL_INTERRUPT_PRIORITY configuration constant. The interrupt
\r
106 * service routine measures the number of processor clocks that occur between
\r
107 * each interrupt - and in so doing measures the jitter in the interrupt timing.
\r
108 * The maximum measured jitter time is latched in the ulMaxJitter variable, and
\r
109 * displayed on the OLED display by the 'OLED' task as described below. The
\r
110 * fast interrupt is configured and handled in the timertest.c source file.
\r
112 * "OLED" task - the OLED task is a 'gatekeeper' task. It is the only task that
\r
113 * is permitted to access the display directly. Other tasks wishing to write a
\r
114 * message to the OLED send the message on a queue to the OLED task instead of
\r
115 * accessing the OLED themselves. The OLED task just blocks on the queue waiting
\r
116 * for messages - waking and displaying the messages as they arrive.
\r
118 * "Check" hook - This only executes every five seconds from the tick hook.
\r
119 * Its main function is to check that all the standard demo tasks are still
\r
120 * operational. Should any unexpected behaviour within a demo task be discovered
\r
121 * the tick hook will write an error to the OLED (via the OLED task). If all the
\r
122 * demo tasks are executing with their expected behaviour then the check task
\r
123 * writes PASS to the OLED (again via the OLED task), as described above.
\r
125 * "uIP" task - This is the task that handles the uIP stack. All TCP/IP
\r
126 * processing is performed in this task.
\r
132 /*************************************************************************
\r
133 * Please ensure to read http://www.freertos.org/portLM3Sxxxx_Eclipse.html
\r
134 * which provides information on configuring and running this demo for the
\r
135 * various Luminary Micro EKs.
\r
136 *************************************************************************/
\r
141 /* Standard includes. */
\r
144 /* Scheduler includes. */
\r
145 #include "FreeRTOS.h"
\r
148 #include "semphr.h"
\r
150 /* Hardware library includes. */
\r
151 #include "hw_memmap.h"
\r
152 #include "hw_types.h"
\r
153 #include "hw_sysctl.h"
\r
154 #include "sysctl.h"
\r
157 #include "rit128x96x4.h"
\r
158 #include "osram128x64x4.h"
\r
159 #include "formike128x128x16.h"
\r
161 /* Demo app includes. */
\r
162 #include "BlockQ.h"
\r
164 #include "integer.h"
\r
165 #include "blocktim.h"
\r
167 #include "partest.h"
\r
168 #include "semtest.h"
\r
170 #include "lcd_message.h"
\r
171 #include "bitmap.h"
\r
172 #include "GenQTest.h"
\r
174 #include "recmutex.h"
\r
175 #include "IntQueue.h"
\r
177 /*-----------------------------------------------------------*/
\r
179 /* The time between cycles of the 'check' functionality (defined within the
\r
181 #define mainCHECK_DELAY ( ( TickType_t ) 5000 / portTICK_PERIOD_MS )
\r
183 /* Size of the stack allocated to the uIP task. */
\r
184 #define mainBASIC_WEB_STACK_SIZE ( configMINIMAL_STACK_SIZE * 3 )
\r
186 /* The OLED task uses the sprintf function so requires a little more stack too. */
\r
187 #define mainOLED_TASK_STACK_SIZE ( configMINIMAL_STACK_SIZE + 50 )
\r
189 /* Task priorities. */
\r
190 #define mainQUEUE_POLL_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
191 #define mainCHECK_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
192 #define mainSEM_TEST_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
193 #define mainBLOCK_Q_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
194 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
195 #define mainINTEGER_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
196 #define mainGEN_QUEUE_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
198 /* The maximum number of message that can be waiting for display at any one
\r
200 #define mainOLED_QUEUE_SIZE ( 3 )
\r
202 /* Dimensions the buffer into which the jitter time is written. */
\r
203 #define mainMAX_MSG_LEN 25
\r
205 /* The period of the system clock in nano seconds. This is used to calculate
\r
206 the jitter time in nano seconds. */
\r
207 #define mainNS_PER_CLOCK ( ( unsigned long ) ( ( 1.0 / ( double ) configCPU_CLOCK_HZ ) * 1000000000.0 ) )
\r
209 /* Constants used when writing strings to the display. */
\r
210 #define mainCHARACTER_HEIGHT ( 9 )
\r
211 #define mainMAX_ROWS_128 ( mainCHARACTER_HEIGHT * 14 )
\r
212 #define mainMAX_ROWS_96 ( mainCHARACTER_HEIGHT * 10 )
\r
213 #define mainMAX_ROWS_64 ( mainCHARACTER_HEIGHT * 7 )
\r
214 #define mainFULL_SCALE ( 15 )
\r
215 #define ulSSI_FREQUENCY ( 3500000UL )
\r
217 /*-----------------------------------------------------------*/
\r
220 * The task that handles the uIP stack. All TCP/IP processing is performed in
\r
223 extern void vuIP_Task( void *pvParameters );
\r
226 * The display is written two by more than one task so is controlled by a
\r
227 * 'gatekeeper' task. This is the only task that is actually permitted to
\r
228 * access the display directly. Other tasks wanting to display a message send
\r
229 * the message to the gatekeeper.
\r
231 static void vOLEDTask( void *pvParameters );
\r
234 * Configure the hardware for the demo.
\r
236 static void prvSetupHardware( void );
\r
239 * Configures the high frequency timers - those used to measure the timing
\r
240 * jitter while the real time kernel is executing.
\r
242 extern void vSetupHighFrequencyTimer( void );
\r
245 * The idle hook is used to run a test of the scheduler context switch
\r
248 void vApplicationIdleHook( void ) __attribute__((naked));
\r
249 /*-----------------------------------------------------------*/
\r
251 /* The queue used to send messages to the OLED task. */
\r
252 QueueHandle_t xOLEDQueue;
\r
254 /* The welcome text. */
\r
255 const char * const pcWelcomeMessage = " www.FreeRTOS.org";
\r
257 /* Variables used to detect the test in the idle hook failing. */
\r
258 unsigned long ulIdleError = pdFALSE;
\r
260 /*-----------------------------------------------------------*/
\r
262 /*************************************************************************
\r
263 * Please ensure to read http://www.freertos.org/portLM3Sxxxx_Eclipse.html
\r
264 * which provides information on configuring and running this demo for the
\r
265 * various Luminary Micro EKs.
\r
266 *************************************************************************/
\r
269 prvSetupHardware();
\r
271 /* Create the queue used by the OLED task. Messages for display on the OLED
\r
272 are received via this queue. */
\r
273 xOLEDQueue = xQueueCreate( mainOLED_QUEUE_SIZE, sizeof( xOLEDMessage ) );
\r
275 /* Create the uIP task if running on a processor that includes a MAC and
\r
277 if( SysCtlPeripheralPresent( SYSCTL_PERIPH_ETH ) )
\r
279 xTaskCreate( vuIP_Task, "uIP", mainBASIC_WEB_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY - 1, NULL );
\r
282 /* Start the standard demo tasks. */
\r
283 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
284 vCreateBlockTimeTasks();
\r
285 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
286 vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );
\r
287 vStartIntegerMathTasks( mainINTEGER_TASK_PRIORITY );
\r
288 vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );
\r
289 vStartQueuePeekTasks();
\r
290 vStartRecursiveMutexTasks();
\r
291 vStartInterruptQueueTasks();
\r
293 /* Start the tasks defined within this file/specific to this demo. */
\r
294 xTaskCreate( vOLEDTask, "OLED", mainOLED_TASK_STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );
\r
296 /* The suicide tasks must be created last as they need to know how many
\r
297 tasks were running prior to their creation in order to ascertain whether
\r
298 or not the correct/expected number of tasks are running at any given time. */
\r
299 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
301 /* Configure the high frequency interrupt used to measure the interrupt
\r
303 vSetupHighFrequencyTimer();
\r
305 /* Start the scheduler. */
\r
306 vTaskStartScheduler();
\r
308 /* Will only get here if there was insufficient memory to create the idle
\r
313 /*-----------------------------------------------------------*/
\r
315 void prvSetupHardware( void )
\r
317 /* If running on Rev A2 silicon, turn the LDO voltage up to 2.75V. This is
\r
318 a workaround to allow the PLL to operate reliably. */
\r
319 if( DEVICE_IS_REVA2 )
\r
321 SysCtlLDOSet( SYSCTL_LDO_2_75V );
\r
324 /* Set the clocking to run from the PLL at 50 MHz */
\r
325 SysCtlClockSet( SYSCTL_SYSDIV_4 | SYSCTL_USE_PLL | SYSCTL_OSC_MAIN | SYSCTL_XTAL_8MHZ );
\r
327 /* Enable Port F for Ethernet LEDs
\r
329 LED1 Bit 2 Output */
\r
330 SysCtlPeripheralEnable( SYSCTL_PERIPH_GPIOF );
\r
331 GPIODirModeSet( GPIO_PORTF_BASE, (GPIO_PIN_2 | GPIO_PIN_3), GPIO_DIR_MODE_HW );
\r
332 GPIOPadConfigSet( GPIO_PORTF_BASE, (GPIO_PIN_2 | GPIO_PIN_3 ), GPIO_STRENGTH_2MA, GPIO_PIN_TYPE_STD );
\r
334 vParTestInitialise();
\r
336 /*-----------------------------------------------------------*/
\r
338 void vApplicationTickHook( void )
\r
340 static xOLEDMessage xMessage = { "PASS" };
\r
341 static unsigned long ulTicksSinceLastDisplay = 0;
\r
342 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;
\r
344 /* Called from every tick interrupt. Have enough ticks passed to make it
\r
345 time to perform our health status check again? */
\r
346 ulTicksSinceLastDisplay++;
\r
347 if( ulTicksSinceLastDisplay >= mainCHECK_DELAY )
\r
349 ulTicksSinceLastDisplay = 0;
\r
351 /* Has an error been found in any task? */
\r
352 if( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
354 xMessage.pcMessage = "ERROR IN GEN Q";
\r
356 else if( xAreQueuePeekTasksStillRunning() != pdTRUE )
\r
358 xMessage.pcMessage = "ERROR IN PEEK Q";
\r
360 else if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
362 xMessage.pcMessage = "ERROR IN BLOCK Q";
\r
364 else if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
366 xMessage.pcMessage = "ERROR IN BLOCK TIME";
\r
368 else if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
370 xMessage.pcMessage = "ERROR IN SEMAPHORE";
\r
372 else if( xArePollingQueuesStillRunning() != pdTRUE )
\r
374 xMessage.pcMessage = "ERROR IN POLL Q";
\r
376 else if( xIsCreateTaskStillRunning() != pdTRUE )
\r
378 xMessage.pcMessage = "ERROR IN CREATE";
\r
380 else if( xAreIntegerMathsTaskStillRunning() != pdTRUE )
\r
382 xMessage.pcMessage = "ERROR IN MATH";
\r
384 else if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
386 xMessage.pcMessage = "ERROR IN REC MUTEX";
\r
388 else if( ulIdleError != pdFALSE )
\r
390 xMessage.pcMessage = "ERROR IN HOOK";
\r
392 else if( xAreIntQueueTasksStillRunning() != pdTRUE )
\r
394 xMessage.pcMessage = "ERROR IN INT QUEUE";
\r
398 /* Send the message to the OLED gatekeeper for display. */
\r
399 xHigherPriorityTaskWoken = pdFALSE;
\r
400 xQueueSendFromISR( xOLEDQueue, &xMessage, &xHigherPriorityTaskWoken );
\r
403 /*-----------------------------------------------------------*/
\r
405 void vOLEDTask( void *pvParameters )
\r
407 xOLEDMessage xMessage;
\r
408 unsigned long ulY, ulMaxY;
\r
409 static char cMessage[ mainMAX_MSG_LEN ];
\r
410 extern volatile unsigned long ulMaxJitter;
\r
411 unsigned portBASE_TYPE uxUnusedStackOnEntry, uxUnusedStackNow;
\r
412 const unsigned char *pucImage;
\r
414 /* Functions to access the OLED. The one used depends on the dev kit
\r
416 void ( *vOLEDInit )( unsigned long ) = NULL;
\r
417 void ( *vOLEDStringDraw )( const char *, unsigned long, unsigned long, unsigned char ) = NULL;
\r
418 void ( *vOLEDImageDraw )( const unsigned char *, unsigned long, unsigned long, unsigned long, unsigned long ) = NULL;
\r
419 void ( *vOLEDClear )( void ) = NULL;
\r
421 /* Just for demo purposes. */
\r
422 uxUnusedStackOnEntry = uxTaskGetStackHighWaterMark( NULL );
\r
424 /* Map the OLED access functions to the driver functions that are appropriate
\r
425 for the evaluation kit being used. */
\r
426 switch( HWREG( SYSCTL_DID1 ) & SYSCTL_DID1_PRTNO_MASK )
\r
428 case SYSCTL_DID1_PRTNO_6965 :
\r
429 case SYSCTL_DID1_PRTNO_2965 : vOLEDInit = OSRAM128x64x4Init;
\r
430 vOLEDStringDraw = OSRAM128x64x4StringDraw;
\r
431 vOLEDImageDraw = OSRAM128x64x4ImageDraw;
\r
432 vOLEDClear = OSRAM128x64x4Clear;
\r
433 ulMaxY = mainMAX_ROWS_64;
\r
434 pucImage = pucBasicBitmap;
\r
437 case SYSCTL_DID1_PRTNO_1968 :
\r
438 case SYSCTL_DID1_PRTNO_8962 : vOLEDInit = RIT128x96x4Init;
\r
439 vOLEDStringDraw = RIT128x96x4StringDraw;
\r
440 vOLEDImageDraw = RIT128x96x4ImageDraw;
\r
441 vOLEDClear = RIT128x96x4Clear;
\r
442 ulMaxY = mainMAX_ROWS_96;
\r
443 pucImage = pucBasicBitmap;
\r
446 default : vOLEDInit = vFormike128x128x16Init;
\r
447 vOLEDStringDraw = vFormike128x128x16StringDraw;
\r
448 vOLEDImageDraw = vFormike128x128x16ImageDraw;
\r
449 vOLEDClear = vFormike128x128x16Clear;
\r
450 ulMaxY = mainMAX_ROWS_128;
\r
451 pucImage = pucGrLibBitmap;
\r
457 /* Initialise the OLED and display a startup message. */
\r
458 vOLEDInit( ulSSI_FREQUENCY );
\r
459 vOLEDStringDraw( "POWERED BY FreeRTOS", 0, 0, mainFULL_SCALE );
\r
460 vOLEDImageDraw( pucImage, 0, mainCHARACTER_HEIGHT + 1, bmpBITMAP_WIDTH, bmpBITMAP_HEIGHT );
\r
464 /* Wait for a message to arrive that requires displaying. */
\r
465 xQueueReceive( xOLEDQueue, &xMessage, portMAX_DELAY );
\r
467 /* Write the message on the next available row. */
\r
468 ulY += mainCHARACTER_HEIGHT;
\r
469 if( ulY >= ulMaxY )
\r
471 ulY = mainCHARACTER_HEIGHT;
\r
473 vOLEDStringDraw( pcWelcomeMessage, 0, 0, mainFULL_SCALE );
\r
476 /* Display the message along with the maximum jitter time from the
\r
477 high priority time test. */
\r
478 sprintf( cMessage, "%s [%uns]", xMessage.pcMessage, ulMaxJitter * mainNS_PER_CLOCK );
\r
479 vOLEDStringDraw( cMessage, 0, ulY, mainFULL_SCALE );
\r
482 /*-----------------------------------------------------------*/
\r
484 void vApplicationStackOverflowHook( TaskHandle_t *pxTask, signed char *pcTaskName )
\r