1 /* SPDX-License-Identifier: GPL-2.0-only */ 1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /* 2 /*
3 * V4L2 fwnode binding parsing library 3 * V4L2 fwnode binding parsing library
4 * 4 *
5 * Copyright (c) 2016 Intel Corporation. 5 * Copyright (c) 2016 Intel Corporation.
6 * Author: Sakari Ailus <sakari.ailus@linux.in 6 * Author: Sakari Ailus <sakari.ailus@linux.intel.com>
7 * 7 *
8 * Copyright (C) 2012 - 2013 Samsung Electroni 8 * Copyright (C) 2012 - 2013 Samsung Electronics Co., Ltd.
9 * Author: Sylwester Nawrocki <s.nawrocki@sams 9 * Author: Sylwester Nawrocki <s.nawrocki@samsung.com>
10 * 10 *
11 * Copyright (C) 2012 Renesas Electronics Corp 11 * Copyright (C) 2012 Renesas Electronics Corp.
12 * Author: Guennadi Liakhovetski <g.liakhovets 12 * Author: Guennadi Liakhovetski <g.liakhovetski@gmx.de>
13 */ 13 */
14 #ifndef _V4L2_FWNODE_H 14 #ifndef _V4L2_FWNODE_H
15 #define _V4L2_FWNODE_H 15 #define _V4L2_FWNODE_H
16 16
17 #include <linux/errno.h> 17 #include <linux/errno.h>
18 #include <linux/fwnode.h> 18 #include <linux/fwnode.h>
19 #include <linux/list.h> 19 #include <linux/list.h>
20 #include <linux/types.h> 20 #include <linux/types.h>
21 21
22 #include <media/v4l2-mediabus.h> 22 #include <media/v4l2-mediabus.h>
>> 23 #include <media/v4l2-subdev.h>
>> 24
>> 25 struct fwnode_handle;
>> 26 struct v4l2_async_notifier;
>> 27 struct v4l2_async_subdev;
>> 28
>> 29 #define V4L2_FWNODE_CSI2_MAX_DATA_LANES 4
>> 30
>> 31 /**
>> 32 * struct v4l2_fwnode_bus_mipi_csi2 - MIPI CSI-2 bus data structure
>> 33 * @flags: media bus (V4L2_MBUS_*) flags
>> 34 * @data_lanes: an array of physical data lane indexes
>> 35 * @clock_lane: physical lane index of the clock lane
>> 36 * @num_data_lanes: number of data lanes
>> 37 * @lane_polarities: polarity of the lanes. The order is the same of
>> 38 * the physical lanes.
>> 39 */
>> 40 struct v4l2_fwnode_bus_mipi_csi2 {
>> 41 unsigned int flags;
>> 42 unsigned char data_lanes[V4L2_FWNODE_CSI2_MAX_DATA_LANES];
>> 43 unsigned char clock_lane;
>> 44 unsigned short num_data_lanes;
>> 45 bool lane_polarities[1 + V4L2_FWNODE_CSI2_MAX_DATA_LANES];
>> 46 };
>> 47
>> 48 /**
>> 49 * struct v4l2_fwnode_bus_parallel - parallel data bus data structure
>> 50 * @flags: media bus (V4L2_MBUS_*) flags
>> 51 * @bus_width: bus width in bits
>> 52 * @data_shift: data shift in bits
>> 53 */
>> 54 struct v4l2_fwnode_bus_parallel {
>> 55 unsigned int flags;
>> 56 unsigned char bus_width;
>> 57 unsigned char data_shift;
>> 58 };
>> 59
>> 60 /**
>> 61 * struct v4l2_fwnode_bus_mipi_csi1 - CSI-1/CCP2 data bus structure
>> 62 * @clock_inv: polarity of clock/strobe signal
>> 63 * false - not inverted, true - inverted
>> 64 * @strobe: false - data/clock, true - data/strobe
>> 65 * @lane_polarity: the polarities of the clock (index 0) and data lanes
>> 66 * index (1)
>> 67 * @data_lane: the number of the data lane
>> 68 * @clock_lane: the number of the clock lane
>> 69 */
>> 70 struct v4l2_fwnode_bus_mipi_csi1 {
>> 71 unsigned char clock_inv:1;
>> 72 unsigned char strobe:1;
>> 73 bool lane_polarity[2];
>> 74 unsigned char data_lane;
>> 75 unsigned char clock_lane;
>> 76 };
23 77
24 /** 78 /**
25 * struct v4l2_fwnode_endpoint - the endpoint 79 * struct v4l2_fwnode_endpoint - the endpoint data structure
26 * @base: fwnode endpoint of the v4l2_fwnode 80 * @base: fwnode endpoint of the v4l2_fwnode
27 * @bus_type: bus type 81 * @bus_type: bus type
28 * @bus: bus configuration data structure !! 82 * @bus: union with bus configuration data structure
29 * @bus.parallel: embedded &struct v4l2_mbus_c !! 83 * @bus.parallel: embedded &struct v4l2_fwnode_bus_parallel.
30 * Used if the bus is parallel. 84 * Used if the bus is parallel.
31 * @bus.mipi_csi1: embedded &struct v4l2_mbus_ !! 85 * @bus.mipi_csi1: embedded &struct v4l2_fwnode_bus_mipi_csi1.
32 * Used if the bus is MIPI All 86 * Used if the bus is MIPI Alliance's Camera Serial
33 * Interface version 1 (MIPI C 87 * Interface version 1 (MIPI CSI1) or Standard
34 * Mobile Imaging Architecture 88 * Mobile Imaging Architecture's Compact Camera Port 2
35 * (SMIA CCP2). 89 * (SMIA CCP2).
36 * @bus.mipi_csi2: embedded &struct v4l2_mbus_ !! 90 * @bus.mipi_csi2: embedded &struct v4l2_fwnode_bus_mipi_csi2.
37 * Used if the bus is MIPI All 91 * Used if the bus is MIPI Alliance's Camera Serial
38 * Interface version 2 (MIPI C 92 * Interface version 2 (MIPI CSI2).
39 * @link_frequencies: array of supported link 93 * @link_frequencies: array of supported link frequencies
40 * @nr_of_link_frequencies: number of elements 94 * @nr_of_link_frequencies: number of elements in link_frequenccies array
41 */ 95 */
42 struct v4l2_fwnode_endpoint { 96 struct v4l2_fwnode_endpoint {
43 struct fwnode_endpoint base; 97 struct fwnode_endpoint base;
>> 98 /*
>> 99 * Fields below this line will be zeroed by
>> 100 * v4l2_fwnode_endpoint_parse()
>> 101 */
44 enum v4l2_mbus_type bus_type; 102 enum v4l2_mbus_type bus_type;
45 struct { !! 103 union {
46 struct v4l2_mbus_config_parall !! 104 struct v4l2_fwnode_bus_parallel parallel;
47 struct v4l2_mbus_config_mipi_c !! 105 struct v4l2_fwnode_bus_mipi_csi1 mipi_csi1;
48 struct v4l2_mbus_config_mipi_c !! 106 struct v4l2_fwnode_bus_mipi_csi2 mipi_csi2;
49 } bus; 107 } bus;
50 u64 *link_frequencies; 108 u64 *link_frequencies;
51 unsigned int nr_of_link_frequencies; 109 unsigned int nr_of_link_frequencies;
52 }; 110 };
53 111
54 /** 112 /**
55 * V4L2_FWNODE_PROPERTY_UNSET - identify a non <<
56 * <<
57 * All properties in &struct v4l2_fwnode_devic <<
58 * to this value. <<
59 */ <<
60 #define V4L2_FWNODE_PROPERTY_UNSET (-1U) <<
61 <<
62 /** <<
63 * enum v4l2_fwnode_orientation - possible dev <<
64 * @V4L2_FWNODE_ORIENTATION_FRONT: device inst <<
65 * @V4L2_FWNODE_ORIENTATION_BACK: device insta <<
66 * @V4L2_FWNODE_ORIENTATION_EXTERNAL: device e <<
67 */ <<
68 enum v4l2_fwnode_orientation { <<
69 V4L2_FWNODE_ORIENTATION_FRONT, <<
70 V4L2_FWNODE_ORIENTATION_BACK, <<
71 V4L2_FWNODE_ORIENTATION_EXTERNAL <<
72 }; <<
73 <<
74 /** <<
75 * struct v4l2_fwnode_device_properties - fwno <<
76 * @orientation: device orientation. See &enum <<
77 * @rotation: device rotation <<
78 */ <<
79 struct v4l2_fwnode_device_properties { <<
80 enum v4l2_fwnode_orientation orientati <<
81 unsigned int rotation; <<
82 }; <<
83 <<
84 /** <<
85 * struct v4l2_fwnode_link - a link between tw 113 * struct v4l2_fwnode_link - a link between two endpoints
86 * @local_node: pointer to device_node of this 114 * @local_node: pointer to device_node of this endpoint
87 * @local_port: identifier of the port this en 115 * @local_port: identifier of the port this endpoint belongs to
88 * @local_id: identifier of the id this endpoi 116 * @local_id: identifier of the id this endpoint belongs to
89 * @remote_node: pointer to device_node of the 117 * @remote_node: pointer to device_node of the remote endpoint
90 * @remote_port: identifier of the port the re 118 * @remote_port: identifier of the port the remote endpoint belongs to
91 * @remote_id: identifier of the id the remote 119 * @remote_id: identifier of the id the remote endpoint belongs to
92 */ 120 */
93 struct v4l2_fwnode_link { 121 struct v4l2_fwnode_link {
94 struct fwnode_handle *local_node; 122 struct fwnode_handle *local_node;
95 unsigned int local_port; 123 unsigned int local_port;
96 unsigned int local_id; 124 unsigned int local_id;
97 struct fwnode_handle *remote_node; 125 struct fwnode_handle *remote_node;
98 unsigned int remote_port; 126 unsigned int remote_port;
99 unsigned int remote_id; 127 unsigned int remote_id;
100 }; 128 };
101 129
102 /** 130 /**
103 * enum v4l2_connector_type - connector type 131 * enum v4l2_connector_type - connector type
104 * @V4L2_CONN_UNKNOWN: unknown connector typ 132 * @V4L2_CONN_UNKNOWN: unknown connector type, no V4L2 connector configuration
105 * @V4L2_CONN_COMPOSITE: analog composite conn 133 * @V4L2_CONN_COMPOSITE: analog composite connector
106 * @V4L2_CONN_SVIDEO: analog svideo connect 134 * @V4L2_CONN_SVIDEO: analog svideo connector
107 */ 135 */
108 enum v4l2_connector_type { 136 enum v4l2_connector_type {
109 V4L2_CONN_UNKNOWN, 137 V4L2_CONN_UNKNOWN,
110 V4L2_CONN_COMPOSITE, 138 V4L2_CONN_COMPOSITE,
111 V4L2_CONN_SVIDEO, 139 V4L2_CONN_SVIDEO,
112 }; 140 };
113 141
114 /** 142 /**
115 * struct v4l2_connector_link - connector link 143 * struct v4l2_connector_link - connector link data structure
116 * @head: structure to be used to add the link 144 * @head: structure to be used to add the link to the
117 * &struct v4l2_fwnode_connector 145 * &struct v4l2_fwnode_connector
118 * @fwnode_link: &struct v4l2_fwnode_link link 146 * @fwnode_link: &struct v4l2_fwnode_link link between the connector and the
119 * device the connector belongs 147 * device the connector belongs to.
120 */ 148 */
121 struct v4l2_connector_link { 149 struct v4l2_connector_link {
122 struct list_head head; 150 struct list_head head;
123 struct v4l2_fwnode_link fwnode_link; 151 struct v4l2_fwnode_link fwnode_link;
124 }; 152 };
125 153
126 /** 154 /**
127 * struct v4l2_fwnode_connector_analog - analo 155 * struct v4l2_fwnode_connector_analog - analog connector data structure
128 * @sdtv_stds: sdtv standards this connector s 156 * @sdtv_stds: sdtv standards this connector supports, set to V4L2_STD_ALL
129 * if no restrictions are specifie 157 * if no restrictions are specified.
130 */ 158 */
131 struct v4l2_fwnode_connector_analog { 159 struct v4l2_fwnode_connector_analog {
132 v4l2_std_id sdtv_stds; 160 v4l2_std_id sdtv_stds;
133 }; 161 };
134 162
135 /** 163 /**
136 * struct v4l2_fwnode_connector - the connecto 164 * struct v4l2_fwnode_connector - the connector data structure
137 * @name: the connector device name 165 * @name: the connector device name
138 * @label: optional connector label 166 * @label: optional connector label
139 * @type: connector type 167 * @type: connector type
140 * @links: list of all connector &struct v4l2_ 168 * @links: list of all connector &struct v4l2_connector_link links
141 * @nr_of_links: total number of links 169 * @nr_of_links: total number of links
142 * @connector: connector configuration 170 * @connector: connector configuration
143 * @connector.analog: analog connector configu 171 * @connector.analog: analog connector configuration
144 * &struct v4l2_fwnode_conn 172 * &struct v4l2_fwnode_connector_analog
145 */ 173 */
146 struct v4l2_fwnode_connector { 174 struct v4l2_fwnode_connector {
147 const char *name; 175 const char *name;
148 const char *label; 176 const char *label;
149 enum v4l2_connector_type type; 177 enum v4l2_connector_type type;
150 struct list_head links; 178 struct list_head links;
151 unsigned int nr_of_links; 179 unsigned int nr_of_links;
152 180
153 union { 181 union {
154 struct v4l2_fwnode_connector_a 182 struct v4l2_fwnode_connector_analog analog;
155 /* future connectors */ 183 /* future connectors */
156 } connector; 184 } connector;
157 }; 185 };
158 186
159 /** 187 /**
160 * enum v4l2_fwnode_bus_type - Video bus types <<
161 * @V4L2_FWNODE_BUS_TYPE_GUESS: Default value <<
162 * @V4L2_FWNODE_BUS_TYPE_CSI2_CPHY: MIPI CSI-2 <<
163 * @V4L2_FWNODE_BUS_TYPE_CSI1: MIPI CSI-1 bus <<
164 * @V4L2_FWNODE_BUS_TYPE_CCP2: SMIA Compact Ca <<
165 * @V4L2_FWNODE_BUS_TYPE_CSI2_DPHY: MIPI CSI-2 <<
166 * @V4L2_FWNODE_BUS_TYPE_PARALLEL: Camera Para <<
167 * @V4L2_FWNODE_BUS_TYPE_BT656: BT.656 video f <<
168 * @V4L2_FWNODE_BUS_TYPE_DPI: Video Parallel I <<
169 * @NR_OF_V4L2_FWNODE_BUS_TYPE: Number of bus- <<
170 */ <<
171 enum v4l2_fwnode_bus_type { <<
172 V4L2_FWNODE_BUS_TYPE_GUESS = 0, <<
173 V4L2_FWNODE_BUS_TYPE_CSI2_CPHY, <<
174 V4L2_FWNODE_BUS_TYPE_CSI1, <<
175 V4L2_FWNODE_BUS_TYPE_CCP2, <<
176 V4L2_FWNODE_BUS_TYPE_CSI2_DPHY, <<
177 V4L2_FWNODE_BUS_TYPE_PARALLEL, <<
178 V4L2_FWNODE_BUS_TYPE_BT656, <<
179 V4L2_FWNODE_BUS_TYPE_DPI, <<
180 NR_OF_V4L2_FWNODE_BUS_TYPE <<
181 }; <<
182 <<
183 /** <<
184 * v4l2_fwnode_endpoint_parse() - parse all fw 188 * v4l2_fwnode_endpoint_parse() - parse all fwnode node properties
185 * @fwnode: pointer to the endpoint's fwnode h 189 * @fwnode: pointer to the endpoint's fwnode handle
186 * @vep: pointer to the V4L2 fwnode data struc 190 * @vep: pointer to the V4L2 fwnode data structure
187 * 191 *
188 * This function parses the V4L2 fwnode endpoi 192 * This function parses the V4L2 fwnode endpoint specific parameters from the
189 * firmware. There are two ways to use this fu !! 193 * firmware. The caller is responsible for assigning @vep.bus_type to a valid
190 * obtain the type of the bus (by setting the !! 194 * media bus type. The caller may also set the default configuration for the
191 * V4L2_MBUS_UNKNOWN) or specifying the bus ty !! 195 * endpoint --- a configuration that shall be in line with the DT binding
192 * v4l2_mbus_type types. !! 196 * documentation. Should a device support multiple bus types, the caller may
193 * !! 197 * call this function once the correct type is found --- with a default
194 * When @vep.bus_type is V4L2_MBUS_UNKNOWN, th !! 198 * configuration valid for that type.
195 * property to determine the type when it is a !! 199 *
196 * responsible for validating the contents of !! 200 * As a compatibility means guessing the bus type is also supported by setting
197 * returns. !! 201 * @vep.bus_type to V4L2_MBUS_UNKNOWN. The caller may not provide a default
198 * !! 202 * configuration in this case as the defaults are specific to a given bus type.
199 * As a deprecated functionality to support ol !! 203 * This functionality is deprecated and should not be used in new drivers and it
200 * property for devices that support multiple !! 204 * is only supported for CSI-2 D-PHY, parallel and Bt.656 buses.
201 * does not exist, the function will attempt t <<
202 * endpoint properties available. NEVER RELY O <<
203 * DRIVERS OR BINDINGS. <<
204 * <<
205 * It is also possible to set @vep.bus_type co <<
206 * this case the function will only attempt to <<
207 * bus, and it will return an error if the val <<
208 * corresponds to a different bus. <<
209 * <<
210 * The caller is required to initialise all fi <<
211 * explicitly values, or by zeroing them. <<
212 * 205 *
213 * The function does not change the V4L2 fwnod 206 * The function does not change the V4L2 fwnode endpoint state if it fails.
214 * 207 *
215 * NOTE: This function does not parse "link-fr !! 208 * NOTE: This function does not parse properties the size of which is variable
216 * not known in advance. Please use v4l2_fwnod !! 209 * without a low fixed limit. Please use v4l2_fwnode_endpoint_alloc_parse() in
217 * need properties of variable size. !! 210 * new drivers instead.
218 * 211 *
219 * Return: %0 on success or a negative error c 212 * Return: %0 on success or a negative error code on failure:
220 * %-ENOMEM on memory allocation failu 213 * %-ENOMEM on memory allocation failure
221 * %-EINVAL on parsing failure 214 * %-EINVAL on parsing failure
222 * %-ENXIO on mismatching bus types 215 * %-ENXIO on mismatching bus types
223 */ 216 */
224 int v4l2_fwnode_endpoint_parse(struct fwnode_h 217 int v4l2_fwnode_endpoint_parse(struct fwnode_handle *fwnode,
225 struct v4l2_fwn 218 struct v4l2_fwnode_endpoint *vep);
226 219
227 /** 220 /**
228 * v4l2_fwnode_endpoint_free() - free the V4L2 221 * v4l2_fwnode_endpoint_free() - free the V4L2 fwnode acquired by
229 * v4l2_fwnode_endpoint_alloc_parse() 222 * v4l2_fwnode_endpoint_alloc_parse()
230 * @vep: the V4L2 fwnode the resources of whic 223 * @vep: the V4L2 fwnode the resources of which are to be released
231 * 224 *
232 * It is safe to call this function with NULL 225 * It is safe to call this function with NULL argument or on a V4L2 fwnode the
233 * parsing of which failed. 226 * parsing of which failed.
234 */ 227 */
235 void v4l2_fwnode_endpoint_free(struct v4l2_fwn 228 void v4l2_fwnode_endpoint_free(struct v4l2_fwnode_endpoint *vep);
236 229
237 /** 230 /**
238 * v4l2_fwnode_endpoint_alloc_parse() - parse 231 * v4l2_fwnode_endpoint_alloc_parse() - parse all fwnode node properties
239 * @fwnode: pointer to the endpoint's fwnode h 232 * @fwnode: pointer to the endpoint's fwnode handle
240 * @vep: pointer to the V4L2 fwnode data struc 233 * @vep: pointer to the V4L2 fwnode data structure
241 * 234 *
242 * This function parses the V4L2 fwnode endpoi 235 * This function parses the V4L2 fwnode endpoint specific parameters from the
243 * firmware. There are two ways to use this fu !! 236 * firmware. The caller is responsible for assigning @vep.bus_type to a valid
244 * obtain the type of the bus (by setting the !! 237 * media bus type. The caller may also set the default configuration for the
245 * V4L2_MBUS_UNKNOWN) or specifying the bus ty !! 238 * endpoint --- a configuration that shall be in line with the DT binding
246 * v4l2_mbus_type types. !! 239 * documentation. Should a device support multiple bus types, the caller may
247 * !! 240 * call this function once the correct type is found --- with a default
248 * When @vep.bus_type is V4L2_MBUS_UNKNOWN, th !! 241 * configuration valid for that type.
249 * property to determine the type when it is a !! 242 *
250 * responsible for validating the contents of !! 243 * As a compatibility means guessing the bus type is also supported by setting
251 * returns. !! 244 * @vep.bus_type to V4L2_MBUS_UNKNOWN. The caller may not provide a default
252 * !! 245 * configuration in this case as the defaults are specific to a given bus type.
253 * As a deprecated functionality to support ol !! 246 * This functionality is deprecated and should not be used in new drivers and it
254 * property for devices that support multiple !! 247 * is only supported for CSI-2 D-PHY, parallel and Bt.656 buses.
255 * does not exist, the function will attempt t <<
256 * endpoint properties available. NEVER RELY O <<
257 * DRIVERS OR BINDINGS. <<
258 * <<
259 * It is also possible to set @vep.bus_type co <<
260 * this case the function will only attempt to <<
261 * bus, and it will return an error if the val <<
262 * corresponds to a different bus. <<
263 * <<
264 * The caller is required to initialise all fi <<
265 * explicitly values, or by zeroing them. <<
266 * 248 *
267 * The function does not change the V4L2 fwnod 249 * The function does not change the V4L2 fwnode endpoint state if it fails.
268 * 250 *
269 * v4l2_fwnode_endpoint_alloc_parse() has two 251 * v4l2_fwnode_endpoint_alloc_parse() has two important differences to
270 * v4l2_fwnode_endpoint_parse(): 252 * v4l2_fwnode_endpoint_parse():
271 * 253 *
272 * 1. It also parses variable size data. 254 * 1. It also parses variable size data.
273 * 255 *
274 * 2. The memory it has allocated to store the 256 * 2. The memory it has allocated to store the variable size data must be freed
275 * using v4l2_fwnode_endpoint_free() when n 257 * using v4l2_fwnode_endpoint_free() when no longer needed.
276 * 258 *
277 * Return: %0 on success or a negative error c 259 * Return: %0 on success or a negative error code on failure:
278 * %-ENOMEM on memory allocation failu 260 * %-ENOMEM on memory allocation failure
279 * %-EINVAL on parsing failure 261 * %-EINVAL on parsing failure
280 * %-ENXIO on mismatching bus types 262 * %-ENXIO on mismatching bus types
281 */ 263 */
282 int v4l2_fwnode_endpoint_alloc_parse(struct fw 264 int v4l2_fwnode_endpoint_alloc_parse(struct fwnode_handle *fwnode,
283 struct v4 265 struct v4l2_fwnode_endpoint *vep);
284 266
285 /** 267 /**
286 * v4l2_fwnode_parse_link() - parse a link bet 268 * v4l2_fwnode_parse_link() - parse a link between two endpoints
287 * @fwnode: pointer to the endpoint's fwnode a 269 * @fwnode: pointer to the endpoint's fwnode at the local end of the link
288 * @link: pointer to the V4L2 fwnode link data 270 * @link: pointer to the V4L2 fwnode link data structure
289 * 271 *
290 * Fill the link structure with the local and 272 * Fill the link structure with the local and remote nodes and port numbers.
291 * The local_node and remote_node fields are s 273 * The local_node and remote_node fields are set to point to the local and
292 * remote port's parent nodes respectively (th 274 * remote port's parent nodes respectively (the port parent node being the
293 * parent node of the port node if that node i 275 * parent node of the port node if that node isn't a 'ports' node, or the
294 * grand-parent node of the port node otherwis 276 * grand-parent node of the port node otherwise).
295 * 277 *
296 * A reference is taken to both the local and 278 * A reference is taken to both the local and remote nodes, the caller must use
297 * v4l2_fwnode_put_link() to drop the referenc 279 * v4l2_fwnode_put_link() to drop the references when done with the
298 * link. 280 * link.
299 * 281 *
300 * Return: 0 on success, or -ENOLINK if the re 282 * Return: 0 on success, or -ENOLINK if the remote endpoint fwnode can't be
301 * found. 283 * found.
302 */ 284 */
303 int v4l2_fwnode_parse_link(struct fwnode_handl 285 int v4l2_fwnode_parse_link(struct fwnode_handle *fwnode,
304 struct v4l2_fwnode_ 286 struct v4l2_fwnode_link *link);
305 287
306 /** 288 /**
307 * v4l2_fwnode_put_link() - drop references to 289 * v4l2_fwnode_put_link() - drop references to nodes in a link
308 * @link: pointer to the V4L2 fwnode link data 290 * @link: pointer to the V4L2 fwnode link data structure
309 * 291 *
310 * Drop references to the local and remote nod 292 * Drop references to the local and remote nodes in the link. This function
311 * must be called on every link parsed with v4 293 * must be called on every link parsed with v4l2_fwnode_parse_link().
312 */ 294 */
313 void v4l2_fwnode_put_link(struct v4l2_fwnode_l 295 void v4l2_fwnode_put_link(struct v4l2_fwnode_link *link);
314 296
315 /** 297 /**
316 * v4l2_fwnode_connector_free() - free the V4L 298 * v4l2_fwnode_connector_free() - free the V4L2 connector acquired memory
317 * @connector: the V4L2 connector resources of 299 * @connector: the V4L2 connector resources of which are to be released
318 * 300 *
319 * Free all allocated memory and put all links 301 * Free all allocated memory and put all links acquired by
320 * v4l2_fwnode_connector_parse() and v4l2_fwno 302 * v4l2_fwnode_connector_parse() and v4l2_fwnode_connector_add_link().
321 * 303 *
322 * It is safe to call this function with NULL 304 * It is safe to call this function with NULL argument or on a V4L2 connector
323 * the parsing of which failed. 305 * the parsing of which failed.
324 */ 306 */
325 void v4l2_fwnode_connector_free(struct v4l2_fw 307 void v4l2_fwnode_connector_free(struct v4l2_fwnode_connector *connector);
326 308
327 /** 309 /**
328 * v4l2_fwnode_connector_parse() - initialize 310 * v4l2_fwnode_connector_parse() - initialize the 'struct v4l2_fwnode_connector'
329 * @fwnode: pointer to the subdev endpoint's f 311 * @fwnode: pointer to the subdev endpoint's fwnode handle where the connector
330 * is connected to or to the connecto 312 * is connected to or to the connector endpoint fwnode handle.
331 * @connector: pointer to the V4L2 fwnode conn 313 * @connector: pointer to the V4L2 fwnode connector data structure
332 * 314 *
333 * Fill the &struct v4l2_fwnode_connector with 315 * Fill the &struct v4l2_fwnode_connector with the connector type, label and
334 * all &enum v4l2_connector_type specific conn 316 * all &enum v4l2_connector_type specific connector data. The label is optional
335 * so it is set to %NULL if no one was found. 317 * so it is set to %NULL if no one was found. The function initialize the links
336 * to zero. Adding links to the connector is d 318 * to zero. Adding links to the connector is done by calling
337 * v4l2_fwnode_connector_add_link(). 319 * v4l2_fwnode_connector_add_link().
338 * 320 *
339 * The memory allocated for the label must be 321 * The memory allocated for the label must be freed when no longer needed.
340 * Freeing the memory is done by v4l2_fwnode_c 322 * Freeing the memory is done by v4l2_fwnode_connector_free().
341 * 323 *
342 * Return: 324 * Return:
343 * * %0 on success or a negative error code on 325 * * %0 on success or a negative error code on failure:
344 * * %-EINVAL if @fwnode is invalid 326 * * %-EINVAL if @fwnode is invalid
345 * * %-ENOTCONN if connector type is unknown o 327 * * %-ENOTCONN if connector type is unknown or connector device can't be found
346 */ 328 */
347 int v4l2_fwnode_connector_parse(struct fwnode_ 329 int v4l2_fwnode_connector_parse(struct fwnode_handle *fwnode,
348 struct v4l2_fw 330 struct v4l2_fwnode_connector *connector);
349 331
350 /** 332 /**
351 * v4l2_fwnode_connector_add_link - add a link 333 * v4l2_fwnode_connector_add_link - add a link between a connector node and
352 * a v4l2-sub 334 * a v4l2-subdev node.
353 * @fwnode: pointer to the subdev endpoint's f 335 * @fwnode: pointer to the subdev endpoint's fwnode handle where the connector
354 * is connected to 336 * is connected to
355 * @connector: pointer to the V4L2 fwnode conn 337 * @connector: pointer to the V4L2 fwnode connector data structure
356 * 338 *
357 * Add a new &struct v4l2_connector_link link 339 * Add a new &struct v4l2_connector_link link to the
358 * &struct v4l2_fwnode_connector connector lin 340 * &struct v4l2_fwnode_connector connector links list. The link local_node
359 * points to the connector node, the remote_no 341 * points to the connector node, the remote_node to the host v4l2 (sub)dev.
360 * 342 *
361 * The taken references to remote_node and loc 343 * The taken references to remote_node and local_node must be dropped and the
362 * allocated memory must be freed when no long 344 * allocated memory must be freed when no longer needed. Both is done by calling
363 * v4l2_fwnode_connector_free(). 345 * v4l2_fwnode_connector_free().
364 * 346 *
365 * Return: 347 * Return:
366 * * %0 on success or a negative error code on 348 * * %0 on success or a negative error code on failure:
367 * * %-EINVAL if @fwnode or @connector is inva 349 * * %-EINVAL if @fwnode or @connector is invalid or @connector type is unknown
368 * * %-ENOMEM on link memory allocation failur 350 * * %-ENOMEM on link memory allocation failure
369 * * %-ENOTCONN if remote connector device can 351 * * %-ENOTCONN if remote connector device can't be found
370 * * %-ENOLINK if link parsing between v4l2 (s 352 * * %-ENOLINK if link parsing between v4l2 (sub)dev and connector fails
371 */ 353 */
372 int v4l2_fwnode_connector_add_link(struct fwno 354 int v4l2_fwnode_connector_add_link(struct fwnode_handle *fwnode,
373 struct v4l2 355 struct v4l2_fwnode_connector *connector);
374 356
375 /** 357 /**
376 * v4l2_fwnode_device_parse() - parse fwnode d !! 358 * typedef parse_endpoint_func - Driver's callback function to be called on
377 * @dev: pointer to &struct device !! 359 * each V4L2 fwnode endpoint.
378 * @props: pointer to &struct v4l2_fwnode_devi <<
379 * parsed properties values <<
380 * 360 *
381 * This function parses and validates the V4L2 !! 361 * @dev: pointer to &struct device
382 * firmware interface, and fills the @struct v !! 362 * @vep: pointer to &struct v4l2_fwnode_endpoint
383 * provided by the caller. !! 363 * @asd: pointer to &struct v4l2_async_subdev
384 * 364 *
385 * Return: 365 * Return:
386 * % 0 on success !! 366 * * %0 on success
387 * %-EINVAL if a parsed property value is !! 367 * * %-ENOTCONN if the endpoint is to be skipped but this
388 */ !! 368 * should not be considered as an error
389 int v4l2_fwnode_device_parse(struct device *de !! 369 * * %-EINVAL if the endpoint configuration is invalid
390 struct v4l2_fwnod !! 370 */
>> 371 typedef int (*parse_endpoint_func)(struct device *dev,
>> 372 struct v4l2_fwnode_endpoint *vep,
>> 373 struct v4l2_async_subdev *asd);
>> 374
>> 375 /**
>> 376 * v4l2_async_notifier_parse_fwnode_endpoints - Parse V4L2 fwnode endpoints in a
>> 377 * device node
>> 378 * @dev: the device the endpoints of which are to be parsed
>> 379 * @notifier: notifier for @dev
>> 380 * @asd_struct_size: size of the driver's async sub-device struct, including
>> 381 * sizeof(struct v4l2_async_subdev). The &struct
>> 382 * v4l2_async_subdev shall be the first member of
>> 383 * the driver's async sub-device struct, i.e. both
>> 384 * begin at the same memory address.
>> 385 * @parse_endpoint: Driver's callback function called on each V4L2 fwnode
>> 386 * endpoint. Optional.
>> 387 *
>> 388 * Parse the fwnode endpoints of the @dev device and populate the async sub-
>> 389 * devices list in the notifier. The @parse_endpoint callback function is
>> 390 * called for each endpoint with the corresponding async sub-device pointer to
>> 391 * let the caller initialize the driver-specific part of the async sub-device
>> 392 * structure.
>> 393 *
>> 394 * The notifier memory shall be zeroed before this function is called on the
>> 395 * notifier.
>> 396 *
>> 397 * This function may not be called on a registered notifier and may be called on
>> 398 * a notifier only once.
>> 399 *
>> 400 * The &struct v4l2_fwnode_endpoint passed to the callback function
>> 401 * @parse_endpoint is released once the function is finished. If there is a need
>> 402 * to retain that configuration, the user needs to allocate memory for it.
>> 403 *
>> 404 * Any notifier populated using this function must be released with a call to
>> 405 * v4l2_async_notifier_cleanup() after it has been unregistered and the async
>> 406 * sub-devices are no longer in use, even if the function returned an error.
>> 407 *
>> 408 * Return: %0 on success, including when no async sub-devices are found
>> 409 * %-ENOMEM if memory allocation failed
>> 410 * %-EINVAL if graph or endpoint parsing failed
>> 411 * Other error codes as returned by @parse_endpoint
>> 412 */
>> 413 int
>> 414 v4l2_async_notifier_parse_fwnode_endpoints(struct device *dev,
>> 415 struct v4l2_async_notifier *notifier,
>> 416 size_t asd_struct_size,
>> 417 parse_endpoint_func parse_endpoint);
>> 418
>> 419 /**
>> 420 * v4l2_async_notifier_parse_fwnode_endpoints_by_port - Parse V4L2 fwnode
>> 421 * endpoints of a port in a
>> 422 * device node
>> 423 * @dev: the device the endpoints of which are to be parsed
>> 424 * @notifier: notifier for @dev
>> 425 * @asd_struct_size: size of the driver's async sub-device struct, including
>> 426 * sizeof(struct v4l2_async_subdev). The &struct
>> 427 * v4l2_async_subdev shall be the first member of
>> 428 * the driver's async sub-device struct, i.e. both
>> 429 * begin at the same memory address.
>> 430 * @port: port number where endpoints are to be parsed
>> 431 * @parse_endpoint: Driver's callback function called on each V4L2 fwnode
>> 432 * endpoint. Optional.
>> 433 *
>> 434 * This function is just like v4l2_async_notifier_parse_fwnode_endpoints() with
>> 435 * the exception that it only parses endpoints in a given port. This is useful
>> 436 * on devices that have both sinks and sources: the async sub-devices connected
>> 437 * to sources have already been configured by another driver (on capture
>> 438 * devices). In this case the driver must know which ports to parse.
>> 439 *
>> 440 * Parse the fwnode endpoints of the @dev device on a given @port and populate
>> 441 * the async sub-devices list of the notifier. The @parse_endpoint callback
>> 442 * function is called for each endpoint with the corresponding async sub-device
>> 443 * pointer to let the caller initialize the driver-specific part of the async
>> 444 * sub-device structure.
>> 445 *
>> 446 * The notifier memory shall be zeroed before this function is called on the
>> 447 * notifier the first time.
>> 448 *
>> 449 * This function may not be called on a registered notifier and may be called on
>> 450 * a notifier only once per port.
>> 451 *
>> 452 * The &struct v4l2_fwnode_endpoint passed to the callback function
>> 453 * @parse_endpoint is released once the function is finished. If there is a need
>> 454 * to retain that configuration, the user needs to allocate memory for it.
>> 455 *
>> 456 * Any notifier populated using this function must be released with a call to
>> 457 * v4l2_async_notifier_cleanup() after it has been unregistered and the async
>> 458 * sub-devices are no longer in use, even if the function returned an error.
>> 459 *
>> 460 * Return: %0 on success, including when no async sub-devices are found
>> 461 * %-ENOMEM if memory allocation failed
>> 462 * %-EINVAL if graph or endpoint parsing failed
>> 463 * Other error codes as returned by @parse_endpoint
>> 464 */
>> 465 int
>> 466 v4l2_async_notifier_parse_fwnode_endpoints_by_port(struct device *dev,
>> 467 struct v4l2_async_notifier *notifier,
>> 468 size_t asd_struct_size,
>> 469 unsigned int port,
>> 470 parse_endpoint_func parse_endpoint);
>> 471
>> 472 /**
>> 473 * v4l2_fwnode_reference_parse_sensor_common - parse common references on
>> 474 * sensors for async sub-devices
>> 475 * @dev: the device node the properties of which are parsed for references
>> 476 * @notifier: the async notifier where the async subdevs will be added
>> 477 *
>> 478 * Parse common sensor properties for remote devices related to the
>> 479 * sensor and set up async sub-devices for them.
>> 480 *
>> 481 * Any notifier populated using this function must be released with a call to
>> 482 * v4l2_async_notifier_release() after it has been unregistered and the async
>> 483 * sub-devices are no longer in use, even in the case the function returned an
>> 484 * error.
>> 485 *
>> 486 * Return: 0 on success
>> 487 * -ENOMEM if memory allocation failed
>> 488 * -EINVAL if property parsing failed
>> 489 */
>> 490 int v4l2_async_notifier_parse_fwnode_sensor_common(struct device *dev,
>> 491 struct v4l2_async_notifier *notifier);
>> 492
>> 493 /**
>> 494 * v4l2_async_register_fwnode_subdev - registers a sub-device to the
>> 495 * asynchronous sub-device framework
>> 496 * and parses fwnode endpoints
>> 497 *
>> 498 * @sd: pointer to struct &v4l2_subdev
>> 499 * @asd_struct_size: size of the driver's async sub-device struct, including
>> 500 * sizeof(struct v4l2_async_subdev). The &struct
>> 501 * v4l2_async_subdev shall be the first member of
>> 502 * the driver's async sub-device struct, i.e. both
>> 503 * begin at the same memory address.
>> 504 * @ports: array of port id's to parse for fwnode endpoints. If NULL, will
>> 505 * parse all ports owned by the sub-device.
>> 506 * @num_ports: number of ports in @ports array. Ignored if @ports is NULL.
>> 507 * @parse_endpoint: Driver's callback function called on each V4L2 fwnode
>> 508 * endpoint. Optional.
>> 509 *
>> 510 * This function is just like v4l2_async_register_subdev() with the
>> 511 * exception that calling it will also allocate a notifier for the
>> 512 * sub-device, parse the sub-device's firmware node endpoints using
>> 513 * v4l2_async_notifier_parse_fwnode_endpoints() or
>> 514 * v4l2_async_notifier_parse_fwnode_endpoints_by_port(), and
>> 515 * registers the sub-device notifier. The sub-device is similarly
>> 516 * unregistered by calling v4l2_async_unregister_subdev().
>> 517 *
>> 518 * While registered, the subdev module is marked as in-use.
>> 519 *
>> 520 * An error is returned if the module is no longer loaded on any attempts
>> 521 * to register it.
>> 522 */
>> 523 int
>> 524 v4l2_async_register_fwnode_subdev(struct v4l2_subdev *sd,
>> 525 size_t asd_struct_size,
>> 526 unsigned int *ports,
>> 527 unsigned int num_ports,
>> 528 parse_endpoint_func parse_endpoint);
391 529
392 /* Helper macros to access the connector links 530 /* Helper macros to access the connector links. */
393 531
394 /** v4l2_connector_last_link - Helper macro to 532 /** v4l2_connector_last_link - Helper macro to get the first
395 * &struct v4l2_fw 533 * &struct v4l2_fwnode_connector link
396 * @v4l2c: &struct v4l2_fwnode_connector ownin 534 * @v4l2c: &struct v4l2_fwnode_connector owning the connector links
397 * 535 *
398 * This marco returns the first added &struct 536 * This marco returns the first added &struct v4l2_connector_link connector
399 * link or @NULL if the connector has no links 537 * link or @NULL if the connector has no links.
400 */ 538 */
401 #define v4l2_connector_first_link(v4l2c) 539 #define v4l2_connector_first_link(v4l2c) \
402 list_first_entry_or_null(&(v4l2c)->lin 540 list_first_entry_or_null(&(v4l2c)->links, \
403 struct v4l2_c 541 struct v4l2_connector_link, head)
404 542
405 /** v4l2_connector_last_link - Helper macro to 543 /** v4l2_connector_last_link - Helper macro to get the last
406 * &struct v4l2_fw 544 * &struct v4l2_fwnode_connector link
407 * @v4l2c: &struct v4l2_fwnode_connector ownin 545 * @v4l2c: &struct v4l2_fwnode_connector owning the connector links
408 * 546 *
409 * This marco returns the last &struct v4l2_co 547 * This marco returns the last &struct v4l2_connector_link added connector link.
410 */ 548 */
411 #define v4l2_connector_last_link(v4l2c) 549 #define v4l2_connector_last_link(v4l2c) \
412 list_last_entry(&(v4l2c)->links, struc 550 list_last_entry(&(v4l2c)->links, struct v4l2_connector_link, head)
413 551
414 #endif /* _V4L2_FWNODE_H */ 552 #endif /* _V4L2_FWNODE_H */
415 553
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.