1 // SPDX-License-Identifier: GPL-2.0-only
3 * V4L2 fwnode binding parsing library
5 * The origins of the V4L2 fwnode library are in V4L2 OF library that
6 * formerly was located in v4l2-of.c.
8 * Copyright (c) 2016 Intel Corporation.
11 * Copyright (C) 2012 - 2013 Samsung Electronics Co., Ltd.
14 * Copyright (C) 2012 Renesas Electronics Corp.
17 #include <linux/acpi.h>
18 #include <linux/kernel.h>
20 #include <linux/module.h>
22 #include <linux/property.h>
23 #include <linux/slab.h>
24 #include <linux/string.h>
25 #include <linux/types.h>
27 #include <media/v4l2-async.h>
28 #include <media/v4l2-fwnode.h>
29 #include <media/v4l2-subdev.h>
31 #include "v4l2-subdev-priv.h"
33 static const struct v4l2_fwnode_bus_conv {
34 enum v4l2_fwnode_bus_type fwnode_bus_type;
35 enum v4l2_mbus_type mbus_type;
39 V4L2_FWNODE_BUS_TYPE_GUESS,
43 V4L2_FWNODE_BUS_TYPE_CSI2_CPHY,
47 V4L2_FWNODE_BUS_TYPE_CSI1,
51 V4L2_FWNODE_BUS_TYPE_CCP2,
53 "compact camera port 2",
55 V4L2_FWNODE_BUS_TYPE_CSI2_DPHY,
59 V4L2_FWNODE_BUS_TYPE_PARALLEL,
63 V4L2_FWNODE_BUS_TYPE_BT656,
67 V4L2_FWNODE_BUS_TYPE_DPI,
73 static const struct v4l2_fwnode_bus_conv *
74 get_v4l2_fwnode_bus_conv_by_fwnode_bus(enum v4l2_fwnode_bus_type type)
78 for (i = 0; i < ARRAY_SIZE(buses); i++)
79 if (buses[i].fwnode_bus_type == type)
85 static enum v4l2_mbus_type
86 v4l2_fwnode_bus_type_to_mbus(enum v4l2_fwnode_bus_type type)
88 const struct v4l2_fwnode_bus_conv *conv =
89 get_v4l2_fwnode_bus_conv_by_fwnode_bus(type);
91 return conv ? conv->mbus_type : V4L2_MBUS_INVALID;
95 v4l2_fwnode_bus_type_to_string(enum v4l2_fwnode_bus_type type)
97 const struct v4l2_fwnode_bus_conv *conv =
98 get_v4l2_fwnode_bus_conv_by_fwnode_bus(type);
100 return conv ? conv->name : "not found";
103 static const struct v4l2_fwnode_bus_conv *
104 get_v4l2_fwnode_bus_conv_by_mbus(enum v4l2_mbus_type type)
108 for (i = 0; i < ARRAY_SIZE(buses); i++)
109 if (buses[i].mbus_type == type)
116 v4l2_fwnode_mbus_type_to_string(enum v4l2_mbus_type type)
118 const struct v4l2_fwnode_bus_conv *conv =
119 get_v4l2_fwnode_bus_conv_by_mbus(type);
121 return conv ? conv->name : "not found";
124 static int v4l2_fwnode_endpoint_parse_csi2_bus(struct fwnode_handle *fwnode,
125 struct v4l2_fwnode_endpoint *vep,
126 enum v4l2_mbus_type bus_type)
128 struct v4l2_mbus_config_mipi_csi2 *bus = &vep->bus.mipi_csi2;
129 bool have_clk_lane = false, have_data_lanes = false,
130 have_lane_polarities = false;
131 unsigned int flags = 0, lanes_used = 0;
132 u32 array[1 + V4L2_MBUS_CSI2_MAX_DATA_LANES];
134 unsigned int num_data_lanes = 0;
135 bool use_default_lane_mapping = false;
140 if (bus_type == V4L2_MBUS_CSI2_DPHY ||
141 bus_type == V4L2_MBUS_CSI2_CPHY) {
142 use_default_lane_mapping = true;
144 num_data_lanes = min_t(u32, bus->num_data_lanes,
145 V4L2_MBUS_CSI2_MAX_DATA_LANES);
147 clock_lane = bus->clock_lane;
149 use_default_lane_mapping = false;
151 for (i = 0; i < num_data_lanes; i++) {
152 array[i] = bus->data_lanes[i];
154 use_default_lane_mapping = false;
157 if (use_default_lane_mapping)
158 pr_debug("no lane mapping given, using defaults\n");
161 rval = fwnode_property_count_u32(fwnode, "data-lanes");
164 min_t(int, V4L2_MBUS_CSI2_MAX_DATA_LANES, rval);
166 fwnode_property_read_u32_array(fwnode, "data-lanes", array,
169 have_data_lanes = true;
170 if (use_default_lane_mapping) {
171 pr_debug("data-lanes property exists; disabling default mapping\n");
172 use_default_lane_mapping = false;
176 for (i = 0; i < num_data_lanes; i++) {
177 if (lanes_used & BIT(array[i])) {
178 if (have_data_lanes || !use_default_lane_mapping)
179 pr_warn("duplicated lane %u in data-lanes, using defaults\n",
181 use_default_lane_mapping = true;
183 lanes_used |= BIT(array[i]);
186 pr_debug("lane %u position %u\n", i, array[i]);
189 rval = fwnode_property_count_u32(fwnode, "lane-polarities");
191 if (rval != 1 + num_data_lanes /* clock+data */) {
192 pr_warn("invalid number of lane-polarities entries (need %u, got %u)\n",
193 1 + num_data_lanes, rval);
197 have_lane_polarities = true;
200 if (!fwnode_property_read_u32(fwnode, "clock-lanes", &v)) {
202 pr_debug("clock lane position %u\n", v);
203 have_clk_lane = true;
206 if (have_clk_lane && lanes_used & BIT(clock_lane) &&
207 !use_default_lane_mapping) {
208 pr_warn("duplicated lane %u in clock-lanes, using defaults\n",
210 use_default_lane_mapping = true;
213 if (fwnode_property_present(fwnode, "clock-noncontinuous")) {
214 flags |= V4L2_MBUS_CSI2_NONCONTINUOUS_CLOCK;
215 pr_debug("non-continuous clock\n");
218 if (bus_type == V4L2_MBUS_CSI2_DPHY ||
219 bus_type == V4L2_MBUS_CSI2_CPHY ||
220 lanes_used || have_clk_lane || flags) {
221 /* Only D-PHY has a clock lane. */
222 unsigned int dfl_data_lane_index =
223 bus_type == V4L2_MBUS_CSI2_DPHY;
226 if (bus_type == V4L2_MBUS_UNKNOWN)
227 vep->bus_type = V4L2_MBUS_CSI2_DPHY;
228 bus->num_data_lanes = num_data_lanes;
230 if (use_default_lane_mapping) {
232 for (i = 0; i < num_data_lanes; i++)
233 bus->data_lanes[i] = dfl_data_lane_index + i;
235 bus->clock_lane = clock_lane;
236 for (i = 0; i < num_data_lanes; i++)
237 bus->data_lanes[i] = array[i];
240 if (have_lane_polarities) {
241 fwnode_property_read_u32_array(fwnode,
242 "lane-polarities", array,
245 for (i = 0; i < 1 + num_data_lanes; i++) {
246 bus->lane_polarities[i] = array[i];
247 pr_debug("lane %u polarity %sinverted",
248 i, array[i] ? "" : "not ");
251 pr_debug("no lane polarities defined, assuming not inverted\n");
258 #define PARALLEL_MBUS_FLAGS (V4L2_MBUS_HSYNC_ACTIVE_HIGH | \
259 V4L2_MBUS_HSYNC_ACTIVE_LOW | \
260 V4L2_MBUS_VSYNC_ACTIVE_HIGH | \
261 V4L2_MBUS_VSYNC_ACTIVE_LOW | \
262 V4L2_MBUS_FIELD_EVEN_HIGH | \
263 V4L2_MBUS_FIELD_EVEN_LOW)
266 v4l2_fwnode_endpoint_parse_parallel_bus(struct fwnode_handle *fwnode,
267 struct v4l2_fwnode_endpoint *vep,
268 enum v4l2_mbus_type bus_type)
270 struct v4l2_mbus_config_parallel *bus = &vep->bus.parallel;
271 unsigned int flags = 0;
274 if (bus_type == V4L2_MBUS_PARALLEL || bus_type == V4L2_MBUS_BT656)
277 if (!fwnode_property_read_u32(fwnode, "hsync-active", &v)) {
278 flags &= ~(V4L2_MBUS_HSYNC_ACTIVE_HIGH |
279 V4L2_MBUS_HSYNC_ACTIVE_LOW);
280 flags |= v ? V4L2_MBUS_HSYNC_ACTIVE_HIGH :
281 V4L2_MBUS_HSYNC_ACTIVE_LOW;
282 pr_debug("hsync-active %s\n", v ? "high" : "low");
285 if (!fwnode_property_read_u32(fwnode, "vsync-active", &v)) {
286 flags &= ~(V4L2_MBUS_VSYNC_ACTIVE_HIGH |
287 V4L2_MBUS_VSYNC_ACTIVE_LOW);
288 flags |= v ? V4L2_MBUS_VSYNC_ACTIVE_HIGH :
289 V4L2_MBUS_VSYNC_ACTIVE_LOW;
290 pr_debug("vsync-active %s\n", v ? "high" : "low");
293 if (!fwnode_property_read_u32(fwnode, "field-even-active", &v)) {
294 flags &= ~(V4L2_MBUS_FIELD_EVEN_HIGH |
295 V4L2_MBUS_FIELD_EVEN_LOW);
296 flags |= v ? V4L2_MBUS_FIELD_EVEN_HIGH :
297 V4L2_MBUS_FIELD_EVEN_LOW;
298 pr_debug("field-even-active %s\n", v ? "high" : "low");
301 if (!fwnode_property_read_u32(fwnode, "pclk-sample", &v)) {
302 flags &= ~(V4L2_MBUS_PCLK_SAMPLE_RISING |
303 V4L2_MBUS_PCLK_SAMPLE_FALLING |
304 V4L2_MBUS_PCLK_SAMPLE_DUALEDGE);
307 flags |= V4L2_MBUS_PCLK_SAMPLE_FALLING;
308 pr_debug("pclk-sample low\n");
311 flags |= V4L2_MBUS_PCLK_SAMPLE_RISING;
312 pr_debug("pclk-sample high\n");
315 flags |= V4L2_MBUS_PCLK_SAMPLE_DUALEDGE;
316 pr_debug("pclk-sample dual edge\n");
319 pr_warn("invalid argument for pclk-sample");
324 if (!fwnode_property_read_u32(fwnode, "data-active", &v)) {
325 flags &= ~(V4L2_MBUS_DATA_ACTIVE_HIGH |
326 V4L2_MBUS_DATA_ACTIVE_LOW);
327 flags |= v ? V4L2_MBUS_DATA_ACTIVE_HIGH :
328 V4L2_MBUS_DATA_ACTIVE_LOW;
329 pr_debug("data-active %s\n", v ? "high" : "low");
332 if (fwnode_property_present(fwnode, "slave-mode")) {
333 pr_debug("slave mode\n");
334 flags &= ~V4L2_MBUS_MASTER;
335 flags |= V4L2_MBUS_SLAVE;
337 flags &= ~V4L2_MBUS_SLAVE;
338 flags |= V4L2_MBUS_MASTER;
341 if (!fwnode_property_read_u32(fwnode, "bus-width", &v)) {
343 pr_debug("bus-width %u\n", v);
346 if (!fwnode_property_read_u32(fwnode, "data-shift", &v)) {
348 pr_debug("data-shift %u\n", v);
351 if (!fwnode_property_read_u32(fwnode, "sync-on-green-active", &v)) {
352 flags &= ~(V4L2_MBUS_VIDEO_SOG_ACTIVE_HIGH |
353 V4L2_MBUS_VIDEO_SOG_ACTIVE_LOW);
354 flags |= v ? V4L2_MBUS_VIDEO_SOG_ACTIVE_HIGH :
355 V4L2_MBUS_VIDEO_SOG_ACTIVE_LOW;
356 pr_debug("sync-on-green-active %s\n", v ? "high" : "low");
359 if (!fwnode_property_read_u32(fwnode, "data-enable-active", &v)) {
360 flags &= ~(V4L2_MBUS_DATA_ENABLE_HIGH |
361 V4L2_MBUS_DATA_ENABLE_LOW);
362 flags |= v ? V4L2_MBUS_DATA_ENABLE_HIGH :
363 V4L2_MBUS_DATA_ENABLE_LOW;
364 pr_debug("data-enable-active %s\n", v ? "high" : "low");
370 if (flags & PARALLEL_MBUS_FLAGS)
371 vep->bus_type = V4L2_MBUS_PARALLEL;
373 vep->bus_type = V4L2_MBUS_BT656;
375 case V4L2_MBUS_PARALLEL:
376 vep->bus_type = V4L2_MBUS_PARALLEL;
379 case V4L2_MBUS_BT656:
380 vep->bus_type = V4L2_MBUS_BT656;
381 bus->flags = flags & ~PARALLEL_MBUS_FLAGS;
387 v4l2_fwnode_endpoint_parse_csi1_bus(struct fwnode_handle *fwnode,
388 struct v4l2_fwnode_endpoint *vep,
389 enum v4l2_mbus_type bus_type)
391 struct v4l2_mbus_config_mipi_csi1 *bus = &vep->bus.mipi_csi1;
394 if (!fwnode_property_read_u32(fwnode, "clock-inv", &v)) {
396 pr_debug("clock-inv %u\n", v);
399 if (!fwnode_property_read_u32(fwnode, "strobe", &v)) {
401 pr_debug("strobe %u\n", v);
404 if (!fwnode_property_read_u32(fwnode, "data-lanes", &v)) {
406 pr_debug("data-lanes %u\n", v);
409 if (!fwnode_property_read_u32(fwnode, "clock-lanes", &v)) {
411 pr_debug("clock-lanes %u\n", v);
414 if (bus_type == V4L2_MBUS_CCP2)
415 vep->bus_type = V4L2_MBUS_CCP2;
417 vep->bus_type = V4L2_MBUS_CSI1;
420 static int __v4l2_fwnode_endpoint_parse(struct fwnode_handle *fwnode,
421 struct v4l2_fwnode_endpoint *vep)
423 u32 bus_type = V4L2_FWNODE_BUS_TYPE_GUESS;
424 enum v4l2_mbus_type mbus_type;
427 pr_debug("===== begin parsing endpoint %pfw\n", fwnode);
429 fwnode_property_read_u32(fwnode, "bus-type", &bus_type);
430 pr_debug("fwnode video bus type %s (%u), mbus type %s (%u)\n",
431 v4l2_fwnode_bus_type_to_string(bus_type), bus_type,
432 v4l2_fwnode_mbus_type_to_string(vep->bus_type),
434 mbus_type = v4l2_fwnode_bus_type_to_mbus(bus_type);
435 if (mbus_type == V4L2_MBUS_INVALID) {
436 pr_debug("unsupported bus type %u\n", bus_type);
440 if (vep->bus_type != V4L2_MBUS_UNKNOWN) {
441 if (mbus_type != V4L2_MBUS_UNKNOWN &&
442 vep->bus_type != mbus_type) {
443 pr_debug("expecting bus type %s\n",
444 v4l2_fwnode_mbus_type_to_string(vep->bus_type));
448 vep->bus_type = mbus_type;
451 switch (vep->bus_type) {
452 case V4L2_MBUS_UNKNOWN:
453 rval = v4l2_fwnode_endpoint_parse_csi2_bus(fwnode, vep,
458 if (vep->bus_type == V4L2_MBUS_UNKNOWN)
459 v4l2_fwnode_endpoint_parse_parallel_bus(fwnode, vep,
462 pr_debug("assuming media bus type %s (%u)\n",
463 v4l2_fwnode_mbus_type_to_string(vep->bus_type),
469 v4l2_fwnode_endpoint_parse_csi1_bus(fwnode, vep, vep->bus_type);
472 case V4L2_MBUS_CSI2_DPHY:
473 case V4L2_MBUS_CSI2_CPHY:
474 rval = v4l2_fwnode_endpoint_parse_csi2_bus(fwnode, vep,
480 case V4L2_MBUS_PARALLEL:
481 case V4L2_MBUS_BT656:
482 v4l2_fwnode_endpoint_parse_parallel_bus(fwnode, vep,
487 pr_warn("unsupported bus type %u\n", mbus_type);
491 fwnode_graph_parse_endpoint(fwnode, &vep->base);
496 int v4l2_fwnode_endpoint_parse(struct fwnode_handle *fwnode,
497 struct v4l2_fwnode_endpoint *vep)
501 ret = __v4l2_fwnode_endpoint_parse(fwnode, vep);
503 pr_debug("===== end parsing endpoint %pfw\n", fwnode);
507 EXPORT_SYMBOL_GPL(v4l2_fwnode_endpoint_parse);
509 void v4l2_fwnode_endpoint_free(struct v4l2_fwnode_endpoint *vep)
511 if (IS_ERR_OR_NULL(vep))
514 kfree(vep->link_frequencies);
515 vep->link_frequencies = NULL;
517 EXPORT_SYMBOL_GPL(v4l2_fwnode_endpoint_free);
519 int v4l2_fwnode_endpoint_alloc_parse(struct fwnode_handle *fwnode,
520 struct v4l2_fwnode_endpoint *vep)
524 rval = __v4l2_fwnode_endpoint_parse(fwnode, vep);
528 rval = fwnode_property_count_u64(fwnode, "link-frequencies");
532 vep->link_frequencies =
533 kmalloc_array(rval, sizeof(*vep->link_frequencies),
535 if (!vep->link_frequencies)
538 vep->nr_of_link_frequencies = rval;
540 rval = fwnode_property_read_u64_array(fwnode,
542 vep->link_frequencies,
543 vep->nr_of_link_frequencies);
545 v4l2_fwnode_endpoint_free(vep);
549 for (i = 0; i < vep->nr_of_link_frequencies; i++)
550 pr_debug("link-frequencies %u value %llu\n", i,
551 vep->link_frequencies[i]);
554 pr_debug("===== end parsing endpoint %pfw\n", fwnode);
558 EXPORT_SYMBOL_GPL(v4l2_fwnode_endpoint_alloc_parse);
560 int v4l2_fwnode_parse_link(struct fwnode_handle *fwnode,
561 struct v4l2_fwnode_link *link)
563 struct fwnode_endpoint fwep;
565 memset(link, 0, sizeof(*link));
567 fwnode_graph_parse_endpoint(fwnode, &fwep);
568 link->local_id = fwep.id;
569 link->local_port = fwep.port;
570 link->local_node = fwnode_graph_get_port_parent(fwnode);
572 fwnode = fwnode_graph_get_remote_endpoint(fwnode);
574 fwnode_handle_put(fwnode);
578 fwnode_graph_parse_endpoint(fwnode, &fwep);
579 link->remote_id = fwep.id;
580 link->remote_port = fwep.port;
581 link->remote_node = fwnode_graph_get_port_parent(fwnode);
585 EXPORT_SYMBOL_GPL(v4l2_fwnode_parse_link);
587 void v4l2_fwnode_put_link(struct v4l2_fwnode_link *link)
589 fwnode_handle_put(link->local_node);
590 fwnode_handle_put(link->remote_node);
592 EXPORT_SYMBOL_GPL(v4l2_fwnode_put_link);
594 static const struct v4l2_fwnode_connector_conv {
595 enum v4l2_connector_type type;
596 const char *compatible;
599 .type = V4L2_CONN_COMPOSITE,
600 .compatible = "composite-video-connector",
602 .type = V4L2_CONN_SVIDEO,
603 .compatible = "svideo-connector",
607 static enum v4l2_connector_type
608 v4l2_fwnode_string_to_connector_type(const char *con_str)
612 for (i = 0; i < ARRAY_SIZE(connectors); i++)
613 if (!strcmp(con_str, connectors[i].compatible))
614 return connectors[i].type;
616 return V4L2_CONN_UNKNOWN;
620 v4l2_fwnode_connector_parse_analog(struct fwnode_handle *fwnode,
621 struct v4l2_fwnode_connector *vc)
626 ret = fwnode_property_read_u32(fwnode, "sdtv-standards", &stds);
628 /* The property is optional. */
629 vc->connector.analog.sdtv_stds = ret ? V4L2_STD_ALL : stds;
632 void v4l2_fwnode_connector_free(struct v4l2_fwnode_connector *connector)
634 struct v4l2_connector_link *link, *tmp;
636 if (IS_ERR_OR_NULL(connector) || connector->type == V4L2_CONN_UNKNOWN)
639 list_for_each_entry_safe(link, tmp, &connector->links, head) {
640 v4l2_fwnode_put_link(&link->fwnode_link);
641 list_del(&link->head);
645 kfree(connector->label);
646 connector->label = NULL;
647 connector->type = V4L2_CONN_UNKNOWN;
649 EXPORT_SYMBOL_GPL(v4l2_fwnode_connector_free);
651 static enum v4l2_connector_type
652 v4l2_fwnode_get_connector_type(struct fwnode_handle *fwnode)
654 const char *type_name;
658 return V4L2_CONN_UNKNOWN;
660 /* The connector-type is stored within the compatible string. */
661 err = fwnode_property_read_string(fwnode, "compatible", &type_name);
663 return V4L2_CONN_UNKNOWN;
665 return v4l2_fwnode_string_to_connector_type(type_name);
668 int v4l2_fwnode_connector_parse(struct fwnode_handle *fwnode,
669 struct v4l2_fwnode_connector *connector)
671 struct fwnode_handle *connector_node;
672 enum v4l2_connector_type connector_type;
679 memset(connector, 0, sizeof(*connector));
681 INIT_LIST_HEAD(&connector->links);
683 connector_node = fwnode_graph_get_port_parent(fwnode);
684 connector_type = v4l2_fwnode_get_connector_type(connector_node);
685 if (connector_type == V4L2_CONN_UNKNOWN) {
686 fwnode_handle_put(connector_node);
687 connector_node = fwnode_graph_get_remote_port_parent(fwnode);
688 connector_type = v4l2_fwnode_get_connector_type(connector_node);
691 if (connector_type == V4L2_CONN_UNKNOWN) {
692 pr_err("Unknown connector type\n");
697 connector->type = connector_type;
698 connector->name = fwnode_get_name(connector_node);
699 err = fwnode_property_read_string(connector_node, "label", &label);
700 connector->label = err ? NULL : kstrdup_const(label, GFP_KERNEL);
702 /* Parse the connector specific properties. */
703 switch (connector->type) {
704 case V4L2_CONN_COMPOSITE:
705 case V4L2_CONN_SVIDEO:
706 v4l2_fwnode_connector_parse_analog(connector_node, connector);
708 /* Avoid compiler warnings */
709 case V4L2_CONN_UNKNOWN:
714 fwnode_handle_put(connector_node);
718 EXPORT_SYMBOL_GPL(v4l2_fwnode_connector_parse);
720 int v4l2_fwnode_connector_add_link(struct fwnode_handle *fwnode,
721 struct v4l2_fwnode_connector *connector)
723 struct fwnode_handle *connector_ep;
724 struct v4l2_connector_link *link;
727 if (!fwnode || !connector || connector->type == V4L2_CONN_UNKNOWN)
730 connector_ep = fwnode_graph_get_remote_endpoint(fwnode);
734 link = kzalloc(sizeof(*link), GFP_KERNEL);
740 err = v4l2_fwnode_parse_link(connector_ep, &link->fwnode_link);
744 fwnode_handle_put(connector_ep);
746 list_add(&link->head, &connector->links);
747 connector->nr_of_links++;
753 fwnode_handle_put(connector_ep);
757 EXPORT_SYMBOL_GPL(v4l2_fwnode_connector_add_link);
759 int v4l2_fwnode_device_parse(struct device *dev,
760 struct v4l2_fwnode_device_properties *props)
762 struct fwnode_handle *fwnode = dev_fwnode(dev);
766 memset(props, 0, sizeof(*props));
768 props->orientation = V4L2_FWNODE_PROPERTY_UNSET;
769 ret = fwnode_property_read_u32(fwnode, "orientation", &val);
772 case V4L2_FWNODE_ORIENTATION_FRONT:
773 case V4L2_FWNODE_ORIENTATION_BACK:
774 case V4L2_FWNODE_ORIENTATION_EXTERNAL:
777 dev_warn(dev, "Unsupported device orientation: %u\n", val);
781 props->orientation = val;
782 dev_dbg(dev, "device orientation: %u\n", val);
785 props->rotation = V4L2_FWNODE_PROPERTY_UNSET;
786 ret = fwnode_property_read_u32(fwnode, "rotation", &val);
789 dev_warn(dev, "Unsupported device rotation: %u\n", val);
793 props->rotation = val;
794 dev_dbg(dev, "device rotation: %u\n", val);
799 EXPORT_SYMBOL_GPL(v4l2_fwnode_device_parse);
802 v4l2_async_nf_fwnode_parse_endpoint(struct device *dev,
803 struct v4l2_async_notifier *notifier,
804 struct fwnode_handle *endpoint,
805 unsigned int asd_struct_size,
806 parse_endpoint_func parse_endpoint)
808 struct v4l2_fwnode_endpoint vep = { .bus_type = 0 };
809 struct v4l2_async_subdev *asd;
812 asd = kzalloc(asd_struct_size, GFP_KERNEL);
816 asd->match_type = V4L2_ASYNC_MATCH_FWNODE;
818 fwnode_graph_get_remote_port_parent(endpoint);
819 if (!asd->match.fwnode) {
820 dev_dbg(dev, "no remote endpoint found\n");
825 ret = v4l2_fwnode_endpoint_alloc_parse(endpoint, &vep);
827 dev_warn(dev, "unable to parse V4L2 fwnode endpoint (%d)\n",
832 ret = parse_endpoint ? parse_endpoint(dev, &vep, asd) : 0;
833 if (ret == -ENOTCONN)
834 dev_dbg(dev, "ignoring port@%u/endpoint@%u\n", vep.base.port,
838 "driver could not parse port@%u/endpoint@%u (%d)\n",
839 vep.base.port, vep.base.id, ret);
840 v4l2_fwnode_endpoint_free(&vep);
844 ret = __v4l2_async_nf_add_subdev(notifier, asd);
846 /* not an error if asd already exists */
855 fwnode_handle_put(asd->match.fwnode);
858 return ret == -ENOTCONN ? 0 : ret;
862 v4l2_async_nf_parse_fwnode_endpoints(struct device *dev,
863 struct v4l2_async_notifier *notifier,
864 size_t asd_struct_size,
865 parse_endpoint_func parse_endpoint)
867 struct fwnode_handle *fwnode;
870 if (WARN_ON(asd_struct_size < sizeof(struct v4l2_async_subdev)))
873 fwnode_graph_for_each_endpoint(dev_fwnode(dev), fwnode) {
874 struct fwnode_handle *dev_fwnode;
877 dev_fwnode = fwnode_graph_get_port_parent(fwnode);
878 is_available = fwnode_device_is_available(dev_fwnode);
879 fwnode_handle_put(dev_fwnode);
884 ret = v4l2_async_nf_fwnode_parse_endpoint(dev, notifier,
892 fwnode_handle_put(fwnode);
896 EXPORT_SYMBOL_GPL(v4l2_async_nf_parse_fwnode_endpoints);
899 * v4l2_fwnode_reference_parse - parse references for async sub-devices
900 * @dev: the device node the properties of which are parsed for references
901 * @notifier: the async notifier where the async subdevs will be added
902 * @prop: the name of the property
904 * Return: 0 on success
905 * -ENOENT if no entries were found
906 * -ENOMEM if memory allocation failed
907 * -EINVAL if property parsing failed
909 static int v4l2_fwnode_reference_parse(struct device *dev,
910 struct v4l2_async_notifier *notifier,
913 struct fwnode_reference_args args;
918 !(ret = fwnode_property_get_reference_args(dev_fwnode(dev), prop,
919 NULL, 0, index, &args));
921 struct v4l2_async_subdev *asd;
923 asd = v4l2_async_nf_add_fwnode(notifier, args.fwnode,
924 struct v4l2_async_subdev);
925 fwnode_handle_put(args.fwnode);
927 /* not an error if asd already exists */
928 if (PTR_ERR(asd) == -EEXIST)
935 /* -ENOENT here means successful parsing */
939 /* Return -ENOENT if no references were found */
940 return index ? 0 : -ENOENT;
944 * v4l2_fwnode_reference_get_int_prop - parse a reference with integer
946 * @fwnode: fwnode to read @prop from
947 * @notifier: notifier for @dev
948 * @prop: the name of the property
949 * @index: the index of the reference to get
950 * @props: the array of integer property names
951 * @nprops: the number of integer property names in @nprops
953 * First find an fwnode referred to by the reference at @index in @prop.
955 * Then under that fwnode, @nprops times, for each property in @props,
956 * iteratively follow child nodes starting from fwnode such that they have the
957 * property in @props array at the index of the child node distance from the
958 * root node and the value of that property matching with the integer argument
959 * of the reference, at the same index.
961 * The child fwnode reached at the end of the iteration is then returned to the
964 * The core reason for this is that you cannot refer to just any node in ACPI.
965 * So to refer to an endpoint (easy in DT) you need to refer to a device, then
966 * provide a list of (property name, property value) tuples where each tuple
967 * uniquely identifies a child node. The first tuple identifies a child directly
968 * underneath the device fwnode, the next tuple identifies a child node
969 * underneath the fwnode identified by the previous tuple, etc. until you
970 * reached the fwnode you need.
972 * THIS EXAMPLE EXISTS MERELY TO DOCUMENT THIS FUNCTION. DO NOT USE IT AS A
973 * REFERENCE IN HOW ACPI TABLES SHOULD BE WRITTEN!! See documentation under
974 * Documentation/firmware-guide/acpi/dsd/ instead and especially graph.txt,
975 * data-node-references.txt and leds.txt .
977 * Scope (\_SB.PCI0.I2C2)
981 * Name (_DSD, Package () {
982 * ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
986 * Package () { "nokia,smia" }
989 * ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
991 * Package () { "port0", "PRT0" },
994 * Name (PRT0, Package() {
995 * ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
997 * Package () { "port", 0 },
999 * ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
1001 * Package () { "endpoint0", "EP00" },
1004 * Name (EP00, Package() {
1005 * ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
1007 * Package () { "endpoint", 0 },
1009 * "remote-endpoint",
1011 * \_SB.PCI0.ISP, 4, 0
1023 * Name (_DSD, Package () {
1024 * ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
1026 * Package () { "port4", "PRT4" },
1030 * Name (PRT4, Package() {
1031 * ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
1033 * Package () { "port", 4 },
1035 * ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
1037 * Package () { "endpoint0", "EP40" },
1041 * Name (EP40, Package() {
1042 * ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
1044 * Package () { "endpoint", 0 },
1046 * "remote-endpoint",
1048 * \_SB.PCI0.I2C2.CAM0,
1057 * From the EP40 node under ISP device, you could parse the graph remote
1058 * endpoint using v4l2_fwnode_reference_get_int_prop with these arguments:
1060 * @fwnode: fwnode referring to EP40 under ISP.
1061 * @prop: "remote-endpoint"
1063 * @props: "port", "endpoint"
1066 * And you'd get back fwnode referring to EP00 under CAM0.
1068 * The same works the other way around: if you use EP00 under CAM0 as the
1069 * fwnode, you'll get fwnode referring to EP40 under ISP.
1071 * The same example in DT syntax would look like this:
1074 * compatible = "nokia,smia";
1080 * remote-endpoint = <&isp 4 0>;
1091 * remote-endpoint = <&cam 0 0>;
1097 * Return: 0 on success
1098 * -ENOENT if no entries (or the property itself) were found
1099 * -EINVAL if property parsing otherwise failed
1100 * -ENOMEM if memory allocation failed
1102 static struct fwnode_handle *
1103 v4l2_fwnode_reference_get_int_prop(struct fwnode_handle *fwnode,
1106 const char * const *props,
1107 unsigned int nprops)
1109 struct fwnode_reference_args fwnode_args;
1110 u64 *args = fwnode_args.args;
1111 struct fwnode_handle *child;
1115 * Obtain remote fwnode as well as the integer arguments.
1117 * Note that right now both -ENODATA and -ENOENT may signal
1118 * out-of-bounds access. Return -ENOENT in that case.
1120 ret = fwnode_property_get_reference_args(fwnode, prop, NULL, nprops,
1121 index, &fwnode_args);
1123 return ERR_PTR(ret == -ENODATA ? -ENOENT : ret);
1126 * Find a node in the tree under the referred fwnode corresponding to
1127 * the integer arguments.
1129 fwnode = fwnode_args.fwnode;
1133 /* Loop over all child nodes under fwnode. */
1134 fwnode_for_each_child_node(fwnode, child) {
1135 if (fwnode_property_read_u32(child, *props, &val))
1138 /* Found property, see if its value matches. */
1143 fwnode_handle_put(fwnode);
1145 /* No property found; return an error here. */
1147 fwnode = ERR_PTR(-ENOENT);
1159 struct v4l2_fwnode_int_props {
1161 const char * const *props;
1162 unsigned int nprops;
1166 * v4l2_fwnode_reference_parse_int_props - parse references for async
1168 * @dev: struct device pointer
1169 * @notifier: notifier for @dev
1170 * @prop: the name of the property
1171 * @props: the array of integer property names
1172 * @nprops: the number of integer properties
1174 * Use v4l2_fwnode_reference_get_int_prop to find fwnodes through reference in
1175 * property @prop with integer arguments with child nodes matching in properties
1176 * @props. Then, set up V4L2 async sub-devices for those fwnodes in the notifier
1179 * While it is technically possible to use this function on DT, it is only
1180 * meaningful on ACPI. On Device tree you can refer to any node in the tree but
1181 * on ACPI the references are limited to devices.
1183 * Return: 0 on success
1184 * -ENOENT if no entries (or the property itself) were found
1185 * -EINVAL if property parsing otherwisefailed
1186 * -ENOMEM if memory allocation failed
1189 v4l2_fwnode_reference_parse_int_props(struct device *dev,
1190 struct v4l2_async_notifier *notifier,
1191 const struct v4l2_fwnode_int_props *p)
1193 struct fwnode_handle *fwnode;
1196 const char *prop = p->name;
1197 const char * const *props = p->props;
1198 unsigned int nprops = p->nprops;
1202 fwnode = v4l2_fwnode_reference_get_int_prop(dev_fwnode(dev),
1205 if (IS_ERR(fwnode)) {
1207 * Note that right now both -ENODATA and -ENOENT may
1208 * signal out-of-bounds access. Return the error in
1209 * cases other than that.
1211 if (PTR_ERR(fwnode) != -ENOENT &&
1212 PTR_ERR(fwnode) != -ENODATA)
1213 return PTR_ERR(fwnode);
1216 fwnode_handle_put(fwnode);
1221 !IS_ERR((fwnode = v4l2_fwnode_reference_get_int_prop(dev_fwnode(dev),
1226 struct v4l2_async_subdev *asd;
1228 asd = v4l2_async_nf_add_fwnode(notifier, fwnode,
1229 struct v4l2_async_subdev);
1230 fwnode_handle_put(fwnode);
1233 /* not an error if asd already exists */
1237 return PTR_ERR(asd);
1241 return !fwnode || PTR_ERR(fwnode) == -ENOENT ? 0 : PTR_ERR(fwnode);
1245 * v4l2_async_nf_parse_fwnode_sensor - parse common references on
1246 * sensors for async sub-devices
1247 * @dev: the device node the properties of which are parsed for references
1248 * @notifier: the async notifier where the async subdevs will be added
1250 * Parse common sensor properties for remote devices related to the
1251 * sensor and set up async sub-devices for them.
1253 * Any notifier populated using this function must be released with a call to
1254 * v4l2_async_nf_release() after it has been unregistered and the async
1255 * sub-devices are no longer in use, even in the case the function returned an
1258 * Return: 0 on success
1259 * -ENOMEM if memory allocation failed
1260 * -EINVAL if property parsing failed
1263 v4l2_async_nf_parse_fwnode_sensor(struct device *dev,
1264 struct v4l2_async_notifier *notifier)
1266 static const char * const led_props[] = { "led" };
1267 static const struct v4l2_fwnode_int_props props[] = {
1268 { "flash-leds", led_props, ARRAY_SIZE(led_props) },
1269 { "lens-focus", NULL, 0 },
1273 for (i = 0; i < ARRAY_SIZE(props); i++) {
1276 if (props[i].props && is_acpi_node(dev_fwnode(dev)))
1277 ret = v4l2_fwnode_reference_parse_int_props(dev,
1281 ret = v4l2_fwnode_reference_parse(dev, notifier,
1283 if (ret && ret != -ENOENT) {
1284 dev_warn(dev, "parsing property \"%s\" failed (%d)\n",
1285 props[i].name, ret);
1293 int v4l2_async_register_subdev_sensor(struct v4l2_subdev *sd)
1295 struct v4l2_async_notifier *notifier;
1298 if (WARN_ON(!sd->dev))
1301 notifier = kzalloc(sizeof(*notifier), GFP_KERNEL);
1305 v4l2_async_nf_init(notifier);
1307 ret = v4l2_subdev_get_privacy_led(sd);
1311 ret = v4l2_async_nf_parse_fwnode_sensor(sd->dev, notifier);
1315 ret = v4l2_async_subdev_nf_register(sd, notifier);
1319 ret = v4l2_async_register_subdev(sd);
1321 goto out_unregister;
1323 sd->subdev_notifier = notifier;
1328 v4l2_async_nf_unregister(notifier);
1331 v4l2_subdev_put_privacy_led(sd);
1332 v4l2_async_nf_cleanup(notifier);
1337 EXPORT_SYMBOL_GPL(v4l2_async_register_subdev_sensor);
1339 MODULE_LICENSE("GPL");