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