2 FreeRTOS V4.0.1 - Copyright (C) 2003-2006 Richard Barry.
\r
4 This file is part of the FreeRTOS distribution.
\r
6 FreeRTOS 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 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; 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, 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
30 ***************************************************************************
\r
34 * This demo application creates six co-routines and two tasks (three including
\r
35 * the idle task). The co-routines execute as part of the idle task hook.
\r
37 * Five of the created co-routines are the standard 'co-routine flash'
\r
38 * co-routines contained within the Demo/Common/Minimal/crflash.c file and
\r
39 * documented on the FreeRTOS.org WEB site.
\r
41 * The 'LCD Task' rotates a string on the LCD, delaying between each character
\r
42 * as necessitated by the slow interface, and delaying between each string just
\r
43 * long enough to enable the text to be read.
\r
45 * The sixth co-routine and final task control the transmission and reception
\r
46 * of a string to UART 0. The co-routine periodically sends the first
\r
47 * character of the string to the UART, with the UART's TxEnd interrupt being
\r
48 * used to transmit the remaining characters. The UART's RxEnd interrupt
\r
49 * receives the characters and places them on a queue to be processed by the
\r
50 * 'COMs Rx' task. An error is latched should an unexpected character be
\r
51 * received, or any character be received out of sequence.
\r
53 * A loopback connector is required to ensure that each character transmitted
\r
54 * on the UART is also received on the same UART. For test purposes the UART
\r
55 * FIFO's are not utalised in order to maximise the interrupt overhead. Also
\r
56 * a pseudo random interval is used between the start of each transmission in
\r
57 * order that the resultant interrupts are more randomly distributed and
\r
58 * therefore more likely to highlight any problems.
\r
60 * The flash co-routines control LED's zero to four. LED five is toggled each
\r
61 * time the string is transmitted on the UART. LED six is toggled each time
\r
62 * the string is CORRECTLY received on the UART. LED seven is latched on should
\r
63 * an error be detected in any task or co-routine.
\r
65 * In addition the idle task makes repetative calls to
\r
66 * prvSetAndCheckRegisters(). This simply loads the general purpose registers
\r
67 * with a known value, then checks each register to ensure the held value is
\r
68 * still correct. As a low priority task this checking routine is likely to
\r
69 * get repeatedly swapped in and out. A register being found to contain an
\r
70 * incorrect value is therefore indicative of an error in the task switching
\r
75 /* Scheduler include files. */
\r
76 #include "FreeRTOS.h"
\r
79 #include "croutine.h"
\r
81 /* Demo application include files. */
\r
82 #include "partest.h"
\r
83 #include "crflash.h"
\r
85 /* Library include files. */
\r
86 #include "LM3Sxxx.h"
\r
89 /* The time to delay between writing each character to the LCD. */
\r
90 #define mainCHAR_WRITE_DELAY ( 2 / portTICK_RATE_MS )
\r
92 /* The time to delay between writing each string to the LCD. */
\r
93 #define mainSTRING_WRITE_DELAY ( 400 / portTICK_RATE_MS )
\r
95 /* The number of flash co-routines to create. */
\r
96 #define mainNUM_FLASH_CO_ROUTINES ( 5 )
\r
98 /* The length of the queue used to pass received characters to the Comms Rx
\r
100 #define mainRX_QUEUE_LEN ( 5 )
\r
102 /* The priority of the co-routine used to initiate the transmission of the
\r
103 string on UART 0. */
\r
104 #define mainTX_CO_ROUTINE_PRIORITY ( 1 )
\r
106 /* Only one co-routine is created so its index is not important. */
\r
107 #define mainTX_CO_ROUTINE_INDEX ( 0 )
\r
109 /* The time between transmissions of the string on UART 0. This is pseudo
\r
110 random in order to generate a bit or randomness to when the interrupts occur.*/
\r
111 #define mainMIN_TX_DELAY ( 40 / portTICK_RATE_MS )
\r
112 #define mainMAX_TX_DELAY ( ( portTickType ) 0x7f )
\r
113 #define mainOFFSET_TIME ( ( portTickType ) 3 )
\r
115 /* The time the Comms Rx task should wait to receive a character. This should
\r
116 be slightly longer than the time between transmissions. If we do not receive
\r
117 a character after this time then there must be an error in the transmission or
\r
118 the timing of the transmission. */
\r
119 #define mainCOMMS_RX_DELAY ( mainMAX_TX_DELAY + 20 )
\r
121 /* The task priorites. */
\r
122 #define mainLCD_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
123 #define mainCOMMS_RX_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
125 /* The LED's toggled by the various tasks. */
\r
126 #define mainCOMMS_FAIL_LED ( 7 )
\r
127 #define mainCOMMS_RX_LED ( 6 )
\r
128 #define mainCOMMS_TX_LED ( 5 )
\r
130 /* The baud rate used by the UART comms tasks/co-routine. */
\r
131 #define mainBAUD_RATE ( 57600 )
\r
133 /* FIFO setting for the UART. The FIFO is not used to create a better test. */
\r
134 #define mainFIFO_SET ( 0x10 )
\r
136 /* The string that is transmitted on the UART contains sequentially the
\r
137 characters from mainFIRST_TX_CHAR to mainLAST_TX_CHAR. */
\r
138 #define mainFIRST_TX_CHAR '0'
\r
139 #define mainLAST_TX_CHAR 'z'
\r
141 /* Just used to walk through the program memory in order that some random data
\r
142 can be generated. */
\r
143 #define mainTOTAL_PROGRAM_MEMORY ( ( unsigned portLONG * ) ( 8 * 1024 ) )
\r
144 #define mainFIRST_PROGRAM_BYTES ( ( unsigned portLONG * ) 4 )
\r
146 /*-----------------------------------------------------------*/
\r
149 * The task that rotates text on the LCD.
\r
151 static void vLCDTask( void * pvParameters );
\r
154 * The task that receives the characters from UART 0.
\r
156 static void vCommsRxTask( void * pvParameters );
\r
159 * The co-routine that periodically initiates the transmission of the string on
\r
162 static void vSerialTxCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex );
\r
165 * Writes a string the the LCD.
\r
167 static void prvWriteString( const portCHAR *pcString );
\r
170 * Initialisation routine for the UART.
\r
172 static void vSerialInit( void );
\r
175 * Thread safe write to the PDC.
\r
177 static void prvPDCWrite( portCHAR cAddress, portCHAR cData );
\r
180 * Function to simply set a known value into the general purpose registers
\r
181 * then read them back to ensure they remain set correctly. An incorrect value
\r
182 * being indicative of an error in the task switching mechanism.
\r
184 void prvSetAndCheckRegisters( void );
\r
187 * Latch the LED that indicates that an error has occurred.
\r
189 void vSetErrorLED( void );
\r
192 * Sets up the PLL and ports used by the demo.
\r
194 static void prvSetupHardware( void );
\r
196 /*-----------------------------------------------------------*/
\r
198 /* Error flag set to pdFAIL if an error is encountered in the tasks/co-routines
\r
199 defined within this file. */
\r
200 unsigned portBASE_TYPE uxErrorStatus = pdPASS;
\r
202 /* The next character to transmit. */
\r
203 static portCHAR cNextChar;
\r
205 /* The queue used to transmit characters from the interrupt to the Comms Rx
\r
207 static xQueueHandle xCommsQueue;
\r
209 /*-----------------------------------------------------------*/
\r
213 /* Create the queue used to communicate between the UART ISR and the Comms
\r
215 xCommsQueue = xQueueCreate( mainRX_QUEUE_LEN, sizeof( portCHAR ) );
\r
217 /* Setup the ports used by the demo and the clock. */
\r
218 prvSetupHardware();
\r
220 /* Create the co-routines that flash the LED's. */
\r
221 vStartFlashCoRoutines( mainNUM_FLASH_CO_ROUTINES );
\r
223 /* Create the co-routine that initiates the transmission of characters
\r
225 xCoRoutineCreate( vSerialTxCoRoutine, mainTX_CO_ROUTINE_PRIORITY, mainTX_CO_ROUTINE_INDEX );
\r
227 /* Create the LCD and Comms Rx tasks. */
\r
228 xTaskCreate( vLCDTask, "LCD", configMINIMAL_STACK_SIZE, NULL, mainLCD_TASK_PRIORITY, NULL );
\r
229 xTaskCreate( vCommsRxTask, "CMS", configMINIMAL_STACK_SIZE, NULL, mainCOMMS_RX_TASK_PRIORITY, NULL );
\r
231 /* Start the scheduler running the tasks and co-routines just created. */
\r
232 vTaskStartScheduler();
\r
234 /* Should not get here unless we did not have enough memory to start the
\r
238 /*-----------------------------------------------------------*/
\r
240 static void prvSetupHardware( void )
\r
242 /* Setup the PLL. */
\r
243 SysCtlClockSet( SYSCTL_SYSDIV_10 | SYSCTL_USE_PLL | SYSCTL_OSC_MAIN | SYSCTL_XTAL_6MHZ );
\r
245 /* Initialise the hardware used to talk to the LCD, LED's and UART. */
\r
247 vParTestInitialise();
\r
250 /*-----------------------------------------------------------*/
\r
252 void vApplicationIdleHook( void )
\r
254 /* The co-routines are executed in the idle task using the idle task
\r
258 /* Schedule the co-routines. */
\r
259 vCoRoutineSchedule();
\r
261 /* Run the register check function between each co-routine. */
\r
262 prvSetAndCheckRegisters();
\r
265 /*-----------------------------------------------------------*/
\r
267 static void prvWriteString( const portCHAR *pcString )
\r
269 /* Write pcString to the LED, pausing between each character. */
\r
270 prvPDCWrite(PDC_LCD_CSR, LCD_CLEAR);
\r
273 vTaskDelay( mainCHAR_WRITE_DELAY );
\r
274 prvPDCWrite( PDC_LCD_RAM, *pcString );
\r
278 /*-----------------------------------------------------------*/
\r
280 void vLCDTask( void * pvParameters )
\r
282 unsigned portBASE_TYPE uxIndex;
\r
283 const unsigned portCHAR ucCFGData[] = {
\r
284 0x30, /* Set data bus to 8-bits. */
\r
287 0x3C, /* Number of lines/font. */
\r
288 0x08, /* Display off. */
\r
289 0x01, /* Display clear. */
\r
290 0x06, /* Entry mode [cursor dir][shift]. */
\r
291 0x0C /* Display on [display on][curson on][blinking on]. */
\r
294 /* The strings that are written to the LCD. */
\r
295 const portCHAR *pcStringsToDisplay[] = {
\r
299 "www.FreeRTOS.org",
\r
303 /* Configure the LCD. */
\r
305 while( uxIndex < sizeof( ucCFGData ) )
\r
307 prvPDCWrite( PDC_LCD_CSR, ucCFGData[ uxIndex ] );
\r
309 vTaskDelay( mainCHAR_WRITE_DELAY );
\r
312 /* Turn the LCD Backlight on. */
\r
313 prvPDCWrite( PDC_CSR, 0x01 );
\r
315 /* Clear display. */
\r
316 vTaskDelay( mainCHAR_WRITE_DELAY );
\r
317 prvPDCWrite( PDC_LCD_CSR, LCD_CLEAR );
\r
322 /* Display the string on the LCD. */
\r
323 prvWriteString( pcStringsToDisplay[ uxIndex ] );
\r
325 /* Move on to the next string - wrapping if necessary. */
\r
327 if( *( pcStringsToDisplay[ uxIndex ] ) == 0x00 )
\r
330 /* Longer pause on the last string to be sent. */
\r
331 vTaskDelay( mainSTRING_WRITE_DELAY * 2 );
\r
334 /* Wait until it is time to move onto the next string. */
\r
335 vTaskDelay( mainSTRING_WRITE_DELAY );
\r
338 /*-----------------------------------------------------------*/
\r
340 static void vCommsRxTask( void * pvParameters )
\r
342 static portCHAR cRxedChar, cExpectedChar;
\r
344 /* Set the char we expect to receive to the start of the string. */
\r
345 cExpectedChar = mainFIRST_TX_CHAR;
\r
349 /* Wait for a character to be received. */
\r
350 xQueueReceive( xCommsQueue, ( void * ) &cRxedChar, mainCOMMS_RX_DELAY );
\r
352 /* Was the character recived (if any) the expected character. */
\r
353 if( cRxedChar != cExpectedChar )
\r
355 /* Got an unexpected character. This can sometimes occur when
\r
356 reseting the system using the debugger leaving characters already
\r
357 in the UART regsters. */
\r
358 uxErrorStatus = pdFAIL;
\r
360 /* Resync by waiting for the end of the current string. */
\r
361 while( cRxedChar != mainLAST_TX_CHAR )
\r
363 while( !xQueueReceive( xCommsQueue, ( void * ) &cRxedChar, portMAX_DELAY ) );
\r
366 /* The next expected character is the start of the string again. */
\r
367 cExpectedChar = mainFIRST_TX_CHAR;
\r
371 if( cExpectedChar == mainLAST_TX_CHAR )
\r
373 /* We have reached the end of the string - we now expect to
\r
374 receive the first character in the string again. The LED is
\r
375 toggled to indicate that the entire string was received without
\r
377 vParTestToggleLED( mainCOMMS_RX_LED );
\r
378 cExpectedChar = mainFIRST_TX_CHAR;
\r
382 /* We got the expected character, we now expect to receive the
\r
383 next character in the string. */
\r
389 /*-----------------------------------------------------------*/
\r
391 static void vSerialTxCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex )
\r
393 portTickType xDelayPeriod;
\r
394 static unsigned portLONG *pulRandomBytes = mainFIRST_PROGRAM_BYTES;
\r
396 /* Co-routine MUST start with a call to crSTART. */
\r
397 crSTART( xHandle );
\r
401 /* Was the previously transmitted string received correctly? */
\r
402 if( uxErrorStatus != pdPASS )
\r
404 /* An error was encountered so set the error LED. */
\r
408 /* The next character to Tx is the first in the string. */
\r
409 cNextChar = mainFIRST_TX_CHAR;
\r
411 UARTIntDisable( UART0_BASE, UART_INT_TX );
\r
413 /* Send the first character. */
\r
414 if( !( HWREG( UART0_BASE + UART_O_FR ) & UART_FR_TXFF ) )
\r
416 HWREG( UART0_BASE + UART_O_DR ) = cNextChar;
\r
419 /* Move the variable to the char to Tx on so the ISR transmits
\r
420 the next character in the string once this one has completed. */
\r
423 UARTIntEnable(UART0_BASE, UART_INT_TX);
\r
425 /* Toggle the LED to show a new string is being transmitted. */
\r
426 vParTestToggleLED( mainCOMMS_TX_LED );
\r
428 /* Delay before we start the string off again. A pseudo-random delay
\r
429 is used as this will provide a better test. */
\r
430 xDelayPeriod = xTaskGetTickCount() + ( *pulRandomBytes );
\r
433 if( pulRandomBytes > mainTOTAL_PROGRAM_MEMORY )
\r
435 pulRandomBytes = mainFIRST_PROGRAM_BYTES;
\r
438 /* Make sure we don't wait too long... */
\r
439 xDelayPeriod &= mainMAX_TX_DELAY;
\r
441 /* ...but we do want to wait. */
\r
442 if( xDelayPeriod < mainMIN_TX_DELAY )
\r
444 xDelayPeriod = mainMIN_TX_DELAY;
\r
447 /* Block for the random(ish) time. */
\r
448 crDELAY( xHandle, xDelayPeriod );
\r
451 /* Co-routine MUST end with a call to crEND. */
\r
454 /*-----------------------------------------------------------*/
\r
456 static void vSerialInit( void )
\r
458 /* Enable the UART. GPIOA has already been initialised. */
\r
459 SysCtlPeripheralEnable(SYSCTL_PERIPH_UART0);
\r
461 /* Set GPIO A0 and A1 as peripheral function. They are used to output the
\r
463 GPIODirModeSet( GPIO_PORTA_BASE, GPIO_PIN_0 | GPIO_PIN_1, GPIO_DIR_MODE_HW );
\r
465 /* Configure the UART for 8-N-1 operation. */
\r
466 UARTConfigSet( UART0_BASE, mainBAUD_RATE, UART_CONFIG_WLEN_8 | UART_CONFIG_PAR_NONE | UART_CONFIG_STOP_ONE );
\r
468 /* We dont want to use the fifo. This is for test purposes to generate
\r
469 as many interrupts as possible. */
\r
470 HWREG( UART0_BASE + UART_O_LCR_H ) &= ~mainFIFO_SET;
\r
472 /* Enable both Rx and Tx interrupts. */
\r
473 HWREG( UART0_BASE + UART_O_IM ) |= ( UART_INT_TX | UART_INT_RX );
\r
474 IntEnable( INT_UART0 );
\r
476 /*-----------------------------------------------------------*/
\r
478 void vUART_ISR(void)
\r
480 unsigned portLONG ulStatus;
\r
481 portCHAR cRxedChar;
\r
482 portBASE_TYPE xTaskWokenByPost = pdFALSE;
\r
484 /* What caused the interrupt. */
\r
485 ulStatus = UARTIntStatus( UART0_BASE, pdTRUE );
\r
487 /* Clear the interrupt. */
\r
488 UARTIntClear( UART0_BASE, ulStatus );
\r
490 /* Was an Rx interrpt pending? */
\r
491 if( ulStatus & UART_INT_RX )
\r
493 if( ( HWREG(UART0_BASE + UART_O_FR ) & UART_FR_RXFF ) )
\r
495 /* Get the char from the buffer and post it onto the queue of
\r
496 Rxed chars. Posting the character should wake the task that is
\r
497 blocked on the queue waiting for characters. */
\r
498 cRxedChar = ( portCHAR ) HWREG( UART0_BASE + UART_O_DR );
\r
499 xTaskWokenByPost = xQueueSendFromISR( xCommsQueue, &cRxedChar, xTaskWokenByPost );
\r
503 /* Was a Tx interrupt pending? */
\r
504 if( ulStatus & UART_INT_TX )
\r
506 /* Send the next character in the string. We are not using the FIFO. */
\r
507 if( cNextChar <= mainLAST_TX_CHAR )
\r
509 if( !( HWREG( UART0_BASE + UART_O_FR ) & UART_FR_TXFF ) )
\r
511 HWREG( UART0_BASE + UART_O_DR ) = cNextChar;
\r
517 if( xTaskWokenByPost )
\r
519 /* If a task was woken by the character being received then we force
\r
520 a context switch to occur in case the task is of higher priority than
\r
521 the currently executing task (i.e. the task that this interrupt
\r
523 portEND_SWITCHING_ISR( xTaskWokenByPost );
\r
526 /*-----------------------------------------------------------*/
\r
528 static void prvPDCWrite( portCHAR cAddress, portCHAR cData )
\r
532 PDCWrite( cAddress, cData );
\r
536 /*-----------------------------------------------------------*/
\r
538 void vSetErrorLED( void )
\r
540 vParTestSetLED( mainCOMMS_FAIL_LED, pdTRUE );
\r
542 /*-----------------------------------------------------------*/
\r
544 __asm void prvSetAndCheckRegisters( void )
\r
546 extern vSetErrorLED
\r
548 /* Fill the general purpose registers with known values. */
\r
563 /* Check the values are as expected. */
\r
594 ldr r1, =vSetErrorLED
\r
599 /*-----------------------------------------------------------*/
\r