1 // SPDX-License-Identifier: GPL-2.0-only 2 /* 3 * V4L2 fwnode binding parsing library 4 * 5 * The origins of the V4L2 fwnode library are in V4L2 OF library that 6 * formerly was located in v4l2-of.c. 7 * 8 * Copyright (c) 2016 Intel Corporation. 9 * Author: Sakari Ailus <sakari.ailus@linux.intel.com> 10 * 11 * Copyright (C) 2012 - 2013 Samsung Electronics Co., Ltd. 12 * Author: Sylwester Nawrocki <s.nawrocki@samsung.com> 13 * 14 * Copyright (C) 2012 Renesas Electronics Corp. 15 * Author: Guennadi Liakhovetski <g.liakhovetski@gmx.de> 16 */ 17 #include <linux/acpi.h> 18 #include <linux/kernel.h> 19 #include <linux/mm.h> 20 #include <linux/module.h> 21 #include <linux/of.h> 22 #include <linux/property.h> 23 #include <linux/slab.h> 24 #include <linux/string.h> 25 #include <linux/types.h> 26 27 #include <media/v4l2-async.h> 28 #include <media/v4l2-fwnode.h> 29 #include <media/v4l2-subdev.h> 30 31 static const struct v4l2_fwnode_bus_conv { 32 enum v4l2_fwnode_bus_type fwnode_bus_type; 33 enum v4l2_mbus_type mbus_type; 34 const char *name; 35 } buses[] = { 36 { 37 V4L2_FWNODE_BUS_TYPE_GUESS, 38 V4L2_MBUS_UNKNOWN, 39 "not specified", 40 }, { 41 V4L2_FWNODE_BUS_TYPE_CSI2_CPHY, 42 V4L2_MBUS_CSI2_CPHY, 43 "MIPI CSI-2 C-PHY", 44 }, { 45 V4L2_FWNODE_BUS_TYPE_CSI1, 46 V4L2_MBUS_CSI1, 47 "MIPI CSI-1", 48 }, { 49 V4L2_FWNODE_BUS_TYPE_CCP2, 50 V4L2_MBUS_CCP2, 51 "compact camera port 2", 52 }, { 53 V4L2_FWNODE_BUS_TYPE_CSI2_DPHY, 54 V4L2_MBUS_CSI2_DPHY, 55 "MIPI CSI-2 D-PHY", 56 }, { 57 V4L2_FWNODE_BUS_TYPE_PARALLEL, 58 V4L2_MBUS_PARALLEL, 59 "parallel", 60 }, { 61 V4L2_FWNODE_BUS_TYPE_BT656, 62 V4L2_MBUS_BT656, 63 "Bt.656", 64 } 65 }; 66 67 static const struct v4l2_fwnode_bus_conv * 68 get_v4l2_fwnode_bus_conv_by_fwnode_bus(enum v4l2_fwnode_bus_type type) 69 { 70 unsigned int i; 71 72 for (i = 0; i < ARRAY_SIZE(buses); i++) 73 if (buses[i].fwnode_bus_type == type) 74 return &buses[i]; 75 76 return NULL; 77 } 78 79 static enum v4l2_mbus_type 80 v4l2_fwnode_bus_type_to_mbus(enum v4l2_fwnode_bus_type type) 81 { 82 const struct v4l2_fwnode_bus_conv *conv = 83 get_v4l2_fwnode_bus_conv_by_fwnode_bus(type); 84 85 return conv ? conv->mbus_type : V4L2_MBUS_INVALID; 86 } 87 88 static const char * 89 v4l2_fwnode_bus_type_to_string(enum v4l2_fwnode_bus_type type) 90 { 91 const struct v4l2_fwnode_bus_conv *conv = 92 get_v4l2_fwnode_bus_conv_by_fwnode_bus(type); 93 94 return conv ? conv->name : "not found"; 95 } 96 97 static const struct v4l2_fwnode_bus_conv * 98 get_v4l2_fwnode_bus_conv_by_mbus(enum v4l2_mbus_type type) 99 { 100 unsigned int i; 101 102 for (i = 0; i < ARRAY_SIZE(buses); i++) 103 if (buses[i].mbus_type == type) 104 return &buses[i]; 105 106 return NULL; 107 } 108 109 static const char * 110 v4l2_fwnode_mbus_type_to_string(enum v4l2_mbus_type type) 111 { 112 const struct v4l2_fwnode_bus_conv *conv = 113 get_v4l2_fwnode_bus_conv_by_mbus(type); 114 115 return conv ? conv->name : "not found"; 116 } 117 118 static int v4l2_fwnode_endpoint_parse_csi2_bus(struct fwnode_handle *fwnode, 119 struct v4l2_fwnode_endpoint *vep, 120 enum v4l2_mbus_type bus_type) 121 { 122 struct v4l2_fwnode_bus_mipi_csi2 *bus = &vep->bus.mipi_csi2; 123 bool have_clk_lane = false, have_data_lanes = false, 124 have_lane_polarities = false; 125 unsigned int flags = 0, lanes_used = 0; 126 u32 array[1 + V4L2_FWNODE_CSI2_MAX_DATA_LANES]; 127 u32 clock_lane = 0; 128 unsigned int num_data_lanes = 0; 129 bool use_default_lane_mapping = false; 130 unsigned int i; 131 u32 v; 132 int rval; 133 134 if (bus_type == V4L2_MBUS_CSI2_DPHY || 135 bus_type == V4L2_MBUS_CSI2_CPHY) { 136 use_default_lane_mapping = true; 137 138 num_data_lanes = min_t(u32, bus->num_data_lanes, 139 V4L2_FWNODE_CSI2_MAX_DATA_LANES); 140 141 clock_lane = bus->clock_lane; 142 if (clock_lane) 143 use_default_lane_mapping = false; 144 145 for (i = 0; i < num_data_lanes; i++) { 146 array[i] = bus->data_lanes[i]; 147 if (array[i]) 148 use_default_lane_mapping = false; 149 } 150 151 if (use_default_lane_mapping) 152 pr_debug("no lane mapping given, using defaults\n"); 153 } 154 155 rval = fwnode_property_count_u32(fwnode, "data-lanes"); 156 if (rval > 0) { 157 num_data_lanes = 158 min_t(int, V4L2_FWNODE_CSI2_MAX_DATA_LANES, rval); 159 160 fwnode_property_read_u32_array(fwnode, "data-lanes", array, 161 num_data_lanes); 162 163 have_data_lanes = true; 164 if (use_default_lane_mapping) { 165 pr_debug("data-lanes property exists; disabling default mapping\n"); 166 use_default_lane_mapping = false; 167 } 168 } 169 170 for (i = 0; i < num_data_lanes; i++) { 171 if (lanes_used & BIT(array[i])) { 172 if (have_data_lanes || !use_default_lane_mapping) 173 pr_warn("duplicated lane %u in data-lanes, using defaults\n", 174 array[i]); 175 use_default_lane_mapping = true; 176 } 177 lanes_used |= BIT(array[i]); 178 179 if (have_data_lanes) 180 pr_debug("lane %u position %u\n", i, array[i]); 181 } 182 183 rval = fwnode_property_count_u32(fwnode, "lane-polarities"); 184 if (rval > 0) { 185 if (rval != 1 + num_data_lanes /* clock+data */) { 186 pr_warn("invalid number of lane-polarities entries (need %u, got %u)\n", 187 1 + num_data_lanes, rval); 188 return -EINVAL; 189 } 190 191 have_lane_polarities = true; 192 } 193 194 if (!fwnode_property_read_u32(fwnode, "clock-lanes", &v)) { 195 clock_lane = v; 196 pr_debug("clock lane position %u\n", v); 197 have_clk_lane = true; 198 } 199 200 if (have_clk_lane && lanes_used & BIT(clock_lane) && 201 !use_default_lane_mapping) { 202 pr_warn("duplicated lane %u in clock-lanes, using defaults\n", 203 v); 204 use_default_lane_mapping = true; 205 } 206 207 if (fwnode_property_present(fwnode, "clock-noncontinuous")) { 208 flags |= V4L2_MBUS_CSI2_NONCONTINUOUS_CLOCK; 209 pr_debug("non-continuous clock\n"); 210 } else { 211 flags |= V4L2_MBUS_CSI2_CONTINUOUS_CLOCK; 212 } 213 214 if (bus_type == V4L2_MBUS_CSI2_DPHY || 215 bus_type == V4L2_MBUS_CSI2_CPHY || lanes_used || 216 have_clk_lane || (flags & ~V4L2_MBUS_CSI2_CONTINUOUS_CLOCK)) { 217 /* Only D-PHY has a clock lane. */ 218 unsigned int dfl_data_lane_index = 219 bus_type == V4L2_MBUS_CSI2_DPHY; 220 221 bus->flags = flags; 222 if (bus_type == V4L2_MBUS_UNKNOWN) 223 vep->bus_type = V4L2_MBUS_CSI2_DPHY; 224 bus->num_data_lanes = num_data_lanes; 225 226 if (use_default_lane_mapping) { 227 bus->clock_lane = 0; 228 for (i = 0; i < num_data_lanes; i++) 229 bus->data_lanes[i] = dfl_data_lane_index + i; 230 } else { 231 bus->clock_lane = clock_lane; 232 for (i = 0; i < num_data_lanes; i++) 233 bus->data_lanes[i] = array[i]; 234 } 235 236 if (have_lane_polarities) { 237 fwnode_property_read_u32_array(fwnode, 238 "lane-polarities", array, 239 1 + num_data_lanes); 240 241 for (i = 0; i < 1 + num_data_lanes; i++) { 242 bus->lane_polarities[i] = array[i]; 243 pr_debug("lane %u polarity %sinverted", 244 i, array[i] ? "" : "not "); 245 } 246 } else { 247 pr_debug("no lane polarities defined, assuming not inverted\n"); 248 } 249 } 250 251 return 0; 252 } 253 254 #define PARALLEL_MBUS_FLAGS (V4L2_MBUS_HSYNC_ACTIVE_HIGH | \ 255 V4L2_MBUS_HSYNC_ACTIVE_LOW | \ 256 V4L2_MBUS_VSYNC_ACTIVE_HIGH | \ 257 V4L2_MBUS_VSYNC_ACTIVE_LOW | \ 258 V4L2_MBUS_FIELD_EVEN_HIGH | \ 259 V4L2_MBUS_FIELD_EVEN_LOW) 260 261 static void 262 v4l2_fwnode_endpoint_parse_parallel_bus(struct fwnode_handle *fwnode, 263 struct v4l2_fwnode_endpoint *vep, 264 enum v4l2_mbus_type bus_type) 265 { 266 struct v4l2_fwnode_bus_parallel *bus = &vep->bus.parallel; 267 unsigned int flags = 0; 268 u32 v; 269 270 if (bus_type == V4L2_MBUS_PARALLEL || bus_type == V4L2_MBUS_BT656) 271 flags = bus->flags; 272 273 if (!fwnode_property_read_u32(fwnode, "hsync-active", &v)) { 274 flags &= ~(V4L2_MBUS_HSYNC_ACTIVE_HIGH | 275 V4L2_MBUS_HSYNC_ACTIVE_LOW); 276 flags |= v ? V4L2_MBUS_HSYNC_ACTIVE_HIGH : 277 V4L2_MBUS_HSYNC_ACTIVE_LOW; 278 pr_debug("hsync-active %s\n", v ? "high" : "low"); 279 } 280 281 if (!fwnode_property_read_u32(fwnode, "vsync-active", &v)) { 282 flags &= ~(V4L2_MBUS_VSYNC_ACTIVE_HIGH | 283 V4L2_MBUS_VSYNC_ACTIVE_LOW); 284 flags |= v ? V4L2_MBUS_VSYNC_ACTIVE_HIGH : 285 V4L2_MBUS_VSYNC_ACTIVE_LOW; 286 pr_debug("vsync-active %s\n", v ? "high" : "low"); 287 } 288 289 if (!fwnode_property_read_u32(fwnode, "field-even-active", &v)) { 290 flags &= ~(V4L2_MBUS_FIELD_EVEN_HIGH | 291 V4L2_MBUS_FIELD_EVEN_LOW); 292 flags |= v ? V4L2_MBUS_FIELD_EVEN_HIGH : 293 V4L2_MBUS_FIELD_EVEN_LOW; 294 pr_debug("field-even-active %s\n", v ? "high" : "low"); 295 } 296 297 if (!fwnode_property_read_u32(fwnode, "pclk-sample", &v)) { 298 flags &= ~(V4L2_MBUS_PCLK_SAMPLE_RISING | 299 V4L2_MBUS_PCLK_SAMPLE_FALLING); 300 flags |= v ? V4L2_MBUS_PCLK_SAMPLE_RISING : 301 V4L2_MBUS_PCLK_SAMPLE_FALLING; 302 pr_debug("pclk-sample %s\n", v ? "high" : "low"); 303 } 304 305 if (!fwnode_property_read_u32(fwnode, "data-active", &v)) { 306 flags &= ~(V4L2_MBUS_DATA_ACTIVE_HIGH | 307 V4L2_MBUS_DATA_ACTIVE_LOW); 308 flags |= v ? V4L2_MBUS_DATA_ACTIVE_HIGH : 309 V4L2_MBUS_DATA_ACTIVE_LOW; 310 pr_debug("data-active %s\n", v ? "high" : "low"); 311 } 312 313 if (fwnode_property_present(fwnode, "slave-mode")) { 314 pr_debug("slave mode\n"); 315 flags &= ~V4L2_MBUS_MASTER; 316 flags |= V4L2_MBUS_SLAVE; 317 } else { 318 flags &= ~V4L2_MBUS_SLAVE; 319 flags |= V4L2_MBUS_MASTER; 320 } 321 322 if (!fwnode_property_read_u32(fwnode, "bus-width", &v)) { 323 bus->bus_width = v; 324 pr_debug("bus-width %u\n", v); 325 } 326 327 if (!fwnode_property_read_u32(fwnode, "data-shift", &v)) { 328 bus->data_shift = v; 329 pr_debug("data-shift %u\n", v); 330 } 331 332 if (!fwnode_property_read_u32(fwnode, "sync-on-green-active", &v)) { 333 flags &= ~(V4L2_MBUS_VIDEO_SOG_ACTIVE_HIGH | 334 V4L2_MBUS_VIDEO_SOG_ACTIVE_LOW); 335 flags |= v ? V4L2_MBUS_VIDEO_SOG_ACTIVE_HIGH : 336 V4L2_MBUS_VIDEO_SOG_ACTIVE_LOW; 337 pr_debug("sync-on-green-active %s\n", v ? "high" : "low"); 338 } 339 340 if (!fwnode_property_read_u32(fwnode, "data-enable-active", &v)) { 341 flags &= ~(V4L2_MBUS_DATA_ENABLE_HIGH | 342 V4L2_MBUS_DATA_ENABLE_LOW); 343 flags |= v ? V4L2_MBUS_DATA_ENABLE_HIGH : 344 V4L2_MBUS_DATA_ENABLE_LOW; 345 pr_debug("data-enable-active %s\n", v ? "high" : "low"); 346 } 347 348 switch (bus_type) { 349 default: 350 bus->flags = flags; 351 if (flags & PARALLEL_MBUS_FLAGS) 352 vep->bus_type = V4L2_MBUS_PARALLEL; 353 else 354 vep->bus_type = V4L2_MBUS_BT656; 355 break; 356 case V4L2_MBUS_PARALLEL: 357 vep->bus_type = V4L2_MBUS_PARALLEL; 358 bus->flags = flags; 359 break; 360 case V4L2_MBUS_BT656: 361 vep->bus_type = V4L2_MBUS_BT656; 362 bus->flags = flags & ~PARALLEL_MBUS_FLAGS; 363 break; 364 } 365 } 366 367 static void 368 v4l2_fwnode_endpoint_parse_csi1_bus(struct fwnode_handle *fwnode, 369 struct v4l2_fwnode_endpoint *vep, 370 enum v4l2_mbus_type bus_type) 371 { 372 struct v4l2_fwnode_bus_mipi_csi1 *bus = &vep->bus.mipi_csi1; 373 u32 v; 374 375 if (!fwnode_property_read_u32(fwnode, "clock-inv", &v)) { 376 bus->clock_inv = v; 377 pr_debug("clock-inv %u\n", v); 378 } 379 380 if (!fwnode_property_read_u32(fwnode, "strobe", &v)) { 381 bus->strobe = v; 382 pr_debug("strobe %u\n", v); 383 } 384 385 if (!fwnode_property_read_u32(fwnode, "data-lanes", &v)) { 386 bus->data_lane = v; 387 pr_debug("data-lanes %u\n", v); 388 } 389 390 if (!fwnode_property_read_u32(fwnode, "clock-lanes", &v)) { 391 bus->clock_lane = v; 392 pr_debug("clock-lanes %u\n", v); 393 } 394 395 if (bus_type == V4L2_MBUS_CCP2) 396 vep->bus_type = V4L2_MBUS_CCP2; 397 else 398 vep->bus_type = V4L2_MBUS_CSI1; 399 } 400 401 static int __v4l2_fwnode_endpoint_parse(struct fwnode_handle *fwnode, 402 struct v4l2_fwnode_endpoint *vep) 403 { 404 u32 bus_type = V4L2_FWNODE_BUS_TYPE_GUESS; 405 enum v4l2_mbus_type mbus_type; 406 int rval; 407 408 pr_debug("===== begin parsing endpoint %pfw\n", fwnode); 409 410 fwnode_property_read_u32(fwnode, "bus-type", &bus_type); 411 pr_debug("fwnode video bus type %s (%u), mbus type %s (%u)\n", 412 v4l2_fwnode_bus_type_to_string(bus_type), bus_type, 413 v4l2_fwnode_mbus_type_to_string(vep->bus_type), 414 vep->bus_type); 415 mbus_type = v4l2_fwnode_bus_type_to_mbus(bus_type); 416 if (mbus_type == V4L2_MBUS_INVALID) { 417 pr_debug("unsupported bus type %u\n", bus_type); 418 return -EINVAL; 419 } 420 421 if (vep->bus_type != V4L2_MBUS_UNKNOWN) { 422 if (mbus_type != V4L2_MBUS_UNKNOWN && 423 vep->bus_type != mbus_type) { 424 pr_debug("expecting bus type %s\n", 425 v4l2_fwnode_mbus_type_to_string(vep->bus_type)); 426 return -ENXIO; 427 } 428 } else { 429 vep->bus_type = mbus_type; 430 } 431 432 switch (vep->bus_type) { 433 case V4L2_MBUS_UNKNOWN: 434 rval = v4l2_fwnode_endpoint_parse_csi2_bus(fwnode, vep, 435 V4L2_MBUS_UNKNOWN); 436 if (rval) 437 return rval; 438 439 if (vep->bus_type == V4L2_MBUS_UNKNOWN) 440 v4l2_fwnode_endpoint_parse_parallel_bus(fwnode, vep, 441 V4L2_MBUS_UNKNOWN); 442 443 pr_debug("assuming media bus type %s (%u)\n", 444 v4l2_fwnode_mbus_type_to_string(vep->bus_type), 445 vep->bus_type); 446 447 break; 448 case V4L2_MBUS_CCP2: 449 case V4L2_MBUS_CSI1: 450 v4l2_fwnode_endpoint_parse_csi1_bus(fwnode, vep, vep->bus_type); 451 452 break; 453 case V4L2_MBUS_CSI2_DPHY: 454 case V4L2_MBUS_CSI2_CPHY: 455 rval = v4l2_fwnode_endpoint_parse_csi2_bus(fwnode, vep, 456 vep->bus_type); 457 if (rval) 458 return rval; 459 460 break; 461 case V4L2_MBUS_PARALLEL: 462 case V4L2_MBUS_BT656: 463 v4l2_fwnode_endpoint_parse_parallel_bus(fwnode, vep, 464 vep->bus_type); 465 466 break; 467 default: 468 pr_warn("unsupported bus type %u\n", mbus_type); 469 return -EINVAL; 470 } 471 472 fwnode_graph_parse_endpoint(fwnode, &vep->base); 473 474 return 0; 475 } 476 477 int v4l2_fwnode_endpoint_parse(struct fwnode_handle *fwnode, 478 struct v4l2_fwnode_endpoint *vep) 479 { 480 int ret; 481 482 ret = __v4l2_fwnode_endpoint_parse(fwnode, vep); 483 484 pr_debug("===== end parsing endpoint %pfw\n", fwnode); 485 486 return ret; 487 } 488 EXPORT_SYMBOL_GPL(v4l2_fwnode_endpoint_parse); 489 490 void v4l2_fwnode_endpoint_free(struct v4l2_fwnode_endpoint *vep) 491 { 492 if (IS_ERR_OR_NULL(vep)) 493 return; 494 495 kfree(vep->link_frequencies); 496 vep->link_frequencies = NULL; 497 } 498 EXPORT_SYMBOL_GPL(v4l2_fwnode_endpoint_free); 499 500 int v4l2_fwnode_endpoint_alloc_parse(struct fwnode_handle *fwnode, 501 struct v4l2_fwnode_endpoint *vep) 502 { 503 int rval; 504 505 rval = __v4l2_fwnode_endpoint_parse(fwnode, vep); 506 if (rval < 0) 507 return rval; 508 509 rval = fwnode_property_count_u64(fwnode, "link-frequencies"); 510 if (rval > 0) { 511 unsigned int i; 512 513 vep->link_frequencies = 514 kmalloc_array(rval, sizeof(*vep->link_frequencies), 515 GFP_KERNEL); 516 if (!vep->link_frequencies) 517 return -ENOMEM; 518 519 vep->nr_of_link_frequencies = rval; 520 521 rval = fwnode_property_read_u64_array(fwnode, 522 "link-frequencies", 523 vep->link_frequencies, 524 vep->nr_of_link_frequencies); 525 if (rval < 0) { 526 v4l2_fwnode_endpoint_free(vep); 527 return rval; 528 } 529 530 for (i = 0; i < vep->nr_of_link_frequencies; i++) 531 pr_debug("link-frequencies %u value %llu\n", i, 532 vep->link_frequencies[i]); 533 } 534 535 pr_debug("===== end parsing endpoint %pfw\n", fwnode); 536 537 return 0; 538 } 539 EXPORT_SYMBOL_GPL(v4l2_fwnode_endpoint_alloc_parse); 540 541 int v4l2_fwnode_parse_link(struct fwnode_handle *fwnode, 542 struct v4l2_fwnode_link *link) 543 { 544 struct fwnode_endpoint fwep; 545 546 memset(link, 0, sizeof(*link)); 547 548 fwnode_graph_parse_endpoint(fwnode, &fwep); 549 link->local_id = fwep.id; 550 link->local_port = fwep.port; 551 link->local_node = fwnode_graph_get_port_parent(fwnode); 552 553 fwnode = fwnode_graph_get_remote_endpoint(fwnode); 554 if (!fwnode) { 555 fwnode_handle_put(fwnode); 556 return -ENOLINK; 557 } 558 559 fwnode_graph_parse_endpoint(fwnode, &fwep); 560 link->remote_id = fwep.id; 561 link->remote_port = fwep.port; 562 link->remote_node = fwnode_graph_get_port_parent(fwnode); 563 564 return 0; 565 } 566 EXPORT_SYMBOL_GPL(v4l2_fwnode_parse_link); 567 568 void v4l2_fwnode_put_link(struct v4l2_fwnode_link *link) 569 { 570 fwnode_handle_put(link->local_node); 571 fwnode_handle_put(link->remote_node); 572 } 573 EXPORT_SYMBOL_GPL(v4l2_fwnode_put_link); 574 575 static const struct v4l2_fwnode_connector_conv { 576 enum v4l2_connector_type type; 577 const char *compatible; 578 } connectors[] = { 579 { 580 .type = V4L2_CONN_COMPOSITE, 581 .compatible = "composite-video-connector", 582 }, { 583 .type = V4L2_CONN_SVIDEO, 584 .compatible = "svideo-connector", 585 }, 586 }; 587 588 static enum v4l2_connector_type 589 v4l2_fwnode_string_to_connector_type(const char *con_str) 590 { 591 unsigned int i; 592 593 for (i = 0; i < ARRAY_SIZE(connectors); i++) 594 if (!strcmp(con_str, connectors[i].compatible)) 595 return connectors[i].type; 596 597 return V4L2_CONN_UNKNOWN; 598 } 599 600 static void 601 v4l2_fwnode_connector_parse_analog(struct fwnode_handle *fwnode, 602 struct v4l2_fwnode_connector *vc) 603 { 604 u32 stds; 605 int ret; 606 607 ret = fwnode_property_read_u32(fwnode, "sdtv-standards", &stds); 608 609 /* The property is optional. */ 610 vc->connector.analog.sdtv_stds = ret ? V4L2_STD_ALL : stds; 611 } 612 613 void v4l2_fwnode_connector_free(struct v4l2_fwnode_connector *connector) 614 { 615 struct v4l2_connector_link *link, *tmp; 616 617 if (IS_ERR_OR_NULL(connector) || connector->type == V4L2_CONN_UNKNOWN) 618 return; 619 620 list_for_each_entry_safe(link, tmp, &connector->links, head) { 621 v4l2_fwnode_put_link(&link->fwnode_link); 622 list_del(&link->head); 623 kfree(link); 624 } 625 626 kfree(connector->label); 627 connector->label = NULL; 628 connector->type = V4L2_CONN_UNKNOWN; 629 } 630 EXPORT_SYMBOL_GPL(v4l2_fwnode_connector_free); 631 632 static enum v4l2_connector_type 633 v4l2_fwnode_get_connector_type(struct fwnode_handle *fwnode) 634 { 635 const char *type_name; 636 int err; 637 638 if (!fwnode) 639 return V4L2_CONN_UNKNOWN; 640 641 /* The connector-type is stored within the compatible string. */ 642 err = fwnode_property_read_string(fwnode, "compatible", &type_name); 643 if (err) 644 return V4L2_CONN_UNKNOWN; 645 646 return v4l2_fwnode_string_to_connector_type(type_name); 647 } 648 649 int v4l2_fwnode_connector_parse(struct fwnode_handle *fwnode, 650 struct v4l2_fwnode_connector *connector) 651 { 652 struct fwnode_handle *connector_node; 653 enum v4l2_connector_type connector_type; 654 const char *label; 655 int err; 656 657 if (!fwnode) 658 return -EINVAL; 659 660 memset(connector, 0, sizeof(*connector)); 661 662 INIT_LIST_HEAD(&connector->links); 663 664 connector_node = fwnode_graph_get_port_parent(fwnode); 665 connector_type = v4l2_fwnode_get_connector_type(connector_node); 666 if (connector_type == V4L2_CONN_UNKNOWN) { 667 fwnode_handle_put(connector_node); 668 connector_node = fwnode_graph_get_remote_port_parent(fwnode); 669 connector_type = v4l2_fwnode_get_connector_type(connector_node); 670 } 671 672 if (connector_type == V4L2_CONN_UNKNOWN) { 673 pr_err("Unknown connector type\n"); 674 err = -ENOTCONN; 675 goto out; 676 } 677 678 connector->type = connector_type; 679 connector->name = fwnode_get_name(connector_node); 680 err = fwnode_property_read_string(connector_node, "label", &label); 681 connector->label = err ? NULL : kstrdup_const(label, GFP_KERNEL); 682 683 /* Parse the connector specific properties. */ 684 switch (connector->type) { 685 case V4L2_CONN_COMPOSITE: 686 case V4L2_CONN_SVIDEO: 687 v4l2_fwnode_connector_parse_analog(connector_node, connector); 688 break; 689 /* Avoid compiler warnings */ 690 case V4L2_CONN_UNKNOWN: 691 break; 692 } 693 694 out: 695 fwnode_handle_put(connector_node); 696 697 return err; 698 } 699 EXPORT_SYMBOL_GPL(v4l2_fwnode_connector_parse); 700 701 int v4l2_fwnode_connector_add_link(struct fwnode_handle *fwnode, 702 struct v4l2_fwnode_connector *connector) 703 { 704 struct fwnode_handle *connector_ep; 705 struct v4l2_connector_link *link; 706 int err; 707 708 if (!fwnode || !connector || connector->type == V4L2_CONN_UNKNOWN) 709 return -EINVAL; 710 711 connector_ep = fwnode_graph_get_remote_endpoint(fwnode); 712 if (!connector_ep) 713 return -ENOTCONN; 714 715 link = kzalloc(sizeof(*link), GFP_KERNEL); 716 if (!link) { 717 err = -ENOMEM; 718 goto err; 719 } 720 721 err = v4l2_fwnode_parse_link(connector_ep, &link->fwnode_link); 722 if (err) 723 goto err; 724 725 fwnode_handle_put(connector_ep); 726 727 list_add(&link->head, &connector->links); 728 connector->nr_of_links++; 729 730 return 0; 731 732 err: 733 kfree(link); 734 fwnode_handle_put(connector_ep); 735 736 return err; 737 } 738 EXPORT_SYMBOL_GPL(v4l2_fwnode_connector_add_link); 739 740 int v4l2_fwnode_device_parse(struct device *dev, 741 struct v4l2_fwnode_device_properties *props) 742 { 743 struct fwnode_handle *fwnode = dev_fwnode(dev); 744 u32 val; 745 int ret; 746 747 memset(props, 0, sizeof(*props)); 748 749 props->orientation = V4L2_FWNODE_PROPERTY_UNSET; 750 ret = fwnode_property_read_u32(fwnode, "orientation", &val); 751 if (!ret) { 752 switch (val) { 753 case V4L2_FWNODE_ORIENTATION_FRONT: 754 case V4L2_FWNODE_ORIENTATION_BACK: 755 case V4L2_FWNODE_ORIENTATION_EXTERNAL: 756 break; 757 default: 758 dev_warn(dev, "Unsupported device orientation: %u\n", val); 759 return -EINVAL; 760 } 761 762 props->orientation = val; 763 dev_dbg(dev, "device orientation: %u\n", val); 764 } 765 766 props->rotation = V4L2_FWNODE_PROPERTY_UNSET; 767 ret = fwnode_property_read_u32(fwnode, "rotation", &val); 768 if (!ret) { 769 if (val >= 360) { 770 dev_warn(dev, "Unsupported device rotation: %u\n", val); 771 return -EINVAL; 772 } 773 774 props->rotation = val; 775 dev_dbg(dev, "device rotation: %u\n", val); 776 } 777 778 return 0; 779 } 780 EXPORT_SYMBOL_GPL(v4l2_fwnode_device_parse); 781 782 static int 783 v4l2_async_nf_fwnode_parse_endpoint(struct device *dev, 784 struct v4l2_async_notifier *notifier, 785 struct fwnode_handle *endpoint, 786 unsigned int asd_struct_size, 787 parse_endpoint_func parse_endpoint) 788 { 789 struct v4l2_fwnode_endpoint vep = { .bus_type = 0 }; 790 struct v4l2_async_subdev *asd; 791 int ret; 792 793 asd = kzalloc(asd_struct_size, GFP_KERNEL); 794 if (!asd) 795 return -ENOMEM; 796 797 asd->match_type = V4L2_ASYNC_MATCH_FWNODE; 798 asd->match.fwnode = 799 fwnode_graph_get_remote_port_parent(endpoint); 800 if (!asd->match.fwnode) { 801 dev_dbg(dev, "no remote endpoint found\n"); 802 ret = -ENOTCONN; 803 goto out_err; 804 } 805 806 ret = v4l2_fwnode_endpoint_alloc_parse(endpoint, &vep); 807 if (ret) { 808 dev_warn(dev, "unable to parse V4L2 fwnode endpoint (%d)\n", 809 ret); 810 goto out_err; 811 } 812 813 ret = parse_endpoint ? parse_endpoint(dev, &vep, asd) : 0; 814 if (ret == -ENOTCONN) 815 dev_dbg(dev, "ignoring port@%u/endpoint@%u\n", vep.base.port, 816 vep.base.id); 817 else if (ret < 0) 818 dev_warn(dev, 819 "driver could not parse port@%u/endpoint@%u (%d)\n", 820 vep.base.port, vep.base.id, ret); 821 v4l2_fwnode_endpoint_free(&vep); 822 if (ret < 0) 823 goto out_err; 824 825 ret = __v4l2_async_nf_add_subdev(notifier, asd); 826 if (ret < 0) { 827 /* not an error if asd already exists */ 828 if (ret == -EEXIST) 829 ret = 0; 830 goto out_err; 831 } 832 833 return 0; 834 835 out_err: 836 fwnode_handle_put(asd->match.fwnode); 837 kfree(asd); 838 839 return ret == -ENOTCONN ? 0 : ret; 840 } 841 842 int 843 v4l2_async_nf_parse_fwnode_endpoints(struct device *dev, 844 struct v4l2_async_notifier *notifier, 845 size_t asd_struct_size, 846 parse_endpoint_func parse_endpoint) 847 { 848 struct fwnode_handle *fwnode; 849 int ret = 0; 850 851 if (WARN_ON(asd_struct_size < sizeof(struct v4l2_async_subdev))) 852 return -EINVAL; 853 854 fwnode_graph_for_each_endpoint(dev_fwnode(dev), fwnode) { 855 struct fwnode_handle *dev_fwnode; 856 bool is_available; 857 858 dev_fwnode = fwnode_graph_get_port_parent(fwnode); 859 is_available = fwnode_device_is_available(dev_fwnode); 860 fwnode_handle_put(dev_fwnode); 861 if (!is_available) 862 continue; 863 864 865 ret = v4l2_async_nf_fwnode_parse_endpoint(dev, notifier, 866 fwnode, 867 asd_struct_size, 868 parse_endpoint); 869 if (ret < 0) 870 break; 871 } 872 873 fwnode_handle_put(fwnode); 874 875 return ret; 876 } 877 EXPORT_SYMBOL_GPL(v4l2_async_nf_parse_fwnode_endpoints); 878 879 /* 880 * v4l2_fwnode_reference_parse - parse references for async sub-devices 881 * @dev: the device node the properties of which are parsed for references 882 * @notifier: the async notifier where the async subdevs will be added 883 * @prop: the name of the property 884 * 885 * Return: 0 on success 886 * -ENOENT if no entries were found 887 * -ENOMEM if memory allocation failed 888 * -EINVAL if property parsing failed 889 */ 890 static int v4l2_fwnode_reference_parse(struct device *dev, 891 struct v4l2_async_notifier *notifier, 892 const char *prop) 893 { 894 struct fwnode_reference_args args; 895 unsigned int index; 896 int ret; 897 898 for (index = 0; 899 !(ret = fwnode_property_get_reference_args(dev_fwnode(dev), 900 prop, NULL, 0, 901 index, &args)); 902 index++) 903 fwnode_handle_put(args.fwnode); 904 905 if (!index) 906 return -ENOENT; 907 908 /* 909 * Note that right now both -ENODATA and -ENOENT may signal 910 * out-of-bounds access. Return the error in cases other than that. 911 */ 912 if (ret != -ENOENT && ret != -ENODATA) 913 return ret; 914 915 for (index = 0; 916 !fwnode_property_get_reference_args(dev_fwnode(dev), prop, NULL, 917 0, index, &args); 918 index++) { 919 struct v4l2_async_subdev *asd; 920 921 asd = v4l2_async_nf_add_fwnode(notifier, args.fwnode, 922 struct v4l2_async_subdev); 923 fwnode_handle_put(args.fwnode); 924 if (IS_ERR(asd)) { 925 /* not an error if asd already exists */ 926 if (PTR_ERR(asd) == -EEXIST) 927 continue; 928 929 return PTR_ERR(asd); 930 } 931 } 932 933 return 0; 934 } 935 936 /* 937 * v4l2_fwnode_reference_get_int_prop - parse a reference with integer 938 * arguments 939 * @fwnode: fwnode to read @prop from 940 * @notifier: notifier for @dev 941 * @prop: the name of the property 942 * @index: the index of the reference to get 943 * @props: the array of integer property names 944 * @nprops: the number of integer property names in @nprops 945 * 946 * First find an fwnode referred to by the reference at @index in @prop. 947 * 948 * Then under that fwnode, @nprops times, for each property in @props, 949 * iteratively follow child nodes starting from fwnode such that they have the 950 * property in @props array at the index of the child node distance from the 951 * root node and the value of that property matching with the integer argument 952 * of the reference, at the same index. 953 * 954 * The child fwnode reached at the end of the iteration is then returned to the 955 * caller. 956 * 957 * The core reason for this is that you cannot refer to just any node in ACPI. 958 * So to refer to an endpoint (easy in DT) you need to refer to a device, then 959 * provide a list of (property name, property value) tuples where each tuple 960 * uniquely identifies a child node. The first tuple identifies a child directly 961 * underneath the device fwnode, the next tuple identifies a child node 962 * underneath the fwnode identified by the previous tuple, etc. until you 963 * reached the fwnode you need. 964 * 965 * THIS EXAMPLE EXISTS MERELY TO DOCUMENT THIS FUNCTION. DO NOT USE IT AS A 966 * REFERENCE IN HOW ACPI TABLES SHOULD BE WRITTEN!! See documentation under 967 * Documentation/firmware-guide/acpi/dsd/ instead and especially graph.txt, 968 * data-node-references.txt and leds.txt . 969 * 970 * Scope (\_SB.PCI0.I2C2) 971 * { 972 * Device (CAM0) 973 * { 974 * Name (_DSD, Package () { 975 * ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"), 976 * Package () { 977 * Package () { 978 * "compatible", 979 * Package () { "nokia,smia" } 980 * }, 981 * }, 982 * ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"), 983 * Package () { 984 * Package () { "port0", "PRT0" }, 985 * } 986 * }) 987 * Name (PRT0, Package() { 988 * ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"), 989 * Package () { 990 * Package () { "port", 0 }, 991 * }, 992 * ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"), 993 * Package () { 994 * Package () { "endpoint0", "EP00" }, 995 * } 996 * }) 997 * Name (EP00, Package() { 998 * ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"), 999 * Package () { 1000 * Package () { "endpoint", 0 }, 1001 * Package () { 1002 * "remote-endpoint", 1003 * Package() { 1004 * \_SB.PCI0.ISP, 4, 0 1005 * } 1006 * }, 1007 * } 1008 * }) 1009 * } 1010 * } 1011 * 1012 * Scope (\_SB.PCI0) 1013 * { 1014 * Device (ISP) 1015 * { 1016 * Name (_DSD, Package () { 1017 * ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"), 1018 * Package () { 1019 * Package () { "port4", "PRT4" }, 1020 * } 1021 * }) 1022 * 1023 * Name (PRT4, Package() { 1024 * ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"), 1025 * Package () { 1026 * Package () { "port", 4 }, 1027 * }, 1028 * ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"), 1029 * Package () { 1030 * Package () { "endpoint0", "EP40" }, 1031 * } 1032 * }) 1033 * 1034 * Name (EP40, Package() { 1035 * ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"), 1036 * Package () { 1037 * Package () { "endpoint", 0 }, 1038 * Package () { 1039 * "remote-endpoint", 1040 * Package () { 1041 * \_SB.PCI0.I2C2.CAM0, 1042 * 0, 0 1043 * } 1044 * }, 1045 * } 1046 * }) 1047 * } 1048 * } 1049 * 1050 * From the EP40 node under ISP device, you could parse the graph remote 1051 * endpoint using v4l2_fwnode_reference_get_int_prop with these arguments: 1052 * 1053 * @fwnode: fwnode referring to EP40 under ISP. 1054 * @prop: "remote-endpoint" 1055 * @index: 0 1056 * @props: "port", "endpoint" 1057 * @nprops: 2 1058 * 1059 * And you'd get back fwnode referring to EP00 under CAM0. 1060 * 1061 * The same works the other way around: if you use EP00 under CAM0 as the 1062 * fwnode, you'll get fwnode referring to EP40 under ISP. 1063 * 1064 * The same example in DT syntax would look like this: 1065 * 1066 * cam: cam0 { 1067 * compatible = "nokia,smia"; 1068 * 1069 * port { 1070 * port = <0>; 1071 * endpoint { 1072 * endpoint = <0>; 1073 * remote-endpoint = <&isp 4 0>; 1074 * }; 1075 * }; 1076 * }; 1077 * 1078 * isp: isp { 1079 * ports { 1080 * port@4 { 1081 * port = <4>; 1082 * endpoint { 1083 * endpoint = <0>; 1084 * remote-endpoint = <&cam 0 0>; 1085 * }; 1086 * }; 1087 * }; 1088 * }; 1089 * 1090 * Return: 0 on success 1091 * -ENOENT if no entries (or the property itself) were found 1092 * -EINVAL if property parsing otherwise failed 1093 * -ENOMEM if memory allocation failed 1094 */ 1095 static struct fwnode_handle * 1096 v4l2_fwnode_reference_get_int_prop(struct fwnode_handle *fwnode, 1097 const char *prop, 1098 unsigned int index, 1099 const char * const *props, 1100 unsigned int nprops) 1101 { 1102 struct fwnode_reference_args fwnode_args; 1103 u64 *args = fwnode_args.args; 1104 struct fwnode_handle *child; 1105 int ret; 1106 1107 /* 1108 * Obtain remote fwnode as well as the integer arguments. 1109 * 1110 * Note that right now both -ENODATA and -ENOENT may signal 1111 * out-of-bounds access. Return -ENOENT in that case. 1112 */ 1113 ret = fwnode_property_get_reference_args(fwnode, prop, NULL, nprops, 1114 index, &fwnode_args); 1115 if (ret) 1116 return ERR_PTR(ret == -ENODATA ? -ENOENT : ret); 1117 1118 /* 1119 * Find a node in the tree under the referred fwnode corresponding to 1120 * the integer arguments. 1121 */ 1122 fwnode = fwnode_args.fwnode; 1123 while (nprops--) { 1124 u32 val; 1125 1126 /* Loop over all child nodes under fwnode. */ 1127 fwnode_for_each_child_node(fwnode, child) { 1128 if (fwnode_property_read_u32(child, *props, &val)) 1129 continue; 1130 1131 /* Found property, see if its value matches. */ 1132 if (val == *args) 1133 break; 1134 } 1135 1136 fwnode_handle_put(fwnode); 1137 1138 /* No property found; return an error here. */ 1139 if (!child) { 1140 fwnode = ERR_PTR(-ENOENT); 1141 break; 1142 } 1143 1144 props++; 1145 args++; 1146 fwnode = child; 1147 } 1148 1149 return fwnode; 1150 } 1151 1152 struct v4l2_fwnode_int_props { 1153 const char *name; 1154 const char * const *props; 1155 unsigned int nprops; 1156 }; 1157 1158 /* 1159 * v4l2_fwnode_reference_parse_int_props - parse references for async 1160 * sub-devices 1161 * @dev: struct device pointer 1162 * @notifier: notifier for @dev 1163 * @prop: the name of the property 1164 * @props: the array of integer property names 1165 * @nprops: the number of integer properties 1166 * 1167 * Use v4l2_fwnode_reference_get_int_prop to find fwnodes through reference in 1168 * property @prop with integer arguments with child nodes matching in properties 1169 * @props. Then, set up V4L2 async sub-devices for those fwnodes in the notifier 1170 * accordingly. 1171 * 1172 * While it is technically possible to use this function on DT, it is only 1173 * meaningful on ACPI. On Device tree you can refer to any node in the tree but 1174 * on ACPI the references are limited to devices. 1175 * 1176 * Return: 0 on success 1177 * -ENOENT if no entries (or the property itself) were found 1178 * -EINVAL if property parsing otherwisefailed 1179 * -ENOMEM if memory allocation failed 1180 */ 1181 static int 1182 v4l2_fwnode_reference_parse_int_props(struct device *dev, 1183 struct v4l2_async_notifier *notifier, 1184 const struct v4l2_fwnode_int_props *p) 1185 { 1186 struct fwnode_handle *fwnode; 1187 unsigned int index; 1188 int ret; 1189 const char *prop = p->name; 1190 const char * const *props = p->props; 1191 unsigned int nprops = p->nprops; 1192 1193 index = 0; 1194 do { 1195 fwnode = v4l2_fwnode_reference_get_int_prop(dev_fwnode(dev), 1196 prop, index, 1197 props, nprops); 1198 if (IS_ERR(fwnode)) { 1199 /* 1200 * Note that right now both -ENODATA and -ENOENT may 1201 * signal out-of-bounds access. Return the error in 1202 * cases other than that. 1203 */ 1204 if (PTR_ERR(fwnode) != -ENOENT && 1205 PTR_ERR(fwnode) != -ENODATA) 1206 return PTR_ERR(fwnode); 1207 break; 1208 } 1209 fwnode_handle_put(fwnode); 1210 index++; 1211 } while (1); 1212 1213 for (index = 0; 1214 !IS_ERR((fwnode = v4l2_fwnode_reference_get_int_prop(dev_fwnode(dev), 1215 prop, index, 1216 props, 1217 nprops))); 1218 index++) { 1219 struct v4l2_async_subdev *asd; 1220 1221 asd = v4l2_async_nf_add_fwnode(notifier, fwnode, 1222 struct v4l2_async_subdev); 1223 fwnode_handle_put(fwnode); 1224 if (IS_ERR(asd)) { 1225 ret = PTR_ERR(asd); 1226 /* not an error if asd already exists */ 1227 if (ret == -EEXIST) 1228 continue; 1229 1230 return PTR_ERR(asd); 1231 } 1232 } 1233 1234 return !fwnode || PTR_ERR(fwnode) == -ENOENT ? 0 : PTR_ERR(fwnode); 1235 } 1236 1237 /** 1238 * v4l2_async_nf_parse_fwnode_sensor - parse common references on 1239 * sensors for async sub-devices 1240 * @dev: the device node the properties of which are parsed for references 1241 * @notifier: the async notifier where the async subdevs will be added 1242 * 1243 * Parse common sensor properties for remote devices related to the 1244 * sensor and set up async sub-devices for them. 1245 * 1246 * Any notifier populated using this function must be released with a call to 1247 * v4l2_async_nf_release() after it has been unregistered and the async 1248 * sub-devices are no longer in use, even in the case the function returned an 1249 * error. 1250 * 1251 * Return: 0 on success 1252 * -ENOMEM if memory allocation failed 1253 * -EINVAL if property parsing failed 1254 */ 1255 static int 1256 v4l2_async_nf_parse_fwnode_sensor(struct device *dev, 1257 struct v4l2_async_notifier *notifier) 1258 { 1259 static const char * const led_props[] = { "led" }; 1260 static const struct v4l2_fwnode_int_props props[] = { 1261 { "flash-leds", led_props, ARRAY_SIZE(led_props) }, 1262 { "lens-focus", NULL, 0 }, 1263 }; 1264 unsigned int i; 1265 1266 for (i = 0; i < ARRAY_SIZE(props); i++) { 1267 int ret; 1268 1269 if (props[i].props && is_acpi_node(dev_fwnode(dev))) 1270 ret = v4l2_fwnode_reference_parse_int_props(dev, 1271 notifier, 1272 &props[i]); 1273 else 1274 ret = v4l2_fwnode_reference_parse(dev, notifier, 1275 props[i].name); 1276 if (ret && ret != -ENOENT) { 1277 dev_warn(dev, "parsing property \"%s\" failed (%d)\n", 1278 props[i].name, ret); 1279 return ret; 1280 } 1281 } 1282 1283 return 0; 1284 } 1285 1286 int v4l2_async_register_subdev_sensor(struct v4l2_subdev *sd) 1287 { 1288 struct v4l2_async_notifier *notifier; 1289 int ret; 1290 1291 if (WARN_ON(!sd->dev)) 1292 return -ENODEV; 1293 1294 notifier = kzalloc(sizeof(*notifier), GFP_KERNEL); 1295 if (!notifier) 1296 return -ENOMEM; 1297 1298 v4l2_async_nf_init(notifier); 1299 1300 ret = v4l2_async_nf_parse_fwnode_sensor(sd->dev, notifier); 1301 if (ret < 0) 1302 goto out_cleanup; 1303 1304 ret = v4l2_async_subdev_nf_register(sd, notifier); 1305 if (ret < 0) 1306 goto out_cleanup; 1307 1308 ret = v4l2_async_register_subdev(sd); 1309 if (ret < 0) 1310 goto out_unregister; 1311 1312 sd->subdev_notifier = notifier; 1313 1314 return 0; 1315 1316 out_unregister: 1317 v4l2_async_nf_unregister(notifier); 1318 1319 out_cleanup: 1320 v4l2_async_nf_cleanup(notifier); 1321 kfree(notifier); 1322 1323 return ret; 1324 } 1325 EXPORT_SYMBOL_GPL(v4l2_async_register_subdev_sensor); 1326 1327 MODULE_LICENSE("GPL"); 1328 MODULE_AUTHOR("Sakari Ailus <sakari.ailus@linux.intel.com>"); 1329 MODULE_AUTHOR("Sylwester Nawrocki <s.nawrocki@samsung.com>"); 1330 MODULE_AUTHOR("Guennadi Liakhovetski <g.liakhovetski@gmx.de>"); 1331