2 FreeRTOS.org V5.1.1 - Copyright (C) 2003-2008 Richard Barry.
\r
4 This file is part of the FreeRTOS.org distribution.
\r
6 FreeRTOS.org is free software; you can redistribute it and/or modify
\r
7 it under the terms of the GNU General Public License as published by
\r
8 the Free Software Foundation; either version 2 of the License, or
\r
9 (at your option) any later version.
\r
11 FreeRTOS.org is distributed in the hope that it will be useful,
\r
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
\r
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
\r
14 GNU General Public License for more details.
\r
16 You should have received a copy of the GNU General Public License
\r
17 along with FreeRTOS.org; if not, write to the Free Software
\r
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
\r
20 A special exception to the GPL can be applied should you wish to distribute
\r
21 a combined work that includes FreeRTOS.org, without being obliged to provide
\r
22 the source code for any proprietary components. See the licensing section
\r
23 of http://www.FreeRTOS.org for full details of how and when the exception
\r
26 ***************************************************************************
\r
27 ***************************************************************************
\r
29 * SAVE TIME AND MONEY! We can port FreeRTOS.org to your own hardware, *
\r
30 * and even write all or part of your application on your behalf. *
\r
31 * See http://www.OpenRTOS.com for details of the services we provide to *
\r
32 * expedite your project. *
\r
34 ***************************************************************************
\r
35 ***************************************************************************
\r
37 Please ensure to read the configuration and relevant port sections of the
\r
38 online documentation.
\r
40 http://www.FreeRTOS.org - Documentation, latest information, license and
\r
43 http://www.SafeRTOS.com - A version that is certified for use in safety
\r
46 http://www.OpenRTOS.com - Commercial support, development, porting,
\r
47 licensing and training services.
\r
51 * This demo application creates seven co-routines and one task (two including
\r
52 * the idle task). The co-routines execute as part of the idle task hook.
\r
54 * Five of the created co-routines are the standard 'co-routine flash'
\r
55 * co-routines contained within the Demo/Common/Minimal/crflash.c file and
\r
56 * documented on the FreeRTOS.org WEB site.
\r
58 * The 'LCD Task' rotates a string on the LCD, delaying between each character
\r
59 * as necessitated by the slow interface, and delaying between each string just
\r
60 * long enough to enable the text to be read.
\r
62 * The sixth co-routine controls the transmission of a string to UART 0. The
\r
63 * co-routine periodically sends the first character of the string to the UART,
\r
64 * with the UART's TxEnd interrupt being used to transmit the remaining
\r
65 * characters. The UART's RxEnd interrupt receives the characters and places
\r
66 * them on a queue to be processed by the seventh and final co-routine. An
\r
67 * error is latched should an unexpected character be received, or any
\r
68 * character be received out of sequence.
\r
70 * A loopback connector is required to ensure that each character transmitted
\r
71 * on the UART is also received on the same UART. For test purposes the UART
\r
72 * FIFO's are not utalised in order to maximise the interrupt overhead. Also
\r
73 * a pseudo random interval is used between the start of each transmission in
\r
74 * order that the resultant interrupts are more randomly distributed and
\r
75 * therefore more likely to highlight any problems.
\r
77 * The flash co-routines control LED's zero to four. LED five is toggled each
\r
78 * time the string is transmitted on the UART. LED six is toggled each time
\r
79 * the string is CORRECTLY received on the UART. LED seven is latched on should
\r
80 * an error be detected in any task or co-routine.
\r
82 * In addition the idle task makes repetative calls to
\r
83 * prvSetAndCheckRegisters(). This simply loads the general purpose registers
\r
84 * with a known value, then checks each register to ensure the held value is
\r
85 * still correct. As a low priority task this checking routine is likely to
\r
86 * get repeatedly swapped in and out. A register being found to contain an
\r
87 * incorrect value is therefore indicative of an error in the task switching
\r
92 /* Scheduler include files. */
\r
93 #include "FreeRTOS.h"
\r
96 #include "croutine.h"
\r
98 /* Demo application include files. */
\r
99 #include "partest.h"
\r
100 #include "crflash.h"
\r
102 /* Library include files. */
\r
103 #include "LM3Sxxx.h"
\r
106 /* The time to delay between writing each character to the LCD. */
\r
107 #define mainCHAR_WRITE_DELAY ( 2 / portTICK_RATE_MS )
\r
109 /* The time to delay between writing each string to the LCD. */
\r
110 #define mainSTRING_WRITE_DELAY ( 400 / portTICK_RATE_MS )
\r
112 /* The number of flash co-routines to create. */
\r
113 #define mainNUM_FLASH_CO_ROUTINES ( 5 )
\r
115 /* The length of the queue used to pass received characters to the Comms Rx
\r
117 #define mainRX_QUEUE_LEN ( 5 )
\r
119 /* The priority of the co-routine used to initiate the transmission of the
\r
120 string on UART 0. */
\r
121 #define mainTX_CO_ROUTINE_PRIORITY ( 1 )
\r
123 /* The priority of the co-routine used to receive characters from the UART. */
\r
124 #define mainRX_CO_ROUTINE_PRIORITY ( 2 )
\r
126 /* Only one co-routine is created so its index is not important. */
\r
127 #define mainTX_CO_ROUTINE_INDEX ( 0 )
\r
128 #define mainRX_CO_ROUTINE_INDEX ( 0 )
\r
130 /* The time between transmissions of the string on UART 0. This is pseudo
\r
131 random in order to generate a bit or randomness to when the interrupts occur.*/
\r
132 #define mainMIN_TX_DELAY ( 40 / portTICK_RATE_MS )
\r
133 #define mainMAX_TX_DELAY ( ( portTickType ) 0x7f )
\r
134 #define mainOFFSET_TIME ( ( portTickType ) 3 )
\r
136 /* The time the Comms Rx task should wait to receive a character. This should
\r
137 be slightly longer than the time between transmissions. If we do not receive
\r
138 a character after this time then there must be an error in the transmission or
\r
139 the timing of the transmission. */
\r
140 #define mainCOMMS_RX_DELAY ( mainMAX_TX_DELAY + 20 )
\r
142 /* The task priorites. */
\r
143 #define mainLCD_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
144 #define mainCOMMS_RX_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
146 /* The LED's toggled by the various tasks. */
\r
147 #define mainCOMMS_FAIL_LED ( 7 )
\r
148 #define mainCOMMS_RX_LED ( 6 )
\r
149 #define mainCOMMS_TX_LED ( 5 )
\r
151 /* The baud rate used by the UART comms tasks/co-routine. */
\r
152 #define mainBAUD_RATE ( 57600 )
\r
154 /* FIFO setting for the UART. The FIFO is not used to create a better test. */
\r
155 #define mainFIFO_SET ( 0x10 )
\r
157 /* The string that is transmitted on the UART contains sequentially the
\r
158 characters from mainFIRST_TX_CHAR to mainLAST_TX_CHAR. */
\r
159 #define mainFIRST_TX_CHAR '0'
\r
160 #define mainLAST_TX_CHAR 'z'
\r
162 /* Just used to walk through the program memory in order that some random data
\r
163 can be generated. */
\r
164 #define mainTOTAL_PROGRAM_MEMORY ( ( unsigned portLONG * ) ( 8 * 1024 ) )
\r
165 #define mainFIRST_PROGRAM_BYTES ( ( unsigned portLONG * ) 4 )
\r
167 /*-----------------------------------------------------------*/
\r
170 * The task that rotates text on the LCD.
\r
172 static void vLCDTask( void * pvParameters );
\r
175 * The task that receives the characters from UART 0.
\r
177 static void vCommsRxCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex );
\r
180 * The co-routine that periodically initiates the transmission of the string on
\r
183 static void vSerialTxCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex );
\r
186 * Writes a string the the LCD.
\r
188 static void prvWriteString( const portCHAR *pcString );
\r
191 * Initialisation routine for the UART.
\r
193 static void vSerialInit( void );
\r
196 * Thread safe write to the PDC.
\r
198 static void prvPDCWrite( portCHAR cAddress, portCHAR cData );
\r
201 * Function to simply set a known value into the general purpose registers
\r
202 * then read them back to ensure they remain set correctly. An incorrect value
\r
203 * being indicative of an error in the task switching mechanism.
\r
205 void prvSetAndCheckRegisters( void );
\r
208 * Latch the LED that indicates that an error has occurred.
\r
210 void vSetErrorLED( void );
\r
213 * Sets up the PLL and ports used by the demo.
\r
215 static void prvSetupHardware( void );
\r
217 /*-----------------------------------------------------------*/
\r
219 /* Error flag set to pdFAIL if an error is encountered in the tasks/co-routines
\r
220 defined within this file. */
\r
221 unsigned portBASE_TYPE uxErrorStatus = pdPASS;
\r
223 /* The next character to transmit. */
\r
224 static portCHAR cNextChar;
\r
226 /* The queue used to transmit characters from the interrupt to the Comms Rx
\r
228 static xQueueHandle xCommsQueue;
\r
230 /*-----------------------------------------------------------*/
\r
234 /* Create the queue used to communicate between the UART ISR and the Comms
\r
236 xCommsQueue = xQueueCreate( mainRX_QUEUE_LEN, sizeof( portCHAR ) );
\r
238 /* Setup the ports used by the demo and the clock. */
\r
239 prvSetupHardware();
\r
241 /* Create the co-routines that flash the LED's. */
\r
242 vStartFlashCoRoutines( mainNUM_FLASH_CO_ROUTINES );
\r
244 /* Create the co-routine that initiates the transmission of characters
\r
246 xCoRoutineCreate( vSerialTxCoRoutine, mainTX_CO_ROUTINE_PRIORITY, mainTX_CO_ROUTINE_INDEX );
\r
248 /* Create the co-routine that receives characters from the UART. */
\r
249 xCoRoutineCreate( vCommsRxCoRoutine, mainRX_CO_ROUTINE_PRIORITY, mainRX_CO_ROUTINE_INDEX );
\r
251 /* Create the LCD task. */
\r
252 xTaskCreate( vLCDTask, "LCD", configMINIMAL_STACK_SIZE, NULL, mainLCD_TASK_PRIORITY, NULL );
\r
254 /* Start the scheduler running the tasks and co-routines just created. */
\r
255 vTaskStartScheduler();
\r
257 /* Should not get here unless we did not have enough memory to start the
\r
261 /*-----------------------------------------------------------*/
\r
263 static void prvSetupHardware( void )
\r
265 /* Setup the PLL. */
\r
266 SysCtlClockSet( SYSCTL_SYSDIV_10 | SYSCTL_USE_PLL | SYSCTL_OSC_MAIN | SYSCTL_XTAL_6MHZ );
\r
268 /* Initialise the hardware used to talk to the LCD, LED's and UART. */
\r
270 vParTestInitialise();
\r
273 /*-----------------------------------------------------------*/
\r
275 void vApplicationIdleHook( void )
\r
277 /* The co-routines are executed in the idle task using the idle task
\r
281 /* Schedule the co-routines. */
\r
282 vCoRoutineSchedule();
\r
284 /* Run the register check function between each co-routine. */
\r
285 prvSetAndCheckRegisters();
\r
288 /*-----------------------------------------------------------*/
\r
290 static void prvWriteString( const portCHAR *pcString )
\r
292 /* Write pcString to the LED, pausing between each character. */
\r
293 prvPDCWrite(PDC_LCD_CSR, LCD_CLEAR);
\r
296 vTaskDelay( mainCHAR_WRITE_DELAY );
\r
297 prvPDCWrite( PDC_LCD_RAM, *pcString );
\r
301 /*-----------------------------------------------------------*/
\r
303 void vLCDTask( void * pvParameters )
\r
305 unsigned portBASE_TYPE uxIndex;
\r
306 const unsigned portCHAR ucCFGData[] = {
\r
307 0x30, /* Set data bus to 8-bits. */
\r
310 0x3C, /* Number of lines/font. */
\r
311 0x08, /* Display off. */
\r
312 0x01, /* Display clear. */
\r
313 0x06, /* Entry mode [cursor dir][shift]. */
\r
314 0x0C /* Display on [display on][curson on][blinking on]. */
\r
317 /* The strings that are written to the LCD. */
\r
318 const portCHAR *pcStringsToDisplay[] = {
\r
322 "www.FreeRTOS.org",
\r
326 /* Configure the LCD. */
\r
328 while( uxIndex < sizeof( ucCFGData ) )
\r
330 prvPDCWrite( PDC_LCD_CSR, ucCFGData[ uxIndex ] );
\r
332 vTaskDelay( mainCHAR_WRITE_DELAY );
\r
335 /* Turn the LCD Backlight on. */
\r
336 prvPDCWrite( PDC_CSR, 0x01 );
\r
338 /* Clear display. */
\r
339 vTaskDelay( mainCHAR_WRITE_DELAY );
\r
340 prvPDCWrite( PDC_LCD_CSR, LCD_CLEAR );
\r
345 /* Display the string on the LCD. */
\r
346 prvWriteString( pcStringsToDisplay[ uxIndex ] );
\r
348 /* Move on to the next string - wrapping if necessary. */
\r
350 if( *( pcStringsToDisplay[ uxIndex ] ) == 0x00 )
\r
353 /* Longer pause on the last string to be sent. */
\r
354 vTaskDelay( mainSTRING_WRITE_DELAY * 2 );
\r
357 /* Wait until it is time to move onto the next string. */
\r
358 vTaskDelay( mainSTRING_WRITE_DELAY );
\r
361 /*-----------------------------------------------------------*/
\r
363 static void vCommsRxCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex )
\r
365 static portCHAR cRxedChar, cExpectedChar = mainFIRST_TX_CHAR;
\r
366 portBASE_TYPE xResult;
\r
368 crSTART( xHandle );
\r
372 /* Wait for a character to be received. */
\r
373 crQUEUE_RECEIVE( xHandle, xCommsQueue, ( void * ) &cRxedChar, mainCOMMS_RX_DELAY, &xResult );
\r
375 /* Was the character recived (if any) the expected character. */
\r
376 if( ( cRxedChar != cExpectedChar ) || ( xResult != pdPASS ) )
\r
378 /* Got an unexpected character. This can sometimes occur when
\r
379 reseting the system using the debugger leaving characters already
\r
380 in the UART regsters. */
\r
381 uxErrorStatus = pdFAIL;
\r
383 /* Resync by waiting for the end of the current string. */
\r
384 while( cRxedChar != mainLAST_TX_CHAR )
\r
386 crQUEUE_RECEIVE( xHandle, xCommsQueue, ( void * ) &cRxedChar, mainCOMMS_RX_DELAY, &xResult );
\r
389 /* The next expected character is the start of the string again. */
\r
390 cExpectedChar = mainFIRST_TX_CHAR;
\r
394 if( cExpectedChar == mainLAST_TX_CHAR )
\r
396 /* We have reached the end of the string - we now expect to
\r
397 receive the first character in the string again. The LED is
\r
398 toggled to indicate that the entire string was received without
\r
400 vParTestToggleLED( mainCOMMS_RX_LED );
\r
401 cExpectedChar = mainFIRST_TX_CHAR;
\r
405 /* We got the expected character, we now expect to receive the
\r
406 next character in the string. */
\r
414 /*-----------------------------------------------------------*/
\r
416 static void vSerialTxCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex )
\r
418 portTickType xDelayPeriod;
\r
419 static unsigned portLONG *pulRandomBytes = mainFIRST_PROGRAM_BYTES;
\r
421 /* Co-routine MUST start with a call to crSTART. */
\r
422 crSTART( xHandle );
\r
426 /* Was the previously transmitted string received correctly? */
\r
427 if( uxErrorStatus != pdPASS )
\r
429 /* An error was encountered so set the error LED. */
\r
433 /* The next character to Tx is the first in the string. */
\r
434 cNextChar = mainFIRST_TX_CHAR;
\r
436 UARTIntDisable( UART0_BASE, UART_INT_TX );
\r
438 /* Send the first character. */
\r
439 if( !( HWREG( UART0_BASE + UART_O_FR ) & UART_FR_TXFF ) )
\r
441 HWREG( UART0_BASE + UART_O_DR ) = cNextChar;
\r
444 /* Move the variable to the char to Tx on so the ISR transmits
\r
445 the next character in the string once this one has completed. */
\r
448 UARTIntEnable(UART0_BASE, UART_INT_TX);
\r
450 /* Toggle the LED to show a new string is being transmitted. */
\r
451 vParTestToggleLED( mainCOMMS_TX_LED );
\r
453 /* Delay before we start the string off again. A pseudo-random delay
\r
454 is used as this will provide a better test. */
\r
455 xDelayPeriod = xTaskGetTickCount() + ( *pulRandomBytes );
\r
458 if( pulRandomBytes > mainTOTAL_PROGRAM_MEMORY )
\r
460 pulRandomBytes = mainFIRST_PROGRAM_BYTES;
\r
463 /* Make sure we don't wait too long... */
\r
464 xDelayPeriod &= mainMAX_TX_DELAY;
\r
466 /* ...but we do want to wait. */
\r
467 if( xDelayPeriod < mainMIN_TX_DELAY )
\r
469 xDelayPeriod = mainMIN_TX_DELAY;
\r
472 /* Block for the random(ish) time. */
\r
473 crDELAY( xHandle, xDelayPeriod );
\r
476 /* Co-routine MUST end with a call to crEND. */
\r
479 /*-----------------------------------------------------------*/
\r
481 static void vSerialInit( void )
\r
483 /* Enable the UART. GPIOA has already been initialised. */
\r
484 SysCtlPeripheralEnable(SYSCTL_PERIPH_UART0);
\r
486 /* Set GPIO A0 and A1 as peripheral function. They are used to output the
\r
488 GPIODirModeSet( GPIO_PORTA_BASE, GPIO_PIN_0 | GPIO_PIN_1, GPIO_DIR_MODE_HW );
\r
490 /* Configure the UART for 8-N-1 operation. */
\r
491 UARTConfigSet( UART0_BASE, mainBAUD_RATE, UART_CONFIG_WLEN_8 | UART_CONFIG_PAR_NONE | UART_CONFIG_STOP_ONE );
\r
493 /* We dont want to use the fifo. This is for test purposes to generate
\r
494 as many interrupts as possible. */
\r
495 HWREG( UART0_BASE + UART_O_LCR_H ) &= ~mainFIFO_SET;
\r
497 /* Enable both Rx and Tx interrupts. */
\r
498 HWREG( UART0_BASE + UART_O_IM ) |= ( UART_INT_TX | UART_INT_RX );
\r
499 IntEnable( INT_UART0 );
\r
501 /*-----------------------------------------------------------*/
\r
503 void vUART_ISR(void)
\r
505 unsigned portLONG ulStatus;
\r
506 portCHAR cRxedChar;
\r
507 portBASE_TYPE xTaskWokenByPost = pdFALSE;
\r
509 /* What caused the interrupt. */
\r
510 ulStatus = UARTIntStatus( UART0_BASE, pdTRUE );
\r
512 /* Clear the interrupt. */
\r
513 UARTIntClear( UART0_BASE, ulStatus );
\r
515 /* Was an Rx interrpt pending? */
\r
516 if( ulStatus & UART_INT_RX )
\r
518 if( ( HWREG(UART0_BASE + UART_O_FR ) & UART_FR_RXFF ) )
\r
520 /* Get the char from the buffer and post it onto the queue of
\r
521 Rxed chars. Posting the character should wake the task that is
\r
522 blocked on the queue waiting for characters. */
\r
523 cRxedChar = ( portCHAR ) HWREG( UART0_BASE + UART_O_DR );
\r
524 xTaskWokenByPost = crQUEUE_SEND_FROM_ISR( xCommsQueue, &cRxedChar, xTaskWokenByPost );
\r
528 /* Was a Tx interrupt pending? */
\r
529 if( ulStatus & UART_INT_TX )
\r
531 /* Send the next character in the string. We are not using the FIFO. */
\r
532 if( cNextChar <= mainLAST_TX_CHAR )
\r
534 if( !( HWREG( UART0_BASE + UART_O_FR ) & UART_FR_TXFF ) )
\r
536 HWREG( UART0_BASE + UART_O_DR ) = cNextChar;
\r
542 if( xTaskWokenByPost )
\r
544 /* We are posting to a co-routine rather than a task so don't bother
\r
545 causing a task switch. */
\r
548 /*-----------------------------------------------------------*/
\r
550 static void prvPDCWrite( portCHAR cAddress, portCHAR cData )
\r
554 PDCWrite( cAddress, cData );
\r
558 /*-----------------------------------------------------------*/
\r
560 void vSetErrorLED( void )
\r
562 vParTestSetLED( mainCOMMS_FAIL_LED, pdTRUE );
\r
564 /*-----------------------------------------------------------*/
\r
566 __asm void prvSetAndCheckRegisters( void )
\r
568 extern vSetErrorLED
\r
570 /* Fill the general purpose registers with known values. */
\r
585 /* Check the values are as expected. */
\r
616 ldr r1, =vSetErrorLED
\r
621 /*-----------------------------------------------------------*/
\r