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