diff mbox series

[v3,5/9] console: Provide a documentation for console_search_dev()

Message ID 20201221123008.9930-5-andriy.shevchenko@linux.intel.com
State Accepted
Commit ae69738d3b311d285db83fde37c0eaa2b7b6c2b4
Delegated to: Tom Rini
Headers show
Series [v3,1/9] console: Introduce console_start() and console_stop() | expand

Commit Message

Andy Shevchenko Dec. 21, 2020, 12:30 p.m. UTC
Provide a documentation for console_search_dev().

Suggested-by: Simon Glass <sjg@chromium.org>
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
v3: new patch
 include/console.h | 10 ++++++++++
 1 file changed, 10 insertions(+)

Comments

Tom Rini Jan. 16, 2021, 4:24 p.m. UTC | #1
On Mon, Dec 21, 2020 at 02:30:04PM +0200, Andy Shevchenko wrote:

> Provide a documentation for console_search_dev().
> 
> Suggested-by: Simon Glass <sjg@chromium.org>
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

Applied to u-boot/master, thanks!
diff mbox series

Patch

diff --git a/include/console.h b/include/console.h
index bb186e7be04d..7e628c0cf836 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