summaryrefslogtreecommitdiffstats
path: root/cpukit/libmisc/shell/shell.h
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2007-12-03 02:22:35 +0000
committerChris Johns <chrisj@rtems.org>2007-12-03 02:22:35 +0000
commitdec8f84375aad9b4484169ca81a8b3248b377270 (patch)
treeac59749017b9d7e83aa14f29e3dc8bdfab372899 /cpukit/libmisc/shell/shell.h
parent2007-12-03 Chris Johns <chrisj@rtems.org> (diff)
downloadrtems-dec8f84375aad9b4484169ca81a8b3248b377270.tar.bz2
2007-12-03 Chris Johns <chrisj@rtems.org>
* libmisc/shell/shell.h: Added comments for the parameters to the shell_init function. * libmisc/shell/shell.c: Only set cflags if tcflags is non-zero. This means the shell can use the current cflags settings and the application does not need to know the baudrate etc. * libmisc/capture/capture.h: Fix the comment.
Diffstat (limited to '')
-rw-r--r--cpukit/libmisc/shell/shell.h15
1 files changed, 15 insertions, 0 deletions
diff --git a/cpukit/libmisc/shell/shell.h b/cpukit/libmisc/shell/shell.h
index 3cce16acb3..4e4cb96044 100644
--- a/cpukit/libmisc/shell/shell.h
+++ b/cpukit/libmisc/shell/shell.h
@@ -69,6 +69,21 @@ int shell_scanline(char * line,int size,FILE * in,FILE * out) ;
void cat_file(FILE * out,char *name);
void write_file(char *name,char * content);
+/**
+ * Initialise the shell creating tasks to login and run the shell
+ * sessions.
+ *
+ * @param task_name Name of the shell task.
+ * @param task_stacksize The size of the stack. If 0 the default size is used.
+ * @param task_priority The priority the shell runs at.
+ * @param tcflag The termios c_cflag value. If 0 the default is used, if
+ * not 0 the value is ORed with CLOCAL and CREAD.
+ * @param forever Repeat logins.
+ *
+ * @todo CCJ I am not sure this termios flag setting is a good idea. The shell
+ * needs to adjust the termios for its use but it should assume the
+ * settings are set by the user for things like baudrate etc.
+ */
rtems_status_code shell_init(
char *task_name,
uint32_t task_stacksize, /*0 default*/