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