Commit 49f39cb0 authored Dec 01, 2021 by Sakari Ailus Committed by Rafael J. Wysocki Dec 17, 2021

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: 0fcc2bdc ("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>

parent 4a7f4110

drivers/base/property.c

+2 −2

Original line number	Diff line number	Diff line
		@@ -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.

include/linux/property.h

+2 −1

Original line number	Diff line number	Diff line
		@@ -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)