oveRTOS C API
Embedded RTOS framework — build system, configuration, and portable C API
Loading...
Searching...
No Matches
Data Structures | Macros | Typedefs | Functions
shell.h File Reference
#include "ove/types.h"
#include "ove_config.h"
Include dependency graph for shell.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ove_shell_cmd
 Descriptor for a single shell command. More...
 

Macros

#define OVE_SHELL_MAX_ARGS   8
 Maximum number of arguments (including command name) per shell line.
 

Typedefs

typedef void(* ove_shell_cmd_fn) (int argc, const char *argv[])
 Prototype for a shell command handler function.
 
typedef void(* ove_shell_output_hook_t) (const char *data, size_t len)
 Shell output hook for capturing command output.
 

Functions

int ove_shell_init (void)
 Initialise the shell subsystem.
 
int ove_shell_register_cmd (const struct ove_shell_cmd *cmd)
 Register a command with the shell.
 
void ove_shell_process_char (int c)
 Feed one character into the shell input processor.
 
void ove_shell_process_line (const char *line)
 Process a complete input line through the shell.
 
void ove_shell_set_output_hook (ove_shell_output_hook_t hook)
 Set a hook to capture shell output.