2 FreeRTOS V7.0.0 - Copyright (C) 2011 Real Time Engineers Ltd.
\r
5 ***************************************************************************
\r
7 * FreeRTOS tutorial books are available in pdf and paperback. *
\r
8 * Complete, revised, and edited pdf reference manuals are also *
\r
11 * Purchasing FreeRTOS documentation will not only help you, by *
\r
12 * ensuring you get running as quickly as possible and with an *
\r
13 * in-depth knowledge of how to use FreeRTOS, it will also help *
\r
14 * the FreeRTOS project to continue with its mission of providing *
\r
15 * professional grade, cross platform, de facto standard solutions *
\r
16 * for microcontrollers - completely free of charge! *
\r
18 * >>> See http://www.FreeRTOS.org/Documentation for details. <<< *
\r
20 * Thank you for using FreeRTOS, and thank you for your support! *
\r
22 ***************************************************************************
\r
25 This file is part of the FreeRTOS distribution.
\r
27 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
28 the terms of the GNU General Public License (version 2) as published by the
\r
29 Free Software Foundation AND MODIFIED BY the FreeRTOS exception.
\r
30 >>>NOTE<<< The modification to the GPL is included to allow you to
\r
31 distribute a combined work that includes FreeRTOS without being obliged to
\r
32 provide the source code for proprietary components outside of the FreeRTOS
\r
33 kernel. FreeRTOS is distributed in the hope that it will be useful, but
\r
34 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
\r
35 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
\r
36 more details. You should have received a copy of the GNU General Public
\r
37 License and the FreeRTOS license exception along with FreeRTOS; if not it
\r
38 can be viewed here: http://www.freertos.org/a00114.html and also obtained
\r
39 by writing to Richard Barry, contact details for whom are available on the
\r
44 http://www.FreeRTOS.org - Documentation, latest information, license and
\r
47 http://www.SafeRTOS.com - A version that is certified for use in safety
\r
50 http://www.OpenRTOS.com - Commercial support, development, porting,
\r
51 licensing and training services.
\r
55 * This demo application creates seven co-routines and one task (two including
\r
56 * the idle task). The co-routines execute as part of the idle task hook.
\r
58 * Five of the created co-routines are the standard 'co-routine flash'
\r
59 * co-routines contained within the Demo/Common/Minimal/crflash.c file and
\r
60 * documented on the FreeRTOS.org WEB site.
\r
62 * The 'LCD Task' rotates a string on the LCD, delaying between each character
\r
63 * as necessitated by the slow interface, and delaying between each string just
\r
64 * long enough to enable the text to be read.
\r
66 * The sixth co-routine controls the transmission of a string to UART 0. The
\r
67 * co-routine periodically sends the first character of the string to the UART,
\r
68 * with the UART's TxEnd interrupt being used to transmit the remaining
\r
69 * characters. The UART's RxEnd interrupt receives the characters and places
\r
70 * them on a queue to be processed by the seventh and final co-routine. An
\r
71 * error is latched should an unexpected character be received, or any
\r
72 * character be received out of sequence.
\r
74 * A loopback connector is required to ensure that each character transmitted
\r
75 * on the UART is also received on the same UART. For test purposes the UART
\r
76 * FIFO's are not utalised in order to maximise the interrupt overhead. Also
\r
77 * a pseudo random interval is used between the start of each transmission in
\r
78 * order that the resultant interrupts are more randomly distributed and
\r
79 * therefore more likely to highlight any problems.
\r
81 * The flash co-routines control LED's zero to four. LED five is toggled each
\r
82 * time the string is transmitted on the UART. LED six is toggled each time
\r
83 * the string is CORRECTLY received on the UART. LED seven is latched on should
\r
84 * an error be detected in any task or co-routine.
\r
86 * In addition the idle task makes repetative calls to
\r
87 * prvSetAndCheckRegisters(). This simply loads the general purpose registers
\r
88 * with a known value, then checks each register to ensure the held value is
\r
89 * still correct. As a low priority task this checking routine is likely to
\r
90 * get repeatedly swapped in and out. A register being found to contain an
\r
91 * incorrect value is therefore indicative of an error in the task switching
\r
96 /* Scheduler include files. */
\r
97 #include "FreeRTOS.h"
\r
100 #include "croutine.h"
\r
102 /* Demo application include files. */
\r
103 #include "partest.h"
\r
104 #include "crflash.h"
\r
106 /* Library include files. */
\r
107 #include "LM3Sxxx.h"
\r
110 /* The time to delay between writing each character to the LCD. */
\r
111 #define mainCHAR_WRITE_DELAY ( 2 / portTICK_RATE_MS )
\r
113 /* The time to delay between writing each string to the LCD. */
\r
114 #define mainSTRING_WRITE_DELAY ( 400 / portTICK_RATE_MS )
\r
116 /* The number of flash co-routines to create. */
\r
117 #define mainNUM_FLASH_CO_ROUTINES ( 5 )
\r
119 /* The length of the queue used to pass received characters to the Comms Rx
\r
121 #define mainRX_QUEUE_LEN ( 5 )
\r
123 /* The priority of the co-routine used to initiate the transmission of the
\r
124 string on UART 0. */
\r
125 #define mainTX_CO_ROUTINE_PRIORITY ( 1 )
\r
127 /* The priority of the co-routine used to receive characters from the UART. */
\r
128 #define mainRX_CO_ROUTINE_PRIORITY ( 2 )
\r
130 /* Only one co-routine is created so its index is not important. */
\r
131 #define mainTX_CO_ROUTINE_INDEX ( 0 )
\r
132 #define mainRX_CO_ROUTINE_INDEX ( 0 )
\r
134 /* The time between transmissions of the string on UART 0. This is pseudo
\r
135 random in order to generate a bit or randomness to when the interrupts occur.*/
\r
136 #define mainMIN_TX_DELAY ( 40 / portTICK_RATE_MS )
\r
137 #define mainMAX_TX_DELAY ( ( portTickType ) 0x7f )
\r
138 #define mainOFFSET_TIME ( ( portTickType ) 3 )
\r
140 /* The time the Comms Rx task should wait to receive a character. This should
\r
141 be slightly longer than the time between transmissions. If we do not receive
\r
142 a character after this time then there must be an error in the transmission or
\r
143 the timing of the transmission. */
\r
144 #define mainCOMMS_RX_DELAY ( mainMAX_TX_DELAY + 20 )
\r
146 /* The task priorites. */
\r
147 #define mainLCD_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
148 #define mainCOMMS_RX_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
150 /* The LED's toggled by the various tasks. */
\r
151 #define mainCOMMS_FAIL_LED ( 7 )
\r
152 #define mainCOMMS_RX_LED ( 6 )
\r
153 #define mainCOMMS_TX_LED ( 5 )
\r
155 /* The baud rate used by the UART comms tasks/co-routine. */
\r
156 #define mainBAUD_RATE ( 57600 )
\r
158 /* FIFO setting for the UART. The FIFO is not used to create a better test. */
\r
159 #define mainFIFO_SET ( 0x10 )
\r
161 /* The string that is transmitted on the UART contains sequentially the
\r
162 characters from mainFIRST_TX_CHAR to mainLAST_TX_CHAR. */
\r
163 #define mainFIRST_TX_CHAR '0'
\r
164 #define mainLAST_TX_CHAR 'z'
\r
166 /* Just used to walk through the program memory in order that some random data
\r
167 can be generated. */
\r
168 #define mainTOTAL_PROGRAM_MEMORY ( ( unsigned long * ) ( 8 * 1024 ) )
\r
169 #define mainFIRST_PROGRAM_BYTES ( ( unsigned long * ) 4 )
\r
171 /*-----------------------------------------------------------*/
\r
174 * The task that rotates text on the LCD.
\r
176 static void vLCDTask( void * pvParameters );
\r
179 * The task that receives the characters from UART 0.
\r
181 static void vCommsRxCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex );
\r
184 * The co-routine that periodically initiates the transmission of the string on
\r
187 static void vSerialTxCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex );
\r
190 * Writes a string the the LCD.
\r
192 static void prvWriteString( const char *pcString );
\r
195 * Initialisation routine for the UART.
\r
197 static void vSerialInit( void );
\r
200 * Thread safe write to the PDC.
\r
202 static void prvPDCWrite( char cAddress, char cData );
\r
205 * Function to simply set a known value into the general purpose registers
\r
206 * then read them back to ensure they remain set correctly. An incorrect value
\r
207 * being indicative of an error in the task switching mechanism.
\r
209 void prvSetAndCheckRegisters( void );
\r
212 * Latch the LED that indicates that an error has occurred.
\r
214 void vSetErrorLED( void );
\r
217 * Sets up the PLL and ports used by the demo.
\r
219 static void prvSetupHardware( void );
\r
221 /*-----------------------------------------------------------*/
\r
223 /* Error flag set to pdFAIL if an error is encountered in the tasks/co-routines
\r
224 defined within this file. */
\r
225 unsigned portBASE_TYPE uxErrorStatus = pdPASS;
\r
227 /* The next character to transmit. */
\r
228 static char cNextChar;
\r
230 /* The queue used to transmit characters from the interrupt to the Comms Rx
\r
232 static xQueueHandle xCommsQueue;
\r
234 /*-----------------------------------------------------------*/
\r
238 /* Create the queue used to communicate between the UART ISR and the Comms
\r
240 xCommsQueue = xQueueCreate( mainRX_QUEUE_LEN, sizeof( char ) );
\r
242 /* Setup the ports used by the demo and the clock. */
\r
243 prvSetupHardware();
\r
245 /* Create the co-routines that flash the LED's. */
\r
246 vStartFlashCoRoutines( mainNUM_FLASH_CO_ROUTINES );
\r
248 /* Create the co-routine that initiates the transmission of characters
\r
250 xCoRoutineCreate( vSerialTxCoRoutine, mainTX_CO_ROUTINE_PRIORITY, mainTX_CO_ROUTINE_INDEX );
\r
252 /* Create the co-routine that receives characters from the UART. */
\r
253 xCoRoutineCreate( vCommsRxCoRoutine, mainRX_CO_ROUTINE_PRIORITY, mainRX_CO_ROUTINE_INDEX );
\r
255 /* Create the LCD task. */
\r
256 xTaskCreate( vLCDTask, "LCD", configMINIMAL_STACK_SIZE, NULL, mainLCD_TASK_PRIORITY, NULL );
\r
258 /* Start the scheduler running the tasks and co-routines just created. */
\r
259 vTaskStartScheduler();
\r
261 /* Should not get here unless we did not have enough memory to start the
\r
265 /*-----------------------------------------------------------*/
\r
267 static void prvSetupHardware( void )
\r
269 /* Setup the PLL. */
\r
270 SysCtlClockSet( SYSCTL_SYSDIV_10 | SYSCTL_USE_PLL | SYSCTL_OSC_MAIN | SYSCTL_XTAL_6MHZ );
\r
272 /* Initialise the hardware used to talk to the LCD, LED's and UART. */
\r
274 vParTestInitialise();
\r
277 /*-----------------------------------------------------------*/
\r
279 void vApplicationIdleHook( void )
\r
281 /* The co-routines are executed in the idle task using the idle task
\r
285 /* Schedule the co-routines. */
\r
286 vCoRoutineSchedule();
\r
288 /* Run the register check function between each co-routine. */
\r
289 prvSetAndCheckRegisters();
\r
292 /*-----------------------------------------------------------*/
\r
294 static void prvWriteString( const char *pcString )
\r
296 /* Write pcString to the LED, pausing between each character. */
\r
297 prvPDCWrite(PDC_LCD_CSR, LCD_CLEAR);
\r
300 vTaskDelay( mainCHAR_WRITE_DELAY );
\r
301 prvPDCWrite( PDC_LCD_RAM, *pcString );
\r
305 /*-----------------------------------------------------------*/
\r
307 void vLCDTask( void * pvParameters )
\r
309 unsigned portBASE_TYPE uxIndex;
\r
310 const unsigned char ucCFGData[] = {
\r
311 0x30, /* Set data bus to 8-bits. */
\r
314 0x3C, /* Number of lines/font. */
\r
315 0x08, /* Display off. */
\r
316 0x01, /* Display clear. */
\r
317 0x06, /* Entry mode [cursor dir][shift]. */
\r
318 0x0C /* Display on [display on][curson on][blinking on]. */
\r
321 /* The strings that are written to the LCD. */
\r
322 const char *pcStringsToDisplay[] = {
\r
326 "www.FreeRTOS.org",
\r
330 /* Configure the LCD. */
\r
332 while( uxIndex < sizeof( ucCFGData ) )
\r
334 prvPDCWrite( PDC_LCD_CSR, ucCFGData[ uxIndex ] );
\r
336 vTaskDelay( mainCHAR_WRITE_DELAY );
\r
339 /* Turn the LCD Backlight on. */
\r
340 prvPDCWrite( PDC_CSR, 0x01 );
\r
342 /* Clear display. */
\r
343 vTaskDelay( mainCHAR_WRITE_DELAY );
\r
344 prvPDCWrite( PDC_LCD_CSR, LCD_CLEAR );
\r
349 /* Display the string on the LCD. */
\r
350 prvWriteString( pcStringsToDisplay[ uxIndex ] );
\r
352 /* Move on to the next string - wrapping if necessary. */
\r
354 if( *( pcStringsToDisplay[ uxIndex ] ) == 0x00 )
\r
357 /* Longer pause on the last string to be sent. */
\r
358 vTaskDelay( mainSTRING_WRITE_DELAY * 2 );
\r
361 /* Wait until it is time to move onto the next string. */
\r
362 vTaskDelay( mainSTRING_WRITE_DELAY );
\r
365 /*-----------------------------------------------------------*/
\r
367 static void vCommsRxCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex )
\r
369 static char cRxedChar, cExpectedChar = mainFIRST_TX_CHAR;
\r
370 portBASE_TYPE xResult;
\r
372 crSTART( xHandle );
\r
376 /* Wait for a character to be received. */
\r
377 crQUEUE_RECEIVE( xHandle, xCommsQueue, ( void * ) &cRxedChar, mainCOMMS_RX_DELAY, &xResult );
\r
379 /* Was the character recived (if any) the expected character. */
\r
380 if( ( cRxedChar != cExpectedChar ) || ( xResult != pdPASS ) )
\r
382 /* Got an unexpected character. This can sometimes occur when
\r
383 reseting the system using the debugger leaving characters already
\r
384 in the UART regsters. */
\r
385 uxErrorStatus = pdFAIL;
\r
387 /* Resync by waiting for the end of the current string. */
\r
388 while( cRxedChar != mainLAST_TX_CHAR )
\r
390 crQUEUE_RECEIVE( xHandle, xCommsQueue, ( void * ) &cRxedChar, mainCOMMS_RX_DELAY, &xResult );
\r
393 /* The next expected character is the start of the string again. */
\r
394 cExpectedChar = mainFIRST_TX_CHAR;
\r
398 if( cExpectedChar == mainLAST_TX_CHAR )
\r
400 /* We have reached the end of the string - we now expect to
\r
401 receive the first character in the string again. The LED is
\r
402 toggled to indicate that the entire string was received without
\r
404 vParTestToggleLED( mainCOMMS_RX_LED );
\r
405 cExpectedChar = mainFIRST_TX_CHAR;
\r
409 /* We got the expected character, we now expect to receive the
\r
410 next character in the string. */
\r
418 /*-----------------------------------------------------------*/
\r
420 static void vSerialTxCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex )
\r
422 portTickType xDelayPeriod;
\r
423 static unsigned long *pulRandomBytes = mainFIRST_PROGRAM_BYTES;
\r
425 /* Co-routine MUST start with a call to crSTART. */
\r
426 crSTART( xHandle );
\r
430 /* Was the previously transmitted string received correctly? */
\r
431 if( uxErrorStatus != pdPASS )
\r
433 /* An error was encountered so set the error LED. */
\r
437 /* The next character to Tx is the first in the string. */
\r
438 cNextChar = mainFIRST_TX_CHAR;
\r
440 UARTIntDisable( UART0_BASE, UART_INT_TX );
\r
442 /* Send the first character. */
\r
443 if( !( HWREG( UART0_BASE + UART_O_FR ) & UART_FR_TXFF ) )
\r
445 HWREG( UART0_BASE + UART_O_DR ) = cNextChar;
\r
448 /* Move the variable to the char to Tx on so the ISR transmits
\r
449 the next character in the string once this one has completed. */
\r
452 UARTIntEnable(UART0_BASE, UART_INT_TX);
\r
454 /* Toggle the LED to show a new string is being transmitted. */
\r
455 vParTestToggleLED( mainCOMMS_TX_LED );
\r
457 /* Delay before we start the string off again. A pseudo-random delay
\r
458 is used as this will provide a better test. */
\r
459 xDelayPeriod = xTaskGetTickCount() + ( *pulRandomBytes );
\r
462 if( pulRandomBytes > mainTOTAL_PROGRAM_MEMORY )
\r
464 pulRandomBytes = mainFIRST_PROGRAM_BYTES;
\r
467 /* Make sure we don't wait too long... */
\r
468 xDelayPeriod &= mainMAX_TX_DELAY;
\r
470 /* ...but we do want to wait. */
\r
471 if( xDelayPeriod < mainMIN_TX_DELAY )
\r
473 xDelayPeriod = mainMIN_TX_DELAY;
\r
476 /* Block for the random(ish) time. */
\r
477 crDELAY( xHandle, xDelayPeriod );
\r
480 /* Co-routine MUST end with a call to crEND. */
\r
483 /*-----------------------------------------------------------*/
\r
485 static void vSerialInit( void )
\r
487 /* Enable the UART. GPIOA has already been initialised. */
\r
488 SysCtlPeripheralEnable(SYSCTL_PERIPH_UART0);
\r
490 /* Set GPIO A0 and A1 as peripheral function. They are used to output the
\r
492 GPIODirModeSet( GPIO_PORTA_BASE, GPIO_PIN_0 | GPIO_PIN_1, GPIO_DIR_MODE_HW );
\r
494 /* Configure the UART for 8-N-1 operation. */
\r
495 UARTConfigSet( UART0_BASE, mainBAUD_RATE, UART_CONFIG_WLEN_8 | UART_CONFIG_PAR_NONE | UART_CONFIG_STOP_ONE );
\r
497 /* We dont want to use the fifo. This is for test purposes to generate
\r
498 as many interrupts as possible. */
\r
499 HWREG( UART0_BASE + UART_O_LCR_H ) &= ~mainFIFO_SET;
\r
501 /* Enable both Rx and Tx interrupts. */
\r
502 HWREG( UART0_BASE + UART_O_IM ) |= ( UART_INT_TX | UART_INT_RX );
\r
503 IntEnable( INT_UART0 );
\r
505 /*-----------------------------------------------------------*/
\r
507 void vUART_ISR(void)
\r
509 unsigned long ulStatus;
\r
511 portBASE_TYPE xTaskWokenByPost = pdFALSE;
\r
513 /* What caused the interrupt. */
\r
514 ulStatus = UARTIntStatus( UART0_BASE, pdTRUE );
\r
516 /* Clear the interrupt. */
\r
517 UARTIntClear( UART0_BASE, ulStatus );
\r
519 /* Was an Rx interrpt pending? */
\r
520 if( ulStatus & UART_INT_RX )
\r
522 if( ( HWREG(UART0_BASE + UART_O_FR ) & UART_FR_RXFF ) )
\r
524 /* Get the char from the buffer and post it onto the queue of
\r
525 Rxed chars. Posting the character should wake the task that is
\r
526 blocked on the queue waiting for characters. */
\r
527 cRxedChar = ( char ) HWREG( UART0_BASE + UART_O_DR );
\r
528 xTaskWokenByPost = crQUEUE_SEND_FROM_ISR( xCommsQueue, &cRxedChar, xTaskWokenByPost );
\r
532 /* Was a Tx interrupt pending? */
\r
533 if( ulStatus & UART_INT_TX )
\r
535 /* Send the next character in the string. We are not using the FIFO. */
\r
536 if( cNextChar <= mainLAST_TX_CHAR )
\r
538 if( !( HWREG( UART0_BASE + UART_O_FR ) & UART_FR_TXFF ) )
\r
540 HWREG( UART0_BASE + UART_O_DR ) = cNextChar;
\r
546 if( xTaskWokenByPost )
\r
548 /* We are posting to a co-routine rather than a task so don't bother
\r
549 causing a task switch. */
\r
552 /*-----------------------------------------------------------*/
\r
554 static void prvPDCWrite( char cAddress, char cData )
\r
558 PDCWrite( cAddress, cData );
\r
562 /*-----------------------------------------------------------*/
\r
564 void vSetErrorLED( void )
\r
566 vParTestSetLED( mainCOMMS_FAIL_LED, pdTRUE );
\r
568 /*-----------------------------------------------------------*/
\r
570 __asm void prvSetAndCheckRegisters( void )
\r
572 extern vSetErrorLED
\r
574 /* Fill the general purpose registers with known values. */
\r
589 /* Check the values are as expected. */
\r
620 ldr r1, =vSetErrorLED
\r
625 /*-----------------------------------------------------------*/
\r
projects / freertos / blob