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.
9 * Author: Sakari Ailus <sakari.ailus@linux.intel.com>
11 * Copyright (C) 2012 - 2013 Samsung Electronics Co., Ltd.
12 * Author: Sylwester Nawrocki <s.nawrocki@samsung.com>
14 * Copyright (C) 2012 Renesas Electronics Corp.
15 * Author: Guennadi Liakhovetski <g.liakhovetski@gmx.de>
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 enum v4l2_fwnode_bus_type {
32 V4L2_FWNODE_BUS_TYPE_GUESS = 0,
33 V4L2_FWNODE_BUS_TYPE_CSI2_CPHY,
34 V4L2_FWNODE_BUS_TYPE_CSI1,
35 V4L2_FWNODE_BUS_TYPE_CCP2,
36 V4L2_FWNODE_BUS_TYPE_CSI2_DPHY,
37 V4L2_FWNODE_BUS_TYPE_PARALLEL,
38 V4L2_FWNODE_BUS_TYPE_BT656,
39 NR_OF_V4L2_FWNODE_BUS_TYPE,
42 static const struct v4l2_fwnode_bus_conv {
43 enum v4l2_fwnode_bus_type fwnode_bus_type;
44 enum v4l2_mbus_type mbus_type;
48 V4L2_FWNODE_BUS_TYPE_GUESS,
52 V4L2_FWNODE_BUS_TYPE_CSI2_CPHY,
56 V4L2_FWNODE_BUS_TYPE_CSI1,
60 V4L2_FWNODE_BUS_TYPE_CCP2,
62 "compact camera port 2",
64 V4L2_FWNODE_BUS_TYPE_CSI2_DPHY,
68 V4L2_FWNODE_BUS_TYPE_PARALLEL,
72 V4L2_FWNODE_BUS_TYPE_BT656,
78 static const struct v4l2_fwnode_bus_conv *
79 get_v4l2_fwnode_bus_conv_by_fwnode_bus(enum v4l2_fwnode_bus_type type)
83 for (i = 0; i < ARRAY_SIZE(buses); i++)
84 if (buses[i].fwnode_bus_type == type)
90 static enum v4l2_mbus_type
91 v4l2_fwnode_bus_type_to_mbus(enum v4l2_fwnode_bus_type type)
93 const struct v4l2_fwnode_bus_conv *conv =
94 get_v4l2_fwnode_bus_conv_by_fwnode_bus(type);
96 return conv ? conv->mbus_type : V4L2_MBUS_INVALID;
100 v4l2_fwnode_bus_type_to_string(enum v4l2_fwnode_bus_type type)
102 const struct v4l2_fwnode_bus_conv *conv =
103 get_v4l2_fwnode_bus_conv_by_fwnode_bus(type);
105 return conv ? conv->name : "not found";
108 static const struct v4l2_fwnode_bus_conv *
109 get_v4l2_fwnode_bus_conv_by_mbus(enum v4l2_mbus_type type)
113 for (i = 0; i < ARRAY_SIZE(buses); i++)
114 if (buses[i].mbus_type == type)
121 v4l2_fwnode_mbus_type_to_string(enum v4l2_mbus_type type)
123 const struct v4l2_fwnode_bus_conv *conv =
124 get_v4l2_fwnode_bus_conv_by_mbus(type);
126 return conv ? conv->name : "not found";
129 static int v4l2_fwnode_endpoint_parse_csi2_bus(struct fwnode_handle *fwnode,
130 struct v4l2_fwnode_endpoint *vep,
131 enum v4l2_mbus_type bus_type)
133 struct v4l2_fwnode_bus_mipi_csi2 *bus = &vep->bus.mipi_csi2;
134 bool have_clk_lane = false, have_data_lanes = false,
135 have_lane_polarities = false;
136 unsigned int flags = 0, lanes_used = 0;
137 u32 array[1 + V4L2_FWNODE_CSI2_MAX_DATA_LANES];
139 unsigned int num_data_lanes = 0;
140 bool use_default_lane_mapping = false;
145 if (bus_type == V4L2_MBUS_CSI2_DPHY ||
146 bus_type == V4L2_MBUS_CSI2_CPHY) {
147 use_default_lane_mapping = true;
149 num_data_lanes = min_t(u32, bus->num_data_lanes,
150 V4L2_FWNODE_CSI2_MAX_DATA_LANES);
152 clock_lane = bus->clock_lane;
154 use_default_lane_mapping = false;
156 for (i = 0; i < num_data_lanes; i++) {
157 array[i] = bus->data_lanes[i];
159 use_default_lane_mapping = false;
162 if (use_default_lane_mapping)
163 pr_debug("no lane mapping given, using defaults\n");
166 rval = fwnode_property_count_u32(fwnode, "data-lanes");
169 min_t(int, V4L2_FWNODE_CSI2_MAX_DATA_LANES, rval);
171 fwnode_property_read_u32_array(fwnode, "data-lanes", array,
174 have_data_lanes = true;
175 if (use_default_lane_mapping) {
176 pr_debug("data-lanes property exists; disabling default mapping\n");
177 use_default_lane_mapping = false;
181 for (i = 0; i < num_data_lanes; i++) {
182 if (lanes_used & BIT(array[i])) {
183 if (have_data_lanes || !use_default_lane_mapping)
184 pr_warn("duplicated lane %u in data-lanes, using defaults\n",
186 use_default_lane_mapping = true;
188 lanes_used |= BIT(array[i]);
191 pr_debug("lane %u position %u\n", i, array[i]);
194 rval = fwnode_property_count_u32(fwnode, "lane-polarities");
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 (have_clk_lane && lanes_used & BIT(clock_lane) &&
212 !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)) {
228 /* Only D-PHY has a clock lane. */
229 unsigned int dfl_data_lane_index =
230 bus_type == V4L2_MBUS_CSI2_DPHY;
233 if (bus_type == V4L2_MBUS_UNKNOWN)
234 vep->bus_type = V4L2_MBUS_CSI2_DPHY;
235 bus->num_data_lanes = num_data_lanes;
237 if (use_default_lane_mapping) {
239 for (i = 0; i < num_data_lanes; i++)
240 bus->data_lanes[i] = dfl_data_lane_index + i;
242 bus->clock_lane = clock_lane;
243 for (i = 0; i < num_data_lanes; i++)
244 bus->data_lanes[i] = array[i];
247 if (have_lane_polarities) {
248 fwnode_property_read_u32_array(fwnode,
249 "lane-polarities", array,
252 for (i = 0; i < 1 + num_data_lanes; i++) {
253 bus->lane_polarities[i] = array[i];
254 pr_debug("lane %u polarity %sinverted",
255 i, array[i] ? "" : "not ");
258 pr_debug("no lane polarities defined, assuming not inverted\n");
265 #define PARALLEL_MBUS_FLAGS (V4L2_MBUS_HSYNC_ACTIVE_HIGH | \
266 V4L2_MBUS_HSYNC_ACTIVE_LOW | \
267 V4L2_MBUS_VSYNC_ACTIVE_HIGH | \
268 V4L2_MBUS_VSYNC_ACTIVE_LOW | \
269 V4L2_MBUS_FIELD_EVEN_HIGH | \
270 V4L2_MBUS_FIELD_EVEN_LOW)
273 v4l2_fwnode_endpoint_parse_parallel_bus(struct fwnode_handle *fwnode,
274 struct v4l2_fwnode_endpoint *vep,
275 enum v4l2_mbus_type bus_type)
277 struct v4l2_fwnode_bus_parallel *bus = &vep->bus.parallel;
278 unsigned int flags = 0;
281 if (bus_type == V4L2_MBUS_PARALLEL || bus_type == V4L2_MBUS_BT656)
284 if (!fwnode_property_read_u32(fwnode, "hsync-active", &v)) {
285 flags &= ~(V4L2_MBUS_HSYNC_ACTIVE_HIGH |
286 V4L2_MBUS_HSYNC_ACTIVE_LOW);
287 flags |= v ? V4L2_MBUS_HSYNC_ACTIVE_HIGH :
288 V4L2_MBUS_HSYNC_ACTIVE_LOW;
289 pr_debug("hsync-active %s\n", v ? "high" : "low");
292 if (!fwnode_property_read_u32(fwnode, "vsync-active", &v)) {
293 flags &= ~(V4L2_MBUS_VSYNC_ACTIVE_HIGH |
294 V4L2_MBUS_VSYNC_ACTIVE_LOW);
295 flags |= v ? V4L2_MBUS_VSYNC_ACTIVE_HIGH :
296 V4L2_MBUS_VSYNC_ACTIVE_LOW;
297 pr_debug("vsync-active %s\n", v ? "high" : "low");
300 if (!fwnode_property_read_u32(fwnode, "field-even-active", &v)) {
301 flags &= ~(V4L2_MBUS_FIELD_EVEN_HIGH |
302 V4L2_MBUS_FIELD_EVEN_LOW);
303 flags |= v ? V4L2_MBUS_FIELD_EVEN_HIGH :
304 V4L2_MBUS_FIELD_EVEN_LOW;
305 pr_debug("field-even-active %s\n", v ? "high" : "low");
308 if (!fwnode_property_read_u32(fwnode, "pclk-sample", &v)) {
309 flags &= ~(V4L2_MBUS_PCLK_SAMPLE_RISING |
310 V4L2_MBUS_PCLK_SAMPLE_FALLING);
311 flags |= v ? V4L2_MBUS_PCLK_SAMPLE_RISING :
312 V4L2_MBUS_PCLK_SAMPLE_FALLING;
313 pr_debug("pclk-sample %s\n", v ? "high" : "low");
316 if (!fwnode_property_read_u32(fwnode, "data-active", &v)) {
317 flags &= ~(V4L2_MBUS_DATA_ACTIVE_HIGH |
318 V4L2_MBUS_DATA_ACTIVE_LOW);
319 flags |= v ? V4L2_MBUS_DATA_ACTIVE_HIGH :
320 V4L2_MBUS_DATA_ACTIVE_LOW;
321 pr_debug("data-active %s\n", v ? "high" : "low");
324 if (fwnode_property_present(fwnode, "slave-mode")) {
325 pr_debug("slave mode\n");
326 flags &= ~V4L2_MBUS_MASTER;
327 flags |= V4L2_MBUS_SLAVE;
329 flags &= ~V4L2_MBUS_SLAVE;
330 flags |= V4L2_MBUS_MASTER;
333 if (!fwnode_property_read_u32(fwnode, "bus-width", &v)) {
335 pr_debug("bus-width %u\n", v);
338 if (!fwnode_property_read_u32(fwnode, "data-shift", &v)) {
340 pr_debug("data-shift %u\n", v);
343 if (!fwnode_property_read_u32(fwnode, "sync-on-green-active", &v)) {
344 flags &= ~(V4L2_MBUS_VIDEO_SOG_ACTIVE_HIGH |
345 V4L2_MBUS_VIDEO_SOG_ACTIVE_LOW);
346 flags |= v ? V4L2_MBUS_VIDEO_SOG_ACTIVE_HIGH :
347 V4L2_MBUS_VIDEO_SOG_ACTIVE_LOW;
348 pr_debug("sync-on-green-active %s\n", v ? "high" : "low");
351 if (!fwnode_property_read_u32(fwnode, "data-enable-active", &v)) {
352 flags &= ~(V4L2_MBUS_DATA_ENABLE_HIGH |
353 V4L2_MBUS_DATA_ENABLE_LOW);
354 flags |= v ? V4L2_MBUS_DATA_ENABLE_HIGH :
355 V4L2_MBUS_DATA_ENABLE_LOW;
356 pr_debug("data-enable-active %s\n", v ? "high" : "low");
362 if (flags & PARALLEL_MBUS_FLAGS)
363 vep->bus_type = V4L2_MBUS_PARALLEL;
365 vep->bus_type = V4L2_MBUS_BT656;
367 case V4L2_MBUS_PARALLEL:
368 vep->bus_type = V4L2_MBUS_PARALLEL;
371 case V4L2_MBUS_BT656:
372 vep->bus_type = V4L2_MBUS_BT656;
373 bus->flags = flags & ~PARALLEL_MBUS_FLAGS;
379 v4l2_fwnode_endpoint_parse_csi1_bus(struct fwnode_handle *fwnode,
380 struct v4l2_fwnode_endpoint *vep,
381 enum v4l2_mbus_type bus_type)
383 struct v4l2_fwnode_bus_mipi_csi1 *bus = &vep->bus.mipi_csi1;
386 if (!fwnode_property_read_u32(fwnode, "clock-inv", &v)) {
388 pr_debug("clock-inv %u\n", v);
391 if (!fwnode_property_read_u32(fwnode, "strobe", &v)) {
393 pr_debug("strobe %u\n", v);
396 if (!fwnode_property_read_u32(fwnode, "data-lanes", &v)) {
398 pr_debug("data-lanes %u\n", v);
401 if (!fwnode_property_read_u32(fwnode, "clock-lanes", &v)) {
403 pr_debug("clock-lanes %u\n", v);
406 if (bus_type == V4L2_MBUS_CCP2)
407 vep->bus_type = V4L2_MBUS_CCP2;
409 vep->bus_type = V4L2_MBUS_CSI1;
412 static int __v4l2_fwnode_endpoint_parse(struct fwnode_handle *fwnode,
413 struct v4l2_fwnode_endpoint *vep)
415 u32 bus_type = V4L2_FWNODE_BUS_TYPE_GUESS;
416 enum v4l2_mbus_type mbus_type;
419 if (vep->bus_type == V4L2_MBUS_UNKNOWN) {
420 /* Zero fields from bus union to until the end */
422 sizeof(*vep) - offsetof(typeof(*vep), bus));
425 pr_debug("===== begin parsing endpoint %pfw\n", fwnode);
428 * Zero the fwnode graph endpoint memory in case we don't end up parsing
431 memset(&vep->base, 0, sizeof(vep->base));
433 fwnode_property_read_u32(fwnode, "bus-type", &bus_type);
434 pr_debug("fwnode video bus type %s (%u), mbus type %s (%u)\n",
435 v4l2_fwnode_bus_type_to_string(bus_type), bus_type,
436 v4l2_fwnode_mbus_type_to_string(vep->bus_type),
438 mbus_type = v4l2_fwnode_bus_type_to_mbus(bus_type);
439 if (mbus_type == V4L2_MBUS_INVALID) {
440 pr_debug("unsupported bus type %u\n", bus_type);
444 if (vep->bus_type != V4L2_MBUS_UNKNOWN) {
445 if (mbus_type != V4L2_MBUS_UNKNOWN &&
446 vep->bus_type != mbus_type) {
447 pr_debug("expecting bus type %s\n",
448 v4l2_fwnode_mbus_type_to_string(vep->bus_type));
452 vep->bus_type = mbus_type;
455 switch (vep->bus_type) {
456 case V4L2_MBUS_UNKNOWN:
457 rval = v4l2_fwnode_endpoint_parse_csi2_bus(fwnode, vep,
462 if (vep->bus_type == V4L2_MBUS_UNKNOWN)
463 v4l2_fwnode_endpoint_parse_parallel_bus(fwnode, vep,
466 pr_debug("assuming media bus type %s (%u)\n",
467 v4l2_fwnode_mbus_type_to_string(vep->bus_type),
473 v4l2_fwnode_endpoint_parse_csi1_bus(fwnode, vep, vep->bus_type);
476 case V4L2_MBUS_CSI2_DPHY:
477 case V4L2_MBUS_CSI2_CPHY:
478 rval = v4l2_fwnode_endpoint_parse_csi2_bus(fwnode, vep,
484 case V4L2_MBUS_PARALLEL:
485 case V4L2_MBUS_BT656:
486 v4l2_fwnode_endpoint_parse_parallel_bus(fwnode, vep,
491 pr_warn("unsupported bus type %u\n", mbus_type);
495 fwnode_graph_parse_endpoint(fwnode, &vep->base);
500 int v4l2_fwnode_endpoint_parse(struct fwnode_handle *fwnode,
501 struct v4l2_fwnode_endpoint *vep)
505 ret = __v4l2_fwnode_endpoint_parse(fwnode, vep);
507 pr_debug("===== end parsing endpoint %pfw\n", fwnode);
511 EXPORT_SYMBOL_GPL(v4l2_fwnode_endpoint_parse);
513 void v4l2_fwnode_endpoint_free(struct v4l2_fwnode_endpoint *vep)
515 if (IS_ERR_OR_NULL(vep))
518 kfree(vep->link_frequencies);
519 vep->link_frequencies = NULL;
521 EXPORT_SYMBOL_GPL(v4l2_fwnode_endpoint_free);
523 int v4l2_fwnode_endpoint_alloc_parse(struct fwnode_handle *fwnode,
524 struct v4l2_fwnode_endpoint *vep)
528 rval = __v4l2_fwnode_endpoint_parse(fwnode, vep);
532 rval = fwnode_property_count_u64(fwnode, "link-frequencies");
536 vep->link_frequencies =
537 kmalloc_array(rval, sizeof(*vep->link_frequencies),
539 if (!vep->link_frequencies)
542 vep->nr_of_link_frequencies = rval;
544 rval = fwnode_property_read_u64_array(fwnode,
546 vep->link_frequencies,
547 vep->nr_of_link_frequencies);
549 v4l2_fwnode_endpoint_free(vep);
553 for (i = 0; i < vep->nr_of_link_frequencies; i++)
554 pr_debug("link-frequencies %u value %llu\n", i,
555 vep->link_frequencies[i]);
558 pr_debug("===== end parsing endpoint %pfw\n", fwnode);
562 EXPORT_SYMBOL_GPL(v4l2_fwnode_endpoint_alloc_parse);
564 int v4l2_fwnode_parse_link(struct fwnode_handle *fwnode,
565 struct v4l2_fwnode_link *link)
567 struct fwnode_endpoint fwep;
569 memset(link, 0, sizeof(*link));
571 fwnode_graph_parse_endpoint(fwnode, &fwep);
572 link->local_id = fwep.id;
573 link->local_port = fwep.port;
574 link->local_node = fwnode_graph_get_port_parent(fwnode);
576 fwnode = fwnode_graph_get_remote_endpoint(fwnode);
578 fwnode_handle_put(fwnode);
582 fwnode_graph_parse_endpoint(fwnode, &fwep);
583 link->remote_id = fwep.id;
584 link->remote_port = fwep.port;
585 link->remote_node = fwnode_graph_get_port_parent(fwnode);
589 EXPORT_SYMBOL_GPL(v4l2_fwnode_parse_link);
591 void v4l2_fwnode_put_link(struct v4l2_fwnode_link *link)
593 fwnode_handle_put(link->local_node);
594 fwnode_handle_put(link->remote_node);
596 EXPORT_SYMBOL_GPL(v4l2_fwnode_put_link);
598 static const struct v4l2_fwnode_connector_conv {
599 enum v4l2_connector_type type;
600 const char *compatible;
603 .type = V4L2_CONN_COMPOSITE,
604 .compatible = "composite-video-connector",
606 .type = V4L2_CONN_SVIDEO,
607 .compatible = "svideo-connector",
611 static enum v4l2_connector_type
612 v4l2_fwnode_string_to_connector_type(const char *con_str)
616 for (i = 0; i < ARRAY_SIZE(connectors); i++)
617 if (!strcmp(con_str, connectors[i].compatible))
618 return connectors[i].type;
620 return V4L2_CONN_UNKNOWN;
624 v4l2_fwnode_connector_parse_analog(struct fwnode_handle *fwnode,
625 struct v4l2_fwnode_connector *vc)
630 ret = fwnode_property_read_u32(fwnode, "sdtv-standards", &stds);
632 /* The property is optional. */
633 vc->connector.analog.sdtv_stds = ret ? V4L2_STD_ALL : stds;
636 void v4l2_fwnode_connector_free(struct v4l2_fwnode_connector *connector)
638 struct v4l2_connector_link *link, *tmp;
640 if (IS_ERR_OR_NULL(connector) || connector->type == V4L2_CONN_UNKNOWN)
643 list_for_each_entry_safe(link, tmp, &connector->links, head) {
644 v4l2_fwnode_put_link(&link->fwnode_link);
645 list_del(&link->head);
649 kfree(connector->label);
650 connector->label = NULL;
651 connector->type = V4L2_CONN_UNKNOWN;
653 EXPORT_SYMBOL_GPL(v4l2_fwnode_connector_free);
655 static enum v4l2_connector_type
656 v4l2_fwnode_get_connector_type(struct fwnode_handle *fwnode)
658 const char *type_name;
662 return V4L2_CONN_UNKNOWN;
664 /* The connector-type is stored within the compatible string. */
665 err = fwnode_property_read_string(fwnode, "compatible", &type_name);
667 return V4L2_CONN_UNKNOWN;
669 return v4l2_fwnode_string_to_connector_type(type_name);
672 int v4l2_fwnode_connector_parse(struct fwnode_handle *fwnode,
673 struct v4l2_fwnode_connector *connector)
675 struct fwnode_handle *connector_node;
676 enum v4l2_connector_type connector_type;
683 memset(connector, 0, sizeof(*connector));
685 INIT_LIST_HEAD(&connector->links);
687 connector_node = fwnode_graph_get_port_parent(fwnode);
688 connector_type = v4l2_fwnode_get_connector_type(connector_node);
689 if (connector_type == V4L2_CONN_UNKNOWN) {
690 fwnode_handle_put(connector_node);
691 connector_node = fwnode_graph_get_remote_port_parent(fwnode);
692 connector_type = v4l2_fwnode_get_connector_type(connector_node);
695 if (connector_type == V4L2_CONN_UNKNOWN) {
696 pr_err("Unknown connector type\n");
701 connector->type = connector_type;
702 connector->name = fwnode_get_name(connector_node);
703 err = fwnode_property_read_string(connector_node, "label", &label);
704 connector->label = err ? NULL : kstrdup_const(label, GFP_KERNEL);
706 /* Parse the connector specific properties. */
707 switch (connector->type) {
708 case V4L2_CONN_COMPOSITE:
709 case V4L2_CONN_SVIDEO:
710 v4l2_fwnode_connector_parse_analog(connector_node, connector);
712 /* Avoid compiler warnings */
713 case V4L2_CONN_UNKNOWN:
718 fwnode_handle_put(connector_node);
722 EXPORT_SYMBOL_GPL(v4l2_fwnode_connector_parse);
724 int v4l2_fwnode_connector_add_link(struct fwnode_handle *fwnode,
725 struct v4l2_fwnode_connector *connector)
727 struct fwnode_handle *connector_ep;
728 struct v4l2_connector_link *link;
731 if (!fwnode || !connector || connector->type == V4L2_CONN_UNKNOWN)
734 connector_ep = fwnode_graph_get_remote_endpoint(fwnode);
738 link = kzalloc(sizeof(*link), GFP_KERNEL);
744 err = v4l2_fwnode_parse_link(connector_ep, &link->fwnode_link);
748 fwnode_handle_put(connector_ep);
750 list_add(&link->head, &connector->links);
751 connector->nr_of_links++;
757 fwnode_handle_put(connector_ep);
761 EXPORT_SYMBOL_GPL(v4l2_fwnode_connector_add_link);
763 int v4l2_fwnode_device_parse(struct device *dev,
764 struct v4l2_fwnode_device_properties *props)
766 struct fwnode_handle *fwnode = dev_fwnode(dev);
770 memset(props, 0, sizeof(*props));
772 props->orientation = V4L2_FWNODE_PROPERTY_UNSET;
773 ret = fwnode_property_read_u32(fwnode, "orientation", &val);
776 case V4L2_FWNODE_ORIENTATION_FRONT:
777 case V4L2_FWNODE_ORIENTATION_BACK:
778 case V4L2_FWNODE_ORIENTATION_EXTERNAL:
781 dev_warn(dev, "Unsupported device orientation: %u\n", val);
785 props->orientation = val;
786 dev_dbg(dev, "device orientation: %u\n", val);
789 props->rotation = V4L2_FWNODE_PROPERTY_UNSET;
790 ret = fwnode_property_read_u32(fwnode, "rotation", &val);
793 dev_warn(dev, "Unsupported device rotation: %u\n", val);
797 props->rotation = val;
798 dev_dbg(dev, "device rotation: %u\n", val);
803 EXPORT_SYMBOL_GPL(v4l2_fwnode_device_parse);
806 v4l2_async_notifier_fwnode_parse_endpoint(struct device *dev,
807 struct v4l2_async_notifier *notifier,
808 struct fwnode_handle *endpoint,
809 unsigned int asd_struct_size,
810 parse_endpoint_func parse_endpoint)
812 struct v4l2_fwnode_endpoint vep = { .bus_type = 0 };
813 struct v4l2_async_subdev *asd;
816 asd = kzalloc(asd_struct_size, GFP_KERNEL);
820 asd->match_type = V4L2_ASYNC_MATCH_FWNODE;
822 fwnode_graph_get_remote_port_parent(endpoint);
823 if (!asd->match.fwnode) {
824 dev_dbg(dev, "no remote endpoint found\n");
829 ret = v4l2_fwnode_endpoint_alloc_parse(endpoint, &vep);
831 dev_warn(dev, "unable to parse V4L2 fwnode endpoint (%d)\n",
836 ret = parse_endpoint ? parse_endpoint(dev, &vep, asd) : 0;
837 if (ret == -ENOTCONN)
838 dev_dbg(dev, "ignoring port@%u/endpoint@%u\n", vep.base.port,
842 "driver could not parse port@%u/endpoint@%u (%d)\n",
843 vep.base.port, vep.base.id, ret);
844 v4l2_fwnode_endpoint_free(&vep);
848 ret = v4l2_async_notifier_add_subdev(notifier, asd);
850 /* not an error if asd already exists */
859 fwnode_handle_put(asd->match.fwnode);
862 return ret == -ENOTCONN ? 0 : ret;
866 __v4l2_async_notifier_parse_fwnode_ep(struct device *dev,
867 struct v4l2_async_notifier *notifier,
868 size_t asd_struct_size,
871 parse_endpoint_func parse_endpoint)
873 struct fwnode_handle *fwnode;
876 if (WARN_ON(asd_struct_size < sizeof(struct v4l2_async_subdev)))
879 fwnode_graph_for_each_endpoint(dev_fwnode(dev), fwnode) {
880 struct fwnode_handle *dev_fwnode;
883 dev_fwnode = fwnode_graph_get_port_parent(fwnode);
884 is_available = fwnode_device_is_available(dev_fwnode);
885 fwnode_handle_put(dev_fwnode);
890 struct fwnode_endpoint ep;
892 ret = fwnode_graph_parse_endpoint(fwnode, &ep);
900 ret = v4l2_async_notifier_fwnode_parse_endpoint(dev,
909 fwnode_handle_put(fwnode);
915 v4l2_async_notifier_parse_fwnode_endpoints(struct device *dev,
916 struct v4l2_async_notifier *notifier,
917 size_t asd_struct_size,
918 parse_endpoint_func parse_endpoint)
920 return __v4l2_async_notifier_parse_fwnode_ep(dev, notifier,
922 false, parse_endpoint);
924 EXPORT_SYMBOL_GPL(v4l2_async_notifier_parse_fwnode_endpoints);
927 v4l2_async_notifier_parse_fwnode_endpoints_by_port(struct device *dev,
928 struct v4l2_async_notifier *notifier,
929 size_t asd_struct_size,
931 parse_endpoint_func parse_endpoint)
933 return __v4l2_async_notifier_parse_fwnode_ep(dev, notifier,
938 EXPORT_SYMBOL_GPL(v4l2_async_notifier_parse_fwnode_endpoints_by_port);
941 * v4l2_fwnode_reference_parse - parse references for async sub-devices
942 * @dev: the device node the properties of which are parsed for references
943 * @notifier: the async notifier where the async subdevs will be added
944 * @prop: the name of the property
946 * Return: 0 on success
947 * -ENOENT if no entries were found
948 * -ENOMEM if memory allocation failed
949 * -EINVAL if property parsing failed
951 static int v4l2_fwnode_reference_parse(struct device *dev,
952 struct v4l2_async_notifier *notifier,
955 struct fwnode_reference_args args;
960 !(ret = fwnode_property_get_reference_args(dev_fwnode(dev),
964 fwnode_handle_put(args.fwnode);
970 * Note that right now both -ENODATA and -ENOENT may signal
971 * out-of-bounds access. Return the error in cases other than that.
973 if (ret != -ENOENT && ret != -ENODATA)
977 !fwnode_property_get_reference_args(dev_fwnode(dev), prop, NULL,
980 struct v4l2_async_subdev *asd;
982 asd = v4l2_async_notifier_add_fwnode_subdev(notifier,
985 fwnode_handle_put(args.fwnode);
987 /* not an error if asd already exists */
988 if (PTR_ERR(asd) == -EEXIST)
999 * v4l2_fwnode_reference_get_int_prop - parse a reference with integer
1001 * @fwnode: fwnode to read @prop from
1002 * @notifier: notifier for @dev
1003 * @prop: the name of the property
1004 * @index: the index of the reference to get
1005 * @props: the array of integer property names
1006 * @nprops: the number of integer property names in @nprops
1008 * First find an fwnode referred to by the reference at @index in @prop.
1010 * Then under that fwnode, @nprops times, for each property in @props,
1011 * iteratively follow child nodes starting from fwnode such that they have the
1012 * property in @props array at the index of the child node distance from the
1013 * root node and the value of that property matching with the integer argument
1014 * of the reference, at the same index.
1016 * The child fwnode reached at the end of the iteration is then returned to the
1019 * The core reason for this is that you cannot refer to just any node in ACPI.
1020 * So to refer to an endpoint (easy in DT) you need to refer to a device, then
1021 * provide a list of (property name, property value) tuples where each tuple
1022 * uniquely identifies a child node. The first tuple identifies a child directly
1023 * underneath the device fwnode, the next tuple identifies a child node
1024 * underneath the fwnode identified by the previous tuple, etc. until you
1025 * reached the fwnode you need.
1027 * THIS EXAMPLE EXISTS MERELY TO DOCUMENT THIS FUNCTION. DO NOT USE IT AS A
1028 * REFERENCE IN HOW ACPI TABLES SHOULD BE WRITTEN!! See documentation under
1029 * Documentation/firmware-guide/acpi/dsd/ instead and especially graph.txt,
1030 * data-node-references.txt and leds.txt .
1032 * Scope (\_SB.PCI0.I2C2)
1036 * Name (_DSD, Package () {
1037 * ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
1041 * Package () { "nokia,smia" }
1044 * ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
1046 * Package () { "port0", "PRT0" },
1049 * Name (PRT0, Package() {
1050 * ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
1052 * Package () { "port", 0 },
1054 * ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
1056 * Package () { "endpoint0", "EP00" },
1059 * Name (EP00, Package() {
1060 * ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
1062 * Package () { "endpoint", 0 },
1064 * "remote-endpoint",
1066 * \_SB.PCI0.ISP, 4, 0
1078 * Name (_DSD, Package () {
1079 * ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
1081 * Package () { "port4", "PRT4" },
1085 * Name (PRT4, Package() {
1086 * ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
1088 * Package () { "port", 4 },
1090 * ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
1092 * Package () { "endpoint0", "EP40" },
1096 * Name (EP40, Package() {
1097 * ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
1099 * Package () { "endpoint", 0 },
1101 * "remote-endpoint",
1103 * \_SB.PCI0.I2C2.CAM0,
1112 * From the EP40 node under ISP device, you could parse the graph remote
1113 * endpoint using v4l2_fwnode_reference_get_int_prop with these arguments:
1115 * @fwnode: fwnode referring to EP40 under ISP.
1116 * @prop: "remote-endpoint"
1118 * @props: "port", "endpoint"
1121 * And you'd get back fwnode referring to EP00 under CAM0.
1123 * The same works the other way around: if you use EP00 under CAM0 as the
1124 * fwnode, you'll get fwnode referring to EP40 under ISP.
1126 * The same example in DT syntax would look like this:
1129 * compatible = "nokia,smia";
1135 * remote-endpoint = <&isp 4 0>;
1146 * remote-endpoint = <&cam 0 0>;
1152 * Return: 0 on success
1153 * -ENOENT if no entries (or the property itself) were found
1154 * -EINVAL if property parsing otherwise failed
1155 * -ENOMEM if memory allocation failed
1157 static struct fwnode_handle *
1158 v4l2_fwnode_reference_get_int_prop(struct fwnode_handle *fwnode,
1161 const char * const *props,
1162 unsigned int nprops)
1164 struct fwnode_reference_args fwnode_args;
1165 u64 *args = fwnode_args.args;
1166 struct fwnode_handle *child;
1170 * Obtain remote fwnode as well as the integer arguments.
1172 * Note that right now both -ENODATA and -ENOENT may signal
1173 * out-of-bounds access. Return -ENOENT in that case.
1175 ret = fwnode_property_get_reference_args(fwnode, prop, NULL, nprops,
1176 index, &fwnode_args);
1178 return ERR_PTR(ret == -ENODATA ? -ENOENT : ret);
1181 * Find a node in the tree under the referred fwnode corresponding to
1182 * the integer arguments.
1184 fwnode = fwnode_args.fwnode;
1188 /* Loop over all child nodes under fwnode. */
1189 fwnode_for_each_child_node(fwnode, child) {
1190 if (fwnode_property_read_u32(child, *props, &val))
1193 /* Found property, see if its value matches. */
1198 fwnode_handle_put(fwnode);
1200 /* No property found; return an error here. */
1202 fwnode = ERR_PTR(-ENOENT);
1214 struct v4l2_fwnode_int_props {
1216 const char * const *props;
1217 unsigned int nprops;
1221 * v4l2_fwnode_reference_parse_int_props - parse references for async
1223 * @dev: struct device pointer
1224 * @notifier: notifier for @dev
1225 * @prop: the name of the property
1226 * @props: the array of integer property names
1227 * @nprops: the number of integer properties
1229 * Use v4l2_fwnode_reference_get_int_prop to find fwnodes through reference in
1230 * property @prop with integer arguments with child nodes matching in properties
1231 * @props. Then, set up V4L2 async sub-devices for those fwnodes in the notifier
1234 * While it is technically possible to use this function on DT, it is only
1235 * meaningful on ACPI. On Device tree you can refer to any node in the tree but
1236 * on ACPI the references are limited to devices.
1238 * Return: 0 on success
1239 * -ENOENT if no entries (or the property itself) were found
1240 * -EINVAL if property parsing otherwisefailed
1241 * -ENOMEM if memory allocation failed
1244 v4l2_fwnode_reference_parse_int_props(struct device *dev,
1245 struct v4l2_async_notifier *notifier,
1246 const struct v4l2_fwnode_int_props *p)
1248 struct fwnode_handle *fwnode;
1251 const char *prop = p->name;
1252 const char * const *props = p->props;
1253 unsigned int nprops = p->nprops;
1257 fwnode = v4l2_fwnode_reference_get_int_prop(dev_fwnode(dev),
1260 if (IS_ERR(fwnode)) {
1262 * Note that right now both -ENODATA and -ENOENT may
1263 * signal out-of-bounds access. Return the error in
1264 * cases other than that.
1266 if (PTR_ERR(fwnode) != -ENOENT &&
1267 PTR_ERR(fwnode) != -ENODATA)
1268 return PTR_ERR(fwnode);
1271 fwnode_handle_put(fwnode);
1276 !IS_ERR((fwnode = v4l2_fwnode_reference_get_int_prop(dev_fwnode(dev),
1281 struct v4l2_async_subdev *asd;
1283 asd = v4l2_async_notifier_add_fwnode_subdev(notifier, fwnode,
1285 fwnode_handle_put(fwnode);
1288 /* not an error if asd already exists */
1292 return PTR_ERR(asd);
1296 return !fwnode || PTR_ERR(fwnode) == -ENOENT ? 0 : PTR_ERR(fwnode);
1299 int v4l2_async_notifier_parse_fwnode_sensor_common(struct device *dev,
1300 struct v4l2_async_notifier *notifier)
1302 static const char * const led_props[] = { "led" };
1303 static const struct v4l2_fwnode_int_props props[] = {
1304 { "flash-leds", led_props, ARRAY_SIZE(led_props) },
1305 { "lens-focus", NULL, 0 },
1309 for (i = 0; i < ARRAY_SIZE(props); i++) {
1312 if (props[i].props && is_acpi_node(dev_fwnode(dev)))
1313 ret = v4l2_fwnode_reference_parse_int_props(dev,
1317 ret = v4l2_fwnode_reference_parse(dev, notifier,
1319 if (ret && ret != -ENOENT) {
1320 dev_warn(dev, "parsing property \"%s\" failed (%d)\n",
1321 props[i].name, ret);
1328 EXPORT_SYMBOL_GPL(v4l2_async_notifier_parse_fwnode_sensor_common);
1330 int v4l2_async_register_subdev_sensor_common(struct v4l2_subdev *sd)
1332 struct v4l2_async_notifier *notifier;
1335 if (WARN_ON(!sd->dev))
1338 notifier = kzalloc(sizeof(*notifier), GFP_KERNEL);
1342 v4l2_async_notifier_init(notifier);
1344 ret = v4l2_async_notifier_parse_fwnode_sensor_common(sd->dev,
1349 ret = v4l2_async_subdev_notifier_register(sd, notifier);
1353 ret = v4l2_async_register_subdev(sd);
1355 goto out_unregister;
1357 sd->subdev_notifier = notifier;
1362 v4l2_async_notifier_unregister(notifier);
1365 v4l2_async_notifier_cleanup(notifier);
1370 EXPORT_SYMBOL_GPL(v4l2_async_register_subdev_sensor_common);
1372 MODULE_LICENSE("GPL");
1373 MODULE_AUTHOR("Sakari Ailus <sakari.ailus@linux.intel.com>");
1374 MODULE_AUTHOR("Sylwester Nawrocki <s.nawrocki@samsung.com>");
1375 MODULE_AUTHOR("Guennadi Liakhovetski <g.liakhovetski@gmx.de>");