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