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