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
27  * @bus_type: bus type
28  * @bus: bus configuration data structure
29  * @bus.parallel: embedded &struct v4l2_mbus_config_parallel.
30  *		  Used if the bus is parallel.
31  * @bus.mipi_csi1: embedded &struct v4l2_mbus_config_mipi_csi1.
32  *		   Used if the bus is MIPI Alliance's Camera Serial
36  * @bus.mipi_csi2: embedded &struct v4l2_mbus_config_mipi_csi2.
37  *		   Used if the bus is MIPI Alliance's Camera Serial
49 	} bus;  member
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
89  * @remote_node: pointer to device_node of the remote endpoint
90  * @remote_port: identifier of the port the remote endpoint belongs to
91  * @remote_id: identifier of the id the remote endpoint belongs to
103  * enum v4l2_connector_type - connector type
115  * struct v4l2_connector_link - connector link data structure
127  * struct v4l2_fwnode_connector_analog - analog connector data structure
136  * struct v4l2_fwnode_connector - the connector data structure
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
164  * @V4L2_FWNODE_BUS_TYPE_CCP2: SMIA Compact Camera Port 2 bus
165  * @V4L2_FWNODE_BUS_TYPE_CSI2_DPHY: MIPI CSI-2 bus, D-PHY physical layer
166  * @V4L2_FWNODE_BUS_TYPE_PARALLEL: Camera Parallel Interface bus
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
190  * obtain the type of the bus (by setting the @vep.bus_type field to
191  * V4L2_MBUS_UNKNOWN) or specifying the bus type explicitly to one of the &enum
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
202  * endpoint properties available. NEVER RELY ON GUESSING THE BUS TYPE IN NEW
205  * It is also possible to set @vep.bus_type corresponding to an actual bus. In
207  * bus, and it will return an error if the value of the "bus-type" property
208  * corresponds to a different bus.
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
244  * obtain the type of the bus (by setting the @vep.bus_type field to
245  * V4L2_MBUS_UNKNOWN) or specifying the bus type explicitly to one of the &enum
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
256  * endpoint properties available. NEVER RELY ON GUESSING THE BUS TYPE IN NEW
259  * It is also possible to set @vep.bus_type corresponding to an actual bus. In
261  * bus, and it will return an error if the value of the "bus-type" property
262  * corresponds to a different bus.
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
290  * Fill the link structure with the local and remote nodes and port numbers.
292  * remote port's parent nodes respectively (the port parent node being the
294  * grand-parent node of the port node otherwise).
296  * A reference is taken to both the local and remote nodes, the caller must use
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
310  * Drop references to the local and remote nodes in the link. This function
316  * v4l2_fwnode_connector_free() - free the V4L2 connector acquired memory
328  * v4l2_fwnode_connector_parse() - initialize the 'struct v4l2_fwnode_connector'
344  * * %-EINVAL if @fwnode is invalid
345  * * %-ENOTCONN if connector type is unknown or connector device can't be found
351  * v4l2_fwnode_connector_add_link - add a link between a connector node and
352  *				    a v4l2-subdev node.
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
376  * v4l2_fwnode_device_parse() - parse fwnode device properties
387  *	%-EINVAL if a parsed property value is not valid
394 /** v4l2_connector_last_link - Helper macro to get the first
402 	list_first_entry_or_null(&(v4l2c)->links,			       \
405 /** v4l2_connector_last_link - Helper macro to get the last
412 	list_last_entry(&(v4l2c)->links, struct v4l2_connector_link, head)