Blame view
include/cli.h
4.97 KB
83d290c56 SPDX: Convert all... |
1 |
/* SPDX-License-Identifier: GPL-2.0+ */ |
18d66533a move CLI prototyp... |
2 3 4 |
/* * (C) Copyright 2014 Google, Inc * Simon Glass <sjg@chromium.org> |
18d66533a move CLI prototyp... |
5 6 7 8 9 10 11 12 13 14 15 |
*/ #ifndef __CLI_H #define __CLI_H /** * Go into the command loop * * This will return if we get a timeout waiting for a command. See * CONFIG_BOOT_RETRY_TIME. */ |
c1bb2cd0b main: Hide the hu... |
16 |
void cli_simple_loop(void); |
18d66533a move CLI prototyp... |
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
/** * cli_simple_run_command() - Execute a command with the simple CLI * * @cmd: String containing the command to execute * @flag Flag value - see CMD_FLAG_... * @return 1 - command executed, repeatable * 0 - command executed but not repeatable, interrupted commands are * always considered not repeatable * -1 - not executed (unrecognized, bootd recursion or too many args) * (If cmd is NULL or "" or longer than CONFIG_SYS_CBSIZE-1 it is * considered unrecognized) */ int cli_simple_run_command(const char *cmd, int flag); /** |
a06be2d07 cli: Export cli_s... |
33 34 35 36 37 38 39 40 |
* cli_simple_process_macros() - Expand $() and ${} format env. variables * * @param input Input string possible containing $() / ${} vars * @param output Output string with $() / ${} vars expanded */ void cli_simple_process_macros(const char *input, char *output); /** |
18d66533a move CLI prototyp... |
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
* cli_simple_run_command_list() - Execute a list of command * * The commands should be separated by ; or and will be executed * by the built-in parser. * * This function cannot take a const char * for the command, since if it * finds newlines in the string, it replaces them with \0. * * @param cmd String containing list of commands * @param flag Execution flags (CMD_FLAG_...) * @return 0 on success, or != 0 on error. */ int cli_simple_run_command_list(char *cmd, int flag); /** * cli_readline() - read a line into the console_buffer * * This is a convenience function which calls cli_readline_into_buffer(). * * @prompt: Prompt to display * @return command line length excluding terminator, or -ve on error */ |
e1bf824df Add cli_ prefix t... |
64 |
int cli_readline(const char *const prompt); |
18d66533a move CLI prototyp... |
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
/** * readline_into_buffer() - read a line into a buffer * * Display the prompt, then read a command line into @buffer. The * maximum line length is CONFIG_SYS_CBSIZE including a \0 terminator, which * will always be added. * * The command is echoed as it is typed. Command editing is supported if * CONFIG_CMDLINE_EDITING is defined. Tab auto-complete is supported if * CONFIG_AUTO_COMPLETE is defined. If CONFIG_BOOT_RETRY_TIME is defined, * then a timeout will be applied. * * If CONFIG_BOOT_RETRY_TIME is defined and retry_time >= 0, * time out when time goes past endtime (timebase time in ticks). * * @prompt: Prompt to display * @buffer: Place to put the line that is entered * @timeout: Timeout in milliseconds, 0 if none * @return command line length excluding terminator, or -ve on error: of the * timeout is exceeded (either CONFIG_BOOT_RETRY_TIME or the timeout * parameter), then -2 is returned. If a break is detected (Ctrl-C) then * -1 is returned. */ |
e1bf824df Add cli_ prefix t... |
89 90 |
int cli_readline_into_buffer(const char *const prompt, char *buffer, int timeout); |
18d66533a move CLI prototyp... |
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 |
/** * parse_line() - split a command line down into separate arguments * * The argv[] array is filled with pointers into @line, and each argument * is terminated by \0 (i.e. @line is changed in the process unless there * is only one argument). * * #argv is terminated by a NULL after the last argument pointer. * * At most CONFIG_SYS_MAXARGS arguments are permited - if there are more * than that then an error is printed, and this function returns * CONFIG_SYS_MAXARGS, with argv[] set up to that point. * * @line: Command line to parse * @args: Array to hold arguments * @return number of arguments */ |
e1bf824df Add cli_ prefix t... |
109 |
int cli_simple_parse_line(char *line, char *argv[]); |
18d66533a move CLI prototyp... |
110 |
|
0f9258228 of: clean up OF_C... |
111 |
#if CONFIG_IS_ENABLED(OF_CONTROL) |
affb21562 main: Make the ex... |
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
/** * cli_process_fdt() - process the boot command from the FDT * * If bootcmmd is defined in the /config node of the FDT, we use that * as the boot command. Further, if bootsecure is set to 1 (in the same * node) then we return true, indicating that the command should be executed * as securely as possible, avoiding the CLI parser. * * @cmdp: On entry, the command that will be executed if the FDT does * not have a command. Returns the command to execute after * checking the FDT. * @return true to execute securely, else false */ bool cli_process_fdt(const char **cmdp); /** cli_secure_boot_cmd() - execute a command as securely as possible * * This avoids using the parser, thus executing the command with the * smallest amount of code. Parameters are not supported. */ void cli_secure_boot_cmd(const char *cmd); #else static inline bool cli_process_fdt(const char **cmdp) { return false; } static inline void cli_secure_boot_cmd(const char *cmd) { } #endif /* CONFIG_OF_CONTROL */ |
c1bb2cd0b main: Hide the hu... |
143 144 145 146 147 148 149 150 151 152 |
/** * Go into the command loop * * This will return if we get a timeout waiting for a command, but only for * the simple parser (not hush). See CONFIG_BOOT_RETRY_TIME. */ void cli_loop(void); /** Set up the command line interpreter ready for action */ void cli_init(void); |
6493ccc7c Split out simple ... |
153 |
#define endtick(seconds) (get_ticks() + (uint64_t)(seconds) * get_tbclk()) |
18d66533a move CLI prototyp... |
154 |
#endif |