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