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>
25  * struct v4l2_fwnode_endpoint - the endpoint data structure
55  * V4L2_FWNODE_PROPERTY_UNSET - identify a non initialized property
60 #define V4L2_FWNODE_PROPERTY_UNSET   (-1U)
63  * enum v4l2_fwnode_orientation - possible device orientation
75  * struct v4l2_fwnode_device_properties - fwnode device properties
85  * struct v4l2_fwnode_link - a link between two endpoints
103  * enum v4l2_connector_type - connector type
104  * @V4L2_CONN_UNKNOWN:   unknown connector type, no V4L2 connector configuration
105  * @V4L2_CONN_COMPOSITE: analog composite connector
106  * @V4L2_CONN_SVIDEO:    analog svideo connector
115  * struct v4l2_connector_link - connector link data structure
118  * @fwnode_link: &struct v4l2_fwnode_link link between the connector and the
119  *               device the connector belongs to.
127  * struct v4l2_fwnode_connector_analog - analog connector data structure
128  * @sdtv_stds: sdtv standards this connector supports, set to V4L2_STD_ALL
136  * struct v4l2_fwnode_connector - the connector data structure
137  * @name: the connector device name
138  * @label: optional connector label
139  * @type: connector type
140  * @links: list of all connector &struct v4l2_connector_link links
142  * @connector: connector configuration
143  * @connector.analog: analog connector configuration
156 	} connector;  member
160  * enum v4l2_fwnode_bus_type - Video bus types defined by firmware properties
161  * @V4L2_FWNODE_BUS_TYPE_GUESS: Default value if no bus-type fwnode property
162  * @V4L2_FWNODE_BUS_TYPE_CSI2_CPHY: MIPI CSI-2 bus, C-PHY physical layer
163  * @V4L2_FWNODE_BUS_TYPE_CSI1: MIPI CSI-1 bus
165  * @V4L2_FWNODE_BUS_TYPE_CSI2_DPHY: MIPI CSI-2 bus, D-PHY physical layer
167  * @V4L2_FWNODE_BUS_TYPE_BT656: BT.656 video format bus-type
168  * @V4L2_FWNODE_BUS_TYPE_DPI: Video Parallel Interface bus
169  * @NR_OF_V4L2_FWNODE_BUS_TYPE: Number of bus-types
184  * v4l2_fwnode_endpoint_parse() - parse all fwnode node properties
194  * When @vep.bus_type is V4L2_MBUS_UNKNOWN, the function will use the "bus-type"
199  * As a deprecated functionality to support older DT bindings without "bus-type"
200  * property for devices that support multiple types, if the "bus-type" property
207  * bus, and it will return an error if the value of the "bus-type" property
215  * NOTE: This function does not parse "link-frequencies" property as its size is
220  *	   %-ENOMEM on memory allocation failure
221  *	   %-EINVAL on parsing failure
222  *	   %-ENXIO on mismatching bus types
228  * v4l2_fwnode_endpoint_free() - free the V4L2 fwnode acquired by
238  * v4l2_fwnode_endpoint_alloc_parse() - parse all fwnode node properties
248  * When @vep.bus_type is V4L2_MBUS_UNKNOWN, the function will use the "bus-type"
253  * As a deprecated functionality to support older DT bindings without "bus-type"
254  * property for devices that support multiple types, if the "bus-type" property
261  * bus, and it will return an error if the value of the "bus-type" property
278  *	   %-ENOMEM on memory allocation failure
279  *	   %-EINVAL on parsing failure
280  *	   %-ENXIO on mismatching bus types
286  * v4l2_fwnode_parse_link() - parse a link between two endpoints
294  * grand-parent node of the port node otherwise).
300  * Return: 0 on success, or -ENOLINK if the remote endpoint fwnode can't be
307  * v4l2_fwnode_put_link() - drop references to nodes in a link
316  * v4l2_fwnode_connector_free() - free the V4L2 connector acquired memory
317  * @connector: the V4L2 connector resources of which are to be released
322  * It is safe to call this function with NULL argument or on a V4L2 connector
325 void v4l2_fwnode_connector_free(struct v4l2_fwnode_connector *connector);
328  * v4l2_fwnode_connector_parse() - initialize the 'struct v4l2_fwnode_connector'
329  * @fwnode: pointer to the subdev endpoint's fwnode handle where the connector
330  *	    is connected to or to the connector endpoint fwnode handle.
331  * @connector: pointer to the V4L2 fwnode connector data structure
333  * Fill the &struct v4l2_fwnode_connector with the connector type, label and
334  * all &enum v4l2_connector_type specific connector data. The label is optional
336  * to zero. Adding links to the connector is done by calling
344  * * %-EINVAL if @fwnode is invalid
345  * * %-ENOTCONN if connector type is unknown or connector device can't be found
348 				struct v4l2_fwnode_connector *connector);
351  * v4l2_fwnode_connector_add_link - add a link between a connector node and
352  *				    a v4l2-subdev node.
353  * @fwnode: pointer to the subdev endpoint's fwnode handle where the connector
355  * @connector: pointer to the V4L2 fwnode connector data structure
358  * &struct v4l2_fwnode_connector connector links list. The link local_node
359  * points to the connector node, the remote_node to the host v4l2 (sub)dev.
367  * * %-EINVAL if @fwnode or @connector is invalid or @connector type is unknown
368  * * %-ENOMEM on link memory allocation failure
369  * * %-ENOTCONN if remote connector device can't be found
370  * * %-ENOLINK if link parsing between v4l2 (sub)dev and connector fails
373 				   struct v4l2_fwnode_connector *connector);
376  * v4l2_fwnode_device_parse() - parse fwnode device properties
387  *	%-EINVAL if a parsed property value is not valid
392 /* Helper macros to access the connector links. */
394 /** v4l2_connector_last_link - Helper macro to get the first
396  * @v4l2c: &struct v4l2_fwnode_connector owning the connector links
398  * This marco returns the first added &struct v4l2_connector_link connector
399  * link or @NULL if the connector has no links.
402 	list_first_entry_or_null(&(v4l2c)->links,			       \
405 /** v4l2_connector_last_link - Helper macro to get the last
407  * @v4l2c: &struct v4l2_fwnode_connector owning the connector links
409  * This marco returns the last &struct v4l2_connector_link added connector link.
412 	list_last_entry(&(v4l2c)->links, struct v4l2_connector_link, head)