public inbox for u-boot@lists.denx.de
 help / color / mirror / Atom feed
From: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
To: u-boot@lists.denx.de
Subject: [PATCH v3 5/9] console: Provide a documentation for console_search_dev()
Date: Mon, 21 Dec 2020 14:30:04 +0200	[thread overview]
Message-ID: <20201221123008.9930-5-andriy.shevchenko@linux.intel.com> (raw)
In-Reply-To: <20201221123008.9930-1-andriy.shevchenko@linux.intel.com>

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(+)

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

  parent reply	other threads:[~2020-12-21 12:30 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-12-21 12:30 [PATCH v3 1/9] console: Introduce console_start() and console_stop() Andy Shevchenko
2020-12-21 12:30 ` [PATCH v3 2/9] console: Keep ->start() and ->stop() balanced Andy Shevchenko
2020-12-21 16:47   ` Simon Glass
2021-01-16 16:24   ` Tom Rini
2020-12-21 12:30 ` [PATCH v3 3/9] console: move search_device() from iomux.h to console.h Andy Shevchenko
2021-01-16 16:24   ` Tom Rini
2020-12-21 12:30 ` [PATCH v3 4/9] console: rename search_device() to console_search_dev() Andy Shevchenko
2020-12-21 16:47   ` Simon Glass
2021-01-16 16:24   ` Tom Rini
2020-12-21 12:30 ` Andy Shevchenko [this message]
2021-01-16 16:24   ` [PATCH v3 5/9] console: Provide a documentation for console_search_dev() Tom Rini
2020-12-21 12:30 ` [PATCH v3 6/9] IOMUX: Preserve console list if realloc() fails Andy Shevchenko
2021-01-16 16:25   ` Tom Rini
2020-12-21 12:30 ` [PATCH v3 7/9] IOMUX: Refactor iomux_doenv() in order to increase readability Andy Shevchenko
2021-01-16 16:25   ` Tom Rini
2020-12-21 12:30 ` [PATCH v3 8/9] IOMUX: Drop indentation level by removing redundant 'else' Andy Shevchenko
2021-01-16 16:25   ` Tom Rini
2020-12-21 12:30 ` [PATCH v3 9/9] IOMUX: Stop dropped consoles Andy Shevchenko
2021-01-16 16:25   ` Tom Rini
2021-01-16 16:24 ` [PATCH v3 1/9] console: Introduce console_start() and console_stop() Tom Rini

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20201221123008.9930-5-andriy.shevchenko@linux.intel.com \
    --to=andriy.shevchenko@linux.intel.com \
    --cc=u-boot@lists.denx.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox