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 "DriverLib.h"
\r
88 /* The time to delay between writing each character to the LCD. */
\r
89 #define mainCHAR_WRITE_DELAY ( 2 / portTICK_RATE_MS )
\r
91 /* The time to delay between writing each string to the LCD. */
\r
92 #define mainSTRING_WRITE_DELAY ( 400 / portTICK_RATE_MS )
\r
94 /* The number of flash co-routines to create. */
\r
95 #define mainNUM_FLASH_CO_ROUTINES ( 5 )
\r
97 /* The length of the queue used to pass received characters to the Comms Rx
\r
99 #define mainRX_QUEUE_LEN ( 5 )
\r
101 /* The priority of the co-routine used to initiate the transmission of the
\r
102 string on UART 0. */
\r
103 #define mainTX_CO_ROUTINE_PRIORITY ( 1 )
\r
105 /* Only one co-routine is created so its index is not important. */
\r
106 #define mainTX_CO_ROUTINE_INDEX ( 0 )
\r
108 /* The time between transmissions of the string on UART 0. This is pseudo
\r
109 random in order to generate a bit or randomness to when the interrupts occur.*/
\r
110 #define mainMIN_TX_DELAY ( 40 / portTICK_RATE_MS )
\r
111 #define mainMAX_TX_DELAY ( ( portTickType ) 0x7f )
\r
112 #define mainOFFSET_TIME ( ( portTickType ) 3 )
\r
114 /* The time the Comms Rx task should wait to receive a character. This should
\r
115 be slightly longer than the time between transmissions. If we do not receive
\r
116 a character after this time then there must be an error in the transmission or
\r
117 the timing of the transmission. */
\r
118 #define mainCOMMS_RX_DELAY ( mainMAX_TX_DELAY + 20 )
\r
120 /* The task priorites. */
\r
121 #define mainLCD_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
122 #define mainCOMMS_RX_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
124 /* The LED's toggled by the various tasks. */
\r
125 #define mainCOMMS_FAIL_LED ( 7 )
\r
126 #define mainCOMMS_RX_LED ( 6 )
\r
127 #define mainCOMMS_TX_LED ( 5 )
\r
129 /* The baud rate used by the UART comms tasks/co-routine. */
\r
130 #define mainBAUD_RATE ( 57600 )
\r
132 /* FIFO setting for the UART. The FIFO is not used to create a better test. */
\r
133 #define mainFIFO_SET ( 0x10 )
\r
135 /* The string that is transmitted on the UART contains sequentially the
\r
136 characters from mainFIRST_TX_CHAR to mainLAST_TX_CHAR. */
\r
137 #define mainFIRST_TX_CHAR '0'
\r
138 #define mainLAST_TX_CHAR 'z'
\r
140 /* Just used to walk through the program memory in order that some random data
\r
141 can be generated. */
\r
142 #define mainTOTAL_PROGRAM_MEMORY ( ( unsigned portLONG * ) ( 8 * 1024 ) )
\r
143 #define mainFIRST_PROGRAM_BYTES ( ( unsigned portLONG * ) 4 )
\r
145 /* The error routine that is called if the driver library encounters an error. */
\r
148 __error__(char *pcFilename, unsigned long ulLine)
\r
153 /*-----------------------------------------------------------*/
\r
156 * The task that rotates text on the LCD.
\r
158 static void vLCDTask( void * pvParameters );
\r
161 * The task that receives the characters from UART 0.
\r
163 static void vCommsRxTask( void * pvParameters );
\r
166 * The co-routine that periodically initiates the transmission of the string on
\r
169 static void vSerialTxCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex );
\r
172 * Writes a string the the LCD.
\r
174 static void prvWriteString( const portCHAR *pcString );
\r
177 * Initialisation routine for the UART.
\r
179 static void vSerialInit( void );
\r
182 * Thread safe write to the PDC.
\r
184 static void prvPDCWrite( portCHAR cAddress, portCHAR cData );
\r
187 * Function to simply set a known value into the general purpose registers
\r
188 * then read them back to ensure they remain set correctly. An incorrect value
\r
189 * being indicative of an error in the task switching mechanism.
\r
191 void prvSetAndCheckRegisters( void );
\r
194 * Latch the LED that indicates that an error has occurred.
\r
196 void vSetErrorLED( void );
\r
199 * Sets up the PLL and ports used by the demo.
\r
201 static void prvSetupHardware( void );
\r
203 /*-----------------------------------------------------------*/
\r
205 /* Error flag set to pdFAIL if an error is encountered in the tasks/co-routines
\r
206 defined within this file. */
\r
207 unsigned portBASE_TYPE uxErrorStatus = pdPASS;
\r
209 /* The next character to transmit. */
\r
210 static portCHAR cNextChar;
\r
212 /* The queue used to transmit characters from the interrupt to the Comms Rx
\r
214 static xQueueHandle xCommsQueue;
\r
216 /*-----------------------------------------------------------*/
\r
220 /* Create the queue used to communicate between the UART ISR and the Comms
\r
222 xCommsQueue = xQueueCreate( mainRX_QUEUE_LEN, sizeof( portCHAR ) );
\r
224 /* Setup the ports used by the demo and the clock. */
\r
225 prvSetupHardware();
\r
227 /* Create the co-routines that flash the LED's. */
\r
228 vStartFlashCoRoutines( mainNUM_FLASH_CO_ROUTINES );
\r
230 /* Create the co-routine that initiates the transmission of characters
\r
232 xCoRoutineCreate( vSerialTxCoRoutine, mainTX_CO_ROUTINE_PRIORITY, mainTX_CO_ROUTINE_INDEX );
\r
234 /* Create the LCD and Comms Rx tasks. */
\r
235 xTaskCreate( vLCDTask, "LCD", configMINIMAL_STACK_SIZE, NULL, mainLCD_TASK_PRIORITY, NULL );
\r
236 xTaskCreate( vCommsRxTask, "CMS", configMINIMAL_STACK_SIZE, NULL, mainCOMMS_RX_TASK_PRIORITY, NULL );
\r
238 /* Start the scheduler running the tasks and co-routines just created. */
\r
239 vTaskStartScheduler();
\r
241 /* Should not get here unless we did not have enough memory to start the
\r
246 /*-----------------------------------------------------------*/
\r
248 static void prvSetupHardware( void )
\r
250 /* Setup the PLL. */
\r
251 SysCtlClockSet( SYSCTL_SYSDIV_10 | SYSCTL_USE_PLL | SYSCTL_OSC_MAIN | SYSCTL_XTAL_6MHZ );
\r
253 /* Initialise the hardware used to talk to the LCD, LED's and UART. */
\r
255 vParTestInitialise();
\r
258 /*-----------------------------------------------------------*/
\r
260 void vApplicationIdleHook( void )
\r
262 /* The co-routines are executed in the idle task using the idle task
\r
266 /* Schedule the co-routines. */
\r
267 vCoRoutineSchedule();
\r
269 /* Run the register check function between each co-routine. */
\r
270 prvSetAndCheckRegisters();
\r
273 /*-----------------------------------------------------------*/
\r
275 static void prvWriteString( const portCHAR *pcString )
\r
277 /* Write pcString to the LED, pausing between each character. */
\r
278 prvPDCWrite(PDC_LCD_CSR, LCD_CLEAR);
\r
281 vTaskDelay( mainCHAR_WRITE_DELAY );
\r
282 prvPDCWrite( PDC_LCD_RAM, *pcString );
\r
286 /*-----------------------------------------------------------*/
\r
288 void vLCDTask( void * pvParameters )
\r
290 unsigned portBASE_TYPE uxIndex;
\r
291 const unsigned portCHAR ucCFGData[] = {
\r
292 0x30, /* Set data bus to 8-bits. */
\r
295 0x3C, /* Number of lines/font. */
\r
296 0x08, /* Display off. */
\r
297 0x01, /* Display clear. */
\r
298 0x06, /* Entry mode [cursor dir][shift]. */
\r
299 0x0C /* Display on [display on][curson on][blinking on]. */
\r
302 /* The strings that are written to the LCD. */
\r
303 const portCHAR *pcStringsToDisplay[] = {
\r
307 "www.FreeRTOS.org",
\r
311 /* Configure the LCD. */
\r
313 while( uxIndex < sizeof( ucCFGData ) )
\r
315 prvPDCWrite( PDC_LCD_CSR, ucCFGData[ uxIndex ] );
\r
317 vTaskDelay( mainCHAR_WRITE_DELAY );
\r
320 /* Turn the LCD Backlight on. */
\r
321 prvPDCWrite( PDC_CSR, 0x01 );
\r
323 /* Clear display. */
\r
324 vTaskDelay( mainCHAR_WRITE_DELAY );
\r
325 prvPDCWrite( PDC_LCD_CSR, LCD_CLEAR );
\r
330 /* Display the string on the LCD. */
\r
331 prvWriteString( pcStringsToDisplay[ uxIndex ] );
\r
333 /* Move on to the next string - wrapping if necessary. */
\r
335 if( *( pcStringsToDisplay[ uxIndex ] ) == 0x00 )
\r
338 /* Longer pause on the last string to be sent. */
\r
339 vTaskDelay( mainSTRING_WRITE_DELAY * 2 );
\r
342 /* Wait until it is time to move onto the next string. */
\r
343 vTaskDelay( mainSTRING_WRITE_DELAY );
\r
346 /*-----------------------------------------------------------*/
\r
348 static void vCommsRxTask( void * pvParameters )
\r
350 static portCHAR cRxedChar, cExpectedChar;
\r
352 /* Set the char we expect to receive to the start of the string. */
\r
353 cExpectedChar = mainFIRST_TX_CHAR;
\r
357 /* Wait for a character to be received. */
\r
358 xQueueReceive( xCommsQueue, ( void * ) &cRxedChar, mainCOMMS_RX_DELAY );
\r
360 /* Was the character recived (if any) the expected character. */
\r
361 if( cRxedChar != cExpectedChar )
\r
363 /* Got an unexpected character. This can sometimes occur when
\r
364 reseting the system using the debugger leaving characters already
\r
365 in the UART regsters. */
\r
366 uxErrorStatus = pdFAIL;
\r
368 /* Resync by waiting for the end of the current string. */
\r
369 while( cRxedChar != mainLAST_TX_CHAR )
\r
371 while( !xQueueReceive( xCommsQueue, ( void * ) &cRxedChar, portMAX_DELAY ) );
\r
374 /* The next expected character is the start of the string again. */
\r
375 cExpectedChar = mainFIRST_TX_CHAR;
\r
379 if( cExpectedChar == mainLAST_TX_CHAR )
\r
381 /* We have reached the end of the string - we now expect to
\r
382 receive the first character in the string again. The LED is
\r
383 toggled to indicate that the entire string was received without
\r
385 vParTestToggleLED( mainCOMMS_RX_LED );
\r
386 cExpectedChar = mainFIRST_TX_CHAR;
\r
390 /* We got the expected character, we now expect to receive the
\r
391 next character in the string. */
\r
397 /*-----------------------------------------------------------*/
\r
399 static void vSerialTxCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex )
\r
401 portTickType xDelayPeriod;
\r
402 static unsigned portLONG *pulRandomBytes = mainFIRST_PROGRAM_BYTES;
\r
404 /* Co-routine MUST start with a call to crSTART. */
\r
405 crSTART( xHandle );
\r
409 /* Was the previously transmitted string received correctly? */
\r
410 if( uxErrorStatus != pdPASS )
\r
412 /* An error was encountered so set the error LED. */
\r
416 /* The next character to Tx is the first in the string. */
\r
417 cNextChar = mainFIRST_TX_CHAR;
\r
419 UARTIntDisable( UART0_BASE, UART_INT_TX );
\r
421 /* Send the first character. */
\r
422 if( !( HWREG( UART0_BASE + UART_O_FR ) & UART_FR_TXFF ) )
\r
424 HWREG( UART0_BASE + UART_O_DR ) = cNextChar;
\r
427 /* Move the variable to the char to Tx on so the ISR transmits
\r
428 the next character in the string once this one has completed. */
\r
431 UARTIntEnable(UART0_BASE, UART_INT_TX);
\r
433 /* Toggle the LED to show a new string is being transmitted. */
\r
434 vParTestToggleLED( mainCOMMS_TX_LED );
\r
436 /* Delay before we start the string off again. A pseudo-random delay
\r
437 is used as this will provide a better test. */
\r
438 xDelayPeriod = xTaskGetTickCount() + ( *pulRandomBytes );
\r
441 if( pulRandomBytes > mainTOTAL_PROGRAM_MEMORY )
\r
443 pulRandomBytes = mainFIRST_PROGRAM_BYTES;
\r
446 /* Make sure we don't wait too long... */
\r
447 xDelayPeriod &= mainMAX_TX_DELAY;
\r
449 /* ...but we do want to wait. */
\r
450 if( xDelayPeriod < mainMIN_TX_DELAY )
\r
452 xDelayPeriod = mainMIN_TX_DELAY;
\r
455 /* Block for the random(ish) time. */
\r
456 crDELAY( xHandle, xDelayPeriod );
\r
459 /* Co-routine MUST end with a call to crEND. */
\r
462 /*-----------------------------------------------------------*/
\r
464 static void vSerialInit( void )
\r
466 /* Enable the UART. GPIOA has already been initialised. */
\r
467 SysCtlPeripheralEnable(SYSCTL_PERIPH_UART0);
\r
469 /* Set GPIO A0 and A1 as peripheral function. They are used to output the
\r
471 GPIODirModeSet( GPIO_PORTA_BASE, GPIO_PIN_0 | GPIO_PIN_1, GPIO_DIR_MODE_HW );
\r
473 /* Configure the UART for 8-N-1 operation. */
\r
474 UARTConfigSet( UART0_BASE, mainBAUD_RATE, UART_CONFIG_WLEN_8 | UART_CONFIG_PAR_NONE | UART_CONFIG_STOP_ONE );
\r
476 /* We dont want to use the fifo. This is for test purposes to generate
\r
477 as many interrupts as possible. */
\r
478 HWREG( UART0_BASE + UART_O_LCR_H ) &= ~mainFIFO_SET;
\r
480 /* Enable both Rx and Tx interrupts. */
\r
481 HWREG( UART0_BASE + UART_O_IM ) |= ( UART_INT_TX | UART_INT_RX );
\r
482 IntEnable( INT_UART0 );
\r
484 /*-----------------------------------------------------------*/
\r
486 void vUART_ISR(void)
\r
488 unsigned portLONG ulStatus;
\r
489 portCHAR cRxedChar;
\r
490 portBASE_TYPE xTaskWokenByPost = pdFALSE;
\r
492 /* What caused the interrupt. */
\r
493 ulStatus = UARTIntStatus( UART0_BASE, pdTRUE );
\r
495 /* Clear the interrupt. */
\r
496 UARTIntClear( UART0_BASE, ulStatus );
\r
498 /* Was an Rx interrpt pending? */
\r
499 if( ulStatus & UART_INT_RX )
\r
501 if( ( HWREG(UART0_BASE + UART_O_FR ) & UART_FR_RXFF ) )
\r
503 /* Get the char from the buffer and post it onto the queue of
\r
504 Rxed chars. Posting the character should wake the task that is
\r
505 blocked on the queue waiting for characters. */
\r
506 cRxedChar = ( portCHAR ) HWREG( UART0_BASE + UART_O_DR );
\r
507 xTaskWokenByPost = xQueueSendFromISR( xCommsQueue, &cRxedChar, xTaskWokenByPost );
\r
511 /* Was a Tx interrupt pending? */
\r
512 if( ulStatus & UART_INT_TX )
\r
514 /* Send the next character in the string. We are not using the FIFO. */
\r
515 if( cNextChar <= mainLAST_TX_CHAR )
\r
517 if( !( HWREG( UART0_BASE + UART_O_FR ) & UART_FR_TXFF ) )
\r
519 HWREG( UART0_BASE + UART_O_DR ) = cNextChar;
\r
525 if( xTaskWokenByPost )
\r
527 /* If a task was woken by the character being received then we force
\r
528 a context switch to occur in case the task is of higher priority than
\r
529 the currently executing task (i.e. the task that this interrupt
\r
531 portEND_SWITCHING_ISR( xTaskWokenByPost );
\r
534 /*-----------------------------------------------------------*/
\r
536 static void prvPDCWrite( portCHAR cAddress, portCHAR cData )
\r
540 PDCWrite( cAddress, cData );
\r
544 /*-----------------------------------------------------------*/
\r
546 void vSetErrorLED( void )
\r
548 vParTestSetLED( mainCOMMS_FAIL_LED, pdTRUE );
\r
550 /*-----------------------------------------------------------*/
\r
552 void prvSetAndCheckRegisters( void )
\r
554 /* Fill the general purpose registers with known values. */
\r
558 " add r0, r11, #1 \n"
\r
559 " add r1, r11, #2 \n"
\r
560 " add r2, r11, #3 \n"
\r
561 " add r3, r11, #4 \n"
\r
562 " add r4, r11, #5 \n"
\r
563 " add r5, r11, #6 \n"
\r
564 " add r6, r11, #7 \n"
\r
565 " add r7, r11, #8 \n"
\r
566 " add r8, r11, #9 \n"
\r
567 " add r9, r11, #10 \n"
\r
568 " add r10, r11, #11 \n"
\r
569 " add r12, r11, #12"
\r
572 /* Check the values are as expected. */
\r
576 " bne set_error_led \n"
\r
578 " bne set_error_led \n"
\r
580 " bne set_error_led \n"
\r
582 " bne set_error_led \n"
\r
584 " bne set_error_led \n"
\r
586 " bne set_error_led \n"
\r
588 " bne set_error_led \n"
\r
590 " bne set_error_led \n"
\r
592 " bne set_error_led \n"
\r
594 " bne set_error_led \n"
\r
596 " bne set_error_led \n"
\r
598 " bne set_error_led \n"
\r
600 " bne set_error_led \n"
\r
606 "set_error_led: \n"
\r
608 " ldr r1, vSetErrorLEDConst\n"
\r
614 "vSetErrorLEDConst: .word vSetErrorLED"
\r
617 /*-----------------------------------------------------------*/
\r