]>
cloudbase.mooo.com Git - z180-stamp.git/blob - include/cli_readline.h
2 * (C) Copyright 2014 Leo C. <erbl259-lmu@yahoo.de>
4 * (C) Copyright 2014 Google, Inc
5 * Simon Glass <sjg@chromium.org>
7 * SPDX-License-Identifier: GPL-2.0+
10 #ifndef CLI_READLINE_H
11 #define CLI_READLINE_H
13 extern char console_buffer
[]; /* console I/O buffer */
16 * cli_readline() - read a line into the console_buffer
18 * This is a convenience function which calls cli_readline_into_buffer().
20 * @prompt: Prompt to display
21 * @return command line length excluding terminator, or -ve on error
23 int cli_readline(const FLASH
char *const prompt
);
26 * readline_into_buffer() - read a line into a buffer
28 * Display the prompt, then read a command line into @buffer. The
29 * maximum line length is CONFIG_SYS_CBSIZE including a \0 terminator, which
30 * will always be added.
32 * The command is echoed as it is typed. Command editing is supported.
33 * Tab auto-complete is supported if CONFIG_AUTO_COMPLETE is defined.
34 * If CONFIG_BOOT_RETRY_TIME is defined, then a timeout will be applied.
36 * If CONFIG_BOOT_RETRY_TIME is defined and retry_time >= 0,
37 * time out when time goes past endtime (timebase time in ticks).
39 * @prompt: Prompt to display
40 * @buffer: Place to put the line that is entered
41 * @timeout: Timeout in milliseconds, 0 if none
42 * @return command line length excluding terminator, or -ve on error: of the
43 * timeout is exceeded (either CONFIG_BOOT_RETRY_TIME or the timeout
44 * parameter), then -2 is returned. If a break is detected (Ctrl-C) then
47 //int cli_readline_into_buffer(const char *const prompt, char *buffer, int timeout);
50 #endif /* CLI_READLINE_H */