2 * FreeRTOS Kernel V10.3.0
\r
3 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
\r
5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
\r
6 * this software and associated documentation files (the "Software"), to deal in
\r
7 * the Software without restriction, including without limitation the rights to
\r
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
\r
9 * the Software, and to permit persons to whom the Software is furnished to do so,
\r
10 * subject to the following conditions:
\r
12 * The above copyright notice and this permission notice shall be included in all
\r
13 * copies or substantial portions of the Software.
\r
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
\r
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
\r
17 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
\r
18 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
\r
19 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
\r
20 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\r
22 * http://www.FreeRTOS.org
\r
23 * http://aws.amazon.com/freertos
\r
25 * 1 tab == 4 spaces!
\r
30 * Creates all the demo application tasks, then starts the scheduler. The WEB
\r
31 * documentation provides more details of the standard demo application tasks.
\r
32 * In addition to the standard demo tasks, the following tasks and tests are
\r
33 * defined and/or created within this file:
\r
35 * "Fast Interrupt Test" - A high frequency periodic interrupt is generated
\r
36 * using a free running timer to demonstrate the use of the
\r
37 * configKERNEL_INTERRUPT_PRIORITY configuration constant. The interrupt
\r
38 * service routine measures the number of processor clocks that occur between
\r
39 * each interrupt - and in so doing measures the jitter in the interrupt timing.
\r
40 * The maximum measured jitter time is latched in the ulMaxJitter variable, and
\r
41 * displayed on the OLED display by the 'OLED' task as described below. The
\r
42 * fast interrupt is configured and handled in the timertest.c source file.
\r
44 * "OLED" task - the OLED task is a 'gatekeeper' task. It is the only task that
\r
45 * is permitted to access the display directly. Other tasks wishing to write a
\r
46 * message to the OLED send the message on a queue to the OLED task instead of
\r
47 * accessing the OLED themselves. The OLED task just blocks on the queue waiting
\r
48 * for messages - waking and displaying the messages as they arrive.
\r
50 * "Check" hook - This only executes every five seconds from the tick hook.
\r
51 * Its main function is to check that all the standard demo tasks are still
\r
52 * operational. Should any unexpected behaviour within a demo task be discovered
\r
53 * the tick hook will write an error to the OLED (via the OLED task). If all the
\r
54 * demo tasks are executing with their expected behaviour then the check task
\r
55 * writes PASS to the OLED (again via the OLED task), as described above.
\r
57 * "uIP" task - This is the task that handles the uIP stack. All TCP/IP
\r
58 * processing is performed in this task.
\r
64 /*************************************************************************
\r
65 * Please ensure to read http://www.freertos.org/portLM3Sxxxx_Eclipse.html
\r
66 * which provides information on configuring and running this demo for the
\r
67 * various Luminary Micro EKs.
\r
68 *************************************************************************/
\r
73 /* Standard includes. */
\r
76 /* Scheduler includes. */
\r
77 #include "FreeRTOS.h"
\r
82 /* Hardware library includes. */
\r
83 #include "hw_memmap.h"
\r
84 #include "hw_types.h"
\r
85 #include "hw_sysctl.h"
\r
89 #include "rit128x96x4.h"
\r
90 #include "osram128x64x4.h"
\r
91 #include "formike128x128x16.h"
\r
93 /* Demo app includes. */
\r
96 #include "integer.h"
\r
97 #include "blocktim.h"
\r
99 #include "partest.h"
\r
100 #include "semtest.h"
\r
102 #include "lcd_message.h"
\r
103 #include "bitmap.h"
\r
104 #include "GenQTest.h"
\r
106 #include "recmutex.h"
\r
107 #include "IntQueue.h"
\r
108 #include "QueueSet.h"
\r
110 /*-----------------------------------------------------------*/
\r
112 /* The time between cycles of the 'check' functionality (defined within the
\r
114 #define mainCHECK_DELAY ( ( TickType_t ) 5000 / portTICK_PERIOD_MS )
\r
116 /* Size of the stack allocated to the uIP task. */
\r
117 #define mainBASIC_WEB_STACK_SIZE ( configMINIMAL_STACK_SIZE * 3 )
\r
119 /* The OLED task uses the sprintf function so requires a little more stack too. */
\r
120 #define mainOLED_TASK_STACK_SIZE ( configMINIMAL_STACK_SIZE + 50 )
\r
122 /* Task priorities. */
\r
123 #define mainQUEUE_POLL_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
124 #define mainCHECK_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
125 #define mainSEM_TEST_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
126 #define mainBLOCK_Q_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
127 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
128 #define mainINTEGER_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
129 #define mainGEN_QUEUE_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
131 /* The maximum number of message that can be waiting for display at any one
\r
133 #define mainOLED_QUEUE_SIZE ( 3 )
\r
135 /* Dimensions the buffer into which the jitter time is written. */
\r
136 #define mainMAX_MSG_LEN 25
\r
138 /* The period of the system clock in nano seconds. This is used to calculate
\r
139 the jitter time in nano seconds. */
\r
140 #define mainNS_PER_CLOCK ( ( unsigned long ) ( ( 1.0 / ( double ) configCPU_CLOCK_HZ ) * 1000000000.0 ) )
\r
142 /* Constants used when writing strings to the display. */
\r
143 #define mainCHARACTER_HEIGHT ( 9 )
\r
144 #define mainMAX_ROWS_128 ( mainCHARACTER_HEIGHT * 14 )
\r
145 #define mainMAX_ROWS_96 ( mainCHARACTER_HEIGHT * 10 )
\r
146 #define mainMAX_ROWS_64 ( mainCHARACTER_HEIGHT * 7 )
\r
147 #define mainFULL_SCALE ( 15 )
\r
148 #define ulSSI_FREQUENCY ( 3500000UL )
\r
150 /*-----------------------------------------------------------*/
\r
153 * The task that handles the uIP stack. All TCP/IP processing is performed in
\r
156 extern void vuIP_Task( void *pvParameters );
\r
159 * The display is written two by more than one task so is controlled by a
\r
160 * 'gatekeeper' task. This is the only task that is actually permitted to
\r
161 * access the display directly. Other tasks wanting to display a message send
\r
162 * the message to the gatekeeper.
\r
164 static void vOLEDTask( void *pvParameters );
\r
167 * Configure the hardware for the demo.
\r
169 static void prvSetupHardware( void );
\r
172 * Configures the high frequency timers - those used to measure the timing
\r
173 * jitter while the real time kernel is executing.
\r
175 extern void vSetupHighFrequencyTimer( void );
\r
178 * The idle hook is used to run a test of the scheduler context switch
\r
181 void vApplicationIdleHook( void ) __attribute__((naked));
\r
182 /*-----------------------------------------------------------*/
\r
184 /* The queue used to send messages to the OLED task. */
\r
185 QueueHandle_t xOLEDQueue;
\r
187 /* The welcome text. */
\r
188 const char * const pcWelcomeMessage = " www.FreeRTOS.org";
\r
190 /* Variables used to detect the test in the idle hook failing. */
\r
191 unsigned long ulIdleError = pdFALSE;
\r
193 /*-----------------------------------------------------------*/
\r
195 /*************************************************************************
\r
196 * Please ensure to read http://www.freertos.org/portLM3Sxxxx_Eclipse.html
\r
197 * which provides information on configuring and running this demo for the
\r
198 * various Luminary Micro EKs.
\r
199 *************************************************************************/
\r
202 prvSetupHardware();
\r
204 /* Create the queue used by the OLED task. Messages for display on the OLED
\r
205 are received via this queue. */
\r
206 xOLEDQueue = xQueueCreate( mainOLED_QUEUE_SIZE, sizeof( xOLEDMessage ) );
\r
208 /* Create the uIP task if running on a processor that includes a MAC and
\r
210 if( SysCtlPeripheralPresent( SYSCTL_PERIPH_ETH ) )
\r
212 xTaskCreate( vuIP_Task, "uIP", mainBASIC_WEB_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY - 1, NULL );
\r
215 /* Start the standard demo tasks. */
\r
216 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
217 vCreateBlockTimeTasks();
\r
218 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
219 vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );
\r
220 vStartIntegerMathTasks( mainINTEGER_TASK_PRIORITY );
\r
221 vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );
\r
222 vStartQueuePeekTasks();
\r
223 vStartRecursiveMutexTasks();
\r
224 vStartInterruptQueueTasks();
\r
225 vStartQueueSetTasks();
\r
227 /* Start the tasks defined within this file/specific to this demo. */
\r
228 xTaskCreate( vOLEDTask, "OLED", mainOLED_TASK_STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );
\r
230 /* The suicide tasks must be created last as they need to know how many
\r
231 tasks were running prior to their creation in order to ascertain whether
\r
232 or not the correct/expected number of tasks are running at any given time. */
\r
233 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
235 /* Configure the high frequency interrupt used to measure the interrupt
\r
237 vSetupHighFrequencyTimer();
\r
239 /* Start the scheduler. */
\r
240 vTaskStartScheduler();
\r
242 /* Will only get here if there was insufficient memory to create the idle
\r
247 /*-----------------------------------------------------------*/
\r
249 void prvSetupHardware( void )
\r
251 /* If running on Rev A2 silicon, turn the LDO voltage up to 2.75V. This is
\r
252 a workaround to allow the PLL to operate reliably. */
\r
253 if( DEVICE_IS_REVA2 )
\r
255 SysCtlLDOSet( SYSCTL_LDO_2_75V );
\r
258 /* Set the clocking to run from the PLL at 50 MHz */
\r
259 SysCtlClockSet( SYSCTL_SYSDIV_4 | SYSCTL_USE_PLL | SYSCTL_OSC_MAIN | SYSCTL_XTAL_8MHZ );
\r
261 /* Enable Port F for Ethernet LEDs
\r
263 LED1 Bit 2 Output */
\r
264 SysCtlPeripheralEnable( SYSCTL_PERIPH_GPIOF );
\r
265 GPIODirModeSet( GPIO_PORTF_BASE, (GPIO_PIN_2 | GPIO_PIN_3), GPIO_DIR_MODE_HW );
\r
266 GPIOPadConfigSet( GPIO_PORTF_BASE, (GPIO_PIN_2 | GPIO_PIN_3 ), GPIO_STRENGTH_2MA, GPIO_PIN_TYPE_STD );
\r
268 vParTestInitialise();
\r
270 /*-----------------------------------------------------------*/
\r
272 void vApplicationTickHook( void )
\r
274 static xOLEDMessage xMessage = { "PASS" };
\r
275 static unsigned long ulTicksSinceLastDisplay = 0;
\r
276 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;
\r
278 /* Called from every tick interrupt. Have enough ticks passed to make it
\r
279 time to perform our health status check again? */
\r
280 ulTicksSinceLastDisplay++;
\r
281 if( ulTicksSinceLastDisplay >= mainCHECK_DELAY )
\r
283 ulTicksSinceLastDisplay = 0;
\r
285 /* Has an error been found in any task? */
\r
286 if( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
288 xMessage.pcMessage = "ERROR IN GEN Q";
\r
290 else if( xAreQueuePeekTasksStillRunning() != pdTRUE )
\r
292 xMessage.pcMessage = "ERROR IN PEEK Q";
\r
294 else if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
296 xMessage.pcMessage = "ERROR IN BLOCK Q";
\r
298 else if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
300 xMessage.pcMessage = "ERROR IN BLOCK TIME";
\r
302 else if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
304 xMessage.pcMessage = "ERROR IN SEMAPHORE";
\r
306 else if( xArePollingQueuesStillRunning() != pdTRUE )
\r
308 xMessage.pcMessage = "ERROR IN POLL Q";
\r
310 else if( xIsCreateTaskStillRunning() != pdTRUE )
\r
312 xMessage.pcMessage = "ERROR IN CREATE";
\r
314 else if( xAreIntegerMathsTaskStillRunning() != pdTRUE )
\r
316 xMessage.pcMessage = "ERROR IN MATH";
\r
318 else if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
320 xMessage.pcMessage = "ERROR IN REC MUTEX";
\r
322 else if( ulIdleError != pdFALSE )
\r
324 xMessage.pcMessage = "ERROR IN HOOK";
\r
326 else if( xAreIntQueueTasksStillRunning() != pdTRUE )
\r
328 xMessage.pcMessage = "ERROR IN INT QUEUE";
\r
330 else if( xAreQueueSetTasksStillRunning() != pdTRUE )
\r
332 xMessage.pcMessage = "ERROR IN QUEUE SET";
\r
335 /* Send the message to the OLED gatekeeper for display. */
\r
336 xHigherPriorityTaskWoken = pdFALSE;
\r
337 xQueueSendFromISR( xOLEDQueue, &xMessage, &xHigherPriorityTaskWoken );
\r
340 /* Exercise the queue sets from an ISR. */
\r
341 vQueueSetAccessQueueSetFromISR();
\r
343 /*-----------------------------------------------------------*/
\r
345 void vOLEDTask( void *pvParameters )
\r
347 xOLEDMessage xMessage;
\r
348 unsigned long ulY, ulMaxY;
\r
349 static char cMessage[ mainMAX_MSG_LEN ];
\r
350 extern volatile unsigned long ulMaxJitter;
\r
351 unsigned portBASE_TYPE uxUnusedStackOnEntry;
\r
352 const unsigned char *pucImage;
\r
354 /* Functions to access the OLED. The one used depends on the dev kit
\r
356 void ( *vOLEDInit )( unsigned long ) = NULL;
\r
357 void ( *vOLEDStringDraw )( const char *, unsigned long, unsigned long, unsigned char ) = NULL;
\r
358 void ( *vOLEDImageDraw )( const unsigned char *, unsigned long, unsigned long, unsigned long, unsigned long ) = NULL;
\r
359 void ( *vOLEDClear )( void ) = NULL;
\r
361 /* Just for demo purposes. */
\r
362 uxUnusedStackOnEntry = uxTaskGetStackHighWaterMark( NULL );
\r
364 /* Map the OLED access functions to the driver functions that are appropriate
\r
365 for the evaluation kit being used. */
\r
366 switch( HWREG( SYSCTL_DID1 ) & SYSCTL_DID1_PRTNO_MASK )
\r
368 case SYSCTL_DID1_PRTNO_6965 :
\r
369 case SYSCTL_DID1_PRTNO_2965 : vOLEDInit = OSRAM128x64x4Init;
\r
370 vOLEDStringDraw = OSRAM128x64x4StringDraw;
\r
371 vOLEDImageDraw = OSRAM128x64x4ImageDraw;
\r
372 vOLEDClear = OSRAM128x64x4Clear;
\r
373 ulMaxY = mainMAX_ROWS_64;
\r
374 pucImage = pucBasicBitmap;
\r
377 case SYSCTL_DID1_PRTNO_1968 :
\r
378 case SYSCTL_DID1_PRTNO_8962 : vOLEDInit = RIT128x96x4Init;
\r
379 vOLEDStringDraw = RIT128x96x4StringDraw;
\r
380 vOLEDImageDraw = RIT128x96x4ImageDraw;
\r
381 vOLEDClear = RIT128x96x4Clear;
\r
382 ulMaxY = mainMAX_ROWS_96;
\r
383 pucImage = pucBasicBitmap;
\r
386 default : vOLEDInit = vFormike128x128x16Init;
\r
387 vOLEDStringDraw = vFormike128x128x16StringDraw;
\r
388 vOLEDImageDraw = vFormike128x128x16ImageDraw;
\r
389 vOLEDClear = vFormike128x128x16Clear;
\r
390 ulMaxY = mainMAX_ROWS_128;
\r
391 pucImage = pucGrLibBitmap;
\r
397 /* Initialise the OLED and display a startup message. */
\r
398 vOLEDInit( ulSSI_FREQUENCY );
\r
399 vOLEDStringDraw( "POWERED BY FreeRTOS", 0, 0, mainFULL_SCALE );
\r
400 vOLEDImageDraw( pucImage, 0, mainCHARACTER_HEIGHT + 1, bmpBITMAP_WIDTH, bmpBITMAP_HEIGHT );
\r
404 /* Wait for a message to arrive that requires displaying. */
\r
405 xQueueReceive( xOLEDQueue, &xMessage, portMAX_DELAY );
\r
407 /* Write the message on the next available row. */
\r
408 ulY += mainCHARACTER_HEIGHT;
\r
409 if( ulY >= ulMaxY )
\r
411 ulY = mainCHARACTER_HEIGHT;
\r
413 vOLEDStringDraw( pcWelcomeMessage, 0, 0, mainFULL_SCALE );
\r
416 /* Display the message along with the maximum jitter time from the
\r
417 high priority time test. */
\r
418 sprintf( cMessage, "%s [%uns]", xMessage.pcMessage, ulMaxJitter * mainNS_PER_CLOCK );
\r
419 vOLEDStringDraw( cMessage, 0, ulY, mainFULL_SCALE );
\r
422 /*-----------------------------------------------------------*/
\r
424 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName )
\r
428 /*-----------------------------------------------------------*/
\r
430 void vApplicationMallocFailedHook( void )
\r
434 /*-----------------------------------------------------------*/
\r
436 /* Just to keep the linker happy. */
\r
437 void __error__( char *pcFilename, unsigned long ulLine )
\r
442 int uipprintf( const char *fmt, ... )
\r