core/cmd/cmd.c

   1 /*******************************************************************
   2     Copyright (C) 2009 FreakLabs
   3     All rights reserved.
   4
   5     Redistribution and use in source and binary forms, with or without
   6     modification, are permitted provided that the following conditions
   7     are met:
   8
   9     1. Redistributions of source code must retain the above copyright
  10        notice, this list of conditions and the following disclaimer.
  11     2. Redistributions in binary form must reproduce the above copyright
  12        notice, this list of conditions and the following disclaimer in the
  13        documentation and/or other materials provided with the distribution.
  14     3. Neither the name of the the copyright holder nor the names of its contributors
  15        may be used to endorse or promote products derived from this software
  16        without specific prior written permission.
  17
  18     THIS SOFTWARE IS PROVIDED BY THE THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
  19     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21     ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  22     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24     OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26     LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27     OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28     SUCH DAMAGE.
  29
  30     Originally written by Christopher Wang aka Akiba.
  31     Please post support questions to the FreakLabs forum.
  32 *******************************************************************/
  33
  34 /**************************************************************************/
  35 /*!
  36     @file     cmd.c
  37     @author   Christopher Wang (Freaklabs)
  38               Modified by: K. Townsend (microBuilder.eu)
  39     @date     19 May 2010
  40
  41     Original code taken from the FreakUSB Open Source USB Device Stack
  42     http://freaklabs.org/index.php/FreakUSB-Open-Source-USB-Device-Stack.html
  43
  44     If it works well, you can thank Akiba at Freaklabs.  If it fails
  45     miserably, you can blame me (since parts of it it were rather
  46     ungraciously modified). :-)
  47
  48 */
  49 /**************************************************************************/
  50
  51 #include <stdio.h>
  52 #include <string.h>
  53
  54 #include "cmd.h"
  55 #include "project/cmd_tbl.h"
  56
  57 #ifdef CFG_PRINTF_UART
  58 #include "core/uart/uart.h"
  59 #endif
  60
  61 #ifdef CFG_PRINTF_USBCDC
  62   #include "core/usbcdc/cdcuser.h"
  63   static char usbcdcBuf [32];
  64 #endif
  65
  66 #if CFG_INTERFACE_ENABLEIRQ == 1
  67   #include "core/gpio/gpio.h"
  68 #endif
  69
  70 static uint8_t msg[CFG_INTERFACE_MAXMSGSIZE];
  71 static uint8_t *msg_ptr;
  72
  73 /**************************************************************************/
  74 /*!
  75     @brief  Polls the relevant incoming message queue to see if anything
  76             is waiting to be processed.
  77 */
  78 /**************************************************************************/
  79 void cmdPoll()
  80 {
  81   #if defined CFG_PRINTF_UART
  82   while (uartRxBufferDataPending())
  83   {
  84     uint8_t c = uartRxBufferRead();
  85     cmdRx(c);
  86   }
  87   #endif
  88
  89   #if defined CFG_PRINTF_USBCDC
  90     int  numBytesToRead, numBytesRead, numAvailByte;
  91
  92     CDC_OutBufAvailChar (&numAvailByte);
  93     if (numAvailByte > 0)
  94     {
  95       numBytesToRead = numAvailByte > 32 ? 32 : numAvailByte;
  96       numBytesRead = CDC_RdOutBuf (&usbcdcBuf[0], &numBytesToRead);
  97       int i;
  98       for (i = 0; i < numBytesRead; i++)
  99       {
 100         cmdRx(usbcdcBuf[i]);
 101       }
 102     }
 103   #endif
 104 }
 105
 106 /**************************************************************************/
 107 /*!
 108     @brief  Handles a single incoming character.  If a new line is
 109             detected, the entire command will be passed to the command
 110             parser.  If a text character is detected, it will be added to
 111             the message buffer until a new line is detected (up to the
 112             maximum queue size, CFG_INTERFACE_MAXMSGSIZE).
 113
 114     @param[in]  c
 115                 The character to parse.
 116 */
 117 /**************************************************************************/
 118 void cmdRx(uint8_t c)
 119 {
 120   // read out the data in the buffer and echo it back to the host.
 121   switch (c)
 122   {
 123     case '\r':
 124     case '\n':
 125         // terminate the msg and reset the msg ptr. then send
 126         // it to the handler for processing.
 127         *msg_ptr = '\0';
 128         #if CFG_INTERFACE_SILENTMODE == 0
 129         printf("%s", CFG_PRINTF_NEWLINE);
 130         #endif
 131         cmdParse((char *)msg);
 132         msg_ptr = msg;
 133         break;
 134
 135     case '\b':
 136         #if CFG_INTERFACE_SILENTMODE == 0
 137         printf("%c",c);
 138         #endif
 139         if (msg_ptr > msg)
 140         {
 141             msg_ptr--;
 142         }
 143         break;
 144
 145     default:
 146         #if CFG_INTERFACE_SILENTMODE == 0
 147         printf("%c",c);
 148         #endif
 149         *msg_ptr++ = c;
 150         break;
 151   }
 152 }
 153
 154 /**************************************************************************/
 155 /*!
 156     @brief  Displays the command prompt.  The text that appears is defined
 157             in projectconfig.h.
 158 */
 159 /**************************************************************************/
 160 static void cmdMenu()
 161 {
 162   #if CFG_INTERFACE_SILENTMODE == 0
 163   printf(CFG_PRINTF_NEWLINE);
 164   printf(CFG_INTERFACE_PROMPT);
 165   #endif
 166 }
 167
 168 /**************************************************************************/
 169 /*!
 170     @brief  Parse the command line. This function tokenizes the command
 171             input, then searches for the command table entry associated
 172             with the commmand. Once found, it will jump to the
 173             corresponding function.
 174
 175     @param[in]  cmd
 176                 The entire command string to be parsed
 177 */
 178 /**************************************************************************/
 179 void cmdParse(char *cmd)
 180 {
 181   size_t argc, i = 0;
 182   char *argv[30];
 183
 184   argv[i] = strtok(cmd, " ");
 185   do
 186   {
 187       argv[++i] = strtok(NULL, " ");
 188   } while ((i < 30) && (argv[i] != NULL));
 189
 190   argc = i;
 191   for (i=0; i < CMD_COUNT; i++)
 192   {
 193       if (!strcmp(argv[0], cmd_tbl[i].command))
 194       {
 195         if ((argc == 2) && !strcmp (argv [1], "?"))
 196         {
 197           // Display parameter help menu on 'command ?'
 198           printf ("%s%s%s", cmd_tbl[i].description, CFG_PRINTF_NEWLINE, CFG_PRINTF_NEWLINE);
 199           printf ("%s%s", cmd_tbl[i].parameters, CFG_PRINTF_NEWLINE);
 200         }
 201         else if ((argc - 1) < cmd_tbl[i].minArgs)
 202         {
 203           // Too few arguments supplied
 204           printf ("Too few arguments (%d expected)%s", cmd_tbl[i].minArgs, CFG_PRINTF_NEWLINE);
 205           printf ("%sType '%s ?' for more information%s%s", CFG_PRINTF_NEWLINE, cmd_tbl[i].command, CFG_PRINTF_NEWLINE, CFG_PRINTF_NEWLINE);
 206         }
 207         else if ((argc - 1) > cmd_tbl[i].maxArgs)
 208         {
 209           // Too many arguments supplied
 210           printf ("Too many arguments (%d maximum)%s", cmd_tbl[i].maxArgs, CFG_PRINTF_NEWLINE);
 211           printf ("%sType '%s ?' for more information%s%s", CFG_PRINTF_NEWLINE, cmd_tbl[i].command, CFG_PRINTF_NEWLINE, CFG_PRINTF_NEWLINE);
 212         }
 213         else
 214         {
 215           #if CFG_INTERFACE_ENABLEIRQ != 0
 216           // Set the IRQ pin high at start of a command
 217           gpioSetValue(CFG_INTERFACE_IRQPORT, CFG_INTERFACE_IRQPIN, 1);
 218           #endif
 219           // Dispatch command to the appropriate function
 220           cmd_tbl[i].func(argc - 1, &argv [1]);
 221           #if CFG_INTERFACE_ENABLEIRQ  != 0
 222           // Set the IRQ pin low to signal the end of a command
 223           gpioSetValue(CFG_INTERFACE_IRQPORT, CFG_INTERFACE_IRQPIN, 0);
 224           #endif
 225         }
 226
 227         // Refresh the command prompt
 228         cmdMenu();
 229         return;
 230       }
 231   }
 232   printf("Command not recognized: '%s'%s%s", cmd, CFG_PRINTF_NEWLINE, CFG_PRINTF_NEWLINE);
 233   #if CFG_INTERFACE_SILENTMODE == 0
 234   printf("Type '?' for a list of all available commands%s", CFG_PRINTF_NEWLINE);
 235   #endif
 236
 237   cmdMenu();
 238 }
 239
 240 /**************************************************************************/
 241 /*!
 242     @brief Initialises the command line using the appropriate interface
 243 */
 244 /**************************************************************************/
 245 void cmdInit()
 246 {
 247   #if defined CFG_INTERFACE && defined CFG_INTERFACE_UART
 248     // Check if UART is already initialised
 249     uart_pcb_t *pcb = uartGetPCB();
 250     if (!pcb->initialised)
 251     {
 252       uartInit(CFG_UART_BAUDRATE);
 253     }
 254   #endif
 255
 256   #if CFG_INTERFACE_ENABLEIRQ != 0
 257     // Set IRQ pin as output
 258     gpioSetDir(CFG_INTERFACE_IRQPORT, CFG_INTERFACE_IRQPIN, gpioDirection_Output);
 259     gpioSetValue(CFG_INTERFACE_IRQPORT, CFG_INTERFACE_IRQPIN, 1);
 260   #endif
 261
 262   // init the msg ptr
 263   msg_ptr = msg;
 264
 265   // Show the menu
 266   cmdMenu();
 267
 268   // Set the IRQ pin low by default
 269   #if CFG_INTERFACE_ENABLEIRQ  != 0
 270     gpioSetValue(CFG_INTERFACE_IRQPORT, CFG_INTERFACE_IRQPIN, 0);
 271   #endif
 272 }
 273
 274 /**************************************************************************/
 275 /*!
 276     'help' command handler
 277 */
 278 /**************************************************************************/
 279 void cmd_help(uint8_t argc, char **argv)
 280 {
 281   size_t i;
 282
 283   printf("Command      Description%s", CFG_PRINTF_NEWLINE);
 284   printf("-------      -----------%s", CFG_PRINTF_NEWLINE);
 285
 286   // Display full command list
 287   for (i=0; i < CMD_COUNT; i++)
 288   {
 289     if (!cmd_tbl[i].hidden)
 290     {
 291       printf ("%-10s   %s%s", cmd_tbl[i].command, cmd_tbl[i].description, CFG_PRINTF_NEWLINE);
 292     }
 293   }
 294
 295   printf("%sCommand parameters can be seen by entering: <command-name> ?%s", CFG_PRINTF_NEWLINE, CFG_PRINTF_NEWLINE);
 296 }