2 FreeRTOS V5.4.1 - Copyright (C) 2009 Real Time Engineers Ltd.
\r
4 This file is part of the FreeRTOS distribution.
\r
6 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
7 the terms of the GNU General Public License (version 2) as published by the
\r
8 Free Software Foundation and modified by the FreeRTOS exception.
\r
9 **NOTE** The exception to the GPL is included to allow you to distribute a
\r
10 combined work that includes FreeRTOS without being obliged to provide the
\r
11 source code for proprietary components outside of the FreeRTOS kernel.
\r
12 Alternative commercial license and support terms are also available upon
\r
13 request. See the licensing section of http://www.FreeRTOS.org for full
\r
16 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT
\r
17 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
\r
18 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
\r
21 You should have received a copy of the GNU General Public License along
\r
22 with FreeRTOS; if not, write to the Free Software Foundation, Inc., 59
\r
23 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
\r
26 ***************************************************************************
\r
28 * Looking for a quick start? Then check out the FreeRTOS eBook! *
\r
29 * See http://www.FreeRTOS.org/Documentation for details *
\r
31 ***************************************************************************
\r
35 Please ensure to read the configuration and relevant port sections of the
\r
36 online documentation.
\r
38 http://www.FreeRTOS.org - Documentation, latest information, license and
\r
41 http://www.SafeRTOS.com - A version that is certified for use in safety
\r
44 http://www.OpenRTOS.com - Commercial support, development, porting,
\r
45 licensing and training services.
\r
50 * Creates all the demo application tasks, then starts the scheduler. The WEB
\r
51 * documentation provides more details of the standard demo application tasks.
\r
52 * In addition to the standard demo tasks, the following tasks and tests are
\r
53 * defined and/or created within this file:
\r
55 * "Fast Interrupt Test" - A high frequency periodic interrupt is generated
\r
56 * using a free running timer to demonstrate the use of the
\r
57 * configKERNEL_INTERRUPT_PRIORITY configuration constant. The interrupt
\r
58 * service routine measures the number of processor clocks that occur between
\r
59 * each interrupt - and in so doing measures the jitter in the interrupt timing.
\r
60 * The maximum measured jitter time is latched in the ulMaxJitter variable, and
\r
61 * displayed on the OLED display by the 'OLED' task as described below. The
\r
62 * fast interrupt is configured and handled in the timertest.c source file.
\r
64 * "OLED" task - the OLED task is a 'gatekeeper' task. It is the only task that
\r
65 * is permitted to access the display directly. Other tasks wishing to write a
\r
66 * message to the OLED send the message on a queue to the OLED task instead of
\r
67 * accessing the OLED themselves. The OLED task just blocks on the queue waiting
\r
68 * for messages - waking and displaying the messages as they arrive.
\r
70 * "Check" hook - This only executes every five seconds from the tick hook.
\r
71 * Its main function is to check that all the standard demo tasks are still
\r
72 * operational. Should any unexpected behaviour within a demo task be discovered
\r
73 * the tick hook will write an error to the OLED (via the OLED task). If all the
\r
74 * demo tasks are executing with their expected behaviour then the check task
\r
75 * writes PASS to the OLED (again via the OLED task), as described above.
\r
77 * "uIP" task - This is the task that handles the uIP stack. All TCP/IP
\r
78 * processing is performed in this task.
\r
84 /*************************************************************************
\r
85 * Please ensure to read http://www.freertos.org/portlm3sx965.html
\r
86 * which provides information on configuring and running this demo for the
\r
87 * various Luminary Micro EKs.
\r
88 *************************************************************************/
\r
90 /* Set the following option to 1 to include the WEB server in the build. By
\r
91 default the WEB server is excluded to keep the compiled code size under the 32K
\r
92 limit imposed by the KickStart version of the IAR compiler. The graphics
\r
93 libraries take up a lot of ROM space, hence including the graphics libraries
\r
94 and the TCP/IP stack together cannot be accommodated with the 32K size limit. */
\r
95 #define mainINCLUDE_WEB_SERVER 0
\r
98 /* Standard includes. */
\r
101 /* Scheduler includes. */
\r
102 #include "FreeRTOS.h"
\r
105 #include "semphr.h"
\r
107 /* Hardware library includes. */
\r
108 #include "hw_memmap.h"
\r
109 #include "hw_types.h"
\r
110 #include "hw_sysctl.h"
\r
111 #include "sysctl.h"
\r
114 #include "rit128x96x4.h"
\r
115 #include "osram128x64x4.h"
\r
116 #include "formike128x128x16.h"
\r
118 /* Demo app includes. */
\r
119 #include "BlockQ.h"
\r
121 #include "integer.h"
\r
122 #include "blocktim.h"
\r
124 #include "partest.h"
\r
125 #include "semtest.h"
\r
127 #include "lcd_message.h"
\r
128 #include "bitmap.h"
\r
129 #include "GenQTest.h"
\r
131 #include "recmutex.h"
\r
132 #include "IntQueue.h"
\r
134 /*-----------------------------------------------------------*/
\r
136 /* The time between cycles of the 'check' functionality (defined within the
\r
138 #define mainCHECK_DELAY ( ( portTickType ) 5000 / portTICK_RATE_MS )
\r
140 /* Size of the stack allocated to the uIP task. */
\r
141 #define mainBASIC_WEB_STACK_SIZE ( configMINIMAL_STACK_SIZE * 3 )
\r
143 /* The OLED task uses the sprintf function so requires a little more stack too. */
\r
144 #define mainOLED_TASK_STACK_SIZE ( configMINIMAL_STACK_SIZE + 50 )
\r
146 /* Task priorities. */
\r
147 #define mainQUEUE_POLL_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
148 #define mainCHECK_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
149 #define mainSEM_TEST_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
150 #define mainBLOCK_Q_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
151 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
152 #define mainINTEGER_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
153 #define mainGEN_QUEUE_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
155 /* The maximum number of message that can be waiting for display at any one
\r
157 #define mainOLED_QUEUE_SIZE ( 3 )
\r
159 /* Dimensions the buffer into which the jitter time is written. */
\r
160 #define mainMAX_MSG_LEN 25
\r
162 /* The period of the system clock in nano seconds. This is used to calculate
\r
163 the jitter time in nano seconds. */
\r
164 #define mainNS_PER_CLOCK ( ( unsigned portLONG ) ( ( 1.0 / ( double ) configCPU_CLOCK_HZ ) * 1000000000.0 ) )
\r
166 /* Constants used when writing strings to the display. */
\r
167 #define mainCHARACTER_HEIGHT ( 9 )
\r
168 #define mainMAX_ROWS_128 ( mainCHARACTER_HEIGHT * 14 )
\r
169 #define mainMAX_ROWS_96 ( mainCHARACTER_HEIGHT * 10 )
\r
170 #define mainMAX_ROWS_64 ( mainCHARACTER_HEIGHT * 7 )
\r
171 #define mainFULL_SCALE ( 15 )
\r
172 #define ulSSI_FREQUENCY ( 3500000UL )
\r
174 /*-----------------------------------------------------------*/
\r
177 * The task that handles the uIP stack. All TCP/IP processing is performed in
\r
180 extern void vuIP_Task( void *pvParameters );
\r
183 * The display is written two by more than one task so is controlled by a
\r
184 * 'gatekeeper' task. This is the only task that is actually permitted to
\r
185 * access the display directly. Other tasks wanting to display a message send
\r
186 * the message to the gatekeeper.
\r
188 static void vOLEDTask( void *pvParameters );
\r
191 * Configure the hardware for the demo.
\r
193 static void prvSetupHardware( void );
\r
196 * Configures the high frequency timers - those used to measure the timing
\r
197 * jitter while the real time kernel is executing.
\r
199 extern void vSetupHighFrequencyTimer( void );
\r
202 * Hook functions that can get called by the kernel.
\r
204 void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed portCHAR *pcTaskName );
\r
205 void vApplicationTickHook( void );
\r
208 /*-----------------------------------------------------------*/
\r
210 /* The queue used to send messages to the OLED task. */
\r
211 xQueueHandle xOLEDQueue;
\r
213 /* The welcome text. */
\r
214 const portCHAR * const pcWelcomeMessage = " www.FreeRTOS.org";
\r
216 /*-----------------------------------------------------------*/
\r
219 /*************************************************************************
\r
220 * Please ensure to read http://www.freertos.org/portlm3sx965.html
\r
221 * which provides information on configuring and running this demo for the
\r
222 * various Luminary Micro EKs.
\r
223 *************************************************************************/
\r
226 prvSetupHardware();
\r
228 /* Create the queue used by the OLED task. Messages for display on the OLED
\r
229 are received via this queue. */
\r
230 xOLEDQueue = xQueueCreate( mainOLED_QUEUE_SIZE, sizeof( xOLEDMessage ) );
\r
232 /* Start the standard demo tasks. */
\r
233 vStartIntegerMathTasks( mainINTEGER_TASK_PRIORITY );
\r
234 vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );
\r
235 vStartInterruptQueueTasks();
\r
236 vStartRecursiveMutexTasks();
\r
237 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
238 vCreateBlockTimeTasks();
\r
239 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
240 vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );
\r
241 vStartQueuePeekTasks();
\r
243 /* Exclude some tasks if using the kickstart version to ensure we stay within
\r
244 the 32K code size limit. */
\r
245 #if mainINCLUDE_WEB_SERVER != 0
\r
247 /* Create the uIP task if running on a processor that includes a MAC and
\r
249 if( SysCtlPeripheralPresent( SYSCTL_PERIPH_ETH ) )
\r
251 xTaskCreate( vuIP_Task, ( signed portCHAR * ) "uIP", mainBASIC_WEB_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY - 1, NULL );
\r
258 /* Start the tasks defined within this file/specific to this demo. */
\r
259 xTaskCreate( vOLEDTask, ( signed portCHAR * ) "OLED", mainOLED_TASK_STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );
\r
261 /* The suicide tasks must be created last as they need to know how many
\r
262 tasks were running prior to their creation in order to ascertain whether
\r
263 or not the correct/expected number of tasks are running at any given time. */
\r
264 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
266 /* Configure the high frequency interrupt used to measure the interrupt
\r
268 vSetupHighFrequencyTimer();
\r
270 /* Start the scheduler. */
\r
271 vTaskStartScheduler();
\r
273 /* Will only get here if there was insufficient memory to create the idle
\r
277 /*-----------------------------------------------------------*/
\r
279 void prvSetupHardware( void )
\r
281 /* If running on Rev A2 silicon, turn the LDO voltage up to 2.75V. This is
\r
282 a workaround to allow the PLL to operate reliably. */
\r
283 if( DEVICE_IS_REVA2 )
\r
285 SysCtlLDOSet( SYSCTL_LDO_2_75V );
\r
288 /* Set the clocking to run from the PLL at 50 MHz */
\r
289 SysCtlClockSet( SYSCTL_SYSDIV_4 | SYSCTL_USE_PLL | SYSCTL_OSC_MAIN | SYSCTL_XTAL_8MHZ );
\r
291 /* Enable Port F for Ethernet LEDs
\r
293 LED1 Bit 2 Output */
\r
294 SysCtlPeripheralEnable( SYSCTL_PERIPH_GPIOF );
\r
295 GPIODirModeSet( GPIO_PORTF_BASE, (GPIO_PIN_2 | GPIO_PIN_3), GPIO_DIR_MODE_HW );
\r
296 GPIOPadConfigSet( GPIO_PORTF_BASE, (GPIO_PIN_2 | GPIO_PIN_3 ), GPIO_STRENGTH_2MA, GPIO_PIN_TYPE_STD );
\r
298 vParTestInitialise();
\r
300 /*-----------------------------------------------------------*/
\r
302 void vApplicationTickHook( void )
\r
304 static xOLEDMessage xMessage = { "PASS" };
\r
305 static unsigned portLONG ulTicksSinceLastDisplay = 0;
\r
306 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;
\r
308 /* Called from every tick interrupt. Have enough ticks passed to make it
\r
309 time to perform our health status check again? */
\r
310 ulTicksSinceLastDisplay++;
\r
311 if( ulTicksSinceLastDisplay >= mainCHECK_DELAY )
\r
313 ulTicksSinceLastDisplay = 0;
\r
315 /* Has an error been found in any task? */
\r
316 if( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
318 xMessage.pcMessage = "ERROR IN GEN Q";
\r
320 else if( xIsCreateTaskStillRunning() != pdTRUE )
\r
322 xMessage.pcMessage = "ERROR IN CREATE";
\r
324 else if( xAreIntegerMathsTaskStillRunning() != pdTRUE )
\r
326 xMessage.pcMessage = "ERROR IN MATH";
\r
328 else if( xAreIntQueueTasksStillRunning() != pdTRUE )
\r
330 xMessage.pcMessage = "ERROR IN INT QUEUE";
\r
332 else if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
334 xMessage.pcMessage = "ERROR IN BLOCK Q";
\r
336 else if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
338 xMessage.pcMessage = "ERROR IN BLOCK TIME";
\r
340 else if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
342 xMessage.pcMessage = "ERROR IN SEMAPHORE";
\r
344 else if( xArePollingQueuesStillRunning() != pdTRUE )
\r
346 xMessage.pcMessage = "ERROR IN POLL Q";
\r
348 else if( xAreQueuePeekTasksStillRunning() != pdTRUE )
\r
350 xMessage.pcMessage = "ERROR IN PEEK Q";
\r
352 else if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
354 xMessage.pcMessage = "ERROR IN REC MUTEX";
\r
357 /* Send the message to the OLED gatekeeper for display. */
\r
358 xHigherPriorityTaskWoken = pdFALSE;
\r
359 xQueueSendFromISR( xOLEDQueue, &xMessage, &xHigherPriorityTaskWoken );
\r
362 /*-----------------------------------------------------------*/
\r
364 void vOLEDTask( void *pvParameters )
\r
366 xOLEDMessage xMessage;
\r
367 unsigned portLONG ulY, ulMaxY;
\r
368 static portCHAR cMessage[ mainMAX_MSG_LEN ];
\r
369 extern volatile unsigned portLONG ulMaxJitter;
\r
370 unsigned portBASE_TYPE uxUnusedStackOnEntry;
\r
371 const unsigned portCHAR *pucImage;
\r
373 /* Functions to access the OLED. The one used depends on the dev kit
\r
375 void ( *vOLEDInit )( unsigned portLONG ) = NULL;
\r
376 void ( *vOLEDStringDraw )( const portCHAR *, unsigned portLONG, unsigned portLONG, unsigned portCHAR ) = NULL;
\r
377 void ( *vOLEDImageDraw )( const unsigned portCHAR *, unsigned portLONG, unsigned portLONG, unsigned portLONG, unsigned portLONG ) = NULL;
\r
378 void ( *vOLEDClear )( void ) = NULL;
\r
380 /* Just for demo purposes. */
\r
381 uxUnusedStackOnEntry = uxTaskGetStackHighWaterMark( NULL );
\r
383 /* Map the OLED access functions to the driver functions that are appropriate
\r
384 for the evaluation kit being used. */
\r
385 switch( HWREG( SYSCTL_DID1 ) & SYSCTL_DID1_PRTNO_MASK )
\r
387 case SYSCTL_DID1_PRTNO_6965 :
\r
388 case SYSCTL_DID1_PRTNO_2965 : vOLEDInit = OSRAM128x64x4Init;
\r
389 vOLEDStringDraw = OSRAM128x64x4StringDraw;
\r
390 vOLEDImageDraw = OSRAM128x64x4ImageDraw;
\r
391 vOLEDClear = OSRAM128x64x4Clear;
\r
392 ulMaxY = mainMAX_ROWS_64;
\r
393 pucImage = pucBasicBitmap;
\r
396 case SYSCTL_DID1_PRTNO_1968 :
\r
397 case SYSCTL_DID1_PRTNO_8962 : vOLEDInit = RIT128x96x4Init;
\r
398 vOLEDStringDraw = RIT128x96x4StringDraw;
\r
399 vOLEDImageDraw = RIT128x96x4ImageDraw;
\r
400 vOLEDClear = RIT128x96x4Clear;
\r
401 ulMaxY = mainMAX_ROWS_96;
\r
402 pucImage = pucBasicBitmap;
\r
405 default : vOLEDInit = vFormike128x128x16Init;
\r
406 vOLEDStringDraw = vFormike128x128x16StringDraw;
\r
407 vOLEDImageDraw = vFormike128x128x16ImageDraw;
\r
408 vOLEDClear = vFormike128x128x16Clear;
\r
409 ulMaxY = mainMAX_ROWS_128;
\r
410 pucImage = pucGrLibBitmap;
\r
417 /* Initialise the OLED and display a startup message. */
\r
418 vOLEDInit( ulSSI_FREQUENCY );
\r
419 vOLEDStringDraw( "POWERED BY FreeRTOS", 0, 0, mainFULL_SCALE );
\r
420 vOLEDImageDraw( pucImage, 0, mainCHARACTER_HEIGHT + 1, bmpBITMAP_WIDTH, bmpBITMAP_HEIGHT );
\r
424 /* Wait for a message to arrive that requires displaying. */
\r
425 xQueueReceive( xOLEDQueue, &xMessage, portMAX_DELAY );
\r
427 /* Write the message on the next available row. */
\r
428 ulY += mainCHARACTER_HEIGHT;
\r
429 if( ulY >= ulMaxY )
\r
431 ulY = mainCHARACTER_HEIGHT;
\r
433 vOLEDStringDraw( pcWelcomeMessage, 0, 0, mainFULL_SCALE );
\r
436 /* Display the message along with the maximum jitter time from the
\r
437 high priority time test. */
\r
438 sprintf( cMessage, "%s [%uns]", xMessage.pcMessage, ulMaxJitter * mainNS_PER_CLOCK );
\r
439 vOLEDStringDraw( cMessage, 0, ulY, mainFULL_SCALE );
\r
442 /*-----------------------------------------------------------*/
\r
444 void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed portCHAR *pcTaskName )
\r
447 ( void ) pcTaskName;
\r