From: Saravana Kannan <saravanak@google.com>
To: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
"Rafael J. Wysocki" <rafael@kernel.org>,
"Rafael J. Wysocki" <rjw@rjwysocki.net>,
Len Brown <lenb@kernel.org>
Cc: Saravana Kannan <saravanak@google.com>,
kernel-team@android.com, linux-kernel@vger.kernel.org,
linux-acpi@vger.kernel.org
Subject: [PATCH v1] driver core: Clarify documentation for fwnode_operations.add_links()
Date: Tue, 12 Nov 2019 18:35:59 -0800 [thread overview]
Message-ID: <20191113023559.62295-2-saravanak@google.com> (raw)
In-Reply-To: <20191113023559.62295-1-saravanak@google.com>
The wording was a bit ambiguous. So update it to make it clear.
Signed-off-by: Saravana Kannan <saravanak@google.com>
---
include/linux/fwnode.h | 15 ++++++++-------
1 file changed, 8 insertions(+), 7 deletions(-)
diff --git a/include/linux/fwnode.h b/include/linux/fwnode.h
index 766ff9bb5876..23df37f85398 100644
--- a/include/linux/fwnode.h
+++ b/include/linux/fwnode.h
@@ -94,15 +94,16 @@ struct fwnode_reference_args {
* available suppliers.
*
* Return 0 if device links have been successfully created to all
- * the suppliers this device needs to create device links to or if
- * the supplier information is not known.
+ * the known suppliers of this device or if the supplier
+ * information is not known.
*
- * Return -ENODEV if and only if the suppliers needed for probing
- * the device are not yet available to create device links to.
+ * Return -ENODEV if the suppliers needed for probing this device
+ * have not been registered yet (because device links can only be
+ * created to devices registered with the driver core).
*
- * Return -EAGAIN if there are suppliers that need to be linked to
- * that are not yet available but none of those suppliers are
- * necessary for probing this device.
+ * Return -EAGAIN if some of the suppliers of this device have not
+ * been registered yet, but none of those suppliers are necessary
+ * for probing the device.
*/
struct fwnode_operations {
struct fwnode_handle *(*get)(struct fwnode_handle *fwnode);
--
2.24.0.rc1.363.gb1bccd3e3d-goog
next prev parent reply other threads:[~2019-11-13 2:36 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-11-13 2:35 [PATCH v1] driver core: Allow device link operations inside sync_state() Saravana Kannan
2019-11-13 2:35 ` Saravana Kannan [this message]
2019-11-13 10:20 ` [PATCH v1] driver core: Clarify documentation for fwnode_operations.add_links() Rafael J. Wysocki
2019-11-14 9:13 ` [PATCH v1] driver core: Allow device link operations inside sync_state() Rafael J. Wysocki
2019-11-14 19:32 ` Saravana Kannan
2019-11-14 9:15 ` Rafael J. Wysocki
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=20191113023559.62295-2-saravanak@google.com \
--to=saravanak@google.com \
--cc=gregkh@linuxfoundation.org \
--cc=kernel-team@android.com \
--cc=lenb@kernel.org \
--cc=linux-acpi@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rafael@kernel.org \
--cc=rjw@rjwysocki.net \
/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;
as well as URLs for NNTP newsgroup(s).