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

   1 /*\r
   2  * FreeRTOS Kernel V10.0.0\r
   3  * Copyright (C) 2017 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. If you wish to use our Amazon\r
  14  * FreeRTOS name, please do so in a fair use way that does not cause confusion.\r
  15  *\r
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  18  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  19  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  20  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  22  *\r
  23  * http://www.FreeRTOS.org\r
  24  * http://aws.amazon.com/freertos\r
  25  *\r
  26  * 1 tab == 4 spaces!\r
  27  */\r
  28 \r
  29 /* \r
  30         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0. \r
  31 */\r
  32 \r
  33 /* Standard includes. */ \r
  34 #include <stdlib.h>\r
  35 \r
  36 /* Scheduler includes. */\r
  37 #include "FreeRTOS.h"\r
  38 #include "queue.h"\r
  39 \r
  40 /* Demo application includes. */\r
  41 #include "serial.h"\r
  42 \r
  43 /*-----------------------------------------------------------*/\r
  44 \r
  45 /* Location of the COM0 registers. */\r
  46 #define serCOM0                                                 ( ( AT91PS_USART ) AT91C_BASE_US0 )\r
  47 \r
  48 /* Interrupt control macros. */\r
  49 #define serINTERRUPT_LEVEL                              ( 5 )\r
  50 #define vInterruptOn()                                  AT91F_US_EnableIt( serCOM0, AT91C_US_TXRDY | AT91C_US_RXRDY )\r
  51 #define vInterruptOff()                                 AT91F_US_DisableIt( serCOM0, AT91C_US_TXRDY )\r
  52 \r
  53 /* Misc constants. */\r
  54 #define serINVALID_QUEUE                                ( ( QueueHandle_t ) 0 )\r
  55 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
  56 #define serNO_BLOCK                                             ( ( TickType_t ) 0 )\r
  57 #define serNO_TIMEGUARD                                 ( ( unsigned long ) 0 )\r
  58 #define serNO_PERIPHERAL_B_SETUP                ( ( unsigned long ) 0 )\r
  59 \r
  60 \r
  61 /* Queues used to hold received characters, and characters waiting to be\r
  62 transmitted. */\r
  63 static QueueHandle_t xRxedChars; \r
  64 static QueueHandle_t xCharsForTx; \r
  65 \r
  66 /*-----------------------------------------------------------*/\r
  67 \r
  68 /* Interrupt entry point written in the assembler file serialISR.s79. */\r
  69 extern void vSerialISREntry( void );\r
  70 \r
  71 /* The interrupt service routine - called from the assembly entry point. */\r
  72 __arm void vSerialISR( void );\r
  73 \r
  74 /*-----------------------------------------------------------*/\r
  75 \r
  76 /*\r
  77  * See the serial2.h header file.\r
  78  */\r
  79 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
  80 {\r
  81 xComPortHandle xReturn = serHANDLE;\r
  82 extern void ( vUART_ISR )( void );\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                 portENTER_CRITICAL();\r
  93                 {\r
  94                         /* Enable the USART clock. */\r
  95                         AT91F_PMC_EnablePeriphClock( AT91C_BASE_PMC, 1 << AT91C_ID_US0 );\r
  96 \r
  97                         AT91F_PIO_CfgPeriph( AT91C_BASE_PIOA, ( ( unsigned long ) AT91C_PA5_RXD0 ) | ( ( unsigned long ) AT91C_PA6_TXD0 ), serNO_PERIPHERAL_B_SETUP );\r
  98 \r
  99                         /* Set the required protocol. */\r
 100                         AT91F_US_Configure( serCOM0, configCPU_CLOCK_HZ, AT91C_US_ASYNC_MODE, ulWantedBaud, serNO_TIMEGUARD );\r
 101 \r
 102                         /* Enable Rx and Tx. */\r
 103                         serCOM0->US_CR = AT91C_US_RXEN | AT91C_US_TXEN;\r
 104 \r
 105                         /* Enable the Rx interrupts.  The Tx interrupts are not enabled\r
 106                         until there are characters to be transmitted. */\r
 107                 AT91F_US_EnableIt( serCOM0, AT91C_US_RXRDY );\r
 108 \r
 109                         /* Enable the interrupts in the AIC. */\r
 110                         AT91F_AIC_ConfigureIt( AT91C_BASE_AIC, AT91C_ID_US0, serINTERRUPT_LEVEL, AT91C_AIC_SRCTYPE_INT_LEVEL_SENSITIVE, ( void (*)( void ) ) vSerialISREntry );\r
 111                         AT91F_AIC_EnableIt( AT91C_BASE_AIC, AT91C_ID_US0 );\r
 112                 }\r
 113                 portEXIT_CRITICAL();\r
 114         }\r
 115         else\r
 116         {\r
 117                 xReturn = ( xComPortHandle ) 0;\r
 118         }\r
 119 \r
 120         /* This demo file only supports a single port but we have to return \r
 121         something to comply with the standard demo header file. */\r
 122         return xReturn;\r
 123 }\r
 124 /*-----------------------------------------------------------*/\r
 125 \r
 126 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, TickType_t xBlockTime )\r
 127 {\r
 128         /* The port handle is not required as this driver only supports one port. */\r
 129         ( void ) pxPort;\r
 130 \r
 131         /* Get the next character from the buffer.  Return false if no characters\r
 132         are available, or arrive before xBlockTime expires. */\r
 133         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 134         {\r
 135                 return pdTRUE;\r
 136         }\r
 137         else\r
 138         {\r
 139                 return pdFALSE;\r
 140         }\r
 141 }\r
 142 /*-----------------------------------------------------------*/\r
 143 \r
 144 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 145 {\r
 146 signed char *pxNext;\r
 147 \r
 148         /* A couple of parameters that this port does not use. */\r
 149         ( void ) usStringLength;\r
 150         ( void ) pxPort;\r
 151 \r
 152         /* NOTE: This implementation does not handle the queue being full as no\r
 153         block time is used! */\r
 154 \r
 155         /* The port handle is not required as this driver only supports UART0. */\r
 156         ( void ) pxPort;\r
 157 \r
 158         /* Send each character in the string, one at a time. */\r
 159         pxNext = ( signed char * ) pcString;\r
 160         while( *pxNext )\r
 161         {\r
 162                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 163                 pxNext++;\r
 164         }\r
 165 }\r
 166 /*-----------------------------------------------------------*/\r
 167 \r
 168 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, TickType_t xBlockTime )\r
 169 {\r
 170         /* Place the character in the queue of characters to be transmitted. */\r
 171         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 172         {\r
 173                 return pdFAIL;\r
 174         }\r
 175 \r
 176         /* Turn on the Tx interrupt so the ISR will remove the character from the\r
 177         queue and send it.   This does not need to be in a critical section as\r
 178         if the interrupt has already removed the character the next interrupt\r
 179         will simply turn off the Tx interrupt again. */\r
 180         vInterruptOn();\r
 181 \r
 182         return pdPASS;\r
 183 }\r
 184 /*-----------------------------------------------------------*/\r
 185 \r
 186 void vSerialClose( xComPortHandle xPort )\r
 187 {\r
 188         /* Not supported as not required by the demo application. */\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