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