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