Added a small generic command line shell.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1411 35acf78f-673a-0410-8e92-d51de3d6d3f4

3 files changed, 384 insertions, 0 deletions

diff --git a/os/various/shell.c b/os/various/shell.c
new file mode 100644
index 000000000..8ba101d01
--- /dev/null
+++ b/os/various/shell.c
@@ -0,0 +1,284 @@
+/*

+    ChibiOS/RT - Copyright (C) 2006-2007 Giovanni Di Sirio.

+

+    This file is part of ChibiOS/RT.

+

+    ChibiOS/RT is free software; you can redistribute it and/or modify

+    it under the terms of the GNU General Public License as published by

+    the Free Software Foundation; either version 3 of the License, or

+    (at your option) any later version.

+

+    ChibiOS/RT is distributed in the hope that it will be useful,

+    but WITHOUT ANY WARRANTY; without even the implied warranty of

+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

+    GNU General Public License for more details.

+

+    You should have received a copy of the GNU General Public License

+    along with this program.  If not, see <http://www.gnu.org/licenses/>.

+*/

+

+/**

+ * @file shell.c

+ * @brief Simple CLI shell code.

+ * @addtogroup SHELL

+ * @{

+ */

+

+#include <stdio.h>

+#include <string.h>

+

+#include "ch.h"

+#include "shell.h"

+

+#if SHELL_USE_IPRINTF

+#define sprintf siprintf

+#endif

+

+/**

+ * @brief Shell termination event source.
+ */

+EventSource shell_terminated;

+

+/*

+ * MinGW does not seem to have this function...

+ */

+static char *strtok_r(char *str, const char *delim, char **saveptr) {

+  char *token;

+  if (str)

+    *saveptr = str;

+  token = *saveptr;

+

+  if (!token)

+    return NULL;

+

+  token += strspn(token, delim);

+  *saveptr = strpbrk(token, delim);

+  if (*saveptr)

+    *(*saveptr)++ = '\0';

+

+  return *token ? token : NULL;

+}

+

+static void usage(BaseChannel *chp, char *p) {

+

+  shellPrint(chp, "Usage: ");

+  shellPrintLine(chp, p);

+}

+

+static void list_commands(BaseChannel *chp, const ShellCommand *scp) {

+

+  while (scp->sc_name != NULL) {

+    shellPrint(chp, scp->sc_name);

+    shellPrint(chp, " ");

+    scp++;

+  }

+}

+

+static void cmd_info(BaseChannel *chp, int argc, char *argv[]) {

+

+  (void)argv;

+  if (argc > 0) {

+    usage(chp, "info");

+    return;

+  }

+

+  shellPrint(chp, "Kernel version ");

+  shellPrintLine(chp, CH_KERNEL_VERSION);

+  shellPrint(chp, "Architecture ");

+  shellPrintLine(chp, CH_ARCHITECTURE_NAME);

+#ifdef __GNUC__

+  shellPrint(chp, "GCC Version ");

+  shellPrintLine(chp, __VERSION__);

+#endif

+}

+

+static void cmd_systime(BaseChannel *chp, int argc, char *argv[]) {

+  char buf[12];

+

+  (void)argv;

+  if (argc > 0) {

+    usage(chp, "systime");

+    return;

+  }

+  sprintf(buf, "%lu", (unsigned long)chTimeNow());

+  shellPrintLine(chp, buf);

+}

+

+/**

+ * @brief Array of the default commands.
+ */

+static ShellCommand local_commands[] = {

+  {"info", cmd_info},

+  {"systime", cmd_systime},

+  {NULL, NULL}

+};

+

+static bool_t cmdexec(const ShellCommand *scp, BaseChannel *chp,

+                      char *name, int argc, char *argv[]) {

+

+  while (scp->sc_name != NULL) {

+    if (strcmpi(scp->sc_name, name) == 0) {

+      scp->sc_function(chp, argc, argv);

+      return FALSE;

+    }

+    scp++;

+  }

+  return TRUE;

+}

+

+/**

+ * @brief Shell thread function.

+ *
+ * @param[in] p pointer to an @p BaseChannel object
+ * @return Termination reason.

+ * @retval RDY_OK terminated by command.

+ * @retval RDY_RESET terminated by reset condition on the I/O channel.
+ */

+static msg_t shell_thread(void *p) {

+  int n;

+  msg_t msg = RDY_OK;

+  BaseChannel *chp = ((ShellConfig *)p)->sc_channel;

+  const ShellCommand *scp = ((ShellConfig *)p)->sc_commands;

+  char *lp, *cmd, *tokp, line[SHELL_MAX_LINE_LENGTH];

+  char *args[SHELL_MAX_ARGUMENTS + 1];

+

+  shellPrintLine(chp, "");

+  shellPrintLine(chp, "ChibiOS/RT Shell");

+  while (TRUE) {

+    shellPrint(chp, "ch> ");

+    if (shellGetLine(chp, line, sizeof(line))) {

+      shellPrint(chp, "\nlogout");

+      break;

+    }

+    lp = strtok_r(line, " \009", &tokp);

+    cmd = lp;

+    n = 0;

+    while ((lp = strtok_r(NULL, " \009", &tokp)) != NULL) {

+      if (n >= SHELL_MAX_ARGUMENTS) {

+        shellPrintLine(chp, "too many arguments");

+        cmd = NULL;

+        break;

+      }

+      args[n++] = lp;

+    }

+    args[n] = NULL;

+    if (cmd != NULL) {

+      if (strcmpi(cmd, "exit") == 0) {

+        if (n > 0)

+          usage(chp, "exit");

+        break;

+      }

+      else if (strcmpi(cmd, "help") == 0) {

+        if (n > 0)

+          usage(chp, "help");

+        shellPrint(chp, "Commands: help exit ");

+        list_commands(chp, local_commands);

+        if (scp != NULL)

+          list_commands(chp, scp);

+        shellPrintLine(chp, "");

+      }

+      else if (cmdexec(local_commands, chp, cmd, n, args) &&

+          ((scp == NULL) || cmdexec(scp, chp, cmd, n, args))) {

+        shellPrint(chp, cmd);

+        shellPrintLine(chp, " ?");

+      }

+    }

+  }

+  chSysLock();

+  chEvtBroadcastI(&shell_terminated);

+  return msg;

+}

+

+/**

+ * @brief Shell manager initialization.
+ */

+void shellInit(void) {

+

+  chEvtInit(&shell_terminated);

+}

+

+/**

+ * @brief Spawns a new shell.

+ *
+ * @param[in] chp pointer to an @p BaseChannel object
+ * @param[in] size size of the shell working area to be allocated

+ * @param[in] prio the priority level for the new shell

+ *

+ * @return A pointer to the shell thread.

+ * @retval NULL thread creation failed because memory allocation.

+ */

+Thread *shellCreate(const ShellConfig *scp, size_t size, tprio_t prio) {

+

+  return chThdCreateFromHeap(NULL, size, prio, shell_thread, (void *)scp);

+}

+

+/**

+ * @brief Prints a string.

+ *
+ * @param[in] chp pointer to an @p BaseChannel object

+ * @param[in] msg pointer to the string
+ */

+void shellPrint(BaseChannel *chp, const char *msg) {

+

+  while (*msg)

+    chIOPut(chp, *msg++);

+}

+

+/**

+ * @brief Prints a string with a final newline.

+ *

+ * @param[in] chp pointer to an @p BaseChannel object

+ * @param[in] msg pointer to the string

+ */

+void shellPrintLine(BaseChannel *chp, const char *msg) {

+

+  shellPrint(chp, msg);

+  shellPrint(chp, "\r\n");

+}

+

+/**

+ * @brief Reads a whole line from the input channel.

+ *
+ * @param[in] chp pointer to an @p BaseChannel object

+ * @param[in] line pointer to the line buffer
+ * @param[in] size buffer maximum length

+ *
+ * @return The operation status.

+ * @retval TRUE the channel was reset or CTRL-D pressed.

+ * @retval FALSE operation successful.

+ */

+bool_t shellGetLine(BaseChannel *chp, char *line, unsigned size) {

+  char *p = line;

+

+  while (TRUE) {

+    short c = (short)chIOGet(chp);

+    if (c < 0)

+      return TRUE;

+    if (c == 4) {

+      shellPrintLine(chp, "^D");

+      return TRUE;

+    }

+    if (c == 8) {

+      if (p != line) {

+        chIOPut(chp, (uint8_t)c);

+        chIOPut(chp, 0x20);

+        chIOPut(chp, (uint8_t)c);

+        p--;

+      }

+      continue;

+    }

+    if (c == '\r') {

+      shellPrintLine(chp, "");

+      *p = 0;

+      return FALSE;

+    }

+    if (c < 0x20)

+      continue;

+    if (p < line + size - 1) {

+      chIOPut(chp, (uint8_t)c);

+      *p++ = (char)c;

+    }

+  }

+}

+

+/** @} */

diff --git a/os/various/shell.h b/os/various/shell.h
new file mode 100644
index 000000000..d96acc4c4
--- /dev/null
+++ b/os/various/shell.h
@@ -0,0 +1,90 @@
+/*

+    ChibiOS/RT - Copyright (C) 2006-2007 Giovanni Di Sirio.

+

+    This file is part of ChibiOS/RT.

+

+    ChibiOS/RT is free software; you can redistribute it and/or modify

+    it under the terms of the GNU General Public License as published by

+    the Free Software Foundation; either version 3 of the License, or

+    (at your option) any later version.

+

+    ChibiOS/RT is distributed in the hope that it will be useful,

+    but WITHOUT ANY WARRANTY; without even the implied warranty of

+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

+    GNU General Public License for more details.

+

+    You should have received a copy of the GNU General Public License

+    along with this program.  If not, see <http://www.gnu.org/licenses/>.

+*/

+

+/**

+ * @file shell.h

+ * @brief Simple CLI shell header.

+ * @addtogroup SHELL

+ * @{

+ */

+

+#ifndef _SHELL_H_

+#define _SHELL_H_

+

+/**

+ * @brief Shell maximum input line length.

+ */

+#if !defined(SHELL_MAX_LINE_LENGTH) || defined(__DOXYGEN__)

+#define SHELL_MAX_LINE_LENGTH       64

+#endif

+

+/**

+ * @brief Shell maximum input line length.

+ */

+#if !defined(SHELL_MAX_ARGUMENTS) || defined(__DOXYGEN__)

+#define SHELL_MAX_ARGUMENTS         4

+#endif

+

+/**

+ * @brief Enforces the use of iprintf() on newlib.

+ */

+#if !defined(SHELL_USE_IPRINTF) || defined(__DOXYGEN__)

+#define SHELL_USE_IPRINTF           TRUE

+#endif

+

+/**

+ * @brief Command handler function type.
+ */

+typedef void (*shellcmd_t)(BaseChannel *chp, int argc, char *argv[]);

+

+/**

+ * @brief Custom command entry type.
+ */

+typedef struct {

+  const char            *sc_name;           /**< @brief Command name.       */

+  shellcmd_t            sc_function;        /**< @brief Command function.   */

+} ShellCommand;

+

+/**

+ * @brief Shell descriptor type.
+ */

+typedef struct {

+  BaseChannel           *sc_channel;        /**< @brief I/O channel associated

+                                                 to the shell.              */

+  const ShellCommand    *sc_commands;       /**< @brief Shell extra commands

+                                                 table.                     */

+} ShellConfig;

+

+extern EventSource shell_terminated;

+

+#ifdef __cplusplus

+extern "C" {

+#endif

+  void shellInit(void);

+  Thread *shellCreate(const ShellConfig *scp, size_t size, tprio_t prio);

+  void shellPrint(BaseChannel *chp, const char *msg);

+  void shellPrintLine(BaseChannel *chp, const char *msg);

+  bool_t shellGetLine(BaseChannel *chp, char *line, unsigned size);

+#ifdef __cplusplus

+}

+#endif

+

+#endif /* _SHELL_H_ */

+

+/** @} */

diff --git a/os/various/various.dox b/os/various/various.dox
index fae5e65e5..10dfe874f 100644
--- a/os/various/various.dox
+++ b/os/various/various.dox
@@ -47,3 +47,13 @@
  *

  * @ingroup various

  */

+

+/**

+ * @defgroup SHELL Command Shell

+ * @brief Small extendible command line shell.

+ * @details This module implements a generic extendible command line interface.

+ * The CLI just requires an I/O channel (@p BaseChannel), more commands can be

+ * added to the shell using the configuration structure.

+ *

+ * @ingroup various

+ */