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

   1 /*\r
   2  * FreeRTOS Kernel V10.1.0\r
   3  * Copyright (C) 2018 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software.\r
  14  *\r
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  21  *\r
  22  * http://www.FreeRTOS.org\r
  23  * http://aws.amazon.com/freertos\r
  24  *\r
  25  * 1 tab == 4 spaces!\r
  26  */\r
  27 \r
  28 /*\r
  29         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0.\r
  30 */\r
  31 \r
  32 /* Standard includes. */\r
  33 #include <stdlib.h>\r
  34 \r
  35 /* Scheduler includes. */\r
  36 #include "FreeRTOS.h"\r
  37 #include "queue.h"\r
  38 \r
  39 /* Demo application includes. */\r
  40 #include "serial.h"\r
  41 \r
  42 /* Atmel library includes. */\r
  43 #include <usart/usart.h>\r
  44 #include <aic/aic.h>\r
  45 #include <pmc/pmc.h>\r
  46 \r
  47 /*-----------------------------------------------------------*/\r
  48 \r
  49 /* Location of the COM0 registers. */\r
  50 #define serCOM0                                                 ( ( AT91PS_USART ) AT91C_BASE_US0 )\r
  51 \r
  52 /* Interrupt control macros. */\r
  53 #define serINTERRUPT_LEVEL                              ( 5 )\r
  54 #define vInterruptOn()                                  serCOM0->US_IER = ( AT91C_US_TXRDY | AT91C_US_RXRDY )\r
  55 #define vInterruptOff()                                 serCOM0->US_IDR = AT91C_US_TXRDY\r
  56 \r
  57 /* Misc constants. */\r
  58 #define serINVALID_QUEUE                                ( ( QueueHandle_t ) 0 )\r
  59 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
  60 #define serNO_BLOCK                                             ( ( TickType_t ) 0 )\r
  61 #define serNO_TIMEGUARD                                 ( ( unsigned long ) 0 )\r
  62 #define serNO_PERIPHERAL_B_SETUP                ( ( unsigned long ) 0 )\r
  63 \r
  64 \r
  65 /* Queues used to hold received characters, and characters waiting to be\r
  66 transmitted. */\r
  67 static QueueHandle_t xRxedChars;\r
  68 static QueueHandle_t xCharsForTx;\r
  69 \r
  70 /*-----------------------------------------------------------*/\r
  71 \r
  72 /* The interrupt service routine. */\r
  73 __arm void vSerialISR( void );\r
  74 \r
  75 /*-----------------------------------------------------------*/\r
  76 \r
  77 /*\r
  78  * See the serial2.h header file.\r
  79  */\r
  80 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
  81 {\r
  82 xComPortHandle xReturn = serHANDLE;\r
  83 \r
  84         /* Create the queues used to hold Rx and Tx characters. */\r
  85         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
  86         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
  87 \r
  88         /* If the queues were created correctly then setup the serial port\r
  89         hardware. */\r
  90         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
  91         {\r
  92                 PMC_EnablePeripheral( AT91C_ID_US0 );   \r
  93                 portENTER_CRITICAL();\r
  94                 {\r
  95                         USART_Configure( serCOM0, ( AT91C_US_CHRL_8_BITS | AT91C_US_PAR_NONE ), ulWantedBaud, configCPU_CLOCK_HZ );\r
  96 \r
  97                         /* Enable Rx and Tx. */\r
  98                         USART_SetTransmitterEnabled( serCOM0, pdTRUE );\r
  99                         USART_SetReceiverEnabled( serCOM0, pdTRUE );\r
 100 \r
 101                         /* Enable the Rx interrupts.  The Tx interrupts are not enabled\r
 102                         until there are characters to be transmitted. */\r
 103                         serCOM0->US_IER = AT91C_US_RXRDY;\r
 104 \r
 105                         /* Enable the interrupts in the AIC. */\r
 106                         AIC_ConfigureIT( AT91C_ID_US0, AT91C_AIC_PRIOR_LOWEST, ( void (*)( void ) ) vSerialISR );\r
 107                         AIC_EnableIT( AT91C_ID_US0 );\r
 108                 }\r
 109                 portEXIT_CRITICAL();\r
 110         }\r
 111         else\r
 112         {\r
 113                 xReturn = ( xComPortHandle ) 0;\r
 114         }\r
 115 \r
 116         /* This demo file only supports a single port but we have to return\r
 117         something to comply with the standard demo header file. */\r
 118         return xReturn;\r
 119 }\r
 120 /*-----------------------------------------------------------*/\r
 121 \r
 122 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, TickType_t xBlockTime )\r
 123 {\r
 124         /* The port handle is not required as this driver only supports one port. */\r
 125         ( void ) pxPort;\r
 126 \r
 127         /* Get the next character from the buffer.  Return false if no characters\r
 128         are available, or arrive before xBlockTime expires. */\r
 129         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 130         {\r
 131                 return pdTRUE;\r
 132         }\r
 133         else\r
 134         {\r
 135                 return pdFALSE;\r
 136         }\r
 137 }\r
 138 /*-----------------------------------------------------------*/\r
 139 \r
 140 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 141 {\r
 142 signed char *pxNext;\r
 143 \r
 144         /* A couple of parameters that this port does not use. */\r
 145         ( void ) usStringLength;\r
 146         ( void ) pxPort;\r
 147 \r
 148         /* NOTE: This implementation does not handle the queue being full as no\r
 149         block time is used! */\r
 150 \r
 151         /* The port handle is not required as this driver only supports UART0. */\r
 152         ( void ) pxPort;\r
 153 \r
 154         /* Send each character in the string, one at a time. */\r
 155         pxNext = ( signed char * ) pcString;\r
 156         while( *pxNext )\r
 157         {\r
 158                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 159                 pxNext++;\r
 160         }\r
 161 }\r
 162 /*-----------------------------------------------------------*/\r
 163 \r
 164 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, TickType_t xBlockTime )\r
 165 {\r
 166         /* Just to remove compiler warning. */\r
 167         ( void ) pxPort;\r
 168         \r
 169         /* Place the character in the queue of characters to be transmitted. */\r
 170         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 171         {\r
 172                 return pdFAIL;\r
 173         }\r
 174 \r
 175         /* Turn on the Tx interrupt so the ISR will remove the character from the\r
 176         queue and send it.   This does not need to be in a critical section as\r
 177         if the interrupt has already removed the character the next interrupt\r
 178         will simply turn off the Tx interrupt again. */\r
 179         vInterruptOn();\r
 180 \r
 181         return pdPASS;\r
 182 }\r
 183 /*-----------------------------------------------------------*/\r
 184 \r
 185 void vSerialClose( xComPortHandle xPort )\r
 186 {\r
 187         /* Not supported as not required by the demo application. */\r
 188         ( void ) xPort;\r
 189 }\r
 190 /*-----------------------------------------------------------*/\r
 191 \r
 192 /* Serial port ISR.  This can cause a context switch so is not defined as a\r
 193 standard ISR using the __irq keyword.  Instead a wrapper function is defined\r
 194 within serialISR.s79 which in turn calls this function.  See the port\r
 195 documentation on the FreeRTOS.org website for more information. */\r
 196 __arm void vSerialISR( void )\r
 197 {\r
 198 unsigned long ulStatus;\r
 199 signed char cChar;\r
 200 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 201 \r
 202         /* What caused the interrupt? */\r
 203         ulStatus = serCOM0->US_CSR &= serCOM0->US_IMR;\r
 204 \r
 205         if( ulStatus & AT91C_US_TXRDY )\r
 206         {\r
 207                 /* The interrupt was caused by the THR becoming empty.  Are there any\r
 208                 more characters to transmit? */\r
 209                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 210                 {\r
 211                         /* A character was retrieved from the queue so can be sent to the\r
 212                         THR now. */\r
 213                         serCOM0->US_THR = cChar;\r
 214                 }\r
 215                 else\r
 216                 {\r
 217                         /* Queue empty, nothing to send so turn off the Tx interrupt. */\r
 218                         vInterruptOff();\r
 219                 }               \r
 220         }\r
 221 \r
 222         if( ulStatus & AT91C_US_RXRDY )\r
 223         {\r
 224                 /* The interrupt was caused by a character being received.  Grab the\r
 225                 character from the RHR and place it in the queue or received\r
 226                 characters. */\r
 227                 cChar = serCOM0->US_RHR;\r
 228                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 229         }\r
 230 \r
 231         /* If a task was woken by either a character being received or a character\r
 232         being transmitted then we may need to switch to another task. */\r
 233         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 234 \r
 235         /* End the interrupt in the AIC. */\r
 236         AT91C_BASE_AIC->AIC_EOICR = 0;\r
 237 }\r
 238 \r
 239 \r
 240 \r
 241 \r
 242         \r