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

   1 /*\r
   2  * FreeRTOS Kernel V10.3.0\r
   3  * Copyright (C) 2020 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         ***Note*** This example uses queues to send each character into an interrupt\r
  32         service routine and out of an interrupt service routine individually.  This\r
  33         is done to demonstrate queues being used in an interrupt, and to deliberately\r
  34         load the system to test the FreeRTOS port.  It is *NOT* meant to be an\r
  35         example of an efficient implementation.  An efficient implementation should\r
  36         use FIFOs or DMA if available, and only use FreeRTOS API functions when\r
  37         enough has been received to warrant a task being unblocked to process the\r
  38         data.\r
  39 */\r
  40 \r
  41 /* Scheduler includes. */\r
  42 #include "FreeRTOS.h"\r
  43 #include "queue.h"\r
  44 #include "semphr.h"\r
  45 #include "comtest2.h"\r
  46 \r
  47 /* Library includes. */\r
  48 #include "mcu.h"\r
  49 \r
  50 /* Demo application includes. */\r
  51 #include "serial.h"\r
  52 /*-----------------------------------------------------------*/\r
  53 \r
  54 /* Register bit definitions. */\r
  55 #define serRX_INT_ENABLE                0x10\r
  56 #define serTX_INT_ENABLE                0x08\r
  57 #define serRX_ENABLE                    0x02\r
  58 #define serTX_ENABLE                    0x01\r
  59 #define serORE_ERROR_BIT                0x08\r
  60 #define serFRE_ERROR_BIT                0x10\r
  61 #define serPE_ERROR_BIT                 0x20\r
  62 #define serRX_INT                               0x04\r
  63 #define serTX_INT                               0x02\r
  64 \r
  65 /* Misc defines. */\r
  66 #define serINVALID_QUEUE                                ( ( QueueHandle_t ) 0 )\r
  67 #define serNO_BLOCK                                             ( ( TickType_t ) 0 )\r
  68 \r
  69 /*-----------------------------------------------------------*/\r
  70 \r
  71 /* The queue used to hold received characters. */\r
  72 static QueueHandle_t xRxedChars;\r
  73 static QueueHandle_t xCharsForTx;\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         /* Create the queues used to hold Rx/Tx characters. */\r
  83         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
  84         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
  85         \r
  86         /* If the queues were created correctly then setup the serial port\r
  87         hardware. */\r
  88         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
  89         {\r
  90                 /* Ensure interrupts don't fire during the init process.  Interrupts\r
  91                 will be enabled automatically when the first task start running. */\r
  92                 portDISABLE_INTERRUPTS();\r
  93                 \r
  94                 /* Configure P21 and P22 for use by the UART. */\r
  95                 FM3_GPIO->PFR2 |= ( 1 << 0x01 ) | ( 1 << 0x02 );\r
  96                 \r
  97                 /* SIN0_0 and SOT0_0. */\r
  98                 FM3_GPIO->EPFR07 |= ( 1 << 6 );\r
  99                 \r
 100                 /* Reset. */\r
 101                 FM3_MFS0_UART->SCR = 0x80;\r
 102                 \r
 103                 /* Enable output in mode 0. */\r
 104                 FM3_MFS0_UART->SMR = 0x01;\r
 105                 \r
 106                 /* Clear all errors that may already be present. */\r
 107                 FM3_MFS0_UART->SSR = 0x00;\r
 108                 FM3_MFS0_UART->ESCR = 0x00;\r
 109                 \r
 110                 FM3_MFS0_UART->BGR = ( configCPU_CLOCK_HZ / 2UL ) / ( ulWantedBaud - 1UL );\r
 111 \r
 112                 /* Enable Rx, Tx, and the Rx interrupt. */              \r
 113                 FM3_MFS0_UART->SCR |= ( serRX_ENABLE | serTX_ENABLE | serRX_INT_ENABLE );\r
 114                 \r
 115                 /* Configure the NVIC for UART interrupts. */\r
 116                 NVIC_ClearPendingIRQ( MFS0RX_IRQn );\r
 117                 NVIC_EnableIRQ( MFS0RX_IRQn );\r
 118                 \r
 119                 /* The priority *MUST* be at or below\r
 120                 configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY as FreeRTOS API functions\r
 121                 are called in the interrupt handler. */\r
 122                 NVIC_SetPriority( MFS0RX_IRQn, configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY );\r
 123                 \r
 124                 /* Do the same for the Tx interrupts. */\r
 125                 NVIC_ClearPendingIRQ( MFS0TX_IRQn );\r
 126                 NVIC_EnableIRQ( MFS0TX_IRQn );\r
 127                 \r
 128                 /* The priority *MUST* be at or below\r
 129                 configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY as FreeRTOS API functions\r
 130                 are called in the interrupt handler. */\r
 131                 NVIC_SetPriority( MFS0TX_IRQn, configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY );\r
 132         }\r
 133 \r
 134         /* This demo file only supports a single port but we have to return\r
 135         something to comply with the standard demo header file. */\r
 136         return ( xComPortHandle ) 0;\r
 137 }\r
 138 /*-----------------------------------------------------------*/\r
 139 \r
 140 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, TickType_t xBlockTime )\r
 141 {\r
 142         /* The port handle is not required as this driver only supports one port. */\r
 143         ( void ) pxPort;\r
 144 \r
 145         /* Get the next character from the buffer.  Return false if no characters\r
 146         are available, or arrive before xBlockTime expires. */\r
 147         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 148         {\r
 149                 return pdTRUE;\r
 150         }\r
 151         else\r
 152         {\r
 153                 return pdFALSE;\r
 154         }\r
 155 }\r
 156 /*-----------------------------------------------------------*/\r
 157 \r
 158 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 159 {\r
 160 signed char *pxNext;\r
 161 \r
 162         /* A couple of parameters that this port does not use. */\r
 163         ( void ) usStringLength;\r
 164         ( void ) pxPort;\r
 165 \r
 166         /* NOTE: This implementation does not handle the queue being full as no\r
 167         block time is used! */\r
 168 \r
 169         /* The port handle is not required as this driver only supports one UART. */\r
 170         ( void ) pxPort;\r
 171 \r
 172         /* Send each character in the string, one at a time. */\r
 173         pxNext = ( signed char * ) pcString;\r
 174         while( *pxNext )\r
 175         {\r
 176                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 177                 pxNext++;\r
 178         }\r
 179 }\r
 180 /*-----------------------------------------------------------*/\r
 181 \r
 182 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, TickType_t xBlockTime )\r
 183 {\r
 184 signed portBASE_TYPE xReturn;\r
 185 \r
 186         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) == pdPASS )\r
 187         {\r
 188                 xReturn = pdPASS;\r
 189                 \r
 190                 /* Enable the UART Tx interrupt. */\r
 191                 FM3_MFS0_UART->SCR |= serTX_INT_ENABLE;\r
 192         }\r
 193         else\r
 194         {\r
 195                 xReturn = pdFAIL;\r
 196         }\r
 197 \r
 198         return xReturn;\r
 199 }\r
 200 /*-----------------------------------------------------------*/\r
 201 \r
 202 void vSerialClose( xComPortHandle xPort )\r
 203 {\r
 204         /* Not supported as not required by the demo application. */\r
 205 }\r
 206 /*-----------------------------------------------------------*/\r
 207 \r
 208 void MFS0RX_IRQHandler( void )\r
 209 {\r
 210 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 211 char cChar;\r
 212 \r
 213         if( ( FM3_MFS0_UART->SSR & ( serORE_ERROR_BIT | serFRE_ERROR_BIT | serPE_ERROR_BIT ) ) != 0 )\r
 214         {\r
 215                 /* A PE, ORE or FRE error occurred.  Clear it. */\r
 216                 FM3_MFS0_UART->SSR |= ( 1 << 7 );\r
 217                 cChar = FM3_MFS0_UART->RDR;\r
 218         }\r
 219         else if( FM3_MFS0_UART->SSR & serRX_INT )\r
 220         {\r
 221                 /* A character has been received on the USART, send it to the Rx\r
 222                 handler task. */\r
 223                 cChar = FM3_MFS0_UART->RDR;\r
 224                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 225         }       \r
 226 \r
 227         /* If sending or receiving from a queue has caused a task to unblock, and\r
 228         the unblocked task has a priority equal to or higher than the currently\r
 229         running task (the task this ISR interrupted), then xHigherPriorityTaskWoken\r
 230         will have automatically been set to pdTRUE within the queue send or receive\r
 231         function.  portEND_SWITCHING_ISR() will then ensure that this ISR returns\r
 232         directly to the higher priority unblocked task. */\r
 233         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 234 }\r
 235 /*-----------------------------------------------------------*/\r
 236 \r
 237 void MFS0TX_IRQHandler( void )\r
 238 {\r
 239 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 240 char cChar;\r
 241 \r
 242         if( FM3_MFS0_UART->SSR & serTX_INT )\r
 243         {\r
 244                 /* The interrupt was caused by the TX register becoming empty.  Are\r
 245                 there any more characters to transmit? */\r
 246                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 247                 {\r
 248                         /* A character was retrieved from the queue so can be sent to the\r
 249                         USART now. */\r
 250                         FM3_MFS0_UART->TDR = cChar;\r
 251                 }\r
 252                 else\r
 253                 {\r
 254                         /* Disable the Tx interrupt. */\r
 255                         FM3_MFS0_UART->SCR &= ~serTX_INT_ENABLE;\r
 256                 }               \r
 257         }       \r
 258 \r
 259         /* If sending or receiving from a queue has caused a task to unblock, and\r
 260         the unblocked task has a priority equal to or higher than the currently\r
 261         running task (the task this ISR interrupted), then xHigherPriorityTaskWoken\r
 262         will have automatically been set to pdTRUE within the queue send or receive\r
 263         function.  portEND_SWITCHING_ISR() will then ensure that this ISR returns\r
 264         directly to the higher priority unblocked task. */\r
 265         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 266 }\r
 267 \r
 268 \r
 269 \r
 270 \r
 271 \r
 272         \r