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

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