git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/ARM7_STR71x_IAR/serial/serial.c

   1 /*\r
   2     FreeRTOS V8.2.0rc1 - Copyright (C) 2014 Real Time Engineers Ltd.\r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     This file is part of the FreeRTOS distribution.\r
   8 \r
   9     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  10     the terms of the GNU General Public License (version 2) as published by the\r
  11     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  12 \r
  13     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  14     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  15     >>!   obliged to provide the source code for proprietary components     !<<\r
  16     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  17 \r
  18     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  19     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  20     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  21     link: http://www.freertos.org/a00114.html\r
  22 \r
  23     1 tab == 4 spaces!\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  28      *    not run, what could be wrong?".  Have you defined configASSERT()?  *\r
  29      *                                                                       *\r
  30      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  31      *                                                                       *\r
  32     ***************************************************************************\r
  33 \r
  34     ***************************************************************************\r
  35      *                                                                       *\r
  36      *    FreeRTOS provides completely free yet professionally developed,    *\r
  37      *    robust, strictly quality controlled, supported, and cross          *\r
  38      *    platform software that is more than just the market leader, it     *\r
  39      *    is the industry's de facto standard.                               *\r
  40      *                                                                       *\r
  41      *    Help yourself get started quickly while simultaneously helping     *\r
  42      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  43      *    tutorial book, reference manual, or both:                          *\r
  44      *    http://www.FreeRTOS.org/Documentation                              *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     ***************************************************************************\r
  49      *                                                                       *\r
  50      *   Investing in training allows your team to be as productive as       *\r
  51      *   possible as early as possible, lowering your overall development    *\r
  52      *   cost, and enabling you to bring a more robust product to market     *\r
  53      *   earlier than would otherwise be possible.  Richard Barry is both    *\r
  54      *   the architect and key author of FreeRTOS, and so also the world's   *\r
  55      *   leading authority on what is the world's most popular real time     *\r
  56      *   kernel for deeply embedded MCU designs.  Obtaining your training    *\r
  57      *   from Richard ensures your team will gain directly from his in-depth *\r
  58      *   product knowledge and years of usage experience.  Contact Real Time *\r
  59      *   Engineers Ltd to enquire about the FreeRTOS Masterclass, presented  *\r
  60      *   by Richard Barry:  http://www.FreeRTOS.org/contact\r
  61      *                                                                       *\r
  62     ***************************************************************************\r
  63 \r
  64     ***************************************************************************\r
  65      *                                                                       *\r
  66      *    You are receiving this top quality software for free.  Please play *\r
  67      *    fair and reciprocate by reporting any suspected issues and         *\r
  68      *    participating in the community forum:                              *\r
  69      *    http://www.FreeRTOS.org/support                                    *\r
  70      *                                                                       *\r
  71      *    Thank you!                                                         *\r
  72      *                                                                       *\r
  73     ***************************************************************************\r
  74 \r
  75     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  76     license and Real Time Engineers Ltd. contact details.\r
  77 \r
  78     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  79     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  80     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  81 \r
  82     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  83     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  84 \r
  85     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  86     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  87     licenses offer ticketed support, indemnification and commercial middleware.\r
  88 \r
  89     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  90     engineered and independently SIL3 certified version for use in safety and\r
  91     mission critical applications that require provable dependability.\r
  92 \r
  93     1 tab == 4 spaces!\r
  94 */\r
  95 \r
  96 /*\r
  97         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0.\r
  98 */\r
  99 \r
 100 /* Library includes. */\r
 101 #include "uart.h"\r
 102 #include "gpio.h"\r
 103 #include "eic.h"\r
 104 \r
 105 /* Scheduler includes. */\r
 106 #include "FreeRTOS.h"\r
 107 #include "queue.h"\r
 108 \r
 109 /* Demo application includes. */\r
 110 #include "serial.h"\r
 111 \r
 112 #define UART0_Rx_Pin                                    ( 0x0001<< 8 )\r
 113 #define UART0_Tx_Pin                                    ( 0x0001<< 9 )\r
 114 \r
 115 #define serINVALID_QUEUE                                ( ( QueueHandle_t ) 0 )\r
 116 #define serNO_BLOCK                                             ( ( TickType_t ) 0 )\r
 117 \r
 118 /* Macros to turn on and off the Tx empty interrupt. */\r
 119 #define serINTERRUPT_ON()                               UART0->IER |= UART_TxHalfEmpty\r
 120 #define serINTERRUPT_OFF()                              UART0->IER &= ~UART_TxHalfEmpty\r
 121 \r
 122 /*-----------------------------------------------------------*/\r
 123 \r
 124 /* Queues used to hold received characters, and characters waiting to be\r
 125 transmitted. */\r
 126 static QueueHandle_t xRxedChars;\r
 127 static QueueHandle_t xCharsForTx;\r
 128 \r
 129 /*-----------------------------------------------------------*/\r
 130 \r
 131 /* Interrupt entry point written in the assembler file serialISR.s79. */\r
 132 extern void vSerialISREntry( void );\r
 133 \r
 134 /* The interrupt service routine - called from the assembly entry point. */\r
 135 __arm void vSerialISR( void );\r
 136 \r
 137 /*-----------------------------------------------------------*/\r
 138 \r
 139 /*\r
 140  * See the serial2.h header file.\r
 141  */\r
 142 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 143 {\r
 144 xComPortHandle xReturn;\r
 145         \r
 146         /* Create the queues used to hold Rx and Tx characters. */\r
 147         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 148         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 149 \r
 150         /* If the queues were created correctly then setup the serial port\r
 151         hardware. */\r
 152         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 153         {\r
 154                 portENTER_CRITICAL();\r
 155                 {\r
 156                         /* Setup the UART port pins. */\r
 157                         GPIO_Config( GPIO0, UART0_Tx_Pin, GPIO_AF_PP );\r
 158                         GPIO_Config( GPIO0, UART0_Rx_Pin, GPIO_IN_TRI_CMOS );\r
 159 \r
 160                         /* Configure the UART. */\r
 161                         UART_OnOffConfig( UART0, ENABLE );\r
 162                         UART_FifoConfig( UART0, DISABLE );\r
 163                         UART_FifoReset( UART0, UART_RxFIFO );\r
 164                         UART_FifoReset( UART0, UART_TxFIFO );\r
 165                         UART_LoopBackConfig(UART0, DISABLE );\r
 166                         UART_Config( UART0, ulWantedBaud, UART_NO_PARITY, UART_1_StopBits, UARTM_8D );\r
 167                         UART_RxConfig( UART0, ENABLE );\r
 168 \r
 169                         /* Configure the IEC for the UART interrupts. */\r
 170                         EIC_IRQChannelPriorityConfig( UART0_IRQChannel, 1 );\r
 171                         EIC_IRQChannelConfig( UART0_IRQChannel, ENABLE );\r
 172                         EIC_IRQConfig( ENABLE );\r
 173                         UART_ItConfig( UART0, UART_RxBufFull, ENABLE );\r
 174                 }\r
 175                 portEXIT_CRITICAL();\r
 176         }\r
 177         else\r
 178         {\r
 179                 xReturn = ( xComPortHandle ) 0;\r
 180         }\r
 181 \r
 182         /* This demo file only supports a single port but we have to return\r
 183         something to comply with the standard demo header file. */\r
 184         return xReturn;\r
 185 }\r
 186 /*-----------------------------------------------------------*/\r
 187 \r
 188 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, TickType_t xBlockTime )\r
 189 {\r
 190         /* The port handle is not required as this driver only supports one port. */\r
 191         ( void ) pxPort;\r
 192 \r
 193         /* Get the next character from the buffer.  Return false if no characters\r
 194         are available, or arrive before xBlockTime expires. */\r
 195         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 196         {\r
 197                 return pdTRUE;\r
 198         }\r
 199         else\r
 200         {\r
 201                 return pdFALSE;\r
 202         }\r
 203 }\r
 204 /*-----------------------------------------------------------*/\r
 205 \r
 206 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 207 {\r
 208 signed char *pxNext;\r
 209 \r
 210         /* A couple of parameters that this port does not use. */\r
 211         ( void ) usStringLength;\r
 212         ( void ) pxPort;\r
 213 \r
 214         /* NOTE: This implementation does not handle the queue being full as no\r
 215         block time is used! */\r
 216 \r
 217         /* The port handle is not required as this driver only supports UART0. */\r
 218         ( void ) pxPort;\r
 219 \r
 220         /* Send each character in the string, one at a time. */\r
 221         pxNext = ( signed char * ) pcString;\r
 222         while( *pxNext )\r
 223         {\r
 224                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 225                 pxNext++;\r
 226         }\r
 227 }\r
 228 /*-----------------------------------------------------------*/\r
 229 \r
 230 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, TickType_t xBlockTime )\r
 231 {\r
 232         /* Place the character in the queue of characters to be transmitted. */\r
 233         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 234         {\r
 235                 return pdFAIL;\r
 236         }\r
 237 \r
 238         /* Turn on the Tx interrupt so the ISR will remove the character from the\r
 239         queue and send it.   This does not need to be in a critical section as\r
 240         if the interrupt has already removed the character the next interrupt\r
 241         will simply turn off the Tx interrupt again. */\r
 242         serINTERRUPT_ON();\r
 243 \r
 244         return pdPASS;\r
 245 }\r
 246 /*-----------------------------------------------------------*/\r
 247 \r
 248 void vSerialClose( xComPortHandle xPort )\r
 249 {\r
 250         /* Not supported as not required by the demo application. */\r
 251 }\r
 252 /*-----------------------------------------------------------*/\r
 253 \r
 254 /* Serial port ISR.  This can cause a context switch so is not defined as a\r
 255 standard ISR using the __irq keyword.  Instead a wrapper function is defined\r
 256 within serialISR.s79 which in turn calls this function.  See the port\r
 257 documentation on the FreeRTOS.org website for more information. */\r
 258 __arm void vSerialISR( void )\r
 259 {\r
 260 unsigned short usStatus;\r
 261 signed char cChar;\r
 262 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 263 \r
 264         /* What caused the interrupt? */\r
 265         usStatus = UART_FlagStatus( UART0 );\r
 266 \r
 267         if( usStatus & UART_TxHalfEmpty )\r
 268         {\r
 269                 /* The interrupt was caused by the THR becoming empty.  Are there any\r
 270                 more characters to transmit? */\r
 271                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 272                 {\r
 273                         /* A character was retrieved from the queue so can be sent to the\r
 274                         THR now. */\r
 275                         UART0->TxBUFR = cChar;\r
 276                 }\r
 277                 else\r
 278                 {\r
 279                         /* Queue empty, nothing to send so turn off the Tx interrupt. */\r
 280                         serINTERRUPT_OFF();\r
 281                 }               \r
 282         }\r
 283 \r
 284         if( usStatus &  UART_RxBufFull )\r
 285         {\r
 286                 /* The interrupt was caused by a character being received.  Grab the\r
 287                 character from the RHR and place it in the queue of received\r
 288                 characters. */\r
 289                 cChar = UART0->RxBUFR;\r
 290                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 291         }\r
 292 \r
 293         /* If a task was woken by either a character being received or a character\r
 294         being transmitted then we may need to switch to another task. */\r
 295         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 296 \r
 297         /* End the interrupt in the EIC. */\r
 298         portCLEAR_EIC();\r
 299 }\r
 300 \r
 301 \r
 302 \r
 303 \r
 304 \r
 305         \r