include/media/v4l2-fwnode.h

1 /* SPDX-License-Identifier: GPL-2.0-only */
8  * Copyright (C) 2012 - 2013 Samsung Electronics Co., Ltd.
22 #include <media/v4l2-mediabus.h>
31  * struct v4l2_fwnode_bus_mipi_csi2 - MIPI CSI-2 bus data structure
48  * struct v4l2_fwnode_bus_parallel - parallel data bus data structure
60  * struct v4l2_fwnode_bus_mipi_csi1 - CSI-1/CCP2 data bus structure
62  *	       false - not inverted, true - inverted
63  * @strobe: false - data/clock, true - data/strobe
78  * struct v4l2_fwnode_endpoint - the endpoint data structure
112  * V4L2_FWNODE_PROPERTY_UNSET - identify a non initialized property
117 #define V4L2_FWNODE_PROPERTY_UNSET   (-1U)
120  * enum v4l2_fwnode_orientation - possible device orientation
132  * struct v4l2_fwnode_device_properties - fwnode device properties
142  * struct v4l2_fwnode_link - a link between two endpoints
160  * enum v4l2_connector_type - connector type
172  * struct v4l2_connector_link - connector link data structure
184  * struct v4l2_fwnode_connector_analog - analog connector data structure
193  * struct v4l2_fwnode_connector - the connector data structure
197  * @links: list of all connector &struct v4l2_connector_link links
198  * @nr_of_links: total number of links
207 	struct list_head links;  member
217  * v4l2_fwnode_endpoint_parse() - parse all fwnode node properties
224  * endpoint --- a configuration that shall be in line with the DT binding
226  * call this function once the correct type is found --- with a default
230  * FEATURE REQUIRES "bus-type" PROPERTY IN DT BINDINGS. For old drivers,
231  * guessing @vep.bus_type between CSI-2 D-PHY, parallel and BT.656 busses is
237  * without a low fixed limit. Please use v4l2_fwnode_endpoint_alloc_parse() in
241  *	   %-ENOMEM on memory allocation failure
242  *	   %-EINVAL on parsing failure
243  *	   %-ENXIO on mismatching bus types
249  * v4l2_fwnode_endpoint_free() - free the V4L2 fwnode acquired by
259  * v4l2_fwnode_endpoint_alloc_parse() - parse all fwnode node properties
266  * endpoint --- a configuration that shall be in line with the DT binding
268  * call this function once the correct type is found --- with a default
272  * FEATURE REQUIRES "bus-type" PROPERTY IN DT BINDINGS. For old drivers,
273  * guessing @vep.bus_type between CSI-2 D-PHY, parallel and BT.656 busses is
287  *	   %-ENOMEM on memory allocation failure
288  *	   %-EINVAL on parsing failure
289  *	   %-ENXIO on mismatching bus types
295  * v4l2_fwnode_parse_link() - parse a link between two endpoints
303  * grand-parent node of the port node otherwise).
309  * Return: 0 on success, or -ENOLINK if the remote endpoint fwnode can't be
316  * v4l2_fwnode_put_link() - drop references to nodes in a link
325  * v4l2_fwnode_connector_free() - free the V4L2 connector acquired memory
328  * Free all allocated memory and put all links acquired by
337  * v4l2_fwnode_connector_parse() - initialize the 'struct v4l2_fwnode_connector'
344  * so it is set to %NULL if no one was found. The function initialize the links
345  * to zero. Adding links to the connector is done by calling
353  * * %-EINVAL if @fwnode is invalid
354  * * %-ENOTCONN if connector type is unknown or connector device can't be found
360  * v4l2_fwnode_connector_add_link - add a link between a connector node and
361  *				    a v4l2-subdev node.
367  * &struct v4l2_fwnode_connector connector links list. The link local_node
376  * * %-EINVAL if @fwnode or @connector is invalid or @connector type is unknown
377  * * %-ENOMEM on link memory allocation failure
378  * * %-ENOTCONN if remote connector device can't be found
379  * * %-ENOLINK if link parsing between v4l2 (sub)dev and connector fails
385  * v4l2_fwnode_device_parse() - parse fwnode device properties
396  *	%-EINVAL if a parsed property value is not valid
402  * typedef parse_endpoint_func - Driver's callback function to be called on
411  * * %-ENOTCONN if the endpoint is to be skipped but this
413  * * %-EINVAL if the endpoint configuration is invalid
420  * v4l2_async_notifier_parse_fwnode_endpoints - Parse V4L2 fwnode endpoints in a
424  * @asd_struct_size: size of the driver's async sub-device struct, including
427  *		     the driver's async sub-device struct, i.e. both
432  * Parse the fwnode endpoints of the @dev device and populate the async sub-
434  * called for each endpoint with the corresponding async sub-device pointer to
435  * let the caller initialize the driver-specific part of the async sub-device
450  * sub-devices are no longer in use, even if the function returned an error.
452  * Return: %0 on success, including when no async sub-devices are found
453  *	   %-ENOMEM if memory allocation failed
454  *	   %-EINVAL if graph or endpoint parsing failed
464  * v4l2_async_notifier_parse_fwnode_endpoints_by_port - Parse V4L2 fwnode
469  * @asd_struct_size: size of the driver's async sub-device struct, including
472  *		     the driver's async sub-device struct, i.e. both
480  * on devices that have both sinks and sources: the async sub-devices connected
485  * the async sub-devices list of the notifier. The @parse_endpoint callback
486  * function is called for each endpoint with the corresponding async sub-device
487  * pointer to let the caller initialize the driver-specific part of the async
488  * sub-device structure.
502  * sub-devices are no longer in use, even if the function returned an error.
504  * Return: %0 on success, including when no async sub-devices are found
505  *	   %-ENOMEM if memory allocation failed
506  *	   %-EINVAL if graph or endpoint parsing failed
517  * v4l2_fwnode_reference_parse_sensor_common - parse common references on
518  *					       sensors for async sub-devices
523  * sensor and set up async sub-devices for them.
527  * sub-devices are no longer in use, even in the case the function returned an
531  *	   -ENOMEM if memory allocation failed
532  *	   -EINVAL if property parsing failed
537 /* Helper macros to access the connector links. */
539 /** v4l2_connector_last_link - Helper macro to get the first
541  * @v4l2c: &struct v4l2_fwnode_connector owning the connector links
544  * link or @NULL if the connector has no links.
547 	list_first_entry_or_null(&(v4l2c)->links,			       \
550 /** v4l2_connector_last_link - Helper macro to get the last
552  * @v4l2c: &struct v4l2_fwnode_connector owning the connector links
557 	list_last_entry(&(v4l2c)->links, struct v4l2_connector_link, head)