git.sur5r.net Git - freertos/blob - Demo/CORTEX_LM3S316_IAR/commstest.c

   1 /*\r
   2         FreeRTOS.org V5.1.2 - Copyright (C) 2003-2009 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS.org distribution.\r
   5 \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
  10 \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
  15 \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
  19 \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
  24         can be applied.\r
  25 \r
  26     ***************************************************************************\r
  27     ***************************************************************************\r
  28     *                                                                         *\r
  29     * Get the FreeRTOS eBook!  See http://www.FreeRTOS.org/Documentation      *\r
  30         *                                                                         *\r
  31         * This is a concise, step by step, 'hands on' guide that describes both   *\r
  32         * general multitasking concepts and FreeRTOS specifics. It presents and   *\r
  33         * explains numerous examples that are written using the FreeRTOS API.     *\r
  34         * Full source code for all the examples is provided in an accompanying    *\r
  35         * .zip file.                                                              *\r
  36     *                                                                         *\r
  37     ***************************************************************************\r
  38     ***************************************************************************\r
  39 \r
  40         Please ensure to read the configuration and relevant port sections of the\r
  41         online documentation.\r
  42 \r
  43         http://www.FreeRTOS.org - Documentation, latest information, license and \r
  44         contact details.\r
  45 \r
  46         http://www.SafeRTOS.com - A version that is certified for use in safety \r
  47         critical systems.\r
  48 \r
  49         http://www.OpenRTOS.com - Commercial support, development, porting, \r
  50         licensing and training services.\r
  51 */\r
  52 \r
  53 /*\r
  54  * The comms test Rx and Tx task and co-routine.  See the comments at the top\r
  55  * of main.c for full information.\r
  56  */\r
  57 \r
  58 \r
  59 /* Scheduler include files. */\r
  60 #include "FreeRTOS.h"\r
  61 #include "task.h"\r
  62 #include "queue.h"\r
  63 #include "croutine.h"\r
  64 \r
  65 /* Demo application include files. */\r
  66 #include "partest.h"\r
  67 \r
  68 /* Library include files. */\r
  69 #include "DriverLib.h"\r
  70 \r
  71 /* The LED's toggled by the various tasks. */\r
  72 #define commsFAIL_LED                   ( 7 )\r
  73 #define commsRX_LED                     ( 6 )\r
  74 #define commsTX_LED                     ( 5 )\r
  75 \r
  76 /* The length of the queue used to pass received characters to the Comms Rx\r
  77 task. */\r
  78 #define commsRX_QUEUE_LEN                       ( 5 )\r
  79 \r
  80 /* The baud rate used by the UART comms tasks/co-routine. */\r
  81 #define commsBAUD_RATE                          ( 57600 )\r
  82 \r
  83 /* FIFO setting for the UART.  The FIFO is not used to create a better test. */\r
  84 #define commsFIFO_SET                           ( 0x10 )\r
  85 \r
  86 /* The string that is transmitted on the UART contains sequentially the\r
  87 characters from commsFIRST_TX_CHAR to commsLAST_TX_CHAR. */\r
  88 #define commsFIRST_TX_CHAR '0'\r
  89 #define commsLAST_TX_CHAR 'z'\r
  90 \r
  91 /* Just used to walk through the program memory in order that some random data\r
  92 can be generated. */\r
  93 #define commsTOTAL_PROGRAM_MEMORY ( ( unsigned portLONG * ) ( 8 * 1024 ) )\r
  94 #define commsFIRST_PROGRAM_BYTES ( ( unsigned portLONG * ) 4 )\r
  95 \r
  96 /* The time between transmissions of the string on UART 0.   This is pseudo\r
  97 random in order to generate a bit or randomness to when the interrupts occur.*/\r
  98 #define commsMIN_TX_DELAY                       ( 40 / portTICK_RATE_MS )\r
  99 #define commsMAX_TX_DELAY                       ( ( portTickType ) 0x7f )\r
 100 #define commsOFFSET_TIME                        ( ( portTickType ) 3 )\r
 101 \r
 102 /* The time the Comms Rx task should wait to receive a character.  This should\r
 103 be slightly longer than the time between transmissions.  If we do not receive\r
 104 a character after this time then there must be an error in the transmission or\r
 105 the timing of the transmission. */\r
 106 #define commsRX_DELAY                   ( commsMAX_TX_DELAY + 20 )\r
 107 \r
 108 \r
 109 static unsigned portBASE_TYPE uxCommsErrorStatus = pdPASS;\r
 110 \r
 111 /* The queue used to pass characters out of the ISR. */\r
 112 static xQueueHandle xCommsQueue;\r
 113 \r
 114 /* The next character to transmit. */\r
 115 static portCHAR cNextChar;\r
 116 \r
 117 /*-----------------------------------------------------------*/\r
 118 \r
 119 void vSerialInit( void )\r
 120 {\r
 121         /* Create the queue used to communicate between the UART ISR and the Comms\r
 122         Rx task. */\r
 123         xCommsQueue = xQueueCreate( commsRX_QUEUE_LEN, sizeof( portCHAR ) );\r
 124 \r
 125         /* Enable the UART.  GPIOA has already been initialised. */\r
 126         SysCtlPeripheralEnable(SYSCTL_PERIPH_UART0);\r
 127 \r
 128         /* Set GPIO A0 and A1 as peripheral function.  They are used to output the\r
 129         UART signals. */\r
 130         GPIODirModeSet( GPIO_PORTA_BASE, GPIO_PIN_0 | GPIO_PIN_1, GPIO_DIR_MODE_HW );\r
 131 \r
 132         /* Configure the UART for 8-N-1 operation. */\r
 133         UARTConfigSetExpClk( UART0_BASE, SysCtlClockGet(), commsBAUD_RATE, UART_CONFIG_WLEN_8 | UART_CONFIG_PAR_NONE | UART_CONFIG_STOP_ONE );\r
 134 \r
 135         /* We dont want to use the fifo.  This is for test purposes to generate\r
 136         as many interrupts as possible. */\r
 137         HWREG( UART0_BASE + UART_O_LCR_H ) &= ~commsFIFO_SET;\r
 138 \r
 139         /* Enable both Rx and Tx interrupts. */\r
 140         HWREG( UART0_BASE + UART_O_IM ) |= ( UART_INT_TX | UART_INT_RX );\r
 141         IntPrioritySet( INT_UART0, configKERNEL_INTERRUPT_PRIORITY );\r
 142         IntEnable( INT_UART0 );\r
 143 }\r
 144 /*-----------------------------------------------------------*/\r
 145 \r
 146 void vSerialTxCoRoutine( xCoRoutineHandle xHandle, unsigned portBASE_TYPE uxIndex )\r
 147 {\r
 148 portTickType xDelayPeriod;\r
 149 static unsigned portLONG *pulRandomBytes = commsFIRST_PROGRAM_BYTES;\r
 150 \r
 151         /* Co-routine MUST start with a call to crSTART. */\r
 152         crSTART( xHandle );\r
 153 \r
 154         for(;;)\r
 155     {   \r
 156                 /* Was the previously transmitted string received correctly? */\r
 157                 if( uxCommsErrorStatus != pdPASS )\r
 158                 {\r
 159                         /* An error was encountered so set the error LED. */\r
 160                         vParTestSetLED( commsFAIL_LED, pdTRUE );\r
 161                 }\r
 162 \r
 163                 /* The next character to Tx is the first in the string. */\r
 164                 cNextChar = commsFIRST_TX_CHAR;\r
 165 \r
 166                 UARTIntDisable( UART0_BASE, UART_INT_TX );\r
 167                 {\r
 168                         /* Send the first character. */\r
 169                         if( !( HWREG( UART0_BASE + UART_O_FR ) & UART_FR_TXFF ) )\r
 170                         {\r
 171                                 HWREG( UART0_BASE + UART_O_DR ) = cNextChar;\r
 172                         }\r
 173 \r
 174                         /* Move the variable to the char to Tx on so the ISR transmits\r
 175                         the next character in the string once this one has completed. */\r
 176                         cNextChar++;\r
 177                 }\r
 178                 UARTIntEnable(UART0_BASE, UART_INT_TX);\r
 179 \r
 180                 /* Toggle the LED to show a new string is being transmitted. */\r
 181         vParTestToggleLED( commsTX_LED );\r
 182 \r
 183                 /* Delay before we start the string off again.  A pseudo-random delay\r
 184                 is used as this will provide a better test. */\r
 185                 xDelayPeriod = xTaskGetTickCount() + ( *pulRandomBytes );\r
 186 \r
 187                 pulRandomBytes++;\r
 188                 if( pulRandomBytes > commsTOTAL_PROGRAM_MEMORY )\r
 189                 {\r
 190                         pulRandomBytes = commsFIRST_PROGRAM_BYTES;\r
 191                 }\r
 192 \r
 193                 /* Make sure we don't wait too long... */\r
 194                 xDelayPeriod &= commsMAX_TX_DELAY;\r
 195 \r
 196                 /* ...but we do want to wait. */\r
 197                 if( xDelayPeriod < commsMIN_TX_DELAY )\r
 198                 {\r
 199                         xDelayPeriod = commsMIN_TX_DELAY;\r
 200                 }\r
 201 \r
 202                 /* Block for the random(ish) time. */\r
 203                 crDELAY( xHandle, xDelayPeriod );\r
 204     }\r
 205 \r
 206         /* Co-routine MUST end with a call to crEND. */\r
 207         crEND();\r
 208 }\r
 209 /*-----------------------------------------------------------*/\r
 210 \r
 211 void vUART_ISR( void )\r
 212 {\r
 213 unsigned portLONG ulStatus;\r
 214 portCHAR cRxedChar;\r
 215 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 216 \r
 217         /* What caused the interrupt. */\r
 218         ulStatus = UARTIntStatus( UART0_BASE, pdTRUE );\r
 219 \r
 220         /* Clear the interrupt. */\r
 221         UARTIntClear( UART0_BASE, ulStatus );\r
 222 \r
 223         /* Was an Rx interrpt pending? */\r
 224         if( ulStatus & UART_INT_RX )\r
 225         {\r
 226                 if( ( HWREG(UART0_BASE + UART_O_FR ) & UART_FR_RXFF ) )\r
 227                 {\r
 228                         /* Get the char from the buffer and post it onto the queue of\r
 229                         Rxed chars.  Posting the character should wake the task that is\r
 230                         blocked on the queue waiting for characters. */\r
 231                         cRxedChar = ( portCHAR ) HWREG( UART0_BASE + UART_O_DR );\r
 232                         xQueueSendFromISR( xCommsQueue, &cRxedChar, &xHigherPriorityTaskWoken );\r
 233                 }               \r
 234         }\r
 235 \r
 236         /* Was a Tx interrupt pending? */\r
 237         if( ulStatus & UART_INT_TX )\r
 238         {\r
 239                 /* Send the next character in the string.  We are not using the FIFO. */\r
 240                 if( cNextChar <= commsLAST_TX_CHAR )\r
 241                 {\r
 242                         if( !( HWREG( UART0_BASE + UART_O_FR ) & UART_FR_TXFF ) )\r
 243                         {\r
 244                                 HWREG( UART0_BASE + UART_O_DR ) = cNextChar;\r
 245                         }\r
 246                         cNextChar++;\r
 247                 }\r
 248         }\r
 249         \r
 250         /* If a task was woken by the character being received then we force\r
 251         a context switch to occur in case the task is of higher priority than\r
 252         the currently executing task (i.e. the task that this interrupt\r
 253         interrupted.) */\r
 254         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 255 }\r
 256 /*-----------------------------------------------------------*/\r
 257 \r
 258 void vCommsRxTask( void * pvParameters )\r
 259 {\r
 260 static portCHAR cRxedChar, cExpectedChar;\r
 261 \r
 262         /* Set the char we expect to receive to the start of the string. */\r
 263         cExpectedChar = commsFIRST_TX_CHAR;\r
 264 \r
 265         for( ;; )\r
 266         {\r
 267                 /* Wait for a character to be received. */\r
 268                 xQueueReceive( xCommsQueue, ( void * ) &cRxedChar, commsRX_DELAY );\r
 269 \r
 270                 /* Was the character recived (if any) the expected character. */\r
 271                 if( cRxedChar != cExpectedChar )\r
 272                 {\r
 273                         /* Got an unexpected character.  This can sometimes occur when\r
 274                         reseting the system using the debugger leaving characters already\r
 275                         in the UART regsters. */\r
 276                         uxCommsErrorStatus = pdFAIL;\r
 277 \r
 278                         /* Resync by waiting for the end of the current string. */\r
 279                         while( cRxedChar != commsLAST_TX_CHAR )\r
 280                         {\r
 281                                 while( !xQueueReceive( xCommsQueue, ( void * ) &cRxedChar, portMAX_DELAY ) );\r
 282                         }\r
 283 \r
 284                         /* The next expected character is the start of the string again. */\r
 285                         cExpectedChar = commsFIRST_TX_CHAR;\r
 286                 }\r
 287                 else\r
 288                 {\r
 289                         if( cExpectedChar == commsLAST_TX_CHAR )\r
 290                         {\r
 291                                 /* We have reached the end of the string - we now expect to\r
 292                                 receive the first character in the string again.   The LED is\r
 293                                 toggled to indicate that the entire string was received without\r
 294                                 error. */\r
 295                                 vParTestToggleLED( commsRX_LED );\r
 296                                 cExpectedChar = commsFIRST_TX_CHAR;\r
 297                         }\r
 298                         else\r
 299                         {\r
 300                                 /* We got the expected character, we now expect to receive the\r
 301                                 next character in the string. */\r
 302                                 cExpectedChar++;\r
 303                         }\r
 304                 }\r
 305         }\r
 306 }\r
 307 /*-----------------------------------------------------------*/\r
 308 \r
 309 unsigned portBASE_TYPE uxGetCommsStatus( void )\r
 310 {\r
 311         return uxCommsErrorStatus;\r
 312 }\r