diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2009-12-10 15:44:55 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2009-12-10 15:44:55 +0000 |
| commit | dea70dbc797e0936c2532ae55881437e06e169fa (patch) | |
| tree | 8b2e54295e4f0d670c0c9625ae1d4c475c6c7176 /os/various/shell.h | |
| parent | 97b35245d19b59ff87d69fa9f7df701eea8f18c9 (diff) | |
| download | ChibiOS-dea70dbc797e0936c2532ae55881437e06e169fa.tar.gz ChibiOS-dea70dbc797e0936c2532ae55881437e06e169fa.tar.bz2 ChibiOS-dea70dbc797e0936c2532ae55881437e06e169fa.zip | |
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
Diffstat (limited to 'os/various/shell.h')
| -rw-r--r-- | os/various/shell.h | 90 |
1 files changed, 90 insertions, 0 deletions
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_ */
+
+/** @} */
|