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

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