forked from Imagelibrary/rtems
f3db4ac83a
* libmisc/Makefile.am, libmisc/shell/shell.c, libmisc/shell/shell.h: Split out rtems_shell_get_prompt() so it can be overridden by the user. * libmisc/shell/shell_getprompt.c: New file.
252 lines
6.4 KiB
C
252 lines
6.4 KiB
C
/**
|
|
* @file rtems/shell.h
|
|
*
|
|
* Instantatiate a new terminal shell.
|
|
*/
|
|
|
|
/*
|
|
* Author:
|
|
*
|
|
* WORK: fernando.ruiz@ctv.es
|
|
* HOME: correo@fernando-ruiz.com
|
|
*
|
|
* Thanks at:
|
|
* Chris Johns
|
|
*
|
|
* $Id$
|
|
*/
|
|
|
|
#ifndef __RTEMS_SHELL_H__
|
|
#define __RTEMS_SHELL_H__
|
|
|
|
#include <rtems.h>
|
|
#include <stdio.h>
|
|
#include <termios.h>
|
|
#include <rtems/fs.h>
|
|
#include <rtems/libio.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*
|
|
* Some key labels to define special keys.
|
|
*/
|
|
|
|
#define RTEMS_SHELL_KEYS_EXTENDED (0x8000)
|
|
#define RTEMS_SHELL_KEYS_NORMAL_MASK (0x00ff)
|
|
#define RTEMS_SHELL_KEYS_INS (0)
|
|
#define RTEMS_SHELL_KEYS_DEL (1)
|
|
#define RTEMS_SHELL_KEYS_UARROW (2)
|
|
#define RTEMS_SHELL_KEYS_DARROW (3)
|
|
#define RTEMS_SHELL_KEYS_LARROW (4)
|
|
#define RTEMS_SHELL_KEYS_RARROW (5)
|
|
#define RTEMS_SHELL_KEYS_HOME (6)
|
|
#define RTEMS_SHELL_KEYS_END (7)
|
|
#define RTEMS_SHELL_KEYS_F1 (8)
|
|
#define RTEMS_SHELL_KEYS_F2 (9)
|
|
#define RTEMS_SHELL_KEYS_F3 (10)
|
|
#define RTEMS_SHELL_KEYS_F4 (11)
|
|
#define RTEMS_SHELL_KEYS_F5 (12)
|
|
#define RTEMS_SHELL_KEYS_F6 (13)
|
|
#define RTEMS_SHELL_KEYS_F7 (14)
|
|
#define RTEMS_SHELL_KEYS_F8 (15)
|
|
#define RTEMS_SHELL_KEYS_F9 (16)
|
|
#define RTEMS_SHELL_KEYS_F10 (17)
|
|
|
|
typedef int (*rtems_shell_command_t)(int argc,char * argv[]);
|
|
|
|
struct rtems_shell_cmd_tt;
|
|
typedef struct rtems_shell_cmd_tt rtems_shell_cmd_t;
|
|
|
|
struct rtems_shell_cmd_tt {
|
|
char *name;
|
|
char *usage;
|
|
char *topic;
|
|
rtems_shell_command_t command;
|
|
rtems_shell_cmd_t *alias;
|
|
rtems_shell_cmd_t *next;
|
|
};
|
|
|
|
typedef struct {
|
|
char *name;
|
|
char *alias;
|
|
} rtems_shell_alias_t;
|
|
|
|
/*
|
|
* The return value has RTEMS_SHELL_KEYS_EXTENDED set if the key
|
|
* is extended, ie a special key.
|
|
*/
|
|
unsigned int rtems_shell_getchar(FILE *in);
|
|
|
|
rtems_shell_cmd_t * rtems_shell_lookup_cmd(char * cmd);
|
|
|
|
rtems_shell_cmd_t *rtems_shell_add_cmd_struct(
|
|
rtems_shell_cmd_t *shell_cmd
|
|
);
|
|
|
|
rtems_shell_cmd_t * rtems_shell_add_cmd(
|
|
char *cmd,
|
|
char *topic,
|
|
char *usage,
|
|
rtems_shell_command_t command
|
|
);
|
|
|
|
rtems_shell_cmd_t * rtems_shell_alias_cmd(
|
|
char *cmd,
|
|
char *alias
|
|
);
|
|
|
|
int rtems_shell_make_args(
|
|
char *commandLine,
|
|
int *argc_p,
|
|
char **argv_p,
|
|
int max_args
|
|
);
|
|
|
|
int rtems_shell_scanline(
|
|
char *line,
|
|
int size,
|
|
FILE *in,
|
|
FILE *out
|
|
);
|
|
|
|
int rtems_shell_cat_file(
|
|
FILE *out,
|
|
char *name
|
|
);
|
|
|
|
void rtems_shell_write_file(
|
|
const char *name,
|
|
const char *content
|
|
);
|
|
|
|
int rtems_shell_script_file(
|
|
int argc,
|
|
char *argv[]
|
|
);
|
|
|
|
/**
|
|
* 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 forever Repeat logins.
|
|
* @param wait Caller should block until shell exits
|
|
*
|
|
*/
|
|
rtems_status_code rtems_shell_init(
|
|
char *task_name,
|
|
uint32_t task_stacksize, /*0 default*/
|
|
rtems_task_priority task_priority,
|
|
char *devname,
|
|
int forever,
|
|
int wait
|
|
);
|
|
|
|
/**
|
|
* Run a shell script creating a shell tasks to execute the command under.
|
|
*
|
|
* @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 input The file of commands. Can be 'stdin' to use stdin.
|
|
* @param output The output file to write commands to. Can be 'stdout',
|
|
* 'stderr' or '/dev/null'.
|
|
* @param output_append Append the output to the file or truncate the file.
|
|
* Create if it does not exist.
|
|
* @param wait Wait for the script to finish.
|
|
*/
|
|
rtems_status_code rtems_shell_script(
|
|
char *task_name,
|
|
uint32_t task_stacksize, /*0 default*/
|
|
rtems_task_priority task_priority,
|
|
const char *input,
|
|
const char *output,
|
|
int output_append,
|
|
int wait,
|
|
int echo
|
|
);
|
|
|
|
/*
|
|
* Things that are useful to external entities developing commands and plugging
|
|
* them in.
|
|
*/
|
|
int rtems_shell_str2int(char * s);
|
|
|
|
typedef struct {
|
|
rtems_name magic; /* 'S','E','N','V': Shell Environment */
|
|
char *devname;
|
|
char *taskname;
|
|
/* user extensions */
|
|
int exit_shell; /* logout */
|
|
int forever ; /* repeat login */
|
|
int errorlevel;
|
|
int echo;
|
|
char cwd[256];
|
|
const char* input;
|
|
const char* output;
|
|
int output_append;
|
|
rtems_id wake_on_end;
|
|
} rtems_shell_env_t;
|
|
|
|
rtems_boolean rtems_shell_main_loop(
|
|
rtems_shell_env_t *rtems_shell_env
|
|
);
|
|
|
|
extern rtems_shell_env_t rtems_global_shell_env;
|
|
extern rtems_shell_env_t *rtems_current_shell_env;
|
|
|
|
/*
|
|
* The types of file systems we can mount. We have them broken out
|
|
* out like this so they can be configured by shellconfig.h. The
|
|
* mount command needs special treatment due to some file systems
|
|
* being dependent on the network stack and some not. If we had
|
|
* all possible file systems being included it would force the
|
|
* networking stack into the applcation and this may not be
|
|
* required.
|
|
*/
|
|
struct rtems_shell_filesystems_tt;
|
|
typedef struct rtems_shell_filesystems_tt rtems_shell_filesystems_t;
|
|
|
|
typedef int (*rtems_shell_filesystems_mounter_t)(
|
|
const char* driver,
|
|
const char* path,
|
|
rtems_shell_filesystems_t* fs,
|
|
rtems_filesystem_options_t options
|
|
);
|
|
|
|
struct rtems_shell_filesystems_tt {
|
|
const char* name;
|
|
int driver_needed;
|
|
rtems_filesystem_operations_table* fs_ops;
|
|
rtems_shell_filesystems_mounter_t mounter;
|
|
};
|
|
|
|
/**
|
|
* This method dynamically builds the command line prompt string
|
|
* and places it in @a prompt.
|
|
*
|
|
* @param[in] shell_env is the shell execution environment
|
|
* @param[in] prompt is a pointer to a string buffer area
|
|
* @param[in] size is length of the prompt buffer area
|
|
*
|
|
* @return This method fills in the memory pointed to by @a prompt.
|
|
*
|
|
* @note An application specific implementation can be provided
|
|
* by the user.
|
|
*/
|
|
void rtems_shell_get_prompt(
|
|
rtems_shell_env_t *shell_env,
|
|
char *prompt,
|
|
size_t size
|
|
);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|