2 FreeRTOS.org V4.2.1 - Copyright (C) 2003-2007 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 See http://www.FreeRTOS.org for documentation, latest information, license
\r
28 and contact details. Please ensure to read the configuration and relevant
\r
29 port sections of the online documentation.
\r
31 Also see http://www.SafeRTOS.com for an IEC 61508 compliant version along
\r
32 with commercial development and support options.
\r
33 ***************************************************************************
\r
37 * This demo application creates six co-routines and two tasks (three including
\r
38 * the idle task). The co-routines execute as part of the idle task hook.
\r
40 * Five of the created co-routines are the standard 'co-routine flash'
\r
41 * co-routines contained within the Demo/Common/Minimal/crflash.c file and
\r
42 * documented on the FreeRTOS.org WEB site.
\r
44 * The 'LCD Task' rotates a string on the LCD, delaying between each character
\r
45 * as necessitated by the slow interface, and delaying between each string just
\r
46 * long enough to enable the text to be read.
\r
48 * The sixth co-routine and final task control the transmission and reception
\r
49 * of a string to UART 0. The co-routine periodically sends the first
\r
50 * character of the string to the UART, with the UART's TxEnd interrupt being
\r
51 * used to transmit the remaining characters. The UART's RxEnd interrupt
\r
52 * receives the characters and places them on a queue to be processed by the
\r
53 * 'COMs Rx' task. An error is latched should an unexpected character be
\r
54 * received, or any character be received out of sequence.
\r
56 * A loopback connector is required to ensure that each character transmitted
\r
57 * on the UART is also received on the same UART. For test purposes the UART
\r
58 * FIFO's are not utalised in order to maximise the interrupt overhead. Also
\r
59 * a pseudo random interval is used between the start of each transmission in
\r
60 * order that the resultant interrupts are more randomly distributed and
\r
61 * therefore more likely to highlight any problems.
\r
63 * The flash co-routines control LED's zero to four. LED five is toggled each
\r
64 * time the string is transmitted on the UART. LED six is toggled each time
\r
65 * the string is CORRECTLY received on the UART. LED seven is latched on should
\r
66 * an error be detected in any task or co-routine.
\r
68 * In addition the idle task makes repetative calls to
\r
69 * prvSetAndCheckRegisters(). This simply loads the general purpose registers
\r
70 * with a known value, then checks each register to ensure the held value is
\r
71 * still correct. As a low priority task this checking routine is likely to
\r
72 * get repeatedly swapped in and out. A register being found to contain an
\r
73 * incorrect value is therefore indicative of an error in the task switching
\r
78 /* Scheduler include files. */
\r
79 #include "FreeRTOS.h"
\r
82 #include "croutine.h"
\r
84 /* Demo application include files. */
\r
85 #include "partest.h"
\r
86 #include "crflash.h"
\r
88 /* Library include files. */
\r
89 #include "LM3Sxxx.h"
\r
92 /* The time to delay between writing each character to the LCD. */
\r
93 #define mainCHAR_WRITE_DELAY ( 2 / portTICK_RATE_MS )
\r
95 /* The time to delay between writing each string to the LCD. */
\r
96 #define mainSTRING_WRITE_DELAY ( 400 / portTICK_RATE_MS )
\r
98 /* The number of flash co-routines to create. */
\r
99 #define mainNUM_FLASH_CO_ROUTINES ( 5 )
\r
101 /* The length of the queue used to pass received characters to the Comms Rx
\r
103 #define mainRX_QUEUE_LEN ( 5 )
\r
105 /* The priority of the co-routine used to initiate the transmission of the
\r
106 string on UART 0. */
\r
107 #define mainTX_CO_ROUTINE_PRIORITY ( 1 )
\r
109 /* Only one co-routine is created so its index is not important. */
\r
110 #define mainTX_CO_ROUTINE_INDEX ( 0 )
\r
112 /* The time between transmissions of the string on UART 0. This is pseudo
\r
113 random in order to generate a bit or randomness to when the interrupts occur.*/
\r
114 #define mainMIN_TX_DELAY ( 40 / portTICK_RATE_MS )
\r
115 #define mainMAX_TX_DELAY ( ( portTickType ) 0x7f )
\r
116 #define mainOFFSET_TIME ( ( portTickType ) 3 )
\r
118 /* The time the Comms Rx task should wait to receive a character. This should
\r
119 be slightly longer than the time between transmissions. If we do not receive
\r
120 a character after this time then there must be an error in the transmission or
\r
121 the timing of the transmission. */
\r
122 #define mainCOMMS_RX_DELAY ( mainMAX_TX_DELAY + 20 )
\r
124 /* The task priorites. */
\r
125 #define mainLCD_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
126 #define mainCOMMS_RX_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
128 /* The LED's toggled by the various tasks. */
\r
129 #define mainCOMMS_FAIL_LED ( 7 )
\r
130 #define mainCOMMS_RX_LED ( 6 )
\r
131 #define mainCOMMS_TX_LED ( 5 )
\r
133 /* The baud rate used by the UART comms tasks/co-routine. */
\r
134 #define mainBAUD_RATE ( 57600 )
\r
136 /* FIFO setting for the UART. The FIFO is not used to create a better test. */
\r
137 #define mainFIFO_SET ( 0x10 )
\r
139 /* The string that is transmitted on the UART contains sequentially the
\r
140 characters from mainFIRST_TX_CHAR to mainLAST_TX_CHAR. */
\r
141 #define mainFIRST_TX_CHAR '0'
\r
142 #define mainLAST_TX_CHAR 'z'
\r
144 /* Just used to walk through the program memory in order that some random data
\r
145 can be generated. */
\r
146 #define mainTOTAL_PROGRAM_MEMORY ( ( unsigned portLONG * ) ( 8 * 1024 ) )
\r
147 #define mainFIRST_PROGRAM_BYTES ( ( unsigned portLONG * ) 4 )
\r
149 /*-----------------------------------------------------------*/
\r
152 * The task that rotates text on the LCD.
\r
154 static void vLCDTask( void * pvParameters );
\r
157 * The task that receives the characters from UART 0.
\r
159 static void vCommsRxTask( void * pvParameters );
\r
162 * The co-routine that periodically initiates the transmission of the string on
\r
165 static void vSerialTxCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex );
\r
168 * Writes a string the the LCD.
\r
170 static void prvWriteString( const portCHAR *pcString );
\r
173 * Initialisation routine for the UART.
\r
175 static void vSerialInit( void );
\r
178 * Thread safe write to the PDC.
\r
180 static void prvPDCWrite( portCHAR cAddress, portCHAR cData );
\r
183 * Function to simply set a known value into the general purpose registers
\r
184 * then read them back to ensure they remain set correctly. An incorrect value
\r
185 * being indicative of an error in the task switching mechanism.
\r
187 void prvSetAndCheckRegisters( void );
\r
190 * Latch the LED that indicates that an error has occurred.
\r
192 void vSetErrorLED( void );
\r
195 * Sets up the PLL and ports used by the demo.
\r
197 static void prvSetupHardware( void );
\r
199 /*-----------------------------------------------------------*/
\r
201 /* Error flag set to pdFAIL if an error is encountered in the tasks/co-routines
\r
202 defined within this file. */
\r
203 unsigned portBASE_TYPE uxErrorStatus = pdPASS;
\r
205 /* The next character to transmit. */
\r
206 static portCHAR cNextChar;
\r
208 /* The queue used to transmit characters from the interrupt to the Comms Rx
\r
210 static xQueueHandle xCommsQueue;
\r
212 /*-----------------------------------------------------------*/
\r
216 /* Create the queue used to communicate between the UART ISR and the Comms
\r
218 xCommsQueue = xQueueCreate( mainRX_QUEUE_LEN, sizeof( portCHAR ) );
\r
220 /* Setup the ports used by the demo and the clock. */
\r
221 prvSetupHardware();
\r
223 /* Create the co-routines that flash the LED's. */
\r
224 vStartFlashCoRoutines( mainNUM_FLASH_CO_ROUTINES );
\r
226 /* Create the co-routine that initiates the transmission of characters
\r
228 xCoRoutineCreate( vSerialTxCoRoutine, mainTX_CO_ROUTINE_PRIORITY, mainTX_CO_ROUTINE_INDEX );
\r
230 /* Create the LCD and Comms Rx tasks. */
\r
231 xTaskCreate( vLCDTask, "LCD", configMINIMAL_STACK_SIZE, NULL, mainLCD_TASK_PRIORITY, NULL );
\r
232 xTaskCreate( vCommsRxTask, "CMS", configMINIMAL_STACK_SIZE, NULL, mainCOMMS_RX_TASK_PRIORITY, NULL );
\r
234 /* Start the scheduler running the tasks and co-routines just created. */
\r
235 vTaskStartScheduler();
\r
237 /* Should not get here unless we did not have enough memory to start the
\r
241 /*-----------------------------------------------------------*/
\r
243 static void prvSetupHardware( void )
\r
245 /* Setup the PLL. */
\r
246 SysCtlClockSet( SYSCTL_SYSDIV_10 | SYSCTL_USE_PLL | SYSCTL_OSC_MAIN | SYSCTL_XTAL_6MHZ );
\r
248 /* Initialise the hardware used to talk to the LCD, LED's and UART. */
\r
250 vParTestInitialise();
\r
253 /*-----------------------------------------------------------*/
\r
255 void vApplicationIdleHook( void )
\r
257 /* The co-routines are executed in the idle task using the idle task
\r
261 /* Schedule the co-routines. */
\r
262 vCoRoutineSchedule();
\r
264 /* Run the register check function between each co-routine. */
\r
265 prvSetAndCheckRegisters();
\r
268 /*-----------------------------------------------------------*/
\r
270 static void prvWriteString( const portCHAR *pcString )
\r
272 /* Write pcString to the LED, pausing between each character. */
\r
273 prvPDCWrite(PDC_LCD_CSR, LCD_CLEAR);
\r
276 vTaskDelay( mainCHAR_WRITE_DELAY );
\r
277 prvPDCWrite( PDC_LCD_RAM, *pcString );
\r
281 /*-----------------------------------------------------------*/
\r
283 void vLCDTask( void * pvParameters )
\r
285 unsigned portBASE_TYPE uxIndex;
\r
286 const unsigned portCHAR ucCFGData[] = {
\r
287 0x30, /* Set data bus to 8-bits. */
\r
290 0x3C, /* Number of lines/font. */
\r
291 0x08, /* Display off. */
\r
292 0x01, /* Display clear. */
\r
293 0x06, /* Entry mode [cursor dir][shift]. */
\r
294 0x0C /* Display on [display on][curson on][blinking on]. */
\r
297 /* The strings that are written to the LCD. */
\r
298 const portCHAR *pcStringsToDisplay[] = {
\r
302 "www.FreeRTOS.org",
\r
306 /* Configure the LCD. */
\r
308 while( uxIndex < sizeof( ucCFGData ) )
\r
310 prvPDCWrite( PDC_LCD_CSR, ucCFGData[ uxIndex ] );
\r
312 vTaskDelay( mainCHAR_WRITE_DELAY );
\r
315 /* Turn the LCD Backlight on. */
\r
316 prvPDCWrite( PDC_CSR, 0x01 );
\r
318 /* Clear display. */
\r
319 vTaskDelay( mainCHAR_WRITE_DELAY );
\r
320 prvPDCWrite( PDC_LCD_CSR, LCD_CLEAR );
\r
325 /* Display the string on the LCD. */
\r
326 prvWriteString( pcStringsToDisplay[ uxIndex ] );
\r
328 /* Move on to the next string - wrapping if necessary. */
\r
330 if( *( pcStringsToDisplay[ uxIndex ] ) == 0x00 )
\r
333 /* Longer pause on the last string to be sent. */
\r
334 vTaskDelay( mainSTRING_WRITE_DELAY * 2 );
\r
337 /* Wait until it is time to move onto the next string. */
\r
338 vTaskDelay( mainSTRING_WRITE_DELAY );
\r
341 /*-----------------------------------------------------------*/
\r
343 static void vCommsRxTask( void * pvParameters )
\r
345 static portCHAR cRxedChar, cExpectedChar;
\r
347 /* Set the char we expect to receive to the start of the string. */
\r
348 cExpectedChar = mainFIRST_TX_CHAR;
\r
352 /* Wait for a character to be received. */
\r
353 xQueueReceive( xCommsQueue, ( void * ) &cRxedChar, mainCOMMS_RX_DELAY );
\r
355 /* Was the character recived (if any) the expected character. */
\r
356 if( cRxedChar != cExpectedChar )
\r
358 /* Got an unexpected character. This can sometimes occur when
\r
359 reseting the system using the debugger leaving characters already
\r
360 in the UART regsters. */
\r
361 uxErrorStatus = pdFAIL;
\r
363 /* Resync by waiting for the end of the current string. */
\r
364 while( cRxedChar != mainLAST_TX_CHAR )
\r
366 while( !xQueueReceive( xCommsQueue, ( void * ) &cRxedChar, portMAX_DELAY ) );
\r
369 /* The next expected character is the start of the string again. */
\r
370 cExpectedChar = mainFIRST_TX_CHAR;
\r
374 if( cExpectedChar == mainLAST_TX_CHAR )
\r
376 /* We have reached the end of the string - we now expect to
\r
377 receive the first character in the string again. The LED is
\r
378 toggled to indicate that the entire string was received without
\r
380 vParTestToggleLED( mainCOMMS_RX_LED );
\r
381 cExpectedChar = mainFIRST_TX_CHAR;
\r
385 /* We got the expected character, we now expect to receive the
\r
386 next character in the string. */
\r
392 /*-----------------------------------------------------------*/
\r
394 static void vSerialTxCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex )
\r
396 portTickType xDelayPeriod;
\r
397 static unsigned portLONG *pulRandomBytes = mainFIRST_PROGRAM_BYTES;
\r
399 /* Co-routine MUST start with a call to crSTART. */
\r
400 crSTART( xHandle );
\r
404 /* Was the previously transmitted string received correctly? */
\r
405 if( uxErrorStatus != pdPASS )
\r
407 /* An error was encountered so set the error LED. */
\r
411 /* The next character to Tx is the first in the string. */
\r
412 cNextChar = mainFIRST_TX_CHAR;
\r
414 UARTIntDisable( UART0_BASE, UART_INT_TX );
\r
416 /* Send the first character. */
\r
417 if( !( HWREG( UART0_BASE + UART_O_FR ) & UART_FR_TXFF ) )
\r
419 HWREG( UART0_BASE + UART_O_DR ) = cNextChar;
\r
422 /* Move the variable to the char to Tx on so the ISR transmits
\r
423 the next character in the string once this one has completed. */
\r
426 UARTIntEnable(UART0_BASE, UART_INT_TX);
\r
428 /* Toggle the LED to show a new string is being transmitted. */
\r
429 vParTestToggleLED( mainCOMMS_TX_LED );
\r
431 /* Delay before we start the string off again. A pseudo-random delay
\r
432 is used as this will provide a better test. */
\r
433 xDelayPeriod = xTaskGetTickCount() + ( *pulRandomBytes );
\r
436 if( pulRandomBytes > mainTOTAL_PROGRAM_MEMORY )
\r
438 pulRandomBytes = mainFIRST_PROGRAM_BYTES;
\r
441 /* Make sure we don't wait too long... */
\r
442 xDelayPeriod &= mainMAX_TX_DELAY;
\r
444 /* ...but we do want to wait. */
\r
445 if( xDelayPeriod < mainMIN_TX_DELAY )
\r
447 xDelayPeriod = mainMIN_TX_DELAY;
\r
450 /* Block for the random(ish) time. */
\r
451 crDELAY( xHandle, xDelayPeriod );
\r
454 /* Co-routine MUST end with a call to crEND. */
\r
457 /*-----------------------------------------------------------*/
\r
459 static void vSerialInit( void )
\r
461 /* Enable the UART. GPIOA has already been initialised. */
\r
462 SysCtlPeripheralEnable(SYSCTL_PERIPH_UART0);
\r
464 /* Set GPIO A0 and A1 as peripheral function. They are used to output the
\r
466 GPIODirModeSet( GPIO_PORTA_BASE, GPIO_PIN_0 | GPIO_PIN_1, GPIO_DIR_MODE_HW );
\r
468 /* Configure the UART for 8-N-1 operation. */
\r
469 UARTConfigSet( UART0_BASE, mainBAUD_RATE, UART_CONFIG_WLEN_8 | UART_CONFIG_PAR_NONE | UART_CONFIG_STOP_ONE );
\r
471 /* We dont want to use the fifo. This is for test purposes to generate
\r
472 as many interrupts as possible. */
\r
473 HWREG( UART0_BASE + UART_O_LCR_H ) &= ~mainFIFO_SET;
\r
475 /* Enable both Rx and Tx interrupts. */
\r
476 HWREG( UART0_BASE + UART_O_IM ) |= ( UART_INT_TX | UART_INT_RX );
\r
477 IntEnable( INT_UART0 );
\r
479 /*-----------------------------------------------------------*/
\r
481 void vUART_ISR(void)
\r
483 unsigned portLONG ulStatus;
\r
484 portCHAR cRxedChar;
\r
485 portBASE_TYPE xTaskWokenByPost = pdFALSE;
\r
487 /* What caused the interrupt. */
\r
488 ulStatus = UARTIntStatus( UART0_BASE, pdTRUE );
\r
490 /* Clear the interrupt. */
\r
491 UARTIntClear( UART0_BASE, ulStatus );
\r
493 /* Was an Rx interrpt pending? */
\r
494 if( ulStatus & UART_INT_RX )
\r
496 if( ( HWREG(UART0_BASE + UART_O_FR ) & UART_FR_RXFF ) )
\r
498 /* Get the char from the buffer and post it onto the queue of
\r
499 Rxed chars. Posting the character should wake the task that is
\r
500 blocked on the queue waiting for characters. */
\r
501 cRxedChar = ( portCHAR ) HWREG( UART0_BASE + UART_O_DR );
\r
502 xTaskWokenByPost = xQueueSendFromISR( xCommsQueue, &cRxedChar, xTaskWokenByPost );
\r
506 /* Was a Tx interrupt pending? */
\r
507 if( ulStatus & UART_INT_TX )
\r
509 /* Send the next character in the string. We are not using the FIFO. */
\r
510 if( cNextChar <= mainLAST_TX_CHAR )
\r
512 if( !( HWREG( UART0_BASE + UART_O_FR ) & UART_FR_TXFF ) )
\r
514 HWREG( UART0_BASE + UART_O_DR ) = cNextChar;
\r
520 if( xTaskWokenByPost )
\r
522 /* If a task was woken by the character being received then we force
\r
523 a context switch to occur in case the task is of higher priority than
\r
524 the currently executing task (i.e. the task that this interrupt
\r
526 portEND_SWITCHING_ISR( xTaskWokenByPost );
\r
529 /*-----------------------------------------------------------*/
\r
531 static void prvPDCWrite( portCHAR cAddress, portCHAR cData )
\r
535 PDCWrite( cAddress, cData );
\r
539 /*-----------------------------------------------------------*/
\r
541 void vSetErrorLED( void )
\r
543 vParTestSetLED( mainCOMMS_FAIL_LED, pdTRUE );
\r
545 /*-----------------------------------------------------------*/
\r
547 __asm void prvSetAndCheckRegisters( void )
\r
549 extern vSetErrorLED
\r
551 /* Fill the general purpose registers with known values. */
\r
566 /* Check the values are as expected. */
\r
597 ldr r1, =vSetErrorLED
\r
602 /*-----------------------------------------------------------*/
\r