2 FreeRTOS V8.2.0 - 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
71 * This demo application creates seven co-routines and one task (two including
\r
72 * the idle task). The co-routines execute as part of the idle task hook.
\r
74 * Five of the created co-routines are the standard 'co-routine flash'
\r
75 * co-routines contained within the Demo/Common/Minimal/crflash.c file and
\r
76 * documented on the FreeRTOS.org WEB site.
\r
78 * The 'LCD Task' rotates a string on the LCD, delaying between each character
\r
79 * as necessitated by the slow interface, and delaying between each string just
\r
80 * long enough to enable the text to be read.
\r
82 * The sixth co-routine controls the transmission of a string to UART 0. The
\r
83 * co-routine periodically sends the first character of the string to the UART,
\r
84 * with the UART's TxEnd interrupt being used to transmit the remaining
\r
85 * characters. The UART's RxEnd interrupt receives the characters and places
\r
86 * them on a queue to be processed by the seventh and final co-routine. An
\r
87 * error is latched should an unexpected character be received, or any
\r
88 * character be received out of sequence.
\r
90 * A loopback connector is required to ensure that each character transmitted
\r
91 * on the UART is also received on the same UART. For test purposes the UART
\r
92 * FIFO's are not utalised in order to maximise the interrupt overhead. Also
\r
93 * a pseudo random interval is used between the start of each transmission in
\r
94 * order that the resultant interrupts are more randomly distributed and
\r
95 * therefore more likely to highlight any problems.
\r
97 * The flash co-routines control LED's zero to four. LED five is toggled each
\r
98 * time the string is transmitted on the UART. LED six is toggled each time
\r
99 * the string is CORRECTLY received on the UART. LED seven is latched on should
\r
100 * an error be detected in any task or co-routine.
\r
102 * In addition the idle task makes repetative calls to
\r
103 * prvSetAndCheckRegisters(). This simply loads the general purpose registers
\r
104 * with a known value, then checks each register to ensure the held value is
\r
105 * still correct. As a low priority task this checking routine is likely to
\r
106 * get repeatedly swapped in and out. A register being found to contain an
\r
107 * incorrect value is therefore indicative of an error in the task switching
\r
112 /* Scheduler include files. */
\r
113 #include "FreeRTOS.h"
\r
116 #include "croutine.h"
\r
118 /* Demo application include files. */
\r
119 #include "partest.h"
\r
120 #include "crflash.h"
\r
122 /* Library include files. */
\r
123 #include "DriverLib.h"
\r
125 /* The time to delay between writing each character to the LCD. */
\r
126 #define mainCHAR_WRITE_DELAY ( 2 / portTICK_PERIOD_MS )
\r
128 /* The time to delay between writing each string to the LCD. */
\r
129 #define mainSTRING_WRITE_DELAY ( 400 / portTICK_PERIOD_MS )
\r
131 /* The number of flash co-routines to create. */
\r
132 #define mainNUM_FLASH_CO_ROUTINES ( 5 )
\r
134 /* The length of the queue used to pass received characters to the Comms Rx
\r
136 #define mainRX_QUEUE_LEN ( 5 )
\r
138 /* The priority of the co-routine used to initiate the transmission of the
\r
139 string on UART 0. */
\r
140 #define mainTX_CO_ROUTINE_PRIORITY ( 1 )
\r
142 /* The priority of the co-routine used to receive characters from the UART. */
\r
143 #define mainRX_CO_ROUTINE_PRIORITY ( 2 )
\r
145 /* Only one co-routine is created so its index is not important. */
\r
146 #define mainTX_CO_ROUTINE_INDEX ( 0 )
\r
147 #define mainRX_CO_ROUTINE_INDEX ( 0 )
\r
149 /* The time between transmissions of the string on UART 0. This is pseudo
\r
150 random in order to generate a bit or randomness to when the interrupts occur.*/
\r
151 #define mainMIN_TX_DELAY ( 40 / portTICK_PERIOD_MS )
\r
152 #define mainMAX_TX_DELAY ( ( TickType_t ) 0x7f )
\r
153 #define mainOFFSET_TIME ( ( TickType_t ) 3 )
\r
155 /* The time the Comms Rx task should wait to receive a character. This should
\r
156 be slightly longer than the time between transmissions. If we do not receive
\r
157 a character after this time then there must be an error in the transmission or
\r
158 the timing of the transmission. */
\r
159 #define mainCOMMS_RX_DELAY ( mainMAX_TX_DELAY + 20 )
\r
161 /* The task priorites. */
\r
162 #define mainLCD_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
163 #define mainCOMMS_RX_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
165 /* The LED's toggled by the various tasks. */
\r
166 #define mainCOMMS_FAIL_LED ( 7 )
\r
167 #define mainCOMMS_RX_LED ( 6 )
\r
168 #define mainCOMMS_TX_LED ( 5 )
\r
170 /* The baud rate used by the UART comms tasks/co-routine. */
\r
171 #define mainBAUD_RATE ( 57600 )
\r
173 /* FIFO setting for the UART. The FIFO is not used to create a better test. */
\r
174 #define mainFIFO_SET ( 0x10 )
\r
176 /* The string that is transmitted on the UART contains sequentially the
\r
177 characters from mainFIRST_TX_CHAR to mainLAST_TX_CHAR. */
\r
178 #define mainFIRST_TX_CHAR '0'
\r
179 #define mainLAST_TX_CHAR 'z'
\r
181 /* Just used to walk through the program memory in order that some random data
\r
182 can be generated. */
\r
183 #define mainTOTAL_PROGRAM_MEMORY ( ( unsigned long * ) ( 8 * 1024 ) )
\r
184 #define mainFIRST_PROGRAM_BYTES ( ( unsigned long * ) 4 )
\r
186 /* The error routine that is called if the driver library encounters an error. */
\r
189 __error__(char *pcFilename, unsigned long ulLine)
\r
194 /*-----------------------------------------------------------*/
\r
197 * The task that rotates text on the LCD.
\r
199 static void vLCDTask( void * pvParameters );
\r
202 * The task that receives the characters from UART 0.
\r
204 static void vCommsRxCoRoutine( CoRoutineHandle_t xHandle, unsigned portBASE_TYPE uxIndex );
\r
207 * The co-routine that periodically initiates the transmission of the string on
\r
210 static void vSerialTxCoRoutine( CoRoutineHandle_t xHandle, unsigned portBASE_TYPE uxIndex );
\r
213 * Writes a string the the LCD.
\r
215 static void prvWriteString( const char *pcString );
\r
218 * Initialisation routine for the UART.
\r
220 static void vSerialInit( void );
\r
223 * Thread safe write to the PDC.
\r
225 static void prvPDCWrite( char cAddress, char cData );
\r
228 * Function to simply set a known value into the general purpose registers
\r
229 * then read them back to ensure they remain set correctly. An incorrect value
\r
230 * being indicative of an error in the task switching mechanism.
\r
232 void prvSetAndCheckRegisters( void );
\r
235 * Latch the LED that indicates that an error has occurred.
\r
237 void vSetErrorLED( void );
\r
240 * Sets up the PLL and ports used by the demo.
\r
242 static void prvSetupHardware( void );
\r
244 /*-----------------------------------------------------------*/
\r
246 /* Error flag set to pdFAIL if an error is encountered in the tasks/co-routines
\r
247 defined within this file. */
\r
248 unsigned portBASE_TYPE uxErrorStatus = pdPASS;
\r
250 /* The next character to transmit. */
\r
251 static char cNextChar;
\r
253 /* The queue used to transmit characters from the interrupt to the Comms Rx
\r
255 static QueueHandle_t xCommsQueue;
\r
257 /*-----------------------------------------------------------*/
\r
261 /* Create the queue used to communicate between the UART ISR and the Comms
\r
263 xCommsQueue = xQueueCreate( mainRX_QUEUE_LEN, sizeof( char ) );
\r
265 /* Setup the ports used by the demo and the clock. */
\r
266 prvSetupHardware();
\r
268 /* Create the co-routines that flash the LED's. */
\r
269 vStartFlashCoRoutines( mainNUM_FLASH_CO_ROUTINES );
\r
271 /* Create the co-routine that initiates the transmission of characters
\r
273 xCoRoutineCreate( vSerialTxCoRoutine, mainTX_CO_ROUTINE_PRIORITY, mainTX_CO_ROUTINE_INDEX );
\r
275 /* Create the co-routine that receives characters from the UART. */
\r
276 xCoRoutineCreate( vCommsRxCoRoutine, mainRX_CO_ROUTINE_PRIORITY, mainRX_CO_ROUTINE_INDEX );
\r
278 /* Create the LCD task. */
\r
279 xTaskCreate( vLCDTask, "LCD", configMINIMAL_STACK_SIZE, NULL, mainLCD_TASK_PRIORITY, NULL );
\r
281 /* Start the scheduler running the tasks and co-routines just created. */
\r
282 vTaskStartScheduler();
\r
284 /* Should not get here unless we did not have enough memory to start the
\r
288 /*-----------------------------------------------------------*/
\r
290 static void prvSetupHardware( void )
\r
292 /* Setup the PLL. */
\r
293 SysCtlClockSet( SYSCTL_SYSDIV_10 | SYSCTL_USE_PLL | SYSCTL_OSC_MAIN | SYSCTL_XTAL_6MHZ );
\r
295 /* Initialise the hardware used to talk to the LCD, LED's and UART. */
\r
297 vParTestInitialise();
\r
300 /*-----------------------------------------------------------*/
\r
302 void vApplicationIdleHook( void )
\r
304 /* The co-routines are executed in the idle task using the idle task
\r
308 /* Schedule the co-routines. */
\r
309 vCoRoutineSchedule();
\r
311 /* Run the register check function between each co-routine. */
\r
312 prvSetAndCheckRegisters();
\r
315 /*-----------------------------------------------------------*/
\r
317 static void prvWriteString( const char *pcString )
\r
319 /* Write pcString to the LED, pausing between each character. */
\r
320 prvPDCWrite(PDC_LCD_CSR, LCD_CLEAR);
\r
323 vTaskDelay( mainCHAR_WRITE_DELAY );
\r
324 prvPDCWrite( PDC_LCD_RAM, *pcString );
\r
328 /*-----------------------------------------------------------*/
\r
330 void vLCDTask( void * pvParameters )
\r
332 unsigned portBASE_TYPE uxIndex;
\r
333 const unsigned char ucCFGData[] = {
\r
334 0x30, /* Set data bus to 8-bits. */
\r
337 0x3C, /* Number of lines/font. */
\r
338 0x08, /* Display off. */
\r
339 0x01, /* Display clear. */
\r
340 0x06, /* Entry mode [cursor dir][shift]. */
\r
341 0x0C /* Display on [display on][curson on][blinking on]. */
\r
344 /* The strings that are written to the LCD. */
\r
345 const char *pcStringsToDisplay[] = {
\r
349 "www.FreeRTOS.org",
\r
353 /* Configure the LCD. */
\r
355 while( uxIndex < sizeof( ucCFGData ) )
\r
357 prvPDCWrite( PDC_LCD_CSR, ucCFGData[ uxIndex ] );
\r
359 vTaskDelay( mainCHAR_WRITE_DELAY );
\r
362 /* Turn the LCD Backlight on. */
\r
363 prvPDCWrite( PDC_CSR, 0x01 );
\r
365 /* Clear display. */
\r
366 vTaskDelay( mainCHAR_WRITE_DELAY );
\r
367 prvPDCWrite( PDC_LCD_CSR, LCD_CLEAR );
\r
372 /* Display the string on the LCD. */
\r
373 prvWriteString( pcStringsToDisplay[ uxIndex ] );
\r
375 /* Move on to the next string - wrapping if necessary. */
\r
377 if( *( pcStringsToDisplay[ uxIndex ] ) == 0x00 )
\r
380 /* Longer pause on the last string to be sent. */
\r
381 vTaskDelay( mainSTRING_WRITE_DELAY * 2 );
\r
384 /* Wait until it is time to move onto the next string. */
\r
385 vTaskDelay( mainSTRING_WRITE_DELAY );
\r
388 /*-----------------------------------------------------------*/
\r
390 static void vCommsRxCoRoutine( CoRoutineHandle_t xHandle, unsigned portBASE_TYPE uxIndex )
\r
392 static char cRxedChar, cExpectedChar = mainFIRST_TX_CHAR;
\r
393 portBASE_TYPE xResult;
\r
395 crSTART( xHandle );
\r
399 /* Wait for a character to be received. */
\r
400 crQUEUE_RECEIVE( xHandle, xCommsQueue, ( void * ) &cRxedChar, mainCOMMS_RX_DELAY, &xResult );
\r
402 /* Was the character recived (if any) the expected character. */
\r
403 if( ( cRxedChar != cExpectedChar ) || ( xResult != pdPASS ) )
\r
405 /* Got an unexpected character. This can sometimes occur when
\r
406 reseting the system using the debugger leaving characters already
\r
407 in the UART regsters. */
\r
408 uxErrorStatus = pdFAIL;
\r
410 /* Resync by waiting for the end of the current string. */
\r
411 while( cRxedChar != mainLAST_TX_CHAR )
\r
413 crQUEUE_RECEIVE( xHandle, xCommsQueue, ( void * ) &cRxedChar, mainCOMMS_RX_DELAY, &xResult );
\r
416 /* The next expected character is the start of the string again. */
\r
417 cExpectedChar = mainFIRST_TX_CHAR;
\r
421 if( cExpectedChar == mainLAST_TX_CHAR )
\r
423 /* We have reached the end of the string - we now expect to
\r
424 receive the first character in the string again. The LED is
\r
425 toggled to indicate that the entire string was received without
\r
427 vParTestToggleLED( mainCOMMS_RX_LED );
\r
428 cExpectedChar = mainFIRST_TX_CHAR;
\r
432 /* We got the expected character, we now expect to receive the
\r
433 next character in the string. */
\r
441 /*-----------------------------------------------------------*/
\r
443 static void vSerialTxCoRoutine( CoRoutineHandle_t xHandle, unsigned portBASE_TYPE uxIndex )
\r
445 TickType_t xDelayPeriod;
\r
446 static unsigned long *pulRandomBytes = mainFIRST_PROGRAM_BYTES;
\r
448 /* Co-routine MUST start with a call to crSTART. */
\r
449 crSTART( xHandle );
\r
453 /* Was the previously transmitted string received correctly? */
\r
454 if( uxErrorStatus != pdPASS )
\r
456 /* An error was encountered so set the error LED. */
\r
460 /* The next character to Tx is the first in the string. */
\r
461 cNextChar = mainFIRST_TX_CHAR;
\r
463 UARTIntDisable( UART0_BASE, UART_INT_TX );
\r
465 /* Send the first character. */
\r
466 if( !( HWREG( UART0_BASE + UART_O_FR ) & UART_FR_TXFF ) )
\r
468 HWREG( UART0_BASE + UART_O_DR ) = cNextChar;
\r
471 /* Move the variable to the char to Tx on so the ISR transmits
\r
472 the next character in the string once this one has completed. */
\r
475 UARTIntEnable(UART0_BASE, UART_INT_TX);
\r
477 /* Toggle the LED to show a new string is being transmitted. */
\r
478 vParTestToggleLED( mainCOMMS_TX_LED );
\r
480 /* Delay before we start the string off again. A pseudo-random delay
\r
481 is used as this will provide a better test. */
\r
482 xDelayPeriod = xTaskGetTickCount() + ( *pulRandomBytes );
\r
485 if( pulRandomBytes > mainTOTAL_PROGRAM_MEMORY )
\r
487 pulRandomBytes = mainFIRST_PROGRAM_BYTES;
\r
490 /* Make sure we don't wait too long... */
\r
491 xDelayPeriod &= mainMAX_TX_DELAY;
\r
493 /* ...but we do want to wait. */
\r
494 if( xDelayPeriod < mainMIN_TX_DELAY )
\r
496 xDelayPeriod = mainMIN_TX_DELAY;
\r
499 /* Block for the random(ish) time. */
\r
500 crDELAY( xHandle, xDelayPeriod );
\r
503 /* Co-routine MUST end with a call to crEND. */
\r
506 /*-----------------------------------------------------------*/
\r
508 static void vSerialInit( void )
\r
510 /* Enable the UART. GPIOA has already been initialised. */
\r
511 SysCtlPeripheralEnable(SYSCTL_PERIPH_UART0);
\r
513 /* Set GPIO A0 and A1 as peripheral function. They are used to output the
\r
515 GPIODirModeSet( GPIO_PORTA_BASE, GPIO_PIN_0 | GPIO_PIN_1, GPIO_DIR_MODE_HW );
\r
517 /* Configure the UART for 8-N-1 operation. */
\r
518 UARTConfigSet( UART0_BASE, mainBAUD_RATE, UART_CONFIG_WLEN_8 | UART_CONFIG_PAR_NONE | UART_CONFIG_STOP_ONE );
\r
520 /* We dont want to use the fifo. This is for test purposes to generate
\r
521 as many interrupts as possible. */
\r
522 HWREG( UART0_BASE + UART_O_LCR_H ) &= ~mainFIFO_SET;
\r
524 /* Enable both Rx and Tx interrupts. */
\r
525 HWREG( UART0_BASE + UART_O_IM ) |= ( UART_INT_TX | UART_INT_RX );
\r
526 IntEnable( INT_UART0 );
\r
528 /*-----------------------------------------------------------*/
\r
530 void vUART_ISR(void)
\r
532 unsigned long ulStatus;
\r
534 portBASE_TYPE xTaskWokenByPost = pdFALSE;
\r
536 /* What caused the interrupt. */
\r
537 ulStatus = UARTIntStatus( UART0_BASE, pdTRUE );
\r
539 /* Clear the interrupt. */
\r
540 UARTIntClear( UART0_BASE, ulStatus );
\r
542 /* Was an Rx interrpt pending? */
\r
543 if( ulStatus & UART_INT_RX )
\r
545 if( ( HWREG(UART0_BASE + UART_O_FR ) & UART_FR_RXFF ) )
\r
547 /* Get the char from the buffer and post it onto the queue of
\r
548 Rxed chars. Posting the character should wake the task that is
\r
549 blocked on the queue waiting for characters. */
\r
550 cRxedChar = ( char ) HWREG( UART0_BASE + UART_O_DR );
\r
551 xTaskWokenByPost = crQUEUE_SEND_FROM_ISR( xCommsQueue, &cRxedChar, xTaskWokenByPost );
\r
555 /* Was a Tx interrupt pending? */
\r
556 if( ulStatus & UART_INT_TX )
\r
558 /* Send the next character in the string. We are not using the FIFO. */
\r
559 if( cNextChar <= mainLAST_TX_CHAR )
\r
561 if( !( HWREG( UART0_BASE + UART_O_FR ) & UART_FR_TXFF ) )
\r
563 HWREG( UART0_BASE + UART_O_DR ) = cNextChar;
\r
569 if( xTaskWokenByPost )
\r
571 /* We are posting to a co-routine rather than a task so don't bother
\r
572 causing a task switch. */
\r
575 /*-----------------------------------------------------------*/
\r
577 static void prvPDCWrite( char cAddress, char cData )
\r
581 PDCWrite( cAddress, cData );
\r
585 /*-----------------------------------------------------------*/
\r
587 void vSetErrorLED( void )
\r
589 vParTestSetLED( mainCOMMS_FAIL_LED, pdTRUE );
\r
591 /*-----------------------------------------------------------*/
\r
593 void prvSetAndCheckRegisters( void )
\r
595 /* Fill the general purpose registers with known values. */
\r
596 __asm volatile( " mov r11, #10\n"
\r
597 " add r0, r11, #1\n"
\r
598 " add r1, r11, #2\n"
\r
599 " add r2, r11, #3\n"
\r
600 " add r3, r11, #4\n"
\r
601 " add r4, r11, #5\n"
\r
602 " add r5, r11, #6\n"
\r
603 " add r6, r11, #7\n"
\r
604 " add r7, r11, #8\n"
\r
605 " add r12, r11, #12" );
\r
607 /* Check the values are as expected. */
\r
608 __asm volatile( " cmp r11, #10\n"
\r
609 " bne set_error_led\n"
\r
611 " bne set_error_led\n"
\r
613 " bne set_error_led\n"
\r
615 " bne set_error_led\n"
\r
617 " bne set_error_led\n"
\r
619 " bne set_error_led\n"
\r
621 " bne set_error_led\n"
\r
623 " bne set_error_led\n"
\r
625 " bne set_error_led\n"
\r
627 " bne set_error_led\n"
\r
630 __asm volatile( "set_error_led:\n"
\r
632 " ldr r1, =vSetErrorLED\n"
\r
637 /*-----------------------------------------------------------*/
\r