drivers/gpu/drm/drm_connector.c

   1 /*
   2  * Copyright (c) 2016 Intel Corporation
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and its
   5  * documentation for any purpose is hereby granted without fee, provided that
   6  * the above copyright notice appear in all copies and that both that copyright
   7  * notice and this permission notice appear in supporting documentation, and
   8  * that the name of the copyright holders not be used in advertising or
   9  * publicity pertaining to distribution of the software without specific,
  10  * written prior permission.  The copyright holders make no representations
  11  * about the suitability of this software for any purpose.  It is provided "as
  12  * is" without express or implied warranty.
  13  *
  14  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  15  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  16  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  17  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  18  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  19  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  20  * OF THIS SOFTWARE.
  21  */
  22
  23 #include <drm/drm_connector.h>
  24 #include <drm/drm_edid.h>
  25 #include <drm/drm_encoder.h>
  26 #include <drm/drm_utils.h>
  27 #include <drm/drm_print.h>
  28 #include <drm/drm_drv.h>
  29 #include <drm/drm_file.h>
  30
  31 #include <linux/uaccess.h>
  32
  33 #include "drm_crtc_internal.h"
  34 #include "drm_internal.h"
  35
  36 /**
  37  * DOC: overview
  38  *
  39  * In DRM connectors are the general abstraction for display sinks, and include
  40  * als fixed panels or anything else that can display pixels in some form. As
  41  * opposed to all other KMS objects representing hardware (like CRTC, encoder or
  42  * plane abstractions) connectors can be hotplugged and unplugged at runtime.
  43  * Hence they are reference-counted using drm_connector_get() and
  44  * drm_connector_put().
  45  *
  46  * KMS driver must create, initialize, register and attach at a &struct
  47  * drm_connector for each such sink. The instance is created as other KMS
  48  * objects and initialized by setting the following fields. The connector is
  49  * initialized with a call to drm_connector_init() with a pointer to the
  50  * &struct drm_connector_funcs and a connector type, and then exposed to
  51  * userspace with a call to drm_connector_register().
  52  *
  53  * Connectors must be attached to an encoder to be used. For devices that map
  54  * connectors to encoders 1:1, the connector should be attached at
  55  * initialization time with a call to drm_connector_attach_encoder(). The
  56  * driver must also set the &drm_connector.encoder field to point to the
  57  * attached encoder.
  58  *
  59  * For connectors which are not fixed (like built-in panels) the driver needs to
  60  * support hotplug notifications. The simplest way to do that is by using the
  61  * probe helpers, see drm_kms_helper_poll_init() for connectors which don't have
  62  * hardware support for hotplug interrupts. Connectors with hardware hotplug
  63  * support can instead use e.g. drm_helper_hpd_irq_event().
  64  */
  65
  66 struct drm_conn_prop_enum_list {
  67         int type;
  68         const char *name;
  69         struct ida ida;
  70 };
  71
  72 /*
  73  * Connector and encoder types.
  74  */
  75 static struct drm_conn_prop_enum_list drm_connector_enum_list[] = {
  76         { DRM_MODE_CONNECTOR_Unknown, "Unknown" },
  77         { DRM_MODE_CONNECTOR_VGA, "VGA" },
  78         { DRM_MODE_CONNECTOR_DVII, "DVI-I" },
  79         { DRM_MODE_CONNECTOR_DVID, "DVI-D" },
  80         { DRM_MODE_CONNECTOR_DVIA, "DVI-A" },
  81         { DRM_MODE_CONNECTOR_Composite, "Composite" },
  82         { DRM_MODE_CONNECTOR_SVIDEO, "SVIDEO" },
  83         { DRM_MODE_CONNECTOR_LVDS, "LVDS" },
  84         { DRM_MODE_CONNECTOR_Component, "Component" },
  85         { DRM_MODE_CONNECTOR_9PinDIN, "DIN" },
  86         { DRM_MODE_CONNECTOR_DisplayPort, "DP" },
  87         { DRM_MODE_CONNECTOR_HDMIA, "HDMI-A" },
  88         { DRM_MODE_CONNECTOR_HDMIB, "HDMI-B" },
  89         { DRM_MODE_CONNECTOR_TV, "TV" },
  90         { DRM_MODE_CONNECTOR_eDP, "eDP" },
  91         { DRM_MODE_CONNECTOR_VIRTUAL, "Virtual" },
  92         { DRM_MODE_CONNECTOR_DSI, "DSI" },
  93         { DRM_MODE_CONNECTOR_DPI, "DPI" },
  94         { DRM_MODE_CONNECTOR_WRITEBACK, "Writeback" },
  95 };
  96
  97 void drm_connector_ida_init(void)
  98 {
  99         int i;
 100
 101         for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
 102                 ida_init(&drm_connector_enum_list[i].ida);
 103 }
 104
 105 void drm_connector_ida_destroy(void)
 106 {
 107         int i;
 108
 109         for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
 110                 ida_destroy(&drm_connector_enum_list[i].ida);
 111 }
 112
 113 /**
 114  * drm_connector_get_cmdline_mode - reads the user's cmdline mode
 115  * @connector: connector to quwery
 116  *
 117  * The kernel supports per-connector configuration of its consoles through
 118  * use of the video= parameter. This function parses that option and
 119  * extracts the user's specified mode (or enable/disable status) for a
 120  * particular connector. This is typically only used during the early fbdev
 121  * setup.
 122  */
 123 static void drm_connector_get_cmdline_mode(struct drm_connector *connector)
 124 {
 125         struct drm_cmdline_mode *mode = &connector->cmdline_mode;
 126         char *option = NULL;
 127
 128         if (fb_get_options(connector->name, &option))
 129                 return;
 130
 131         if (!drm_mode_parse_command_line_for_connector(option,
 132                                                        connector,
 133                                                        mode))
 134                 return;
 135
 136         if (mode->force) {
 137                 DRM_INFO("forcing %s connector %s\n", connector->name,
 138                          drm_get_connector_force_name(mode->force));
 139                 connector->force = mode->force;
 140         }
 141
 142         DRM_DEBUG_KMS("cmdline mode for connector %s %dx%d@%dHz%s%s%s\n",
 143                       connector->name,
 144                       mode->xres, mode->yres,
 145                       mode->refresh_specified ? mode->refresh : 60,
 146                       mode->rb ? " reduced blanking" : "",
 147                       mode->margins ? " with margins" : "",
 148                       mode->interlace ?  " interlaced" : "");
 149 }
 150
 151 static void drm_connector_free(struct kref *kref)
 152 {
 153         struct drm_connector *connector =
 154                 container_of(kref, struct drm_connector, base.refcount);
 155         struct drm_device *dev = connector->dev;
 156
 157         drm_mode_object_unregister(dev, &connector->base);
 158         connector->funcs->destroy(connector);
 159 }
 160
 161 void drm_connector_free_work_fn(struct work_struct *work)
 162 {
 163         struct drm_connector *connector, *n;
 164         struct drm_device *dev =
 165                 container_of(work, struct drm_device, mode_config.connector_free_work);
 166         struct drm_mode_config *config = &dev->mode_config;
 167         unsigned long flags;
 168         struct llist_node *freed;
 169
 170         spin_lock_irqsave(&config->connector_list_lock, flags);
 171         freed = llist_del_all(&config->connector_free_list);
 172         spin_unlock_irqrestore(&config->connector_list_lock, flags);
 173
 174         llist_for_each_entry_safe(connector, n, freed, free_node) {
 175                 drm_mode_object_unregister(dev, &connector->base);
 176                 connector->funcs->destroy(connector);
 177         }
 178 }
 179
 180 /**
 181  * drm_connector_init - Init a preallocated connector
 182  * @dev: DRM device
 183  * @connector: the connector to init
 184  * @funcs: callbacks for this connector
 185  * @connector_type: user visible type of the connector
 186  *
 187  * Initialises a preallocated connector. Connectors should be
 188  * subclassed as part of driver connector objects.
 189  *
 190  * Returns:
 191  * Zero on success, error code on failure.
 192  */
 193 int drm_connector_init(struct drm_device *dev,
 194                        struct drm_connector *connector,
 195                        const struct drm_connector_funcs *funcs,
 196                        int connector_type)
 197 {
 198         struct drm_mode_config *config = &dev->mode_config;
 199         int ret;
 200         struct ida *connector_ida =
 201                 &drm_connector_enum_list[connector_type].ida;
 202
 203         WARN_ON(drm_drv_uses_atomic_modeset(dev) &&
 204                 (!funcs->atomic_destroy_state ||
 205                  !funcs->atomic_duplicate_state));
 206
 207         ret = __drm_mode_object_add(dev, &connector->base,
 208                                     DRM_MODE_OBJECT_CONNECTOR,
 209                                     false, drm_connector_free);
 210         if (ret)
 211                 return ret;
 212
 213         connector->base.properties = &connector->properties;
 214         connector->dev = dev;
 215         connector->funcs = funcs;
 216
 217         /* connector index is used with 32bit bitmasks */
 218         ret = ida_simple_get(&config->connector_ida, 0, 32, GFP_KERNEL);
 219         if (ret < 0) {
 220                 DRM_DEBUG_KMS("Failed to allocate %s connector index: %d\n",
 221                               drm_connector_enum_list[connector_type].name,
 222                               ret);
 223                 goto out_put;
 224         }
 225         connector->index = ret;
 226         ret = 0;
 227
 228         connector->connector_type = connector_type;
 229         connector->connector_type_id =
 230                 ida_simple_get(connector_ida, 1, 0, GFP_KERNEL);
 231         if (connector->connector_type_id < 0) {
 232                 ret = connector->connector_type_id;
 233                 goto out_put_id;
 234         }
 235         connector->name =
 236                 kasprintf(GFP_KERNEL, "%s-%d",
 237                           drm_connector_enum_list[connector_type].name,
 238                           connector->connector_type_id);
 239         if (!connector->name) {
 240                 ret = -ENOMEM;
 241                 goto out_put_type_id;
 242         }
 243
 244         INIT_LIST_HEAD(&connector->probed_modes);
 245         INIT_LIST_HEAD(&connector->modes);
 246         mutex_init(&connector->mutex);
 247         connector->edid_blob_ptr = NULL;
 248         connector->tile_blob_ptr = NULL;
 249         connector->status = connector_status_unknown;
 250         connector->display_info.panel_orientation =
 251                 DRM_MODE_PANEL_ORIENTATION_UNKNOWN;
 252
 253         drm_connector_get_cmdline_mode(connector);
 254
 255         /* We should add connectors at the end to avoid upsetting the connector
 256          * index too much. */
 257         spin_lock_irq(&config->connector_list_lock);
 258         list_add_tail(&connector->head, &config->connector_list);
 259         config->num_connector++;
 260         spin_unlock_irq(&config->connector_list_lock);
 261
 262         if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL &&
 263             connector_type != DRM_MODE_CONNECTOR_WRITEBACK)
 264                 drm_connector_attach_edid_property(connector);
 265
 266         drm_object_attach_property(&connector->base,
 267                                       config->dpms_property, 0);
 268
 269         drm_object_attach_property(&connector->base,
 270                                    config->link_status_property,
 271                                    0);
 272
 273         drm_object_attach_property(&connector->base,
 274                                    config->non_desktop_property,
 275                                    0);
 276         drm_object_attach_property(&connector->base,
 277                                    config->tile_property,
 278                                    0);
 279
 280         if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
 281                 drm_object_attach_property(&connector->base, config->prop_crtc_id, 0);
 282         }
 283
 284         connector->debugfs_entry = NULL;
 285 out_put_type_id:
 286         if (ret)
 287                 ida_simple_remove(connector_ida, connector->connector_type_id);
 288 out_put_id:
 289         if (ret)
 290                 ida_simple_remove(&config->connector_ida, connector->index);
 291 out_put:
 292         if (ret)
 293                 drm_mode_object_unregister(dev, &connector->base);
 294
 295         return ret;
 296 }
 297 EXPORT_SYMBOL(drm_connector_init);
 298
 299 /**
 300  * drm_connector_attach_edid_property - attach edid property.
 301  * @connector: the connector
 302  *
 303  * Some connector types like DRM_MODE_CONNECTOR_VIRTUAL do not get a
 304  * edid property attached by default.  This function can be used to
 305  * explicitly enable the edid property in these cases.
 306  */
 307 void drm_connector_attach_edid_property(struct drm_connector *connector)
 308 {
 309         struct drm_mode_config *config = &connector->dev->mode_config;
 310
 311         drm_object_attach_property(&connector->base,
 312                                    config->edid_property,
 313                                    0);
 314 }
 315 EXPORT_SYMBOL(drm_connector_attach_edid_property);
 316
 317 /**
 318  * drm_connector_attach_encoder - attach a connector to an encoder
 319  * @connector: connector to attach
 320  * @encoder: encoder to attach @connector to
 321  *
 322  * This function links up a connector to an encoder. Note that the routing
 323  * restrictions between encoders and crtcs are exposed to userspace through the
 324  * possible_clones and possible_crtcs bitmasks.
 325  *
 326  * Returns:
 327  * Zero on success, negative errno on failure.
 328  */
 329 int drm_connector_attach_encoder(struct drm_connector *connector,
 330                                  struct drm_encoder *encoder)
 331 {
 332         int i;
 333
 334         /*
 335          * In the past, drivers have attempted to model the static association
 336          * of connector to encoder in simple connector/encoder devices using a
 337          * direct assignment of connector->encoder = encoder. This connection
 338          * is a logical one and the responsibility of the core, so drivers are
 339          * expected not to mess with this.
 340          *
 341          * Note that the error return should've been enough here, but a large
 342          * majority of drivers ignores the return value, so add in a big WARN
 343          * to get people's attention.
 344          */
 345         if (WARN_ON(connector->encoder))
 346                 return -EINVAL;
 347
 348         for (i = 0; i < ARRAY_SIZE(connector->encoder_ids); i++) {
 349                 if (connector->encoder_ids[i] == 0) {
 350                         connector->encoder_ids[i] = encoder->base.id;
 351                         return 0;
 352                 }
 353         }
 354         return -ENOMEM;
 355 }
 356 EXPORT_SYMBOL(drm_connector_attach_encoder);
 357
 358 /**
 359  * drm_connector_has_possible_encoder - check if the connector and encoder are assosicated with each other
 360  * @connector: the connector
 361  * @encoder: the encoder
 362  *
 363  * Returns:
 364  * True if @encoder is one of the possible encoders for @connector.
 365  */
 366 bool drm_connector_has_possible_encoder(struct drm_connector *connector,
 367                                         struct drm_encoder *encoder)
 368 {
 369         struct drm_encoder *enc;
 370         int i;
 371
 372         drm_connector_for_each_possible_encoder(connector, enc, i) {
 373                 if (enc == encoder)
 374                         return true;
 375         }
 376
 377         return false;
 378 }
 379 EXPORT_SYMBOL(drm_connector_has_possible_encoder);
 380
 381 static void drm_mode_remove(struct drm_connector *connector,
 382                             struct drm_display_mode *mode)
 383 {
 384         list_del(&mode->head);
 385         drm_mode_destroy(connector->dev, mode);
 386 }
 387
 388 /**
 389  * drm_connector_cleanup - cleans up an initialised connector
 390  * @connector: connector to cleanup
 391  *
 392  * Cleans up the connector but doesn't free the object.
 393  */
 394 void drm_connector_cleanup(struct drm_connector *connector)
 395 {
 396         struct drm_device *dev = connector->dev;
 397         struct drm_display_mode *mode, *t;
 398
 399         /* The connector should have been removed from userspace long before
 400          * it is finally destroyed.
 401          */
 402         if (WARN_ON(connector->registration_state ==
 403                     DRM_CONNECTOR_REGISTERED))
 404                 drm_connector_unregister(connector);
 405
 406         if (connector->tile_group) {
 407                 drm_mode_put_tile_group(dev, connector->tile_group);
 408                 connector->tile_group = NULL;
 409         }
 410
 411         list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
 412                 drm_mode_remove(connector, mode);
 413
 414         list_for_each_entry_safe(mode, t, &connector->modes, head)
 415                 drm_mode_remove(connector, mode);
 416
 417         ida_simple_remove(&drm_connector_enum_list[connector->connector_type].ida,
 418                           connector->connector_type_id);
 419
 420         ida_simple_remove(&dev->mode_config.connector_ida,
 421                           connector->index);
 422
 423         kfree(connector->display_info.bus_formats);
 424         drm_mode_object_unregister(dev, &connector->base);
 425         kfree(connector->name);
 426         connector->name = NULL;
 427         spin_lock_irq(&dev->mode_config.connector_list_lock);
 428         list_del(&connector->head);
 429         dev->mode_config.num_connector--;
 430         spin_unlock_irq(&dev->mode_config.connector_list_lock);
 431
 432         WARN_ON(connector->state && !connector->funcs->atomic_destroy_state);
 433         if (connector->state && connector->funcs->atomic_destroy_state)
 434                 connector->funcs->atomic_destroy_state(connector,
 435                                                        connector->state);
 436
 437         mutex_destroy(&connector->mutex);
 438
 439         memset(connector, 0, sizeof(*connector));
 440 }
 441 EXPORT_SYMBOL(drm_connector_cleanup);
 442
 443 /**
 444  * drm_connector_register - register a connector
 445  * @connector: the connector to register
 446  *
 447  * Register userspace interfaces for a connector
 448  *
 449  * Returns:
 450  * Zero on success, error code on failure.
 451  */
 452 int drm_connector_register(struct drm_connector *connector)
 453 {
 454         int ret = 0;
 455
 456         if (!connector->dev->registered)
 457                 return 0;
 458
 459         mutex_lock(&connector->mutex);
 460         if (connector->registration_state != DRM_CONNECTOR_INITIALIZING)
 461                 goto unlock;
 462
 463         ret = drm_sysfs_connector_add(connector);
 464         if (ret)
 465                 goto unlock;
 466
 467         ret = drm_debugfs_connector_add(connector);
 468         if (ret) {
 469                 goto err_sysfs;
 470         }
 471
 472         if (connector->funcs->late_register) {
 473                 ret = connector->funcs->late_register(connector);
 474                 if (ret)
 475                         goto err_debugfs;
 476         }
 477
 478         drm_mode_object_register(connector->dev, &connector->base);
 479
 480         connector->registration_state = DRM_CONNECTOR_REGISTERED;
 481         goto unlock;
 482
 483 err_debugfs:
 484         drm_debugfs_connector_remove(connector);
 485 err_sysfs:
 486         drm_sysfs_connector_remove(connector);
 487 unlock:
 488         mutex_unlock(&connector->mutex);
 489         return ret;
 490 }
 491 EXPORT_SYMBOL(drm_connector_register);
 492
 493 /**
 494  * drm_connector_unregister - unregister a connector
 495  * @connector: the connector to unregister
 496  *
 497  * Unregister userspace interfaces for a connector
 498  */
 499 void drm_connector_unregister(struct drm_connector *connector)
 500 {
 501         mutex_lock(&connector->mutex);
 502         if (connector->registration_state != DRM_CONNECTOR_REGISTERED) {
 503                 mutex_unlock(&connector->mutex);
 504                 return;
 505         }
 506
 507         if (connector->funcs->early_unregister)
 508                 connector->funcs->early_unregister(connector);
 509
 510         drm_sysfs_connector_remove(connector);
 511         drm_debugfs_connector_remove(connector);
 512
 513         connector->registration_state = DRM_CONNECTOR_UNREGISTERED;
 514         mutex_unlock(&connector->mutex);
 515 }
 516 EXPORT_SYMBOL(drm_connector_unregister);
 517
 518 void drm_connector_unregister_all(struct drm_device *dev)
 519 {
 520         struct drm_connector *connector;
 521         struct drm_connector_list_iter conn_iter;
 522
 523         drm_connector_list_iter_begin(dev, &conn_iter);
 524         drm_for_each_connector_iter(connector, &conn_iter)
 525                 drm_connector_unregister(connector);
 526         drm_connector_list_iter_end(&conn_iter);
 527 }
 528
 529 int drm_connector_register_all(struct drm_device *dev)
 530 {
 531         struct drm_connector *connector;
 532         struct drm_connector_list_iter conn_iter;
 533         int ret = 0;
 534
 535         drm_connector_list_iter_begin(dev, &conn_iter);
 536         drm_for_each_connector_iter(connector, &conn_iter) {
 537                 ret = drm_connector_register(connector);
 538                 if (ret)
 539                         break;
 540         }
 541         drm_connector_list_iter_end(&conn_iter);
 542
 543         if (ret)
 544                 drm_connector_unregister_all(dev);
 545         return ret;
 546 }
 547
 548 /**
 549  * drm_get_connector_status_name - return a string for connector status
 550  * @status: connector status to compute name of
 551  *
 552  * In contrast to the other drm_get_*_name functions this one here returns a
 553  * const pointer and hence is threadsafe.
 554  */
 555 const char *drm_get_connector_status_name(enum drm_connector_status status)
 556 {
 557         if (status == connector_status_connected)
 558                 return "connected";
 559         else if (status == connector_status_disconnected)
 560                 return "disconnected";
 561         else
 562                 return "unknown";
 563 }
 564 EXPORT_SYMBOL(drm_get_connector_status_name);
 565
 566 /**
 567  * drm_get_connector_force_name - return a string for connector force
 568  * @force: connector force to get name of
 569  *
 570  * Returns: const pointer to name.
 571  */
 572 const char *drm_get_connector_force_name(enum drm_connector_force force)
 573 {
 574         switch (force) {
 575         case DRM_FORCE_UNSPECIFIED:
 576                 return "unspecified";
 577         case DRM_FORCE_OFF:
 578                 return "off";
 579         case DRM_FORCE_ON:
 580                 return "on";
 581         case DRM_FORCE_ON_DIGITAL:
 582                 return "digital";
 583         default:
 584                 return "unknown";
 585         }
 586 }
 587
 588 #ifdef CONFIG_LOCKDEP
 589 static struct lockdep_map connector_list_iter_dep_map = {
 590         .name = "drm_connector_list_iter"
 591 };
 592 #endif
 593
 594 /**
 595  * drm_connector_list_iter_begin - initialize a connector_list iterator
 596  * @dev: DRM device
 597  * @iter: connector_list iterator
 598  *
 599  * Sets @iter up to walk the &drm_mode_config.connector_list of @dev. @iter
 600  * must always be cleaned up again by calling drm_connector_list_iter_end().
 601  * Iteration itself happens using drm_connector_list_iter_next() or
 602  * drm_for_each_connector_iter().
 603  */
 604 void drm_connector_list_iter_begin(struct drm_device *dev,
 605                                    struct drm_connector_list_iter *iter)
 606 {
 607         iter->dev = dev;
 608         iter->conn = NULL;
 609         lock_acquire_shared_recursive(&connector_list_iter_dep_map, 0, 1, NULL, _RET_IP_);
 610 }
 611 EXPORT_SYMBOL(drm_connector_list_iter_begin);
 612
 613 /*
 614  * Extra-safe connector put function that works in any context. Should only be
 615  * used from the connector_iter functions, where we never really expect to
 616  * actually release the connector when dropping our final reference.
 617  */
 618 static void
 619 __drm_connector_put_safe(struct drm_connector *conn)
 620 {
 621         struct drm_mode_config *config = &conn->dev->mode_config;
 622
 623         lockdep_assert_held(&config->connector_list_lock);
 624
 625         if (!refcount_dec_and_test(&conn->base.refcount.refcount))
 626                 return;
 627
 628         llist_add(&conn->free_node, &config->connector_free_list);
 629         schedule_work(&config->connector_free_work);
 630 }
 631
 632 /**
 633  * drm_connector_list_iter_next - return next connector
 634  * @iter: connector_list iterator
 635  *
 636  * Returns the next connector for @iter, or NULL when the list walk has
 637  * completed.
 638  */
 639 struct drm_connector *
 640 drm_connector_list_iter_next(struct drm_connector_list_iter *iter)
 641 {
 642         struct drm_connector *old_conn = iter->conn;
 643         struct drm_mode_config *config = &iter->dev->mode_config;
 644         struct list_head *lhead;
 645         unsigned long flags;
 646
 647         spin_lock_irqsave(&config->connector_list_lock, flags);
 648         lhead = old_conn ? &old_conn->head : &config->connector_list;
 649
 650         do {
 651                 if (lhead->next == &config->connector_list) {
 652                         iter->conn = NULL;
 653                         break;
 654                 }
 655
 656                 lhead = lhead->next;
 657                 iter->conn = list_entry(lhead, struct drm_connector, head);
 658
 659                 /* loop until it's not a zombie connector */
 660         } while (!kref_get_unless_zero(&iter->conn->base.refcount));
 661
 662         if (old_conn)
 663                 __drm_connector_put_safe(old_conn);
 664         spin_unlock_irqrestore(&config->connector_list_lock, flags);
 665
 666         return iter->conn;
 667 }
 668 EXPORT_SYMBOL(drm_connector_list_iter_next);
 669
 670 /**
 671  * drm_connector_list_iter_end - tear down a connector_list iterator
 672  * @iter: connector_list iterator
 673  *
 674  * Tears down @iter and releases any resources (like &drm_connector references)
 675  * acquired while walking the list. This must always be called, both when the
 676  * iteration completes fully or when it was aborted without walking the entire
 677  * list.
 678  */
 679 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter)
 680 {
 681         struct drm_mode_config *config = &iter->dev->mode_config;
 682         unsigned long flags;
 683
 684         iter->dev = NULL;
 685         if (iter->conn) {
 686                 spin_lock_irqsave(&config->connector_list_lock, flags);
 687                 __drm_connector_put_safe(iter->conn);
 688                 spin_unlock_irqrestore(&config->connector_list_lock, flags);
 689         }
 690         lock_release(&connector_list_iter_dep_map, 0, _RET_IP_);
 691 }
 692 EXPORT_SYMBOL(drm_connector_list_iter_end);
 693
 694 static const struct drm_prop_enum_list drm_subpixel_enum_list[] = {
 695         { SubPixelUnknown, "Unknown" },
 696         { SubPixelHorizontalRGB, "Horizontal RGB" },
 697         { SubPixelHorizontalBGR, "Horizontal BGR" },
 698         { SubPixelVerticalRGB, "Vertical RGB" },
 699         { SubPixelVerticalBGR, "Vertical BGR" },
 700         { SubPixelNone, "None" },
 701 };
 702
 703 /**
 704  * drm_get_subpixel_order_name - return a string for a given subpixel enum
 705  * @order: enum of subpixel_order
 706  *
 707  * Note you could abuse this and return something out of bounds, but that
 708  * would be a caller error.  No unscrubbed user data should make it here.
 709  */
 710 const char *drm_get_subpixel_order_name(enum subpixel_order order)
 711 {
 712         return drm_subpixel_enum_list[order].name;
 713 }
 714 EXPORT_SYMBOL(drm_get_subpixel_order_name);
 715
 716 static const struct drm_prop_enum_list drm_dpms_enum_list[] = {
 717         { DRM_MODE_DPMS_ON, "On" },
 718         { DRM_MODE_DPMS_STANDBY, "Standby" },
 719         { DRM_MODE_DPMS_SUSPEND, "Suspend" },
 720         { DRM_MODE_DPMS_OFF, "Off" }
 721 };
 722 DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)
 723
 724 static const struct drm_prop_enum_list drm_link_status_enum_list[] = {
 725         { DRM_MODE_LINK_STATUS_GOOD, "Good" },
 726         { DRM_MODE_LINK_STATUS_BAD, "Bad" },
 727 };
 728
 729 /**
 730  * drm_display_info_set_bus_formats - set the supported bus formats
 731  * @info: display info to store bus formats in
 732  * @formats: array containing the supported bus formats
 733  * @num_formats: the number of entries in the fmts array
 734  *
 735  * Store the supported bus formats in display info structure.
 736  * See MEDIA_BUS_FMT_* definitions in include/uapi/linux/media-bus-format.h for
 737  * a full list of available formats.
 738  */
 739 int drm_display_info_set_bus_formats(struct drm_display_info *info,
 740                                      const u32 *formats,
 741                                      unsigned int num_formats)
 742 {
 743         u32 *fmts = NULL;
 744
 745         if (!formats && num_formats)
 746                 return -EINVAL;
 747
 748         if (formats && num_formats) {
 749                 fmts = kmemdup(formats, sizeof(*formats) * num_formats,
 750                                GFP_KERNEL);
 751                 if (!fmts)
 752                         return -ENOMEM;
 753         }
 754
 755         kfree(info->bus_formats);
 756         info->bus_formats = fmts;
 757         info->num_bus_formats = num_formats;
 758
 759         return 0;
 760 }
 761 EXPORT_SYMBOL(drm_display_info_set_bus_formats);
 762
 763 /* Optional connector properties. */
 764 static const struct drm_prop_enum_list drm_scaling_mode_enum_list[] = {
 765         { DRM_MODE_SCALE_NONE, "None" },
 766         { DRM_MODE_SCALE_FULLSCREEN, "Full" },
 767         { DRM_MODE_SCALE_CENTER, "Center" },
 768         { DRM_MODE_SCALE_ASPECT, "Full aspect" },
 769 };
 770
 771 static const struct drm_prop_enum_list drm_aspect_ratio_enum_list[] = {
 772         { DRM_MODE_PICTURE_ASPECT_NONE, "Automatic" },
 773         { DRM_MODE_PICTURE_ASPECT_4_3, "4:3" },
 774         { DRM_MODE_PICTURE_ASPECT_16_9, "16:9" },
 775 };
 776
 777 static const struct drm_prop_enum_list drm_content_type_enum_list[] = {
 778         { DRM_MODE_CONTENT_TYPE_NO_DATA, "No Data" },
 779         { DRM_MODE_CONTENT_TYPE_GRAPHICS, "Graphics" },
 780         { DRM_MODE_CONTENT_TYPE_PHOTO, "Photo" },
 781         { DRM_MODE_CONTENT_TYPE_CINEMA, "Cinema" },
 782         { DRM_MODE_CONTENT_TYPE_GAME, "Game" },
 783 };
 784
 785 static const struct drm_prop_enum_list drm_panel_orientation_enum_list[] = {
 786         { DRM_MODE_PANEL_ORIENTATION_NORMAL,    "Normal"        },
 787         { DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP, "Upside Down"   },
 788         { DRM_MODE_PANEL_ORIENTATION_LEFT_UP,   "Left Side Up"  },
 789         { DRM_MODE_PANEL_ORIENTATION_RIGHT_UP,  "Right Side Up" },
 790 };
 791
 792 static const struct drm_prop_enum_list drm_dvi_i_select_enum_list[] = {
 793         { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
 794         { DRM_MODE_SUBCONNECTOR_DVID,      "DVI-D"     }, /* DVI-I  */
 795         { DRM_MODE_SUBCONNECTOR_DVIA,      "DVI-A"     }, /* DVI-I  */
 796 };
 797 DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)
 798
 799 static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] = {
 800         { DRM_MODE_SUBCONNECTOR_Unknown,   "Unknown"   }, /* DVI-I and TV-out */
 801         { DRM_MODE_SUBCONNECTOR_DVID,      "DVI-D"     }, /* DVI-I  */
 802         { DRM_MODE_SUBCONNECTOR_DVIA,      "DVI-A"     }, /* DVI-I  */
 803 };
 804 DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
 805                  drm_dvi_i_subconnector_enum_list)
 806
 807 static const struct drm_prop_enum_list drm_tv_select_enum_list[] = {
 808         { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
 809         { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
 810         { DRM_MODE_SUBCONNECTOR_SVIDEO,    "SVIDEO"    }, /* TV-out */
 811         { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
 812         { DRM_MODE_SUBCONNECTOR_SCART,     "SCART"     }, /* TV-out */
 813 };
 814 DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)
 815
 816 static const struct drm_prop_enum_list drm_tv_subconnector_enum_list[] = {
 817         { DRM_MODE_SUBCONNECTOR_Unknown,   "Unknown"   }, /* DVI-I and TV-out */
 818         { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
 819         { DRM_MODE_SUBCONNECTOR_SVIDEO,    "SVIDEO"    }, /* TV-out */
 820         { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
 821         { DRM_MODE_SUBCONNECTOR_SCART,     "SCART"     }, /* TV-out */
 822 };
 823 DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
 824                  drm_tv_subconnector_enum_list)
 825
 826 static struct drm_prop_enum_list drm_cp_enum_list[] = {
 827         { DRM_MODE_CONTENT_PROTECTION_UNDESIRED, "Undesired" },
 828         { DRM_MODE_CONTENT_PROTECTION_DESIRED, "Desired" },
 829         { DRM_MODE_CONTENT_PROTECTION_ENABLED, "Enabled" },
 830 };
 831 DRM_ENUM_NAME_FN(drm_get_content_protection_name, drm_cp_enum_list)
 832
 833 static const struct drm_prop_enum_list hdmi_colorspaces[] = {
 834         /* For Default case, driver will set the colorspace */
 835         { DRM_MODE_COLORIMETRY_DEFAULT, "Default" },
 836         /* Standard Definition Colorimetry based on CEA 861 */
 837         { DRM_MODE_COLORIMETRY_SMPTE_170M_YCC, "SMPTE_170M_YCC" },
 838         { DRM_MODE_COLORIMETRY_BT709_YCC, "BT709_YCC" },
 839         /* Standard Definition Colorimetry based on IEC 61966-2-4 */
 840         { DRM_MODE_COLORIMETRY_XVYCC_601, "XVYCC_601" },
 841         /* High Definition Colorimetry based on IEC 61966-2-4 */
 842         { DRM_MODE_COLORIMETRY_XVYCC_709, "XVYCC_709" },
 843         /* Colorimetry based on IEC 61966-2-1/Amendment 1 */
 844         { DRM_MODE_COLORIMETRY_SYCC_601, "SYCC_601" },
 845         /* Colorimetry based on IEC 61966-2-5 [33] */
 846         { DRM_MODE_COLORIMETRY_OPYCC_601, "opYCC_601" },
 847         /* Colorimetry based on IEC 61966-2-5 */
 848         { DRM_MODE_COLORIMETRY_OPRGB, "opRGB" },
 849         /* Colorimetry based on ITU-R BT.2020 */
 850         { DRM_MODE_COLORIMETRY_BT2020_CYCC, "BT2020_CYCC" },
 851         /* Colorimetry based on ITU-R BT.2020 */
 852         { DRM_MODE_COLORIMETRY_BT2020_RGB, "BT2020_RGB" },
 853         /* Colorimetry based on ITU-R BT.2020 */
 854         { DRM_MODE_COLORIMETRY_BT2020_YCC, "BT2020_YCC" },
 855         /* Added as part of Additional Colorimetry Extension in 861.G */
 856         { DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65, "DCI-P3_RGB_D65" },
 857         { DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER, "DCI-P3_RGB_Theater" },
 858 };
 859
 860 /**
 861  * DOC: standard connector properties
 862  *
 863  * DRM connectors have a few standardized properties:
 864  *
 865  * EDID:
 866  *      Blob property which contains the current EDID read from the sink. This
 867  *      is useful to parse sink identification information like vendor, model
 868  *      and serial. Drivers should update this property by calling
 869  *      drm_connector_update_edid_property(), usually after having parsed
 870  *      the EDID using drm_add_edid_modes(). Userspace cannot change this
 871  *      property.
 872  * DPMS:
 873  *      Legacy property for setting the power state of the connector. For atomic
 874  *      drivers this is only provided for backwards compatibility with existing
 875  *      drivers, it remaps to controlling the "ACTIVE" property on the CRTC the
 876  *      connector is linked to. Drivers should never set this property directly,
 877  *      it is handled by the DRM core by calling the &drm_connector_funcs.dpms
 878  *      callback. For atomic drivers the remapping to the "ACTIVE" property is
 879  *      implemented in the DRM core.  This is the only standard connector
 880  *      property that userspace can change.
 881  *
 882  *      Note that this property cannot be set through the MODE_ATOMIC ioctl,
 883  *      userspace must use "ACTIVE" on the CRTC instead.
 884  *
 885  *      WARNING:
 886  *
 887  *      For userspace also running on legacy drivers the "DPMS" semantics are a
 888  *      lot more complicated. First, userspace cannot rely on the "DPMS" value
 889  *      returned by the GETCONNECTOR actually reflecting reality, because many
 890  *      drivers fail to update it. For atomic drivers this is taken care of in
 891  *      drm_atomic_helper_update_legacy_modeset_state().
 892  *
 893  *      The second issue is that the DPMS state is only well-defined when the
 894  *      connector is connected to a CRTC. In atomic the DRM core enforces that
 895  *      "ACTIVE" is off in such a case, no such checks exists for "DPMS".
 896  *
 897  *      Finally, when enabling an output using the legacy SETCONFIG ioctl then
 898  *      "DPMS" is forced to ON. But see above, that might not be reflected in
 899  *      the software value on legacy drivers.
 900  *
 901  *      Summarizing: Only set "DPMS" when the connector is known to be enabled,
 902  *      assume that a successful SETCONFIG call also sets "DPMS" to on, and
 903  *      never read back the value of "DPMS" because it can be incorrect.
 904  * PATH:
 905  *      Connector path property to identify how this sink is physically
 906  *      connected. Used by DP MST. This should be set by calling
 907  *      drm_connector_set_path_property(), in the case of DP MST with the
 908  *      path property the MST manager created. Userspace cannot change this
 909  *      property.
 910  * TILE:
 911  *      Connector tile group property to indicate how a set of DRM connector
 912  *      compose together into one logical screen. This is used by both high-res
 913  *      external screens (often only using a single cable, but exposing multiple
 914  *      DP MST sinks), or high-res integrated panels (like dual-link DSI) which
 915  *      are not gen-locked. Note that for tiled panels which are genlocked, like
 916  *      dual-link LVDS or dual-link DSI, the driver should try to not expose the
 917  *      tiling and virtualize both &drm_crtc and &drm_plane if needed. Drivers
 918  *      should update this value using drm_connector_set_tile_property().
 919  *      Userspace cannot change this property.
 920  * link-status:
 921  *      Connector link-status property to indicate the status of link. The
 922  *      default value of link-status is "GOOD". If something fails during or
 923  *      after modeset, the kernel driver may set this to "BAD" and issue a
 924  *      hotplug uevent. Drivers should update this value using
 925  *      drm_connector_set_link_status_property().
 926  * non_desktop:
 927  *      Indicates the output should be ignored for purposes of displaying a
 928  *      standard desktop environment or console. This is most likely because
 929  *      the output device is not rectilinear.
 930  * Content Protection:
 931  *      This property is used by userspace to request the kernel protect future
 932  *      content communicated over the link. When requested, kernel will apply
 933  *      the appropriate means of protection (most often HDCP), and use the
 934  *      property to tell userspace the protection is active.
 935  *
 936  *      Drivers can set this up by calling
 937  *      drm_connector_attach_content_protection_property() on initialization.
 938  *
 939  *      The value of this property can be one of the following:
 940  *
 941  *      DRM_MODE_CONTENT_PROTECTION_UNDESIRED = 0
 942  *              The link is not protected, content is transmitted in the clear.
 943  *      DRM_MODE_CONTENT_PROTECTION_DESIRED = 1
 944  *              Userspace has requested content protection, but the link is not
 945  *              currently protected. When in this state, kernel should enable
 946  *              Content Protection as soon as possible.
 947  *      DRM_MODE_CONTENT_PROTECTION_ENABLED = 2
 948  *              Userspace has requested content protection, and the link is
 949  *              protected. Only the driver can set the property to this value.
 950  *              If userspace attempts to set to ENABLED, kernel will return
 951  *              -EINVAL.
 952  *
 953  *      A few guidelines:
 954  *
 955  *      - DESIRED state should be preserved until userspace de-asserts it by
 956  *        setting the property to UNDESIRED. This means ENABLED should only
 957  *        transition to UNDESIRED when the user explicitly requests it.
 958  *      - If the state is DESIRED, kernel should attempt to re-authenticate the
 959  *        link whenever possible. This includes across disable/enable, dpms,
 960  *        hotplug, downstream device changes, link status failures, etc..
 961  *      - Userspace is responsible for polling the property to determine when
 962  *        the value transitions from ENABLED to DESIRED. This signifies the link
 963  *        is no longer protected and userspace should take appropriate action
 964  *        (whatever that might be).
 965  *
 966  * max bpc:
 967  *      This range property is used by userspace to limit the bit depth. When
 968  *      used the driver would limit the bpc in accordance with the valid range
 969  *      supported by the hardware and sink. Drivers to use the function
 970  *      drm_connector_attach_max_bpc_property() to create and attach the
 971  *      property to the connector during initialization.
 972  *
 973  * Connectors also have one standardized atomic property:
 974  *
 975  * CRTC_ID:
 976  *      Mode object ID of the &drm_crtc this connector should be connected to.
 977  *
 978  * Connectors for LCD panels may also have one standardized property:
 979  *
 980  * panel orientation:
 981  *      On some devices the LCD panel is mounted in the casing in such a way
 982  *      that the up/top side of the panel does not match with the top side of
 983  *      the device. Userspace can use this property to check for this.
 984  *      Note that input coordinates from touchscreens (input devices with
 985  *      INPUT_PROP_DIRECT) will still map 1:1 to the actual LCD panel
 986  *      coordinates, so if userspace rotates the picture to adjust for
 987  *      the orientation it must also apply the same transformation to the
 988  *      touchscreen input coordinates. This property is initialized by calling
 989  *      drm_connector_init_panel_orientation_property().
 990  *
 991  * scaling mode:
 992  *      This property defines how a non-native mode is upscaled to the native
 993  *      mode of an LCD panel:
 994  *
 995  *      None:
 996  *              No upscaling happens, scaling is left to the panel. Not all
 997  *              drivers expose this mode.
 998  *      Full:
 999  *              The output is upscaled to the full resolution of the panel,
1000  *              ignoring the aspect ratio.
1001  *      Center:
1002  *              No upscaling happens, the output is centered within the native
1003  *              resolution the panel.
1004  *      Full aspect:
1005  *              The output is upscaled to maximize either the width or height
1006  *              while retaining the aspect ratio.
1007  *
1008  *      This property should be set up by calling
1009  *      drm_connector_attach_scaling_mode_property(). Note that drivers
1010  *      can also expose this property to external outputs, in which case they
1011  *      must support "None", which should be the default (since external screens
1012  *      have a built-in scaler).
1013  */
1014
1015 int drm_connector_create_standard_properties(struct drm_device *dev)
1016 {
1017         struct drm_property *prop;
1018
1019         prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1020                                    DRM_MODE_PROP_IMMUTABLE,
1021                                    "EDID", 0);
1022         if (!prop)
1023                 return -ENOMEM;
1024         dev->mode_config.edid_property = prop;
1025
1026         prop = drm_property_create_enum(dev, 0,
1027                                    "DPMS", drm_dpms_enum_list,
1028                                    ARRAY_SIZE(drm_dpms_enum_list));
1029         if (!prop)
1030                 return -ENOMEM;
1031         dev->mode_config.dpms_property = prop;
1032
1033         prop = drm_property_create(dev,
1034                                    DRM_MODE_PROP_BLOB |
1035                                    DRM_MODE_PROP_IMMUTABLE,
1036                                    "PATH", 0);
1037         if (!prop)
1038                 return -ENOMEM;
1039         dev->mode_config.path_property = prop;
1040
1041         prop = drm_property_create(dev,
1042                                    DRM_MODE_PROP_BLOB |
1043                                    DRM_MODE_PROP_IMMUTABLE,
1044                                    "TILE", 0);
1045         if (!prop)
1046                 return -ENOMEM;
1047         dev->mode_config.tile_property = prop;
1048
1049         prop = drm_property_create_enum(dev, 0, "link-status",
1050                                         drm_link_status_enum_list,
1051                                         ARRAY_SIZE(drm_link_status_enum_list));
1052         if (!prop)
1053                 return -ENOMEM;
1054         dev->mode_config.link_status_property = prop;
1055
1056         prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE, "non-desktop");
1057         if (!prop)
1058                 return -ENOMEM;
1059         dev->mode_config.non_desktop_property = prop;
1060
1061         return 0;
1062 }
1063
1064 /**
1065  * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1066  * @dev: DRM device
1067  *
1068  * Called by a driver the first time a DVI-I connector is made.
1069  */
1070 int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1071 {
1072         struct drm_property *dvi_i_selector;
1073         struct drm_property *dvi_i_subconnector;
1074
1075         if (dev->mode_config.dvi_i_select_subconnector_property)
1076                 return 0;
1077
1078         dvi_i_selector =
1079                 drm_property_create_enum(dev, 0,
1080                                     "select subconnector",
1081                                     drm_dvi_i_select_enum_list,
1082                                     ARRAY_SIZE(drm_dvi_i_select_enum_list));
1083         dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1084
1085         dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1086                                     "subconnector",
1087                                     drm_dvi_i_subconnector_enum_list,
1088                                     ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1089         dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1090
1091         return 0;
1092 }
1093 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1094
1095 /**
1096  * DOC: HDMI connector properties
1097  *
1098  * content type (HDMI specific):
1099  *      Indicates content type setting to be used in HDMI infoframes to indicate
1100  *      content type for the external device, so that it adjusts its display
1101  *      settings accordingly.
1102  *
1103  *      The value of this property can be one of the following:
1104  *
1105  *      No Data:
1106  *              Content type is unknown
1107  *      Graphics:
1108  *              Content type is graphics
1109  *      Photo:
1110  *              Content type is photo
1111  *      Cinema:
1112  *              Content type is cinema
1113  *      Game:
1114  *              Content type is game
1115  *
1116  *      Drivers can set up this property by calling
1117  *      drm_connector_attach_content_type_property(). Decoding to
1118  *      infoframe values is done through drm_hdmi_avi_infoframe_content_type().
1119  */
1120
1121 /**
1122  * drm_connector_attach_content_type_property - attach content-type property
1123  * @connector: connector to attach content type property on.
1124  *
1125  * Called by a driver the first time a HDMI connector is made.
1126  */
1127 int drm_connector_attach_content_type_property(struct drm_connector *connector)
1128 {
1129         if (!drm_mode_create_content_type_property(connector->dev))
1130                 drm_object_attach_property(&connector->base,
1131                                            connector->dev->mode_config.content_type_property,
1132                                            DRM_MODE_CONTENT_TYPE_NO_DATA);
1133         return 0;
1134 }
1135 EXPORT_SYMBOL(drm_connector_attach_content_type_property);
1136
1137
1138 /**
1139  * drm_hdmi_avi_infoframe_content_type() - fill the HDMI AVI infoframe
1140  *                                         content type information, based
1141  *                                         on correspondent DRM property.
1142  * @frame: HDMI AVI infoframe
1143  * @conn_state: DRM display connector state
1144  *
1145  */
1146 void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame,
1147                                          const struct drm_connector_state *conn_state)
1148 {
1149         switch (conn_state->content_type) {
1150         case DRM_MODE_CONTENT_TYPE_GRAPHICS:
1151                 frame->content_type = HDMI_CONTENT_TYPE_GRAPHICS;
1152                 break;
1153         case DRM_MODE_CONTENT_TYPE_CINEMA:
1154                 frame->content_type = HDMI_CONTENT_TYPE_CINEMA;
1155                 break;
1156         case DRM_MODE_CONTENT_TYPE_GAME:
1157                 frame->content_type = HDMI_CONTENT_TYPE_GAME;
1158                 break;
1159         case DRM_MODE_CONTENT_TYPE_PHOTO:
1160                 frame->content_type = HDMI_CONTENT_TYPE_PHOTO;
1161                 break;
1162         default:
1163                 /* Graphics is the default(0) */
1164                 frame->content_type = HDMI_CONTENT_TYPE_GRAPHICS;
1165         }
1166
1167         frame->itc = conn_state->content_type != DRM_MODE_CONTENT_TYPE_NO_DATA;
1168 }
1169 EXPORT_SYMBOL(drm_hdmi_avi_infoframe_content_type);
1170
1171 /**
1172  * drm_mode_attach_tv_margin_properties - attach TV connector margin properties
1173  * @connector: DRM connector
1174  *
1175  * Called by a driver when it needs to attach TV margin props to a connector.
1176  * Typically used on SDTV and HDMI connectors.
1177  */
1178 void drm_connector_attach_tv_margin_properties(struct drm_connector *connector)
1179 {
1180         struct drm_device *dev = connector->dev;
1181
1182         drm_object_attach_property(&connector->base,
1183                                    dev->mode_config.tv_left_margin_property,
1184                                    0);
1185         drm_object_attach_property(&connector->base,
1186                                    dev->mode_config.tv_right_margin_property,
1187                                    0);
1188         drm_object_attach_property(&connector->base,
1189                                    dev->mode_config.tv_top_margin_property,
1190                                    0);
1191         drm_object_attach_property(&connector->base,
1192                                    dev->mode_config.tv_bottom_margin_property,
1193                                    0);
1194 }
1195 EXPORT_SYMBOL(drm_connector_attach_tv_margin_properties);
1196
1197 /**
1198  * drm_mode_create_tv_margin_properties - create TV connector margin properties
1199  * @dev: DRM device
1200  *
1201  * Called by a driver's HDMI connector initialization routine, this function
1202  * creates the TV margin properties for a given device. No need to call this
1203  * function for an SDTV connector, it's already called from
1204  * drm_mode_create_tv_properties().
1205  */
1206 int drm_mode_create_tv_margin_properties(struct drm_device *dev)
1207 {
1208         if (dev->mode_config.tv_left_margin_property)
1209                 return 0;
1210
1211         dev->mode_config.tv_left_margin_property =
1212                 drm_property_create_range(dev, 0, "left margin", 0, 100);
1213         if (!dev->mode_config.tv_left_margin_property)
1214                 return -ENOMEM;
1215
1216         dev->mode_config.tv_right_margin_property =
1217                 drm_property_create_range(dev, 0, "right margin", 0, 100);
1218         if (!dev->mode_config.tv_right_margin_property)
1219                 return -ENOMEM;
1220
1221         dev->mode_config.tv_top_margin_property =
1222                 drm_property_create_range(dev, 0, "top margin", 0, 100);
1223         if (!dev->mode_config.tv_top_margin_property)
1224                 return -ENOMEM;
1225
1226         dev->mode_config.tv_bottom_margin_property =
1227                 drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1228         if (!dev->mode_config.tv_bottom_margin_property)
1229                 return -ENOMEM;
1230
1231         return 0;
1232 }
1233 EXPORT_SYMBOL(drm_mode_create_tv_margin_properties);
1234
1235 /**
1236  * drm_mode_create_tv_properties - create TV specific connector properties
1237  * @dev: DRM device
1238  * @num_modes: number of different TV formats (modes) supported
1239  * @modes: array of pointers to strings containing name of each format
1240  *
1241  * Called by a driver's TV initialization routine, this function creates
1242  * the TV specific connector properties for a given device.  Caller is
1243  * responsible for allocating a list of format names and passing them to
1244  * this routine.
1245  */
1246 int drm_mode_create_tv_properties(struct drm_device *dev,
1247                                   unsigned int num_modes,
1248                                   const char * const modes[])
1249 {
1250         struct drm_property *tv_selector;
1251         struct drm_property *tv_subconnector;
1252         unsigned int i;
1253
1254         if (dev->mode_config.tv_select_subconnector_property)
1255                 return 0;
1256
1257         /*
1258          * Basic connector properties
1259          */
1260         tv_selector = drm_property_create_enum(dev, 0,
1261                                           "select subconnector",
1262                                           drm_tv_select_enum_list,
1263                                           ARRAY_SIZE(drm_tv_select_enum_list));
1264         if (!tv_selector)
1265                 goto nomem;
1266
1267         dev->mode_config.tv_select_subconnector_property = tv_selector;
1268
1269         tv_subconnector =
1270                 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1271                                     "subconnector",
1272                                     drm_tv_subconnector_enum_list,
1273                                     ARRAY_SIZE(drm_tv_subconnector_enum_list));
1274         if (!tv_subconnector)
1275                 goto nomem;
1276         dev->mode_config.tv_subconnector_property = tv_subconnector;
1277
1278         /*
1279          * Other, TV specific properties: margins & TV modes.
1280          */
1281         if (drm_mode_create_tv_margin_properties(dev))
1282                 goto nomem;
1283
1284         dev->mode_config.tv_mode_property =
1285                 drm_property_create(dev, DRM_MODE_PROP_ENUM,
1286                                     "mode", num_modes);
1287         if (!dev->mode_config.tv_mode_property)
1288                 goto nomem;
1289
1290         for (i = 0; i < num_modes; i++)
1291                 drm_property_add_enum(dev->mode_config.tv_mode_property,
1292                                       i, modes[i]);
1293
1294         dev->mode_config.tv_brightness_property =
1295                 drm_property_create_range(dev, 0, "brightness", 0, 100);
1296         if (!dev->mode_config.tv_brightness_property)
1297                 goto nomem;
1298
1299         dev->mode_config.tv_contrast_property =
1300                 drm_property_create_range(dev, 0, "contrast", 0, 100);
1301         if (!dev->mode_config.tv_contrast_property)
1302                 goto nomem;
1303
1304         dev->mode_config.tv_flicker_reduction_property =
1305                 drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1306         if (!dev->mode_config.tv_flicker_reduction_property)
1307                 goto nomem;
1308
1309         dev->mode_config.tv_overscan_property =
1310                 drm_property_create_range(dev, 0, "overscan", 0, 100);
1311         if (!dev->mode_config.tv_overscan_property)
1312                 goto nomem;
1313
1314         dev->mode_config.tv_saturation_property =
1315                 drm_property_create_range(dev, 0, "saturation", 0, 100);
1316         if (!dev->mode_config.tv_saturation_property)
1317                 goto nomem;
1318
1319         dev->mode_config.tv_hue_property =
1320                 drm_property_create_range(dev, 0, "hue", 0, 100);
1321         if (!dev->mode_config.tv_hue_property)
1322                 goto nomem;
1323
1324         return 0;
1325 nomem:
1326         return -ENOMEM;
1327 }
1328 EXPORT_SYMBOL(drm_mode_create_tv_properties);
1329
1330 /**
1331  * drm_mode_create_scaling_mode_property - create scaling mode property
1332  * @dev: DRM device
1333  *
1334  * Called by a driver the first time it's needed, must be attached to desired
1335  * connectors.
1336  *
1337  * Atomic drivers should use drm_connector_attach_scaling_mode_property()
1338  * instead to correctly assign &drm_connector_state.picture_aspect_ratio
1339  * in the atomic state.
1340  */
1341 int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1342 {
1343         struct drm_property *scaling_mode;
1344
1345         if (dev->mode_config.scaling_mode_property)
1346                 return 0;
1347
1348         scaling_mode =
1349                 drm_property_create_enum(dev, 0, "scaling mode",
1350                                 drm_scaling_mode_enum_list,
1351                                     ARRAY_SIZE(drm_scaling_mode_enum_list));
1352
1353         dev->mode_config.scaling_mode_property = scaling_mode;
1354
1355         return 0;
1356 }
1357 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1358
1359 /**
1360  * DOC: Variable refresh properties
1361  *
1362  * Variable refresh rate capable displays can dynamically adjust their
1363  * refresh rate by extending the duration of their vertical front porch
1364  * until page flip or timeout occurs. This can reduce or remove stuttering
1365  * and latency in scenarios where the page flip does not align with the
1366  * vblank interval.
1367  *
1368  * An example scenario would be an application flipping at a constant rate
1369  * of 48Hz on a 60Hz display. The page flip will frequently miss the vblank
1370  * interval and the same contents will be displayed twice. This can be
1371  * observed as stuttering for content with motion.
1372  *
1373  * If variable refresh rate was active on a display that supported a
1374  * variable refresh range from 35Hz to 60Hz no stuttering would be observable
1375  * for the example scenario. The minimum supported variable refresh rate of
1376  * 35Hz is below the page flip frequency and the vertical front porch can
1377  * be extended until the page flip occurs. The vblank interval will be
1378  * directly aligned to the page flip rate.
1379  *
1380  * Not all userspace content is suitable for use with variable refresh rate.
1381  * Large and frequent changes in vertical front porch duration may worsen
1382  * perceived stuttering for input sensitive applications.
1383  *
1384  * Panel brightness will also vary with vertical front porch duration. Some
1385  * panels may have noticeable differences in brightness between the minimum
1386  * vertical front porch duration and the maximum vertical front porch duration.
1387  * Large and frequent changes in vertical front porch duration may produce
1388  * observable flickering for such panels.
1389  *
1390  * Userspace control for variable refresh rate is supported via properties
1391  * on the &drm_connector and &drm_crtc objects.
1392  *
1393  * "vrr_capable":
1394  *      Optional &drm_connector boolean property that drivers should attach
1395  *      with drm_connector_attach_vrr_capable_property() on connectors that
1396  *      could support variable refresh rates. Drivers should update the
1397  *      property value by calling drm_connector_set_vrr_capable_property().
1398  *
1399  *      Absence of the property should indicate absence of support.
1400  *
1401  * "VRR_ENABLED":
1402  *      Default &drm_crtc boolean property that notifies the driver that the
1403  *      content on the CRTC is suitable for variable refresh rate presentation.
1404  *      The driver will take this property as a hint to enable variable
1405  *      refresh rate support if the receiver supports it, ie. if the
1406  *      "vrr_capable" property is true on the &drm_connector object. The
1407  *      vertical front porch duration will be extended until page-flip or
1408  *      timeout when enabled.
1409  *
1410  *      The minimum vertical front porch duration is defined as the vertical
1411  *      front porch duration for the current mode.
1412  *
1413  *      The maximum vertical front porch duration is greater than or equal to
1414  *      the minimum vertical front porch duration. The duration is derived
1415  *      from the minimum supported variable refresh rate for the connector.
1416  *
1417  *      The driver may place further restrictions within these minimum
1418  *      and maximum bounds.
1419  */
1420
1421 /**
1422  * drm_connector_attach_vrr_capable_property - creates the
1423  * vrr_capable property
1424  * @connector: connector to create the vrr_capable property on.
1425  *
1426  * This is used by atomic drivers to add support for querying
1427  * variable refresh rate capability for a connector.
1428  *
1429  * Returns:
1430  * Zero on success, negative errono on failure.
1431  */
1432 int drm_connector_attach_vrr_capable_property(
1433         struct drm_connector *connector)
1434 {
1435         struct drm_device *dev = connector->dev;
1436         struct drm_property *prop;
1437
1438         if (!connector->vrr_capable_property) {
1439                 prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE,
1440                         "vrr_capable");
1441                 if (!prop)
1442                         return -ENOMEM;
1443
1444                 connector->vrr_capable_property = prop;
1445                 drm_object_attach_property(&connector->base, prop, 0);
1446         }
1447
1448         return 0;
1449 }
1450 EXPORT_SYMBOL(drm_connector_attach_vrr_capable_property);
1451
1452 /**
1453  * drm_connector_attach_scaling_mode_property - attach atomic scaling mode property
1454  * @connector: connector to attach scaling mode property on.
1455  * @scaling_mode_mask: or'ed mask of BIT(%DRM_MODE_SCALE_\*).
1456  *
1457  * This is used to add support for scaling mode to atomic drivers.
1458  * The scaling mode will be set to &drm_connector_state.picture_aspect_ratio
1459  * and can be used from &drm_connector_helper_funcs->atomic_check for validation.
1460  *
1461  * This is the atomic version of drm_mode_create_scaling_mode_property().
1462  *
1463  * Returns:
1464  * Zero on success, negative errno on failure.
1465  */
1466 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
1467                                                u32 scaling_mode_mask)
1468 {
1469         struct drm_device *dev = connector->dev;
1470         struct drm_property *scaling_mode_property;
1471         int i;
1472         const unsigned valid_scaling_mode_mask =
1473                 (1U << ARRAY_SIZE(drm_scaling_mode_enum_list)) - 1;
1474
1475         if (WARN_ON(hweight32(scaling_mode_mask) < 2 ||
1476                     scaling_mode_mask & ~valid_scaling_mode_mask))
1477                 return -EINVAL;
1478
1479         scaling_mode_property =
1480                 drm_property_create(dev, DRM_MODE_PROP_ENUM, "scaling mode",
1481                                     hweight32(scaling_mode_mask));
1482
1483         if (!scaling_mode_property)
1484                 return -ENOMEM;
1485
1486         for (i = 0; i < ARRAY_SIZE(drm_scaling_mode_enum_list); i++) {
1487                 int ret;
1488
1489                 if (!(BIT(i) & scaling_mode_mask))
1490                         continue;
1491
1492                 ret = drm_property_add_enum(scaling_mode_property,
1493                                             drm_scaling_mode_enum_list[i].type,
1494                                             drm_scaling_mode_enum_list[i].name);
1495
1496                 if (ret) {
1497                         drm_property_destroy(dev, scaling_mode_property);
1498
1499                         return ret;
1500                 }
1501         }
1502
1503         drm_object_attach_property(&connector->base,
1504                                    scaling_mode_property, 0);
1505
1506         connector->scaling_mode_property = scaling_mode_property;
1507
1508         return 0;
1509 }
1510 EXPORT_SYMBOL(drm_connector_attach_scaling_mode_property);
1511
1512 /**
1513  * drm_connector_attach_content_protection_property - attach content protection
1514  * property
1515  *
1516  * @connector: connector to attach CP property on.
1517  *
1518  * This is used to add support for content protection on select connectors.
1519  * Content Protection is intentionally vague to allow for different underlying
1520  * technologies, however it is most implemented by HDCP.
1521  *
1522  * The content protection will be set to &drm_connector_state.content_protection
1523  *
1524  * Returns:
1525  * Zero on success, negative errno on failure.
1526  */
1527 int drm_connector_attach_content_protection_property(
1528                 struct drm_connector *connector)
1529 {
1530         struct drm_device *dev = connector->dev;
1531         struct drm_property *prop;
1532
1533         prop = drm_property_create_enum(dev, 0, "Content Protection",
1534                                         drm_cp_enum_list,
1535                                         ARRAY_SIZE(drm_cp_enum_list));
1536         if (!prop)
1537                 return -ENOMEM;
1538
1539         drm_object_attach_property(&connector->base, prop,
1540                                    DRM_MODE_CONTENT_PROTECTION_UNDESIRED);
1541
1542         connector->content_protection_property = prop;
1543
1544         return 0;
1545 }
1546 EXPORT_SYMBOL(drm_connector_attach_content_protection_property);
1547
1548 /**
1549  * drm_mode_create_aspect_ratio_property - create aspect ratio property
1550  * @dev: DRM device
1551  *
1552  * Called by a driver the first time it's needed, must be attached to desired
1553  * connectors.
1554  *
1555  * Returns:
1556  * Zero on success, negative errno on failure.
1557  */
1558 int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
1559 {
1560         if (dev->mode_config.aspect_ratio_property)
1561                 return 0;
1562
1563         dev->mode_config.aspect_ratio_property =
1564                 drm_property_create_enum(dev, 0, "aspect ratio",
1565                                 drm_aspect_ratio_enum_list,
1566                                 ARRAY_SIZE(drm_aspect_ratio_enum_list));
1567
1568         if (dev->mode_config.aspect_ratio_property == NULL)
1569                 return -ENOMEM;
1570
1571         return 0;
1572 }
1573 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
1574
1575 /**
1576  * DOC: standard connector properties
1577  *
1578  * Colorspace:
1579  *     drm_mode_create_colorspace_property - create colorspace property
1580  *     This property helps select a suitable colorspace based on the sink
1581  *     capability. Modern sink devices support wider gamut like BT2020.
1582  *     This helps switch to BT2020 mode if the BT2020 encoded video stream
1583  *     is being played by the user, same for any other colorspace. Thereby
1584  *     giving a good visual experience to users.
1585  *
1586  *     The expectation from userspace is that it should parse the EDID
1587  *     and get supported colorspaces. Use this property and switch to the
1588  *     one supported. Sink supported colorspaces should be retrieved by
1589  *     userspace from EDID and driver will not explicitly expose them.
1590  *
1591  *     Basically the expectation from userspace is:
1592  *      - Set up CRTC DEGAMMA/CTM/GAMMA to convert to some sink
1593  *        colorspace
1594  *      - Set this new property to let the sink know what it
1595  *        converted the CRTC output to.
1596  *      - This property is just to inform sink what colorspace
1597  *        source is trying to drive.
1598  *
1599  * Called by a driver the first time it's needed, must be attached to desired
1600  * connectors.
1601  */
1602 int drm_mode_create_colorspace_property(struct drm_connector *connector)
1603 {
1604         struct drm_device *dev = connector->dev;
1605         struct drm_property *prop;
1606
1607         if (connector->connector_type == DRM_MODE_CONNECTOR_HDMIA ||
1608             connector->connector_type == DRM_MODE_CONNECTOR_HDMIB) {
1609                 prop = drm_property_create_enum(dev, DRM_MODE_PROP_ENUM,
1610                                                 "Colorspace",
1611                                                 hdmi_colorspaces,
1612                                                 ARRAY_SIZE(hdmi_colorspaces));
1613                 if (!prop)
1614                         return -ENOMEM;
1615         } else {
1616                 DRM_DEBUG_KMS("Colorspace property not supported\n");
1617                 return 0;
1618         }
1619
1620         connector->colorspace_property = prop;
1621
1622         return 0;
1623 }
1624 EXPORT_SYMBOL(drm_mode_create_colorspace_property);
1625
1626 /**
1627  * drm_mode_create_content_type_property - create content type property
1628  * @dev: DRM device
1629  *
1630  * Called by a driver the first time it's needed, must be attached to desired
1631  * connectors.
1632  *
1633  * Returns:
1634  * Zero on success, negative errno on failure.
1635  */
1636 int drm_mode_create_content_type_property(struct drm_device *dev)
1637 {
1638         if (dev->mode_config.content_type_property)
1639                 return 0;
1640
1641         dev->mode_config.content_type_property =
1642                 drm_property_create_enum(dev, 0, "content type",
1643                                          drm_content_type_enum_list,
1644                                          ARRAY_SIZE(drm_content_type_enum_list));
1645
1646         if (dev->mode_config.content_type_property == NULL)
1647                 return -ENOMEM;
1648
1649         return 0;
1650 }
1651 EXPORT_SYMBOL(drm_mode_create_content_type_property);
1652
1653 /**
1654  * drm_mode_create_suggested_offset_properties - create suggests offset properties
1655  * @dev: DRM device
1656  *
1657  * Create the the suggested x/y offset property for connectors.
1658  */
1659 int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
1660 {
1661         if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
1662                 return 0;
1663
1664         dev->mode_config.suggested_x_property =
1665                 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
1666
1667         dev->mode_config.suggested_y_property =
1668                 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
1669
1670         if (dev->mode_config.suggested_x_property == NULL ||
1671             dev->mode_config.suggested_y_property == NULL)
1672                 return -ENOMEM;
1673         return 0;
1674 }
1675 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
1676
1677 /**
1678  * drm_connector_set_path_property - set tile property on connector
1679  * @connector: connector to set property on.
1680  * @path: path to use for property; must not be NULL.
1681  *
1682  * This creates a property to expose to userspace to specify a
1683  * connector path. This is mainly used for DisplayPort MST where
1684  * connectors have a topology and we want to allow userspace to give
1685  * them more meaningful names.
1686  *
1687  * Returns:
1688  * Zero on success, negative errno on failure.
1689  */
1690 int drm_connector_set_path_property(struct drm_connector *connector,
1691                                     const char *path)
1692 {
1693         struct drm_device *dev = connector->dev;
1694         int ret;
1695
1696         ret = drm_property_replace_global_blob(dev,
1697                                                &connector->path_blob_ptr,
1698                                                strlen(path) + 1,
1699                                                path,
1700                                                &connector->base,
1701                                                dev->mode_config.path_property);
1702         return ret;
1703 }
1704 EXPORT_SYMBOL(drm_connector_set_path_property);
1705
1706 /**
1707  * drm_connector_set_tile_property - set tile property on connector
1708  * @connector: connector to set property on.
1709  *
1710  * This looks up the tile information for a connector, and creates a
1711  * property for userspace to parse if it exists. The property is of
1712  * the form of 8 integers using ':' as a separator.
1713  * This is used for dual port tiled displays with DisplayPort SST
1714  * or DisplayPort MST connectors.
1715  *
1716  * Returns:
1717  * Zero on success, errno on failure.
1718  */
1719 int drm_connector_set_tile_property(struct drm_connector *connector)
1720 {
1721         struct drm_device *dev = connector->dev;
1722         char tile[256];
1723         int ret;
1724
1725         if (!connector->has_tile) {
1726                 ret  = drm_property_replace_global_blob(dev,
1727                                                         &connector->tile_blob_ptr,
1728                                                         0,
1729                                                         NULL,
1730                                                         &connector->base,
1731                                                         dev->mode_config.tile_property);
1732                 return ret;
1733         }
1734
1735         snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
1736                  connector->tile_group->id, connector->tile_is_single_monitor,
1737                  connector->num_h_tile, connector->num_v_tile,
1738                  connector->tile_h_loc, connector->tile_v_loc,
1739                  connector->tile_h_size, connector->tile_v_size);
1740
1741         ret = drm_property_replace_global_blob(dev,
1742                                                &connector->tile_blob_ptr,
1743                                                strlen(tile) + 1,
1744                                                tile,
1745                                                &connector->base,
1746                                                dev->mode_config.tile_property);
1747         return ret;
1748 }
1749 EXPORT_SYMBOL(drm_connector_set_tile_property);
1750
1751 /**
1752  * drm_connector_update_edid_property - update the edid property of a connector
1753  * @connector: drm connector
1754  * @edid: new value of the edid property
1755  *
1756  * This function creates a new blob modeset object and assigns its id to the
1757  * connector's edid property.
1758  * Since we also parse tile information from EDID's displayID block, we also
1759  * set the connector's tile property here. See drm_connector_set_tile_property()
1760  * for more details.
1761  *
1762  * Returns:
1763  * Zero on success, negative errno on failure.
1764  */
1765 int drm_connector_update_edid_property(struct drm_connector *connector,
1766                                        const struct edid *edid)
1767 {
1768         struct drm_device *dev = connector->dev;
1769         size_t size = 0;
1770         int ret;
1771
1772         /* ignore requests to set edid when overridden */
1773         if (connector->override_edid)
1774                 return 0;
1775
1776         if (edid)
1777                 size = EDID_LENGTH * (1 + edid->extensions);
1778
1779         /* Set the display info, using edid if available, otherwise
1780          * reseting the values to defaults. This duplicates the work
1781          * done in drm_add_edid_modes, but that function is not
1782          * consistently called before this one in all drivers and the
1783          * computation is cheap enough that it seems better to
1784          * duplicate it rather than attempt to ensure some arbitrary
1785          * ordering of calls.
1786          */
1787         if (edid)
1788                 drm_add_display_info(connector, edid);
1789         else
1790                 drm_reset_display_info(connector);
1791
1792         drm_object_property_set_value(&connector->base,
1793                                       dev->mode_config.non_desktop_property,
1794                                       connector->display_info.non_desktop);
1795
1796         ret = drm_property_replace_global_blob(dev,
1797                                                &connector->edid_blob_ptr,
1798                                                size,
1799                                                edid,
1800                                                &connector->base,
1801                                                dev->mode_config.edid_property);
1802         if (ret)
1803                 return ret;
1804         return drm_connector_set_tile_property(connector);
1805 }
1806 EXPORT_SYMBOL(drm_connector_update_edid_property);
1807
1808 /**
1809  * drm_connector_set_link_status_property - Set link status property of a connector
1810  * @connector: drm connector
1811  * @link_status: new value of link status property (0: Good, 1: Bad)
1812  *
1813  * In usual working scenario, this link status property will always be set to
1814  * "GOOD". If something fails during or after a mode set, the kernel driver
1815  * may set this link status property to "BAD". The caller then needs to send a
1816  * hotplug uevent for userspace to re-check the valid modes through
1817  * GET_CONNECTOR_IOCTL and retry modeset.
1818  *
1819  * Note: Drivers cannot rely on userspace to support this property and
1820  * issue a modeset. As such, they may choose to handle issues (like
1821  * re-training a link) without userspace's intervention.
1822  *
1823  * The reason for adding this property is to handle link training failures, but
1824  * it is not limited to DP or link training. For example, if we implement
1825  * asynchronous setcrtc, this property can be used to report any failures in that.
1826  */
1827 void drm_connector_set_link_status_property(struct drm_connector *connector,
1828                                             uint64_t link_status)
1829 {
1830         struct drm_device *dev = connector->dev;
1831
1832         drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
1833         connector->state->link_status = link_status;
1834         drm_modeset_unlock(&dev->mode_config.connection_mutex);
1835 }
1836 EXPORT_SYMBOL(drm_connector_set_link_status_property);
1837
1838 /**
1839  * drm_connector_attach_max_bpc_property - attach "max bpc" property
1840  * @connector: connector to attach max bpc property on.
1841  * @min: The minimum bit depth supported by the connector.
1842  * @max: The maximum bit depth supported by the connector.
1843  *
1844  * This is used to add support for limiting the bit depth on a connector.
1845  *
1846  * Returns:
1847  * Zero on success, negative errno on failure.
1848  */
1849 int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
1850                                           int min, int max)
1851 {
1852         struct drm_device *dev = connector->dev;
1853         struct drm_property *prop;
1854
1855         prop = connector->max_bpc_property;
1856         if (!prop) {
1857                 prop = drm_property_create_range(dev, 0, "max bpc", min, max);
1858                 if (!prop)
1859                         return -ENOMEM;
1860
1861                 connector->max_bpc_property = prop;
1862         }
1863
1864         drm_object_attach_property(&connector->base, prop, max);
1865         connector->state->max_requested_bpc = max;
1866         connector->state->max_bpc = max;
1867
1868         return 0;
1869 }
1870 EXPORT_SYMBOL(drm_connector_attach_max_bpc_property);
1871
1872 /**
1873  * drm_connector_set_vrr_capable_property - sets the variable refresh rate
1874  * capable property for a connector
1875  * @connector: drm connector
1876  * @capable: True if the connector is variable refresh rate capable
1877  *
1878  * Should be used by atomic drivers to update the indicated support for
1879  * variable refresh rate over a connector.
1880  */
1881 void drm_connector_set_vrr_capable_property(
1882                 struct drm_connector *connector, bool capable)
1883 {
1884         drm_object_property_set_value(&connector->base,
1885                                       connector->vrr_capable_property,
1886                                       capable);
1887 }
1888 EXPORT_SYMBOL(drm_connector_set_vrr_capable_property);
1889
1890 /**
1891  * drm_connector_init_panel_orientation_property -
1892  *      initialize the connecters panel_orientation property
1893  * @connector: connector for which to init the panel-orientation property.
1894  * @width: width in pixels of the panel, used for panel quirk detection
1895  * @height: height in pixels of the panel, used for panel quirk detection
1896  *
1897  * This function should only be called for built-in panels, after setting
1898  * connector->display_info.panel_orientation first (if known).
1899  *
1900  * This function will check for platform specific (e.g. DMI based) quirks
1901  * overriding display_info.panel_orientation first, then if panel_orientation
1902  * is not DRM_MODE_PANEL_ORIENTATION_UNKNOWN it will attach the
1903  * "panel orientation" property to the connector.
1904  *
1905  * Returns:
1906  * Zero on success, negative errno on failure.
1907  */
1908 int drm_connector_init_panel_orientation_property(
1909         struct drm_connector *connector, int width, int height)
1910 {
1911         struct drm_device *dev = connector->dev;
1912         struct drm_display_info *info = &connector->display_info;
1913         struct drm_property *prop;
1914         int orientation_quirk;
1915
1916         orientation_quirk = drm_get_panel_orientation_quirk(width, height);
1917         if (orientation_quirk != DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
1918                 info->panel_orientation = orientation_quirk;
1919
1920         if (info->panel_orientation == DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
1921                 return 0;
1922
1923         prop = dev->mode_config.panel_orientation_property;
1924         if (!prop) {
1925                 prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1926                                 "panel orientation",
1927                                 drm_panel_orientation_enum_list,
1928                                 ARRAY_SIZE(drm_panel_orientation_enum_list));
1929                 if (!prop)
1930                         return -ENOMEM;
1931
1932                 dev->mode_config.panel_orientation_property = prop;
1933         }
1934
1935         drm_object_attach_property(&connector->base, prop,
1936                                    info->panel_orientation);
1937         return 0;
1938 }
1939 EXPORT_SYMBOL(drm_connector_init_panel_orientation_property);
1940
1941 int drm_connector_set_obj_prop(struct drm_mode_object *obj,
1942                                     struct drm_property *property,
1943                                     uint64_t value)
1944 {
1945         int ret = -EINVAL;
1946         struct drm_connector *connector = obj_to_connector(obj);
1947
1948         /* Do DPMS ourselves */
1949         if (property == connector->dev->mode_config.dpms_property) {
1950                 ret = (*connector->funcs->dpms)(connector, (int)value);
1951         } else if (connector->funcs->set_property)
1952                 ret = connector->funcs->set_property(connector, property, value);
1953
1954         if (!ret)
1955                 drm_object_property_set_value(&connector->base, property, value);
1956         return ret;
1957 }
1958
1959 int drm_connector_property_set_ioctl(struct drm_device *dev,
1960                                      void *data, struct drm_file *file_priv)
1961 {
1962         struct drm_mode_connector_set_property *conn_set_prop = data;
1963         struct drm_mode_obj_set_property obj_set_prop = {
1964                 .value = conn_set_prop->value,
1965                 .prop_id = conn_set_prop->prop_id,
1966                 .obj_id = conn_set_prop->connector_id,
1967                 .obj_type = DRM_MODE_OBJECT_CONNECTOR
1968         };
1969
1970         /* It does all the locking and checking we need */
1971         return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
1972 }
1973
1974 static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
1975 {
1976         /* For atomic drivers only state objects are synchronously updated and
1977          * protected by modeset locks, so check those first. */
1978         if (connector->state)
1979                 return connector->state->best_encoder;
1980         return connector->encoder;
1981 }
1982
1983 static bool
1984 drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
1985                              const struct list_head *export_list,
1986                              const struct drm_file *file_priv)
1987 {
1988         /*
1989          * If user-space hasn't configured the driver to expose the stereo 3D
1990          * modes, don't expose them.
1991          */
1992         if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
1993                 return false;
1994         /*
1995          * If user-space hasn't configured the driver to expose the modes
1996          * with aspect-ratio, don't expose them. However if such a mode
1997          * is unique, let it be exposed, but reset the aspect-ratio flags
1998          * while preparing the list of user-modes.
1999          */
2000         if (!file_priv->aspect_ratio_allowed) {
2001                 struct drm_display_mode *mode_itr;
2002
2003                 list_for_each_entry(mode_itr, export_list, export_head)
2004                         if (drm_mode_match(mode_itr, mode,
2005                                            DRM_MODE_MATCH_TIMINGS |
2006                                            DRM_MODE_MATCH_CLOCK |
2007                                            DRM_MODE_MATCH_FLAGS |
2008                                            DRM_MODE_MATCH_3D_FLAGS))
2009                                 return false;
2010         }
2011
2012         return true;
2013 }
2014
2015 int drm_mode_getconnector(struct drm_device *dev, void *data,
2016                           struct drm_file *file_priv)
2017 {
2018         struct drm_mode_get_connector *out_resp = data;
2019         struct drm_connector *connector;
2020         struct drm_encoder *encoder;
2021         struct drm_display_mode *mode;
2022         int mode_count = 0;
2023         int encoders_count = 0;
2024         int ret = 0;
2025         int copied = 0;
2026         int i;
2027         struct drm_mode_modeinfo u_mode;
2028         struct drm_mode_modeinfo __user *mode_ptr;
2029         uint32_t __user *encoder_ptr;
2030         LIST_HEAD(export_list);
2031
2032         if (!drm_core_check_feature(dev, DRIVER_MODESET))
2033                 return -EOPNOTSUPP;
2034
2035         memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
2036
2037         connector = drm_connector_lookup(dev, file_priv, out_resp->connector_id);
2038         if (!connector)
2039                 return -ENOENT;
2040
2041         drm_connector_for_each_possible_encoder(connector, encoder, i)
2042                 encoders_count++;
2043
2044         if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
2045                 copied = 0;
2046                 encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
2047
2048                 drm_connector_for_each_possible_encoder(connector, encoder, i) {
2049                         if (put_user(encoder->base.id, encoder_ptr + copied)) {
2050                                 ret = -EFAULT;
2051                                 goto out;
2052                         }
2053                         copied++;
2054                 }
2055         }
2056         out_resp->count_encoders = encoders_count;
2057
2058         out_resp->connector_id = connector->base.id;
2059         out_resp->connector_type = connector->connector_type;
2060         out_resp->connector_type_id = connector->connector_type_id;
2061
2062         mutex_lock(&dev->mode_config.mutex);
2063         if (out_resp->count_modes == 0) {
2064                 connector->funcs->fill_modes(connector,
2065                                              dev->mode_config.max_width,
2066                                              dev->mode_config.max_height);
2067         }
2068
2069         out_resp->mm_width = connector->display_info.width_mm;
2070         out_resp->mm_height = connector->display_info.height_mm;
2071         out_resp->subpixel = connector->display_info.subpixel_order;
2072         out_resp->connection = connector->status;
2073
2074         /* delayed so we get modes regardless of pre-fill_modes state */
2075         list_for_each_entry(mode, &connector->modes, head)
2076                 if (drm_mode_expose_to_userspace(mode, &export_list,
2077                                                  file_priv)) {
2078                         list_add_tail(&mode->export_head, &export_list);
2079                         mode_count++;
2080                 }
2081
2082         /*
2083          * This ioctl is called twice, once to determine how much space is
2084          * needed, and the 2nd time to fill it.
2085          * The modes that need to be exposed to the user are maintained in the
2086          * 'export_list'. When the ioctl is called first time to determine the,
2087          * space, the export_list gets filled, to find the no.of modes. In the
2088          * 2nd time, the user modes are filled, one by one from the export_list.
2089          */
2090         if ((out_resp->count_modes >= mode_count) && mode_count) {
2091                 copied = 0;
2092                 mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
2093                 list_for_each_entry(mode, &export_list, export_head) {
2094                         drm_mode_convert_to_umode(&u_mode, mode);
2095                         /*
2096                          * Reset aspect ratio flags of user-mode, if modes with
2097                          * aspect-ratio are not supported.
2098                          */
2099                         if (!file_priv->aspect_ratio_allowed)
2100                                 u_mode.flags &= ~DRM_MODE_FLAG_PIC_AR_MASK;
2101                         if (copy_to_user(mode_ptr + copied,
2102                                          &u_mode, sizeof(u_mode))) {
2103                                 ret = -EFAULT;
2104                                 mutex_unlock(&dev->mode_config.mutex);
2105
2106                                 goto out;
2107                         }
2108                         copied++;
2109                 }
2110         }
2111         out_resp->count_modes = mode_count;
2112         mutex_unlock(&dev->mode_config.mutex);
2113
2114         drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2115         encoder = drm_connector_get_encoder(connector);
2116         if (encoder)
2117                 out_resp->encoder_id = encoder->base.id;
2118         else
2119                 out_resp->encoder_id = 0;
2120
2121         /* Only grab properties after probing, to make sure EDID and other
2122          * properties reflect the latest status. */
2123         ret = drm_mode_object_get_properties(&connector->base, file_priv->atomic,
2124                         (uint32_t __user *)(unsigned long)(out_resp->props_ptr),
2125                         (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr),
2126                         &out_resp->count_props);
2127         drm_modeset_unlock(&dev->mode_config.connection_mutex);
2128
2129 out:
2130         drm_connector_put(connector);
2131
2132         return ret;
2133 }
2134
2135
2136 /**
2137  * DOC: Tile group
2138  *
2139  * Tile groups are used to represent tiled monitors with a unique integer
2140  * identifier. Tiled monitors using DisplayID v1.3 have a unique 8-byte handle,
2141  * we store this in a tile group, so we have a common identifier for all tiles
2142  * in a monitor group. The property is called "TILE". Drivers can manage tile
2143  * groups using drm_mode_create_tile_group(), drm_mode_put_tile_group() and
2144  * drm_mode_get_tile_group(). But this is only needed for internal panels where
2145  * the tile group information is exposed through a non-standard way.
2146  */
2147
2148 static void drm_tile_group_free(struct kref *kref)
2149 {
2150         struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
2151         struct drm_device *dev = tg->dev;
2152         mutex_lock(&dev->mode_config.idr_mutex);
2153         idr_remove(&dev->mode_config.tile_idr, tg->id);
2154         mutex_unlock(&dev->mode_config.idr_mutex);
2155         kfree(tg);
2156 }
2157
2158 /**
2159  * drm_mode_put_tile_group - drop a reference to a tile group.
2160  * @dev: DRM device
2161  * @tg: tile group to drop reference to.
2162  *
2163  * drop reference to tile group and free if 0.
2164  */
2165 void drm_mode_put_tile_group(struct drm_device *dev,
2166                              struct drm_tile_group *tg)
2167 {
2168         kref_put(&tg->refcount, drm_tile_group_free);
2169 }
2170 EXPORT_SYMBOL(drm_mode_put_tile_group);
2171
2172 /**
2173  * drm_mode_get_tile_group - get a reference to an existing tile group
2174  * @dev: DRM device
2175  * @topology: 8-bytes unique per monitor.
2176  *
2177  * Use the unique bytes to get a reference to an existing tile group.
2178  *
2179  * RETURNS:
2180  * tile group or NULL if not found.
2181  */
2182 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
2183                                                char topology[8])
2184 {
2185         struct drm_tile_group *tg;
2186         int id;
2187         mutex_lock(&dev->mode_config.idr_mutex);
2188         idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
2189                 if (!memcmp(tg->group_data, topology, 8)) {
2190                         if (!kref_get_unless_zero(&tg->refcount))
2191                                 tg = NULL;
2192                         mutex_unlock(&dev->mode_config.idr_mutex);
2193                         return tg;
2194                 }
2195         }
2196         mutex_unlock(&dev->mode_config.idr_mutex);
2197         return NULL;
2198 }
2199 EXPORT_SYMBOL(drm_mode_get_tile_group);
2200
2201 /**
2202  * drm_mode_create_tile_group - create a tile group from a displayid description
2203  * @dev: DRM device
2204  * @topology: 8-bytes unique per monitor.
2205  *
2206  * Create a tile group for the unique monitor, and get a unique
2207  * identifier for the tile group.
2208  *
2209  * RETURNS:
2210  * new tile group or NULL.
2211  */
2212 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
2213                                                   char topology[8])
2214 {
2215         struct drm_tile_group *tg;
2216         int ret;
2217
2218         tg = kzalloc(sizeof(*tg), GFP_KERNEL);
2219         if (!tg)
2220                 return NULL;
2221
2222         kref_init(&tg->refcount);
2223         memcpy(tg->group_data, topology, 8);
2224         tg->dev = dev;
2225
2226         mutex_lock(&dev->mode_config.idr_mutex);
2227         ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
2228         if (ret >= 0) {
2229                 tg->id = ret;
2230         } else {
2231                 kfree(tg);
2232                 tg = NULL;
2233         }
2234
2235         mutex_unlock(&dev->mode_config.idr_mutex);
2236         return tg;
2237 }
2238 EXPORT_SYMBOL(drm_mode_create_tile_group);