device property: Fix documentation for FWNODE_GRAPH_DEVICE_DISABLED

FWNODE_GRAPH_DEVICE_DISABLED flag was meant for also returning endpoints
connected to disabled devices, but it also may return endpoints that are
not connected. Fix this in documentation. Also
fwnode_graph_get_endpoint_by_id() was affeced by this.

Also improve the language a little bit.

Fixes: 0fcc2bdc8aff ("device property: Add fwnode_graph_get_endpoint_by_id()")
Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>

diff --git a/drivers/base/property.c b/drivers/base/property.c
index b7b3a7b8600601fcf62bcd11d00a21351809920d..e2860abf9889850851f19dcc9de6efd284ec0da9 100644 (file)
--- a/drivers/base/property.c
+++ b/drivers/base/property.c
@@ -1063,8 +1063,8 @@ EXPORT_SYMBOL_GPL(fwnode_graph_get_remote_node);
  * has not been found, look for the closest endpoint ID greater than the
  * specified one and return the endpoint that corresponds to it, if present.
  *
- * Do not return endpoints that belong to disabled devices, unless
- * FWNODE_GRAPH_DEVICE_DISABLED is passed in @flags.
+ * Does not return endpoints that belong to disabled devices or endpoints that
+ * are unconnected, unless FWNODE_GRAPH_DEVICE_DISABLED is passed in @flags.
  *
  * The returned endpoint needs to be released by calling fwnode_handle_put() on
  * it when it is not needed any more.

diff --git a/include/linux/property.h b/include/linux/property.h
index 16f736c698a2d858093c555c9b58959abc0ca4e0..7a2df45ec3aeaac8f2050bea8cf5feb4ad24243f 100644 (file)
--- a/include/linux/property.h
+++ b/include/linux/property.h
@@ -414,7 +414,8 @@ static inline bool fwnode_graph_is_endpoint(struct fwnode_handle *fwnode)
  *                             one.
  * @FWNODE_GRAPH_DEVICE_DISABLED: That the device to which the remote
  *                               endpoint of the given endpoint belongs to,
- *                               may be disabled.
+ *                               may be disabled, or that the endpoint is not
+ *                               connected.
  */
 #define FWNODE_GRAPH_ENDPOINT_NEXT     BIT(0)
 #define FWNODE_GRAPH_DEVICE_DISABLED   BIT(1)