2 FreeRTOS V7.4.0 - Copyright (C) 2013 Real Time Engineers Ltd.
\r
4 FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME. PLEASE VISIT
\r
5 http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 ***************************************************************************
\r
9 * FreeRTOS tutorial books are available in pdf and paperback. *
\r
10 * Complete, revised, and edited pdf reference manuals are also *
\r
13 * Purchasing FreeRTOS documentation will not only help you, by *
\r
14 * ensuring you get running as quickly as possible and with an *
\r
15 * in-depth knowledge of how to use FreeRTOS, it will also help *
\r
16 * the FreeRTOS project to continue with its mission of providing *
\r
17 * professional grade, cross platform, de facto standard solutions *
\r
18 * for microcontrollers - completely free of charge! *
\r
20 * >>> See http://www.FreeRTOS.org/Documentation for details. <<< *
\r
22 * Thank you for using FreeRTOS, and thank you for your support! *
\r
24 ***************************************************************************
\r
27 This file is part of the FreeRTOS distribution.
\r
29 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
30 the terms of the GNU General Public License (version 2) as published by the
\r
31 Free Software Foundation AND MODIFIED BY the FreeRTOS exception.
\r
33 >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to
\r
34 distribute a combined work that includes FreeRTOS without being obliged to
\r
35 provide the source code for proprietary components outside of the FreeRTOS
\r
38 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
39 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
40 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
\r
41 details. You should have received a copy of the GNU General Public License
\r
42 and the FreeRTOS license exception along with FreeRTOS; if not itcan be
\r
43 viewed here: http://www.freertos.org/a00114.html and also obtained by
\r
44 writing to Real Time Engineers Ltd., contact details for whom are available
\r
45 on the FreeRTOS WEB site.
\r
49 ***************************************************************************
\r
51 * Having a problem? Start by reading the FAQ "My application does *
\r
52 * not run, what could be wrong?" *
\r
54 * http://www.FreeRTOS.org/FAQHelp.html *
\r
56 ***************************************************************************
\r
59 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
60 license and Real Time Engineers Ltd. contact details.
\r
62 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
63 including FreeRTOS+Trace - an indispensable productivity tool, and our new
\r
64 fully thread aware and reentrant UDP/IP stack.
\r
66 http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
\r
67 Integrity Systems, who sell the code with commercial support,
\r
68 indemnification and middleware, under the OpenRTOS brand.
\r
70 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
71 engineered and independently SIL3 certified version for use in safety and
\r
72 mission critical applications that require provable dependability.
\r
76 * This demo application creates six co-routines and two tasks (three including
\r
77 * the idle task). The co-routines execute as part of the idle task hook.
\r
79 * Five of the created co-routines are the standard 'co-routine flash'
\r
80 * co-routines contained within the Demo/Common/Minimal/crflash.c file and
\r
81 * documented on the FreeRTOS.org WEB site.
\r
83 * The 'LCD Task' rotates a string on the LCD, delaying between each character
\r
84 * as necessitated by the slow interface, and delaying between each string just
\r
85 * long enough to enable the text to be read.
\r
87 * The sixth co-routine and final task control the transmission and reception
\r
88 * of a string to UART 0. The co-routine periodically sends the first
\r
89 * character of the string to the UART, with the UART's TxEnd interrupt being
\r
90 * used to transmit the remaining characters. The UART's RxEnd interrupt
\r
91 * receives the characters and places them on a queue to be processed by the
\r
92 * 'COMs Rx' task. An error is latched should an unexpected character be
\r
93 * received, or any character be received out of sequence.
\r
95 * A loopback connector is required to ensure that each character transmitted
\r
96 * on the UART is also received on the same UART. For test purposes the UART
\r
97 * FIFO's are not utalised in order to maximise the interrupt overhead. Also
\r
98 * a pseudo random interval is used between the start of each transmission in
\r
99 * order that the resultant interrupts are more randomly distributed and
\r
100 * therefore more likely to highlight any problems.
\r
102 * The flash co-routines control LED's zero to four. LED five is toggled each
\r
103 * time the string is transmitted on the UART. LED six is toggled each time
\r
104 * the string is CORRECTLY received on the UART. LED seven is latched on should
\r
105 * an error be detected in any task or co-routine.
\r
107 * In addition the idle task makes repetative calls to
\r
108 * prvSetAndCheckRegisters(). This simply loads the general purpose registers
\r
109 * with a known value, then checks each register to ensure the held value is
\r
110 * still correct. As a low priority task this checking routine is likely to
\r
111 * get repeatedly swapped in and out. A register being found to contain an
\r
112 * incorrect value is therefore indicative of an error in the task switching
\r
117 /* Scheduler include files. */
\r
118 #include "FreeRTOS.h"
\r
121 #include "croutine.h"
\r
123 /* Demo application include files. */
\r
124 #include "partest.h"
\r
125 #include "crflash.h"
\r
127 /* Library include files. */
\r
128 #include "DriverLib.h"
\r
130 /* The time to delay between writing each character to the LCD. */
\r
131 #define mainCHAR_WRITE_DELAY ( 2 / portTICK_RATE_MS )
\r
133 /* The time to delay between writing each string to the LCD. */
\r
134 #define mainSTRING_WRITE_DELAY ( 400 / portTICK_RATE_MS )
\r
136 /* The number of flash co-routines to create. */
\r
137 #define mainNUM_FLASH_CO_ROUTINES ( 5 )
\r
139 /* The length of the queue used to pass received characters to the Comms Rx
\r
141 #define mainRX_QUEUE_LEN ( 5 )
\r
143 /* The priority of the co-routine used to initiate the transmission of the
\r
144 string on UART 0. */
\r
145 #define mainTX_CO_ROUTINE_PRIORITY ( 1 )
\r
147 /* Only one co-routine is created so its index is not important. */
\r
148 #define mainTX_CO_ROUTINE_INDEX ( 0 )
\r
150 /* The time between transmissions of the string on UART 0. This is pseudo
\r
151 random in order to generate a bit or randomness to when the interrupts occur.*/
\r
152 #define mainMIN_TX_DELAY ( 40 / portTICK_RATE_MS )
\r
153 #define mainMAX_TX_DELAY ( ( portTickType ) 0x7f )
\r
154 #define mainOFFSET_TIME ( ( portTickType ) 3 )
\r
156 /* The time the Comms Rx task should wait to receive a character. This should
\r
157 be slightly longer than the time between transmissions. If we do not receive
\r
158 a character after this time then there must be an error in the transmission or
\r
159 the timing of the transmission. */
\r
160 #define mainCOMMS_RX_DELAY ( mainMAX_TX_DELAY + 20 )
\r
162 /* The task priorites. */
\r
163 #define mainLCD_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
164 #define mainCOMMS_RX_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
166 /* The LED's toggled by the various tasks. */
\r
167 #define mainCOMMS_FAIL_LED ( 7 )
\r
168 #define mainCOMMS_RX_LED ( 6 )
\r
169 #define mainCOMMS_TX_LED ( 5 )
\r
171 /* The baud rate used by the UART comms tasks/co-routine. */
\r
172 #define mainBAUD_RATE ( 57600 )
\r
174 /* FIFO setting for the UART. The FIFO is not used to create a better test. */
\r
175 #define mainFIFO_SET ( 0x10 )
\r
177 /* The string that is transmitted on the UART contains sequentially the
\r
178 characters from mainFIRST_TX_CHAR to mainLAST_TX_CHAR. */
\r
179 #define mainFIRST_TX_CHAR '0'
\r
180 #define mainLAST_TX_CHAR 'z'
\r
182 /* Just used to walk through the program memory in order that some random data
\r
183 can be generated. */
\r
184 #define mainTOTAL_PROGRAM_MEMORY ( ( unsigned long * ) ( 8 * 1024 ) )
\r
185 #define mainFIRST_PROGRAM_BYTES ( ( unsigned long * ) 4 )
\r
187 /* The error routine that is called if the driver library encounters an error. */
\r
190 __error__(char *pcFilename, unsigned long ulLine)
\r
195 /*-----------------------------------------------------------*/
\r
198 * The task that rotates text on the LCD.
\r
200 static void vLCDTask( void * pvParameters );
\r
203 * The task that receives the characters from UART 0.
\r
205 static void vCommsRxTask( void * pvParameters );
\r
208 * The co-routine that periodically initiates the transmission of the string on
\r
211 static void vSerialTxCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex );
\r
214 * Writes a string the the LCD.
\r
216 static void prvWriteString( const char *pcString );
\r
219 * Initialisation routine for the UART.
\r
221 static void vSerialInit( void );
\r
224 * Thread safe write to the PDC.
\r
226 static void prvPDCWrite( char cAddress, char cData );
\r
229 * Function to simply set a known value into the general purpose registers
\r
230 * then read them back to ensure they remain set correctly. An incorrect value
\r
231 * being indicative of an error in the task switching mechanism.
\r
233 void prvSetAndCheckRegisters( void );
\r
236 * Latch the LED that indicates that an error has occurred.
\r
238 void vSetErrorLED( void );
\r
241 * Sets up the PLL and ports used by the demo.
\r
243 static void prvSetupHardware( void );
\r
245 /*-----------------------------------------------------------*/
\r
247 /* Error flag set to pdFAIL if an error is encountered in the tasks/co-routines
\r
248 defined within this file. */
\r
249 unsigned portBASE_TYPE uxErrorStatus = pdPASS;
\r
251 /* The next character to transmit. */
\r
252 static char cNextChar;
\r
254 /* The queue used to transmit characters from the interrupt to the Comms Rx
\r
256 static xQueueHandle xCommsQueue;
\r
258 /*-----------------------------------------------------------*/
\r
262 /* Create the queue used to communicate between the UART ISR and the Comms
\r
264 xCommsQueue = xQueueCreate( mainRX_QUEUE_LEN, sizeof( char ) );
\r
266 /* Setup the ports used by the demo and the clock. */
\r
267 prvSetupHardware();
\r
269 /* Create the co-routines that flash the LED's. */
\r
270 vStartFlashCoRoutines( mainNUM_FLASH_CO_ROUTINES );
\r
272 /* Create the co-routine that initiates the transmission of characters
\r
274 xCoRoutineCreate( vSerialTxCoRoutine, mainTX_CO_ROUTINE_PRIORITY, mainTX_CO_ROUTINE_INDEX );
\r
276 /* Create the LCD and Comms Rx tasks. */
\r
277 xTaskCreate( vLCDTask, "LCD", configMINIMAL_STACK_SIZE, NULL, mainLCD_TASK_PRIORITY, NULL );
\r
278 xTaskCreate( vCommsRxTask, "CMS", configMINIMAL_STACK_SIZE, NULL, mainCOMMS_RX_TASK_PRIORITY, NULL );
\r
280 /* Start the scheduler running the tasks and co-routines just created. */
\r
281 vTaskStartScheduler();
\r
283 /* Should not get here unless we did not have enough memory to start the
\r
287 /*-----------------------------------------------------------*/
\r
289 static void prvSetupHardware( void )
\r
291 /* Setup the PLL. */
\r
292 SysCtlClockSet( SYSCTL_SYSDIV_10 | SYSCTL_USE_PLL | SYSCTL_OSC_MAIN | SYSCTL_XTAL_6MHZ );
\r
294 /* Initialise the hardware used to talk to the LCD, LED's and UART. */
\r
296 vParTestInitialise();
\r
299 /*-----------------------------------------------------------*/
\r
301 void vApplicationIdleHook( void )
\r
303 /* The co-routines are executed in the idle task using the idle task
\r
307 /* Schedule the co-routines. */
\r
308 vCoRoutineSchedule();
\r
310 /* Run the register check function between each co-routine. */
\r
311 prvSetAndCheckRegisters();
\r
314 /*-----------------------------------------------------------*/
\r
316 static void prvWriteString( const char *pcString )
\r
318 /* Write pcString to the LED, pausing between each character. */
\r
319 prvPDCWrite(PDC_LCD_CSR, LCD_CLEAR);
\r
322 vTaskDelay( mainCHAR_WRITE_DELAY );
\r
323 prvPDCWrite( PDC_LCD_RAM, *pcString );
\r
327 /*-----------------------------------------------------------*/
\r
329 void vLCDTask( void * pvParameters )
\r
331 unsigned portBASE_TYPE uxIndex;
\r
332 const unsigned char ucCFGData[] = {
\r
333 0x30, /* Set data bus to 8-bits. */
\r
336 0x3C, /* Number of lines/font. */
\r
337 0x08, /* Display off. */
\r
338 0x01, /* Display clear. */
\r
339 0x06, /* Entry mode [cursor dir][shift]. */
\r
340 0x0C /* Display on [display on][curson on][blinking on]. */
\r
343 /* The strings that are written to the LCD. */
\r
344 const char *pcStringsToDisplay[] = {
\r
348 "www.FreeRTOS.org",
\r
352 /* Configure the LCD. */
\r
354 while( uxIndex < sizeof( ucCFGData ) )
\r
356 prvPDCWrite( PDC_LCD_CSR, ucCFGData[ uxIndex ] );
\r
358 vTaskDelay( mainCHAR_WRITE_DELAY );
\r
361 /* Turn the LCD Backlight on. */
\r
362 prvPDCWrite( PDC_CSR, 0x01 );
\r
364 /* Clear display. */
\r
365 vTaskDelay( mainCHAR_WRITE_DELAY );
\r
366 prvPDCWrite( PDC_LCD_CSR, LCD_CLEAR );
\r
371 /* Display the string on the LCD. */
\r
372 prvWriteString( pcStringsToDisplay[ uxIndex ] );
\r
374 /* Move on to the next string - wrapping if necessary. */
\r
376 if( *( pcStringsToDisplay[ uxIndex ] ) == 0x00 )
\r
379 /* Longer pause on the last string to be sent. */
\r
380 vTaskDelay( mainSTRING_WRITE_DELAY * 2 );
\r
383 /* Wait until it is time to move onto the next string. */
\r
384 vTaskDelay( mainSTRING_WRITE_DELAY );
\r
387 /*-----------------------------------------------------------*/
\r
389 static void vCommsRxTask( void * pvParameters )
\r
391 static char cRxedChar, cExpectedChar;
\r
393 /* Set the char we expect to receive to the start of the string. */
\r
394 cExpectedChar = mainFIRST_TX_CHAR;
\r
398 /* Wait for a character to be received. */
\r
399 xQueueReceive( xCommsQueue, ( void * ) &cRxedChar, mainCOMMS_RX_DELAY );
\r
401 /* Was the character recived (if any) the expected character. */
\r
402 if( cRxedChar != cExpectedChar )
\r
404 /* Got an unexpected character. This can sometimes occur when
\r
405 reseting the system using the debugger leaving characters already
\r
406 in the UART regsters. */
\r
407 uxErrorStatus = pdFAIL;
\r
409 /* Resync by waiting for the end of the current string. */
\r
410 while( cRxedChar != mainLAST_TX_CHAR )
\r
412 while( !xQueueReceive( xCommsQueue, ( void * ) &cRxedChar, portMAX_DELAY ) );
\r
415 /* The next expected character is the start of the string again. */
\r
416 cExpectedChar = mainFIRST_TX_CHAR;
\r
420 if( cExpectedChar == mainLAST_TX_CHAR )
\r
422 /* We have reached the end of the string - we now expect to
\r
423 receive the first character in the string again. The LED is
\r
424 toggled to indicate that the entire string was received without
\r
426 vParTestToggleLED( mainCOMMS_RX_LED );
\r
427 cExpectedChar = mainFIRST_TX_CHAR;
\r
431 /* We got the expected character, we now expect to receive the
\r
432 next character in the string. */
\r
438 /*-----------------------------------------------------------*/
\r
440 static void vSerialTxCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex )
\r
442 portTickType xDelayPeriod;
\r
443 static unsigned long *pulRandomBytes = mainFIRST_PROGRAM_BYTES;
\r
445 /* Co-routine MUST start with a call to crSTART. */
\r
446 crSTART( xHandle );
\r
450 /* Was the previously transmitted string received correctly? */
\r
451 if( uxErrorStatus != pdPASS )
\r
453 /* An error was encountered so set the error LED. */
\r
457 /* The next character to Tx is the first in the string. */
\r
458 cNextChar = mainFIRST_TX_CHAR;
\r
460 UARTIntDisable( UART0_BASE, UART_INT_TX );
\r
462 /* Send the first character. */
\r
463 if( !( HWREG( UART0_BASE + UART_O_FR ) & UART_FR_TXFF ) )
\r
465 HWREG( UART0_BASE + UART_O_DR ) = cNextChar;
\r
468 /* Move the variable to the char to Tx on so the ISR transmits
\r
469 the next character in the string once this one has completed. */
\r
472 UARTIntEnable(UART0_BASE, UART_INT_TX);
\r
474 /* Toggle the LED to show a new string is being transmitted. */
\r
475 vParTestToggleLED( mainCOMMS_TX_LED );
\r
477 /* Delay before we start the string off again. A pseudo-random delay
\r
478 is used as this will provide a better test. */
\r
479 xDelayPeriod = xTaskGetTickCount() + ( *pulRandomBytes );
\r
482 if( pulRandomBytes > mainTOTAL_PROGRAM_MEMORY )
\r
484 pulRandomBytes = mainFIRST_PROGRAM_BYTES;
\r
487 /* Make sure we don't wait too long... */
\r
488 xDelayPeriod &= mainMAX_TX_DELAY;
\r
490 /* ...but we do want to wait. */
\r
491 if( xDelayPeriod < mainMIN_TX_DELAY )
\r
493 xDelayPeriod = mainMIN_TX_DELAY;
\r
496 /* Block for the random(ish) time. */
\r
497 crDELAY( xHandle, xDelayPeriod );
\r
500 /* Co-routine MUST end with a call to crEND. */
\r
503 /*-----------------------------------------------------------*/
\r
505 static void vSerialInit( void )
\r
507 /* Enable the UART. GPIOA has already been initialised. */
\r
508 SysCtlPeripheralEnable(SYSCTL_PERIPH_UART0);
\r
510 /* Set GPIO A0 and A1 as peripheral function. They are used to output the
\r
512 GPIODirModeSet( GPIO_PORTA_BASE, GPIO_PIN_0 | GPIO_PIN_1, GPIO_DIR_MODE_HW );
\r
514 /* Configure the UART for 8-N-1 operation. */
\r
515 UARTConfigSet( UART0_BASE, mainBAUD_RATE, UART_CONFIG_WLEN_8 | UART_CONFIG_PAR_NONE | UART_CONFIG_STOP_ONE );
\r
517 /* We dont want to use the fifo. This is for test purposes to generate
\r
518 as many interrupts as possible. */
\r
519 HWREG( UART0_BASE + UART_O_LCR_H ) &= ~mainFIFO_SET;
\r
521 /* Enable both Rx and Tx interrupts. */
\r
522 HWREG( UART0_BASE + UART_O_IM ) |= ( UART_INT_TX | UART_INT_RX );
\r
523 IntEnable( INT_UART0 );
\r
525 /*-----------------------------------------------------------*/
\r
527 void vUART_ISR(void)
\r
529 unsigned long ulStatus;
\r
531 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;
\r
533 /* What caused the interrupt. */
\r
534 ulStatus = UARTIntStatus( UART0_BASE, pdTRUE );
\r
536 /* Clear the interrupt. */
\r
537 UARTIntClear( UART0_BASE, ulStatus );
\r
539 /* Was an Rx interrpt pending? */
\r
540 if( ulStatus & UART_INT_RX )
\r
542 if( ( HWREG(UART0_BASE + UART_O_FR ) & UART_FR_RXFF ) )
\r
544 /* Get the char from the buffer and post it onto the queue of
\r
545 Rxed chars. Posting the character should wake the task that is
\r
546 blocked on the queue waiting for characters. */
\r
547 cRxedChar = ( char ) HWREG( UART0_BASE + UART_O_DR );
\r
548 xQueueSendFromISR( xCommsQueue, &cRxedChar, &xHigherPriorityTaskWoken );
\r
552 /* Was a Tx interrupt pending? */
\r
553 if( ulStatus & UART_INT_TX )
\r
555 /* Send the next character in the string. We are not using the FIFO. */
\r
556 if( cNextChar <= mainLAST_TX_CHAR )
\r
558 if( !( HWREG( UART0_BASE + UART_O_FR ) & UART_FR_TXFF ) )
\r
560 HWREG( UART0_BASE + UART_O_DR ) = cNextChar;
\r
566 /* If a task was woken by the character being received then we force
\r
567 a context switch to occur in case the task is of higher priority than
\r
568 the currently executing task (i.e. the task that this interrupt
\r
570 portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );
\r
572 /*-----------------------------------------------------------*/
\r
574 static void prvPDCWrite( char cAddress, char cData )
\r
578 PDCWrite( cAddress, cData );
\r
582 /*-----------------------------------------------------------*/
\r
584 void vSetErrorLED( void )
\r
586 vParTestSetLED( mainCOMMS_FAIL_LED, pdTRUE );
\r
588 /*-----------------------------------------------------------*/
\r
590 void prvSetAndCheckRegisters( void )
\r
592 /* Fill the general purpose registers with known values. */
\r
593 __asm volatile( " mov r11, #10\n"
\r
594 " add r0, r11, #1\n"
\r
595 " add r1, r11, #2\n"
\r
596 " add r2, r11, #3\n"
\r
597 " add r3, r11, #4\n"
\r
598 " add r4, r11, #5\n"
\r
599 " add r5, r11, #6\n"
\r
600 " add r6, r11, #7\n"
\r
601 " add r7, r11, #8\n"
\r
602 " add r8, r11, #9\n"
\r
603 " add r9, r11, #10\n"
\r
604 " add r10, r11, #11\n"
\r
605 " add r12, r11, #12" );
\r
607 /* Check the values are as expected. */
\r
608 __asm volatile( " cmp r11, #10\n"
\r
609 " bne set_error_led\n"
\r
611 " bne set_error_led\n"
\r
613 " bne set_error_led\n"
\r
615 " bne set_error_led\n"
\r
617 " bne set_error_led\n"
\r
619 " bne set_error_led\n"
\r
621 " bne set_error_led\n"
\r
623 " bne set_error_led\n"
\r
625 " bne set_error_led\n"
\r
627 " bne set_error_led\n"
\r
629 " bne set_error_led\n"
\r
631 " bne set_error_led\n"
\r
633 " bne set_error_led\n"
\r
636 __asm volatile( "set_error_led:\n"
\r
638 " ldr r1, =vSetErrorLED\n"
\r
643 /*-----------------------------------------------------------*/
\r
projects / freertos / blob