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