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

   1 /*\r
   2         FreeRTOS.org V4.6.1 - Copyright (C) 2003-2007 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS distribution.\r
   5 \r
   6         FreeRTOS 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 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; 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, 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         See http://www.FreeRTOS.org for documentation, latest information, license\r
  28         and contact details.  Please ensure to read the configuration and relevant\r
  29         port sections of the online documentation.\r
  30 \r
  31         Also see http://www.SafeRTOS.com a version that has been certified for use\r
  32         in safety critical systems, plus commercial licensing, development and\r
  33         support options.\r
  34         ***************************************************************************\r
  35 */\r
  36 \r
  37 /*\r
  38         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART1.\r
  39 */\r
  40 \r
  41 /* Library includes. */\r
  42 #include "91x_lib.h"\r
  43 \r
  44 /* Scheduler includes. */\r
  45 #include "FreeRTOS.h"\r
  46 #include "queue.h"\r
  47 #include "semphr.h"\r
  48 \r
  49 /* Demo application includes. */\r
  50 #include "serial.h"\r
  51 /*-----------------------------------------------------------*/\r
  52 \r
  53 /* Misc defines. */\r
  54 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
  55 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
  56 #define serTX_BLOCK_TIME                                ( 40 / portTICK_RATE_MS )\r
  57 \r
  58 /* Interrupt and status bit definitions. */\r
  59 #define mainTXRIS 0x20  \r
  60 #define mainRXRIS 0x50\r
  61 #define serTX_FIFO_FULL 0x20\r
  62 #define serCLEAR_ALL_INTERRUPTS 0x3ff\r
  63 /*-----------------------------------------------------------*/\r
  64 \r
  65 /* The queue used to hold received characters. */\r
  66 static xQueueHandle xRxedChars;\r
  67 \r
  68 /* The semaphore used to wake a task waiting for space to become available\r
  69 in the FIFO. */\r
  70 static xSemaphoreHandle xTxFIFOSemaphore;\r
  71 \r
  72 /*-----------------------------------------------------------*/\r
  73 \r
  74 /* UART interrupt handler. */\r
  75 void UART1_IRQHandler( void );\r
  76 \r
  77 /* The interrupt service routine - called from the assembly entry point. */\r
  78 __arm void UART1_IRQHandler( void );\r
  79 \r
  80 /*-----------------------------------------------------------*/\r
  81 \r
  82 /* Flag to indicate whether or not a task is blocked waiting for space on\r
  83 the FIFO. */\r
  84 static portLONG lTaskWaiting = pdFALSE;\r
  85 \r
  86 /*\r
  87  * See the serial2.h header file.\r
  88  */\r
  89 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
  90 {\r
  91 xComPortHandle xReturn;\r
  92 UART_InitTypeDef xUART1_Init;\r
  93 GPIO_InitTypeDef GPIO_InitStructure;\r
  94         \r
  95         /* Create the queues used to hold Rx characters. */\r
  96         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
  97         \r
  98         /* Create the semaphore used to wake a task waiting for space to become\r
  99         available in the FIFO. */\r
 100         vSemaphoreCreateBinary( xTxFIFOSemaphore );\r
 101 \r
 102         /* If the queue/semaphore was created correctly then setup the serial port\r
 103         hardware. */\r
 104         if( ( xRxedChars != serINVALID_QUEUE ) && ( xTxFIFOSemaphore != serINVALID_QUEUE ) )\r
 105         {\r
 106                 /* Pre take the semaphore so a task will block if it tries to access\r
 107                 it. */\r
 108                 xSemaphoreTake( xTxFIFOSemaphore, 0 );\r
 109                 \r
 110                 /* Configure the UART. */\r
 111                 xUART1_Init.UART_WordLength = UART_WordLength_8D;\r
 112                 xUART1_Init.UART_StopBits = UART_StopBits_1;\r
 113                 xUART1_Init.UART_Parity = UART_Parity_No;\r
 114                 xUART1_Init.UART_BaudRate = ulWantedBaud;\r
 115                 xUART1_Init.UART_HardwareFlowControl = UART_HardwareFlowControl_None;\r
 116                 xUART1_Init.UART_Mode = UART_Mode_Tx_Rx;\r
 117                 xUART1_Init.UART_FIFO = UART_FIFO_Enable;\r
 118 \r
 119                 /* Enable the UART1 Clock */\r
 120                 SCU_APBPeriphClockConfig( __UART1, ENABLE );\r
 121                 \r
 122                 /* Enable the GPIO3 Clock */\r
 123                 SCU_APBPeriphClockConfig( __GPIO3, ENABLE );\r
 124                 \r
 125                 /* Configure UART1_Rx pin GPIO3.2 */\r
 126                 GPIO_InitStructure.GPIO_Direction = GPIO_PinInput;\r
 127                 GPIO_InitStructure.GPIO_Pin = GPIO_Pin_2;\r
 128                 GPIO_InitStructure.GPIO_Type = GPIO_Type_PushPull ;\r
 129                 GPIO_InitStructure.GPIO_IPConnected = GPIO_IPConnected_Enable;\r
 130                 GPIO_InitStructure.GPIO_Alternate = GPIO_InputAlt1 ;\r
 131                 GPIO_Init( GPIO3, &GPIO_InitStructure );\r
 132                 \r
 133                 /* Configure UART1_Tx pin GPIO3.3 */\r
 134                 GPIO_InitStructure.GPIO_Direction = GPIO_PinOutput;\r
 135                 GPIO_InitStructure.GPIO_Pin = GPIO_Pin_3;\r
 136                 GPIO_InitStructure.GPIO_Type = GPIO_Type_PushPull ;\r
 137                 GPIO_InitStructure.GPIO_IPConnected = GPIO_IPConnected_Enable;\r
 138                 GPIO_InitStructure.GPIO_Alternate = GPIO_OutputAlt2 ;\r
 139                 GPIO_Init( GPIO3, &GPIO_InitStructure );\r
 140                 \r
 141                 \r
 142                 portENTER_CRITICAL();\r
 143                 {               \r
 144                         /* Configure the UART itself. */\r
 145                         UART_DeInit( UART1 );           \r
 146                         UART_Init( UART1, &xUART1_Init );\r
 147                         UART_ITConfig( UART1, UART_IT_Receive | UART_IT_Transmit, ENABLE );\r
 148                         UART1->ICR = serCLEAR_ALL_INTERRUPTS;\r
 149                         UART_LoopBackConfig( UART1, DISABLE );\r
 150                         UART_IrDACmd( IrDA1, DISABLE );\r
 151 \r
 152                         /* Configure the VIC for the UART interrupts. */                        \r
 153                         VIC_Config( UART1_ITLine, VIC_IRQ, 9 );\r
 154                         VIC_ITCmd( UART1_ITLine, ENABLE );\r
 155 \r
 156                         UART_Cmd( UART1, ENABLE );                      \r
 157                         lTaskWaiting = pdFALSE;\r
 158                 }\r
 159                 portEXIT_CRITICAL();\r
 160         }\r
 161         else\r
 162         {\r
 163                 xReturn = ( xComPortHandle ) 0;\r
 164         }\r
 165 \r
 166         /* This demo file only supports a single port but we have to return\r
 167         something to comply with the standard demo header file. */\r
 168         return xReturn;\r
 169 }\r
 170 /*-----------------------------------------------------------*/\r
 171 \r
 172 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime )\r
 173 {\r
 174         /* The port handle is not required as this driver only supports one port. */\r
 175         ( void ) pxPort;\r
 176 \r
 177         /* Get the next character from the buffer.  Return false if no characters\r
 178         are available, or arrive before xBlockTime expires. */\r
 179         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 180         {\r
 181                 return pdTRUE;\r
 182         }\r
 183         else\r
 184         {\r
 185                 return pdFALSE;\r
 186         }\r
 187 }\r
 188 /*-----------------------------------------------------------*/\r
 189 \r
 190 void vSerialPutString( xComPortHandle pxPort, const signed portCHAR * const pcString, unsigned portSHORT usStringLength )\r
 191 {\r
 192 signed portCHAR *pxNext;\r
 193 \r
 194         /* A couple of parameters that this port does not use. */\r
 195         ( void ) usStringLength;\r
 196         ( void ) pxPort;\r
 197 \r
 198         /* NOTE: This implementation does not handle the queue being full as no\r
 199         block time is used! */\r
 200 \r
 201         /* The port handle is not required as this driver only supports UART1. */\r
 202         ( void ) pxPort;\r
 203 \r
 204         /* Send each character in the string, one at a time. */\r
 205         pxNext = ( signed portCHAR * ) pcString;\r
 206         while( *pxNext )\r
 207         {\r
 208                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 209                 pxNext++;\r
 210         }\r
 211 }\r
 212 /*-----------------------------------------------------------*/\r
 213 \r
 214 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime )\r
 215 {\r
 216 portBASE_TYPE xReturn;\r
 217 \r
 218         portENTER_CRITICAL();\r
 219         {\r
 220                 /* Can we write to the FIFO? */\r
 221                 if( UART1->FR & serTX_FIFO_FULL )\r
 222                 {\r
 223                         /* Wait for the interrupt letting us know there is space on the\r
 224                         FIFO.  It is ok to block in a critical section, interrupts will be\r
 225                         enabled for other tasks once we force a switch. */\r
 226                         lTaskWaiting = pdTRUE;\r
 227                         \r
 228                         /* Just to be a bit different this driver uses a semaphore to\r
 229                         block the sending task when the FIFO is full.  The standard COMTest\r
 230                         task assumes a queue of adequate length exists so does not use\r
 231                         a block time.  For this demo the block time is therefore hard\r
 232                         coded. */\r
 233                         xReturn = xSemaphoreTake( xTxFIFOSemaphore, serTX_BLOCK_TIME );\r
 234                         if( xReturn )\r
 235                         {\r
 236                                 UART1->DR = cOutChar;\r
 237                         }\r
 238                 }\r
 239                 else\r
 240                 {\r
 241                         UART1->DR = cOutChar;\r
 242                         xReturn = pdPASS;\r
 243                 }\r
 244         }\r
 245         portEXIT_CRITICAL();\r
 246 \r
 247         return xReturn;\r
 248 }\r
 249 /*-----------------------------------------------------------*/\r
 250 \r
 251 void vSerialClose( xComPortHandle xPort )\r
 252 {\r
 253         /* Not supported as not required by the demo application. */\r
 254 }\r
 255 /*-----------------------------------------------------------*/\r
 256 \r
 257 void UART1_IRQHandler( void )\r
 258 {\r
 259 signed portCHAR cChar;\r
 260 portBASE_TYPE xTaskWokenByTx = pdFALSE, xTaskWokenByPost = pdFALSE;\r
 261 \r
 262         while( UART1->RIS &     mainRXRIS )\r
 263         {\r
 264                 /* The interrupt was caused by a character being received.  Grab the\r
 265                 character from the DR and place it in the queue of received\r
 266                 characters. */\r
 267                 cChar = UART1->DR;\r
 268                 xTaskWokenByPost = xQueueSendFromISR( xRxedChars, &cChar, xTaskWokenByPost );\r
 269         }       \r
 270         \r
 271         if( UART1->RIS & mainTXRIS )\r
 272         {\r
 273                 if( lTaskWaiting == pdTRUE )\r
 274                 {\r
 275                         /* This interrupt was caused by space becoming available on the Tx\r
 276                         FIFO, wake any task that is waiting to post (if any). */\r
 277                         xTaskWokenByTx = xSemaphoreGiveFromISR( xTxFIFOSemaphore, xTaskWokenByTx );\r
 278                         lTaskWaiting = pdFALSE;\r
 279                 }\r
 280                 \r
 281                 UART1->ICR = mainTXRIS;\r
 282         }\r
 283 \r
 284         /* If a task was woken by either a character being received or a character\r
 285         being transmitted then we may need to switch to another task. */\r
 286         portEND_SWITCHING_ISR( ( xTaskWokenByPost || xTaskWokenByTx ) );\r
 287 }\r
 288 \r
 289 \r
 290 \r
 291 \r
 292 \r
 293         \r