console: Provide a documentation for console_search_dev()

Provide a documentation for console_search_dev().

Suggested-by: Simon Glass <sjg@chromium.org>
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
This commit is contained in:
Andy Shevchenko 2020-12-21 14:30:04 +02:00 committed by Tom Rini
parent 3232487daf
commit ae69738d3b

View file

@ -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