git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_R4_RM48_TMS570_CCS5/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*** \r
  32         The implementation provided in this file is intended to demonstrate using\r
  33         queues to pass data into and out of interrupts, and to demonstrate context \r
  34         switching from inside an interrupt service routine.  It is *not* intended to \r
  35         represent an efficient implementation.  Real implementations should not pass \r
  36         individual characters on queues, but instead use RAM buffers, DMA and/or \r
  37         FIFO features as appropriate.  Semaphores can be used to signal a task that \r
  38         data is available to be processed.\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 \r
  46 /* Demo application includes. */\r
  47 #include "serial.h"\r
  48 \r
  49 /*-----------------------------------------------------------*/\r
  50 \r
  51 /* Registers required to configure the SCI. */\r
  52 #define serialSCI_GCR0_REG              ( * ( ( volatile unsigned long * ) 0xFFF7E400 ) )\r
  53 #define serialSCI_GCR1_REG              ( * ( ( volatile unsigned long * ) 0xFFF7E404 ) )\r
  54 #define serialSCI_GCR2_REG              ( * ( ( volatile unsigned long * ) 0xFFF7E408 ) )\r
  55 #define serialSCI_SETINT_REG            ( * ( ( volatile unsigned long * ) 0xFFF7E40C ) )\r
  56 #define serialSCI_CLRINT_REG            ( * ( ( volatile unsigned long * ) 0xFFF7E410 ) )\r
  57 #define serialSCI_SETINTLVL_REG         ( * ( ( volatile unsigned long * ) 0xFFF7E414 ) )\r
  58 #define serialSCI_CLRINTLVL_REG         ( * ( ( volatile unsigned long * ) 0xFFF7E418 ) )\r
  59 #define serialSCI_FLR_REG               ( * ( ( volatile unsigned long * ) 0xFFF7E41C ) )\r
  60 #define serialSCI_INTVEC0_REG           ( * ( ( volatile unsigned long * ) 0xFFF7E420 ) )\r
  61 #define serialSCI_INTVEC1_REG           ( * ( ( volatile unsigned long * ) 0xFFF7E424 ) )\r
  62 #define serialSCI_LENGTH_REG            ( * ( ( volatile unsigned long * ) 0xFFF7E428 ) )\r
  63 #define serialSCI_BAUD_REG              ( * ( ( volatile unsigned long * ) 0xFFF7E42C ) )\r
  64 #define serialSCI_RD_REG                ( * ( ( volatile unsigned long * ) 0xFFF7E434 ) )\r
  65 #define serialSCI_TD_REG                ( * ( ( volatile unsigned long * ) 0xFFF7E438 ) )\r
  66 #define serialSCI_FUN_REG               ( * ( ( volatile unsigned long * ) 0xFFF7E43C ) )\r
  67 #define serialSCI_DIR_REG               ( * ( ( volatile unsigned long * ) 0xFFF7E440 ) )\r
  68 #define serialSCI_DIN_REG               ( * ( ( volatile unsigned long * ) 0xFFF7E444 ) )\r
  69 #define serialSCI_DOUT_REG              ( * ( ( volatile unsigned long * ) 0xFFF7E448 ) )\r
  70 #define serialSCI_DSET_REG              ( * ( ( volatile unsigned long * ) 0xFFF7E44C ) )\r
  71 #define serialSCI_DCLR_REG              ( * ( ( volatile unsigned long * ) 0xFFF7E450 ) )\r
  72 \r
  73 /* SCI constants */\r
  74 #define serialSCI_FE_INT    ( 0x04000000 )  /* framming error */\r
  75 #define serialSCI_OE_INT    ( 0x02000000 )  /* overrun error */\r
  76 #define serialSCI_PE_INT    ( 0x01000000 )  /* parity error */\r
  77 #define serialSCI_RX_INT    ( 0x00000200 )  /* receive buffer ready */\r
  78 #define serialSCI_TX_INT    ( 0x00000100 )  /* transmit buffer ready */\r
  79 #define serialSCI_WAKE_INT  ( 0x00000002 )  /* wakeup */\r
  80 #define serialSCI_BREAK_INT ( 0x00000001 )  /* break detect */\r
  81 #define serialSCI_IDLE_FLG  ( 0x00000004 )  /* IDLE flasg */\r
  82 \r
  83 /* Registers required to configure the VIM. */\r
  84 #define serialVIM_REQMASKSET0_REG       ( * ( ( volatile unsigned long * ) 0xFFFFFE30 ) )\r
  85 #define serialVIM_SCIHINT_RAM       ( * ( ( void (**)(void) ) 0xFFF82038 ) )\r
  86 \r
  87 /* Baudrate */\r
  88 #define serialBAURATE           19200.0                 /* Baudrate in Hz */\r
  89 \r
  90 /*-----------------------------------------------------------*/\r
  91 \r
  92 /* Misc defines. */\r
  93 #define serINVALID_QUEUE                                ( ( QueueHandle_t ) 0 )\r
  94 #define serNO_BLOCK                                             ( ( TickType_t ) 0 )\r
  95 #define serTX_BLOCK_TIME                                ( 40 / portTICK_PERIOD_MS )\r
  96 \r
  97 /*-----------------------------------------------------------*/\r
  98 \r
  99 /* The queue used to hold received characters. */\r
 100 static QueueHandle_t xRxedChars = NULL;\r
 101 static QueueHandle_t xCharsForTx = NULL;\r
 102 \r
 103 /*-----------------------------------------------------------*/\r
 104 \r
 105 /* UART interrupt handler. */\r
 106 __interrupt void vSCIInterruptHandler( void );\r
 107 \r
 108 /*-----------------------------------------------------------*/\r
 109 \r
 110 /*\r
 111  * See the serial2.h header file.\r
 112  */\r
 113 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 114 {\r
 115 xComPortHandle xReturn = ( xComPortHandle ) 0;\r
 116 \r
 117         /* unused parameters, demo has a fixed baud rate (19200) */\r
 118         ( void ) ulWantedBaud;\r
 119 \r
 120         /* Create the queues used to hold Rx/Tx characters. */\r
 121         xRxedChars  = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 122         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 123         \r
 124         /* If the queue/semaphore was created correctly then setup the serial port\r
 125         hardware. */\r
 126         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 127         {\r
 128                 /* Initalise SCI1 */\r
 129             /* Bring SCI out of reset */\r
 130                 serialSCI_GCR0_REG = 0x00000001UL;\r
 131             /* Disable all interrupts */\r
 132                 serialSCI_CLRINT_REG = 0xFFFFFFFFUL;\r
 133                 /* All Interrupt to SCI High Level */\r
 134                 serialSCI_CLRINTLVL_REG = 0xFFFFFFFFUL;\r
 135             /* Global control 1 */\r
 136                 serialSCI_GCR1_REG = 0x03010032UL;\r
 137             /* Baudrate */\r
 138                 serialSCI_BAUD_REG = ((unsigned long)((configCPU_CLOCK_HZ / (16.0 * serialBAURATE) + 0.5)) - 1) & 0x00FFFFFF;\r
 139             /* Transmission length (8-bit) */\r
 140                 serialSCI_LENGTH_REG = 8 - 1;\r
 141             /* Set SCI pins functional mode */\r
 142                 serialSCI_FUN_REG = 0x00000006UL;\r
 143             /* Enable RX interrupt */\r
 144             serialSCI_SETINT_REG = 0x00000200UL;\r
 145             /* Finally start SCI1 */\r
 146             serialSCI_GCR1_REG |= 0x00000080UL;\r
 147 \r
 148                 /* Setup interrupt routine address in VIM table */\r
 149             serialVIM_SCIHINT_RAM = &vSCIInterruptHandler;\r
 150                 /* Enable SCI interrupt in VIM */\r
 151             serialVIM_REQMASKSET0_REG = 0x00002000UL;\r
 152         }\r
 153 \r
 154         /* This demo file only supports a single port but we have to return\r
 155         something to comply with the standard demo header file. */\r
 156         return xReturn;\r
 157 }\r
 158 /*-----------------------------------------------------------*/\r
 159 \r
 160 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, TickType_t xBlockTime )\r
 161 {\r
 162         /* The port handle is not required as this driver only supports one port. */\r
 163         ( void ) pxPort;\r
 164 \r
 165         /* Get the next character from the buffer.  Return false if no characters\r
 166         are available, or arrive before xBlockTime expires. */\r
 167         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 168         {\r
 169                 return pdTRUE;\r
 170         }\r
 171         else\r
 172         {\r
 173                 return pdFALSE;\r
 174         }\r
 175 }\r
 176 /*-----------------------------------------------------------*/\r
 177 \r
 178 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 179 {\r
 180 signed char *pxNext;\r
 181 \r
 182         /* A couple of parameters that this port does not use. */\r
 183         ( void ) usStringLength;\r
 184 \r
 185         /* NOTE: This implementation does not handle the queue being full as no\r
 186         block time is used! */\r
 187 \r
 188         /* Send each character in the string, one at a time. */\r
 189         pxNext = ( signed char * ) pcString;\r
 190         while( *pxNext )\r
 191         {\r
 192                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 193                 pxNext++;\r
 194         }\r
 195 }\r
 196 /*-----------------------------------------------------------*/\r
 197 \r
 198 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, TickType_t xBlockTime )\r
 199 {\r
 200 signed portBASE_TYPE xReturn;\r
 201 \r
 202         /* check if we are already transmitting */\r
 203         if ( (serialSCI_SETINT_REG & serialSCI_TX_INT) == 0)\r
 204         {\r
 205                 /* First byte */\r
 206 \r
 207                 /* Wait until IDLE idle period is finished */\r
 208                 while ( (serialSCI_FLR_REG & serialSCI_IDLE_FLG) != 0 ) \r
 209                 { \r
 210                         /* wait */ \r
 211                 };\r
 212                 \r
 213                 /* Need to send first byte before interrupts flags are set. */\r
 214                 serialSCI_TD_REG = cOutChar;\r
 215                 \r
 216                 /* Enable the TX interrupt. */\r
 217                 serialSCI_SETINT_REG = serialSCI_TX_INT;\r
 218 \r
 219                 xReturn = pdPASS;\r
 220         }\r
 221         else if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) == pdPASS )\r
 222         {\r
 223                 xReturn = pdPASS;\r
 224         }\r
 225         else\r
 226         {\r
 227                 xReturn = pdFAIL;\r
 228         }\r
 229 \r
 230         return xReturn;\r
 231 }\r
 232 /*-----------------------------------------------------------*/\r
 233 \r
 234 void vSerialClose( xComPortHandle xPort )\r
 235 {\r
 236         /* Not supported as not required by the demo application. */\r
 237 }\r
 238 /*-----------------------------------------------------------*/\r
 239 \r
 240 __interrupt void vSCIInterruptHandler( void )\r
 241 {\r
 242 /* xHigherPriorityTaskWoken must be initialised to pdFALSE. */\r
 243 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 244 char cChar;\r
 245 portBASE_TYPE xVectorValue = serialSCI_INTVEC0_REG;\r
 246 \r
 247         switch( xVectorValue )\r
 248         {\r
 249                 case 11:\r
 250                         /* Receive buffer full interrupt, send received char to queue */\r
 251                         cChar = serialSCI_RD_REG;\r
 252                         xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 253                         break;\r
 254 \r
 255                 case 12:\r
 256                         /* Transmit buffer empty interrupt received */\r
 257                         /* Are there any more characters to transmit? */\r
 258                         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 259                         {\r
 260                                 /* A character was retrieved from the queue so can be sent to\r
 261                                 the TD now. */\r
 262                                 serialSCI_TD_REG = cChar;\r
 263                         }\r
 264                         else\r
 265                         {\r
 266                                 /* no more bytes, clear the TX interrupt */\r
 267                                 serialSCI_CLRINT_REG = serialSCI_TX_INT;\r
 268                         }\r
 269                         break;\r
 270 \r
 271                 default:\r
 272                         /* unused interrupt, clear flags */\r
 273                         serialSCI_FLR_REG = 0x07000003;\r
 274         }\r
 275 \r
 276         /* If calling xQueueSendFromISR() above caused a task to leave the blocked\r
 277         state, and the task that left the blocked state has a priority above the\r
 278         task that this interrupt interrupted, then xHighPriorityTaskWoken will have\r
 279         been set to pdTRUE.  If xHigherPriorityTaskWoken equals true then calling\r
 280         portYIELD_FROM_ISR() will result in this interrupt returning directly to the\r
 281         unblocked task. */\r
 282         portYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
 283 }\r
 284 \r
 285 \r
 286 \r
 287 \r
 288 \r
 289         \r