Loading...
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_auth.h>
24#include <drm/drm_connector.h>
25#include <drm/drm_drv.h>
26#include <drm/drm_edid.h>
27#include <drm/drm_encoder.h>
28#include <drm/drm_file.h>
29#include <drm/drm_managed.h>
30#include <drm/drm_panel.h>
31#include <drm/drm_print.h>
32#include <drm/drm_privacy_screen_consumer.h>
33#include <drm/drm_sysfs.h>
34#include <drm/drm_utils.h>
35
36#include <linux/property.h>
37#include <linux/uaccess.h>
38
39#include <video/cmdline.h>
40
41#include "drm_crtc_internal.h"
42#include "drm_internal.h"
43
44/**
45 * DOC: overview
46 *
47 * In DRM connectors are the general abstraction for display sinks, and include
48 * also fixed panels or anything else that can display pixels in some form. As
49 * opposed to all other KMS objects representing hardware (like CRTC, encoder or
50 * plane abstractions) connectors can be hotplugged and unplugged at runtime.
51 * Hence they are reference-counted using drm_connector_get() and
52 * drm_connector_put().
53 *
54 * KMS driver must create, initialize, register and attach at a &struct
55 * drm_connector for each such sink. The instance is created as other KMS
56 * objects and initialized by setting the following fields. The connector is
57 * initialized with a call to drm_connector_init() with a pointer to the
58 * &struct drm_connector_funcs and a connector type, and then exposed to
59 * userspace with a call to drm_connector_register().
60 *
61 * Connectors must be attached to an encoder to be used. For devices that map
62 * connectors to encoders 1:1, the connector should be attached at
63 * initialization time with a call to drm_connector_attach_encoder(). The
64 * driver must also set the &drm_connector.encoder field to point to the
65 * attached encoder.
66 *
67 * For connectors which are not fixed (like built-in panels) the driver needs to
68 * support hotplug notifications. The simplest way to do that is by using the
69 * probe helpers, see drm_kms_helper_poll_init() for connectors which don't have
70 * hardware support for hotplug interrupts. Connectors with hardware hotplug
71 * support can instead use e.g. drm_helper_hpd_irq_event().
72 */
73
74/*
75 * Global connector list for drm_connector_find_by_fwnode().
76 * Note drm_connector_[un]register() first take connector->lock and then
77 * take the connector_list_lock.
78 */
79static DEFINE_MUTEX(connector_list_lock);
80static LIST_HEAD(connector_list);
81
82struct drm_conn_prop_enum_list {
83 int type;
84 const char *name;
85 struct ida ida;
86};
87
88/*
89 * Connector and encoder types.
90 */
91static struct drm_conn_prop_enum_list drm_connector_enum_list[] = {
92 { DRM_MODE_CONNECTOR_Unknown, "Unknown" },
93 { DRM_MODE_CONNECTOR_VGA, "VGA" },
94 { DRM_MODE_CONNECTOR_DVII, "DVI-I" },
95 { DRM_MODE_CONNECTOR_DVID, "DVI-D" },
96 { DRM_MODE_CONNECTOR_DVIA, "DVI-A" },
97 { DRM_MODE_CONNECTOR_Composite, "Composite" },
98 { DRM_MODE_CONNECTOR_SVIDEO, "SVIDEO" },
99 { DRM_MODE_CONNECTOR_LVDS, "LVDS" },
100 { DRM_MODE_CONNECTOR_Component, "Component" },
101 { DRM_MODE_CONNECTOR_9PinDIN, "DIN" },
102 { DRM_MODE_CONNECTOR_DisplayPort, "DP" },
103 { DRM_MODE_CONNECTOR_HDMIA, "HDMI-A" },
104 { DRM_MODE_CONNECTOR_HDMIB, "HDMI-B" },
105 { DRM_MODE_CONNECTOR_TV, "TV" },
106 { DRM_MODE_CONNECTOR_eDP, "eDP" },
107 { DRM_MODE_CONNECTOR_VIRTUAL, "Virtual" },
108 { DRM_MODE_CONNECTOR_DSI, "DSI" },
109 { DRM_MODE_CONNECTOR_DPI, "DPI" },
110 { DRM_MODE_CONNECTOR_WRITEBACK, "Writeback" },
111 { DRM_MODE_CONNECTOR_SPI, "SPI" },
112 { DRM_MODE_CONNECTOR_USB, "USB" },
113};
114
115void drm_connector_ida_init(void)
116{
117 int i;
118
119 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
120 ida_init(&drm_connector_enum_list[i].ida);
121}
122
123void drm_connector_ida_destroy(void)
124{
125 int i;
126
127 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
128 ida_destroy(&drm_connector_enum_list[i].ida);
129}
130
131/**
132 * drm_get_connector_type_name - return a string for connector type
133 * @type: The connector type (DRM_MODE_CONNECTOR_*)
134 *
135 * Returns: the name of the connector type, or NULL if the type is not valid.
136 */
137const char *drm_get_connector_type_name(unsigned int type)
138{
139 if (type < ARRAY_SIZE(drm_connector_enum_list))
140 return drm_connector_enum_list[type].name;
141
142 return NULL;
143}
144EXPORT_SYMBOL(drm_get_connector_type_name);
145
146/**
147 * drm_connector_get_cmdline_mode - reads the user's cmdline mode
148 * @connector: connector to query
149 *
150 * The kernel supports per-connector configuration of its consoles through
151 * use of the video= parameter. This function parses that option and
152 * extracts the user's specified mode (or enable/disable status) for a
153 * particular connector. This is typically only used during the early fbdev
154 * setup.
155 */
156static void drm_connector_get_cmdline_mode(struct drm_connector *connector)
157{
158 struct drm_cmdline_mode *mode = &connector->cmdline_mode;
159 const char *option;
160
161 option = video_get_options(connector->name);
162 if (!option)
163 return;
164
165 if (!drm_mode_parse_command_line_for_connector(option,
166 connector,
167 mode))
168 return;
169
170 if (mode->force) {
171 DRM_INFO("forcing %s connector %s\n", connector->name,
172 drm_get_connector_force_name(mode->force));
173 connector->force = mode->force;
174 }
175
176 if (mode->panel_orientation != DRM_MODE_PANEL_ORIENTATION_UNKNOWN) {
177 DRM_INFO("cmdline forces connector %s panel_orientation to %d\n",
178 connector->name, mode->panel_orientation);
179 drm_connector_set_panel_orientation(connector,
180 mode->panel_orientation);
181 }
182
183 DRM_DEBUG_KMS("cmdline mode for connector %s %s %dx%d@%dHz%s%s%s\n",
184 connector->name, mode->name,
185 mode->xres, mode->yres,
186 mode->refresh_specified ? mode->refresh : 60,
187 mode->rb ? " reduced blanking" : "",
188 mode->margins ? " with margins" : "",
189 mode->interlace ? " interlaced" : "");
190}
191
192static void drm_connector_free(struct kref *kref)
193{
194 struct drm_connector *connector =
195 container_of(kref, struct drm_connector, base.refcount);
196 struct drm_device *dev = connector->dev;
197
198 drm_mode_object_unregister(dev, &connector->base);
199 connector->funcs->destroy(connector);
200}
201
202void drm_connector_free_work_fn(struct work_struct *work)
203{
204 struct drm_connector *connector, *n;
205 struct drm_device *dev =
206 container_of(work, struct drm_device, mode_config.connector_free_work);
207 struct drm_mode_config *config = &dev->mode_config;
208 unsigned long flags;
209 struct llist_node *freed;
210
211 spin_lock_irqsave(&config->connector_list_lock, flags);
212 freed = llist_del_all(&config->connector_free_list);
213 spin_unlock_irqrestore(&config->connector_list_lock, flags);
214
215 llist_for_each_entry_safe(connector, n, freed, free_node) {
216 drm_mode_object_unregister(dev, &connector->base);
217 connector->funcs->destroy(connector);
218 }
219}
220
221static int __drm_connector_init(struct drm_device *dev,
222 struct drm_connector *connector,
223 const struct drm_connector_funcs *funcs,
224 int connector_type,
225 struct i2c_adapter *ddc)
226{
227 struct drm_mode_config *config = &dev->mode_config;
228 int ret;
229 struct ida *connector_ida =
230 &drm_connector_enum_list[connector_type].ida;
231
232 WARN_ON(drm_drv_uses_atomic_modeset(dev) &&
233 (!funcs->atomic_destroy_state ||
234 !funcs->atomic_duplicate_state));
235
236 ret = __drm_mode_object_add(dev, &connector->base,
237 DRM_MODE_OBJECT_CONNECTOR,
238 false, drm_connector_free);
239 if (ret)
240 return ret;
241
242 connector->base.properties = &connector->properties;
243 connector->dev = dev;
244 connector->funcs = funcs;
245
246 /* connector index is used with 32bit bitmasks */
247 ret = ida_alloc_max(&config->connector_ida, 31, GFP_KERNEL);
248 if (ret < 0) {
249 DRM_DEBUG_KMS("Failed to allocate %s connector index: %d\n",
250 drm_connector_enum_list[connector_type].name,
251 ret);
252 goto out_put;
253 }
254 connector->index = ret;
255 ret = 0;
256
257 connector->connector_type = connector_type;
258 connector->connector_type_id =
259 ida_alloc_min(connector_ida, 1, GFP_KERNEL);
260 if (connector->connector_type_id < 0) {
261 ret = connector->connector_type_id;
262 goto out_put_id;
263 }
264 connector->name =
265 kasprintf(GFP_KERNEL, "%s-%d",
266 drm_connector_enum_list[connector_type].name,
267 connector->connector_type_id);
268 if (!connector->name) {
269 ret = -ENOMEM;
270 goto out_put_type_id;
271 }
272
273 /* provide ddc symlink in sysfs */
274 connector->ddc = ddc;
275
276 INIT_LIST_HEAD(&connector->global_connector_list_entry);
277 INIT_LIST_HEAD(&connector->probed_modes);
278 INIT_LIST_HEAD(&connector->modes);
279 mutex_init(&connector->mutex);
280 mutex_init(&connector->eld_mutex);
281 mutex_init(&connector->edid_override_mutex);
282 mutex_init(&connector->hdmi.infoframes.lock);
283 connector->edid_blob_ptr = NULL;
284 connector->epoch_counter = 0;
285 connector->tile_blob_ptr = NULL;
286 connector->status = connector_status_unknown;
287 connector->display_info.panel_orientation =
288 DRM_MODE_PANEL_ORIENTATION_UNKNOWN;
289
290 drm_connector_get_cmdline_mode(connector);
291
292 /* We should add connectors at the end to avoid upsetting the connector
293 * index too much.
294 */
295 spin_lock_irq(&config->connector_list_lock);
296 list_add_tail(&connector->head, &config->connector_list);
297 config->num_connector++;
298 spin_unlock_irq(&config->connector_list_lock);
299
300 if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL &&
301 connector_type != DRM_MODE_CONNECTOR_WRITEBACK)
302 drm_connector_attach_edid_property(connector);
303
304 drm_object_attach_property(&connector->base,
305 config->dpms_property, 0);
306
307 drm_object_attach_property(&connector->base,
308 config->link_status_property,
309 0);
310
311 drm_object_attach_property(&connector->base,
312 config->non_desktop_property,
313 0);
314 drm_object_attach_property(&connector->base,
315 config->tile_property,
316 0);
317
318 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
319 drm_object_attach_property(&connector->base, config->prop_crtc_id, 0);
320 }
321
322 connector->debugfs_entry = NULL;
323out_put_type_id:
324 if (ret)
325 ida_free(connector_ida, connector->connector_type_id);
326out_put_id:
327 if (ret)
328 ida_free(&config->connector_ida, connector->index);
329out_put:
330 if (ret)
331 drm_mode_object_unregister(dev, &connector->base);
332
333 return ret;
334}
335
336/**
337 * drm_connector_init - Init a preallocated connector
338 * @dev: DRM device
339 * @connector: the connector to init
340 * @funcs: callbacks for this connector
341 * @connector_type: user visible type of the connector
342 *
343 * Initialises a preallocated connector. Connectors should be
344 * subclassed as part of driver connector objects.
345 *
346 * At driver unload time the driver's &drm_connector_funcs.destroy hook
347 * should call drm_connector_cleanup() and free the connector structure.
348 * The connector structure should not be allocated with devm_kzalloc().
349 *
350 * Note: consider using drmm_connector_init() instead of
351 * drm_connector_init() to let the DRM managed resource infrastructure
352 * take care of cleanup and deallocation.
353 *
354 * Returns:
355 * Zero on success, error code on failure.
356 */
357int drm_connector_init(struct drm_device *dev,
358 struct drm_connector *connector,
359 const struct drm_connector_funcs *funcs,
360 int connector_type)
361{
362 if (drm_WARN_ON(dev, !(funcs && funcs->destroy)))
363 return -EINVAL;
364
365 return __drm_connector_init(dev, connector, funcs, connector_type, NULL);
366}
367EXPORT_SYMBOL(drm_connector_init);
368
369/**
370 * drm_connector_init_with_ddc - Init a preallocated connector
371 * @dev: DRM device
372 * @connector: the connector to init
373 * @funcs: callbacks for this connector
374 * @connector_type: user visible type of the connector
375 * @ddc: pointer to the associated ddc adapter
376 *
377 * Initialises a preallocated connector. Connectors should be
378 * subclassed as part of driver connector objects.
379 *
380 * At driver unload time the driver's &drm_connector_funcs.destroy hook
381 * should call drm_connector_cleanup() and free the connector structure.
382 * The connector structure should not be allocated with devm_kzalloc().
383 *
384 * Ensures that the ddc field of the connector is correctly set.
385 *
386 * Note: consider using drmm_connector_init() instead of
387 * drm_connector_init_with_ddc() to let the DRM managed resource
388 * infrastructure take care of cleanup and deallocation.
389 *
390 * Returns:
391 * Zero on success, error code on failure.
392 */
393int drm_connector_init_with_ddc(struct drm_device *dev,
394 struct drm_connector *connector,
395 const struct drm_connector_funcs *funcs,
396 int connector_type,
397 struct i2c_adapter *ddc)
398{
399 if (drm_WARN_ON(dev, !(funcs && funcs->destroy)))
400 return -EINVAL;
401
402 return __drm_connector_init(dev, connector, funcs, connector_type, ddc);
403}
404EXPORT_SYMBOL(drm_connector_init_with_ddc);
405
406static void drm_connector_cleanup_action(struct drm_device *dev,
407 void *ptr)
408{
409 struct drm_connector *connector = ptr;
410
411 drm_connector_cleanup(connector);
412}
413
414/**
415 * drmm_connector_init - Init a preallocated connector
416 * @dev: DRM device
417 * @connector: the connector to init
418 * @funcs: callbacks for this connector
419 * @connector_type: user visible type of the connector
420 * @ddc: optional pointer to the associated ddc adapter
421 *
422 * Initialises a preallocated connector. Connectors should be
423 * subclassed as part of driver connector objects.
424 *
425 * Cleanup is automatically handled with a call to
426 * drm_connector_cleanup() in a DRM-managed action.
427 *
428 * The connector structure should be allocated with drmm_kzalloc().
429 *
430 * The @drm_connector_funcs.destroy hook must be NULL.
431 *
432 * Returns:
433 * Zero on success, error code on failure.
434 */
435int drmm_connector_init(struct drm_device *dev,
436 struct drm_connector *connector,
437 const struct drm_connector_funcs *funcs,
438 int connector_type,
439 struct i2c_adapter *ddc)
440{
441 int ret;
442
443 if (drm_WARN_ON(dev, funcs && funcs->destroy))
444 return -EINVAL;
445
446 ret = __drm_connector_init(dev, connector, funcs, connector_type, ddc);
447 if (ret)
448 return ret;
449
450 ret = drmm_add_action_or_reset(dev, drm_connector_cleanup_action,
451 connector);
452 if (ret)
453 return ret;
454
455 return 0;
456}
457EXPORT_SYMBOL(drmm_connector_init);
458
459/**
460 * drmm_connector_hdmi_init - Init a preallocated HDMI connector
461 * @dev: DRM device
462 * @connector: A pointer to the HDMI connector to init
463 * @vendor: HDMI Controller Vendor name
464 * @product: HDMI Controller Product name
465 * @funcs: callbacks for this connector
466 * @hdmi_funcs: HDMI-related callbacks for this connector
467 * @connector_type: user visible type of the connector
468 * @ddc: optional pointer to the associated ddc adapter
469 * @supported_formats: Bitmask of @hdmi_colorspace listing supported output formats
470 * @max_bpc: Maximum bits per char the HDMI connector supports
471 *
472 * Initialises a preallocated HDMI connector. Connectors can be
473 * subclassed as part of driver connector objects.
474 *
475 * Cleanup is automatically handled with a call to
476 * drm_connector_cleanup() in a DRM-managed action.
477 *
478 * The connector structure should be allocated with drmm_kzalloc().
479 *
480 * The @drm_connector_funcs.destroy hook must be NULL.
481 *
482 * Returns:
483 * Zero on success, error code on failure.
484 */
485int drmm_connector_hdmi_init(struct drm_device *dev,
486 struct drm_connector *connector,
487 const char *vendor, const char *product,
488 const struct drm_connector_funcs *funcs,
489 const struct drm_connector_hdmi_funcs *hdmi_funcs,
490 int connector_type,
491 struct i2c_adapter *ddc,
492 unsigned long supported_formats,
493 unsigned int max_bpc)
494{
495 int ret;
496
497 if (!vendor || !product)
498 return -EINVAL;
499
500 if ((strlen(vendor) > DRM_CONNECTOR_HDMI_VENDOR_LEN) ||
501 (strlen(product) > DRM_CONNECTOR_HDMI_PRODUCT_LEN))
502 return -EINVAL;
503
504 if (!(connector_type == DRM_MODE_CONNECTOR_HDMIA ||
505 connector_type == DRM_MODE_CONNECTOR_HDMIB))
506 return -EINVAL;
507
508 if (!supported_formats || !(supported_formats & BIT(HDMI_COLORSPACE_RGB)))
509 return -EINVAL;
510
511 if (connector->ycbcr_420_allowed != !!(supported_formats & BIT(HDMI_COLORSPACE_YUV420)))
512 return -EINVAL;
513
514 if (!(max_bpc == 8 || max_bpc == 10 || max_bpc == 12))
515 return -EINVAL;
516
517 ret = drmm_connector_init(dev, connector, funcs, connector_type, ddc);
518 if (ret)
519 return ret;
520
521 connector->hdmi.supported_formats = supported_formats;
522 strtomem_pad(connector->hdmi.vendor, vendor, 0);
523 strtomem_pad(connector->hdmi.product, product, 0);
524
525 /*
526 * drm_connector_attach_max_bpc_property() requires the
527 * connector to have a state.
528 */
529 if (connector->funcs->reset)
530 connector->funcs->reset(connector);
531
532 drm_connector_attach_max_bpc_property(connector, 8, max_bpc);
533 connector->max_bpc = max_bpc;
534
535 if (max_bpc > 8)
536 drm_connector_attach_hdr_output_metadata_property(connector);
537
538 connector->hdmi.funcs = hdmi_funcs;
539
540 return 0;
541}
542EXPORT_SYMBOL(drmm_connector_hdmi_init);
543
544/**
545 * drm_connector_attach_edid_property - attach edid property.
546 * @connector: the connector
547 *
548 * Some connector types like DRM_MODE_CONNECTOR_VIRTUAL do not get a
549 * edid property attached by default. This function can be used to
550 * explicitly enable the edid property in these cases.
551 */
552void drm_connector_attach_edid_property(struct drm_connector *connector)
553{
554 struct drm_mode_config *config = &connector->dev->mode_config;
555
556 drm_object_attach_property(&connector->base,
557 config->edid_property,
558 0);
559}
560EXPORT_SYMBOL(drm_connector_attach_edid_property);
561
562/**
563 * drm_connector_attach_encoder - attach a connector to an encoder
564 * @connector: connector to attach
565 * @encoder: encoder to attach @connector to
566 *
567 * This function links up a connector to an encoder. Note that the routing
568 * restrictions between encoders and crtcs are exposed to userspace through the
569 * possible_clones and possible_crtcs bitmasks.
570 *
571 * Returns:
572 * Zero on success, negative errno on failure.
573 */
574int drm_connector_attach_encoder(struct drm_connector *connector,
575 struct drm_encoder *encoder)
576{
577 /*
578 * In the past, drivers have attempted to model the static association
579 * of connector to encoder in simple connector/encoder devices using a
580 * direct assignment of connector->encoder = encoder. This connection
581 * is a logical one and the responsibility of the core, so drivers are
582 * expected not to mess with this.
583 *
584 * Note that the error return should've been enough here, but a large
585 * majority of drivers ignores the return value, so add in a big WARN
586 * to get people's attention.
587 */
588 if (WARN_ON(connector->encoder))
589 return -EINVAL;
590
591 connector->possible_encoders |= drm_encoder_mask(encoder);
592
593 return 0;
594}
595EXPORT_SYMBOL(drm_connector_attach_encoder);
596
597/**
598 * drm_connector_has_possible_encoder - check if the connector and encoder are
599 * associated with each other
600 * @connector: the connector
601 * @encoder: the encoder
602 *
603 * Returns:
604 * True if @encoder is one of the possible encoders for @connector.
605 */
606bool drm_connector_has_possible_encoder(struct drm_connector *connector,
607 struct drm_encoder *encoder)
608{
609 return connector->possible_encoders & drm_encoder_mask(encoder);
610}
611EXPORT_SYMBOL(drm_connector_has_possible_encoder);
612
613static void drm_mode_remove(struct drm_connector *connector,
614 struct drm_display_mode *mode)
615{
616 list_del(&mode->head);
617 drm_mode_destroy(connector->dev, mode);
618}
619
620/**
621 * drm_connector_cleanup - cleans up an initialised connector
622 * @connector: connector to cleanup
623 *
624 * Cleans up the connector but doesn't free the object.
625 */
626void drm_connector_cleanup(struct drm_connector *connector)
627{
628 struct drm_device *dev = connector->dev;
629 struct drm_display_mode *mode, *t;
630
631 /* The connector should have been removed from userspace long before
632 * it is finally destroyed.
633 */
634 if (WARN_ON(connector->registration_state ==
635 DRM_CONNECTOR_REGISTERED))
636 drm_connector_unregister(connector);
637
638 if (connector->privacy_screen) {
639 drm_privacy_screen_put(connector->privacy_screen);
640 connector->privacy_screen = NULL;
641 }
642
643 if (connector->tile_group) {
644 drm_mode_put_tile_group(dev, connector->tile_group);
645 connector->tile_group = NULL;
646 }
647
648 list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
649 drm_mode_remove(connector, mode);
650
651 list_for_each_entry_safe(mode, t, &connector->modes, head)
652 drm_mode_remove(connector, mode);
653
654 ida_free(&drm_connector_enum_list[connector->connector_type].ida,
655 connector->connector_type_id);
656
657 ida_free(&dev->mode_config.connector_ida, connector->index);
658
659 kfree(connector->display_info.bus_formats);
660 kfree(connector->display_info.vics);
661 drm_mode_object_unregister(dev, &connector->base);
662 kfree(connector->name);
663 connector->name = NULL;
664 fwnode_handle_put(connector->fwnode);
665 connector->fwnode = NULL;
666 spin_lock_irq(&dev->mode_config.connector_list_lock);
667 list_del(&connector->head);
668 dev->mode_config.num_connector--;
669 spin_unlock_irq(&dev->mode_config.connector_list_lock);
670
671 WARN_ON(connector->state && !connector->funcs->atomic_destroy_state);
672 if (connector->state && connector->funcs->atomic_destroy_state)
673 connector->funcs->atomic_destroy_state(connector,
674 connector->state);
675
676 mutex_destroy(&connector->hdmi.infoframes.lock);
677 mutex_destroy(&connector->mutex);
678
679 memset(connector, 0, sizeof(*connector));
680
681 if (dev->registered)
682 drm_sysfs_hotplug_event(dev);
683}
684EXPORT_SYMBOL(drm_connector_cleanup);
685
686/**
687 * drm_connector_register - register a connector
688 * @connector: the connector to register
689 *
690 * Register userspace interfaces for a connector. Only call this for connectors
691 * which can be hotplugged after drm_dev_register() has been called already,
692 * e.g. DP MST connectors. All other connectors will be registered automatically
693 * when calling drm_dev_register().
694 *
695 * When the connector is no longer available, callers must call
696 * drm_connector_unregister().
697 *
698 * Returns:
699 * Zero on success, error code on failure.
700 */
701int drm_connector_register(struct drm_connector *connector)
702{
703 int ret = 0;
704
705 if (!connector->dev->registered)
706 return 0;
707
708 mutex_lock(&connector->mutex);
709 if (connector->registration_state != DRM_CONNECTOR_INITIALIZING)
710 goto unlock;
711
712 ret = drm_sysfs_connector_add(connector);
713 if (ret)
714 goto unlock;
715
716 drm_debugfs_connector_add(connector);
717
718 if (connector->funcs->late_register) {
719 ret = connector->funcs->late_register(connector);
720 if (ret)
721 goto err_debugfs;
722 }
723
724 ret = drm_sysfs_connector_add_late(connector);
725 if (ret)
726 goto err_late_register;
727
728 drm_mode_object_register(connector->dev, &connector->base);
729
730 connector->registration_state = DRM_CONNECTOR_REGISTERED;
731
732 /* Let userspace know we have a new connector */
733 drm_sysfs_connector_hotplug_event(connector);
734
735 if (connector->privacy_screen)
736 drm_privacy_screen_register_notifier(connector->privacy_screen,
737 &connector->privacy_screen_notifier);
738
739 mutex_lock(&connector_list_lock);
740 list_add_tail(&connector->global_connector_list_entry, &connector_list);
741 mutex_unlock(&connector_list_lock);
742 goto unlock;
743
744err_late_register:
745 if (connector->funcs->early_unregister)
746 connector->funcs->early_unregister(connector);
747err_debugfs:
748 drm_debugfs_connector_remove(connector);
749 drm_sysfs_connector_remove(connector);
750unlock:
751 mutex_unlock(&connector->mutex);
752 return ret;
753}
754EXPORT_SYMBOL(drm_connector_register);
755
756/**
757 * drm_connector_unregister - unregister a connector
758 * @connector: the connector to unregister
759 *
760 * Unregister userspace interfaces for a connector. Only call this for
761 * connectors which have been registered explicitly by calling
762 * drm_connector_register().
763 */
764void drm_connector_unregister(struct drm_connector *connector)
765{
766 mutex_lock(&connector->mutex);
767 if (connector->registration_state != DRM_CONNECTOR_REGISTERED) {
768 mutex_unlock(&connector->mutex);
769 return;
770 }
771
772 mutex_lock(&connector_list_lock);
773 list_del_init(&connector->global_connector_list_entry);
774 mutex_unlock(&connector_list_lock);
775
776 if (connector->privacy_screen)
777 drm_privacy_screen_unregister_notifier(
778 connector->privacy_screen,
779 &connector->privacy_screen_notifier);
780
781 drm_sysfs_connector_remove_early(connector);
782
783 if (connector->funcs->early_unregister)
784 connector->funcs->early_unregister(connector);
785
786 drm_debugfs_connector_remove(connector);
787 drm_sysfs_connector_remove(connector);
788
789 connector->registration_state = DRM_CONNECTOR_UNREGISTERED;
790 mutex_unlock(&connector->mutex);
791}
792EXPORT_SYMBOL(drm_connector_unregister);
793
794void drm_connector_unregister_all(struct drm_device *dev)
795{
796 struct drm_connector *connector;
797 struct drm_connector_list_iter conn_iter;
798
799 drm_connector_list_iter_begin(dev, &conn_iter);
800 drm_for_each_connector_iter(connector, &conn_iter)
801 drm_connector_unregister(connector);
802 drm_connector_list_iter_end(&conn_iter);
803}
804
805int drm_connector_register_all(struct drm_device *dev)
806{
807 struct drm_connector *connector;
808 struct drm_connector_list_iter conn_iter;
809 int ret = 0;
810
811 drm_connector_list_iter_begin(dev, &conn_iter);
812 drm_for_each_connector_iter(connector, &conn_iter) {
813 ret = drm_connector_register(connector);
814 if (ret)
815 break;
816 }
817 drm_connector_list_iter_end(&conn_iter);
818
819 if (ret)
820 drm_connector_unregister_all(dev);
821 return ret;
822}
823
824/**
825 * drm_get_connector_status_name - return a string for connector status
826 * @status: connector status to compute name of
827 *
828 * In contrast to the other drm_get_*_name functions this one here returns a
829 * const pointer and hence is threadsafe.
830 *
831 * Returns: connector status string
832 */
833const char *drm_get_connector_status_name(enum drm_connector_status status)
834{
835 if (status == connector_status_connected)
836 return "connected";
837 else if (status == connector_status_disconnected)
838 return "disconnected";
839 else
840 return "unknown";
841}
842EXPORT_SYMBOL(drm_get_connector_status_name);
843
844/**
845 * drm_get_connector_force_name - return a string for connector force
846 * @force: connector force to get name of
847 *
848 * Returns: const pointer to name.
849 */
850const char *drm_get_connector_force_name(enum drm_connector_force force)
851{
852 switch (force) {
853 case DRM_FORCE_UNSPECIFIED:
854 return "unspecified";
855 case DRM_FORCE_OFF:
856 return "off";
857 case DRM_FORCE_ON:
858 return "on";
859 case DRM_FORCE_ON_DIGITAL:
860 return "digital";
861 default:
862 return "unknown";
863 }
864}
865
866#ifdef CONFIG_LOCKDEP
867static struct lockdep_map connector_list_iter_dep_map = {
868 .name = "drm_connector_list_iter"
869};
870#endif
871
872/**
873 * drm_connector_list_iter_begin - initialize a connector_list iterator
874 * @dev: DRM device
875 * @iter: connector_list iterator
876 *
877 * Sets @iter up to walk the &drm_mode_config.connector_list of @dev. @iter
878 * must always be cleaned up again by calling drm_connector_list_iter_end().
879 * Iteration itself happens using drm_connector_list_iter_next() or
880 * drm_for_each_connector_iter().
881 */
882void drm_connector_list_iter_begin(struct drm_device *dev,
883 struct drm_connector_list_iter *iter)
884{
885 iter->dev = dev;
886 iter->conn = NULL;
887 lock_acquire_shared_recursive(&connector_list_iter_dep_map, 0, 1, NULL, _RET_IP_);
888}
889EXPORT_SYMBOL(drm_connector_list_iter_begin);
890
891/*
892 * Extra-safe connector put function that works in any context. Should only be
893 * used from the connector_iter functions, where we never really expect to
894 * actually release the connector when dropping our final reference.
895 */
896static void
897__drm_connector_put_safe(struct drm_connector *conn)
898{
899 struct drm_mode_config *config = &conn->dev->mode_config;
900
901 lockdep_assert_held(&config->connector_list_lock);
902
903 if (!refcount_dec_and_test(&conn->base.refcount.refcount))
904 return;
905
906 llist_add(&conn->free_node, &config->connector_free_list);
907 schedule_work(&config->connector_free_work);
908}
909
910/**
911 * drm_connector_list_iter_next - return next connector
912 * @iter: connector_list iterator
913 *
914 * Returns: the next connector for @iter, or NULL when the list walk has
915 * completed.
916 */
917struct drm_connector *
918drm_connector_list_iter_next(struct drm_connector_list_iter *iter)
919{
920 struct drm_connector *old_conn = iter->conn;
921 struct drm_mode_config *config = &iter->dev->mode_config;
922 struct list_head *lhead;
923 unsigned long flags;
924
925 spin_lock_irqsave(&config->connector_list_lock, flags);
926 lhead = old_conn ? &old_conn->head : &config->connector_list;
927
928 do {
929 if (lhead->next == &config->connector_list) {
930 iter->conn = NULL;
931 break;
932 }
933
934 lhead = lhead->next;
935 iter->conn = list_entry(lhead, struct drm_connector, head);
936
937 /* loop until it's not a zombie connector */
938 } while (!kref_get_unless_zero(&iter->conn->base.refcount));
939
940 if (old_conn)
941 __drm_connector_put_safe(old_conn);
942 spin_unlock_irqrestore(&config->connector_list_lock, flags);
943
944 return iter->conn;
945}
946EXPORT_SYMBOL(drm_connector_list_iter_next);
947
948/**
949 * drm_connector_list_iter_end - tear down a connector_list iterator
950 * @iter: connector_list iterator
951 *
952 * Tears down @iter and releases any resources (like &drm_connector references)
953 * acquired while walking the list. This must always be called, both when the
954 * iteration completes fully or when it was aborted without walking the entire
955 * list.
956 */
957void drm_connector_list_iter_end(struct drm_connector_list_iter *iter)
958{
959 struct drm_mode_config *config = &iter->dev->mode_config;
960 unsigned long flags;
961
962 iter->dev = NULL;
963 if (iter->conn) {
964 spin_lock_irqsave(&config->connector_list_lock, flags);
965 __drm_connector_put_safe(iter->conn);
966 spin_unlock_irqrestore(&config->connector_list_lock, flags);
967 }
968 lock_release(&connector_list_iter_dep_map, _RET_IP_);
969}
970EXPORT_SYMBOL(drm_connector_list_iter_end);
971
972static const struct drm_prop_enum_list drm_subpixel_enum_list[] = {
973 { SubPixelUnknown, "Unknown" },
974 { SubPixelHorizontalRGB, "Horizontal RGB" },
975 { SubPixelHorizontalBGR, "Horizontal BGR" },
976 { SubPixelVerticalRGB, "Vertical RGB" },
977 { SubPixelVerticalBGR, "Vertical BGR" },
978 { SubPixelNone, "None" },
979};
980
981/**
982 * drm_get_subpixel_order_name - return a string for a given subpixel enum
983 * @order: enum of subpixel_order
984 *
985 * Note you could abuse this and return something out of bounds, but that
986 * would be a caller error. No unscrubbed user data should make it here.
987 *
988 * Returns: string describing an enumerated subpixel property
989 */
990const char *drm_get_subpixel_order_name(enum subpixel_order order)
991{
992 return drm_subpixel_enum_list[order].name;
993}
994EXPORT_SYMBOL(drm_get_subpixel_order_name);
995
996static const struct drm_prop_enum_list drm_dpms_enum_list[] = {
997 { DRM_MODE_DPMS_ON, "On" },
998 { DRM_MODE_DPMS_STANDBY, "Standby" },
999 { DRM_MODE_DPMS_SUSPEND, "Suspend" },
1000 { DRM_MODE_DPMS_OFF, "Off" }
1001};
1002DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)
1003
1004static const struct drm_prop_enum_list drm_link_status_enum_list[] = {
1005 { DRM_MODE_LINK_STATUS_GOOD, "Good" },
1006 { DRM_MODE_LINK_STATUS_BAD, "Bad" },
1007};
1008
1009/**
1010 * drm_display_info_set_bus_formats - set the supported bus formats
1011 * @info: display info to store bus formats in
1012 * @formats: array containing the supported bus formats
1013 * @num_formats: the number of entries in the fmts array
1014 *
1015 * Store the supported bus formats in display info structure.
1016 * See MEDIA_BUS_FMT_* definitions in include/uapi/linux/media-bus-format.h for
1017 * a full list of available formats.
1018 *
1019 * Returns:
1020 * 0 on success or a negative error code on failure.
1021 */
1022int drm_display_info_set_bus_formats(struct drm_display_info *info,
1023 const u32 *formats,
1024 unsigned int num_formats)
1025{
1026 u32 *fmts = NULL;
1027
1028 if (!formats && num_formats)
1029 return -EINVAL;
1030
1031 if (formats && num_formats) {
1032 fmts = kmemdup(formats, sizeof(*formats) * num_formats,
1033 GFP_KERNEL);
1034 if (!fmts)
1035 return -ENOMEM;
1036 }
1037
1038 kfree(info->bus_formats);
1039 info->bus_formats = fmts;
1040 info->num_bus_formats = num_formats;
1041
1042 return 0;
1043}
1044EXPORT_SYMBOL(drm_display_info_set_bus_formats);
1045
1046/* Optional connector properties. */
1047static const struct drm_prop_enum_list drm_scaling_mode_enum_list[] = {
1048 { DRM_MODE_SCALE_NONE, "None" },
1049 { DRM_MODE_SCALE_FULLSCREEN, "Full" },
1050 { DRM_MODE_SCALE_CENTER, "Center" },
1051 { DRM_MODE_SCALE_ASPECT, "Full aspect" },
1052};
1053
1054static const struct drm_prop_enum_list drm_aspect_ratio_enum_list[] = {
1055 { DRM_MODE_PICTURE_ASPECT_NONE, "Automatic" },
1056 { DRM_MODE_PICTURE_ASPECT_4_3, "4:3" },
1057 { DRM_MODE_PICTURE_ASPECT_16_9, "16:9" },
1058};
1059
1060static const struct drm_prop_enum_list drm_content_type_enum_list[] = {
1061 { DRM_MODE_CONTENT_TYPE_NO_DATA, "No Data" },
1062 { DRM_MODE_CONTENT_TYPE_GRAPHICS, "Graphics" },
1063 { DRM_MODE_CONTENT_TYPE_PHOTO, "Photo" },
1064 { DRM_MODE_CONTENT_TYPE_CINEMA, "Cinema" },
1065 { DRM_MODE_CONTENT_TYPE_GAME, "Game" },
1066};
1067
1068static const struct drm_prop_enum_list drm_panel_orientation_enum_list[] = {
1069 { DRM_MODE_PANEL_ORIENTATION_NORMAL, "Normal" },
1070 { DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP, "Upside Down" },
1071 { DRM_MODE_PANEL_ORIENTATION_LEFT_UP, "Left Side Up" },
1072 { DRM_MODE_PANEL_ORIENTATION_RIGHT_UP, "Right Side Up" },
1073};
1074
1075static const struct drm_prop_enum_list drm_dvi_i_select_enum_list[] = {
1076 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
1077 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
1078 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
1079};
1080DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)
1081
1082static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] = {
1083 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I, TV-out and DP */
1084 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
1085 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
1086};
1087DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
1088 drm_dvi_i_subconnector_enum_list)
1089
1090static const struct drm_prop_enum_list drm_tv_mode_enum_list[] = {
1091 { DRM_MODE_TV_MODE_NTSC, "NTSC" },
1092 { DRM_MODE_TV_MODE_NTSC_443, "NTSC-443" },
1093 { DRM_MODE_TV_MODE_NTSC_J, "NTSC-J" },
1094 { DRM_MODE_TV_MODE_PAL, "PAL" },
1095 { DRM_MODE_TV_MODE_PAL_M, "PAL-M" },
1096 { DRM_MODE_TV_MODE_PAL_N, "PAL-N" },
1097 { DRM_MODE_TV_MODE_SECAM, "SECAM" },
1098 { DRM_MODE_TV_MODE_MONOCHROME, "Mono" },
1099};
1100DRM_ENUM_NAME_FN(drm_get_tv_mode_name, drm_tv_mode_enum_list)
1101
1102/**
1103 * drm_get_tv_mode_from_name - Translates a TV mode name into its enum value
1104 * @name: TV Mode name we want to convert
1105 * @len: Length of @name
1106 *
1107 * Translates @name into an enum drm_connector_tv_mode.
1108 *
1109 * Returns: the enum value on success, a negative errno otherwise.
1110 */
1111int drm_get_tv_mode_from_name(const char *name, size_t len)
1112{
1113 unsigned int i;
1114
1115 for (i = 0; i < ARRAY_SIZE(drm_tv_mode_enum_list); i++) {
1116 const struct drm_prop_enum_list *item = &drm_tv_mode_enum_list[i];
1117
1118 if (strlen(item->name) == len && !strncmp(item->name, name, len))
1119 return item->type;
1120 }
1121
1122 return -EINVAL;
1123}
1124EXPORT_SYMBOL(drm_get_tv_mode_from_name);
1125
1126static const struct drm_prop_enum_list drm_tv_select_enum_list[] = {
1127 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
1128 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
1129 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
1130 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
1131 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
1132};
1133DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)
1134
1135static const struct drm_prop_enum_list drm_tv_subconnector_enum_list[] = {
1136 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I, TV-out and DP */
1137 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
1138 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
1139 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
1140 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
1141};
1142DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
1143 drm_tv_subconnector_enum_list)
1144
1145static const struct drm_prop_enum_list drm_dp_subconnector_enum_list[] = {
1146 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I, TV-out and DP */
1147 { DRM_MODE_SUBCONNECTOR_VGA, "VGA" }, /* DP */
1148 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DP */
1149 { DRM_MODE_SUBCONNECTOR_HDMIA, "HDMI" }, /* DP */
1150 { DRM_MODE_SUBCONNECTOR_DisplayPort, "DP" }, /* DP */
1151 { DRM_MODE_SUBCONNECTOR_Wireless, "Wireless" }, /* DP */
1152 { DRM_MODE_SUBCONNECTOR_Native, "Native" }, /* DP */
1153};
1154
1155DRM_ENUM_NAME_FN(drm_get_dp_subconnector_name,
1156 drm_dp_subconnector_enum_list)
1157
1158
1159static const char * const colorspace_names[] = {
1160 /* For Default case, driver will set the colorspace */
1161 [DRM_MODE_COLORIMETRY_DEFAULT] = "Default",
1162 /* Standard Definition Colorimetry based on CEA 861 */
1163 [DRM_MODE_COLORIMETRY_SMPTE_170M_YCC] = "SMPTE_170M_YCC",
1164 [DRM_MODE_COLORIMETRY_BT709_YCC] = "BT709_YCC",
1165 /* Standard Definition Colorimetry based on IEC 61966-2-4 */
1166 [DRM_MODE_COLORIMETRY_XVYCC_601] = "XVYCC_601",
1167 /* High Definition Colorimetry based on IEC 61966-2-4 */
1168 [DRM_MODE_COLORIMETRY_XVYCC_709] = "XVYCC_709",
1169 /* Colorimetry based on IEC 61966-2-1/Amendment 1 */
1170 [DRM_MODE_COLORIMETRY_SYCC_601] = "SYCC_601",
1171 /* Colorimetry based on IEC 61966-2-5 [33] */
1172 [DRM_MODE_COLORIMETRY_OPYCC_601] = "opYCC_601",
1173 /* Colorimetry based on IEC 61966-2-5 */
1174 [DRM_MODE_COLORIMETRY_OPRGB] = "opRGB",
1175 /* Colorimetry based on ITU-R BT.2020 */
1176 [DRM_MODE_COLORIMETRY_BT2020_CYCC] = "BT2020_CYCC",
1177 /* Colorimetry based on ITU-R BT.2020 */
1178 [DRM_MODE_COLORIMETRY_BT2020_RGB] = "BT2020_RGB",
1179 /* Colorimetry based on ITU-R BT.2020 */
1180 [DRM_MODE_COLORIMETRY_BT2020_YCC] = "BT2020_YCC",
1181 /* Added as part of Additional Colorimetry Extension in 861.G */
1182 [DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65] = "DCI-P3_RGB_D65",
1183 [DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER] = "DCI-P3_RGB_Theater",
1184 [DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED] = "RGB_WIDE_FIXED",
1185 /* Colorimetry based on scRGB (IEC 61966-2-2) */
1186 [DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT] = "RGB_WIDE_FLOAT",
1187 [DRM_MODE_COLORIMETRY_BT601_YCC] = "BT601_YCC",
1188};
1189
1190/**
1191 * drm_get_colorspace_name - return a string for color encoding
1192 * @colorspace: color space to compute name of
1193 *
1194 * In contrast to the other drm_get_*_name functions this one here returns a
1195 * const pointer and hence is threadsafe.
1196 */
1197const char *drm_get_colorspace_name(enum drm_colorspace colorspace)
1198{
1199 if (colorspace < ARRAY_SIZE(colorspace_names) && colorspace_names[colorspace])
1200 return colorspace_names[colorspace];
1201 else
1202 return "(null)";
1203}
1204
1205static const u32 hdmi_colorspaces =
1206 BIT(DRM_MODE_COLORIMETRY_SMPTE_170M_YCC) |
1207 BIT(DRM_MODE_COLORIMETRY_BT709_YCC) |
1208 BIT(DRM_MODE_COLORIMETRY_XVYCC_601) |
1209 BIT(DRM_MODE_COLORIMETRY_XVYCC_709) |
1210 BIT(DRM_MODE_COLORIMETRY_SYCC_601) |
1211 BIT(DRM_MODE_COLORIMETRY_OPYCC_601) |
1212 BIT(DRM_MODE_COLORIMETRY_OPRGB) |
1213 BIT(DRM_MODE_COLORIMETRY_BT2020_CYCC) |
1214 BIT(DRM_MODE_COLORIMETRY_BT2020_RGB) |
1215 BIT(DRM_MODE_COLORIMETRY_BT2020_YCC) |
1216 BIT(DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65) |
1217 BIT(DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER);
1218
1219/*
1220 * As per DP 1.4a spec, 2.2.5.7.5 VSC SDP Payload for Pixel Encoding/Colorimetry
1221 * Format Table 2-120
1222 */
1223static const u32 dp_colorspaces =
1224 BIT(DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED) |
1225 BIT(DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT) |
1226 BIT(DRM_MODE_COLORIMETRY_OPRGB) |
1227 BIT(DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65) |
1228 BIT(DRM_MODE_COLORIMETRY_BT2020_RGB) |
1229 BIT(DRM_MODE_COLORIMETRY_BT601_YCC) |
1230 BIT(DRM_MODE_COLORIMETRY_BT709_YCC) |
1231 BIT(DRM_MODE_COLORIMETRY_XVYCC_601) |
1232 BIT(DRM_MODE_COLORIMETRY_XVYCC_709) |
1233 BIT(DRM_MODE_COLORIMETRY_SYCC_601) |
1234 BIT(DRM_MODE_COLORIMETRY_OPYCC_601) |
1235 BIT(DRM_MODE_COLORIMETRY_BT2020_CYCC) |
1236 BIT(DRM_MODE_COLORIMETRY_BT2020_YCC);
1237
1238static const struct drm_prop_enum_list broadcast_rgb_names[] = {
1239 { DRM_HDMI_BROADCAST_RGB_AUTO, "Automatic" },
1240 { DRM_HDMI_BROADCAST_RGB_FULL, "Full" },
1241 { DRM_HDMI_BROADCAST_RGB_LIMITED, "Limited 16:235" },
1242};
1243
1244/*
1245 * drm_hdmi_connector_get_broadcast_rgb_name - Return a string for HDMI connector RGB broadcast selection
1246 * @broadcast_rgb: Broadcast RGB selection to compute name of
1247 *
1248 * Returns: the name of the Broadcast RGB selection, or NULL if the type
1249 * is not valid.
1250 */
1251const char *
1252drm_hdmi_connector_get_broadcast_rgb_name(enum drm_hdmi_broadcast_rgb broadcast_rgb)
1253{
1254 if (broadcast_rgb >= ARRAY_SIZE(broadcast_rgb_names))
1255 return NULL;
1256
1257 return broadcast_rgb_names[broadcast_rgb].name;
1258}
1259EXPORT_SYMBOL(drm_hdmi_connector_get_broadcast_rgb_name);
1260
1261static const char * const output_format_str[] = {
1262 [HDMI_COLORSPACE_RGB] = "RGB",
1263 [HDMI_COLORSPACE_YUV420] = "YUV 4:2:0",
1264 [HDMI_COLORSPACE_YUV422] = "YUV 4:2:2",
1265 [HDMI_COLORSPACE_YUV444] = "YUV 4:4:4",
1266};
1267
1268/*
1269 * drm_hdmi_connector_get_output_format_name() - Return a string for HDMI connector output format
1270 * @fmt: Output format to compute name of
1271 *
1272 * Returns: the name of the output format, or NULL if the type is not
1273 * valid.
1274 */
1275const char *
1276drm_hdmi_connector_get_output_format_name(enum hdmi_colorspace fmt)
1277{
1278 if (fmt >= ARRAY_SIZE(output_format_str))
1279 return NULL;
1280
1281 return output_format_str[fmt];
1282}
1283EXPORT_SYMBOL(drm_hdmi_connector_get_output_format_name);
1284
1285/**
1286 * DOC: standard connector properties
1287 *
1288 * DRM connectors have a few standardized properties:
1289 *
1290 * EDID:
1291 * Blob property which contains the current EDID read from the sink. This
1292 * is useful to parse sink identification information like vendor, model
1293 * and serial. Drivers should update this property by calling
1294 * drm_connector_update_edid_property(), usually after having parsed
1295 * the EDID using drm_add_edid_modes(). Userspace cannot change this
1296 * property.
1297 *
1298 * User-space should not parse the EDID to obtain information exposed via
1299 * other KMS properties (because the kernel might apply limits, quirks or
1300 * fixups to the EDID). For instance, user-space should not try to parse
1301 * mode lists from the EDID.
1302 * DPMS:
1303 * Legacy property for setting the power state of the connector. For atomic
1304 * drivers this is only provided for backwards compatibility with existing
1305 * drivers, it remaps to controlling the "ACTIVE" property on the CRTC the
1306 * connector is linked to. Drivers should never set this property directly,
1307 * it is handled by the DRM core by calling the &drm_connector_funcs.dpms
1308 * callback. For atomic drivers the remapping to the "ACTIVE" property is
1309 * implemented in the DRM core.
1310 *
1311 * Note that this property cannot be set through the MODE_ATOMIC ioctl,
1312 * userspace must use "ACTIVE" on the CRTC instead.
1313 *
1314 * WARNING:
1315 *
1316 * For userspace also running on legacy drivers the "DPMS" semantics are a
1317 * lot more complicated. First, userspace cannot rely on the "DPMS" value
1318 * returned by the GETCONNECTOR actually reflecting reality, because many
1319 * drivers fail to update it. For atomic drivers this is taken care of in
1320 * drm_atomic_helper_update_legacy_modeset_state().
1321 *
1322 * The second issue is that the DPMS state is only well-defined when the
1323 * connector is connected to a CRTC. In atomic the DRM core enforces that
1324 * "ACTIVE" is off in such a case, no such checks exists for "DPMS".
1325 *
1326 * Finally, when enabling an output using the legacy SETCONFIG ioctl then
1327 * "DPMS" is forced to ON. But see above, that might not be reflected in
1328 * the software value on legacy drivers.
1329 *
1330 * Summarizing: Only set "DPMS" when the connector is known to be enabled,
1331 * assume that a successful SETCONFIG call also sets "DPMS" to on, and
1332 * never read back the value of "DPMS" because it can be incorrect.
1333 * PATH:
1334 * Connector path property to identify how this sink is physically
1335 * connected. Used by DP MST. This should be set by calling
1336 * drm_connector_set_path_property(), in the case of DP MST with the
1337 * path property the MST manager created. Userspace cannot change this
1338 * property.
1339 *
1340 * In the case of DP MST, the property has the format
1341 * ``mst:<parent>-<ports>`` where ``<parent>`` is the KMS object ID of the
1342 * parent connector and ``<ports>`` is a hyphen-separated list of DP MST
1343 * port numbers. Note, KMS object IDs are not guaranteed to be stable
1344 * across reboots.
1345 * TILE:
1346 * Connector tile group property to indicate how a set of DRM connector
1347 * compose together into one logical screen. This is used by both high-res
1348 * external screens (often only using a single cable, but exposing multiple
1349 * DP MST sinks), or high-res integrated panels (like dual-link DSI) which
1350 * are not gen-locked. Note that for tiled panels which are genlocked, like
1351 * dual-link LVDS or dual-link DSI, the driver should try to not expose the
1352 * tiling and virtualise both &drm_crtc and &drm_plane if needed. Drivers
1353 * should update this value using drm_connector_set_tile_property().
1354 * Userspace cannot change this property.
1355 * link-status:
1356 * Connector link-status property to indicate the status of link. The
1357 * default value of link-status is "GOOD". If something fails during or
1358 * after modeset, the kernel driver may set this to "BAD" and issue a
1359 * hotplug uevent. Drivers should update this value using
1360 * drm_connector_set_link_status_property().
1361 *
1362 * When user-space receives the hotplug uevent and detects a "BAD"
1363 * link-status, the sink doesn't receive pixels anymore (e.g. the screen
1364 * becomes completely black). The list of available modes may have
1365 * changed. User-space is expected to pick a new mode if the current one
1366 * has disappeared and perform a new modeset with link-status set to
1367 * "GOOD" to re-enable the connector.
1368 *
1369 * If multiple connectors share the same CRTC and one of them gets a "BAD"
1370 * link-status, the other are unaffected (ie. the sinks still continue to
1371 * receive pixels).
1372 *
1373 * When user-space performs an atomic commit on a connector with a "BAD"
1374 * link-status without resetting the property to "GOOD", the sink may
1375 * still not receive pixels. When user-space performs an atomic commit
1376 * which resets the link-status property to "GOOD" without the
1377 * ALLOW_MODESET flag set, it might fail because a modeset is required.
1378 *
1379 * User-space can only change link-status to "GOOD", changing it to "BAD"
1380 * is a no-op.
1381 *
1382 * For backwards compatibility with non-atomic userspace the kernel
1383 * tries to automatically set the link-status back to "GOOD" in the
1384 * SETCRTC IOCTL. This might fail if the mode is no longer valid, similar
1385 * to how it might fail if a different screen has been connected in the
1386 * interim.
1387 * non_desktop:
1388 * Indicates the output should be ignored for purposes of displaying a
1389 * standard desktop environment or console. This is most likely because
1390 * the output device is not rectilinear.
1391 * Content Protection:
1392 * This property is used by userspace to request the kernel protect future
1393 * content communicated over the link. When requested, kernel will apply
1394 * the appropriate means of protection (most often HDCP), and use the
1395 * property to tell userspace the protection is active.
1396 *
1397 * Drivers can set this up by calling
1398 * drm_connector_attach_content_protection_property() on initialization.
1399 *
1400 * The value of this property can be one of the following:
1401 *
1402 * DRM_MODE_CONTENT_PROTECTION_UNDESIRED = 0
1403 * The link is not protected, content is transmitted in the clear.
1404 * DRM_MODE_CONTENT_PROTECTION_DESIRED = 1
1405 * Userspace has requested content protection, but the link is not
1406 * currently protected. When in this state, kernel should enable
1407 * Content Protection as soon as possible.
1408 * DRM_MODE_CONTENT_PROTECTION_ENABLED = 2
1409 * Userspace has requested content protection, and the link is
1410 * protected. Only the driver can set the property to this value.
1411 * If userspace attempts to set to ENABLED, kernel will return
1412 * -EINVAL.
1413 *
1414 * A few guidelines:
1415 *
1416 * - DESIRED state should be preserved until userspace de-asserts it by
1417 * setting the property to UNDESIRED. This means ENABLED should only
1418 * transition to UNDESIRED when the user explicitly requests it.
1419 * - If the state is DESIRED, kernel should attempt to re-authenticate the
1420 * link whenever possible. This includes across disable/enable, dpms,
1421 * hotplug, downstream device changes, link status failures, etc..
1422 * - Kernel sends uevent with the connector id and property id through
1423 * @drm_hdcp_update_content_protection, upon below kernel triggered
1424 * scenarios:
1425 *
1426 * - DESIRED -> ENABLED (authentication success)
1427 * - ENABLED -> DESIRED (termination of authentication)
1428 * - Please note no uevents for userspace triggered property state changes,
1429 * which can't fail such as
1430 *
1431 * - DESIRED/ENABLED -> UNDESIRED
1432 * - UNDESIRED -> DESIRED
1433 * - Userspace is responsible for polling the property or listen to uevents
1434 * to determine when the value transitions from ENABLED to DESIRED.
1435 * This signifies the link is no longer protected and userspace should
1436 * take appropriate action (whatever that might be).
1437 *
1438 * HDCP Content Type:
1439 * This Enum property is used by the userspace to declare the content type
1440 * of the display stream, to kernel. Here display stream stands for any
1441 * display content that userspace intended to display through HDCP
1442 * encryption.
1443 *
1444 * Content Type of a stream is decided by the owner of the stream, as
1445 * "HDCP Type0" or "HDCP Type1".
1446 *
1447 * The value of the property can be one of the below:
1448 * - "HDCP Type0": DRM_MODE_HDCP_CONTENT_TYPE0 = 0
1449 * - "HDCP Type1": DRM_MODE_HDCP_CONTENT_TYPE1 = 1
1450 *
1451 * When kernel starts the HDCP authentication (see "Content Protection"
1452 * for details), it uses the content type in "HDCP Content Type"
1453 * for performing the HDCP authentication with the display sink.
1454 *
1455 * Please note in HDCP spec versions, a link can be authenticated with
1456 * HDCP 2.2 for Content Type 0/Content Type 1. Where as a link can be
1457 * authenticated with HDCP1.4 only for Content Type 0(though it is implicit
1458 * in nature. As there is no reference for Content Type in HDCP1.4).
1459 *
1460 * HDCP2.2 authentication protocol itself takes the "Content Type" as a
1461 * parameter, which is a input for the DP HDCP2.2 encryption algo.
1462 *
1463 * In case of Type 0 content protection request, kernel driver can choose
1464 * either of HDCP spec versions 1.4 and 2.2. When HDCP2.2 is used for
1465 * "HDCP Type 0", a HDCP 2.2 capable repeater in the downstream can send
1466 * that content to a HDCP 1.4 authenticated HDCP sink (Type0 link).
1467 * But if the content is classified as "HDCP Type 1", above mentioned
1468 * HDCP 2.2 repeater wont send the content to the HDCP sink as it can't
1469 * authenticate the HDCP1.4 capable sink for "HDCP Type 1".
1470 *
1471 * Please note userspace can be ignorant of the HDCP versions used by the
1472 * kernel driver to achieve the "HDCP Content Type".
1473 *
1474 * At current scenario, classifying a content as Type 1 ensures that the
1475 * content will be displayed only through the HDCP2.2 encrypted link.
1476 *
1477 * Note that the HDCP Content Type property is introduced at HDCP 2.2, and
1478 * defaults to type 0. It is only exposed by drivers supporting HDCP 2.2
1479 * (hence supporting Type 0 and Type 1). Based on how next versions of
1480 * HDCP specs are defined content Type could be used for higher versions
1481 * too.
1482 *
1483 * If content type is changed when "Content Protection" is not UNDESIRED,
1484 * then kernel will disable the HDCP and re-enable with new type in the
1485 * same atomic commit. And when "Content Protection" is ENABLED, it means
1486 * that link is HDCP authenticated and encrypted, for the transmission of
1487 * the Type of stream mentioned at "HDCP Content Type".
1488 *
1489 * HDR_OUTPUT_METADATA:
1490 * Connector property to enable userspace to send HDR Metadata to
1491 * driver. This metadata is based on the composition and blending
1492 * policies decided by user, taking into account the hardware and
1493 * sink capabilities. The driver gets this metadata and creates a
1494 * Dynamic Range and Mastering Infoframe (DRM) in case of HDMI,
1495 * SDP packet (Non-audio INFOFRAME SDP v1.3) for DP. This is then
1496 * sent to sink. This notifies the sink of the upcoming frame's Color
1497 * Encoding and Luminance parameters.
1498 *
1499 * Userspace first need to detect the HDR capabilities of sink by
1500 * reading and parsing the EDID. Details of HDR metadata for HDMI
1501 * are added in CTA 861.G spec. For DP , its defined in VESA DP
1502 * Standard v1.4. It needs to then get the metadata information
1503 * of the video/game/app content which are encoded in HDR (basically
1504 * using HDR transfer functions). With this information it needs to
1505 * decide on a blending policy and compose the relevant
1506 * layers/overlays into a common format. Once this blending is done,
1507 * userspace will be aware of the metadata of the composed frame to
1508 * be send to sink. It then uses this property to communicate this
1509 * metadata to driver which then make a Infoframe packet and sends
1510 * to sink based on the type of encoder connected.
1511 *
1512 * Userspace will be responsible to do Tone mapping operation in case:
1513 * - Some layers are HDR and others are SDR
1514 * - HDR layers luminance is not same as sink
1515 *
1516 * It will even need to do colorspace conversion and get all layers
1517 * to one common colorspace for blending. It can use either GL, Media
1518 * or display engine to get this done based on the capabilities of the
1519 * associated hardware.
1520 *
1521 * Driver expects metadata to be put in &struct hdr_output_metadata
1522 * structure from userspace. This is received as blob and stored in
1523 * &drm_connector_state.hdr_output_metadata. It parses EDID and saves the
1524 * sink metadata in &struct hdr_sink_metadata, as
1525 * &drm_connector.hdr_sink_metadata. Driver uses
1526 * drm_hdmi_infoframe_set_hdr_metadata() helper to set the HDR metadata,
1527 * hdmi_drm_infoframe_pack() to pack the infoframe as per spec, in case of
1528 * HDMI encoder.
1529 *
1530 * max bpc:
1531 * This range property is used by userspace to limit the bit depth. When
1532 * used the driver would limit the bpc in accordance with the valid range
1533 * supported by the hardware and sink. Drivers to use the function
1534 * drm_connector_attach_max_bpc_property() to create and attach the
1535 * property to the connector during initialization.
1536 *
1537 * Connectors also have one standardized atomic property:
1538 *
1539 * CRTC_ID:
1540 * Mode object ID of the &drm_crtc this connector should be connected to.
1541 *
1542 * Connectors for LCD panels may also have one standardized property:
1543 *
1544 * panel orientation:
1545 * On some devices the LCD panel is mounted in the casing in such a way
1546 * that the up/top side of the panel does not match with the top side of
1547 * the device. Userspace can use this property to check for this.
1548 * Note that input coordinates from touchscreens (input devices with
1549 * INPUT_PROP_DIRECT) will still map 1:1 to the actual LCD panel
1550 * coordinates, so if userspace rotates the picture to adjust for
1551 * the orientation it must also apply the same transformation to the
1552 * touchscreen input coordinates. This property is initialized by calling
1553 * drm_connector_set_panel_orientation() or
1554 * drm_connector_set_panel_orientation_with_quirk()
1555 *
1556 * scaling mode:
1557 * This property defines how a non-native mode is upscaled to the native
1558 * mode of an LCD panel:
1559 *
1560 * None:
1561 * No upscaling happens, scaling is left to the panel. Not all
1562 * drivers expose this mode.
1563 * Full:
1564 * The output is upscaled to the full resolution of the panel,
1565 * ignoring the aspect ratio.
1566 * Center:
1567 * No upscaling happens, the output is centered within the native
1568 * resolution the panel.
1569 * Full aspect:
1570 * The output is upscaled to maximize either the width or height
1571 * while retaining the aspect ratio.
1572 *
1573 * This property should be set up by calling
1574 * drm_connector_attach_scaling_mode_property(). Note that drivers
1575 * can also expose this property to external outputs, in which case they
1576 * must support "None", which should be the default (since external screens
1577 * have a built-in scaler).
1578 *
1579 * subconnector:
1580 * This property is used by DVI-I, TVout and DisplayPort to indicate different
1581 * connector subtypes. Enum values more or less match with those from main
1582 * connector types.
1583 * For DVI-I and TVout there is also a matching property "select subconnector"
1584 * allowing to switch between signal types.
1585 * DP subconnector corresponds to a downstream port.
1586 *
1587 * privacy-screen sw-state, privacy-screen hw-state:
1588 * These 2 optional properties can be used to query the state of the
1589 * electronic privacy screen that is available on some displays; and in
1590 * some cases also control the state. If a driver implements these
1591 * properties then both properties must be present.
1592 *
1593 * "privacy-screen hw-state" is read-only and reflects the actual state
1594 * of the privacy-screen, possible values: "Enabled", "Disabled,
1595 * "Enabled-locked", "Disabled-locked". The locked states indicate
1596 * that the state cannot be changed through the DRM API. E.g. there
1597 * might be devices where the firmware-setup options, or a hardware
1598 * slider-switch, offer always on / off modes.
1599 *
1600 * "privacy-screen sw-state" can be set to change the privacy-screen state
1601 * when not locked. In this case the driver must update the hw-state
1602 * property to reflect the new state on completion of the commit of the
1603 * sw-state property. Setting the sw-state property when the hw-state is
1604 * locked must be interpreted by the driver as a request to change the
1605 * state to the set state when the hw-state becomes unlocked. E.g. if
1606 * "privacy-screen hw-state" is "Enabled-locked" and the sw-state
1607 * gets set to "Disabled" followed by the user unlocking the state by
1608 * changing the slider-switch position, then the driver must set the
1609 * state to "Disabled" upon receiving the unlock event.
1610 *
1611 * In some cases the privacy-screen's actual state might change outside of
1612 * control of the DRM code. E.g. there might be a firmware handled hotkey
1613 * which toggles the actual state, or the actual state might be changed
1614 * through another userspace API such as writing /proc/acpi/ibm/lcdshadow.
1615 * In this case the driver must update both the hw-state and the sw-state
1616 * to reflect the new value, overwriting any pending state requests in the
1617 * sw-state. Any pending sw-state requests are thus discarded.
1618 *
1619 * Note that the ability for the state to change outside of control of
1620 * the DRM master process means that userspace must not cache the value
1621 * of the sw-state. Caching the sw-state value and including it in later
1622 * atomic commits may lead to overriding a state change done through e.g.
1623 * a firmware handled hotkey. Therefor userspace must not include the
1624 * privacy-screen sw-state in an atomic commit unless it wants to change
1625 * its value.
1626 *
1627 * left margin, right margin, top margin, bottom margin:
1628 * Add margins to the connector's viewport. This is typically used to
1629 * mitigate overscan on TVs.
1630 *
1631 * The value is the size in pixels of the black border which will be
1632 * added. The attached CRTC's content will be scaled to fill the whole
1633 * area inside the margin.
1634 *
1635 * The margins configuration might be sent to the sink, e.g. via HDMI AVI
1636 * InfoFrames.
1637 *
1638 * Drivers can set up these properties by calling
1639 * drm_mode_create_tv_margin_properties().
1640 */
1641
1642int drm_connector_create_standard_properties(struct drm_device *dev)
1643{
1644 struct drm_property *prop;
1645
1646 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1647 DRM_MODE_PROP_IMMUTABLE,
1648 "EDID", 0);
1649 if (!prop)
1650 return -ENOMEM;
1651 dev->mode_config.edid_property = prop;
1652
1653 prop = drm_property_create_enum(dev, 0,
1654 "DPMS", drm_dpms_enum_list,
1655 ARRAY_SIZE(drm_dpms_enum_list));
1656 if (!prop)
1657 return -ENOMEM;
1658 dev->mode_config.dpms_property = prop;
1659
1660 prop = drm_property_create(dev,
1661 DRM_MODE_PROP_BLOB |
1662 DRM_MODE_PROP_IMMUTABLE,
1663 "PATH", 0);
1664 if (!prop)
1665 return -ENOMEM;
1666 dev->mode_config.path_property = prop;
1667
1668 prop = drm_property_create(dev,
1669 DRM_MODE_PROP_BLOB |
1670 DRM_MODE_PROP_IMMUTABLE,
1671 "TILE", 0);
1672 if (!prop)
1673 return -ENOMEM;
1674 dev->mode_config.tile_property = prop;
1675
1676 prop = drm_property_create_enum(dev, 0, "link-status",
1677 drm_link_status_enum_list,
1678 ARRAY_SIZE(drm_link_status_enum_list));
1679 if (!prop)
1680 return -ENOMEM;
1681 dev->mode_config.link_status_property = prop;
1682
1683 prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE, "non-desktop");
1684 if (!prop)
1685 return -ENOMEM;
1686 dev->mode_config.non_desktop_property = prop;
1687
1688 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB,
1689 "HDR_OUTPUT_METADATA", 0);
1690 if (!prop)
1691 return -ENOMEM;
1692 dev->mode_config.hdr_output_metadata_property = prop;
1693
1694 return 0;
1695}
1696
1697/**
1698 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1699 * @dev: DRM device
1700 *
1701 * Called by a driver the first time a DVI-I connector is made.
1702 *
1703 * Returns: %0
1704 */
1705int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1706{
1707 struct drm_property *dvi_i_selector;
1708 struct drm_property *dvi_i_subconnector;
1709
1710 if (dev->mode_config.dvi_i_select_subconnector_property)
1711 return 0;
1712
1713 dvi_i_selector =
1714 drm_property_create_enum(dev, 0,
1715 "select subconnector",
1716 drm_dvi_i_select_enum_list,
1717 ARRAY_SIZE(drm_dvi_i_select_enum_list));
1718 dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1719
1720 dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1721 "subconnector",
1722 drm_dvi_i_subconnector_enum_list,
1723 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1724 dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1725
1726 return 0;
1727}
1728EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1729
1730/**
1731 * drm_connector_attach_dp_subconnector_property - create subconnector property for DP
1732 * @connector: drm_connector to attach property
1733 *
1734 * Called by a driver when DP connector is created.
1735 */
1736void drm_connector_attach_dp_subconnector_property(struct drm_connector *connector)
1737{
1738 struct drm_mode_config *mode_config = &connector->dev->mode_config;
1739
1740 if (!mode_config->dp_subconnector_property)
1741 mode_config->dp_subconnector_property =
1742 drm_property_create_enum(connector->dev,
1743 DRM_MODE_PROP_IMMUTABLE,
1744 "subconnector",
1745 drm_dp_subconnector_enum_list,
1746 ARRAY_SIZE(drm_dp_subconnector_enum_list));
1747
1748 drm_object_attach_property(&connector->base,
1749 mode_config->dp_subconnector_property,
1750 DRM_MODE_SUBCONNECTOR_Unknown);
1751}
1752EXPORT_SYMBOL(drm_connector_attach_dp_subconnector_property);
1753
1754/**
1755 * DOC: HDMI connector properties
1756 *
1757 * Broadcast RGB (HDMI specific)
1758 * Indicates the Quantization Range (Full vs Limited) used. The color
1759 * processing pipeline will be adjusted to match the value of the
1760 * property, and the Infoframes will be generated and sent accordingly.
1761 *
1762 * This property is only relevant if the HDMI output format is RGB. If
1763 * it's one of the YCbCr variant, it will be ignored.
1764 *
1765 * The CRTC attached to the connector must be configured by user-space to
1766 * always produce full-range pixels.
1767 *
1768 * The value of this property can be one of the following:
1769 *
1770 * Automatic:
1771 * The quantization range is selected automatically based on the
1772 * mode according to the HDMI specifications (HDMI 1.4b - Section
1773 * 6.6 - Video Quantization Ranges).
1774 *
1775 * Full:
1776 * Full quantization range is forced.
1777 *
1778 * Limited 16:235:
1779 * Limited quantization range is forced. Unlike the name suggests,
1780 * this works for any number of bits-per-component.
1781 *
1782 * Property values other than Automatic can result in colors being off (if
1783 * limited is selected but the display expects full), or a black screen
1784 * (if full is selected but the display expects limited).
1785 *
1786 * Drivers can set up this property by calling
1787 * drm_connector_attach_broadcast_rgb_property().
1788 *
1789 * content type (HDMI specific):
1790 * Indicates content type setting to be used in HDMI infoframes to indicate
1791 * content type for the external device, so that it adjusts its display
1792 * settings accordingly.
1793 *
1794 * The value of this property can be one of the following:
1795 *
1796 * No Data:
1797 * Content type is unknown
1798 * Graphics:
1799 * Content type is graphics
1800 * Photo:
1801 * Content type is photo
1802 * Cinema:
1803 * Content type is cinema
1804 * Game:
1805 * Content type is game
1806 *
1807 * The meaning of each content type is defined in CTA-861-G table 15.
1808 *
1809 * Drivers can set up this property by calling
1810 * drm_connector_attach_content_type_property(). Decoding to
1811 * infoframe values is done through drm_hdmi_avi_infoframe_content_type().
1812 */
1813
1814/*
1815 * TODO: Document the properties:
1816 * - brightness
1817 * - contrast
1818 * - flicker reduction
1819 * - hue
1820 * - mode
1821 * - overscan
1822 * - saturation
1823 * - select subconnector
1824 */
1825/**
1826 * DOC: Analog TV Connector Properties
1827 *
1828 * TV Mode:
1829 * Indicates the TV Mode used on an analog TV connector. The value
1830 * of this property can be one of the following:
1831 *
1832 * NTSC:
1833 * TV Mode is CCIR System M (aka 525-lines) together with
1834 * the NTSC Color Encoding.
1835 *
1836 * NTSC-443:
1837 *
1838 * TV Mode is CCIR System M (aka 525-lines) together with
1839 * the NTSC Color Encoding, but with a color subcarrier
1840 * frequency of 4.43MHz
1841 *
1842 * NTSC-J:
1843 *
1844 * TV Mode is CCIR System M (aka 525-lines) together with
1845 * the NTSC Color Encoding, but with a black level equal to
1846 * the blanking level.
1847 *
1848 * PAL:
1849 *
1850 * TV Mode is CCIR System B (aka 625-lines) together with
1851 * the PAL Color Encoding.
1852 *
1853 * PAL-M:
1854 *
1855 * TV Mode is CCIR System M (aka 525-lines) together with
1856 * the PAL Color Encoding.
1857 *
1858 * PAL-N:
1859 *
1860 * TV Mode is CCIR System N together with the PAL Color
1861 * Encoding, a color subcarrier frequency of 3.58MHz, the
1862 * SECAM color space, and narrower channels than other PAL
1863 * variants.
1864 *
1865 * SECAM:
1866 *
1867 * TV Mode is CCIR System B (aka 625-lines) together with
1868 * the SECAM Color Encoding.
1869 *
1870 * Mono:
1871 *
1872 * Use timings appropriate to the DRM mode, including
1873 * equalizing pulses for a 525-line or 625-line mode,
1874 * with no pedestal or color encoding.
1875 *
1876 * Drivers can set up this property by calling
1877 * drm_mode_create_tv_properties().
1878 */
1879
1880/**
1881 * drm_connector_attach_content_type_property - attach content-type property
1882 * @connector: connector to attach content type property on.
1883 *
1884 * Called by a driver the first time a HDMI connector is made.
1885 *
1886 * Returns: %0
1887 */
1888int drm_connector_attach_content_type_property(struct drm_connector *connector)
1889{
1890 if (!drm_mode_create_content_type_property(connector->dev))
1891 drm_object_attach_property(&connector->base,
1892 connector->dev->mode_config.content_type_property,
1893 DRM_MODE_CONTENT_TYPE_NO_DATA);
1894 return 0;
1895}
1896EXPORT_SYMBOL(drm_connector_attach_content_type_property);
1897
1898/**
1899 * drm_connector_attach_tv_margin_properties - attach TV connector margin
1900 * properties
1901 * @connector: DRM connector
1902 *
1903 * Called by a driver when it needs to attach TV margin props to a connector.
1904 * Typically used on SDTV and HDMI connectors.
1905 */
1906void drm_connector_attach_tv_margin_properties(struct drm_connector *connector)
1907{
1908 struct drm_device *dev = connector->dev;
1909
1910 drm_object_attach_property(&connector->base,
1911 dev->mode_config.tv_left_margin_property,
1912 0);
1913 drm_object_attach_property(&connector->base,
1914 dev->mode_config.tv_right_margin_property,
1915 0);
1916 drm_object_attach_property(&connector->base,
1917 dev->mode_config.tv_top_margin_property,
1918 0);
1919 drm_object_attach_property(&connector->base,
1920 dev->mode_config.tv_bottom_margin_property,
1921 0);
1922}
1923EXPORT_SYMBOL(drm_connector_attach_tv_margin_properties);
1924
1925/**
1926 * drm_mode_create_tv_margin_properties - create TV connector margin properties
1927 * @dev: DRM device
1928 *
1929 * Called by a driver's HDMI connector initialization routine, this function
1930 * creates the TV margin properties for a given device. No need to call this
1931 * function for an SDTV connector, it's already called from
1932 * drm_mode_create_tv_properties_legacy().
1933 *
1934 * Returns:
1935 * 0 on success or a negative error code on failure.
1936 */
1937int drm_mode_create_tv_margin_properties(struct drm_device *dev)
1938{
1939 if (dev->mode_config.tv_left_margin_property)
1940 return 0;
1941
1942 dev->mode_config.tv_left_margin_property =
1943 drm_property_create_range(dev, 0, "left margin", 0, 100);
1944 if (!dev->mode_config.tv_left_margin_property)
1945 return -ENOMEM;
1946
1947 dev->mode_config.tv_right_margin_property =
1948 drm_property_create_range(dev, 0, "right margin", 0, 100);
1949 if (!dev->mode_config.tv_right_margin_property)
1950 return -ENOMEM;
1951
1952 dev->mode_config.tv_top_margin_property =
1953 drm_property_create_range(dev, 0, "top margin", 0, 100);
1954 if (!dev->mode_config.tv_top_margin_property)
1955 return -ENOMEM;
1956
1957 dev->mode_config.tv_bottom_margin_property =
1958 drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1959 if (!dev->mode_config.tv_bottom_margin_property)
1960 return -ENOMEM;
1961
1962 return 0;
1963}
1964EXPORT_SYMBOL(drm_mode_create_tv_margin_properties);
1965
1966/**
1967 * drm_mode_create_tv_properties_legacy - create TV specific connector properties
1968 * @dev: DRM device
1969 * @num_modes: number of different TV formats (modes) supported
1970 * @modes: array of pointers to strings containing name of each format
1971 *
1972 * Called by a driver's TV initialization routine, this function creates
1973 * the TV specific connector properties for a given device. Caller is
1974 * responsible for allocating a list of format names and passing them to
1975 * this routine.
1976 *
1977 * NOTE: This functions registers the deprecated "mode" connector
1978 * property to select the analog TV mode (ie, NTSC, PAL, etc.). New
1979 * drivers must use drm_mode_create_tv_properties() instead.
1980 *
1981 * Returns:
1982 * 0 on success or a negative error code on failure.
1983 */
1984int drm_mode_create_tv_properties_legacy(struct drm_device *dev,
1985 unsigned int num_modes,
1986 const char * const modes[])
1987{
1988 struct drm_property *tv_selector;
1989 struct drm_property *tv_subconnector;
1990 unsigned int i;
1991
1992 if (dev->mode_config.tv_select_subconnector_property)
1993 return 0;
1994
1995 /*
1996 * Basic connector properties
1997 */
1998 tv_selector = drm_property_create_enum(dev, 0,
1999 "select subconnector",
2000 drm_tv_select_enum_list,
2001 ARRAY_SIZE(drm_tv_select_enum_list));
2002 if (!tv_selector)
2003 goto nomem;
2004
2005 dev->mode_config.tv_select_subconnector_property = tv_selector;
2006
2007 tv_subconnector =
2008 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
2009 "subconnector",
2010 drm_tv_subconnector_enum_list,
2011 ARRAY_SIZE(drm_tv_subconnector_enum_list));
2012 if (!tv_subconnector)
2013 goto nomem;
2014 dev->mode_config.tv_subconnector_property = tv_subconnector;
2015
2016 /*
2017 * Other, TV specific properties: margins & TV modes.
2018 */
2019 if (drm_mode_create_tv_margin_properties(dev))
2020 goto nomem;
2021
2022 if (num_modes) {
2023 dev->mode_config.legacy_tv_mode_property =
2024 drm_property_create(dev, DRM_MODE_PROP_ENUM,
2025 "mode", num_modes);
2026 if (!dev->mode_config.legacy_tv_mode_property)
2027 goto nomem;
2028
2029 for (i = 0; i < num_modes; i++)
2030 drm_property_add_enum(dev->mode_config.legacy_tv_mode_property,
2031 i, modes[i]);
2032 }
2033
2034 dev->mode_config.tv_brightness_property =
2035 drm_property_create_range(dev, 0, "brightness", 0, 100);
2036 if (!dev->mode_config.tv_brightness_property)
2037 goto nomem;
2038
2039 dev->mode_config.tv_contrast_property =
2040 drm_property_create_range(dev, 0, "contrast", 0, 100);
2041 if (!dev->mode_config.tv_contrast_property)
2042 goto nomem;
2043
2044 dev->mode_config.tv_flicker_reduction_property =
2045 drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
2046 if (!dev->mode_config.tv_flicker_reduction_property)
2047 goto nomem;
2048
2049 dev->mode_config.tv_overscan_property =
2050 drm_property_create_range(dev, 0, "overscan", 0, 100);
2051 if (!dev->mode_config.tv_overscan_property)
2052 goto nomem;
2053
2054 dev->mode_config.tv_saturation_property =
2055 drm_property_create_range(dev, 0, "saturation", 0, 100);
2056 if (!dev->mode_config.tv_saturation_property)
2057 goto nomem;
2058
2059 dev->mode_config.tv_hue_property =
2060 drm_property_create_range(dev, 0, "hue", 0, 100);
2061 if (!dev->mode_config.tv_hue_property)
2062 goto nomem;
2063
2064 return 0;
2065nomem:
2066 return -ENOMEM;
2067}
2068EXPORT_SYMBOL(drm_mode_create_tv_properties_legacy);
2069
2070/**
2071 * drm_mode_create_tv_properties - create TV specific connector properties
2072 * @dev: DRM device
2073 * @supported_tv_modes: Bitmask of TV modes supported (See DRM_MODE_TV_MODE_*)
2074 *
2075 * Called by a driver's TV initialization routine, this function creates
2076 * the TV specific connector properties for a given device.
2077 *
2078 * Returns:
2079 * 0 on success or a negative error code on failure.
2080 */
2081int drm_mode_create_tv_properties(struct drm_device *dev,
2082 unsigned int supported_tv_modes)
2083{
2084 struct drm_prop_enum_list tv_mode_list[DRM_MODE_TV_MODE_MAX];
2085 struct drm_property *tv_mode;
2086 unsigned int i, len = 0;
2087
2088 if (dev->mode_config.tv_mode_property)
2089 return 0;
2090
2091 for (i = 0; i < DRM_MODE_TV_MODE_MAX; i++) {
2092 if (!(supported_tv_modes & BIT(i)))
2093 continue;
2094
2095 tv_mode_list[len].type = i;
2096 tv_mode_list[len].name = drm_get_tv_mode_name(i);
2097 len++;
2098 }
2099
2100 tv_mode = drm_property_create_enum(dev, 0, "TV mode",
2101 tv_mode_list, len);
2102 if (!tv_mode)
2103 return -ENOMEM;
2104
2105 dev->mode_config.tv_mode_property = tv_mode;
2106
2107 return drm_mode_create_tv_properties_legacy(dev, 0, NULL);
2108}
2109EXPORT_SYMBOL(drm_mode_create_tv_properties);
2110
2111/**
2112 * drm_mode_create_scaling_mode_property - create scaling mode property
2113 * @dev: DRM device
2114 *
2115 * Called by a driver the first time it's needed, must be attached to desired
2116 * connectors.
2117 *
2118 * Atomic drivers should use drm_connector_attach_scaling_mode_property()
2119 * instead to correctly assign &drm_connector_state.scaling_mode
2120 * in the atomic state.
2121 *
2122 * Returns: %0
2123 */
2124int drm_mode_create_scaling_mode_property(struct drm_device *dev)
2125{
2126 struct drm_property *scaling_mode;
2127
2128 if (dev->mode_config.scaling_mode_property)
2129 return 0;
2130
2131 scaling_mode =
2132 drm_property_create_enum(dev, 0, "scaling mode",
2133 drm_scaling_mode_enum_list,
2134 ARRAY_SIZE(drm_scaling_mode_enum_list));
2135
2136 dev->mode_config.scaling_mode_property = scaling_mode;
2137
2138 return 0;
2139}
2140EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
2141
2142/**
2143 * DOC: Variable refresh properties
2144 *
2145 * Variable refresh rate capable displays can dynamically adjust their
2146 * refresh rate by extending the duration of their vertical front porch
2147 * until page flip or timeout occurs. This can reduce or remove stuttering
2148 * and latency in scenarios where the page flip does not align with the
2149 * vblank interval.
2150 *
2151 * An example scenario would be an application flipping at a constant rate
2152 * of 48Hz on a 60Hz display. The page flip will frequently miss the vblank
2153 * interval and the same contents will be displayed twice. This can be
2154 * observed as stuttering for content with motion.
2155 *
2156 * If variable refresh rate was active on a display that supported a
2157 * variable refresh range from 35Hz to 60Hz no stuttering would be observable
2158 * for the example scenario. The minimum supported variable refresh rate of
2159 * 35Hz is below the page flip frequency and the vertical front porch can
2160 * be extended until the page flip occurs. The vblank interval will be
2161 * directly aligned to the page flip rate.
2162 *
2163 * Not all userspace content is suitable for use with variable refresh rate.
2164 * Large and frequent changes in vertical front porch duration may worsen
2165 * perceived stuttering for input sensitive applications.
2166 *
2167 * Panel brightness will also vary with vertical front porch duration. Some
2168 * panels may have noticeable differences in brightness between the minimum
2169 * vertical front porch duration and the maximum vertical front porch duration.
2170 * Large and frequent changes in vertical front porch duration may produce
2171 * observable flickering for such panels.
2172 *
2173 * Userspace control for variable refresh rate is supported via properties
2174 * on the &drm_connector and &drm_crtc objects.
2175 *
2176 * "vrr_capable":
2177 * Optional &drm_connector boolean property that drivers should attach
2178 * with drm_connector_attach_vrr_capable_property() on connectors that
2179 * could support variable refresh rates. Drivers should update the
2180 * property value by calling drm_connector_set_vrr_capable_property().
2181 *
2182 * Absence of the property should indicate absence of support.
2183 *
2184 * "VRR_ENABLED":
2185 * Default &drm_crtc boolean property that notifies the driver that the
2186 * content on the CRTC is suitable for variable refresh rate presentation.
2187 * The driver will take this property as a hint to enable variable
2188 * refresh rate support if the receiver supports it, ie. if the
2189 * "vrr_capable" property is true on the &drm_connector object. The
2190 * vertical front porch duration will be extended until page-flip or
2191 * timeout when enabled.
2192 *
2193 * The minimum vertical front porch duration is defined as the vertical
2194 * front porch duration for the current mode.
2195 *
2196 * The maximum vertical front porch duration is greater than or equal to
2197 * the minimum vertical front porch duration. The duration is derived
2198 * from the minimum supported variable refresh rate for the connector.
2199 *
2200 * The driver may place further restrictions within these minimum
2201 * and maximum bounds.
2202 */
2203
2204/**
2205 * drm_connector_attach_vrr_capable_property - creates the
2206 * vrr_capable property
2207 * @connector: connector to create the vrr_capable property on.
2208 *
2209 * This is used by atomic drivers to add support for querying
2210 * variable refresh rate capability for a connector.
2211 *
2212 * Returns:
2213 * Zero on success, negative errno on failure.
2214 */
2215int drm_connector_attach_vrr_capable_property(
2216 struct drm_connector *connector)
2217{
2218 struct drm_device *dev = connector->dev;
2219 struct drm_property *prop;
2220
2221 if (!connector->vrr_capable_property) {
2222 prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE,
2223 "vrr_capable");
2224 if (!prop)
2225 return -ENOMEM;
2226
2227 connector->vrr_capable_property = prop;
2228 drm_object_attach_property(&connector->base, prop, 0);
2229 }
2230
2231 return 0;
2232}
2233EXPORT_SYMBOL(drm_connector_attach_vrr_capable_property);
2234
2235/**
2236 * drm_connector_attach_scaling_mode_property - attach atomic scaling mode property
2237 * @connector: connector to attach scaling mode property on.
2238 * @scaling_mode_mask: or'ed mask of BIT(%DRM_MODE_SCALE_\*).
2239 *
2240 * This is used to add support for scaling mode to atomic drivers.
2241 * The scaling mode will be set to &drm_connector_state.scaling_mode
2242 * and can be used from &drm_connector_helper_funcs->atomic_check for validation.
2243 *
2244 * This is the atomic version of drm_mode_create_scaling_mode_property().
2245 *
2246 * Returns:
2247 * Zero on success, negative errno on failure.
2248 */
2249int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
2250 u32 scaling_mode_mask)
2251{
2252 struct drm_device *dev = connector->dev;
2253 struct drm_property *scaling_mode_property;
2254 int i;
2255 const unsigned valid_scaling_mode_mask =
2256 (1U << ARRAY_SIZE(drm_scaling_mode_enum_list)) - 1;
2257
2258 if (WARN_ON(hweight32(scaling_mode_mask) < 2 ||
2259 scaling_mode_mask & ~valid_scaling_mode_mask))
2260 return -EINVAL;
2261
2262 scaling_mode_property =
2263 drm_property_create(dev, DRM_MODE_PROP_ENUM, "scaling mode",
2264 hweight32(scaling_mode_mask));
2265
2266 if (!scaling_mode_property)
2267 return -ENOMEM;
2268
2269 for (i = 0; i < ARRAY_SIZE(drm_scaling_mode_enum_list); i++) {
2270 int ret;
2271
2272 if (!(BIT(i) & scaling_mode_mask))
2273 continue;
2274
2275 ret = drm_property_add_enum(scaling_mode_property,
2276 drm_scaling_mode_enum_list[i].type,
2277 drm_scaling_mode_enum_list[i].name);
2278
2279 if (ret) {
2280 drm_property_destroy(dev, scaling_mode_property);
2281
2282 return ret;
2283 }
2284 }
2285
2286 drm_object_attach_property(&connector->base,
2287 scaling_mode_property, 0);
2288
2289 connector->scaling_mode_property = scaling_mode_property;
2290
2291 return 0;
2292}
2293EXPORT_SYMBOL(drm_connector_attach_scaling_mode_property);
2294
2295/**
2296 * drm_mode_create_aspect_ratio_property - create aspect ratio property
2297 * @dev: DRM device
2298 *
2299 * Called by a driver the first time it's needed, must be attached to desired
2300 * connectors.
2301 *
2302 * Returns:
2303 * Zero on success, negative errno on failure.
2304 */
2305int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
2306{
2307 if (dev->mode_config.aspect_ratio_property)
2308 return 0;
2309
2310 dev->mode_config.aspect_ratio_property =
2311 drm_property_create_enum(dev, 0, "aspect ratio",
2312 drm_aspect_ratio_enum_list,
2313 ARRAY_SIZE(drm_aspect_ratio_enum_list));
2314
2315 if (dev->mode_config.aspect_ratio_property == NULL)
2316 return -ENOMEM;
2317
2318 return 0;
2319}
2320EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
2321
2322/**
2323 * DOC: standard connector properties
2324 *
2325 * Colorspace:
2326 * This property is used to inform the driver about the color encoding
2327 * user space configured the pixel operation properties to produce.
2328 * The variants set the colorimetry, transfer characteristics, and which
2329 * YCbCr conversion should be used when necessary.
2330 * The transfer characteristics from HDR_OUTPUT_METADATA takes precedence
2331 * over this property.
2332 * User space always configures the pixel operation properties to produce
2333 * full quantization range data (see the Broadcast RGB property).
2334 *
2335 * Drivers inform the sink about what colorimetry, transfer
2336 * characteristics, YCbCr conversion, and quantization range to expect
2337 * (this can depend on the output mode, output format and other
2338 * properties). Drivers also convert the user space provided data to what
2339 * the sink expects.
2340 *
2341 * User space has to check if the sink supports all of the possible
2342 * colorimetries that the driver is allowed to pick by parsing the EDID.
2343 *
2344 * For historical reasons this property exposes a number of variants which
2345 * result in undefined behavior.
2346 *
2347 * Default:
2348 * The behavior is driver-specific.
2349 *
2350 * BT2020_RGB:
2351 *
2352 * BT2020_YCC:
2353 * User space configures the pixel operation properties to produce
2354 * RGB content with Rec. ITU-R BT.2020 colorimetry, Rec.
2355 * ITU-R BT.2020 (Table 4, RGB) transfer characteristics and full
2356 * quantization range.
2357 * User space can use the HDR_OUTPUT_METADATA property to set the
2358 * transfer characteristics to PQ (Rec. ITU-R BT.2100 Table 4) or
2359 * HLG (Rec. ITU-R BT.2100 Table 5) in which case, user space
2360 * configures pixel operation properties to produce content with
2361 * the respective transfer characteristics.
2362 * User space has to make sure the sink supports Rec.
2363 * ITU-R BT.2020 R'G'B' and Rec. ITU-R BT.2020 Y'C'BC'R
2364 * colorimetry.
2365 * Drivers can configure the sink to use an RGB format, tell the
2366 * sink to expect Rec. ITU-R BT.2020 R'G'B' colorimetry and convert
2367 * to the appropriate quantization range.
2368 * Drivers can configure the sink to use a YCbCr format, tell the
2369 * sink to expect Rec. ITU-R BT.2020 Y'C'BC'R colorimetry, convert
2370 * to YCbCr using the Rec. ITU-R BT.2020 non-constant luminance
2371 * conversion matrix and convert to the appropriate quantization
2372 * range.
2373 * The variants BT2020_RGB and BT2020_YCC are equivalent and the
2374 * driver chooses between RGB and YCbCr on its own.
2375 *
2376 * SMPTE_170M_YCC:
2377 * BT709_YCC:
2378 * XVYCC_601:
2379 * XVYCC_709:
2380 * SYCC_601:
2381 * opYCC_601:
2382 * opRGB:
2383 * BT2020_CYCC:
2384 * DCI-P3_RGB_D65:
2385 * DCI-P3_RGB_Theater:
2386 * RGB_WIDE_FIXED:
2387 * RGB_WIDE_FLOAT:
2388 *
2389 * BT601_YCC:
2390 * The behavior is undefined.
2391 *
2392 * Because between HDMI and DP have different colorspaces,
2393 * drm_mode_create_hdmi_colorspace_property() is used for HDMI connector and
2394 * drm_mode_create_dp_colorspace_property() is used for DP connector.
2395 */
2396
2397static int drm_mode_create_colorspace_property(struct drm_connector *connector,
2398 u32 supported_colorspaces)
2399{
2400 struct drm_device *dev = connector->dev;
2401 u32 colorspaces = supported_colorspaces | BIT(DRM_MODE_COLORIMETRY_DEFAULT);
2402 struct drm_prop_enum_list enum_list[DRM_MODE_COLORIMETRY_COUNT];
2403 int i, len;
2404
2405 if (connector->colorspace_property)
2406 return 0;
2407
2408 if (!supported_colorspaces) {
2409 drm_err(dev, "No supported colorspaces provded on [CONNECTOR:%d:%s]\n",
2410 connector->base.id, connector->name);
2411 return -EINVAL;
2412 }
2413
2414 if ((supported_colorspaces & -BIT(DRM_MODE_COLORIMETRY_COUNT)) != 0) {
2415 drm_err(dev, "Unknown colorspace provded on [CONNECTOR:%d:%s]\n",
2416 connector->base.id, connector->name);
2417 return -EINVAL;
2418 }
2419
2420 len = 0;
2421 for (i = 0; i < DRM_MODE_COLORIMETRY_COUNT; i++) {
2422 if ((colorspaces & BIT(i)) == 0)
2423 continue;
2424
2425 enum_list[len].type = i;
2426 enum_list[len].name = colorspace_names[i];
2427 len++;
2428 }
2429
2430 connector->colorspace_property =
2431 drm_property_create_enum(dev, DRM_MODE_PROP_ENUM, "Colorspace",
2432 enum_list,
2433 len);
2434
2435 if (!connector->colorspace_property)
2436 return -ENOMEM;
2437
2438 return 0;
2439}
2440
2441/**
2442 * drm_mode_create_hdmi_colorspace_property - create hdmi colorspace property
2443 * @connector: connector to create the Colorspace property on.
2444 * @supported_colorspaces: bitmap of supported color spaces
2445 *
2446 * Called by a driver the first time it's needed, must be attached to desired
2447 * HDMI connectors.
2448 *
2449 * Returns:
2450 * Zero on success, negative errno on failure.
2451 */
2452int drm_mode_create_hdmi_colorspace_property(struct drm_connector *connector,
2453 u32 supported_colorspaces)
2454{
2455 u32 colorspaces;
2456
2457 if (supported_colorspaces)
2458 colorspaces = supported_colorspaces & hdmi_colorspaces;
2459 else
2460 colorspaces = hdmi_colorspaces;
2461
2462 return drm_mode_create_colorspace_property(connector, colorspaces);
2463}
2464EXPORT_SYMBOL(drm_mode_create_hdmi_colorspace_property);
2465
2466/**
2467 * drm_mode_create_dp_colorspace_property - create dp colorspace property
2468 * @connector: connector to create the Colorspace property on.
2469 * @supported_colorspaces: bitmap of supported color spaces
2470 *
2471 * Called by a driver the first time it's needed, must be attached to desired
2472 * DP connectors.
2473 *
2474 * Returns:
2475 * Zero on success, negative errno on failure.
2476 */
2477int drm_mode_create_dp_colorspace_property(struct drm_connector *connector,
2478 u32 supported_colorspaces)
2479{
2480 u32 colorspaces;
2481
2482 if (supported_colorspaces)
2483 colorspaces = supported_colorspaces & dp_colorspaces;
2484 else
2485 colorspaces = dp_colorspaces;
2486
2487 return drm_mode_create_colorspace_property(connector, colorspaces);
2488}
2489EXPORT_SYMBOL(drm_mode_create_dp_colorspace_property);
2490
2491/**
2492 * drm_mode_create_content_type_property - create content type property
2493 * @dev: DRM device
2494 *
2495 * Called by a driver the first time it's needed, must be attached to desired
2496 * connectors.
2497 *
2498 * Returns:
2499 * Zero on success, negative errno on failure.
2500 */
2501int drm_mode_create_content_type_property(struct drm_device *dev)
2502{
2503 if (dev->mode_config.content_type_property)
2504 return 0;
2505
2506 dev->mode_config.content_type_property =
2507 drm_property_create_enum(dev, 0, "content type",
2508 drm_content_type_enum_list,
2509 ARRAY_SIZE(drm_content_type_enum_list));
2510
2511 if (dev->mode_config.content_type_property == NULL)
2512 return -ENOMEM;
2513
2514 return 0;
2515}
2516EXPORT_SYMBOL(drm_mode_create_content_type_property);
2517
2518/**
2519 * drm_mode_create_suggested_offset_properties - create suggests offset properties
2520 * @dev: DRM device
2521 *
2522 * Create the suggested x/y offset property for connectors.
2523 *
2524 * Returns:
2525 * 0 on success or a negative error code on failure.
2526 */
2527int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
2528{
2529 if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
2530 return 0;
2531
2532 dev->mode_config.suggested_x_property =
2533 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
2534
2535 dev->mode_config.suggested_y_property =
2536 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
2537
2538 if (dev->mode_config.suggested_x_property == NULL ||
2539 dev->mode_config.suggested_y_property == NULL)
2540 return -ENOMEM;
2541 return 0;
2542}
2543EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
2544
2545/**
2546 * drm_connector_set_path_property - set tile property on connector
2547 * @connector: connector to set property on.
2548 * @path: path to use for property; must not be NULL.
2549 *
2550 * This creates a property to expose to userspace to specify a
2551 * connector path. This is mainly used for DisplayPort MST where
2552 * connectors have a topology and we want to allow userspace to give
2553 * them more meaningful names.
2554 *
2555 * Returns:
2556 * Zero on success, negative errno on failure.
2557 */
2558int drm_connector_set_path_property(struct drm_connector *connector,
2559 const char *path)
2560{
2561 struct drm_device *dev = connector->dev;
2562 int ret;
2563
2564 ret = drm_property_replace_global_blob(dev,
2565 &connector->path_blob_ptr,
2566 strlen(path) + 1,
2567 path,
2568 &connector->base,
2569 dev->mode_config.path_property);
2570 return ret;
2571}
2572EXPORT_SYMBOL(drm_connector_set_path_property);
2573
2574/**
2575 * drm_connector_set_tile_property - set tile property on connector
2576 * @connector: connector to set property on.
2577 *
2578 * This looks up the tile information for a connector, and creates a
2579 * property for userspace to parse if it exists. The property is of
2580 * the form of 8 integers using ':' as a separator.
2581 * This is used for dual port tiled displays with DisplayPort SST
2582 * or DisplayPort MST connectors.
2583 *
2584 * Returns:
2585 * Zero on success, errno on failure.
2586 */
2587int drm_connector_set_tile_property(struct drm_connector *connector)
2588{
2589 struct drm_device *dev = connector->dev;
2590 char tile[256];
2591 int ret;
2592
2593 if (!connector->has_tile) {
2594 ret = drm_property_replace_global_blob(dev,
2595 &connector->tile_blob_ptr,
2596 0,
2597 NULL,
2598 &connector->base,
2599 dev->mode_config.tile_property);
2600 return ret;
2601 }
2602
2603 snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
2604 connector->tile_group->id, connector->tile_is_single_monitor,
2605 connector->num_h_tile, connector->num_v_tile,
2606 connector->tile_h_loc, connector->tile_v_loc,
2607 connector->tile_h_size, connector->tile_v_size);
2608
2609 ret = drm_property_replace_global_blob(dev,
2610 &connector->tile_blob_ptr,
2611 strlen(tile) + 1,
2612 tile,
2613 &connector->base,
2614 dev->mode_config.tile_property);
2615 return ret;
2616}
2617EXPORT_SYMBOL(drm_connector_set_tile_property);
2618
2619/**
2620 * drm_connector_set_link_status_property - Set link status property of a connector
2621 * @connector: drm connector
2622 * @link_status: new value of link status property (0: Good, 1: Bad)
2623 *
2624 * In usual working scenario, this link status property will always be set to
2625 * "GOOD". If something fails during or after a mode set, the kernel driver
2626 * may set this link status property to "BAD". The caller then needs to send a
2627 * hotplug uevent for userspace to re-check the valid modes through
2628 * GET_CONNECTOR_IOCTL and retry modeset.
2629 *
2630 * Note: Drivers cannot rely on userspace to support this property and
2631 * issue a modeset. As such, they may choose to handle issues (like
2632 * re-training a link) without userspace's intervention.
2633 *
2634 * The reason for adding this property is to handle link training failures, but
2635 * it is not limited to DP or link training. For example, if we implement
2636 * asynchronous setcrtc, this property can be used to report any failures in that.
2637 */
2638void drm_connector_set_link_status_property(struct drm_connector *connector,
2639 uint64_t link_status)
2640{
2641 struct drm_device *dev = connector->dev;
2642
2643 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2644 connector->state->link_status = link_status;
2645 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2646}
2647EXPORT_SYMBOL(drm_connector_set_link_status_property);
2648
2649/**
2650 * drm_connector_attach_max_bpc_property - attach "max bpc" property
2651 * @connector: connector to attach max bpc property on.
2652 * @min: The minimum bit depth supported by the connector.
2653 * @max: The maximum bit depth supported by the connector.
2654 *
2655 * This is used to add support for limiting the bit depth on a connector.
2656 *
2657 * Returns:
2658 * Zero on success, negative errno on failure.
2659 */
2660int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
2661 int min, int max)
2662{
2663 struct drm_device *dev = connector->dev;
2664 struct drm_property *prop;
2665
2666 prop = connector->max_bpc_property;
2667 if (!prop) {
2668 prop = drm_property_create_range(dev, 0, "max bpc", min, max);
2669 if (!prop)
2670 return -ENOMEM;
2671
2672 connector->max_bpc_property = prop;
2673 }
2674
2675 drm_object_attach_property(&connector->base, prop, max);
2676 connector->state->max_requested_bpc = max;
2677 connector->state->max_bpc = max;
2678
2679 return 0;
2680}
2681EXPORT_SYMBOL(drm_connector_attach_max_bpc_property);
2682
2683/**
2684 * drm_connector_attach_hdr_output_metadata_property - attach "HDR_OUTPUT_METADA" property
2685 * @connector: connector to attach the property on.
2686 *
2687 * This is used to allow the userspace to send HDR Metadata to the
2688 * driver.
2689 *
2690 * Returns:
2691 * Zero on success, negative errno on failure.
2692 */
2693int drm_connector_attach_hdr_output_metadata_property(struct drm_connector *connector)
2694{
2695 struct drm_device *dev = connector->dev;
2696 struct drm_property *prop = dev->mode_config.hdr_output_metadata_property;
2697
2698 drm_object_attach_property(&connector->base, prop, 0);
2699
2700 return 0;
2701}
2702EXPORT_SYMBOL(drm_connector_attach_hdr_output_metadata_property);
2703
2704/**
2705 * drm_connector_attach_broadcast_rgb_property - attach "Broadcast RGB" property
2706 * @connector: connector to attach the property on.
2707 *
2708 * This is used to add support for forcing the RGB range on a connector
2709 *
2710 * Returns:
2711 * Zero on success, negative errno on failure.
2712 */
2713int drm_connector_attach_broadcast_rgb_property(struct drm_connector *connector)
2714{
2715 struct drm_device *dev = connector->dev;
2716 struct drm_property *prop;
2717
2718 prop = connector->broadcast_rgb_property;
2719 if (!prop) {
2720 prop = drm_property_create_enum(dev, DRM_MODE_PROP_ENUM,
2721 "Broadcast RGB",
2722 broadcast_rgb_names,
2723 ARRAY_SIZE(broadcast_rgb_names));
2724 if (!prop)
2725 return -EINVAL;
2726
2727 connector->broadcast_rgb_property = prop;
2728 }
2729
2730 drm_object_attach_property(&connector->base, prop,
2731 DRM_HDMI_BROADCAST_RGB_AUTO);
2732
2733 return 0;
2734}
2735EXPORT_SYMBOL(drm_connector_attach_broadcast_rgb_property);
2736
2737/**
2738 * drm_connector_attach_colorspace_property - attach "Colorspace" property
2739 * @connector: connector to attach the property on.
2740 *
2741 * This is used to allow the userspace to signal the output colorspace
2742 * to the driver.
2743 *
2744 * Returns:
2745 * Zero on success, negative errno on failure.
2746 */
2747int drm_connector_attach_colorspace_property(struct drm_connector *connector)
2748{
2749 struct drm_property *prop = connector->colorspace_property;
2750
2751 drm_object_attach_property(&connector->base, prop, DRM_MODE_COLORIMETRY_DEFAULT);
2752
2753 return 0;
2754}
2755EXPORT_SYMBOL(drm_connector_attach_colorspace_property);
2756
2757/**
2758 * drm_connector_atomic_hdr_metadata_equal - checks if the hdr metadata changed
2759 * @old_state: old connector state to compare
2760 * @new_state: new connector state to compare
2761 *
2762 * This is used by HDR-enabled drivers to test whether the HDR metadata
2763 * have changed between two different connector state (and thus probably
2764 * requires a full blown mode change).
2765 *
2766 * Returns:
2767 * True if the metadata are equal, False otherwise
2768 */
2769bool drm_connector_atomic_hdr_metadata_equal(struct drm_connector_state *old_state,
2770 struct drm_connector_state *new_state)
2771{
2772 struct drm_property_blob *old_blob = old_state->hdr_output_metadata;
2773 struct drm_property_blob *new_blob = new_state->hdr_output_metadata;
2774
2775 if (!old_blob || !new_blob)
2776 return old_blob == new_blob;
2777
2778 if (old_blob->length != new_blob->length)
2779 return false;
2780
2781 return !memcmp(old_blob->data, new_blob->data, old_blob->length);
2782}
2783EXPORT_SYMBOL(drm_connector_atomic_hdr_metadata_equal);
2784
2785/**
2786 * drm_connector_set_vrr_capable_property - sets the variable refresh rate
2787 * capable property for a connector
2788 * @connector: drm connector
2789 * @capable: True if the connector is variable refresh rate capable
2790 *
2791 * Should be used by atomic drivers to update the indicated support for
2792 * variable refresh rate over a connector.
2793 */
2794void drm_connector_set_vrr_capable_property(
2795 struct drm_connector *connector, bool capable)
2796{
2797 if (!connector->vrr_capable_property)
2798 return;
2799
2800 drm_object_property_set_value(&connector->base,
2801 connector->vrr_capable_property,
2802 capable);
2803}
2804EXPORT_SYMBOL(drm_connector_set_vrr_capable_property);
2805
2806/**
2807 * drm_connector_set_panel_orientation - sets the connector's panel_orientation
2808 * @connector: connector for which to set the panel-orientation property.
2809 * @panel_orientation: drm_panel_orientation value to set
2810 *
2811 * This function sets the connector's panel_orientation and attaches
2812 * a "panel orientation" property to the connector.
2813 *
2814 * Calling this function on a connector where the panel_orientation has
2815 * already been set is a no-op (e.g. the orientation has been overridden with
2816 * a kernel commandline option).
2817 *
2818 * It is allowed to call this function with a panel_orientation of
2819 * DRM_MODE_PANEL_ORIENTATION_UNKNOWN, in which case it is a no-op.
2820 *
2821 * The function shouldn't be called in panel after drm is registered (i.e.
2822 * drm_dev_register() is called in drm).
2823 *
2824 * Returns:
2825 * Zero on success, negative errno on failure.
2826 */
2827int drm_connector_set_panel_orientation(
2828 struct drm_connector *connector,
2829 enum drm_panel_orientation panel_orientation)
2830{
2831 struct drm_device *dev = connector->dev;
2832 struct drm_display_info *info = &connector->display_info;
2833 struct drm_property *prop;
2834
2835 /* Already set? */
2836 if (info->panel_orientation != DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2837 return 0;
2838
2839 /* Don't attach the property if the orientation is unknown */
2840 if (panel_orientation == DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2841 return 0;
2842
2843 info->panel_orientation = panel_orientation;
2844
2845 prop = dev->mode_config.panel_orientation_property;
2846 if (!prop) {
2847 prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
2848 "panel orientation",
2849 drm_panel_orientation_enum_list,
2850 ARRAY_SIZE(drm_panel_orientation_enum_list));
2851 if (!prop)
2852 return -ENOMEM;
2853
2854 dev->mode_config.panel_orientation_property = prop;
2855 }
2856
2857 drm_object_attach_property(&connector->base, prop,
2858 info->panel_orientation);
2859 return 0;
2860}
2861EXPORT_SYMBOL(drm_connector_set_panel_orientation);
2862
2863/**
2864 * drm_connector_set_panel_orientation_with_quirk - set the
2865 * connector's panel_orientation after checking for quirks
2866 * @connector: connector for which to init the panel-orientation property.
2867 * @panel_orientation: drm_panel_orientation value to set
2868 * @width: width in pixels of the panel, used for panel quirk detection
2869 * @height: height in pixels of the panel, used for panel quirk detection
2870 *
2871 * Like drm_connector_set_panel_orientation(), but with a check for platform
2872 * specific (e.g. DMI based) quirks overriding the passed in panel_orientation.
2873 *
2874 * Returns:
2875 * Zero on success, negative errno on failure.
2876 */
2877int drm_connector_set_panel_orientation_with_quirk(
2878 struct drm_connector *connector,
2879 enum drm_panel_orientation panel_orientation,
2880 int width, int height)
2881{
2882 int orientation_quirk;
2883
2884 orientation_quirk = drm_get_panel_orientation_quirk(width, height);
2885 if (orientation_quirk != DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2886 panel_orientation = orientation_quirk;
2887
2888 return drm_connector_set_panel_orientation(connector,
2889 panel_orientation);
2890}
2891EXPORT_SYMBOL(drm_connector_set_panel_orientation_with_quirk);
2892
2893/**
2894 * drm_connector_set_orientation_from_panel -
2895 * set the connector's panel_orientation from panel's callback.
2896 * @connector: connector for which to init the panel-orientation property.
2897 * @panel: panel that can provide orientation information.
2898 *
2899 * Drm drivers should call this function before drm_dev_register().
2900 * Orientation is obtained from panel's .get_orientation() callback.
2901 *
2902 * Returns:
2903 * Zero on success, negative errno on failure.
2904 */
2905int drm_connector_set_orientation_from_panel(
2906 struct drm_connector *connector,
2907 struct drm_panel *panel)
2908{
2909 enum drm_panel_orientation orientation;
2910
2911 if (panel && panel->funcs && panel->funcs->get_orientation)
2912 orientation = panel->funcs->get_orientation(panel);
2913 else
2914 orientation = DRM_MODE_PANEL_ORIENTATION_UNKNOWN;
2915
2916 return drm_connector_set_panel_orientation(connector, orientation);
2917}
2918EXPORT_SYMBOL(drm_connector_set_orientation_from_panel);
2919
2920static const struct drm_prop_enum_list privacy_screen_enum[] = {
2921 { PRIVACY_SCREEN_DISABLED, "Disabled" },
2922 { PRIVACY_SCREEN_ENABLED, "Enabled" },
2923 { PRIVACY_SCREEN_DISABLED_LOCKED, "Disabled-locked" },
2924 { PRIVACY_SCREEN_ENABLED_LOCKED, "Enabled-locked" },
2925};
2926
2927/**
2928 * drm_connector_create_privacy_screen_properties - create the drm connecter's
2929 * privacy-screen properties.
2930 * @connector: connector for which to create the privacy-screen properties
2931 *
2932 * This function creates the "privacy-screen sw-state" and "privacy-screen
2933 * hw-state" properties for the connector. They are not attached.
2934 */
2935void
2936drm_connector_create_privacy_screen_properties(struct drm_connector *connector)
2937{
2938 if (connector->privacy_screen_sw_state_property)
2939 return;
2940
2941 /* Note sw-state only supports the first 2 values of the enum */
2942 connector->privacy_screen_sw_state_property =
2943 drm_property_create_enum(connector->dev, DRM_MODE_PROP_ENUM,
2944 "privacy-screen sw-state",
2945 privacy_screen_enum, 2);
2946
2947 connector->privacy_screen_hw_state_property =
2948 drm_property_create_enum(connector->dev,
2949 DRM_MODE_PROP_IMMUTABLE | DRM_MODE_PROP_ENUM,
2950 "privacy-screen hw-state",
2951 privacy_screen_enum,
2952 ARRAY_SIZE(privacy_screen_enum));
2953}
2954EXPORT_SYMBOL(drm_connector_create_privacy_screen_properties);
2955
2956/**
2957 * drm_connector_attach_privacy_screen_properties - attach the drm connecter's
2958 * privacy-screen properties.
2959 * @connector: connector on which to attach the privacy-screen properties
2960 *
2961 * This function attaches the "privacy-screen sw-state" and "privacy-screen
2962 * hw-state" properties to the connector. The initial state of both is set
2963 * to "Disabled".
2964 */
2965void
2966drm_connector_attach_privacy_screen_properties(struct drm_connector *connector)
2967{
2968 if (!connector->privacy_screen_sw_state_property)
2969 return;
2970
2971 drm_object_attach_property(&connector->base,
2972 connector->privacy_screen_sw_state_property,
2973 PRIVACY_SCREEN_DISABLED);
2974
2975 drm_object_attach_property(&connector->base,
2976 connector->privacy_screen_hw_state_property,
2977 PRIVACY_SCREEN_DISABLED);
2978}
2979EXPORT_SYMBOL(drm_connector_attach_privacy_screen_properties);
2980
2981static void drm_connector_update_privacy_screen_properties(
2982 struct drm_connector *connector, bool set_sw_state)
2983{
2984 enum drm_privacy_screen_status sw_state, hw_state;
2985
2986 drm_privacy_screen_get_state(connector->privacy_screen,
2987 &sw_state, &hw_state);
2988
2989 if (set_sw_state)
2990 connector->state->privacy_screen_sw_state = sw_state;
2991 drm_object_property_set_value(&connector->base,
2992 connector->privacy_screen_hw_state_property, hw_state);
2993}
2994
2995static int drm_connector_privacy_screen_notifier(
2996 struct notifier_block *nb, unsigned long action, void *data)
2997{
2998 struct drm_connector *connector =
2999 container_of(nb, struct drm_connector, privacy_screen_notifier);
3000 struct drm_device *dev = connector->dev;
3001
3002 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
3003 drm_connector_update_privacy_screen_properties(connector, true);
3004 drm_modeset_unlock(&dev->mode_config.connection_mutex);
3005
3006 drm_sysfs_connector_property_event(connector,
3007 connector->privacy_screen_sw_state_property);
3008 drm_sysfs_connector_property_event(connector,
3009 connector->privacy_screen_hw_state_property);
3010
3011 return NOTIFY_DONE;
3012}
3013
3014/**
3015 * drm_connector_attach_privacy_screen_provider - attach a privacy-screen to
3016 * the connector
3017 * @connector: connector to attach the privacy-screen to
3018 * @priv: drm_privacy_screen to attach
3019 *
3020 * Create and attach the standard privacy-screen properties and register
3021 * a generic notifier for generating sysfs-connector-status-events
3022 * on external changes to the privacy-screen status.
3023 * This function takes ownership of the passed in drm_privacy_screen and will
3024 * call drm_privacy_screen_put() on it when the connector is destroyed.
3025 */
3026void drm_connector_attach_privacy_screen_provider(
3027 struct drm_connector *connector, struct drm_privacy_screen *priv)
3028{
3029 connector->privacy_screen = priv;
3030 connector->privacy_screen_notifier.notifier_call =
3031 drm_connector_privacy_screen_notifier;
3032
3033 drm_connector_create_privacy_screen_properties(connector);
3034 drm_connector_update_privacy_screen_properties(connector, true);
3035 drm_connector_attach_privacy_screen_properties(connector);
3036}
3037EXPORT_SYMBOL(drm_connector_attach_privacy_screen_provider);
3038
3039/**
3040 * drm_connector_update_privacy_screen - update connector's privacy-screen sw-state
3041 * @connector_state: connector-state to update the privacy-screen for
3042 *
3043 * This function calls drm_privacy_screen_set_sw_state() on the connector's
3044 * privacy-screen.
3045 *
3046 * If the connector has no privacy-screen, then this is a no-op.
3047 */
3048void drm_connector_update_privacy_screen(const struct drm_connector_state *connector_state)
3049{
3050 struct drm_connector *connector = connector_state->connector;
3051 int ret;
3052
3053 if (!connector->privacy_screen)
3054 return;
3055
3056 ret = drm_privacy_screen_set_sw_state(connector->privacy_screen,
3057 connector_state->privacy_screen_sw_state);
3058 if (ret) {
3059 drm_err(connector->dev, "Error updating privacy-screen sw_state\n");
3060 return;
3061 }
3062
3063 /* The hw_state property value may have changed, update it. */
3064 drm_connector_update_privacy_screen_properties(connector, false);
3065}
3066EXPORT_SYMBOL(drm_connector_update_privacy_screen);
3067
3068int drm_connector_set_obj_prop(struct drm_mode_object *obj,
3069 struct drm_property *property,
3070 uint64_t value)
3071{
3072 int ret = -EINVAL;
3073 struct drm_connector *connector = obj_to_connector(obj);
3074
3075 /* Do DPMS ourselves */
3076 if (property == connector->dev->mode_config.dpms_property) {
3077 ret = (*connector->funcs->dpms)(connector, (int)value);
3078 } else if (connector->funcs->set_property)
3079 ret = connector->funcs->set_property(connector, property, value);
3080
3081 if (!ret)
3082 drm_object_property_set_value(&connector->base, property, value);
3083 return ret;
3084}
3085
3086int drm_connector_property_set_ioctl(struct drm_device *dev,
3087 void *data, struct drm_file *file_priv)
3088{
3089 struct drm_mode_connector_set_property *conn_set_prop = data;
3090 struct drm_mode_obj_set_property obj_set_prop = {
3091 .value = conn_set_prop->value,
3092 .prop_id = conn_set_prop->prop_id,
3093 .obj_id = conn_set_prop->connector_id,
3094 .obj_type = DRM_MODE_OBJECT_CONNECTOR
3095 };
3096
3097 /* It does all the locking and checking we need */
3098 return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
3099}
3100
3101static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
3102{
3103 /* For atomic drivers only state objects are synchronously updated and
3104 * protected by modeset locks, so check those first.
3105 */
3106 if (connector->state)
3107 return connector->state->best_encoder;
3108 return connector->encoder;
3109}
3110
3111static bool
3112drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
3113 const struct list_head *modes,
3114 const struct drm_file *file_priv)
3115{
3116 /*
3117 * If user-space hasn't configured the driver to expose the stereo 3D
3118 * modes, don't expose them.
3119 */
3120 if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
3121 return false;
3122 /*
3123 * If user-space hasn't configured the driver to expose the modes
3124 * with aspect-ratio, don't expose them. However if such a mode
3125 * is unique, let it be exposed, but reset the aspect-ratio flags
3126 * while preparing the list of user-modes.
3127 */
3128 if (!file_priv->aspect_ratio_allowed) {
3129 const struct drm_display_mode *mode_itr;
3130
3131 list_for_each_entry(mode_itr, modes, head) {
3132 if (mode_itr->expose_to_userspace &&
3133 drm_mode_match(mode_itr, mode,
3134 DRM_MODE_MATCH_TIMINGS |
3135 DRM_MODE_MATCH_CLOCK |
3136 DRM_MODE_MATCH_FLAGS |
3137 DRM_MODE_MATCH_3D_FLAGS))
3138 return false;
3139 }
3140 }
3141
3142 return true;
3143}
3144
3145int drm_mode_getconnector(struct drm_device *dev, void *data,
3146 struct drm_file *file_priv)
3147{
3148 struct drm_mode_get_connector *out_resp = data;
3149 struct drm_connector *connector;
3150 struct drm_encoder *encoder;
3151 struct drm_display_mode *mode;
3152 int mode_count = 0;
3153 int encoders_count = 0;
3154 int ret = 0;
3155 int copied = 0;
3156 struct drm_mode_modeinfo u_mode;
3157 struct drm_mode_modeinfo __user *mode_ptr;
3158 uint32_t __user *encoder_ptr;
3159 bool is_current_master;
3160
3161 if (!drm_core_check_feature(dev, DRIVER_MODESET))
3162 return -EOPNOTSUPP;
3163
3164 memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
3165
3166 connector = drm_connector_lookup(dev, file_priv, out_resp->connector_id);
3167 if (!connector)
3168 return -ENOENT;
3169
3170 encoders_count = hweight32(connector->possible_encoders);
3171
3172 if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
3173 copied = 0;
3174 encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
3175
3176 drm_connector_for_each_possible_encoder(connector, encoder) {
3177 if (put_user(encoder->base.id, encoder_ptr + copied)) {
3178 ret = -EFAULT;
3179 goto out;
3180 }
3181 copied++;
3182 }
3183 }
3184 out_resp->count_encoders = encoders_count;
3185
3186 out_resp->connector_id = connector->base.id;
3187 out_resp->connector_type = connector->connector_type;
3188 out_resp->connector_type_id = connector->connector_type_id;
3189
3190 is_current_master = drm_is_current_master(file_priv);
3191
3192 mutex_lock(&dev->mode_config.mutex);
3193 if (out_resp->count_modes == 0) {
3194 if (is_current_master)
3195 connector->funcs->fill_modes(connector,
3196 dev->mode_config.max_width,
3197 dev->mode_config.max_height);
3198 else
3199 drm_dbg_kms(dev, "User-space requested a forced probe on [CONNECTOR:%d:%s] but is not the DRM master, demoting to read-only probe\n",
3200 connector->base.id, connector->name);
3201 }
3202
3203 out_resp->mm_width = connector->display_info.width_mm;
3204 out_resp->mm_height = connector->display_info.height_mm;
3205 out_resp->subpixel = connector->display_info.subpixel_order;
3206 out_resp->connection = connector->status;
3207
3208 /* delayed so we get modes regardless of pre-fill_modes state */
3209 list_for_each_entry(mode, &connector->modes, head) {
3210 WARN_ON(mode->expose_to_userspace);
3211
3212 if (drm_mode_expose_to_userspace(mode, &connector->modes,
3213 file_priv)) {
3214 mode->expose_to_userspace = true;
3215 mode_count++;
3216 }
3217 }
3218
3219 /*
3220 * This ioctl is called twice, once to determine how much space is
3221 * needed, and the 2nd time to fill it.
3222 */
3223 if ((out_resp->count_modes >= mode_count) && mode_count) {
3224 copied = 0;
3225 mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
3226 list_for_each_entry(mode, &connector->modes, head) {
3227 if (!mode->expose_to_userspace)
3228 continue;
3229
3230 /* Clear the tag for the next time around */
3231 mode->expose_to_userspace = false;
3232
3233 drm_mode_convert_to_umode(&u_mode, mode);
3234 /*
3235 * Reset aspect ratio flags of user-mode, if modes with
3236 * aspect-ratio are not supported.
3237 */
3238 if (!file_priv->aspect_ratio_allowed)
3239 u_mode.flags &= ~DRM_MODE_FLAG_PIC_AR_MASK;
3240 if (copy_to_user(mode_ptr + copied,
3241 &u_mode, sizeof(u_mode))) {
3242 ret = -EFAULT;
3243
3244 /*
3245 * Clear the tag for the rest of
3246 * the modes for the next time around.
3247 */
3248 list_for_each_entry_continue(mode, &connector->modes, head)
3249 mode->expose_to_userspace = false;
3250
3251 mutex_unlock(&dev->mode_config.mutex);
3252
3253 goto out;
3254 }
3255 copied++;
3256 }
3257 } else {
3258 /* Clear the tag for the next time around */
3259 list_for_each_entry(mode, &connector->modes, head)
3260 mode->expose_to_userspace = false;
3261 }
3262
3263 out_resp->count_modes = mode_count;
3264 mutex_unlock(&dev->mode_config.mutex);
3265
3266 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
3267 encoder = drm_connector_get_encoder(connector);
3268 if (encoder)
3269 out_resp->encoder_id = encoder->base.id;
3270 else
3271 out_resp->encoder_id = 0;
3272
3273 /* Only grab properties after probing, to make sure EDID and other
3274 * properties reflect the latest status.
3275 */
3276 ret = drm_mode_object_get_properties(&connector->base, file_priv->atomic,
3277 (uint32_t __user *)(unsigned long)(out_resp->props_ptr),
3278 (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr),
3279 &out_resp->count_props);
3280 drm_modeset_unlock(&dev->mode_config.connection_mutex);
3281
3282out:
3283 drm_connector_put(connector);
3284
3285 return ret;
3286}
3287
3288/**
3289 * drm_connector_find_by_fwnode - Find a connector based on the associated fwnode
3290 * @fwnode: fwnode for which to find the matching drm_connector
3291 *
3292 * This functions looks up a drm_connector based on its associated fwnode. When
3293 * a connector is found a reference to the connector is returned. The caller must
3294 * call drm_connector_put() to release this reference when it is done with the
3295 * connector.
3296 *
3297 * Returns: A reference to the found connector or an ERR_PTR().
3298 */
3299struct drm_connector *drm_connector_find_by_fwnode(struct fwnode_handle *fwnode)
3300{
3301 struct drm_connector *connector, *found = ERR_PTR(-ENODEV);
3302
3303 if (!fwnode)
3304 return ERR_PTR(-ENODEV);
3305
3306 mutex_lock(&connector_list_lock);
3307
3308 list_for_each_entry(connector, &connector_list, global_connector_list_entry) {
3309 if (connector->fwnode == fwnode ||
3310 (connector->fwnode && connector->fwnode->secondary == fwnode)) {
3311 drm_connector_get(connector);
3312 found = connector;
3313 break;
3314 }
3315 }
3316
3317 mutex_unlock(&connector_list_lock);
3318
3319 return found;
3320}
3321
3322/**
3323 * drm_connector_oob_hotplug_event - Report out-of-band hotplug event to connector
3324 * @connector_fwnode: fwnode_handle to report the event on
3325 * @status: hot plug detect logical state
3326 *
3327 * On some hardware a hotplug event notification may come from outside the display
3328 * driver / device. An example of this is some USB Type-C setups where the hardware
3329 * muxes the DisplayPort data and aux-lines but does not pass the altmode HPD
3330 * status bit to the GPU's DP HPD pin.
3331 *
3332 * This function can be used to report these out-of-band events after obtaining
3333 * a drm_connector reference through calling drm_connector_find_by_fwnode().
3334 */
3335void drm_connector_oob_hotplug_event(struct fwnode_handle *connector_fwnode,
3336 enum drm_connector_status status)
3337{
3338 struct drm_connector *connector;
3339
3340 connector = drm_connector_find_by_fwnode(connector_fwnode);
3341 if (IS_ERR(connector))
3342 return;
3343
3344 if (connector->funcs->oob_hotplug_event)
3345 connector->funcs->oob_hotplug_event(connector, status);
3346
3347 drm_connector_put(connector);
3348}
3349EXPORT_SYMBOL(drm_connector_oob_hotplug_event);
3350
3351
3352/**
3353 * DOC: Tile group
3354 *
3355 * Tile groups are used to represent tiled monitors with a unique integer
3356 * identifier. Tiled monitors using DisplayID v1.3 have a unique 8-byte handle,
3357 * we store this in a tile group, so we have a common identifier for all tiles
3358 * in a monitor group. The property is called "TILE". Drivers can manage tile
3359 * groups using drm_mode_create_tile_group(), drm_mode_put_tile_group() and
3360 * drm_mode_get_tile_group(). But this is only needed for internal panels where
3361 * the tile group information is exposed through a non-standard way.
3362 */
3363
3364static void drm_tile_group_free(struct kref *kref)
3365{
3366 struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
3367 struct drm_device *dev = tg->dev;
3368
3369 mutex_lock(&dev->mode_config.idr_mutex);
3370 idr_remove(&dev->mode_config.tile_idr, tg->id);
3371 mutex_unlock(&dev->mode_config.idr_mutex);
3372 kfree(tg);
3373}
3374
3375/**
3376 * drm_mode_put_tile_group - drop a reference to a tile group.
3377 * @dev: DRM device
3378 * @tg: tile group to drop reference to.
3379 *
3380 * drop reference to tile group and free if 0.
3381 */
3382void drm_mode_put_tile_group(struct drm_device *dev,
3383 struct drm_tile_group *tg)
3384{
3385 kref_put(&tg->refcount, drm_tile_group_free);
3386}
3387EXPORT_SYMBOL(drm_mode_put_tile_group);
3388
3389/**
3390 * drm_mode_get_tile_group - get a reference to an existing tile group
3391 * @dev: DRM device
3392 * @topology: 8-bytes unique per monitor.
3393 *
3394 * Use the unique bytes to get a reference to an existing tile group.
3395 *
3396 * RETURNS:
3397 * tile group or NULL if not found.
3398 */
3399struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
3400 const char topology[8])
3401{
3402 struct drm_tile_group *tg;
3403 int id;
3404
3405 mutex_lock(&dev->mode_config.idr_mutex);
3406 idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
3407 if (!memcmp(tg->group_data, topology, 8)) {
3408 if (!kref_get_unless_zero(&tg->refcount))
3409 tg = NULL;
3410 mutex_unlock(&dev->mode_config.idr_mutex);
3411 return tg;
3412 }
3413 }
3414 mutex_unlock(&dev->mode_config.idr_mutex);
3415 return NULL;
3416}
3417EXPORT_SYMBOL(drm_mode_get_tile_group);
3418
3419/**
3420 * drm_mode_create_tile_group - create a tile group from a displayid description
3421 * @dev: DRM device
3422 * @topology: 8-bytes unique per monitor.
3423 *
3424 * Create a tile group for the unique monitor, and get a unique
3425 * identifier for the tile group.
3426 *
3427 * RETURNS:
3428 * new tile group or NULL.
3429 */
3430struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
3431 const char topology[8])
3432{
3433 struct drm_tile_group *tg;
3434 int ret;
3435
3436 tg = kzalloc(sizeof(*tg), GFP_KERNEL);
3437 if (!tg)
3438 return NULL;
3439
3440 kref_init(&tg->refcount);
3441 memcpy(tg->group_data, topology, 8);
3442 tg->dev = dev;
3443
3444 mutex_lock(&dev->mode_config.idr_mutex);
3445 ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
3446 if (ret >= 0) {
3447 tg->id = ret;
3448 } else {
3449 kfree(tg);
3450 tg = NULL;
3451 }
3452
3453 mutex_unlock(&dev->mode_config.idr_mutex);
3454 return tg;
3455}
3456EXPORT_SYMBOL(drm_mode_create_tile_group);
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_auth.h>
24#include <drm/drm_connector.h>
25#include <drm/drm_edid.h>
26#include <drm/drm_encoder.h>
27#include <drm/drm_utils.h>
28#include <drm/drm_print.h>
29#include <drm/drm_drv.h>
30#include <drm/drm_file.h>
31#include <drm/drm_sysfs.h>
32
33#include <linux/uaccess.h>
34
35#include "drm_crtc_internal.h"
36#include "drm_internal.h"
37
38/**
39 * DOC: overview
40 *
41 * In DRM connectors are the general abstraction for display sinks, and include
42 * also fixed panels or anything else that can display pixels in some form. As
43 * opposed to all other KMS objects representing hardware (like CRTC, encoder or
44 * plane abstractions) connectors can be hotplugged and unplugged at runtime.
45 * Hence they are reference-counted using drm_connector_get() and
46 * drm_connector_put().
47 *
48 * KMS driver must create, initialize, register and attach at a &struct
49 * drm_connector for each such sink. The instance is created as other KMS
50 * objects and initialized by setting the following fields. The connector is
51 * initialized with a call to drm_connector_init() with a pointer to the
52 * &struct drm_connector_funcs and a connector type, and then exposed to
53 * userspace with a call to drm_connector_register().
54 *
55 * Connectors must be attached to an encoder to be used. For devices that map
56 * connectors to encoders 1:1, the connector should be attached at
57 * initialization time with a call to drm_connector_attach_encoder(). The
58 * driver must also set the &drm_connector.encoder field to point to the
59 * attached encoder.
60 *
61 * For connectors which are not fixed (like built-in panels) the driver needs to
62 * support hotplug notifications. The simplest way to do that is by using the
63 * probe helpers, see drm_kms_helper_poll_init() for connectors which don't have
64 * hardware support for hotplug interrupts. Connectors with hardware hotplug
65 * support can instead use e.g. drm_helper_hpd_irq_event().
66 */
67
68struct drm_conn_prop_enum_list {
69 int type;
70 const char *name;
71 struct ida ida;
72};
73
74/*
75 * Connector and encoder types.
76 */
77static struct drm_conn_prop_enum_list drm_connector_enum_list[] = {
78 { DRM_MODE_CONNECTOR_Unknown, "Unknown" },
79 { DRM_MODE_CONNECTOR_VGA, "VGA" },
80 { DRM_MODE_CONNECTOR_DVII, "DVI-I" },
81 { DRM_MODE_CONNECTOR_DVID, "DVI-D" },
82 { DRM_MODE_CONNECTOR_DVIA, "DVI-A" },
83 { DRM_MODE_CONNECTOR_Composite, "Composite" },
84 { DRM_MODE_CONNECTOR_SVIDEO, "SVIDEO" },
85 { DRM_MODE_CONNECTOR_LVDS, "LVDS" },
86 { DRM_MODE_CONNECTOR_Component, "Component" },
87 { DRM_MODE_CONNECTOR_9PinDIN, "DIN" },
88 { DRM_MODE_CONNECTOR_DisplayPort, "DP" },
89 { DRM_MODE_CONNECTOR_HDMIA, "HDMI-A" },
90 { DRM_MODE_CONNECTOR_HDMIB, "HDMI-B" },
91 { DRM_MODE_CONNECTOR_TV, "TV" },
92 { DRM_MODE_CONNECTOR_eDP, "eDP" },
93 { DRM_MODE_CONNECTOR_VIRTUAL, "Virtual" },
94 { DRM_MODE_CONNECTOR_DSI, "DSI" },
95 { DRM_MODE_CONNECTOR_DPI, "DPI" },
96 { DRM_MODE_CONNECTOR_WRITEBACK, "Writeback" },
97 { DRM_MODE_CONNECTOR_SPI, "SPI" },
98 { DRM_MODE_CONNECTOR_USB, "USB" },
99};
100
101void drm_connector_ida_init(void)
102{
103 int i;
104
105 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
106 ida_init(&drm_connector_enum_list[i].ida);
107}
108
109void drm_connector_ida_destroy(void)
110{
111 int i;
112
113 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
114 ida_destroy(&drm_connector_enum_list[i].ida);
115}
116
117/**
118 * drm_get_connector_type_name - return a string for connector type
119 * @type: The connector type (DRM_MODE_CONNECTOR_*)
120 *
121 * Returns: the name of the connector type, or NULL if the type is not valid.
122 */
123const char *drm_get_connector_type_name(unsigned int type)
124{
125 if (type < ARRAY_SIZE(drm_connector_enum_list))
126 return drm_connector_enum_list[type].name;
127
128 return NULL;
129}
130EXPORT_SYMBOL(drm_get_connector_type_name);
131
132/**
133 * drm_connector_get_cmdline_mode - reads the user's cmdline mode
134 * @connector: connector to query
135 *
136 * The kernel supports per-connector configuration of its consoles through
137 * use of the video= parameter. This function parses that option and
138 * extracts the user's specified mode (or enable/disable status) for a
139 * particular connector. This is typically only used during the early fbdev
140 * setup.
141 */
142static void drm_connector_get_cmdline_mode(struct drm_connector *connector)
143{
144 struct drm_cmdline_mode *mode = &connector->cmdline_mode;
145 char *option = NULL;
146
147 if (fb_get_options(connector->name, &option))
148 return;
149
150 if (!drm_mode_parse_command_line_for_connector(option,
151 connector,
152 mode))
153 return;
154
155 if (mode->force) {
156 DRM_INFO("forcing %s connector %s\n", connector->name,
157 drm_get_connector_force_name(mode->force));
158 connector->force = mode->force;
159 }
160
161 if (mode->panel_orientation != DRM_MODE_PANEL_ORIENTATION_UNKNOWN) {
162 DRM_INFO("cmdline forces connector %s panel_orientation to %d\n",
163 connector->name, mode->panel_orientation);
164 drm_connector_set_panel_orientation(connector,
165 mode->panel_orientation);
166 }
167
168 DRM_DEBUG_KMS("cmdline mode for connector %s %s %dx%d@%dHz%s%s%s\n",
169 connector->name, mode->name,
170 mode->xres, mode->yres,
171 mode->refresh_specified ? mode->refresh : 60,
172 mode->rb ? " reduced blanking" : "",
173 mode->margins ? " with margins" : "",
174 mode->interlace ? " interlaced" : "");
175}
176
177static void drm_connector_free(struct kref *kref)
178{
179 struct drm_connector *connector =
180 container_of(kref, struct drm_connector, base.refcount);
181 struct drm_device *dev = connector->dev;
182
183 drm_mode_object_unregister(dev, &connector->base);
184 connector->funcs->destroy(connector);
185}
186
187void drm_connector_free_work_fn(struct work_struct *work)
188{
189 struct drm_connector *connector, *n;
190 struct drm_device *dev =
191 container_of(work, struct drm_device, mode_config.connector_free_work);
192 struct drm_mode_config *config = &dev->mode_config;
193 unsigned long flags;
194 struct llist_node *freed;
195
196 spin_lock_irqsave(&config->connector_list_lock, flags);
197 freed = llist_del_all(&config->connector_free_list);
198 spin_unlock_irqrestore(&config->connector_list_lock, flags);
199
200 llist_for_each_entry_safe(connector, n, freed, free_node) {
201 drm_mode_object_unregister(dev, &connector->base);
202 connector->funcs->destroy(connector);
203 }
204}
205
206/**
207 * drm_connector_init - Init a preallocated connector
208 * @dev: DRM device
209 * @connector: the connector to init
210 * @funcs: callbacks for this connector
211 * @connector_type: user visible type of the connector
212 *
213 * Initialises a preallocated connector. Connectors should be
214 * subclassed as part of driver connector objects.
215 *
216 * Returns:
217 * Zero on success, error code on failure.
218 */
219int drm_connector_init(struct drm_device *dev,
220 struct drm_connector *connector,
221 const struct drm_connector_funcs *funcs,
222 int connector_type)
223{
224 struct drm_mode_config *config = &dev->mode_config;
225 int ret;
226 struct ida *connector_ida =
227 &drm_connector_enum_list[connector_type].ida;
228
229 WARN_ON(drm_drv_uses_atomic_modeset(dev) &&
230 (!funcs->atomic_destroy_state ||
231 !funcs->atomic_duplicate_state));
232
233 ret = __drm_mode_object_add(dev, &connector->base,
234 DRM_MODE_OBJECT_CONNECTOR,
235 false, drm_connector_free);
236 if (ret)
237 return ret;
238
239 connector->base.properties = &connector->properties;
240 connector->dev = dev;
241 connector->funcs = funcs;
242
243 /* connector index is used with 32bit bitmasks */
244 ret = ida_simple_get(&config->connector_ida, 0, 32, GFP_KERNEL);
245 if (ret < 0) {
246 DRM_DEBUG_KMS("Failed to allocate %s connector index: %d\n",
247 drm_connector_enum_list[connector_type].name,
248 ret);
249 goto out_put;
250 }
251 connector->index = ret;
252 ret = 0;
253
254 connector->connector_type = connector_type;
255 connector->connector_type_id =
256 ida_simple_get(connector_ida, 1, 0, GFP_KERNEL);
257 if (connector->connector_type_id < 0) {
258 ret = connector->connector_type_id;
259 goto out_put_id;
260 }
261 connector->name =
262 kasprintf(GFP_KERNEL, "%s-%d",
263 drm_connector_enum_list[connector_type].name,
264 connector->connector_type_id);
265 if (!connector->name) {
266 ret = -ENOMEM;
267 goto out_put_type_id;
268 }
269
270 INIT_LIST_HEAD(&connector->probed_modes);
271 INIT_LIST_HEAD(&connector->modes);
272 mutex_init(&connector->mutex);
273 connector->edid_blob_ptr = NULL;
274 connector->epoch_counter = 0;
275 connector->tile_blob_ptr = NULL;
276 connector->status = connector_status_unknown;
277 connector->display_info.panel_orientation =
278 DRM_MODE_PANEL_ORIENTATION_UNKNOWN;
279
280 drm_connector_get_cmdline_mode(connector);
281
282 /* We should add connectors at the end to avoid upsetting the connector
283 * index too much.
284 */
285 spin_lock_irq(&config->connector_list_lock);
286 list_add_tail(&connector->head, &config->connector_list);
287 config->num_connector++;
288 spin_unlock_irq(&config->connector_list_lock);
289
290 if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL &&
291 connector_type != DRM_MODE_CONNECTOR_WRITEBACK)
292 drm_connector_attach_edid_property(connector);
293
294 drm_object_attach_property(&connector->base,
295 config->dpms_property, 0);
296
297 drm_object_attach_property(&connector->base,
298 config->link_status_property,
299 0);
300
301 drm_object_attach_property(&connector->base,
302 config->non_desktop_property,
303 0);
304 drm_object_attach_property(&connector->base,
305 config->tile_property,
306 0);
307
308 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
309 drm_object_attach_property(&connector->base, config->prop_crtc_id, 0);
310 }
311
312 connector->debugfs_entry = NULL;
313out_put_type_id:
314 if (ret)
315 ida_simple_remove(connector_ida, connector->connector_type_id);
316out_put_id:
317 if (ret)
318 ida_simple_remove(&config->connector_ida, connector->index);
319out_put:
320 if (ret)
321 drm_mode_object_unregister(dev, &connector->base);
322
323 return ret;
324}
325EXPORT_SYMBOL(drm_connector_init);
326
327/**
328 * drm_connector_init_with_ddc - Init a preallocated connector
329 * @dev: DRM device
330 * @connector: the connector to init
331 * @funcs: callbacks for this connector
332 * @connector_type: user visible type of the connector
333 * @ddc: pointer to the associated ddc adapter
334 *
335 * Initialises a preallocated connector. Connectors should be
336 * subclassed as part of driver connector objects.
337 *
338 * Ensures that the ddc field of the connector is correctly set.
339 *
340 * Returns:
341 * Zero on success, error code on failure.
342 */
343int drm_connector_init_with_ddc(struct drm_device *dev,
344 struct drm_connector *connector,
345 const struct drm_connector_funcs *funcs,
346 int connector_type,
347 struct i2c_adapter *ddc)
348{
349 int ret;
350
351 ret = drm_connector_init(dev, connector, funcs, connector_type);
352 if (ret)
353 return ret;
354
355 /* provide ddc symlink in sysfs */
356 connector->ddc = ddc;
357
358 return ret;
359}
360EXPORT_SYMBOL(drm_connector_init_with_ddc);
361
362/**
363 * drm_connector_attach_edid_property - attach edid property.
364 * @connector: the connector
365 *
366 * Some connector types like DRM_MODE_CONNECTOR_VIRTUAL do not get a
367 * edid property attached by default. This function can be used to
368 * explicitly enable the edid property in these cases.
369 */
370void drm_connector_attach_edid_property(struct drm_connector *connector)
371{
372 struct drm_mode_config *config = &connector->dev->mode_config;
373
374 drm_object_attach_property(&connector->base,
375 config->edid_property,
376 0);
377}
378EXPORT_SYMBOL(drm_connector_attach_edid_property);
379
380/**
381 * drm_connector_attach_encoder - attach a connector to an encoder
382 * @connector: connector to attach
383 * @encoder: encoder to attach @connector to
384 *
385 * This function links up a connector to an encoder. Note that the routing
386 * restrictions between encoders and crtcs are exposed to userspace through the
387 * possible_clones and possible_crtcs bitmasks.
388 *
389 * Returns:
390 * Zero on success, negative errno on failure.
391 */
392int drm_connector_attach_encoder(struct drm_connector *connector,
393 struct drm_encoder *encoder)
394{
395 /*
396 * In the past, drivers have attempted to model the static association
397 * of connector to encoder in simple connector/encoder devices using a
398 * direct assignment of connector->encoder = encoder. This connection
399 * is a logical one and the responsibility of the core, so drivers are
400 * expected not to mess with this.
401 *
402 * Note that the error return should've been enough here, but a large
403 * majority of drivers ignores the return value, so add in a big WARN
404 * to get people's attention.
405 */
406 if (WARN_ON(connector->encoder))
407 return -EINVAL;
408
409 connector->possible_encoders |= drm_encoder_mask(encoder);
410
411 return 0;
412}
413EXPORT_SYMBOL(drm_connector_attach_encoder);
414
415/**
416 * drm_connector_has_possible_encoder - check if the connector and encoder are
417 * associated with each other
418 * @connector: the connector
419 * @encoder: the encoder
420 *
421 * Returns:
422 * True if @encoder is one of the possible encoders for @connector.
423 */
424bool drm_connector_has_possible_encoder(struct drm_connector *connector,
425 struct drm_encoder *encoder)
426{
427 return connector->possible_encoders & drm_encoder_mask(encoder);
428}
429EXPORT_SYMBOL(drm_connector_has_possible_encoder);
430
431static void drm_mode_remove(struct drm_connector *connector,
432 struct drm_display_mode *mode)
433{
434 list_del(&mode->head);
435 drm_mode_destroy(connector->dev, mode);
436}
437
438/**
439 * drm_connector_cleanup - cleans up an initialised connector
440 * @connector: connector to cleanup
441 *
442 * Cleans up the connector but doesn't free the object.
443 */
444void drm_connector_cleanup(struct drm_connector *connector)
445{
446 struct drm_device *dev = connector->dev;
447 struct drm_display_mode *mode, *t;
448
449 /* The connector should have been removed from userspace long before
450 * it is finally destroyed.
451 */
452 if (WARN_ON(connector->registration_state ==
453 DRM_CONNECTOR_REGISTERED))
454 drm_connector_unregister(connector);
455
456 if (connector->tile_group) {
457 drm_mode_put_tile_group(dev, connector->tile_group);
458 connector->tile_group = NULL;
459 }
460
461 list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
462 drm_mode_remove(connector, mode);
463
464 list_for_each_entry_safe(mode, t, &connector->modes, head)
465 drm_mode_remove(connector, mode);
466
467 ida_simple_remove(&drm_connector_enum_list[connector->connector_type].ida,
468 connector->connector_type_id);
469
470 ida_simple_remove(&dev->mode_config.connector_ida,
471 connector->index);
472
473 kfree(connector->display_info.bus_formats);
474 drm_mode_object_unregister(dev, &connector->base);
475 kfree(connector->name);
476 connector->name = NULL;
477 spin_lock_irq(&dev->mode_config.connector_list_lock);
478 list_del(&connector->head);
479 dev->mode_config.num_connector--;
480 spin_unlock_irq(&dev->mode_config.connector_list_lock);
481
482 WARN_ON(connector->state && !connector->funcs->atomic_destroy_state);
483 if (connector->state && connector->funcs->atomic_destroy_state)
484 connector->funcs->atomic_destroy_state(connector,
485 connector->state);
486
487 mutex_destroy(&connector->mutex);
488
489 memset(connector, 0, sizeof(*connector));
490}
491EXPORT_SYMBOL(drm_connector_cleanup);
492
493/**
494 * drm_connector_register - register a connector
495 * @connector: the connector to register
496 *
497 * Register userspace interfaces for a connector. Only call this for connectors
498 * which can be hotplugged after drm_dev_register() has been called already,
499 * e.g. DP MST connectors. All other connectors will be registered automatically
500 * when calling drm_dev_register().
501 *
502 * Returns:
503 * Zero on success, error code on failure.
504 */
505int drm_connector_register(struct drm_connector *connector)
506{
507 int ret = 0;
508
509 if (!connector->dev->registered)
510 return 0;
511
512 mutex_lock(&connector->mutex);
513 if (connector->registration_state != DRM_CONNECTOR_INITIALIZING)
514 goto unlock;
515
516 ret = drm_sysfs_connector_add(connector);
517 if (ret)
518 goto unlock;
519
520 drm_debugfs_connector_add(connector);
521
522 if (connector->funcs->late_register) {
523 ret = connector->funcs->late_register(connector);
524 if (ret)
525 goto err_debugfs;
526 }
527
528 drm_mode_object_register(connector->dev, &connector->base);
529
530 connector->registration_state = DRM_CONNECTOR_REGISTERED;
531
532 /* Let userspace know we have a new connector */
533 drm_sysfs_hotplug_event(connector->dev);
534
535 goto unlock;
536
537err_debugfs:
538 drm_debugfs_connector_remove(connector);
539 drm_sysfs_connector_remove(connector);
540unlock:
541 mutex_unlock(&connector->mutex);
542 return ret;
543}
544EXPORT_SYMBOL(drm_connector_register);
545
546/**
547 * drm_connector_unregister - unregister a connector
548 * @connector: the connector to unregister
549 *
550 * Unregister userspace interfaces for a connector. Only call this for
551 * connectors which have registered explicitly by calling drm_dev_register(),
552 * since connectors are unregistered automatically when drm_dev_unregister() is
553 * called.
554 */
555void drm_connector_unregister(struct drm_connector *connector)
556{
557 mutex_lock(&connector->mutex);
558 if (connector->registration_state != DRM_CONNECTOR_REGISTERED) {
559 mutex_unlock(&connector->mutex);
560 return;
561 }
562
563 if (connector->funcs->early_unregister)
564 connector->funcs->early_unregister(connector);
565
566 drm_sysfs_connector_remove(connector);
567 drm_debugfs_connector_remove(connector);
568
569 connector->registration_state = DRM_CONNECTOR_UNREGISTERED;
570 mutex_unlock(&connector->mutex);
571}
572EXPORT_SYMBOL(drm_connector_unregister);
573
574void drm_connector_unregister_all(struct drm_device *dev)
575{
576 struct drm_connector *connector;
577 struct drm_connector_list_iter conn_iter;
578
579 drm_connector_list_iter_begin(dev, &conn_iter);
580 drm_for_each_connector_iter(connector, &conn_iter)
581 drm_connector_unregister(connector);
582 drm_connector_list_iter_end(&conn_iter);
583}
584
585int drm_connector_register_all(struct drm_device *dev)
586{
587 struct drm_connector *connector;
588 struct drm_connector_list_iter conn_iter;
589 int ret = 0;
590
591 drm_connector_list_iter_begin(dev, &conn_iter);
592 drm_for_each_connector_iter(connector, &conn_iter) {
593 ret = drm_connector_register(connector);
594 if (ret)
595 break;
596 }
597 drm_connector_list_iter_end(&conn_iter);
598
599 if (ret)
600 drm_connector_unregister_all(dev);
601 return ret;
602}
603
604/**
605 * drm_get_connector_status_name - return a string for connector status
606 * @status: connector status to compute name of
607 *
608 * In contrast to the other drm_get_*_name functions this one here returns a
609 * const pointer and hence is threadsafe.
610 */
611const char *drm_get_connector_status_name(enum drm_connector_status status)
612{
613 if (status == connector_status_connected)
614 return "connected";
615 else if (status == connector_status_disconnected)
616 return "disconnected";
617 else
618 return "unknown";
619}
620EXPORT_SYMBOL(drm_get_connector_status_name);
621
622/**
623 * drm_get_connector_force_name - return a string for connector force
624 * @force: connector force to get name of
625 *
626 * Returns: const pointer to name.
627 */
628const char *drm_get_connector_force_name(enum drm_connector_force force)
629{
630 switch (force) {
631 case DRM_FORCE_UNSPECIFIED:
632 return "unspecified";
633 case DRM_FORCE_OFF:
634 return "off";
635 case DRM_FORCE_ON:
636 return "on";
637 case DRM_FORCE_ON_DIGITAL:
638 return "digital";
639 default:
640 return "unknown";
641 }
642}
643
644#ifdef CONFIG_LOCKDEP
645static struct lockdep_map connector_list_iter_dep_map = {
646 .name = "drm_connector_list_iter"
647};
648#endif
649
650/**
651 * drm_connector_list_iter_begin - initialize a connector_list iterator
652 * @dev: DRM device
653 * @iter: connector_list iterator
654 *
655 * Sets @iter up to walk the &drm_mode_config.connector_list of @dev. @iter
656 * must always be cleaned up again by calling drm_connector_list_iter_end().
657 * Iteration itself happens using drm_connector_list_iter_next() or
658 * drm_for_each_connector_iter().
659 */
660void drm_connector_list_iter_begin(struct drm_device *dev,
661 struct drm_connector_list_iter *iter)
662{
663 iter->dev = dev;
664 iter->conn = NULL;
665 lock_acquire_shared_recursive(&connector_list_iter_dep_map, 0, 1, NULL, _RET_IP_);
666}
667EXPORT_SYMBOL(drm_connector_list_iter_begin);
668
669/*
670 * Extra-safe connector put function that works in any context. Should only be
671 * used from the connector_iter functions, where we never really expect to
672 * actually release the connector when dropping our final reference.
673 */
674static void
675__drm_connector_put_safe(struct drm_connector *conn)
676{
677 struct drm_mode_config *config = &conn->dev->mode_config;
678
679 lockdep_assert_held(&config->connector_list_lock);
680
681 if (!refcount_dec_and_test(&conn->base.refcount.refcount))
682 return;
683
684 llist_add(&conn->free_node, &config->connector_free_list);
685 schedule_work(&config->connector_free_work);
686}
687
688/**
689 * drm_connector_list_iter_next - return next connector
690 * @iter: connector_list iterator
691 *
692 * Returns the next connector for @iter, or NULL when the list walk has
693 * completed.
694 */
695struct drm_connector *
696drm_connector_list_iter_next(struct drm_connector_list_iter *iter)
697{
698 struct drm_connector *old_conn = iter->conn;
699 struct drm_mode_config *config = &iter->dev->mode_config;
700 struct list_head *lhead;
701 unsigned long flags;
702
703 spin_lock_irqsave(&config->connector_list_lock, flags);
704 lhead = old_conn ? &old_conn->head : &config->connector_list;
705
706 do {
707 if (lhead->next == &config->connector_list) {
708 iter->conn = NULL;
709 break;
710 }
711
712 lhead = lhead->next;
713 iter->conn = list_entry(lhead, struct drm_connector, head);
714
715 /* loop until it's not a zombie connector */
716 } while (!kref_get_unless_zero(&iter->conn->base.refcount));
717
718 if (old_conn)
719 __drm_connector_put_safe(old_conn);
720 spin_unlock_irqrestore(&config->connector_list_lock, flags);
721
722 return iter->conn;
723}
724EXPORT_SYMBOL(drm_connector_list_iter_next);
725
726/**
727 * drm_connector_list_iter_end - tear down a connector_list iterator
728 * @iter: connector_list iterator
729 *
730 * Tears down @iter and releases any resources (like &drm_connector references)
731 * acquired while walking the list. This must always be called, both when the
732 * iteration completes fully or when it was aborted without walking the entire
733 * list.
734 */
735void drm_connector_list_iter_end(struct drm_connector_list_iter *iter)
736{
737 struct drm_mode_config *config = &iter->dev->mode_config;
738 unsigned long flags;
739
740 iter->dev = NULL;
741 if (iter->conn) {
742 spin_lock_irqsave(&config->connector_list_lock, flags);
743 __drm_connector_put_safe(iter->conn);
744 spin_unlock_irqrestore(&config->connector_list_lock, flags);
745 }
746 lock_release(&connector_list_iter_dep_map, _RET_IP_);
747}
748EXPORT_SYMBOL(drm_connector_list_iter_end);
749
750static const struct drm_prop_enum_list drm_subpixel_enum_list[] = {
751 { SubPixelUnknown, "Unknown" },
752 { SubPixelHorizontalRGB, "Horizontal RGB" },
753 { SubPixelHorizontalBGR, "Horizontal BGR" },
754 { SubPixelVerticalRGB, "Vertical RGB" },
755 { SubPixelVerticalBGR, "Vertical BGR" },
756 { SubPixelNone, "None" },
757};
758
759/**
760 * drm_get_subpixel_order_name - return a string for a given subpixel enum
761 * @order: enum of subpixel_order
762 *
763 * Note you could abuse this and return something out of bounds, but that
764 * would be a caller error. No unscrubbed user data should make it here.
765 */
766const char *drm_get_subpixel_order_name(enum subpixel_order order)
767{
768 return drm_subpixel_enum_list[order].name;
769}
770EXPORT_SYMBOL(drm_get_subpixel_order_name);
771
772static const struct drm_prop_enum_list drm_dpms_enum_list[] = {
773 { DRM_MODE_DPMS_ON, "On" },
774 { DRM_MODE_DPMS_STANDBY, "Standby" },
775 { DRM_MODE_DPMS_SUSPEND, "Suspend" },
776 { DRM_MODE_DPMS_OFF, "Off" }
777};
778DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)
779
780static const struct drm_prop_enum_list drm_link_status_enum_list[] = {
781 { DRM_MODE_LINK_STATUS_GOOD, "Good" },
782 { DRM_MODE_LINK_STATUS_BAD, "Bad" },
783};
784
785/**
786 * drm_display_info_set_bus_formats - set the supported bus formats
787 * @info: display info to store bus formats in
788 * @formats: array containing the supported bus formats
789 * @num_formats: the number of entries in the fmts array
790 *
791 * Store the supported bus formats in display info structure.
792 * See MEDIA_BUS_FMT_* definitions in include/uapi/linux/media-bus-format.h for
793 * a full list of available formats.
794 */
795int drm_display_info_set_bus_formats(struct drm_display_info *info,
796 const u32 *formats,
797 unsigned int num_formats)
798{
799 u32 *fmts = NULL;
800
801 if (!formats && num_formats)
802 return -EINVAL;
803
804 if (formats && num_formats) {
805 fmts = kmemdup(formats, sizeof(*formats) * num_formats,
806 GFP_KERNEL);
807 if (!fmts)
808 return -ENOMEM;
809 }
810
811 kfree(info->bus_formats);
812 info->bus_formats = fmts;
813 info->num_bus_formats = num_formats;
814
815 return 0;
816}
817EXPORT_SYMBOL(drm_display_info_set_bus_formats);
818
819/* Optional connector properties. */
820static const struct drm_prop_enum_list drm_scaling_mode_enum_list[] = {
821 { DRM_MODE_SCALE_NONE, "None" },
822 { DRM_MODE_SCALE_FULLSCREEN, "Full" },
823 { DRM_MODE_SCALE_CENTER, "Center" },
824 { DRM_MODE_SCALE_ASPECT, "Full aspect" },
825};
826
827static const struct drm_prop_enum_list drm_aspect_ratio_enum_list[] = {
828 { DRM_MODE_PICTURE_ASPECT_NONE, "Automatic" },
829 { DRM_MODE_PICTURE_ASPECT_4_3, "4:3" },
830 { DRM_MODE_PICTURE_ASPECT_16_9, "16:9" },
831};
832
833static const struct drm_prop_enum_list drm_content_type_enum_list[] = {
834 { DRM_MODE_CONTENT_TYPE_NO_DATA, "No Data" },
835 { DRM_MODE_CONTENT_TYPE_GRAPHICS, "Graphics" },
836 { DRM_MODE_CONTENT_TYPE_PHOTO, "Photo" },
837 { DRM_MODE_CONTENT_TYPE_CINEMA, "Cinema" },
838 { DRM_MODE_CONTENT_TYPE_GAME, "Game" },
839};
840
841static const struct drm_prop_enum_list drm_panel_orientation_enum_list[] = {
842 { DRM_MODE_PANEL_ORIENTATION_NORMAL, "Normal" },
843 { DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP, "Upside Down" },
844 { DRM_MODE_PANEL_ORIENTATION_LEFT_UP, "Left Side Up" },
845 { DRM_MODE_PANEL_ORIENTATION_RIGHT_UP, "Right Side Up" },
846};
847
848static const struct drm_prop_enum_list drm_dvi_i_select_enum_list[] = {
849 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
850 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
851 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
852};
853DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)
854
855static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] = {
856 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I, TV-out and DP */
857 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
858 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
859};
860DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
861 drm_dvi_i_subconnector_enum_list)
862
863static const struct drm_prop_enum_list drm_tv_select_enum_list[] = {
864 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
865 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
866 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
867 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
868 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
869};
870DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)
871
872static const struct drm_prop_enum_list drm_tv_subconnector_enum_list[] = {
873 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I, TV-out and DP */
874 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
875 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
876 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
877 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
878};
879DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
880 drm_tv_subconnector_enum_list)
881
882static const struct drm_prop_enum_list drm_dp_subconnector_enum_list[] = {
883 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I, TV-out and DP */
884 { DRM_MODE_SUBCONNECTOR_VGA, "VGA" }, /* DP */
885 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DP */
886 { DRM_MODE_SUBCONNECTOR_HDMIA, "HDMI" }, /* DP */
887 { DRM_MODE_SUBCONNECTOR_DisplayPort, "DP" }, /* DP */
888 { DRM_MODE_SUBCONNECTOR_Wireless, "Wireless" }, /* DP */
889 { DRM_MODE_SUBCONNECTOR_Native, "Native" }, /* DP */
890};
891
892DRM_ENUM_NAME_FN(drm_get_dp_subconnector_name,
893 drm_dp_subconnector_enum_list)
894
895static const struct drm_prop_enum_list hdmi_colorspaces[] = {
896 /* For Default case, driver will set the colorspace */
897 { DRM_MODE_COLORIMETRY_DEFAULT, "Default" },
898 /* Standard Definition Colorimetry based on CEA 861 */
899 { DRM_MODE_COLORIMETRY_SMPTE_170M_YCC, "SMPTE_170M_YCC" },
900 { DRM_MODE_COLORIMETRY_BT709_YCC, "BT709_YCC" },
901 /* Standard Definition Colorimetry based on IEC 61966-2-4 */
902 { DRM_MODE_COLORIMETRY_XVYCC_601, "XVYCC_601" },
903 /* High Definition Colorimetry based on IEC 61966-2-4 */
904 { DRM_MODE_COLORIMETRY_XVYCC_709, "XVYCC_709" },
905 /* Colorimetry based on IEC 61966-2-1/Amendment 1 */
906 { DRM_MODE_COLORIMETRY_SYCC_601, "SYCC_601" },
907 /* Colorimetry based on IEC 61966-2-5 [33] */
908 { DRM_MODE_COLORIMETRY_OPYCC_601, "opYCC_601" },
909 /* Colorimetry based on IEC 61966-2-5 */
910 { DRM_MODE_COLORIMETRY_OPRGB, "opRGB" },
911 /* Colorimetry based on ITU-R BT.2020 */
912 { DRM_MODE_COLORIMETRY_BT2020_CYCC, "BT2020_CYCC" },
913 /* Colorimetry based on ITU-R BT.2020 */
914 { DRM_MODE_COLORIMETRY_BT2020_RGB, "BT2020_RGB" },
915 /* Colorimetry based on ITU-R BT.2020 */
916 { DRM_MODE_COLORIMETRY_BT2020_YCC, "BT2020_YCC" },
917 /* Added as part of Additional Colorimetry Extension in 861.G */
918 { DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65, "DCI-P3_RGB_D65" },
919 { DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER, "DCI-P3_RGB_Theater" },
920};
921
922/*
923 * As per DP 1.4a spec, 2.2.5.7.5 VSC SDP Payload for Pixel Encoding/Colorimetry
924 * Format Table 2-120
925 */
926static const struct drm_prop_enum_list dp_colorspaces[] = {
927 /* For Default case, driver will set the colorspace */
928 { DRM_MODE_COLORIMETRY_DEFAULT, "Default" },
929 { DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED, "RGB_Wide_Gamut_Fixed_Point" },
930 /* Colorimetry based on scRGB (IEC 61966-2-2) */
931 { DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT, "RGB_Wide_Gamut_Floating_Point" },
932 /* Colorimetry based on IEC 61966-2-5 */
933 { DRM_MODE_COLORIMETRY_OPRGB, "opRGB" },
934 /* Colorimetry based on SMPTE RP 431-2 */
935 { DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65, "DCI-P3_RGB_D65" },
936 /* Colorimetry based on ITU-R BT.2020 */
937 { DRM_MODE_COLORIMETRY_BT2020_RGB, "BT2020_RGB" },
938 { DRM_MODE_COLORIMETRY_BT601_YCC, "BT601_YCC" },
939 { DRM_MODE_COLORIMETRY_BT709_YCC, "BT709_YCC" },
940 /* Standard Definition Colorimetry based on IEC 61966-2-4 */
941 { DRM_MODE_COLORIMETRY_XVYCC_601, "XVYCC_601" },
942 /* High Definition Colorimetry based on IEC 61966-2-4 */
943 { DRM_MODE_COLORIMETRY_XVYCC_709, "XVYCC_709" },
944 /* Colorimetry based on IEC 61966-2-1/Amendment 1 */
945 { DRM_MODE_COLORIMETRY_SYCC_601, "SYCC_601" },
946 /* Colorimetry based on IEC 61966-2-5 [33] */
947 { DRM_MODE_COLORIMETRY_OPYCC_601, "opYCC_601" },
948 /* Colorimetry based on ITU-R BT.2020 */
949 { DRM_MODE_COLORIMETRY_BT2020_CYCC, "BT2020_CYCC" },
950 /* Colorimetry based on ITU-R BT.2020 */
951 { DRM_MODE_COLORIMETRY_BT2020_YCC, "BT2020_YCC" },
952};
953
954/**
955 * DOC: standard connector properties
956 *
957 * DRM connectors have a few standardized properties:
958 *
959 * EDID:
960 * Blob property which contains the current EDID read from the sink. This
961 * is useful to parse sink identification information like vendor, model
962 * and serial. Drivers should update this property by calling
963 * drm_connector_update_edid_property(), usually after having parsed
964 * the EDID using drm_add_edid_modes(). Userspace cannot change this
965 * property.
966 *
967 * User-space should not parse the EDID to obtain information exposed via
968 * other KMS properties (because the kernel might apply limits, quirks or
969 * fixups to the EDID). For instance, user-space should not try to parse
970 * mode lists from the EDID.
971 * DPMS:
972 * Legacy property for setting the power state of the connector. For atomic
973 * drivers this is only provided for backwards compatibility with existing
974 * drivers, it remaps to controlling the "ACTIVE" property on the CRTC the
975 * connector is linked to. Drivers should never set this property directly,
976 * it is handled by the DRM core by calling the &drm_connector_funcs.dpms
977 * callback. For atomic drivers the remapping to the "ACTIVE" property is
978 * implemented in the DRM core.
979 *
980 * Note that this property cannot be set through the MODE_ATOMIC ioctl,
981 * userspace must use "ACTIVE" on the CRTC instead.
982 *
983 * WARNING:
984 *
985 * For userspace also running on legacy drivers the "DPMS" semantics are a
986 * lot more complicated. First, userspace cannot rely on the "DPMS" value
987 * returned by the GETCONNECTOR actually reflecting reality, because many
988 * drivers fail to update it. For atomic drivers this is taken care of in
989 * drm_atomic_helper_update_legacy_modeset_state().
990 *
991 * The second issue is that the DPMS state is only well-defined when the
992 * connector is connected to a CRTC. In atomic the DRM core enforces that
993 * "ACTIVE" is off in such a case, no such checks exists for "DPMS".
994 *
995 * Finally, when enabling an output using the legacy SETCONFIG ioctl then
996 * "DPMS" is forced to ON. But see above, that might not be reflected in
997 * the software value on legacy drivers.
998 *
999 * Summarizing: Only set "DPMS" when the connector is known to be enabled,
1000 * assume that a successful SETCONFIG call also sets "DPMS" to on, and
1001 * never read back the value of "DPMS" because it can be incorrect.
1002 * PATH:
1003 * Connector path property to identify how this sink is physically
1004 * connected. Used by DP MST. This should be set by calling
1005 * drm_connector_set_path_property(), in the case of DP MST with the
1006 * path property the MST manager created. Userspace cannot change this
1007 * property.
1008 * TILE:
1009 * Connector tile group property to indicate how a set of DRM connector
1010 * compose together into one logical screen. This is used by both high-res
1011 * external screens (often only using a single cable, but exposing multiple
1012 * DP MST sinks), or high-res integrated panels (like dual-link DSI) which
1013 * are not gen-locked. Note that for tiled panels which are genlocked, like
1014 * dual-link LVDS or dual-link DSI, the driver should try to not expose the
1015 * tiling and virtualise both &drm_crtc and &drm_plane if needed. Drivers
1016 * should update this value using drm_connector_set_tile_property().
1017 * Userspace cannot change this property.
1018 * link-status:
1019 * Connector link-status property to indicate the status of link. The
1020 * default value of link-status is "GOOD". If something fails during or
1021 * after modeset, the kernel driver may set this to "BAD" and issue a
1022 * hotplug uevent. Drivers should update this value using
1023 * drm_connector_set_link_status_property().
1024 *
1025 * When user-space receives the hotplug uevent and detects a "BAD"
1026 * link-status, the sink doesn't receive pixels anymore (e.g. the screen
1027 * becomes completely black). The list of available modes may have
1028 * changed. User-space is expected to pick a new mode if the current one
1029 * has disappeared and perform a new modeset with link-status set to
1030 * "GOOD" to re-enable the connector.
1031 *
1032 * If multiple connectors share the same CRTC and one of them gets a "BAD"
1033 * link-status, the other are unaffected (ie. the sinks still continue to
1034 * receive pixels).
1035 *
1036 * When user-space performs an atomic commit on a connector with a "BAD"
1037 * link-status without resetting the property to "GOOD", the sink may
1038 * still not receive pixels. When user-space performs an atomic commit
1039 * which resets the link-status property to "GOOD" without the
1040 * ALLOW_MODESET flag set, it might fail because a modeset is required.
1041 *
1042 * User-space can only change link-status to "GOOD", changing it to "BAD"
1043 * is a no-op.
1044 *
1045 * For backwards compatibility with non-atomic userspace the kernel
1046 * tries to automatically set the link-status back to "GOOD" in the
1047 * SETCRTC IOCTL. This might fail if the mode is no longer valid, similar
1048 * to how it might fail if a different screen has been connected in the
1049 * interim.
1050 * non_desktop:
1051 * Indicates the output should be ignored for purposes of displaying a
1052 * standard desktop environment or console. This is most likely because
1053 * the output device is not rectilinear.
1054 * Content Protection:
1055 * This property is used by userspace to request the kernel protect future
1056 * content communicated over the link. When requested, kernel will apply
1057 * the appropriate means of protection (most often HDCP), and use the
1058 * property to tell userspace the protection is active.
1059 *
1060 * Drivers can set this up by calling
1061 * drm_connector_attach_content_protection_property() on initialization.
1062 *
1063 * The value of this property can be one of the following:
1064 *
1065 * DRM_MODE_CONTENT_PROTECTION_UNDESIRED = 0
1066 * The link is not protected, content is transmitted in the clear.
1067 * DRM_MODE_CONTENT_PROTECTION_DESIRED = 1
1068 * Userspace has requested content protection, but the link is not
1069 * currently protected. When in this state, kernel should enable
1070 * Content Protection as soon as possible.
1071 * DRM_MODE_CONTENT_PROTECTION_ENABLED = 2
1072 * Userspace has requested content protection, and the link is
1073 * protected. Only the driver can set the property to this value.
1074 * If userspace attempts to set to ENABLED, kernel will return
1075 * -EINVAL.
1076 *
1077 * A few guidelines:
1078 *
1079 * - DESIRED state should be preserved until userspace de-asserts it by
1080 * setting the property to UNDESIRED. This means ENABLED should only
1081 * transition to UNDESIRED when the user explicitly requests it.
1082 * - If the state is DESIRED, kernel should attempt to re-authenticate the
1083 * link whenever possible. This includes across disable/enable, dpms,
1084 * hotplug, downstream device changes, link status failures, etc..
1085 * - Kernel sends uevent with the connector id and property id through
1086 * @drm_hdcp_update_content_protection, upon below kernel triggered
1087 * scenarios:
1088 *
1089 * - DESIRED -> ENABLED (authentication success)
1090 * - ENABLED -> DESIRED (termination of authentication)
1091 * - Please note no uevents for userspace triggered property state changes,
1092 * which can't fail such as
1093 *
1094 * - DESIRED/ENABLED -> UNDESIRED
1095 * - UNDESIRED -> DESIRED
1096 * - Userspace is responsible for polling the property or listen to uevents
1097 * to determine when the value transitions from ENABLED to DESIRED.
1098 * This signifies the link is no longer protected and userspace should
1099 * take appropriate action (whatever that might be).
1100 *
1101 * HDCP Content Type:
1102 * This Enum property is used by the userspace to declare the content type
1103 * of the display stream, to kernel. Here display stream stands for any
1104 * display content that userspace intended to display through HDCP
1105 * encryption.
1106 *
1107 * Content Type of a stream is decided by the owner of the stream, as
1108 * "HDCP Type0" or "HDCP Type1".
1109 *
1110 * The value of the property can be one of the below:
1111 * - "HDCP Type0": DRM_MODE_HDCP_CONTENT_TYPE0 = 0
1112 * - "HDCP Type1": DRM_MODE_HDCP_CONTENT_TYPE1 = 1
1113 *
1114 * When kernel starts the HDCP authentication (see "Content Protection"
1115 * for details), it uses the content type in "HDCP Content Type"
1116 * for performing the HDCP authentication with the display sink.
1117 *
1118 * Please note in HDCP spec versions, a link can be authenticated with
1119 * HDCP 2.2 for Content Type 0/Content Type 1. Where as a link can be
1120 * authenticated with HDCP1.4 only for Content Type 0(though it is implicit
1121 * in nature. As there is no reference for Content Type in HDCP1.4).
1122 *
1123 * HDCP2.2 authentication protocol itself takes the "Content Type" as a
1124 * parameter, which is a input for the DP HDCP2.2 encryption algo.
1125 *
1126 * In case of Type 0 content protection request, kernel driver can choose
1127 * either of HDCP spec versions 1.4 and 2.2. When HDCP2.2 is used for
1128 * "HDCP Type 0", a HDCP 2.2 capable repeater in the downstream can send
1129 * that content to a HDCP 1.4 authenticated HDCP sink (Type0 link).
1130 * But if the content is classified as "HDCP Type 1", above mentioned
1131 * HDCP 2.2 repeater wont send the content to the HDCP sink as it can't
1132 * authenticate the HDCP1.4 capable sink for "HDCP Type 1".
1133 *
1134 * Please note userspace can be ignorant of the HDCP versions used by the
1135 * kernel driver to achieve the "HDCP Content Type".
1136 *
1137 * At current scenario, classifying a content as Type 1 ensures that the
1138 * content will be displayed only through the HDCP2.2 encrypted link.
1139 *
1140 * Note that the HDCP Content Type property is introduced at HDCP 2.2, and
1141 * defaults to type 0. It is only exposed by drivers supporting HDCP 2.2
1142 * (hence supporting Type 0 and Type 1). Based on how next versions of
1143 * HDCP specs are defined content Type could be used for higher versions
1144 * too.
1145 *
1146 * If content type is changed when "Content Protection" is not UNDESIRED,
1147 * then kernel will disable the HDCP and re-enable with new type in the
1148 * same atomic commit. And when "Content Protection" is ENABLED, it means
1149 * that link is HDCP authenticated and encrypted, for the transmission of
1150 * the Type of stream mentioned at "HDCP Content Type".
1151 *
1152 * HDR_OUTPUT_METADATA:
1153 * Connector property to enable userspace to send HDR Metadata to
1154 * driver. This metadata is based on the composition and blending
1155 * policies decided by user, taking into account the hardware and
1156 * sink capabilities. The driver gets this metadata and creates a
1157 * Dynamic Range and Mastering Infoframe (DRM) in case of HDMI,
1158 * SDP packet (Non-audio INFOFRAME SDP v1.3) for DP. This is then
1159 * sent to sink. This notifies the sink of the upcoming frame's Color
1160 * Encoding and Luminance parameters.
1161 *
1162 * Userspace first need to detect the HDR capabilities of sink by
1163 * reading and parsing the EDID. Details of HDR metadata for HDMI
1164 * are added in CTA 861.G spec. For DP , its defined in VESA DP
1165 * Standard v1.4. It needs to then get the metadata information
1166 * of the video/game/app content which are encoded in HDR (basically
1167 * using HDR transfer functions). With this information it needs to
1168 * decide on a blending policy and compose the relevant
1169 * layers/overlays into a common format. Once this blending is done,
1170 * userspace will be aware of the metadata of the composed frame to
1171 * be send to sink. It then uses this property to communicate this
1172 * metadata to driver which then make a Infoframe packet and sends
1173 * to sink based on the type of encoder connected.
1174 *
1175 * Userspace will be responsible to do Tone mapping operation in case:
1176 * - Some layers are HDR and others are SDR
1177 * - HDR layers luminance is not same as sink
1178 *
1179 * It will even need to do colorspace conversion and get all layers
1180 * to one common colorspace for blending. It can use either GL, Media
1181 * or display engine to get this done based on the capabilities of the
1182 * associated hardware.
1183 *
1184 * Driver expects metadata to be put in &struct hdr_output_metadata
1185 * structure from userspace. This is received as blob and stored in
1186 * &drm_connector_state.hdr_output_metadata. It parses EDID and saves the
1187 * sink metadata in &struct hdr_sink_metadata, as
1188 * &drm_connector.hdr_sink_metadata. Driver uses
1189 * drm_hdmi_infoframe_set_hdr_metadata() helper to set the HDR metadata,
1190 * hdmi_drm_infoframe_pack() to pack the infoframe as per spec, in case of
1191 * HDMI encoder.
1192 *
1193 * max bpc:
1194 * This range property is used by userspace to limit the bit depth. When
1195 * used the driver would limit the bpc in accordance with the valid range
1196 * supported by the hardware and sink. Drivers to use the function
1197 * drm_connector_attach_max_bpc_property() to create and attach the
1198 * property to the connector during initialization.
1199 *
1200 * Connectors also have one standardized atomic property:
1201 *
1202 * CRTC_ID:
1203 * Mode object ID of the &drm_crtc this connector should be connected to.
1204 *
1205 * Connectors for LCD panels may also have one standardized property:
1206 *
1207 * panel orientation:
1208 * On some devices the LCD panel is mounted in the casing in such a way
1209 * that the up/top side of the panel does not match with the top side of
1210 * the device. Userspace can use this property to check for this.
1211 * Note that input coordinates from touchscreens (input devices with
1212 * INPUT_PROP_DIRECT) will still map 1:1 to the actual LCD panel
1213 * coordinates, so if userspace rotates the picture to adjust for
1214 * the orientation it must also apply the same transformation to the
1215 * touchscreen input coordinates. This property is initialized by calling
1216 * drm_connector_set_panel_orientation() or
1217 * drm_connector_set_panel_orientation_with_quirk()
1218 *
1219 * scaling mode:
1220 * This property defines how a non-native mode is upscaled to the native
1221 * mode of an LCD panel:
1222 *
1223 * None:
1224 * No upscaling happens, scaling is left to the panel. Not all
1225 * drivers expose this mode.
1226 * Full:
1227 * The output is upscaled to the full resolution of the panel,
1228 * ignoring the aspect ratio.
1229 * Center:
1230 * No upscaling happens, the output is centered within the native
1231 * resolution the panel.
1232 * Full aspect:
1233 * The output is upscaled to maximize either the width or height
1234 * while retaining the aspect ratio.
1235 *
1236 * This property should be set up by calling
1237 * drm_connector_attach_scaling_mode_property(). Note that drivers
1238 * can also expose this property to external outputs, in which case they
1239 * must support "None", which should be the default (since external screens
1240 * have a built-in scaler).
1241 *
1242 * subconnector:
1243 * This property is used by DVI-I, TVout and DisplayPort to indicate different
1244 * connector subtypes. Enum values more or less match with those from main
1245 * connector types.
1246 * For DVI-I and TVout there is also a matching property "select subconnector"
1247 * allowing to switch between signal types.
1248 * DP subconnector corresponds to a downstream port.
1249 */
1250
1251int drm_connector_create_standard_properties(struct drm_device *dev)
1252{
1253 struct drm_property *prop;
1254
1255 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1256 DRM_MODE_PROP_IMMUTABLE,
1257 "EDID", 0);
1258 if (!prop)
1259 return -ENOMEM;
1260 dev->mode_config.edid_property = prop;
1261
1262 prop = drm_property_create_enum(dev, 0,
1263 "DPMS", drm_dpms_enum_list,
1264 ARRAY_SIZE(drm_dpms_enum_list));
1265 if (!prop)
1266 return -ENOMEM;
1267 dev->mode_config.dpms_property = prop;
1268
1269 prop = drm_property_create(dev,
1270 DRM_MODE_PROP_BLOB |
1271 DRM_MODE_PROP_IMMUTABLE,
1272 "PATH", 0);
1273 if (!prop)
1274 return -ENOMEM;
1275 dev->mode_config.path_property = prop;
1276
1277 prop = drm_property_create(dev,
1278 DRM_MODE_PROP_BLOB |
1279 DRM_MODE_PROP_IMMUTABLE,
1280 "TILE", 0);
1281 if (!prop)
1282 return -ENOMEM;
1283 dev->mode_config.tile_property = prop;
1284
1285 prop = drm_property_create_enum(dev, 0, "link-status",
1286 drm_link_status_enum_list,
1287 ARRAY_SIZE(drm_link_status_enum_list));
1288 if (!prop)
1289 return -ENOMEM;
1290 dev->mode_config.link_status_property = prop;
1291
1292 prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE, "non-desktop");
1293 if (!prop)
1294 return -ENOMEM;
1295 dev->mode_config.non_desktop_property = prop;
1296
1297 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB,
1298 "HDR_OUTPUT_METADATA", 0);
1299 if (!prop)
1300 return -ENOMEM;
1301 dev->mode_config.hdr_output_metadata_property = prop;
1302
1303 return 0;
1304}
1305
1306/**
1307 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1308 * @dev: DRM device
1309 *
1310 * Called by a driver the first time a DVI-I connector is made.
1311 */
1312int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1313{
1314 struct drm_property *dvi_i_selector;
1315 struct drm_property *dvi_i_subconnector;
1316
1317 if (dev->mode_config.dvi_i_select_subconnector_property)
1318 return 0;
1319
1320 dvi_i_selector =
1321 drm_property_create_enum(dev, 0,
1322 "select subconnector",
1323 drm_dvi_i_select_enum_list,
1324 ARRAY_SIZE(drm_dvi_i_select_enum_list));
1325 dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1326
1327 dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1328 "subconnector",
1329 drm_dvi_i_subconnector_enum_list,
1330 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1331 dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1332
1333 return 0;
1334}
1335EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1336
1337/**
1338 * drm_connector_attach_dp_subconnector_property - create subconnector property for DP
1339 * @connector: drm_connector to attach property
1340 *
1341 * Called by a driver when DP connector is created.
1342 */
1343void drm_connector_attach_dp_subconnector_property(struct drm_connector *connector)
1344{
1345 struct drm_mode_config *mode_config = &connector->dev->mode_config;
1346
1347 if (!mode_config->dp_subconnector_property)
1348 mode_config->dp_subconnector_property =
1349 drm_property_create_enum(connector->dev,
1350 DRM_MODE_PROP_IMMUTABLE,
1351 "subconnector",
1352 drm_dp_subconnector_enum_list,
1353 ARRAY_SIZE(drm_dp_subconnector_enum_list));
1354
1355 drm_object_attach_property(&connector->base,
1356 mode_config->dp_subconnector_property,
1357 DRM_MODE_SUBCONNECTOR_Unknown);
1358}
1359EXPORT_SYMBOL(drm_connector_attach_dp_subconnector_property);
1360
1361/**
1362 * DOC: HDMI connector properties
1363 *
1364 * content type (HDMI specific):
1365 * Indicates content type setting to be used in HDMI infoframes to indicate
1366 * content type for the external device, so that it adjusts its display
1367 * settings accordingly.
1368 *
1369 * The value of this property can be one of the following:
1370 *
1371 * No Data:
1372 * Content type is unknown
1373 * Graphics:
1374 * Content type is graphics
1375 * Photo:
1376 * Content type is photo
1377 * Cinema:
1378 * Content type is cinema
1379 * Game:
1380 * Content type is game
1381 *
1382 * Drivers can set up this property by calling
1383 * drm_connector_attach_content_type_property(). Decoding to
1384 * infoframe values is done through drm_hdmi_avi_infoframe_content_type().
1385 */
1386
1387/**
1388 * drm_connector_attach_content_type_property - attach content-type property
1389 * @connector: connector to attach content type property on.
1390 *
1391 * Called by a driver the first time a HDMI connector is made.
1392 */
1393int drm_connector_attach_content_type_property(struct drm_connector *connector)
1394{
1395 if (!drm_mode_create_content_type_property(connector->dev))
1396 drm_object_attach_property(&connector->base,
1397 connector->dev->mode_config.content_type_property,
1398 DRM_MODE_CONTENT_TYPE_NO_DATA);
1399 return 0;
1400}
1401EXPORT_SYMBOL(drm_connector_attach_content_type_property);
1402
1403
1404/**
1405 * drm_hdmi_avi_infoframe_content_type() - fill the HDMI AVI infoframe
1406 * content type information, based
1407 * on correspondent DRM property.
1408 * @frame: HDMI AVI infoframe
1409 * @conn_state: DRM display connector state
1410 *
1411 */
1412void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame,
1413 const struct drm_connector_state *conn_state)
1414{
1415 switch (conn_state->content_type) {
1416 case DRM_MODE_CONTENT_TYPE_GRAPHICS:
1417 frame->content_type = HDMI_CONTENT_TYPE_GRAPHICS;
1418 break;
1419 case DRM_MODE_CONTENT_TYPE_CINEMA:
1420 frame->content_type = HDMI_CONTENT_TYPE_CINEMA;
1421 break;
1422 case DRM_MODE_CONTENT_TYPE_GAME:
1423 frame->content_type = HDMI_CONTENT_TYPE_GAME;
1424 break;
1425 case DRM_MODE_CONTENT_TYPE_PHOTO:
1426 frame->content_type = HDMI_CONTENT_TYPE_PHOTO;
1427 break;
1428 default:
1429 /* Graphics is the default(0) */
1430 frame->content_type = HDMI_CONTENT_TYPE_GRAPHICS;
1431 }
1432
1433 frame->itc = conn_state->content_type != DRM_MODE_CONTENT_TYPE_NO_DATA;
1434}
1435EXPORT_SYMBOL(drm_hdmi_avi_infoframe_content_type);
1436
1437/**
1438 * drm_connector_attach_tv_margin_properties - attach TV connector margin
1439 * properties
1440 * @connector: DRM connector
1441 *
1442 * Called by a driver when it needs to attach TV margin props to a connector.
1443 * Typically used on SDTV and HDMI connectors.
1444 */
1445void drm_connector_attach_tv_margin_properties(struct drm_connector *connector)
1446{
1447 struct drm_device *dev = connector->dev;
1448
1449 drm_object_attach_property(&connector->base,
1450 dev->mode_config.tv_left_margin_property,
1451 0);
1452 drm_object_attach_property(&connector->base,
1453 dev->mode_config.tv_right_margin_property,
1454 0);
1455 drm_object_attach_property(&connector->base,
1456 dev->mode_config.tv_top_margin_property,
1457 0);
1458 drm_object_attach_property(&connector->base,
1459 dev->mode_config.tv_bottom_margin_property,
1460 0);
1461}
1462EXPORT_SYMBOL(drm_connector_attach_tv_margin_properties);
1463
1464/**
1465 * drm_mode_create_tv_margin_properties - create TV connector margin properties
1466 * @dev: DRM device
1467 *
1468 * Called by a driver's HDMI connector initialization routine, this function
1469 * creates the TV margin properties for a given device. No need to call this
1470 * function for an SDTV connector, it's already called from
1471 * drm_mode_create_tv_properties().
1472 */
1473int drm_mode_create_tv_margin_properties(struct drm_device *dev)
1474{
1475 if (dev->mode_config.tv_left_margin_property)
1476 return 0;
1477
1478 dev->mode_config.tv_left_margin_property =
1479 drm_property_create_range(dev, 0, "left margin", 0, 100);
1480 if (!dev->mode_config.tv_left_margin_property)
1481 return -ENOMEM;
1482
1483 dev->mode_config.tv_right_margin_property =
1484 drm_property_create_range(dev, 0, "right margin", 0, 100);
1485 if (!dev->mode_config.tv_right_margin_property)
1486 return -ENOMEM;
1487
1488 dev->mode_config.tv_top_margin_property =
1489 drm_property_create_range(dev, 0, "top margin", 0, 100);
1490 if (!dev->mode_config.tv_top_margin_property)
1491 return -ENOMEM;
1492
1493 dev->mode_config.tv_bottom_margin_property =
1494 drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1495 if (!dev->mode_config.tv_bottom_margin_property)
1496 return -ENOMEM;
1497
1498 return 0;
1499}
1500EXPORT_SYMBOL(drm_mode_create_tv_margin_properties);
1501
1502/**
1503 * drm_mode_create_tv_properties - create TV specific connector properties
1504 * @dev: DRM device
1505 * @num_modes: number of different TV formats (modes) supported
1506 * @modes: array of pointers to strings containing name of each format
1507 *
1508 * Called by a driver's TV initialization routine, this function creates
1509 * the TV specific connector properties for a given device. Caller is
1510 * responsible for allocating a list of format names and passing them to
1511 * this routine.
1512 */
1513int drm_mode_create_tv_properties(struct drm_device *dev,
1514 unsigned int num_modes,
1515 const char * const modes[])
1516{
1517 struct drm_property *tv_selector;
1518 struct drm_property *tv_subconnector;
1519 unsigned int i;
1520
1521 if (dev->mode_config.tv_select_subconnector_property)
1522 return 0;
1523
1524 /*
1525 * Basic connector properties
1526 */
1527 tv_selector = drm_property_create_enum(dev, 0,
1528 "select subconnector",
1529 drm_tv_select_enum_list,
1530 ARRAY_SIZE(drm_tv_select_enum_list));
1531 if (!tv_selector)
1532 goto nomem;
1533
1534 dev->mode_config.tv_select_subconnector_property = tv_selector;
1535
1536 tv_subconnector =
1537 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1538 "subconnector",
1539 drm_tv_subconnector_enum_list,
1540 ARRAY_SIZE(drm_tv_subconnector_enum_list));
1541 if (!tv_subconnector)
1542 goto nomem;
1543 dev->mode_config.tv_subconnector_property = tv_subconnector;
1544
1545 /*
1546 * Other, TV specific properties: margins & TV modes.
1547 */
1548 if (drm_mode_create_tv_margin_properties(dev))
1549 goto nomem;
1550
1551 dev->mode_config.tv_mode_property =
1552 drm_property_create(dev, DRM_MODE_PROP_ENUM,
1553 "mode", num_modes);
1554 if (!dev->mode_config.tv_mode_property)
1555 goto nomem;
1556
1557 for (i = 0; i < num_modes; i++)
1558 drm_property_add_enum(dev->mode_config.tv_mode_property,
1559 i, modes[i]);
1560
1561 dev->mode_config.tv_brightness_property =
1562 drm_property_create_range(dev, 0, "brightness", 0, 100);
1563 if (!dev->mode_config.tv_brightness_property)
1564 goto nomem;
1565
1566 dev->mode_config.tv_contrast_property =
1567 drm_property_create_range(dev, 0, "contrast", 0, 100);
1568 if (!dev->mode_config.tv_contrast_property)
1569 goto nomem;
1570
1571 dev->mode_config.tv_flicker_reduction_property =
1572 drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1573 if (!dev->mode_config.tv_flicker_reduction_property)
1574 goto nomem;
1575
1576 dev->mode_config.tv_overscan_property =
1577 drm_property_create_range(dev, 0, "overscan", 0, 100);
1578 if (!dev->mode_config.tv_overscan_property)
1579 goto nomem;
1580
1581 dev->mode_config.tv_saturation_property =
1582 drm_property_create_range(dev, 0, "saturation", 0, 100);
1583 if (!dev->mode_config.tv_saturation_property)
1584 goto nomem;
1585
1586 dev->mode_config.tv_hue_property =
1587 drm_property_create_range(dev, 0, "hue", 0, 100);
1588 if (!dev->mode_config.tv_hue_property)
1589 goto nomem;
1590
1591 return 0;
1592nomem:
1593 return -ENOMEM;
1594}
1595EXPORT_SYMBOL(drm_mode_create_tv_properties);
1596
1597/**
1598 * drm_mode_create_scaling_mode_property - create scaling mode property
1599 * @dev: DRM device
1600 *
1601 * Called by a driver the first time it's needed, must be attached to desired
1602 * connectors.
1603 *
1604 * Atomic drivers should use drm_connector_attach_scaling_mode_property()
1605 * instead to correctly assign &drm_connector_state.picture_aspect_ratio
1606 * in the atomic state.
1607 */
1608int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1609{
1610 struct drm_property *scaling_mode;
1611
1612 if (dev->mode_config.scaling_mode_property)
1613 return 0;
1614
1615 scaling_mode =
1616 drm_property_create_enum(dev, 0, "scaling mode",
1617 drm_scaling_mode_enum_list,
1618 ARRAY_SIZE(drm_scaling_mode_enum_list));
1619
1620 dev->mode_config.scaling_mode_property = scaling_mode;
1621
1622 return 0;
1623}
1624EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1625
1626/**
1627 * DOC: Variable refresh properties
1628 *
1629 * Variable refresh rate capable displays can dynamically adjust their
1630 * refresh rate by extending the duration of their vertical front porch
1631 * until page flip or timeout occurs. This can reduce or remove stuttering
1632 * and latency in scenarios where the page flip does not align with the
1633 * vblank interval.
1634 *
1635 * An example scenario would be an application flipping at a constant rate
1636 * of 48Hz on a 60Hz display. The page flip will frequently miss the vblank
1637 * interval and the same contents will be displayed twice. This can be
1638 * observed as stuttering for content with motion.
1639 *
1640 * If variable refresh rate was active on a display that supported a
1641 * variable refresh range from 35Hz to 60Hz no stuttering would be observable
1642 * for the example scenario. The minimum supported variable refresh rate of
1643 * 35Hz is below the page flip frequency and the vertical front porch can
1644 * be extended until the page flip occurs. The vblank interval will be
1645 * directly aligned to the page flip rate.
1646 *
1647 * Not all userspace content is suitable for use with variable refresh rate.
1648 * Large and frequent changes in vertical front porch duration may worsen
1649 * perceived stuttering for input sensitive applications.
1650 *
1651 * Panel brightness will also vary with vertical front porch duration. Some
1652 * panels may have noticeable differences in brightness between the minimum
1653 * vertical front porch duration and the maximum vertical front porch duration.
1654 * Large and frequent changes in vertical front porch duration may produce
1655 * observable flickering for such panels.
1656 *
1657 * Userspace control for variable refresh rate is supported via properties
1658 * on the &drm_connector and &drm_crtc objects.
1659 *
1660 * "vrr_capable":
1661 * Optional &drm_connector boolean property that drivers should attach
1662 * with drm_connector_attach_vrr_capable_property() on connectors that
1663 * could support variable refresh rates. Drivers should update the
1664 * property value by calling drm_connector_set_vrr_capable_property().
1665 *
1666 * Absence of the property should indicate absence of support.
1667 *
1668 * "VRR_ENABLED":
1669 * Default &drm_crtc boolean property that notifies the driver that the
1670 * content on the CRTC is suitable for variable refresh rate presentation.
1671 * The driver will take this property as a hint to enable variable
1672 * refresh rate support if the receiver supports it, ie. if the
1673 * "vrr_capable" property is true on the &drm_connector object. The
1674 * vertical front porch duration will be extended until page-flip or
1675 * timeout when enabled.
1676 *
1677 * The minimum vertical front porch duration is defined as the vertical
1678 * front porch duration for the current mode.
1679 *
1680 * The maximum vertical front porch duration is greater than or equal to
1681 * the minimum vertical front porch duration. The duration is derived
1682 * from the minimum supported variable refresh rate for the connector.
1683 *
1684 * The driver may place further restrictions within these minimum
1685 * and maximum bounds.
1686 */
1687
1688/**
1689 * drm_connector_attach_vrr_capable_property - creates the
1690 * vrr_capable property
1691 * @connector: connector to create the vrr_capable property on.
1692 *
1693 * This is used by atomic drivers to add support for querying
1694 * variable refresh rate capability for a connector.
1695 *
1696 * Returns:
1697 * Zero on success, negative errno on failure.
1698 */
1699int drm_connector_attach_vrr_capable_property(
1700 struct drm_connector *connector)
1701{
1702 struct drm_device *dev = connector->dev;
1703 struct drm_property *prop;
1704
1705 if (!connector->vrr_capable_property) {
1706 prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE,
1707 "vrr_capable");
1708 if (!prop)
1709 return -ENOMEM;
1710
1711 connector->vrr_capable_property = prop;
1712 drm_object_attach_property(&connector->base, prop, 0);
1713 }
1714
1715 return 0;
1716}
1717EXPORT_SYMBOL(drm_connector_attach_vrr_capable_property);
1718
1719/**
1720 * drm_connector_attach_scaling_mode_property - attach atomic scaling mode property
1721 * @connector: connector to attach scaling mode property on.
1722 * @scaling_mode_mask: or'ed mask of BIT(%DRM_MODE_SCALE_\*).
1723 *
1724 * This is used to add support for scaling mode to atomic drivers.
1725 * The scaling mode will be set to &drm_connector_state.picture_aspect_ratio
1726 * and can be used from &drm_connector_helper_funcs->atomic_check for validation.
1727 *
1728 * This is the atomic version of drm_mode_create_scaling_mode_property().
1729 *
1730 * Returns:
1731 * Zero on success, negative errno on failure.
1732 */
1733int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
1734 u32 scaling_mode_mask)
1735{
1736 struct drm_device *dev = connector->dev;
1737 struct drm_property *scaling_mode_property;
1738 int i;
1739 const unsigned valid_scaling_mode_mask =
1740 (1U << ARRAY_SIZE(drm_scaling_mode_enum_list)) - 1;
1741
1742 if (WARN_ON(hweight32(scaling_mode_mask) < 2 ||
1743 scaling_mode_mask & ~valid_scaling_mode_mask))
1744 return -EINVAL;
1745
1746 scaling_mode_property =
1747 drm_property_create(dev, DRM_MODE_PROP_ENUM, "scaling mode",
1748 hweight32(scaling_mode_mask));
1749
1750 if (!scaling_mode_property)
1751 return -ENOMEM;
1752
1753 for (i = 0; i < ARRAY_SIZE(drm_scaling_mode_enum_list); i++) {
1754 int ret;
1755
1756 if (!(BIT(i) & scaling_mode_mask))
1757 continue;
1758
1759 ret = drm_property_add_enum(scaling_mode_property,
1760 drm_scaling_mode_enum_list[i].type,
1761 drm_scaling_mode_enum_list[i].name);
1762
1763 if (ret) {
1764 drm_property_destroy(dev, scaling_mode_property);
1765
1766 return ret;
1767 }
1768 }
1769
1770 drm_object_attach_property(&connector->base,
1771 scaling_mode_property, 0);
1772
1773 connector->scaling_mode_property = scaling_mode_property;
1774
1775 return 0;
1776}
1777EXPORT_SYMBOL(drm_connector_attach_scaling_mode_property);
1778
1779/**
1780 * drm_mode_create_aspect_ratio_property - create aspect ratio property
1781 * @dev: DRM device
1782 *
1783 * Called by a driver the first time it's needed, must be attached to desired
1784 * connectors.
1785 *
1786 * Returns:
1787 * Zero on success, negative errno on failure.
1788 */
1789int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
1790{
1791 if (dev->mode_config.aspect_ratio_property)
1792 return 0;
1793
1794 dev->mode_config.aspect_ratio_property =
1795 drm_property_create_enum(dev, 0, "aspect ratio",
1796 drm_aspect_ratio_enum_list,
1797 ARRAY_SIZE(drm_aspect_ratio_enum_list));
1798
1799 if (dev->mode_config.aspect_ratio_property == NULL)
1800 return -ENOMEM;
1801
1802 return 0;
1803}
1804EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
1805
1806/**
1807 * DOC: standard connector properties
1808 *
1809 * Colorspace:
1810 * This property helps select a suitable colorspace based on the sink
1811 * capability. Modern sink devices support wider gamut like BT2020.
1812 * This helps switch to BT2020 mode if the BT2020 encoded video stream
1813 * is being played by the user, same for any other colorspace. Thereby
1814 * giving a good visual experience to users.
1815 *
1816 * The expectation from userspace is that it should parse the EDID
1817 * and get supported colorspaces. Use this property and switch to the
1818 * one supported. Sink supported colorspaces should be retrieved by
1819 * userspace from EDID and driver will not explicitly expose them.
1820 *
1821 * Basically the expectation from userspace is:
1822 * - Set up CRTC DEGAMMA/CTM/GAMMA to convert to some sink
1823 * colorspace
1824 * - Set this new property to let the sink know what it
1825 * converted the CRTC output to.
1826 * - This property is just to inform sink what colorspace
1827 * source is trying to drive.
1828 *
1829 * Because between HDMI and DP have different colorspaces,
1830 * drm_mode_create_hdmi_colorspace_property() is used for HDMI connector and
1831 * drm_mode_create_dp_colorspace_property() is used for DP connector.
1832 */
1833
1834/**
1835 * drm_mode_create_hdmi_colorspace_property - create hdmi colorspace property
1836 * @connector: connector to create the Colorspace property on.
1837 *
1838 * Called by a driver the first time it's needed, must be attached to desired
1839 * HDMI connectors.
1840 *
1841 * Returns:
1842 * Zero on success, negative errno on failure.
1843 */
1844int drm_mode_create_hdmi_colorspace_property(struct drm_connector *connector)
1845{
1846 struct drm_device *dev = connector->dev;
1847
1848 if (connector->colorspace_property)
1849 return 0;
1850
1851 connector->colorspace_property =
1852 drm_property_create_enum(dev, DRM_MODE_PROP_ENUM, "Colorspace",
1853 hdmi_colorspaces,
1854 ARRAY_SIZE(hdmi_colorspaces));
1855
1856 if (!connector->colorspace_property)
1857 return -ENOMEM;
1858
1859 return 0;
1860}
1861EXPORT_SYMBOL(drm_mode_create_hdmi_colorspace_property);
1862
1863/**
1864 * drm_mode_create_dp_colorspace_property - create dp colorspace property
1865 * @connector: connector to create the Colorspace property on.
1866 *
1867 * Called by a driver the first time it's needed, must be attached to desired
1868 * DP connectors.
1869 *
1870 * Returns:
1871 * Zero on success, negative errno on failure.
1872 */
1873int drm_mode_create_dp_colorspace_property(struct drm_connector *connector)
1874{
1875 struct drm_device *dev = connector->dev;
1876
1877 if (connector->colorspace_property)
1878 return 0;
1879
1880 connector->colorspace_property =
1881 drm_property_create_enum(dev, DRM_MODE_PROP_ENUM, "Colorspace",
1882 dp_colorspaces,
1883 ARRAY_SIZE(dp_colorspaces));
1884
1885 if (!connector->colorspace_property)
1886 return -ENOMEM;
1887
1888 return 0;
1889}
1890EXPORT_SYMBOL(drm_mode_create_dp_colorspace_property);
1891
1892/**
1893 * drm_mode_create_content_type_property - create content type property
1894 * @dev: DRM device
1895 *
1896 * Called by a driver the first time it's needed, must be attached to desired
1897 * connectors.
1898 *
1899 * Returns:
1900 * Zero on success, negative errno on failure.
1901 */
1902int drm_mode_create_content_type_property(struct drm_device *dev)
1903{
1904 if (dev->mode_config.content_type_property)
1905 return 0;
1906
1907 dev->mode_config.content_type_property =
1908 drm_property_create_enum(dev, 0, "content type",
1909 drm_content_type_enum_list,
1910 ARRAY_SIZE(drm_content_type_enum_list));
1911
1912 if (dev->mode_config.content_type_property == NULL)
1913 return -ENOMEM;
1914
1915 return 0;
1916}
1917EXPORT_SYMBOL(drm_mode_create_content_type_property);
1918
1919/**
1920 * drm_mode_create_suggested_offset_properties - create suggests offset properties
1921 * @dev: DRM device
1922 *
1923 * Create the suggested x/y offset property for connectors.
1924 */
1925int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
1926{
1927 if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
1928 return 0;
1929
1930 dev->mode_config.suggested_x_property =
1931 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
1932
1933 dev->mode_config.suggested_y_property =
1934 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
1935
1936 if (dev->mode_config.suggested_x_property == NULL ||
1937 dev->mode_config.suggested_y_property == NULL)
1938 return -ENOMEM;
1939 return 0;
1940}
1941EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
1942
1943/**
1944 * drm_connector_set_path_property - set tile property on connector
1945 * @connector: connector to set property on.
1946 * @path: path to use for property; must not be NULL.
1947 *
1948 * This creates a property to expose to userspace to specify a
1949 * connector path. This is mainly used for DisplayPort MST where
1950 * connectors have a topology and we want to allow userspace to give
1951 * them more meaningful names.
1952 *
1953 * Returns:
1954 * Zero on success, negative errno on failure.
1955 */
1956int drm_connector_set_path_property(struct drm_connector *connector,
1957 const char *path)
1958{
1959 struct drm_device *dev = connector->dev;
1960 int ret;
1961
1962 ret = drm_property_replace_global_blob(dev,
1963 &connector->path_blob_ptr,
1964 strlen(path) + 1,
1965 path,
1966 &connector->base,
1967 dev->mode_config.path_property);
1968 return ret;
1969}
1970EXPORT_SYMBOL(drm_connector_set_path_property);
1971
1972/**
1973 * drm_connector_set_tile_property - set tile property on connector
1974 * @connector: connector to set property on.
1975 *
1976 * This looks up the tile information for a connector, and creates a
1977 * property for userspace to parse if it exists. The property is of
1978 * the form of 8 integers using ':' as a separator.
1979 * This is used for dual port tiled displays with DisplayPort SST
1980 * or DisplayPort MST connectors.
1981 *
1982 * Returns:
1983 * Zero on success, errno on failure.
1984 */
1985int drm_connector_set_tile_property(struct drm_connector *connector)
1986{
1987 struct drm_device *dev = connector->dev;
1988 char tile[256];
1989 int ret;
1990
1991 if (!connector->has_tile) {
1992 ret = drm_property_replace_global_blob(dev,
1993 &connector->tile_blob_ptr,
1994 0,
1995 NULL,
1996 &connector->base,
1997 dev->mode_config.tile_property);
1998 return ret;
1999 }
2000
2001 snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
2002 connector->tile_group->id, connector->tile_is_single_monitor,
2003 connector->num_h_tile, connector->num_v_tile,
2004 connector->tile_h_loc, connector->tile_v_loc,
2005 connector->tile_h_size, connector->tile_v_size);
2006
2007 ret = drm_property_replace_global_blob(dev,
2008 &connector->tile_blob_ptr,
2009 strlen(tile) + 1,
2010 tile,
2011 &connector->base,
2012 dev->mode_config.tile_property);
2013 return ret;
2014}
2015EXPORT_SYMBOL(drm_connector_set_tile_property);
2016
2017/**
2018 * drm_connector_update_edid_property - update the edid property of a connector
2019 * @connector: drm connector
2020 * @edid: new value of the edid property
2021 *
2022 * This function creates a new blob modeset object and assigns its id to the
2023 * connector's edid property.
2024 * Since we also parse tile information from EDID's displayID block, we also
2025 * set the connector's tile property here. See drm_connector_set_tile_property()
2026 * for more details.
2027 *
2028 * Returns:
2029 * Zero on success, negative errno on failure.
2030 */
2031int drm_connector_update_edid_property(struct drm_connector *connector,
2032 const struct edid *edid)
2033{
2034 struct drm_device *dev = connector->dev;
2035 size_t size = 0;
2036 int ret;
2037 const struct edid *old_edid;
2038
2039 /* ignore requests to set edid when overridden */
2040 if (connector->override_edid)
2041 return 0;
2042
2043 if (edid)
2044 size = EDID_LENGTH * (1 + edid->extensions);
2045
2046 /* Set the display info, using edid if available, otherwise
2047 * resetting the values to defaults. This duplicates the work
2048 * done in drm_add_edid_modes, but that function is not
2049 * consistently called before this one in all drivers and the
2050 * computation is cheap enough that it seems better to
2051 * duplicate it rather than attempt to ensure some arbitrary
2052 * ordering of calls.
2053 */
2054 if (edid)
2055 drm_add_display_info(connector, edid);
2056 else
2057 drm_reset_display_info(connector);
2058
2059 drm_update_tile_info(connector, edid);
2060
2061 if (connector->edid_blob_ptr) {
2062 old_edid = (const struct edid *)connector->edid_blob_ptr->data;
2063 if (old_edid) {
2064 if (!drm_edid_are_equal(edid, old_edid)) {
2065 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] Edid was changed.\n",
2066 connector->base.id, connector->name);
2067
2068 connector->epoch_counter += 1;
2069 DRM_DEBUG_KMS("Updating change counter to %llu\n",
2070 connector->epoch_counter);
2071 }
2072 }
2073 }
2074
2075 drm_object_property_set_value(&connector->base,
2076 dev->mode_config.non_desktop_property,
2077 connector->display_info.non_desktop);
2078
2079 ret = drm_property_replace_global_blob(dev,
2080 &connector->edid_blob_ptr,
2081 size,
2082 edid,
2083 &connector->base,
2084 dev->mode_config.edid_property);
2085 if (ret)
2086 return ret;
2087 return drm_connector_set_tile_property(connector);
2088}
2089EXPORT_SYMBOL(drm_connector_update_edid_property);
2090
2091/**
2092 * drm_connector_set_link_status_property - Set link status property of a connector
2093 * @connector: drm connector
2094 * @link_status: new value of link status property (0: Good, 1: Bad)
2095 *
2096 * In usual working scenario, this link status property will always be set to
2097 * "GOOD". If something fails during or after a mode set, the kernel driver
2098 * may set this link status property to "BAD". The caller then needs to send a
2099 * hotplug uevent for userspace to re-check the valid modes through
2100 * GET_CONNECTOR_IOCTL and retry modeset.
2101 *
2102 * Note: Drivers cannot rely on userspace to support this property and
2103 * issue a modeset. As such, they may choose to handle issues (like
2104 * re-training a link) without userspace's intervention.
2105 *
2106 * The reason for adding this property is to handle link training failures, but
2107 * it is not limited to DP or link training. For example, if we implement
2108 * asynchronous setcrtc, this property can be used to report any failures in that.
2109 */
2110void drm_connector_set_link_status_property(struct drm_connector *connector,
2111 uint64_t link_status)
2112{
2113 struct drm_device *dev = connector->dev;
2114
2115 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2116 connector->state->link_status = link_status;
2117 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2118}
2119EXPORT_SYMBOL(drm_connector_set_link_status_property);
2120
2121/**
2122 * drm_connector_attach_max_bpc_property - attach "max bpc" property
2123 * @connector: connector to attach max bpc property on.
2124 * @min: The minimum bit depth supported by the connector.
2125 * @max: The maximum bit depth supported by the connector.
2126 *
2127 * This is used to add support for limiting the bit depth on a connector.
2128 *
2129 * Returns:
2130 * Zero on success, negative errno on failure.
2131 */
2132int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
2133 int min, int max)
2134{
2135 struct drm_device *dev = connector->dev;
2136 struct drm_property *prop;
2137
2138 prop = connector->max_bpc_property;
2139 if (!prop) {
2140 prop = drm_property_create_range(dev, 0, "max bpc", min, max);
2141 if (!prop)
2142 return -ENOMEM;
2143
2144 connector->max_bpc_property = prop;
2145 }
2146
2147 drm_object_attach_property(&connector->base, prop, max);
2148 connector->state->max_requested_bpc = max;
2149 connector->state->max_bpc = max;
2150
2151 return 0;
2152}
2153EXPORT_SYMBOL(drm_connector_attach_max_bpc_property);
2154
2155/**
2156 * drm_connector_attach_hdr_output_metadata_property - attach "HDR_OUTPUT_METADA" property
2157 * @connector: connector to attach the property on.
2158 *
2159 * This is used to allow the userspace to send HDR Metadata to the
2160 * driver.
2161 *
2162 * Returns:
2163 * Zero on success, negative errno on failure.
2164 */
2165int drm_connector_attach_hdr_output_metadata_property(struct drm_connector *connector)
2166{
2167 struct drm_device *dev = connector->dev;
2168 struct drm_property *prop = dev->mode_config.hdr_output_metadata_property;
2169
2170 drm_object_attach_property(&connector->base, prop, 0);
2171
2172 return 0;
2173}
2174EXPORT_SYMBOL(drm_connector_attach_hdr_output_metadata_property);
2175
2176/**
2177 * drm_connector_attach_colorspace_property - attach "Colorspace" property
2178 * @connector: connector to attach the property on.
2179 *
2180 * This is used to allow the userspace to signal the output colorspace
2181 * to the driver.
2182 *
2183 * Returns:
2184 * Zero on success, negative errno on failure.
2185 */
2186int drm_connector_attach_colorspace_property(struct drm_connector *connector)
2187{
2188 struct drm_property *prop = connector->colorspace_property;
2189
2190 drm_object_attach_property(&connector->base, prop, DRM_MODE_COLORIMETRY_DEFAULT);
2191
2192 return 0;
2193}
2194EXPORT_SYMBOL(drm_connector_attach_colorspace_property);
2195
2196/**
2197 * drm_connector_atomic_hdr_metadata_equal - checks if the hdr metadata changed
2198 * @old_state: old connector state to compare
2199 * @new_state: new connector state to compare
2200 *
2201 * This is used by HDR-enabled drivers to test whether the HDR metadata
2202 * have changed between two different connector state (and thus probably
2203 * requires a full blown mode change).
2204 *
2205 * Returns:
2206 * True if the metadata are equal, False otherwise
2207 */
2208bool drm_connector_atomic_hdr_metadata_equal(struct drm_connector_state *old_state,
2209 struct drm_connector_state *new_state)
2210{
2211 struct drm_property_blob *old_blob = old_state->hdr_output_metadata;
2212 struct drm_property_blob *new_blob = new_state->hdr_output_metadata;
2213
2214 if (!old_blob || !new_blob)
2215 return old_blob == new_blob;
2216
2217 if (old_blob->length != new_blob->length)
2218 return false;
2219
2220 return !memcmp(old_blob->data, new_blob->data, old_blob->length);
2221}
2222EXPORT_SYMBOL(drm_connector_atomic_hdr_metadata_equal);
2223
2224/**
2225 * drm_connector_set_vrr_capable_property - sets the variable refresh rate
2226 * capable property for a connector
2227 * @connector: drm connector
2228 * @capable: True if the connector is variable refresh rate capable
2229 *
2230 * Should be used by atomic drivers to update the indicated support for
2231 * variable refresh rate over a connector.
2232 */
2233void drm_connector_set_vrr_capable_property(
2234 struct drm_connector *connector, bool capable)
2235{
2236 drm_object_property_set_value(&connector->base,
2237 connector->vrr_capable_property,
2238 capable);
2239}
2240EXPORT_SYMBOL(drm_connector_set_vrr_capable_property);
2241
2242/**
2243 * drm_connector_set_panel_orientation - sets the connector's panel_orientation
2244 * @connector: connector for which to set the panel-orientation property.
2245 * @panel_orientation: drm_panel_orientation value to set
2246 *
2247 * This function sets the connector's panel_orientation and attaches
2248 * a "panel orientation" property to the connector.
2249 *
2250 * Calling this function on a connector where the panel_orientation has
2251 * already been set is a no-op (e.g. the orientation has been overridden with
2252 * a kernel commandline option).
2253 *
2254 * It is allowed to call this function with a panel_orientation of
2255 * DRM_MODE_PANEL_ORIENTATION_UNKNOWN, in which case it is a no-op.
2256 *
2257 * Returns:
2258 * Zero on success, negative errno on failure.
2259 */
2260int drm_connector_set_panel_orientation(
2261 struct drm_connector *connector,
2262 enum drm_panel_orientation panel_orientation)
2263{
2264 struct drm_device *dev = connector->dev;
2265 struct drm_display_info *info = &connector->display_info;
2266 struct drm_property *prop;
2267
2268 /* Already set? */
2269 if (info->panel_orientation != DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2270 return 0;
2271
2272 /* Don't attach the property if the orientation is unknown */
2273 if (panel_orientation == DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2274 return 0;
2275
2276 info->panel_orientation = panel_orientation;
2277
2278 prop = dev->mode_config.panel_orientation_property;
2279 if (!prop) {
2280 prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
2281 "panel orientation",
2282 drm_panel_orientation_enum_list,
2283 ARRAY_SIZE(drm_panel_orientation_enum_list));
2284 if (!prop)
2285 return -ENOMEM;
2286
2287 dev->mode_config.panel_orientation_property = prop;
2288 }
2289
2290 drm_object_attach_property(&connector->base, prop,
2291 info->panel_orientation);
2292 return 0;
2293}
2294EXPORT_SYMBOL(drm_connector_set_panel_orientation);
2295
2296/**
2297 * drm_connector_set_panel_orientation_with_quirk -
2298 * set the connector's panel_orientation after checking for quirks
2299 * @connector: connector for which to init the panel-orientation property.
2300 * @panel_orientation: drm_panel_orientation value to set
2301 * @width: width in pixels of the panel, used for panel quirk detection
2302 * @height: height in pixels of the panel, used for panel quirk detection
2303 *
2304 * Like drm_connector_set_panel_orientation(), but with a check for platform
2305 * specific (e.g. DMI based) quirks overriding the passed in panel_orientation.
2306 *
2307 * Returns:
2308 * Zero on success, negative errno on failure.
2309 */
2310int drm_connector_set_panel_orientation_with_quirk(
2311 struct drm_connector *connector,
2312 enum drm_panel_orientation panel_orientation,
2313 int width, int height)
2314{
2315 int orientation_quirk;
2316
2317 orientation_quirk = drm_get_panel_orientation_quirk(width, height);
2318 if (orientation_quirk != DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2319 panel_orientation = orientation_quirk;
2320
2321 return drm_connector_set_panel_orientation(connector,
2322 panel_orientation);
2323}
2324EXPORT_SYMBOL(drm_connector_set_panel_orientation_with_quirk);
2325
2326int drm_connector_set_obj_prop(struct drm_mode_object *obj,
2327 struct drm_property *property,
2328 uint64_t value)
2329{
2330 int ret = -EINVAL;
2331 struct drm_connector *connector = obj_to_connector(obj);
2332
2333 /* Do DPMS ourselves */
2334 if (property == connector->dev->mode_config.dpms_property) {
2335 ret = (*connector->funcs->dpms)(connector, (int)value);
2336 } else if (connector->funcs->set_property)
2337 ret = connector->funcs->set_property(connector, property, value);
2338
2339 if (!ret)
2340 drm_object_property_set_value(&connector->base, property, value);
2341 return ret;
2342}
2343
2344int drm_connector_property_set_ioctl(struct drm_device *dev,
2345 void *data, struct drm_file *file_priv)
2346{
2347 struct drm_mode_connector_set_property *conn_set_prop = data;
2348 struct drm_mode_obj_set_property obj_set_prop = {
2349 .value = conn_set_prop->value,
2350 .prop_id = conn_set_prop->prop_id,
2351 .obj_id = conn_set_prop->connector_id,
2352 .obj_type = DRM_MODE_OBJECT_CONNECTOR
2353 };
2354
2355 /* It does all the locking and checking we need */
2356 return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
2357}
2358
2359static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
2360{
2361 /* For atomic drivers only state objects are synchronously updated and
2362 * protected by modeset locks, so check those first.
2363 */
2364 if (connector->state)
2365 return connector->state->best_encoder;
2366 return connector->encoder;
2367}
2368
2369static bool
2370drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
2371 const struct list_head *modes,
2372 const struct drm_file *file_priv)
2373{
2374 /*
2375 * If user-space hasn't configured the driver to expose the stereo 3D
2376 * modes, don't expose them.
2377 */
2378 if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
2379 return false;
2380 /*
2381 * If user-space hasn't configured the driver to expose the modes
2382 * with aspect-ratio, don't expose them. However if such a mode
2383 * is unique, let it be exposed, but reset the aspect-ratio flags
2384 * while preparing the list of user-modes.
2385 */
2386 if (!file_priv->aspect_ratio_allowed) {
2387 const struct drm_display_mode *mode_itr;
2388
2389 list_for_each_entry(mode_itr, modes, head) {
2390 if (mode_itr->expose_to_userspace &&
2391 drm_mode_match(mode_itr, mode,
2392 DRM_MODE_MATCH_TIMINGS |
2393 DRM_MODE_MATCH_CLOCK |
2394 DRM_MODE_MATCH_FLAGS |
2395 DRM_MODE_MATCH_3D_FLAGS))
2396 return false;
2397 }
2398 }
2399
2400 return true;
2401}
2402
2403int drm_mode_getconnector(struct drm_device *dev, void *data,
2404 struct drm_file *file_priv)
2405{
2406 struct drm_mode_get_connector *out_resp = data;
2407 struct drm_connector *connector;
2408 struct drm_encoder *encoder;
2409 struct drm_display_mode *mode;
2410 int mode_count = 0;
2411 int encoders_count = 0;
2412 int ret = 0;
2413 int copied = 0;
2414 struct drm_mode_modeinfo u_mode;
2415 struct drm_mode_modeinfo __user *mode_ptr;
2416 uint32_t __user *encoder_ptr;
2417
2418 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2419 return -EOPNOTSUPP;
2420
2421 memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
2422
2423 connector = drm_connector_lookup(dev, file_priv, out_resp->connector_id);
2424 if (!connector)
2425 return -ENOENT;
2426
2427 encoders_count = hweight32(connector->possible_encoders);
2428
2429 if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
2430 copied = 0;
2431 encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
2432
2433 drm_connector_for_each_possible_encoder(connector, encoder) {
2434 if (put_user(encoder->base.id, encoder_ptr + copied)) {
2435 ret = -EFAULT;
2436 goto out;
2437 }
2438 copied++;
2439 }
2440 }
2441 out_resp->count_encoders = encoders_count;
2442
2443 out_resp->connector_id = connector->base.id;
2444 out_resp->connector_type = connector->connector_type;
2445 out_resp->connector_type_id = connector->connector_type_id;
2446
2447 mutex_lock(&dev->mode_config.mutex);
2448 if (out_resp->count_modes == 0) {
2449 if (drm_is_current_master(file_priv))
2450 connector->funcs->fill_modes(connector,
2451 dev->mode_config.max_width,
2452 dev->mode_config.max_height);
2453 else
2454 drm_dbg_kms(dev, "User-space requested a forced probe on [CONNECTOR:%d:%s] but is not the DRM master, demoting to read-only probe",
2455 connector->base.id, connector->name);
2456 }
2457
2458 out_resp->mm_width = connector->display_info.width_mm;
2459 out_resp->mm_height = connector->display_info.height_mm;
2460 out_resp->subpixel = connector->display_info.subpixel_order;
2461 out_resp->connection = connector->status;
2462
2463 /* delayed so we get modes regardless of pre-fill_modes state */
2464 list_for_each_entry(mode, &connector->modes, head) {
2465 WARN_ON(mode->expose_to_userspace);
2466
2467 if (drm_mode_expose_to_userspace(mode, &connector->modes,
2468 file_priv)) {
2469 mode->expose_to_userspace = true;
2470 mode_count++;
2471 }
2472 }
2473
2474 /*
2475 * This ioctl is called twice, once to determine how much space is
2476 * needed, and the 2nd time to fill it.
2477 */
2478 if ((out_resp->count_modes >= mode_count) && mode_count) {
2479 copied = 0;
2480 mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
2481 list_for_each_entry(mode, &connector->modes, head) {
2482 if (!mode->expose_to_userspace)
2483 continue;
2484
2485 /* Clear the tag for the next time around */
2486 mode->expose_to_userspace = false;
2487
2488 drm_mode_convert_to_umode(&u_mode, mode);
2489 /*
2490 * Reset aspect ratio flags of user-mode, if modes with
2491 * aspect-ratio are not supported.
2492 */
2493 if (!file_priv->aspect_ratio_allowed)
2494 u_mode.flags &= ~DRM_MODE_FLAG_PIC_AR_MASK;
2495 if (copy_to_user(mode_ptr + copied,
2496 &u_mode, sizeof(u_mode))) {
2497 ret = -EFAULT;
2498
2499 /*
2500 * Clear the tag for the rest of
2501 * the modes for the next time around.
2502 */
2503 list_for_each_entry_continue(mode, &connector->modes, head)
2504 mode->expose_to_userspace = false;
2505
2506 mutex_unlock(&dev->mode_config.mutex);
2507
2508 goto out;
2509 }
2510 copied++;
2511 }
2512 } else {
2513 /* Clear the tag for the next time around */
2514 list_for_each_entry(mode, &connector->modes, head)
2515 mode->expose_to_userspace = false;
2516 }
2517
2518 out_resp->count_modes = mode_count;
2519 mutex_unlock(&dev->mode_config.mutex);
2520
2521 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2522 encoder = drm_connector_get_encoder(connector);
2523 if (encoder)
2524 out_resp->encoder_id = encoder->base.id;
2525 else
2526 out_resp->encoder_id = 0;
2527
2528 /* Only grab properties after probing, to make sure EDID and other
2529 * properties reflect the latest status.
2530 */
2531 ret = drm_mode_object_get_properties(&connector->base, file_priv->atomic,
2532 (uint32_t __user *)(unsigned long)(out_resp->props_ptr),
2533 (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr),
2534 &out_resp->count_props);
2535 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2536
2537out:
2538 drm_connector_put(connector);
2539
2540 return ret;
2541}
2542
2543
2544/**
2545 * DOC: Tile group
2546 *
2547 * Tile groups are used to represent tiled monitors with a unique integer
2548 * identifier. Tiled monitors using DisplayID v1.3 have a unique 8-byte handle,
2549 * we store this in a tile group, so we have a common identifier for all tiles
2550 * in a monitor group. The property is called "TILE". Drivers can manage tile
2551 * groups using drm_mode_create_tile_group(), drm_mode_put_tile_group() and
2552 * drm_mode_get_tile_group(). But this is only needed for internal panels where
2553 * the tile group information is exposed through a non-standard way.
2554 */
2555
2556static void drm_tile_group_free(struct kref *kref)
2557{
2558 struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
2559 struct drm_device *dev = tg->dev;
2560
2561 mutex_lock(&dev->mode_config.idr_mutex);
2562 idr_remove(&dev->mode_config.tile_idr, tg->id);
2563 mutex_unlock(&dev->mode_config.idr_mutex);
2564 kfree(tg);
2565}
2566
2567/**
2568 * drm_mode_put_tile_group - drop a reference to a tile group.
2569 * @dev: DRM device
2570 * @tg: tile group to drop reference to.
2571 *
2572 * drop reference to tile group and free if 0.
2573 */
2574void drm_mode_put_tile_group(struct drm_device *dev,
2575 struct drm_tile_group *tg)
2576{
2577 kref_put(&tg->refcount, drm_tile_group_free);
2578}
2579EXPORT_SYMBOL(drm_mode_put_tile_group);
2580
2581/**
2582 * drm_mode_get_tile_group - get a reference to an existing tile group
2583 * @dev: DRM device
2584 * @topology: 8-bytes unique per monitor.
2585 *
2586 * Use the unique bytes to get a reference to an existing tile group.
2587 *
2588 * RETURNS:
2589 * tile group or NULL if not found.
2590 */
2591struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
2592 const char topology[8])
2593{
2594 struct drm_tile_group *tg;
2595 int id;
2596
2597 mutex_lock(&dev->mode_config.idr_mutex);
2598 idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
2599 if (!memcmp(tg->group_data, topology, 8)) {
2600 if (!kref_get_unless_zero(&tg->refcount))
2601 tg = NULL;
2602 mutex_unlock(&dev->mode_config.idr_mutex);
2603 return tg;
2604 }
2605 }
2606 mutex_unlock(&dev->mode_config.idr_mutex);
2607 return NULL;
2608}
2609EXPORT_SYMBOL(drm_mode_get_tile_group);
2610
2611/**
2612 * drm_mode_create_tile_group - create a tile group from a displayid description
2613 * @dev: DRM device
2614 * @topology: 8-bytes unique per monitor.
2615 *
2616 * Create a tile group for the unique monitor, and get a unique
2617 * identifier for the tile group.
2618 *
2619 * RETURNS:
2620 * new tile group or NULL.
2621 */
2622struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
2623 const char topology[8])
2624{
2625 struct drm_tile_group *tg;
2626 int ret;
2627
2628 tg = kzalloc(sizeof(*tg), GFP_KERNEL);
2629 if (!tg)
2630 return NULL;
2631
2632 kref_init(&tg->refcount);
2633 memcpy(tg->group_data, topology, 8);
2634 tg->dev = dev;
2635
2636 mutex_lock(&dev->mode_config.idr_mutex);
2637 ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
2638 if (ret >= 0) {
2639 tg->id = ret;
2640 } else {
2641 kfree(tg);
2642 tg = NULL;
2643 }
2644
2645 mutex_unlock(&dev->mode_config.idr_mutex);
2646 return tg;
2647}
2648EXPORT_SYMBOL(drm_mode_create_tile_group);