2 * V4L2 fwnode binding parsing library
4 * The origins of the V4L2 fwnode library are in V4L2 OF library that
5 * formerly was located in v4l2-of.c.
7 * Copyright (c) 2016 Intel Corporation.
8 * Author: Sakari Ailus <sakari.ailus@linux.intel.com>
10 * Copyright (C) 2012 - 2013 Samsung Electronics Co., Ltd.
11 * Author: Sylwester Nawrocki <s.nawrocki@samsung.com>
13 * Copyright (C) 2012 Renesas Electronics Corp.
14 * Author: Guennadi Liakhovetski <g.liakhovetski@gmx.de>
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of version 2 of the GNU General Public License as
18 * published by the Free Software Foundation.
20 #include <linux/acpi.h>
21 #include <linux/kernel.h>
23 #include <linux/module.h>
25 #include <linux/property.h>
26 #include <linux/slab.h>
27 #include <linux/string.h>
28 #include <linux/types.h>
30 #include <media/v4l2-async.h>
31 #include <media/v4l2-fwnode.h>
32 #include <media/v4l2-subdev.h>
34 enum v4l2_fwnode_bus_type {
35 V4L2_FWNODE_BUS_TYPE_GUESS = 0,
36 V4L2_FWNODE_BUS_TYPE_CSI2_CPHY,
37 V4L2_FWNODE_BUS_TYPE_CSI1,
38 V4L2_FWNODE_BUS_TYPE_CCP2,
39 V4L2_FWNODE_BUS_TYPE_CSI2_DPHY,
40 V4L2_FWNODE_BUS_TYPE_PARALLEL,
41 V4L2_FWNODE_BUS_TYPE_BT656,
42 NR_OF_V4L2_FWNODE_BUS_TYPE,
45 static const struct v4l2_fwnode_bus_conv {
46 enum v4l2_fwnode_bus_type fwnode_bus_type;
47 enum v4l2_mbus_type mbus_type;
51 V4L2_FWNODE_BUS_TYPE_GUESS,
55 V4L2_FWNODE_BUS_TYPE_CSI2_CPHY,
59 V4L2_FWNODE_BUS_TYPE_CSI1,
63 V4L2_FWNODE_BUS_TYPE_CCP2,
65 "compact camera port 2",
67 V4L2_FWNODE_BUS_TYPE_CSI2_DPHY,
71 V4L2_FWNODE_BUS_TYPE_PARALLEL,
75 V4L2_FWNODE_BUS_TYPE_BT656,
81 static const struct v4l2_fwnode_bus_conv *
82 get_v4l2_fwnode_bus_conv_by_fwnode_bus(enum v4l2_fwnode_bus_type type)
86 for (i = 0; i < ARRAY_SIZE(busses); i++)
87 if (busses[i].fwnode_bus_type == type)
93 static enum v4l2_mbus_type
94 v4l2_fwnode_bus_type_to_mbus(enum v4l2_fwnode_bus_type type)
96 const struct v4l2_fwnode_bus_conv *conv =
97 get_v4l2_fwnode_bus_conv_by_fwnode_bus(type);
99 return conv ? conv->mbus_type : V4L2_MBUS_UNKNOWN;
103 v4l2_fwnode_bus_type_to_string(enum v4l2_fwnode_bus_type type)
105 const struct v4l2_fwnode_bus_conv *conv =
106 get_v4l2_fwnode_bus_conv_by_fwnode_bus(type);
108 return conv ? conv->name : "not found";
111 static const struct v4l2_fwnode_bus_conv *
112 get_v4l2_fwnode_bus_conv_by_mbus(enum v4l2_mbus_type type)
116 for (i = 0; i < ARRAY_SIZE(busses); i++)
117 if (busses[i].mbus_type == type)
124 v4l2_fwnode_mbus_type_to_string(enum v4l2_mbus_type type)
126 const struct v4l2_fwnode_bus_conv *conv =
127 get_v4l2_fwnode_bus_conv_by_mbus(type);
129 return conv ? conv->name : "not found";
132 static int v4l2_fwnode_endpoint_parse_csi2_bus(struct fwnode_handle *fwnode,
133 struct v4l2_fwnode_endpoint *vep,
134 enum v4l2_mbus_type bus_type)
136 struct v4l2_fwnode_bus_mipi_csi2 *bus = &vep->bus.mipi_csi2;
137 bool have_clk_lane = false, have_data_lanes = false,
138 have_lane_polarities = false;
139 unsigned int flags = 0, lanes_used = 0;
140 u32 array[1 + V4L2_FWNODE_CSI2_MAX_DATA_LANES];
142 unsigned int num_data_lanes = 0;
143 bool use_default_lane_mapping = false;
148 if (bus_type == V4L2_MBUS_CSI2_DPHY ||
149 bus_type == V4L2_MBUS_CSI2_CPHY) {
150 use_default_lane_mapping = true;
152 num_data_lanes = min_t(u32, bus->num_data_lanes,
153 V4L2_FWNODE_CSI2_MAX_DATA_LANES);
155 clock_lane = bus->clock_lane;
157 use_default_lane_mapping = false;
159 for (i = 0; i < num_data_lanes; i++) {
160 array[i] = bus->data_lanes[i];
162 use_default_lane_mapping = false;
165 if (use_default_lane_mapping)
166 pr_debug("using default lane mapping\n");
169 rval = fwnode_property_read_u32_array(fwnode, "data-lanes", NULL, 0);
172 min_t(int, V4L2_FWNODE_CSI2_MAX_DATA_LANES, rval);
174 fwnode_property_read_u32_array(fwnode, "data-lanes", array,
177 have_data_lanes = true;
180 for (i = 0; i < num_data_lanes; i++) {
181 if (lanes_used & BIT(array[i])) {
182 if (have_data_lanes || !use_default_lane_mapping)
183 pr_warn("duplicated lane %u in data-lanes, using defaults\n",
185 use_default_lane_mapping = true;
187 lanes_used |= BIT(array[i]);
190 pr_debug("lane %u position %u\n", i, array[i]);
193 rval = fwnode_property_read_u32_array(fwnode, "lane-polarities", NULL,
196 if (rval != 1 + num_data_lanes /* clock+data */) {
197 pr_warn("invalid number of lane-polarities entries (need %u, got %u)\n",
198 1 + num_data_lanes, rval);
202 have_lane_polarities = true;
205 if (!fwnode_property_read_u32(fwnode, "clock-lanes", &v)) {
207 pr_debug("clock lane position %u\n", v);
208 have_clk_lane = true;
211 if (lanes_used & BIT(clock_lane)) {
212 if (have_clk_lane || !use_default_lane_mapping)
213 pr_warn("duplicated lane %u in clock-lanes, using defaults\n",
215 use_default_lane_mapping = true;
218 if (fwnode_property_present(fwnode, "clock-noncontinuous")) {
219 flags |= V4L2_MBUS_CSI2_NONCONTINUOUS_CLOCK;
220 pr_debug("non-continuous clock\n");
222 flags |= V4L2_MBUS_CSI2_CONTINUOUS_CLOCK;
225 if (bus_type == V4L2_MBUS_CSI2_DPHY ||
226 bus_type == V4L2_MBUS_CSI2_CPHY || lanes_used ||
227 have_clk_lane || (flags & ~V4L2_MBUS_CSI2_CONTINUOUS_CLOCK)) {
229 if (bus_type == V4L2_MBUS_UNKNOWN)
230 vep->bus_type = V4L2_MBUS_CSI2_DPHY;
231 bus->num_data_lanes = num_data_lanes;
233 if (use_default_lane_mapping) {
235 for (i = 0; i < num_data_lanes; i++)
236 bus->data_lanes[i] = 1 + i;
238 bus->clock_lane = clock_lane;
239 for (i = 0; i < num_data_lanes; i++)
240 bus->data_lanes[i] = array[i];
243 if (have_lane_polarities) {
244 fwnode_property_read_u32_array(fwnode,
245 "lane-polarities", array,
248 for (i = 0; i < 1 + num_data_lanes; i++) {
249 bus->lane_polarities[i] = array[i];
250 pr_debug("lane %u polarity %sinverted",
251 i, array[i] ? "" : "not ");
254 pr_debug("no lane polarities defined, assuming not inverted\n");
261 #define PARALLEL_MBUS_FLAGS (V4L2_MBUS_HSYNC_ACTIVE_HIGH | \
262 V4L2_MBUS_HSYNC_ACTIVE_LOW | \
263 V4L2_MBUS_VSYNC_ACTIVE_HIGH | \
264 V4L2_MBUS_VSYNC_ACTIVE_LOW | \
265 V4L2_MBUS_FIELD_EVEN_HIGH | \
266 V4L2_MBUS_FIELD_EVEN_LOW)
268 static void v4l2_fwnode_endpoint_parse_parallel_bus(
269 struct fwnode_handle *fwnode, struct v4l2_fwnode_endpoint *vep,
270 enum v4l2_mbus_type bus_type)
272 struct v4l2_fwnode_bus_parallel *bus = &vep->bus.parallel;
273 unsigned int flags = 0;
276 if (bus_type == V4L2_MBUS_PARALLEL || bus_type == V4L2_MBUS_BT656)
279 if (!fwnode_property_read_u32(fwnode, "hsync-active", &v)) {
280 flags &= ~(V4L2_MBUS_HSYNC_ACTIVE_HIGH |
281 V4L2_MBUS_HSYNC_ACTIVE_LOW);
282 flags |= v ? V4L2_MBUS_HSYNC_ACTIVE_HIGH :
283 V4L2_MBUS_HSYNC_ACTIVE_LOW;
284 pr_debug("hsync-active %s\n", v ? "high" : "low");
287 if (!fwnode_property_read_u32(fwnode, "vsync-active", &v)) {
288 flags &= ~(V4L2_MBUS_VSYNC_ACTIVE_HIGH |
289 V4L2_MBUS_VSYNC_ACTIVE_LOW);
290 flags |= v ? V4L2_MBUS_VSYNC_ACTIVE_HIGH :
291 V4L2_MBUS_VSYNC_ACTIVE_LOW;
292 pr_debug("vsync-active %s\n", v ? "high" : "low");
295 if (!fwnode_property_read_u32(fwnode, "field-even-active", &v)) {
296 flags &= ~(V4L2_MBUS_FIELD_EVEN_HIGH |
297 V4L2_MBUS_FIELD_EVEN_LOW);
298 flags |= v ? V4L2_MBUS_FIELD_EVEN_HIGH :
299 V4L2_MBUS_FIELD_EVEN_LOW;
300 pr_debug("field-even-active %s\n", v ? "high" : "low");
303 if (!fwnode_property_read_u32(fwnode, "pclk-sample", &v)) {
304 flags &= ~(V4L2_MBUS_PCLK_SAMPLE_RISING |
305 V4L2_MBUS_PCLK_SAMPLE_FALLING);
306 flags |= v ? V4L2_MBUS_PCLK_SAMPLE_RISING :
307 V4L2_MBUS_PCLK_SAMPLE_FALLING;
308 pr_debug("pclk-sample %s\n", v ? "high" : "low");
311 if (!fwnode_property_read_u32(fwnode, "data-active", &v)) {
312 flags &= ~(V4L2_MBUS_PCLK_SAMPLE_RISING |
313 V4L2_MBUS_PCLK_SAMPLE_FALLING);
314 flags |= v ? V4L2_MBUS_DATA_ACTIVE_HIGH :
315 V4L2_MBUS_DATA_ACTIVE_LOW;
316 pr_debug("data-active %s\n", v ? "high" : "low");
319 if (fwnode_property_present(fwnode, "slave-mode")) {
320 pr_debug("slave mode\n");
321 flags &= ~V4L2_MBUS_MASTER;
322 flags |= V4L2_MBUS_SLAVE;
324 flags &= ~V4L2_MBUS_SLAVE;
325 flags |= V4L2_MBUS_MASTER;
328 if (!fwnode_property_read_u32(fwnode, "bus-width", &v)) {
330 pr_debug("bus-width %u\n", v);
333 if (!fwnode_property_read_u32(fwnode, "data-shift", &v)) {
335 pr_debug("data-shift %u\n", v);
338 if (!fwnode_property_read_u32(fwnode, "sync-on-green-active", &v)) {
339 flags &= ~(V4L2_MBUS_VIDEO_SOG_ACTIVE_HIGH |
340 V4L2_MBUS_VIDEO_SOG_ACTIVE_LOW);
341 flags |= v ? V4L2_MBUS_VIDEO_SOG_ACTIVE_HIGH :
342 V4L2_MBUS_VIDEO_SOG_ACTIVE_LOW;
343 pr_debug("sync-on-green-active %s\n", v ? "high" : "low");
346 if (!fwnode_property_read_u32(fwnode, "data-enable-active", &v)) {
347 flags &= ~(V4L2_MBUS_DATA_ENABLE_HIGH |
348 V4L2_MBUS_DATA_ENABLE_LOW);
349 flags |= v ? V4L2_MBUS_DATA_ENABLE_HIGH :
350 V4L2_MBUS_DATA_ENABLE_LOW;
351 pr_debug("data-enable-active %s\n", v ? "high" : "low");
357 if (flags & PARALLEL_MBUS_FLAGS)
358 vep->bus_type = V4L2_MBUS_PARALLEL;
360 vep->bus_type = V4L2_MBUS_BT656;
362 case V4L2_MBUS_PARALLEL:
363 vep->bus_type = V4L2_MBUS_PARALLEL;
366 case V4L2_MBUS_BT656:
367 vep->bus_type = V4L2_MBUS_BT656;
368 bus->flags = flags & ~PARALLEL_MBUS_FLAGS;
374 v4l2_fwnode_endpoint_parse_csi1_bus(struct fwnode_handle *fwnode,
375 struct v4l2_fwnode_endpoint *vep,
376 enum v4l2_mbus_type bus_type)
378 struct v4l2_fwnode_bus_mipi_csi1 *bus = &vep->bus.mipi_csi1;
381 if (!fwnode_property_read_u32(fwnode, "clock-inv", &v)) {
383 pr_debug("clock-inv %u\n", v);
386 if (!fwnode_property_read_u32(fwnode, "strobe", &v)) {
388 pr_debug("strobe %u\n", v);
391 if (!fwnode_property_read_u32(fwnode, "data-lanes", &v)) {
393 pr_debug("data-lanes %u\n", v);
396 if (!fwnode_property_read_u32(fwnode, "clock-lanes", &v)) {
398 pr_debug("clock-lanes %u\n", v);
401 if (bus_type == V4L2_MBUS_CCP2)
402 vep->bus_type = V4L2_MBUS_CCP2;
404 vep->bus_type = V4L2_MBUS_CSI1;
407 static int __v4l2_fwnode_endpoint_parse(struct fwnode_handle *fwnode,
408 struct v4l2_fwnode_endpoint *vep)
410 u32 bus_type = V4L2_FWNODE_BUS_TYPE_GUESS;
411 enum v4l2_mbus_type mbus_type;
414 if (vep->bus_type == V4L2_MBUS_UNKNOWN) {
415 /* Zero fields from bus union to until the end */
417 sizeof(*vep) - offsetof(typeof(*vep), bus));
420 pr_debug("===== begin V4L2 endpoint properties\n");
423 * Zero the fwnode graph endpoint memory in case we don't end up parsing
426 memset(&vep->base, 0, sizeof(vep->base));
428 fwnode_property_read_u32(fwnode, "bus-type", &bus_type);
429 pr_debug("fwnode video bus type %s (%u), mbus type %s (%u)\n",
430 v4l2_fwnode_bus_type_to_string(bus_type), bus_type,
431 v4l2_fwnode_mbus_type_to_string(vep->bus_type),
433 mbus_type = v4l2_fwnode_bus_type_to_mbus(bus_type);
435 if (vep->bus_type != V4L2_MBUS_UNKNOWN) {
436 if (mbus_type != V4L2_MBUS_UNKNOWN &&
437 vep->bus_type != mbus_type) {
438 pr_debug("expecting bus type %s\n",
439 v4l2_fwnode_mbus_type_to_string(
444 vep->bus_type = mbus_type;
447 switch (vep->bus_type) {
448 case V4L2_MBUS_UNKNOWN:
449 rval = v4l2_fwnode_endpoint_parse_csi2_bus(fwnode, vep,
454 if (vep->bus_type == V4L2_MBUS_UNKNOWN)
455 v4l2_fwnode_endpoint_parse_parallel_bus(
456 fwnode, vep, V4L2_MBUS_UNKNOWN);
458 pr_debug("assuming media bus type %s (%u)\n",
459 v4l2_fwnode_mbus_type_to_string(vep->bus_type),
465 v4l2_fwnode_endpoint_parse_csi1_bus(fwnode, vep, vep->bus_type);
468 case V4L2_MBUS_CSI2_DPHY:
469 case V4L2_MBUS_CSI2_CPHY:
470 rval = v4l2_fwnode_endpoint_parse_csi2_bus(fwnode, vep,
476 case V4L2_MBUS_PARALLEL:
477 case V4L2_MBUS_BT656:
478 v4l2_fwnode_endpoint_parse_parallel_bus(fwnode, vep,
483 pr_warn("unsupported bus type %u\n", mbus_type);
487 fwnode_graph_parse_endpoint(fwnode, &vep->base);
492 int v4l2_fwnode_endpoint_parse(struct fwnode_handle *fwnode,
493 struct v4l2_fwnode_endpoint *vep)
497 ret = __v4l2_fwnode_endpoint_parse(fwnode, vep);
499 pr_debug("===== end V4L2 endpoint properties\n");
503 EXPORT_SYMBOL_GPL(v4l2_fwnode_endpoint_parse);
505 void v4l2_fwnode_endpoint_free(struct v4l2_fwnode_endpoint *vep)
507 if (IS_ERR_OR_NULL(vep))
510 kfree(vep->link_frequencies);
512 EXPORT_SYMBOL_GPL(v4l2_fwnode_endpoint_free);
514 int v4l2_fwnode_endpoint_alloc_parse(
515 struct fwnode_handle *fwnode, struct v4l2_fwnode_endpoint *vep)
519 rval = __v4l2_fwnode_endpoint_parse(fwnode, vep);
523 rval = fwnode_property_read_u64_array(fwnode, "link-frequencies",
528 vep->link_frequencies =
529 kmalloc_array(rval, sizeof(*vep->link_frequencies),
531 if (!vep->link_frequencies)
534 vep->nr_of_link_frequencies = rval;
536 rval = fwnode_property_read_u64_array(
537 fwnode, "link-frequencies", vep->link_frequencies,
538 vep->nr_of_link_frequencies);
540 v4l2_fwnode_endpoint_free(vep);
544 for (i = 0; i < vep->nr_of_link_frequencies; i++)
545 pr_info("link-frequencies %u value %llu\n", i,
546 vep->link_frequencies[i]);
549 pr_debug("===== end V4L2 endpoint properties\n");
553 EXPORT_SYMBOL_GPL(v4l2_fwnode_endpoint_alloc_parse);
555 int v4l2_fwnode_parse_link(struct fwnode_handle *__fwnode,
556 struct v4l2_fwnode_link *link)
558 const char *port_prop = is_of_node(__fwnode) ? "reg" : "port";
559 struct fwnode_handle *fwnode;
561 memset(link, 0, sizeof(*link));
563 fwnode = fwnode_get_parent(__fwnode);
564 fwnode_property_read_u32(fwnode, port_prop, &link->local_port);
565 fwnode = fwnode_get_next_parent(fwnode);
566 if (is_of_node(fwnode) &&
567 of_node_cmp(to_of_node(fwnode)->name, "ports") == 0)
568 fwnode = fwnode_get_next_parent(fwnode);
569 link->local_node = fwnode;
571 fwnode = fwnode_graph_get_remote_endpoint(__fwnode);
573 fwnode_handle_put(fwnode);
577 fwnode = fwnode_get_parent(fwnode);
578 fwnode_property_read_u32(fwnode, port_prop, &link->remote_port);
579 fwnode = fwnode_get_next_parent(fwnode);
580 if (is_of_node(fwnode) &&
581 of_node_cmp(to_of_node(fwnode)->name, "ports") == 0)
582 fwnode = fwnode_get_next_parent(fwnode);
583 link->remote_node = fwnode;
587 EXPORT_SYMBOL_GPL(v4l2_fwnode_parse_link);
589 void v4l2_fwnode_put_link(struct v4l2_fwnode_link *link)
591 fwnode_handle_put(link->local_node);
592 fwnode_handle_put(link->remote_node);
594 EXPORT_SYMBOL_GPL(v4l2_fwnode_put_link);
596 static int v4l2_async_notifier_fwnode_parse_endpoint(
597 struct device *dev, struct v4l2_async_notifier *notifier,
598 struct fwnode_handle *endpoint, unsigned int asd_struct_size,
599 int (*parse_endpoint)(struct device *dev,
600 struct v4l2_fwnode_endpoint *vep,
601 struct v4l2_async_subdev *asd))
603 struct v4l2_fwnode_endpoint vep = { .bus_type = 0 };
604 struct v4l2_async_subdev *asd;
607 asd = kzalloc(asd_struct_size, GFP_KERNEL);
611 asd->match_type = V4L2_ASYNC_MATCH_FWNODE;
613 fwnode_graph_get_remote_port_parent(endpoint);
614 if (!asd->match.fwnode) {
615 dev_warn(dev, "bad remote port parent\n");
620 ret = v4l2_fwnode_endpoint_alloc_parse(endpoint, &vep);
622 dev_warn(dev, "unable to parse V4L2 fwnode endpoint (%d)\n",
627 ret = parse_endpoint ? parse_endpoint(dev, &vep, asd) : 0;
628 if (ret == -ENOTCONN)
629 dev_dbg(dev, "ignoring port@%u/endpoint@%u\n", vep.base.port,
633 "driver could not parse port@%u/endpoint@%u (%d)\n",
634 vep.base.port, vep.base.id, ret);
635 v4l2_fwnode_endpoint_free(&vep);
639 ret = v4l2_async_notifier_add_subdev(notifier, asd);
641 /* not an error if asd already exists */
650 fwnode_handle_put(asd->match.fwnode);
653 return ret == -ENOTCONN ? 0 : ret;
656 static int __v4l2_async_notifier_parse_fwnode_endpoints(
657 struct device *dev, struct v4l2_async_notifier *notifier,
658 size_t asd_struct_size, unsigned int port, bool has_port,
659 int (*parse_endpoint)(struct device *dev,
660 struct v4l2_fwnode_endpoint *vep,
661 struct v4l2_async_subdev *asd))
663 struct fwnode_handle *fwnode;
666 if (WARN_ON(asd_struct_size < sizeof(struct v4l2_async_subdev)))
669 fwnode_graph_for_each_endpoint(dev_fwnode(dev), fwnode) {
670 struct fwnode_handle *dev_fwnode;
673 dev_fwnode = fwnode_graph_get_port_parent(fwnode);
674 is_available = fwnode_device_is_available(dev_fwnode);
675 fwnode_handle_put(dev_fwnode);
680 struct fwnode_endpoint ep;
682 ret = fwnode_graph_parse_endpoint(fwnode, &ep);
690 ret = v4l2_async_notifier_fwnode_parse_endpoint(
691 dev, notifier, fwnode, asd_struct_size, parse_endpoint);
696 fwnode_handle_put(fwnode);
701 int v4l2_async_notifier_parse_fwnode_endpoints(
702 struct device *dev, struct v4l2_async_notifier *notifier,
703 size_t asd_struct_size,
704 int (*parse_endpoint)(struct device *dev,
705 struct v4l2_fwnode_endpoint *vep,
706 struct v4l2_async_subdev *asd))
708 return __v4l2_async_notifier_parse_fwnode_endpoints(
709 dev, notifier, asd_struct_size, 0, false, parse_endpoint);
711 EXPORT_SYMBOL_GPL(v4l2_async_notifier_parse_fwnode_endpoints);
713 int v4l2_async_notifier_parse_fwnode_endpoints_by_port(
714 struct device *dev, struct v4l2_async_notifier *notifier,
715 size_t asd_struct_size, unsigned int port,
716 int (*parse_endpoint)(struct device *dev,
717 struct v4l2_fwnode_endpoint *vep,
718 struct v4l2_async_subdev *asd))
720 return __v4l2_async_notifier_parse_fwnode_endpoints(
721 dev, notifier, asd_struct_size, port, true, parse_endpoint);
723 EXPORT_SYMBOL_GPL(v4l2_async_notifier_parse_fwnode_endpoints_by_port);
726 * v4l2_fwnode_reference_parse - parse references for async sub-devices
727 * @dev: the device node the properties of which are parsed for references
728 * @notifier: the async notifier where the async subdevs will be added
729 * @prop: the name of the property
731 * Return: 0 on success
732 * -ENOENT if no entries were found
733 * -ENOMEM if memory allocation failed
734 * -EINVAL if property parsing failed
736 static int v4l2_fwnode_reference_parse(
737 struct device *dev, struct v4l2_async_notifier *notifier,
740 struct fwnode_reference_args args;
745 !(ret = fwnode_property_get_reference_args(
746 dev_fwnode(dev), prop, NULL, 0, index, &args));
748 fwnode_handle_put(args.fwnode);
754 * Note that right now both -ENODATA and -ENOENT may signal
755 * out-of-bounds access. Return the error in cases other than that.
757 if (ret != -ENOENT && ret != -ENODATA)
760 for (index = 0; !fwnode_property_get_reference_args(
761 dev_fwnode(dev), prop, NULL, 0, index, &args);
763 struct v4l2_async_subdev *asd;
765 asd = v4l2_async_notifier_add_fwnode_subdev(
766 notifier, args.fwnode, sizeof(*asd));
769 /* not an error if asd already exists */
770 if (ret == -EEXIST) {
771 fwnode_handle_put(args.fwnode);
782 fwnode_handle_put(args.fwnode);
787 * v4l2_fwnode_reference_get_int_prop - parse a reference with integer
789 * @fwnode: fwnode to read @prop from
790 * @notifier: notifier for @dev
791 * @prop: the name of the property
792 * @index: the index of the reference to get
793 * @props: the array of integer property names
794 * @nprops: the number of integer property names in @nprops
796 * First find an fwnode referred to by the reference at @index in @prop.
798 * Then under that fwnode, @nprops times, for each property in @props,
799 * iteratively follow child nodes starting from fwnode such that they have the
800 * property in @props array at the index of the child node distance from the
801 * root node and the value of that property matching with the integer argument
802 * of the reference, at the same index.
804 * The child fwnode reched at the end of the iteration is then returned to the
807 * The core reason for this is that you cannot refer to just any node in ACPI.
808 * So to refer to an endpoint (easy in DT) you need to refer to a device, then
809 * provide a list of (property name, property value) tuples where each tuple
810 * uniquely identifies a child node. The first tuple identifies a child directly
811 * underneath the device fwnode, the next tuple identifies a child node
812 * underneath the fwnode identified by the previous tuple, etc. until you
813 * reached the fwnode you need.
815 * An example with a graph, as defined in Documentation/acpi/dsd/graph.txt:
817 * Scope (\_SB.PCI0.I2C2)
821 * Name (_DSD, Package () {
822 * ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
826 * Package () { "nokia,smia" }
829 * ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
831 * Package () { "port0", "PRT0" },
834 * Name (PRT0, Package() {
835 * ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
837 * Package () { "port", 0 },
839 * ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
841 * Package () { "endpoint0", "EP00" },
844 * Name (EP00, Package() {
845 * ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
847 * Package () { "endpoint", 0 },
851 * \_SB.PCI0.ISP, 4, 0
863 * Name (_DSD, Package () {
864 * ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
866 * Package () { "port4", "PRT4" },
870 * Name (PRT4, Package() {
871 * ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
873 * Package () { "port", 4 },
875 * ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
877 * Package () { "endpoint0", "EP40" },
881 * Name (EP40, Package() {
882 * ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
884 * Package () { "endpoint", 0 },
888 * \_SB.PCI0.I2C2.CAM0,
897 * From the EP40 node under ISP device, you could parse the graph remote
898 * endpoint using v4l2_fwnode_reference_get_int_prop with these arguments:
900 * @fwnode: fwnode referring to EP40 under ISP.
901 * @prop: "remote-endpoint"
903 * @props: "port", "endpoint"
906 * And you'd get back fwnode referring to EP00 under CAM0.
908 * The same works the other way around: if you use EP00 under CAM0 as the
909 * fwnode, you'll get fwnode referring to EP40 under ISP.
911 * The same example in DT syntax would look like this:
914 * compatible = "nokia,smia";
920 * remote-endpoint = <&isp 4 0>;
931 * remote-endpoint = <&cam 0 0>;
937 * Return: 0 on success
938 * -ENOENT if no entries (or the property itself) were found
939 * -EINVAL if property parsing otherwise failed
940 * -ENOMEM if memory allocation failed
942 static struct fwnode_handle *v4l2_fwnode_reference_get_int_prop(
943 struct fwnode_handle *fwnode, const char *prop, unsigned int index,
944 const char * const *props, unsigned int nprops)
946 struct fwnode_reference_args fwnode_args;
947 u64 *args = fwnode_args.args;
948 struct fwnode_handle *child;
952 * Obtain remote fwnode as well as the integer arguments.
954 * Note that right now both -ENODATA and -ENOENT may signal
955 * out-of-bounds access. Return -ENOENT in that case.
957 ret = fwnode_property_get_reference_args(fwnode, prop, NULL, nprops,
958 index, &fwnode_args);
960 return ERR_PTR(ret == -ENODATA ? -ENOENT : ret);
963 * Find a node in the tree under the referred fwnode corresponding to
964 * the integer arguments.
966 fwnode = fwnode_args.fwnode;
970 /* Loop over all child nodes under fwnode. */
971 fwnode_for_each_child_node(fwnode, child) {
972 if (fwnode_property_read_u32(child, *props, &val))
975 /* Found property, see if its value matches. */
980 fwnode_handle_put(fwnode);
982 /* No property found; return an error here. */
984 fwnode = ERR_PTR(-ENOENT);
997 * v4l2_fwnode_reference_parse_int_props - parse references for async
999 * @dev: struct device pointer
1000 * @notifier: notifier for @dev
1001 * @prop: the name of the property
1002 * @props: the array of integer property names
1003 * @nprops: the number of integer properties
1005 * Use v4l2_fwnode_reference_get_int_prop to find fwnodes through reference in
1006 * property @prop with integer arguments with child nodes matching in properties
1007 * @props. Then, set up V4L2 async sub-devices for those fwnodes in the notifier
1010 * While it is technically possible to use this function on DT, it is only
1011 * meaningful on ACPI. On Device tree you can refer to any node in the tree but
1012 * on ACPI the references are limited to devices.
1014 * Return: 0 on success
1015 * -ENOENT if no entries (or the property itself) were found
1016 * -EINVAL if property parsing otherwisefailed
1017 * -ENOMEM if memory allocation failed
1019 static int v4l2_fwnode_reference_parse_int_props(
1020 struct device *dev, struct v4l2_async_notifier *notifier,
1021 const char *prop, const char * const *props, unsigned int nprops)
1023 struct fwnode_handle *fwnode;
1029 fwnode = v4l2_fwnode_reference_get_int_prop(dev_fwnode(dev),
1032 if (IS_ERR(fwnode)) {
1034 * Note that right now both -ENODATA and -ENOENT may
1035 * signal out-of-bounds access. Return the error in
1036 * cases other than that.
1038 if (PTR_ERR(fwnode) != -ENOENT &&
1039 PTR_ERR(fwnode) != -ENODATA)
1040 return PTR_ERR(fwnode);
1043 fwnode_handle_put(fwnode);
1047 for (index = 0; !IS_ERR((fwnode = v4l2_fwnode_reference_get_int_prop(
1048 dev_fwnode(dev), prop, index, props,
1049 nprops))); index++) {
1050 struct v4l2_async_subdev *asd;
1052 asd = v4l2_async_notifier_add_fwnode_subdev(notifier, fwnode,
1056 /* not an error if asd already exists */
1057 if (ret == -EEXIST) {
1058 fwnode_handle_put(fwnode);
1066 return PTR_ERR(fwnode) == -ENOENT ? 0 : PTR_ERR(fwnode);
1069 fwnode_handle_put(fwnode);
1073 int v4l2_async_notifier_parse_fwnode_sensor_common(
1074 struct device *dev, struct v4l2_async_notifier *notifier)
1076 static const char * const led_props[] = { "led" };
1077 static const struct {
1079 const char * const *props;
1080 unsigned int nprops;
1082 { "flash-leds", led_props, ARRAY_SIZE(led_props) },
1083 { "lens-focus", NULL, 0 },
1087 for (i = 0; i < ARRAY_SIZE(props); i++) {
1090 if (props[i].props && is_acpi_node(dev_fwnode(dev)))
1091 ret = v4l2_fwnode_reference_parse_int_props(
1092 dev, notifier, props[i].name,
1093 props[i].props, props[i].nprops);
1095 ret = v4l2_fwnode_reference_parse(
1096 dev, notifier, props[i].name);
1097 if (ret && ret != -ENOENT) {
1098 dev_warn(dev, "parsing property \"%s\" failed (%d)\n",
1099 props[i].name, ret);
1106 EXPORT_SYMBOL_GPL(v4l2_async_notifier_parse_fwnode_sensor_common);
1108 int v4l2_async_register_subdev_sensor_common(struct v4l2_subdev *sd)
1110 struct v4l2_async_notifier *notifier;
1113 if (WARN_ON(!sd->dev))
1116 notifier = kzalloc(sizeof(*notifier), GFP_KERNEL);
1120 v4l2_async_notifier_init(notifier);
1122 ret = v4l2_async_notifier_parse_fwnode_sensor_common(sd->dev,
1127 ret = v4l2_async_subdev_notifier_register(sd, notifier);
1131 ret = v4l2_async_register_subdev(sd);
1133 goto out_unregister;
1135 sd->subdev_notifier = notifier;
1140 v4l2_async_notifier_unregister(notifier);
1143 v4l2_async_notifier_cleanup(notifier);
1148 EXPORT_SYMBOL_GPL(v4l2_async_register_subdev_sensor_common);
1150 int v4l2_async_register_fwnode_subdev(
1151 struct v4l2_subdev *sd, size_t asd_struct_size,
1152 unsigned int *ports, unsigned int num_ports,
1153 int (*parse_endpoint)(struct device *dev,
1154 struct v4l2_fwnode_endpoint *vep,
1155 struct v4l2_async_subdev *asd))
1157 struct v4l2_async_notifier *notifier;
1158 struct device *dev = sd->dev;
1159 struct fwnode_handle *fwnode;
1165 fwnode = dev_fwnode(dev);
1166 if (!fwnode_device_is_available(fwnode))
1169 notifier = kzalloc(sizeof(*notifier), GFP_KERNEL);
1173 v4l2_async_notifier_init(notifier);
1176 ret = v4l2_async_notifier_parse_fwnode_endpoints(
1177 dev, notifier, asd_struct_size, parse_endpoint);
1183 for (i = 0; i < num_ports; i++) {
1184 ret = v4l2_async_notifier_parse_fwnode_endpoints_by_port(
1185 dev, notifier, asd_struct_size,
1186 ports[i], parse_endpoint);
1192 ret = v4l2_async_subdev_notifier_register(sd, notifier);
1196 ret = v4l2_async_register_subdev(sd);
1198 goto out_unregister;
1200 sd->subdev_notifier = notifier;
1205 v4l2_async_notifier_unregister(notifier);
1207 v4l2_async_notifier_cleanup(notifier);
1212 EXPORT_SYMBOL_GPL(v4l2_async_register_fwnode_subdev);
1214 MODULE_LICENSE("GPL");
1215 MODULE_AUTHOR("Sakari Ailus <sakari.ailus@linux.intel.com>");
1216 MODULE_AUTHOR("Sylwester Nawrocki <s.nawrocki@samsung.com>");
1217 MODULE_AUTHOR("Guennadi Liakhovetski <g.liakhovetski@gmx.de>");