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 23
>> 24 struct fwnode_handle;
>> 25 struct v4l2_async_notifier;
>> 26 struct v4l2_async_subdev;
>> 27
24 /** 28 /**
25 * struct v4l2_fwnode_endpoint - the endpoint 29 * struct v4l2_fwnode_endpoint - the endpoint data structure
26 * @base: fwnode endpoint of the v4l2_fwnode 30 * @base: fwnode endpoint of the v4l2_fwnode
27 * @bus_type: bus type 31 * @bus_type: bus type
28 * @bus: bus configuration data structure 32 * @bus: bus configuration data structure
29 * @bus.parallel: embedded &struct v4l2_mbus_c 33 * @bus.parallel: embedded &struct v4l2_mbus_config_parallel.
30 * Used if the bus is parallel. 34 * Used if the bus is parallel.
31 * @bus.mipi_csi1: embedded &struct v4l2_mbus_ 35 * @bus.mipi_csi1: embedded &struct v4l2_mbus_config_mipi_csi1.
32 * Used if the bus is MIPI All 36 * Used if the bus is MIPI Alliance's Camera Serial
33 * Interface version 1 (MIPI C 37 * Interface version 1 (MIPI CSI1) or Standard
34 * Mobile Imaging Architecture 38 * Mobile Imaging Architecture's Compact Camera Port 2
35 * (SMIA CCP2). 39 * (SMIA CCP2).
36 * @bus.mipi_csi2: embedded &struct v4l2_mbus_ 40 * @bus.mipi_csi2: embedded &struct v4l2_mbus_config_mipi_csi2.
37 * Used if the bus is MIPI All 41 * Used if the bus is MIPI Alliance's Camera Serial
38 * Interface version 2 (MIPI C 42 * Interface version 2 (MIPI CSI2).
39 * @link_frequencies: array of supported link 43 * @link_frequencies: array of supported link frequencies
40 * @nr_of_link_frequencies: number of elements 44 * @nr_of_link_frequencies: number of elements in link_frequenccies array
41 */ 45 */
42 struct v4l2_fwnode_endpoint { 46 struct v4l2_fwnode_endpoint {
43 struct fwnode_endpoint base; 47 struct fwnode_endpoint base;
>> 48 /*
>> 49 * Fields below this line will be zeroed by
>> 50 * v4l2_fwnode_endpoint_parse()
>> 51 */
44 enum v4l2_mbus_type bus_type; 52 enum v4l2_mbus_type bus_type;
45 struct { 53 struct {
46 struct v4l2_mbus_config_parall 54 struct v4l2_mbus_config_parallel parallel;
47 struct v4l2_mbus_config_mipi_c 55 struct v4l2_mbus_config_mipi_csi1 mipi_csi1;
48 struct v4l2_mbus_config_mipi_c 56 struct v4l2_mbus_config_mipi_csi2 mipi_csi2;
49 } bus; 57 } bus;
50 u64 *link_frequencies; 58 u64 *link_frequencies;
51 unsigned int nr_of_link_frequencies; 59 unsigned int nr_of_link_frequencies;
52 }; 60 };
53 61
54 /** 62 /**
55 * V4L2_FWNODE_PROPERTY_UNSET - identify a non 63 * V4L2_FWNODE_PROPERTY_UNSET - identify a non initialized property
56 * 64 *
57 * All properties in &struct v4l2_fwnode_devic 65 * All properties in &struct v4l2_fwnode_device_properties are initialized
58 * to this value. 66 * to this value.
59 */ 67 */
60 #define V4L2_FWNODE_PROPERTY_UNSET (-1U) 68 #define V4L2_FWNODE_PROPERTY_UNSET (-1U)
61 69
62 /** 70 /**
63 * enum v4l2_fwnode_orientation - possible dev 71 * enum v4l2_fwnode_orientation - possible device orientation
64 * @V4L2_FWNODE_ORIENTATION_FRONT: device inst 72 * @V4L2_FWNODE_ORIENTATION_FRONT: device installed on the front side
65 * @V4L2_FWNODE_ORIENTATION_BACK: device insta 73 * @V4L2_FWNODE_ORIENTATION_BACK: device installed on the back side
66 * @V4L2_FWNODE_ORIENTATION_EXTERNAL: device e 74 * @V4L2_FWNODE_ORIENTATION_EXTERNAL: device externally located
67 */ 75 */
68 enum v4l2_fwnode_orientation { 76 enum v4l2_fwnode_orientation {
69 V4L2_FWNODE_ORIENTATION_FRONT, 77 V4L2_FWNODE_ORIENTATION_FRONT,
70 V4L2_FWNODE_ORIENTATION_BACK, 78 V4L2_FWNODE_ORIENTATION_BACK,
71 V4L2_FWNODE_ORIENTATION_EXTERNAL 79 V4L2_FWNODE_ORIENTATION_EXTERNAL
72 }; 80 };
73 81
74 /** 82 /**
75 * struct v4l2_fwnode_device_properties - fwno 83 * struct v4l2_fwnode_device_properties - fwnode device properties
76 * @orientation: device orientation. See &enum 84 * @orientation: device orientation. See &enum v4l2_fwnode_orientation
77 * @rotation: device rotation 85 * @rotation: device rotation
78 */ 86 */
79 struct v4l2_fwnode_device_properties { 87 struct v4l2_fwnode_device_properties {
80 enum v4l2_fwnode_orientation orientati 88 enum v4l2_fwnode_orientation orientation;
81 unsigned int rotation; 89 unsigned int rotation;
82 }; 90 };
83 91
84 /** 92 /**
85 * struct v4l2_fwnode_link - a link between tw 93 * struct v4l2_fwnode_link - a link between two endpoints
86 * @local_node: pointer to device_node of this 94 * @local_node: pointer to device_node of this endpoint
87 * @local_port: identifier of the port this en 95 * @local_port: identifier of the port this endpoint belongs to
88 * @local_id: identifier of the id this endpoi 96 * @local_id: identifier of the id this endpoint belongs to
89 * @remote_node: pointer to device_node of the 97 * @remote_node: pointer to device_node of the remote endpoint
90 * @remote_port: identifier of the port the re 98 * @remote_port: identifier of the port the remote endpoint belongs to
91 * @remote_id: identifier of the id the remote 99 * @remote_id: identifier of the id the remote endpoint belongs to
92 */ 100 */
93 struct v4l2_fwnode_link { 101 struct v4l2_fwnode_link {
94 struct fwnode_handle *local_node; 102 struct fwnode_handle *local_node;
95 unsigned int local_port; 103 unsigned int local_port;
96 unsigned int local_id; 104 unsigned int local_id;
97 struct fwnode_handle *remote_node; 105 struct fwnode_handle *remote_node;
98 unsigned int remote_port; 106 unsigned int remote_port;
99 unsigned int remote_id; 107 unsigned int remote_id;
100 }; 108 };
101 109
102 /** 110 /**
103 * enum v4l2_connector_type - connector type 111 * enum v4l2_connector_type - connector type
104 * @V4L2_CONN_UNKNOWN: unknown connector typ 112 * @V4L2_CONN_UNKNOWN: unknown connector type, no V4L2 connector configuration
105 * @V4L2_CONN_COMPOSITE: analog composite conn 113 * @V4L2_CONN_COMPOSITE: analog composite connector
106 * @V4L2_CONN_SVIDEO: analog svideo connect 114 * @V4L2_CONN_SVIDEO: analog svideo connector
107 */ 115 */
108 enum v4l2_connector_type { 116 enum v4l2_connector_type {
109 V4L2_CONN_UNKNOWN, 117 V4L2_CONN_UNKNOWN,
110 V4L2_CONN_COMPOSITE, 118 V4L2_CONN_COMPOSITE,
111 V4L2_CONN_SVIDEO, 119 V4L2_CONN_SVIDEO,
112 }; 120 };
113 121
114 /** 122 /**
115 * struct v4l2_connector_link - connector link 123 * struct v4l2_connector_link - connector link data structure
116 * @head: structure to be used to add the link 124 * @head: structure to be used to add the link to the
117 * &struct v4l2_fwnode_connector 125 * &struct v4l2_fwnode_connector
118 * @fwnode_link: &struct v4l2_fwnode_link link 126 * @fwnode_link: &struct v4l2_fwnode_link link between the connector and the
119 * device the connector belongs 127 * device the connector belongs to.
120 */ 128 */
121 struct v4l2_connector_link { 129 struct v4l2_connector_link {
122 struct list_head head; 130 struct list_head head;
123 struct v4l2_fwnode_link fwnode_link; 131 struct v4l2_fwnode_link fwnode_link;
124 }; 132 };
125 133
126 /** 134 /**
127 * struct v4l2_fwnode_connector_analog - analo 135 * struct v4l2_fwnode_connector_analog - analog connector data structure
128 * @sdtv_stds: sdtv standards this connector s 136 * @sdtv_stds: sdtv standards this connector supports, set to V4L2_STD_ALL
129 * if no restrictions are specifie 137 * if no restrictions are specified.
130 */ 138 */
131 struct v4l2_fwnode_connector_analog { 139 struct v4l2_fwnode_connector_analog {
132 v4l2_std_id sdtv_stds; 140 v4l2_std_id sdtv_stds;
133 }; 141 };
134 142
135 /** 143 /**
136 * struct v4l2_fwnode_connector - the connecto 144 * struct v4l2_fwnode_connector - the connector data structure
137 * @name: the connector device name 145 * @name: the connector device name
138 * @label: optional connector label 146 * @label: optional connector label
139 * @type: connector type 147 * @type: connector type
140 * @links: list of all connector &struct v4l2_ 148 * @links: list of all connector &struct v4l2_connector_link links
141 * @nr_of_links: total number of links 149 * @nr_of_links: total number of links
142 * @connector: connector configuration 150 * @connector: connector configuration
143 * @connector.analog: analog connector configu 151 * @connector.analog: analog connector configuration
144 * &struct v4l2_fwnode_conn 152 * &struct v4l2_fwnode_connector_analog
145 */ 153 */
146 struct v4l2_fwnode_connector { 154 struct v4l2_fwnode_connector {
147 const char *name; 155 const char *name;
148 const char *label; 156 const char *label;
149 enum v4l2_connector_type type; 157 enum v4l2_connector_type type;
150 struct list_head links; 158 struct list_head links;
151 unsigned int nr_of_links; 159 unsigned int nr_of_links;
152 160
153 union { 161 union {
154 struct v4l2_fwnode_connector_a 162 struct v4l2_fwnode_connector_analog analog;
155 /* future connectors */ 163 /* future connectors */
156 } connector; 164 } connector;
157 }; 165 };
158 166
159 /** 167 /**
160 * enum v4l2_fwnode_bus_type - Video bus types 168 * enum v4l2_fwnode_bus_type - Video bus types defined by firmware properties
161 * @V4L2_FWNODE_BUS_TYPE_GUESS: Default value 169 * @V4L2_FWNODE_BUS_TYPE_GUESS: Default value if no bus-type fwnode property
162 * @V4L2_FWNODE_BUS_TYPE_CSI2_CPHY: MIPI CSI-2 170 * @V4L2_FWNODE_BUS_TYPE_CSI2_CPHY: MIPI CSI-2 bus, C-PHY physical layer
163 * @V4L2_FWNODE_BUS_TYPE_CSI1: MIPI CSI-1 bus 171 * @V4L2_FWNODE_BUS_TYPE_CSI1: MIPI CSI-1 bus
164 * @V4L2_FWNODE_BUS_TYPE_CCP2: SMIA Compact Ca 172 * @V4L2_FWNODE_BUS_TYPE_CCP2: SMIA Compact Camera Port 2 bus
165 * @V4L2_FWNODE_BUS_TYPE_CSI2_DPHY: MIPI CSI-2 173 * @V4L2_FWNODE_BUS_TYPE_CSI2_DPHY: MIPI CSI-2 bus, D-PHY physical layer
166 * @V4L2_FWNODE_BUS_TYPE_PARALLEL: Camera Para 174 * @V4L2_FWNODE_BUS_TYPE_PARALLEL: Camera Parallel Interface bus
167 * @V4L2_FWNODE_BUS_TYPE_BT656: BT.656 video f 175 * @V4L2_FWNODE_BUS_TYPE_BT656: BT.656 video format bus-type
168 * @V4L2_FWNODE_BUS_TYPE_DPI: Video Parallel I <<
169 * @NR_OF_V4L2_FWNODE_BUS_TYPE: Number of bus- 176 * @NR_OF_V4L2_FWNODE_BUS_TYPE: Number of bus-types
170 */ 177 */
171 enum v4l2_fwnode_bus_type { 178 enum v4l2_fwnode_bus_type {
172 V4L2_FWNODE_BUS_TYPE_GUESS = 0, 179 V4L2_FWNODE_BUS_TYPE_GUESS = 0,
173 V4L2_FWNODE_BUS_TYPE_CSI2_CPHY, 180 V4L2_FWNODE_BUS_TYPE_CSI2_CPHY,
174 V4L2_FWNODE_BUS_TYPE_CSI1, 181 V4L2_FWNODE_BUS_TYPE_CSI1,
175 V4L2_FWNODE_BUS_TYPE_CCP2, 182 V4L2_FWNODE_BUS_TYPE_CCP2,
176 V4L2_FWNODE_BUS_TYPE_CSI2_DPHY, 183 V4L2_FWNODE_BUS_TYPE_CSI2_DPHY,
177 V4L2_FWNODE_BUS_TYPE_PARALLEL, 184 V4L2_FWNODE_BUS_TYPE_PARALLEL,
178 V4L2_FWNODE_BUS_TYPE_BT656, 185 V4L2_FWNODE_BUS_TYPE_BT656,
179 V4L2_FWNODE_BUS_TYPE_DPI, <<
180 NR_OF_V4L2_FWNODE_BUS_TYPE 186 NR_OF_V4L2_FWNODE_BUS_TYPE
181 }; 187 };
182 188
183 /** 189 /**
184 * v4l2_fwnode_endpoint_parse() - parse all fw 190 * v4l2_fwnode_endpoint_parse() - parse all fwnode node properties
185 * @fwnode: pointer to the endpoint's fwnode h 191 * @fwnode: pointer to the endpoint's fwnode handle
186 * @vep: pointer to the V4L2 fwnode data struc 192 * @vep: pointer to the V4L2 fwnode data structure
187 * 193 *
188 * This function parses the V4L2 fwnode endpoi 194 * This function parses the V4L2 fwnode endpoint specific parameters from the
189 * firmware. There are two ways to use this fu 195 * firmware. There are two ways to use this function, either by letting it
190 * obtain the type of the bus (by setting the 196 * obtain the type of the bus (by setting the @vep.bus_type field to
191 * V4L2_MBUS_UNKNOWN) or specifying the bus ty 197 * V4L2_MBUS_UNKNOWN) or specifying the bus type explicitly to one of the &enum
192 * v4l2_mbus_type types. 198 * v4l2_mbus_type types.
193 * 199 *
194 * When @vep.bus_type is V4L2_MBUS_UNKNOWN, th 200 * When @vep.bus_type is V4L2_MBUS_UNKNOWN, the function will use the "bus-type"
195 * property to determine the type when it is a 201 * property to determine the type when it is available. The caller is
196 * responsible for validating the contents of 202 * responsible for validating the contents of @vep.bus_type field after the call
197 * returns. 203 * returns.
198 * 204 *
199 * As a deprecated functionality to support ol 205 * As a deprecated functionality to support older DT bindings without "bus-type"
200 * property for devices that support multiple 206 * property for devices that support multiple types, if the "bus-type" property
201 * does not exist, the function will attempt t 207 * does not exist, the function will attempt to guess the type based on the
202 * endpoint properties available. NEVER RELY O 208 * endpoint properties available. NEVER RELY ON GUESSING THE BUS TYPE IN NEW
203 * DRIVERS OR BINDINGS. 209 * DRIVERS OR BINDINGS.
204 * 210 *
205 * It is also possible to set @vep.bus_type co 211 * It is also possible to set @vep.bus_type corresponding to an actual bus. In
206 * this case the function will only attempt to 212 * this case the function will only attempt to parse properties related to this
207 * bus, and it will return an error if the val 213 * bus, and it will return an error if the value of the "bus-type" property
208 * corresponds to a different bus. 214 * corresponds to a different bus.
209 * 215 *
210 * The caller is required to initialise all fi 216 * The caller is required to initialise all fields of @vep, either with
211 * explicitly values, or by zeroing them. 217 * explicitly values, or by zeroing them.
212 * 218 *
213 * The function does not change the V4L2 fwnod 219 * The function does not change the V4L2 fwnode endpoint state if it fails.
214 * 220 *
215 * NOTE: This function does not parse "link-fr 221 * NOTE: This function does not parse "link-frequencies" property as its size is
216 * not known in advance. Please use v4l2_fwnod 222 * not known in advance. Please use v4l2_fwnode_endpoint_alloc_parse() if you
217 * need properties of variable size. 223 * need properties of variable size.
218 * 224 *
219 * Return: %0 on success or a negative error c 225 * Return: %0 on success or a negative error code on failure:
220 * %-ENOMEM on memory allocation failu 226 * %-ENOMEM on memory allocation failure
221 * %-EINVAL on parsing failure 227 * %-EINVAL on parsing failure
222 * %-ENXIO on mismatching bus types 228 * %-ENXIO on mismatching bus types
223 */ 229 */
224 int v4l2_fwnode_endpoint_parse(struct fwnode_h 230 int v4l2_fwnode_endpoint_parse(struct fwnode_handle *fwnode,
225 struct v4l2_fwn 231 struct v4l2_fwnode_endpoint *vep);
226 232
227 /** 233 /**
228 * v4l2_fwnode_endpoint_free() - free the V4L2 234 * v4l2_fwnode_endpoint_free() - free the V4L2 fwnode acquired by
229 * v4l2_fwnode_endpoint_alloc_parse() 235 * v4l2_fwnode_endpoint_alloc_parse()
230 * @vep: the V4L2 fwnode the resources of whic 236 * @vep: the V4L2 fwnode the resources of which are to be released
231 * 237 *
232 * It is safe to call this function with NULL 238 * It is safe to call this function with NULL argument or on a V4L2 fwnode the
233 * parsing of which failed. 239 * parsing of which failed.
234 */ 240 */
235 void v4l2_fwnode_endpoint_free(struct v4l2_fwn 241 void v4l2_fwnode_endpoint_free(struct v4l2_fwnode_endpoint *vep);
236 242
237 /** 243 /**
238 * v4l2_fwnode_endpoint_alloc_parse() - parse 244 * v4l2_fwnode_endpoint_alloc_parse() - parse all fwnode node properties
239 * @fwnode: pointer to the endpoint's fwnode h 245 * @fwnode: pointer to the endpoint's fwnode handle
240 * @vep: pointer to the V4L2 fwnode data struc 246 * @vep: pointer to the V4L2 fwnode data structure
241 * 247 *
242 * This function parses the V4L2 fwnode endpoi 248 * This function parses the V4L2 fwnode endpoint specific parameters from the
243 * firmware. There are two ways to use this fu 249 * firmware. There are two ways to use this function, either by letting it
244 * obtain the type of the bus (by setting the 250 * obtain the type of the bus (by setting the @vep.bus_type field to
245 * V4L2_MBUS_UNKNOWN) or specifying the bus ty 251 * V4L2_MBUS_UNKNOWN) or specifying the bus type explicitly to one of the &enum
246 * v4l2_mbus_type types. 252 * v4l2_mbus_type types.
247 * 253 *
248 * When @vep.bus_type is V4L2_MBUS_UNKNOWN, th 254 * When @vep.bus_type is V4L2_MBUS_UNKNOWN, the function will use the "bus-type"
249 * property to determine the type when it is a 255 * property to determine the type when it is available. The caller is
250 * responsible for validating the contents of 256 * responsible for validating the contents of @vep.bus_type field after the call
251 * returns. 257 * returns.
252 * 258 *
253 * As a deprecated functionality to support ol 259 * As a deprecated functionality to support older DT bindings without "bus-type"
254 * property for devices that support multiple 260 * property for devices that support multiple types, if the "bus-type" property
255 * does not exist, the function will attempt t 261 * does not exist, the function will attempt to guess the type based on the
256 * endpoint properties available. NEVER RELY O 262 * endpoint properties available. NEVER RELY ON GUESSING THE BUS TYPE IN NEW
257 * DRIVERS OR BINDINGS. 263 * DRIVERS OR BINDINGS.
258 * 264 *
259 * It is also possible to set @vep.bus_type co 265 * It is also possible to set @vep.bus_type corresponding to an actual bus. In
260 * this case the function will only attempt to 266 * this case the function will only attempt to parse properties related to this
261 * bus, and it will return an error if the val 267 * bus, and it will return an error if the value of the "bus-type" property
262 * corresponds to a different bus. 268 * corresponds to a different bus.
263 * 269 *
264 * The caller is required to initialise all fi 270 * The caller is required to initialise all fields of @vep, either with
265 * explicitly values, or by zeroing them. 271 * explicitly values, or by zeroing them.
266 * 272 *
267 * The function does not change the V4L2 fwnod 273 * The function does not change the V4L2 fwnode endpoint state if it fails.
268 * 274 *
269 * v4l2_fwnode_endpoint_alloc_parse() has two 275 * v4l2_fwnode_endpoint_alloc_parse() has two important differences to
270 * v4l2_fwnode_endpoint_parse(): 276 * v4l2_fwnode_endpoint_parse():
271 * 277 *
272 * 1. It also parses variable size data. 278 * 1. It also parses variable size data.
273 * 279 *
274 * 2. The memory it has allocated to store the 280 * 2. The memory it has allocated to store the variable size data must be freed
275 * using v4l2_fwnode_endpoint_free() when n 281 * using v4l2_fwnode_endpoint_free() when no longer needed.
276 * 282 *
277 * Return: %0 on success or a negative error c 283 * Return: %0 on success or a negative error code on failure:
278 * %-ENOMEM on memory allocation failu 284 * %-ENOMEM on memory allocation failure
279 * %-EINVAL on parsing failure 285 * %-EINVAL on parsing failure
280 * %-ENXIO on mismatching bus types 286 * %-ENXIO on mismatching bus types
281 */ 287 */
282 int v4l2_fwnode_endpoint_alloc_parse(struct fw 288 int v4l2_fwnode_endpoint_alloc_parse(struct fwnode_handle *fwnode,
283 struct v4 289 struct v4l2_fwnode_endpoint *vep);
284 290
285 /** 291 /**
286 * v4l2_fwnode_parse_link() - parse a link bet 292 * v4l2_fwnode_parse_link() - parse a link between two endpoints
287 * @fwnode: pointer to the endpoint's fwnode a 293 * @fwnode: pointer to the endpoint's fwnode at the local end of the link
288 * @link: pointer to the V4L2 fwnode link data 294 * @link: pointer to the V4L2 fwnode link data structure
289 * 295 *
290 * Fill the link structure with the local and 296 * Fill the link structure with the local and remote nodes and port numbers.
291 * The local_node and remote_node fields are s 297 * The local_node and remote_node fields are set to point to the local and
292 * remote port's parent nodes respectively (th 298 * remote port's parent nodes respectively (the port parent node being the
293 * parent node of the port node if that node i 299 * 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 300 * grand-parent node of the port node otherwise).
295 * 301 *
296 * A reference is taken to both the local and 302 * A reference is taken to both the local and remote nodes, the caller must use
297 * v4l2_fwnode_put_link() to drop the referenc 303 * v4l2_fwnode_put_link() to drop the references when done with the
298 * link. 304 * link.
299 * 305 *
300 * Return: 0 on success, or -ENOLINK if the re 306 * Return: 0 on success, or -ENOLINK if the remote endpoint fwnode can't be
301 * found. 307 * found.
302 */ 308 */
303 int v4l2_fwnode_parse_link(struct fwnode_handl 309 int v4l2_fwnode_parse_link(struct fwnode_handle *fwnode,
304 struct v4l2_fwnode_ 310 struct v4l2_fwnode_link *link);
305 311
306 /** 312 /**
307 * v4l2_fwnode_put_link() - drop references to 313 * v4l2_fwnode_put_link() - drop references to nodes in a link
308 * @link: pointer to the V4L2 fwnode link data 314 * @link: pointer to the V4L2 fwnode link data structure
309 * 315 *
310 * Drop references to the local and remote nod 316 * Drop references to the local and remote nodes in the link. This function
311 * must be called on every link parsed with v4 317 * must be called on every link parsed with v4l2_fwnode_parse_link().
312 */ 318 */
313 void v4l2_fwnode_put_link(struct v4l2_fwnode_l 319 void v4l2_fwnode_put_link(struct v4l2_fwnode_link *link);
314 320
315 /** 321 /**
316 * v4l2_fwnode_connector_free() - free the V4L 322 * v4l2_fwnode_connector_free() - free the V4L2 connector acquired memory
317 * @connector: the V4L2 connector resources of 323 * @connector: the V4L2 connector resources of which are to be released
318 * 324 *
319 * Free all allocated memory and put all links 325 * Free all allocated memory and put all links acquired by
320 * v4l2_fwnode_connector_parse() and v4l2_fwno 326 * v4l2_fwnode_connector_parse() and v4l2_fwnode_connector_add_link().
321 * 327 *
322 * It is safe to call this function with NULL 328 * It is safe to call this function with NULL argument or on a V4L2 connector
323 * the parsing of which failed. 329 * the parsing of which failed.
324 */ 330 */
325 void v4l2_fwnode_connector_free(struct v4l2_fw 331 void v4l2_fwnode_connector_free(struct v4l2_fwnode_connector *connector);
326 332
327 /** 333 /**
328 * v4l2_fwnode_connector_parse() - initialize 334 * v4l2_fwnode_connector_parse() - initialize the 'struct v4l2_fwnode_connector'
329 * @fwnode: pointer to the subdev endpoint's f 335 * @fwnode: pointer to the subdev endpoint's fwnode handle where the connector
330 * is connected to or to the connecto 336 * is connected to or to the connector endpoint fwnode handle.
331 * @connector: pointer to the V4L2 fwnode conn 337 * @connector: pointer to the V4L2 fwnode connector data structure
332 * 338 *
333 * Fill the &struct v4l2_fwnode_connector with 339 * Fill the &struct v4l2_fwnode_connector with the connector type, label and
334 * all &enum v4l2_connector_type specific conn 340 * all &enum v4l2_connector_type specific connector data. The label is optional
335 * so it is set to %NULL if no one was found. 341 * 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 342 * to zero. Adding links to the connector is done by calling
337 * v4l2_fwnode_connector_add_link(). 343 * v4l2_fwnode_connector_add_link().
338 * 344 *
339 * The memory allocated for the label must be 345 * The memory allocated for the label must be freed when no longer needed.
340 * Freeing the memory is done by v4l2_fwnode_c 346 * Freeing the memory is done by v4l2_fwnode_connector_free().
341 * 347 *
342 * Return: 348 * Return:
343 * * %0 on success or a negative error code on 349 * * %0 on success or a negative error code on failure:
344 * * %-EINVAL if @fwnode is invalid 350 * * %-EINVAL if @fwnode is invalid
345 * * %-ENOTCONN if connector type is unknown o 351 * * %-ENOTCONN if connector type is unknown or connector device can't be found
346 */ 352 */
347 int v4l2_fwnode_connector_parse(struct fwnode_ 353 int v4l2_fwnode_connector_parse(struct fwnode_handle *fwnode,
348 struct v4l2_fw 354 struct v4l2_fwnode_connector *connector);
349 355
350 /** 356 /**
351 * v4l2_fwnode_connector_add_link - add a link 357 * v4l2_fwnode_connector_add_link - add a link between a connector node and
352 * a v4l2-sub 358 * a v4l2-subdev node.
353 * @fwnode: pointer to the subdev endpoint's f 359 * @fwnode: pointer to the subdev endpoint's fwnode handle where the connector
354 * is connected to 360 * is connected to
355 * @connector: pointer to the V4L2 fwnode conn 361 * @connector: pointer to the V4L2 fwnode connector data structure
356 * 362 *
357 * Add a new &struct v4l2_connector_link link 363 * Add a new &struct v4l2_connector_link link to the
358 * &struct v4l2_fwnode_connector connector lin 364 * &struct v4l2_fwnode_connector connector links list. The link local_node
359 * points to the connector node, the remote_no 365 * points to the connector node, the remote_node to the host v4l2 (sub)dev.
360 * 366 *
361 * The taken references to remote_node and loc 367 * The taken references to remote_node and local_node must be dropped and the
362 * allocated memory must be freed when no long 368 * allocated memory must be freed when no longer needed. Both is done by calling
363 * v4l2_fwnode_connector_free(). 369 * v4l2_fwnode_connector_free().
364 * 370 *
365 * Return: 371 * Return:
366 * * %0 on success or a negative error code on 372 * * %0 on success or a negative error code on failure:
367 * * %-EINVAL if @fwnode or @connector is inva 373 * * %-EINVAL if @fwnode or @connector is invalid or @connector type is unknown
368 * * %-ENOMEM on link memory allocation failur 374 * * %-ENOMEM on link memory allocation failure
369 * * %-ENOTCONN if remote connector device can 375 * * %-ENOTCONN if remote connector device can't be found
370 * * %-ENOLINK if link parsing between v4l2 (s 376 * * %-ENOLINK if link parsing between v4l2 (sub)dev and connector fails
371 */ 377 */
372 int v4l2_fwnode_connector_add_link(struct fwno 378 int v4l2_fwnode_connector_add_link(struct fwnode_handle *fwnode,
373 struct v4l2 379 struct v4l2_fwnode_connector *connector);
374 380
375 /** 381 /**
376 * v4l2_fwnode_device_parse() - parse fwnode d 382 * v4l2_fwnode_device_parse() - parse fwnode device properties
377 * @dev: pointer to &struct device 383 * @dev: pointer to &struct device
378 * @props: pointer to &struct v4l2_fwnode_devi 384 * @props: pointer to &struct v4l2_fwnode_device_properties where to store the
379 * parsed properties values 385 * parsed properties values
380 * 386 *
381 * This function parses and validates the V4L2 387 * This function parses and validates the V4L2 fwnode device properties from the
382 * firmware interface, and fills the @struct v 388 * firmware interface, and fills the @struct v4l2_fwnode_device_properties
383 * provided by the caller. 389 * provided by the caller.
384 * 390 *
385 * Return: 391 * Return:
386 * % 0 on success 392 * % 0 on success
387 * %-EINVAL if a parsed property value is 393 * %-EINVAL if a parsed property value is not valid
388 */ 394 */
389 int v4l2_fwnode_device_parse(struct device *de 395 int v4l2_fwnode_device_parse(struct device *dev,
390 struct v4l2_fwnod 396 struct v4l2_fwnode_device_properties *props);
>> 397
>> 398 /**
>> 399 * typedef parse_endpoint_func - Driver's callback function to be called on
>> 400 * each V4L2 fwnode endpoint.
>> 401 *
>> 402 * @dev: pointer to &struct device
>> 403 * @vep: pointer to &struct v4l2_fwnode_endpoint
>> 404 * @asd: pointer to &struct v4l2_async_subdev
>> 405 *
>> 406 * Return:
>> 407 * * %0 on success
>> 408 * * %-ENOTCONN if the endpoint is to be skipped but this
>> 409 * should not be considered as an error
>> 410 * * %-EINVAL if the endpoint configuration is invalid
>> 411 */
>> 412 typedef int (*parse_endpoint_func)(struct device *dev,
>> 413 struct v4l2_fwnode_endpoint *vep,
>> 414 struct v4l2_async_subdev *asd);
>> 415
>> 416 /**
>> 417 * v4l2_async_nf_parse_fwnode_endpoints - Parse V4L2 fwnode endpoints in a
>> 418 * device node
>> 419 * @dev: the device the endpoints of which are to be parsed
>> 420 * @notifier: notifier for @dev
>> 421 * @asd_struct_size: size of the driver's async sub-device struct, including
>> 422 * sizeof(struct v4l2_async_subdev). The &struct
>> 423 * v4l2_async_subdev shall be the first member of
>> 424 * the driver's async sub-device struct, i.e. both
>> 425 * begin at the same memory address.
>> 426 * @parse_endpoint: Driver's callback function called on each V4L2 fwnode
>> 427 * endpoint. Optional.
>> 428 *
>> 429 * DEPRECATED! This function is deprecated. Don't use it in new drivers.
>> 430 * Instead see an example in cio2_parse_firmware() function in
>> 431 * drivers/media/pci/intel/ipu3/ipu3-cio2.c .
>> 432 *
>> 433 * Parse the fwnode endpoints of the @dev device and populate the async sub-
>> 434 * devices list in the notifier. The @parse_endpoint callback function is
>> 435 * called for each endpoint with the corresponding async sub-device pointer to
>> 436 * let the caller initialize the driver-specific part of the async sub-device
>> 437 * structure.
>> 438 *
>> 439 * The notifier memory shall be zeroed before this function is called on the
>> 440 * notifier.
>> 441 *
>> 442 * This function may not be called on a registered notifier and may be called on
>> 443 * a notifier only once.
>> 444 *
>> 445 * The &struct v4l2_fwnode_endpoint passed to the callback function
>> 446 * @parse_endpoint is released once the function is finished. If there is a need
>> 447 * to retain that configuration, the user needs to allocate memory for it.
>> 448 *
>> 449 * Any notifier populated using this function must be released with a call to
>> 450 * v4l2_async_nf_cleanup() after it has been unregistered and the async
>> 451 * sub-devices are no longer in use, even if the function returned an error.
>> 452 *
>> 453 * Return: %0 on success, including when no async sub-devices are found
>> 454 * %-ENOMEM if memory allocation failed
>> 455 * %-EINVAL if graph or endpoint parsing failed
>> 456 * Other error codes as returned by @parse_endpoint
>> 457 */
>> 458 int
>> 459 v4l2_async_nf_parse_fwnode_endpoints(struct device *dev,
>> 460 struct v4l2_async_notifier *notifier,
>> 461 size_t asd_struct_size,
>> 462 parse_endpoint_func parse_endpoint);
391 463
392 /* Helper macros to access the connector links 464 /* Helper macros to access the connector links. */
393 465
394 /** v4l2_connector_last_link - Helper macro to 466 /** v4l2_connector_last_link - Helper macro to get the first
395 * &struct v4l2_fw 467 * &struct v4l2_fwnode_connector link
396 * @v4l2c: &struct v4l2_fwnode_connector ownin 468 * @v4l2c: &struct v4l2_fwnode_connector owning the connector links
397 * 469 *
398 * This marco returns the first added &struct 470 * This marco returns the first added &struct v4l2_connector_link connector
399 * link or @NULL if the connector has no links 471 * link or @NULL if the connector has no links.
400 */ 472 */
401 #define v4l2_connector_first_link(v4l2c) 473 #define v4l2_connector_first_link(v4l2c) \
402 list_first_entry_or_null(&(v4l2c)->lin 474 list_first_entry_or_null(&(v4l2c)->links, \
403 struct v4l2_c 475 struct v4l2_connector_link, head)
404 476
405 /** v4l2_connector_last_link - Helper macro to 477 /** v4l2_connector_last_link - Helper macro to get the last
406 * &struct v4l2_fw 478 * &struct v4l2_fwnode_connector link
407 * @v4l2c: &struct v4l2_fwnode_connector ownin 479 * @v4l2c: &struct v4l2_fwnode_connector owning the connector links
408 * 480 *
409 * This marco returns the last &struct v4l2_co 481 * This marco returns the last &struct v4l2_connector_link added connector link.
410 */ 482 */
411 #define v4l2_connector_last_link(v4l2c) 483 #define v4l2_connector_last_link(v4l2c) \
412 list_last_entry(&(v4l2c)->links, struc 484 list_last_entry(&(v4l2c)->links, struct v4l2_connector_link, head)
413 485
414 #endif /* _V4L2_FWNODE_H */ 486 #endif /* _V4L2_FWNODE_H */
415 487
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.