git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_SmartFusion2_M2S050_SoftConsole/RTOSDemo/Full-Demo/UARTCommandConsole.c

   1 /*\r
   2     FreeRTOS V7.1.0 - Copyright (C) 2011 Real Time Engineers Ltd.\r
   3 \r
   4 \r
   5     ***************************************************************************\r
   6      *                                                                       *\r
   7      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
   8      *    Complete, revised, and edited pdf reference manuals are also       *\r
   9      *    available.                                                         *\r
  10      *                                                                       *\r
  11      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  12      *    ensuring you get running as quickly as possible and with an        *\r
  13      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  14      *    the FreeRTOS project to continue with its mission of providing     *\r
  15      *    professional grade, cross platform, de facto standard solutions    *\r
  16      *    for microcontrollers - completely free of charge!                  *\r
  17      *                                                                       *\r
  18      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  19      *                                                                       *\r
  20      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  21      *                                                                       *\r
  22     ***************************************************************************\r
  23 \r
  24 \r
  25     This file is part of the FreeRTOS distribution.\r
  26 \r
  27     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  28     the terms of the GNU General Public License (version 2) as published by the\r
  29     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  30     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  31     distribute a combined work that includes FreeRTOS without being obliged to\r
  32     provide the source code for proprietary components outside of the FreeRTOS\r
  33     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  34     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  35     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  36     more details. You should have received a copy of the GNU General Public\r
  37     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  38     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  39     by writing to Richard Barry, contact details for whom are available on the\r
  40     FreeRTOS WEB site.\r
  41 \r
  42     1 tab == 4 spaces!\r
  43 \r
  44     http://www.FreeRTOS.org - Documentation, latest information, license and\r
  45     contact details.\r
  46 \r
  47     http://www.SafeRTOS.com - A version that is certified for use in safety\r
  48     critical systems.\r
  49 \r
  50     http://www.OpenRTOS.com - Commercial support, development, porting,\r
  51     licensing and training services.\r
  52 */\r
  53 \r
  54 /* Standard includes. */\r
  55 #include "string.h"\r
  56 #include "stdio.h"\r
  57 \r
  58 /* FreeRTOS includes. */\r
  59 #include "FreeRTOS.h"\r
  60 #include "task.h"\r
  61 #include "queue.h"\r
  62 \r
  63 /* Driver includes. */\r
  64 #include "drivers/mss_uart/mss_uart.h"\r
  65 \r
  66 /* Example includes. */\r
  67 #include "FreeRTOS_CLI.h"\r
  68 #include "UARTCommandConsole.h"\r
  69 \r
  70 /* Dimensions the buffer into which input characters are placed. */\r
  71 #define cmdMAX_INPUT_SIZE               50\r
  72 \r
  73 /* The maximum time in ticks to wait for the UART access mutex. */\r
  74 #define cmdMAX_MUTEX_WAIT               ( 200 / portTICK_RATE_MS )\r
  75 \r
  76 /* Characters are only ever received slowly on the CLI so it is ok to pass\r
  77 received characters from the UART interrupt to the task on a queue.  This sets\r
  78 the length of the queue used for that purpose. */\r
  79 #define cmdRXED_CHARS_QUEUE_LENGTH                      ( 10 )\r
  80 \r
  81 /*-----------------------------------------------------------*/\r
  82 \r
  83 /*\r
  84  * The task that implements the command console processing.\r
  85  */\r
  86 static void prvUARTCommandConsoleTask( void *pvParameters );\r
  87 \r
  88 /*\r
  89  * Ensure a previous interrupt driven Tx has completed before sending the next\r
  90  * data block to the UART.
  91  */\r
  92 static void prvSendBuffer( const uint8_t * pcBuffer, size_t xBufferLength );\r
  93 \r
  94 /*\r
  95  * A UART is used for printf() output and CLI input and output.  Configure the\r
  96  * UART and register prvUARTRxNotificationHandler() to handle UART Rx events.\r
  97  */\r
  98 static void prvConfigureUART( void );\r
  99 static void prvUARTRxNotificationHandler( mss_uart_instance_t * this_uart );\r
 100 \r
 101 /*-----------------------------------------------------------*/\r
 102 \r
 103 /* Const messages output by the command console. */\r
 104 static const uint8_t * const pcWelcomeMessage = ( uint8_t * ) "\r\n\r\nFreeRTOS command server.\r\nType Help to view a list of registered commands.\r\n\r\n>";\r
 105 static const uint8_t * const pcEndOfOutputMessage = ( uint8_t * ) "\r\n[Press ENTER to execute the previous command again]\r\n>";\r
 106 static const uint8_t * const pcNewLine = ( uint8_t * ) "\r\n";\r
 107 \r
 108 /* The UART used by the CLI. */\r
 109 static const mss_uart_instance_t * const pxUART = &g_mss_uart0;\r
 110 static const IRQn_Type xUART_IRQ = UART0_IRQn;\r
 111 \r
 112 /* Because characters are received slowly (at the speed somebody can type) then\r
 113 it is ok to pass received characters from the Rx interrupt to the task on a\r
 114 queue.  This is the queue used for that purpose. */\r
 115 static xQueueHandle xRxedChars = NULL;\r
 116 \r
 117 /*-----------------------------------------------------------*/\r
 118 \r
 119 void vUARTCommandConsoleStart( uint16_t usStackSize, unsigned portBASE_TYPE uxPriority )\r
 120 {\r
 121         /* A UART is used for printf() output and CLI input and output.  Note there\r
 122         is no mutual exclusion on the UART, but the demo as it stands does not\r
 123         require mutual exclusion. */\r
 124         prvConfigureUART();\r
 125 \r
 126         /* Create that task that handles the console itself. */\r
 127         xTaskCreate(    prvUARTCommandConsoleTask,                      /* The task that implements the command console. */\r
 128                                         ( const int8_t * const ) "CLI",         /* Text name assigned to the task.  This is just to assist debugging.  The kernel does not use this name itself. */\r
 129                                         usStackSize,                                            /* The size of the stack allocated to the task. */\r
 130                                         NULL,                                                           /* The parameter is not used, so NULL is passed. */\r
 131                                         uxPriority,                                                     /* The priority allocated to the task. */\r
 132                                         NULL );                                                         /* A handle is not required, so just pass NULL. */\r
 133 }\r
 134 /*-----------------------------------------------------------*/\r
 135 \r
 136 static void prvUARTCommandConsoleTask( void *pvParameters )\r
 137 {\r
 138 int8_t cRxedChar, cInputIndex = 0, *pcOutputString;\r
 139 static int8_t cInputString[ cmdMAX_INPUT_SIZE ], cLastInputString[ cmdMAX_INPUT_SIZE ];\r
 140 portBASE_TYPE xReturned;\r
 141 \r
 142         ( void ) pvParameters;\r
 143 \r
 144         /* Obtain the address of the output buffer.  Note there is no mutual\r
 145         exclusion on this buffer as it is assumed only one command console\r
 146         interface will be used at any one time. */\r
 147         pcOutputString = FreeRTOS_CLIGetOutputBuffer();\r
 148 \r
 149         /* Send the welcome message. */\r
 150         prvSendBuffer( pcWelcomeMessage, strlen( ( char * ) pcWelcomeMessage ) );\r
 151 \r
 152         for( ;; )\r
 153         {\r
 154                 /* Wait for the next character to arrive. */\r
 155                 if( xQueueReceive( xRxedChars, &cRxedChar, portMAX_DELAY ) == pdPASS )\r
 156                 {\r
 157                         /* Echo the character back. */\r
 158                         prvSendBuffer( ( uint8_t * ) &cRxedChar, sizeof( cRxedChar ) );\r
 159 \r
 160                         /* Was it the end of the line? */\r
 161                         if( cRxedChar == '\n' || cRxedChar == '\r' )\r
 162                         {\r
 163                                 /* Just to space the output from the input. */\r
 164                                 prvSendBuffer( ( uint8_t * ) pcNewLine, strlen( ( char * ) pcNewLine ) );\r
 165 \r
 166                                 /* See if the command is empty, indicating that the last command is\r
 167                                 to be executed again. */\r
 168                                 if( cInputIndex == 0 )\r
 169                                 {\r
 170                                         /* Copy the last command back into the input string. */\r
 171                                         strcpy( ( char * ) cInputString, ( char * ) cLastInputString );\r
 172                                 }\r
 173 \r
 174                                 /* Pass the received command to the command interpreter.  The\r
 175                                 command interpreter is called repeatedly until it returns pdFALSE\r
 176                                 (indicating there is no more output) as it might generate more than\r
 177                                 one string. */\r
 178                                 do\r
 179                                 {\r
 180                                         /* Get the next output string from the command interpreter. */\r
 181                                         xReturned = FreeRTOS_CLIProcessCommand( cInputString, pcOutputString, configCOMMAND_INT_MAX_OUTPUT_SIZE );\r
 182 \r
 183                                         /* Write the generated string to the UART. */\r
 184                                         prvSendBuffer( ( uint8_t * ) pcOutputString, strlen( ( char * ) pcOutputString ) );\r
 185 \r
 186                                 } while( xReturned != pdFALSE );\r
 187 \r
 188                                 /* All the strings generated by the input command have been sent.\r
 189                                 Clear the input string ready to receive the next command.  Remember\r
 190                                 the command that was just processed first in case it is to be\r
 191                                 processed again. */\r
 192                                 strcpy( ( char * ) cLastInputString, ( char * ) cInputString );\r
 193                                 cInputIndex = 0;\r
 194                                 memset( cInputString, 0x00, cmdMAX_INPUT_SIZE );\r
 195 \r
 196                                 prvSendBuffer( ( uint8_t * ) pcEndOfOutputMessage, strlen( ( char * ) pcEndOfOutputMessage ) );\r
 197                         }\r
 198                         else\r
 199                         {\r
 200                                 if( cRxedChar == '\r' )\r
 201                                 {\r
 202                                         /* Ignore the character. */\r
 203                                 }\r
 204                                 else if( cRxedChar == '\b' )\r
 205                                 {\r
 206                                         /* Backspace was pressed.  Erase the last character in the\r
 207                                         string - if any. */\r
 208                                         if( cInputIndex > 0 )\r
 209                                         {\r
 210                                                 cInputIndex--;\r
 211                                                 cInputString[ cInputIndex ] = '\0';\r
 212                                         }\r
 213                                 }\r
 214                                 else\r
 215                                 {\r
 216                                         /* A character was entered.  Add it to the string\r
 217                                         entered so far.  When a \n is entered the complete\r
 218                                         string will be passed to the command interpreter. */\r
 219                                         if( ( cRxedChar >= ' ' ) && ( cRxedChar <= '~' ) )\r
 220                                         {\r
 221                                                 if( cInputIndex < cmdMAX_INPUT_SIZE )\r
 222                                                 {\r
 223                                                         cInputString[ cInputIndex ] = cRxedChar;\r
 224                                                         cInputIndex++;\r
 225                                                 }\r
 226                                         }\r
 227                                 }\r
 228                         }\r
 229                 }\r
 230         }\r
 231 }\r
 232 /*-----------------------------------------------------------*/\r
 233 \r
 234 static void prvSendBuffer( const uint8_t * pcBuffer, size_t xBufferLength )\r
 235 {\r
 236 const portTickType xVeryShortDelay = 2UL;\r
 237 \r
 238         MSS_UART_irq_tx( ( mss_uart_instance_t * ) pxUART, pcBuffer, xBufferLength );\r
 239 \r
 240         /* Ensure any previous transmissions have completed.  The default UART\r
 241         interrupt does not provide an event based method of     signally the end of a Tx\r
 242         - this is therefore a crude poll of the Tx end status.  Replacing the\r
 243         default UART handler with one that 'gives' a semaphore when the Tx is\r
 244         complete would allow this poll loop to be replaced by a simple semaphore\r
 245         block. */\r
 246         while( MSS_UART_tx_complete( ( mss_uart_instance_t * ) pxUART ) == pdFALSE )\r
 247         {\r
 248                 vTaskDelay( xVeryShortDelay );\r
 249         }\r
 250 }\r
 251 /*-----------------------------------------------------------*/\r
 252 \r
 253 static void prvConfigureUART( void )\r
 254 {\r
 255         /* Initialise the UART which is used for printf() and CLI IO. */\r
 256         MSS_UART_init( ( mss_uart_instance_t * ) pxUART, MSS_UART_115200_BAUD, MSS_UART_DATA_8_BITS | MSS_UART_NO_PARITY | MSS_UART_ONE_STOP_BIT );\r
 257 \r
 258         /* Characters are only ever received slowly on the CLI so it is ok to pass\r
 259         received characters from the UART interrupt to the task on a queue.  Create\r
 260         the queue used for that purpose. */\r
 261         xRxedChars = xQueueCreate( cmdRXED_CHARS_QUEUE_LENGTH, sizeof( char ) );\r
 262 \r
 263         /* The interrupt handler makes use of FreeRTOS API functions, so its\r
 264         priority must be at or below the configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY\r
 265         setting (the higher the numeric priority, the lower the logical priority). */\r
 266         NVIC_SetPriority( xUART_IRQ, configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY );\r
 267 \r
 268         /* Set the UART Rx notification function. */\r
 269         MSS_UART_set_rx_handler( ( mss_uart_instance_t * ) pxUART, prvUARTRxNotificationHandler, MSS_UART_FIFO_SINGLE_BYTE );\r
 270 }\r
 271 /*-----------------------------------------------------------*/\r
 272 \r
 273 static void prvUARTRxNotificationHandler( mss_uart_instance_t * pxUART )\r
 274 {\r
 275 uint8_t cRxed;\r
 276 portBASE_TYPE xHigherPriorityTaskWoken;\r
 277 \r
 278         /* The command console receives data very slowly (at the speed of somebody\r
 279         typing), therefore it is ok to just handle one character at a time and use\r
 280         a queue to send the characters to the task. */\r
 281         if( MSS_UART_get_rx( pxUART, &cRxed, sizeof( cRxed ) ) == sizeof( cRxed ) )\r
 282         {\r
 283                 xHigherPriorityTaskWoken = pdFALSE;\r
 284                 xQueueSendFromISR( xRxedChars, &cRxed, &xHigherPriorityTaskWoken );\r
 285 \r
 286                 /* portEND_SWITCHING_ISR() or portYIELD_FROM_ISR() can be used here. */\r
 287                 portYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
 288         }\r
 289 }\r
 290 \r