From ae69738d3b311d285db83fde37c0eaa2b7b6c2b4 Mon Sep 17 00:00:00 2001 From: Andy Shevchenko Date: Mon, 21 Dec 2020 14:30:04 +0200 Subject: [PATCH] console: Provide a documentation for console_search_dev() Provide a documentation for console_search_dev(). Suggested-by: Simon Glass Signed-off-by: Andy Shevchenko --- include/console.h | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/include/console.h b/include/console.h index bb186e7be0..7e628c0cf8 100644 --- a/include/console.h +++ b/include/console.h @@ -25,6 +25,16 @@ void clear_ctrlc(void); /* clear the Control-C condition */ int disable_ctrlc(int); /* 1 to disable, 0 to enable Control-C detect */ int confirm_yesno(void); /* 1 if input is "y", "Y", "yes" or "YES" */ +/** + * console_search_dev() - search for stdio device with given flags and name + * @flags: device flags as per input/output/system + * @name: device name + * + * Iterates over registered STDIO devices and match them with given @flags + * and @name. + * + * @return pointer to the &struct stdio_dev if found, or NULL otherwise + */ struct stdio_dev *console_search_dev(int flags, const char *name); #ifdef CONFIG_CONSOLE_RECORD