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 #ifndef __DRM_CONNECTOR_H__ 24 #define __DRM_CONNECTOR_H__ 25 26 #include <linux/list.h> 27 #include <linux/ctype.h> 28 #include <linux/hdmi.h> 29 #include <drm/drm_mode_object.h> 30 31 #include <uapi/drm/drm_mode.h> 32 33 struct drm_connector_helper_funcs; 34 struct drm_modeset_acquire_ctx; 35 struct drm_device; 36 struct drm_crtc; 37 struct drm_encoder; 38 struct drm_property; 39 struct drm_property_blob; 40 struct drm_printer; 41 struct edid; 42 43 enum drm_connector_force { 44 DRM_FORCE_UNSPECIFIED, 45 DRM_FORCE_OFF, 46 DRM_FORCE_ON, /* force on analog part normally */ 47 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */ 48 }; 49 50 /** 51 * enum drm_connector_status - status for a &drm_connector 52 * 53 * This enum is used to track the connector status. There are no separate 54 * #defines for the uapi! 55 */ 56 enum drm_connector_status { 57 /** 58 * @connector_status_connected: The connector is definitely connected to 59 * a sink device, and can be enabled. 60 */ 61 connector_status_connected = 1, 62 /** 63 * @connector_status_disconnected: The connector isn't connected to a 64 * sink device which can be autodetect. For digital outputs like DP or 65 * HDMI (which can be realiable probed) this means there's really 66 * nothing there. It is driver-dependent whether a connector with this 67 * status can be lit up or not. 68 */ 69 connector_status_disconnected = 2, 70 /** 71 * @connector_status_unknown: The connector's status could not be 72 * reliably detected. This happens when probing would either cause 73 * flicker (like load-detection when the connector is in use), or when a 74 * hardware resource isn't available (like when load-detection needs a 75 * free CRTC). It should be possible to light up the connector with one 76 * of the listed fallback modes. For default configuration userspace 77 * should only try to light up connectors with unknown status when 78 * there's not connector with @connector_status_connected. 79 */ 80 connector_status_unknown = 3, 81 }; 82 83 enum subpixel_order { 84 SubPixelUnknown = 0, 85 SubPixelHorizontalRGB, 86 SubPixelHorizontalBGR, 87 SubPixelVerticalRGB, 88 SubPixelVerticalBGR, 89 SubPixelNone, 90 91 }; 92 93 /** 94 * struct drm_scrambling: sink's scrambling support. 95 */ 96 struct drm_scrambling { 97 /** 98 * @supported: scrambling supported for rates > 340 Mhz. 99 */ 100 bool supported; 101 /** 102 * @low_rates: scrambling supported for rates <= 340 Mhz. 103 */ 104 bool low_rates; 105 }; 106 107 /* 108 * struct drm_scdc - Information about scdc capabilities of a HDMI 2.0 sink 109 * 110 * Provides SCDC register support and capabilities related information on a 111 * HDMI 2.0 sink. In case of a HDMI 1.4 sink, all parameter must be 0. 112 */ 113 struct drm_scdc { 114 /** 115 * @supported: status control & data channel present. 116 */ 117 bool supported; 118 /** 119 * @read_request: sink is capable of generating scdc read request. 120 */ 121 bool read_request; 122 /** 123 * @scrambling: sink's scrambling capabilities 124 */ 125 struct drm_scrambling scrambling; 126 }; 127 128 129 /** 130 * struct drm_hdmi_info - runtime information about the connected HDMI sink 131 * 132 * Describes if a given display supports advanced HDMI 2.0 features. 133 * This information is available in CEA-861-F extension blocks (like HF-VSDB). 134 */ 135 struct drm_hdmi_info { 136 /** @scdc: sink's scdc support and capabilities */ 137 struct drm_scdc scdc; 138 139 /** 140 * @y420_vdb_modes: bitmap of modes which can support ycbcr420 141 * output only (not normal RGB/YCBCR444/422 outputs). There are total 142 * 107 VICs defined by CEA-861-F spec, so the size is 128 bits to map 143 * upto 128 VICs; 144 */ 145 unsigned long y420_vdb_modes[BITS_TO_LONGS(128)]; 146 147 /** 148 * @y420_cmdb_modes: bitmap of modes which can support ycbcr420 149 * output also, along with normal HDMI outputs. There are total 107 150 * VICs defined by CEA-861-F spec, so the size is 128 bits to map upto 151 * 128 VICs; 152 */ 153 unsigned long y420_cmdb_modes[BITS_TO_LONGS(128)]; 154 155 /** @y420_cmdb_map: bitmap of SVD index, to extraxt vcb modes */ 156 u64 y420_cmdb_map; 157 158 /** @y420_dc_modes: bitmap of deep color support index */ 159 u8 y420_dc_modes; 160 }; 161 162 /** 163 * enum drm_link_status - connector's link_status property value 164 * 165 * This enum is used as the connector's link status property value. 166 * It is set to the values defined in uapi. 167 * 168 * @DRM_LINK_STATUS_GOOD: DP Link is Good as a result of successful 169 * link training 170 * @DRM_LINK_STATUS_BAD: DP Link is BAD as a result of link training 171 * failure 172 */ 173 enum drm_link_status { 174 DRM_LINK_STATUS_GOOD = DRM_MODE_LINK_STATUS_GOOD, 175 DRM_LINK_STATUS_BAD = DRM_MODE_LINK_STATUS_BAD, 176 }; 177 178 /** 179 * struct drm_display_info - runtime data about the connected sink 180 * 181 * Describes a given display (e.g. CRT or flat panel) and its limitations. For 182 * fixed display sinks like built-in panels there's not much difference between 183 * this and &struct drm_connector. But for sinks with a real cable this 184 * structure is meant to describe all the things at the other end of the cable. 185 * 186 * For sinks which provide an EDID this can be filled out by calling 187 * drm_add_edid_modes(). 188 */ 189 struct drm_display_info { 190 /** 191 * @name: Name of the display. 192 */ 193 char name[DRM_DISPLAY_INFO_LEN]; 194 195 /** 196 * @width_mm: Physical width in mm. 197 */ 198 unsigned int width_mm; 199 /** 200 * @height_mm: Physical height in mm. 201 */ 202 unsigned int height_mm; 203 204 /** 205 * @pixel_clock: Maximum pixel clock supported by the sink, in units of 206 * 100Hz. This mismatches the clock in &drm_display_mode (which is in 207 * kHZ), because that's what the EDID uses as base unit. 208 */ 209 unsigned int pixel_clock; 210 /** 211 * @bpc: Maximum bits per color channel. Used by HDMI and DP outputs. 212 */ 213 unsigned int bpc; 214 215 /** 216 * @subpixel_order: Subpixel order of LCD panels. 217 */ 218 enum subpixel_order subpixel_order; 219 220 #define DRM_COLOR_FORMAT_RGB444 (1<<0) 221 #define DRM_COLOR_FORMAT_YCRCB444 (1<<1) 222 #define DRM_COLOR_FORMAT_YCRCB422 (1<<2) 223 #define DRM_COLOR_FORMAT_YCRCB420 (1<<3) 224 225 /** 226 * @color_formats: HDMI Color formats, selects between RGB and YCrCb 227 * modes. Used DRM_COLOR_FORMAT\_ defines, which are _not_ the same ones 228 * as used to describe the pixel format in framebuffers, and also don't 229 * match the formats in @bus_formats which are shared with v4l. 230 */ 231 u32 color_formats; 232 233 /** 234 * @bus_formats: Pixel data format on the wire, somewhat redundant with 235 * @color_formats. Array of size @num_bus_formats encoded using 236 * MEDIA_BUS_FMT\_ defines shared with v4l and media drivers. 237 */ 238 const u32 *bus_formats; 239 /** 240 * @num_bus_formats: Size of @bus_formats array. 241 */ 242 unsigned int num_bus_formats; 243 244 #define DRM_BUS_FLAG_DE_LOW (1<<0) 245 #define DRM_BUS_FLAG_DE_HIGH (1<<1) 246 /* drive data on pos. edge */ 247 #define DRM_BUS_FLAG_PIXDATA_POSEDGE (1<<2) 248 /* drive data on neg. edge */ 249 #define DRM_BUS_FLAG_PIXDATA_NEGEDGE (1<<3) 250 /* data is transmitted MSB to LSB on the bus */ 251 #define DRM_BUS_FLAG_DATA_MSB_TO_LSB (1<<4) 252 /* data is transmitted LSB to MSB on the bus */ 253 #define DRM_BUS_FLAG_DATA_LSB_TO_MSB (1<<5) 254 255 /** 256 * @bus_flags: Additional information (like pixel signal polarity) for 257 * the pixel data on the bus, using DRM_BUS_FLAGS\_ defines. 258 */ 259 u32 bus_flags; 260 261 /** 262 * @max_tmds_clock: Maximum TMDS clock rate supported by the 263 * sink in kHz. 0 means undefined. 264 */ 265 int max_tmds_clock; 266 267 /** 268 * @dvi_dual: Dual-link DVI sink? 269 */ 270 bool dvi_dual; 271 272 /** 273 * @has_hdmi_infoframe: Does the sink support the HDMI infoframe? 274 */ 275 bool has_hdmi_infoframe; 276 277 /** 278 * @edid_hdmi_dc_modes: Mask of supported hdmi deep color modes. Even 279 * more stuff redundant with @bus_formats. 280 */ 281 u8 edid_hdmi_dc_modes; 282 283 /** 284 * @cea_rev: CEA revision of the HDMI sink. 285 */ 286 u8 cea_rev; 287 288 /** 289 * @hdmi: advance features of a HDMI sink. 290 */ 291 struct drm_hdmi_info hdmi; 292 293 /** 294 * @non_desktop: Non desktop display (HMD). 295 */ 296 bool non_desktop; 297 }; 298 299 int drm_display_info_set_bus_formats(struct drm_display_info *info, 300 const u32 *formats, 301 unsigned int num_formats); 302 303 /** 304 * struct drm_tv_connector_state - TV connector related states 305 * @subconnector: selected subconnector 306 * @margins: left/right/top/bottom margins 307 * @mode: TV mode 308 * @brightness: brightness in percent 309 * @contrast: contrast in percent 310 * @flicker_reduction: flicker reduction in percent 311 * @overscan: overscan in percent 312 * @saturation: saturation in percent 313 * @hue: hue in percent 314 */ 315 struct drm_tv_connector_state { 316 enum drm_mode_subconnector subconnector; 317 struct { 318 unsigned int left; 319 unsigned int right; 320 unsigned int top; 321 unsigned int bottom; 322 } margins; 323 unsigned int mode; 324 unsigned int brightness; 325 unsigned int contrast; 326 unsigned int flicker_reduction; 327 unsigned int overscan; 328 unsigned int saturation; 329 unsigned int hue; 330 }; 331 332 /** 333 * struct drm_connector_state - mutable connector state 334 * @connector: backpointer to the connector 335 * @best_encoder: can be used by helpers and drivers to select the encoder 336 * @state: backpointer to global drm_atomic_state 337 * @tv: TV connector state 338 */ 339 struct drm_connector_state { 340 struct drm_connector *connector; 341 342 /** 343 * @crtc: CRTC to connect connector to, NULL if disabled. 344 * 345 * Do not change this directly, use drm_atomic_set_crtc_for_connector() 346 * instead. 347 */ 348 struct drm_crtc *crtc; 349 350 struct drm_encoder *best_encoder; 351 352 /** 353 * @link_status: Connector link_status to keep track of whether link is 354 * GOOD or BAD to notify userspace if retraining is necessary. 355 */ 356 enum drm_link_status link_status; 357 358 struct drm_atomic_state *state; 359 360 /** 361 * @commit: Tracks the pending commit to prevent use-after-free conditions. 362 * 363 * Is only set when @crtc is NULL. 364 */ 365 struct drm_crtc_commit *commit; 366 367 struct drm_tv_connector_state tv; 368 369 /** 370 * @picture_aspect_ratio: Connector property to control the 371 * HDMI infoframe aspect ratio setting. 372 * 373 * The %DRM_MODE_PICTURE_ASPECT_\* values much match the 374 * values for &enum hdmi_picture_aspect 375 */ 376 enum hdmi_picture_aspect picture_aspect_ratio; 377 378 /** 379 * @scaling_mode: Connector property to control the 380 * upscaling, mostly used for built-in panels. 381 */ 382 unsigned int scaling_mode; 383 }; 384 385 /** 386 * struct drm_connector_funcs - control connectors on a given device 387 * 388 * Each CRTC may have one or more connectors attached to it. The functions 389 * below allow the core DRM code to control connectors, enumerate available modes, 390 * etc. 391 */ 392 struct drm_connector_funcs { 393 /** 394 * @dpms: 395 * 396 * Legacy entry point to set the per-connector DPMS state. Legacy DPMS 397 * is exposed as a standard property on the connector, but diverted to 398 * this callback in the drm core. Note that atomic drivers don't 399 * implement the 4 level DPMS support on the connector any more, but 400 * instead only have an on/off "ACTIVE" property on the CRTC object. 401 * 402 * This hook is not used by atomic drivers, remapping of the legacy DPMS 403 * property is entirely handled in the DRM core. 404 * 405 * RETURNS: 406 * 407 * 0 on success or a negative error code on failure. 408 */ 409 int (*dpms)(struct drm_connector *connector, int mode); 410 411 /** 412 * @reset: 413 * 414 * Reset connector hardware and software state to off. This function isn't 415 * called by the core directly, only through drm_mode_config_reset(). 416 * It's not a helper hook only for historical reasons. 417 * 418 * Atomic drivers can use drm_atomic_helper_connector_reset() to reset 419 * atomic state using this hook. 420 */ 421 void (*reset)(struct drm_connector *connector); 422 423 /** 424 * @detect: 425 * 426 * Check to see if anything is attached to the connector. The parameter 427 * force is set to false whilst polling, true when checking the 428 * connector due to a user request. force can be used by the driver to 429 * avoid expensive, destructive operations during automated probing. 430 * 431 * This callback is optional, if not implemented the connector will be 432 * considered as always being attached. 433 * 434 * FIXME: 435 * 436 * Note that this hook is only called by the probe helper. It's not in 437 * the helper library vtable purely for historical reasons. The only DRM 438 * core entry point to probe connector state is @fill_modes. 439 * 440 * Note that the helper library will already hold 441 * &drm_mode_config.connection_mutex. Drivers which need to grab additional 442 * locks to avoid races with concurrent modeset changes need to use 443 * &drm_connector_helper_funcs.detect_ctx instead. 444 * 445 * RETURNS: 446 * 447 * drm_connector_status indicating the connector's status. 448 */ 449 enum drm_connector_status (*detect)(struct drm_connector *connector, 450 bool force); 451 452 /** 453 * @force: 454 * 455 * This function is called to update internal encoder state when the 456 * connector is forced to a certain state by userspace, either through 457 * the sysfs interfaces or on the kernel cmdline. In that case the 458 * @detect callback isn't called. 459 * 460 * FIXME: 461 * 462 * Note that this hook is only called by the probe helper. It's not in 463 * the helper library vtable purely for historical reasons. The only DRM 464 * core entry point to probe connector state is @fill_modes. 465 */ 466 void (*force)(struct drm_connector *connector); 467 468 /** 469 * @fill_modes: 470 * 471 * Entry point for output detection and basic mode validation. The 472 * driver should reprobe the output if needed (e.g. when hotplug 473 * handling is unreliable), add all detected modes to &drm_connector.modes 474 * and filter out any the device can't support in any configuration. It 475 * also needs to filter out any modes wider or higher than the 476 * parameters max_width and max_height indicate. 477 * 478 * The drivers must also prune any modes no longer valid from 479 * &drm_connector.modes. Furthermore it must update 480 * &drm_connector.status and &drm_connector.edid. If no EDID has been 481 * received for this output connector->edid must be NULL. 482 * 483 * Drivers using the probe helpers should use 484 * drm_helper_probe_single_connector_modes() or 485 * drm_helper_probe_single_connector_modes_nomerge() to implement this 486 * function. 487 * 488 * RETURNS: 489 * 490 * The number of modes detected and filled into &drm_connector.modes. 491 */ 492 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height); 493 494 /** 495 * @set_property: 496 * 497 * This is the legacy entry point to update a property attached to the 498 * connector. 499 * 500 * This callback is optional if the driver does not support any legacy 501 * driver-private properties. For atomic drivers it is not used because 502 * property handling is done entirely in the DRM core. 503 * 504 * RETURNS: 505 * 506 * 0 on success or a negative error code on failure. 507 */ 508 int (*set_property)(struct drm_connector *connector, struct drm_property *property, 509 uint64_t val); 510 511 /** 512 * @late_register: 513 * 514 * This optional hook can be used to register additional userspace 515 * interfaces attached to the connector, light backlight control, i2c, 516 * DP aux or similar interfaces. It is called late in the driver load 517 * sequence from drm_connector_register() when registering all the 518 * core drm connector interfaces. Everything added from this callback 519 * should be unregistered in the early_unregister callback. 520 * 521 * This is called while holding &drm_connector.mutex. 522 * 523 * Returns: 524 * 525 * 0 on success, or a negative error code on failure. 526 */ 527 int (*late_register)(struct drm_connector *connector); 528 529 /** 530 * @early_unregister: 531 * 532 * This optional hook should be used to unregister the additional 533 * userspace interfaces attached to the connector from 534 * late_register(). It is called from drm_connector_unregister(), 535 * early in the driver unload sequence to disable userspace access 536 * before data structures are torndown. 537 * 538 * This is called while holding &drm_connector.mutex. 539 */ 540 void (*early_unregister)(struct drm_connector *connector); 541 542 /** 543 * @destroy: 544 * 545 * Clean up connector resources. This is called at driver unload time 546 * through drm_mode_config_cleanup(). It can also be called at runtime 547 * when a connector is being hot-unplugged for drivers that support 548 * connector hotplugging (e.g. DisplayPort MST). 549 */ 550 void (*destroy)(struct drm_connector *connector); 551 552 /** 553 * @atomic_duplicate_state: 554 * 555 * Duplicate the current atomic state for this connector and return it. 556 * The core and helpers guarantee that any atomic state duplicated with 557 * this hook and still owned by the caller (i.e. not transferred to the 558 * driver by calling &drm_mode_config_funcs.atomic_commit) will be 559 * cleaned up by calling the @atomic_destroy_state hook in this 560 * structure. 561 * 562 * Atomic drivers which don't subclass &struct drm_connector_state should use 563 * drm_atomic_helper_connector_duplicate_state(). Drivers that subclass the 564 * state structure to extend it with driver-private state should use 565 * __drm_atomic_helper_connector_duplicate_state() to make sure shared state is 566 * duplicated in a consistent fashion across drivers. 567 * 568 * It is an error to call this hook before &drm_connector.state has been 569 * initialized correctly. 570 * 571 * NOTE: 572 * 573 * If the duplicate state references refcounted resources this hook must 574 * acquire a reference for each of them. The driver must release these 575 * references again in @atomic_destroy_state. 576 * 577 * RETURNS: 578 * 579 * Duplicated atomic state or NULL when the allocation failed. 580 */ 581 struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector); 582 583 /** 584 * @atomic_destroy_state: 585 * 586 * Destroy a state duplicated with @atomic_duplicate_state and release 587 * or unreference all resources it references 588 */ 589 void (*atomic_destroy_state)(struct drm_connector *connector, 590 struct drm_connector_state *state); 591 592 /** 593 * @atomic_set_property: 594 * 595 * Decode a driver-private property value and store the decoded value 596 * into the passed-in state structure. Since the atomic core decodes all 597 * standardized properties (even for extensions beyond the core set of 598 * properties which might not be implemented by all drivers) this 599 * requires drivers to subclass the state structure. 600 * 601 * Such driver-private properties should really only be implemented for 602 * truly hardware/vendor specific state. Instead it is preferred to 603 * standardize atomic extension and decode the properties used to expose 604 * such an extension in the core. 605 * 606 * Do not call this function directly, use 607 * drm_atomic_connector_set_property() instead. 608 * 609 * This callback is optional if the driver does not support any 610 * driver-private atomic properties. 611 * 612 * NOTE: 613 * 614 * This function is called in the state assembly phase of atomic 615 * modesets, which can be aborted for any reason (including on 616 * userspace's request to just check whether a configuration would be 617 * possible). Drivers MUST NOT touch any persistent state (hardware or 618 * software) or data structures except the passed in @state parameter. 619 * 620 * Also since userspace controls in which order properties are set this 621 * function must not do any input validation (since the state update is 622 * incomplete and hence likely inconsistent). Instead any such input 623 * validation must be done in the various atomic_check callbacks. 624 * 625 * RETURNS: 626 * 627 * 0 if the property has been found, -EINVAL if the property isn't 628 * implemented by the driver (which shouldn't ever happen, the core only 629 * asks for properties attached to this connector). No other validation 630 * is allowed by the driver. The core already checks that the property 631 * value is within the range (integer, valid enum value, ...) the driver 632 * set when registering the property. 633 */ 634 int (*atomic_set_property)(struct drm_connector *connector, 635 struct drm_connector_state *state, 636 struct drm_property *property, 637 uint64_t val); 638 639 /** 640 * @atomic_get_property: 641 * 642 * Reads out the decoded driver-private property. This is used to 643 * implement the GETCONNECTOR IOCTL. 644 * 645 * Do not call this function directly, use 646 * drm_atomic_connector_get_property() instead. 647 * 648 * This callback is optional if the driver does not support any 649 * driver-private atomic properties. 650 * 651 * RETURNS: 652 * 653 * 0 on success, -EINVAL if the property isn't implemented by the 654 * driver (which shouldn't ever happen, the core only asks for 655 * properties attached to this connector). 656 */ 657 int (*atomic_get_property)(struct drm_connector *connector, 658 const struct drm_connector_state *state, 659 struct drm_property *property, 660 uint64_t *val); 661 662 /** 663 * @atomic_print_state: 664 * 665 * If driver subclasses &struct drm_connector_state, it should implement 666 * this optional hook for printing additional driver specific state. 667 * 668 * Do not call this directly, use drm_atomic_connector_print_state() 669 * instead. 670 */ 671 void (*atomic_print_state)(struct drm_printer *p, 672 const struct drm_connector_state *state); 673 }; 674 675 /* mode specified on the command line */ 676 struct drm_cmdline_mode { 677 bool specified; 678 bool refresh_specified; 679 bool bpp_specified; 680 int xres, yres; 681 int bpp; 682 int refresh; 683 bool rb; 684 bool interlace; 685 bool cvt; 686 bool margins; 687 enum drm_connector_force force; 688 }; 689 690 /** 691 * struct drm_connector - central DRM connector control structure 692 * @dev: parent DRM device 693 * @kdev: kernel device for sysfs attributes 694 * @attr: sysfs attributes 695 * @head: list management 696 * @base: base KMS object 697 * @name: human readable name, can be overwritten by the driver 698 * @connector_type: one of the DRM_MODE_CONNECTOR_<foo> types from drm_mode.h 699 * @connector_type_id: index into connector type enum 700 * @interlace_allowed: can this connector handle interlaced modes? 701 * @doublescan_allowed: can this connector handle doublescan? 702 * @stereo_allowed: can this connector handle stereo modes? 703 * @funcs: connector control functions 704 * @edid_blob_ptr: DRM property containing EDID if present 705 * @properties: property tracking for this connector 706 * @dpms: current dpms state 707 * @helper_private: mid-layer private data 708 * @cmdline_mode: mode line parsed from the kernel cmdline for this connector 709 * @force: a DRM_FORCE_<foo> state for forced mode sets 710 * @override_edid: has the EDID been overwritten through debugfs for testing? 711 * @encoder_ids: valid encoders for this connector 712 * @eld: EDID-like data, if present 713 * @latency_present: AV delay info from ELD, if found 714 * @video_latency: video latency info from ELD, if found 715 * @audio_latency: audio latency info from ELD, if found 716 * @null_edid_counter: track sinks that give us all zeros for the EDID 717 * @bad_edid_counter: track sinks that give us an EDID with invalid checksum 718 * @edid_corrupt: indicates whether the last read EDID was corrupt 719 * @debugfs_entry: debugfs directory for this connector 720 * @has_tile: is this connector connected to a tiled monitor 721 * @tile_group: tile group for the connected monitor 722 * @tile_is_single_monitor: whether the tile is one monitor housing 723 * @num_h_tile: number of horizontal tiles in the tile group 724 * @num_v_tile: number of vertical tiles in the tile group 725 * @tile_h_loc: horizontal location of this tile 726 * @tile_v_loc: vertical location of this tile 727 * @tile_h_size: horizontal size of this tile. 728 * @tile_v_size: vertical size of this tile. 729 * @scaling_mode_property: Optional atomic property to control the upscaling. 730 * 731 * Each connector may be connected to one or more CRTCs, or may be clonable by 732 * another connector if they can share a CRTC. Each connector also has a specific 733 * position in the broader display (referred to as a 'screen' though it could 734 * span multiple monitors). 735 */ 736 struct drm_connector { 737 struct drm_device *dev; 738 struct device *kdev; 739 struct device_attribute *attr; 740 struct list_head head; 741 742 struct drm_mode_object base; 743 744 char *name; 745 746 /** 747 * @mutex: Lock for general connector state, but currently only protects 748 * @registered. Most of the connector state is still protected by 749 * &drm_mode_config.mutex. 750 */ 751 struct mutex mutex; 752 753 /** 754 * @index: Compacted connector index, which matches the position inside 755 * the mode_config.list for drivers not supporting hot-add/removing. Can 756 * be used as an array index. It is invariant over the lifetime of the 757 * connector. 758 */ 759 unsigned index; 760 761 int connector_type; 762 int connector_type_id; 763 bool interlace_allowed; 764 bool doublescan_allowed; 765 bool stereo_allowed; 766 767 /** 768 * @ycbcr_420_allowed : This bool indicates if this connector is 769 * capable of handling YCBCR 420 output. While parsing the EDID 770 * blocks, its very helpful to know, if the source is capable of 771 * handling YCBCR 420 outputs. 772 */ 773 bool ycbcr_420_allowed; 774 775 /** 776 * @registered: Is this connector exposed (registered) with userspace? 777 * Protected by @mutex. 778 */ 779 bool registered; 780 781 /** 782 * @modes: 783 * Modes available on this connector (from fill_modes() + user). 784 * Protected by &drm_mode_config.mutex. 785 */ 786 struct list_head modes; 787 788 /** 789 * @status: 790 * One of the drm_connector_status enums (connected, not, or unknown). 791 * Protected by &drm_mode_config.mutex. 792 */ 793 enum drm_connector_status status; 794 795 /** 796 * @probed_modes: 797 * These are modes added by probing with DDC or the BIOS, before 798 * filtering is applied. Used by the probe helpers. Protected by 799 * &drm_mode_config.mutex. 800 */ 801 struct list_head probed_modes; 802 803 /** 804 * @display_info: Display information is filled from EDID information 805 * when a display is detected. For non hot-pluggable displays such as 806 * flat panels in embedded systems, the driver should initialize the 807 * &drm_display_info.width_mm and &drm_display_info.height_mm fields 808 * with the physical size of the display. 809 * 810 * Protected by &drm_mode_config.mutex. 811 */ 812 struct drm_display_info display_info; 813 const struct drm_connector_funcs *funcs; 814 815 struct drm_property_blob *edid_blob_ptr; 816 struct drm_object_properties properties; 817 818 struct drm_property *scaling_mode_property; 819 820 /** 821 * @path_blob_ptr: 822 * 823 * DRM blob property data for the DP MST path property. 824 */ 825 struct drm_property_blob *path_blob_ptr; 826 827 /** 828 * @tile_blob_ptr: 829 * 830 * DRM blob property data for the tile property (used mostly by DP MST). 831 * This is meant for screens which are driven through separate display 832 * pipelines represented by &drm_crtc, which might not be running with 833 * genlocked clocks. For tiled panels which are genlocked, like 834 * dual-link LVDS or dual-link DSI, the driver should try to not expose 835 * the tiling and virtualize both &drm_crtc and &drm_plane if needed. 836 */ 837 struct drm_property_blob *tile_blob_ptr; 838 839 /* should we poll this connector for connects and disconnects */ 840 /* hot plug detectable */ 841 #define DRM_CONNECTOR_POLL_HPD (1 << 0) 842 /* poll for connections */ 843 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1) 844 /* can cleanly poll for disconnections without flickering the screen */ 845 /* DACs should rarely do this without a lot of testing */ 846 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2) 847 848 /** 849 * @polled: 850 * 851 * Connector polling mode, a combination of 852 * 853 * DRM_CONNECTOR_POLL_HPD 854 * The connector generates hotplug events and doesn't need to be 855 * periodically polled. The CONNECT and DISCONNECT flags must not 856 * be set together with the HPD flag. 857 * 858 * DRM_CONNECTOR_POLL_CONNECT 859 * Periodically poll the connector for connection. 860 * 861 * DRM_CONNECTOR_POLL_DISCONNECT 862 * Periodically poll the connector for disconnection. 863 * 864 * Set to 0 for connectors that don't support connection status 865 * discovery. 866 */ 867 uint8_t polled; 868 869 /* requested DPMS state */ 870 int dpms; 871 872 const struct drm_connector_helper_funcs *helper_private; 873 874 /* forced on connector */ 875 struct drm_cmdline_mode cmdline_mode; 876 enum drm_connector_force force; 877 bool override_edid; 878 879 #define DRM_CONNECTOR_MAX_ENCODER 3 880 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER]; 881 /** 882 * @encoder: Currently bound encoder driving this connector, if any. 883 * Only really meaningful for non-atomic drivers. Atomic drivers should 884 * instead look at &drm_connector_state.best_encoder, and in case they 885 * need the CRTC driving this output, &drm_connector_state.crtc. 886 */ 887 struct drm_encoder *encoder; 888 889 #define MAX_ELD_BYTES 128 890 /* EDID bits */ 891 uint8_t eld[MAX_ELD_BYTES]; 892 bool latency_present[2]; 893 int video_latency[2]; /* [0]: progressive, [1]: interlaced */ 894 int audio_latency[2]; 895 int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */ 896 unsigned bad_edid_counter; 897 898 /* Flag for raw EDID header corruption - used in Displayport 899 * compliance testing - * Displayport Link CTS Core 1.2 rev1.1 4.2.2.6 900 */ 901 bool edid_corrupt; 902 903 struct dentry *debugfs_entry; 904 905 /** 906 * @state: 907 * 908 * Current atomic state for this connector. 909 * 910 * This is protected by @drm_mode_config.connection_mutex. Note that 911 * nonblocking atomic commits access the current connector state without 912 * taking locks. Either by going through the &struct drm_atomic_state 913 * pointers, see for_each_oldnew_connector_in_state(), 914 * for_each_old_connector_in_state() and 915 * for_each_new_connector_in_state(). Or through careful ordering of 916 * atomic commit operations as implemented in the atomic helpers, see 917 * &struct drm_crtc_commit. 918 */ 919 struct drm_connector_state *state; 920 921 /* DisplayID bits */ 922 bool has_tile; 923 struct drm_tile_group *tile_group; 924 bool tile_is_single_monitor; 925 926 uint8_t num_h_tile, num_v_tile; 927 uint8_t tile_h_loc, tile_v_loc; 928 uint16_t tile_h_size, tile_v_size; 929 }; 930 931 #define obj_to_connector(x) container_of(x, struct drm_connector, base) 932 933 int drm_connector_init(struct drm_device *dev, 934 struct drm_connector *connector, 935 const struct drm_connector_funcs *funcs, 936 int connector_type); 937 int drm_connector_register(struct drm_connector *connector); 938 void drm_connector_unregister(struct drm_connector *connector); 939 int drm_mode_connector_attach_encoder(struct drm_connector *connector, 940 struct drm_encoder *encoder); 941 942 void drm_connector_cleanup(struct drm_connector *connector); 943 static inline unsigned drm_connector_index(struct drm_connector *connector) 944 { 945 return connector->index; 946 } 947 948 /** 949 * drm_connector_lookup - lookup connector object 950 * @dev: DRM device 951 * @file_priv: drm file to check for lease against. 952 * @id: connector object id 953 * 954 * This function looks up the connector object specified by id 955 * add takes a reference to it. 956 */ 957 static inline struct drm_connector *drm_connector_lookup(struct drm_device *dev, 958 struct drm_file *file_priv, 959 uint32_t id) 960 { 961 struct drm_mode_object *mo; 962 mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_CONNECTOR); 963 return mo ? obj_to_connector(mo) : NULL; 964 } 965 966 /** 967 * drm_connector_get - acquire a connector reference 968 * @connector: DRM connector 969 * 970 * This function increments the connector's refcount. 971 */ 972 static inline void drm_connector_get(struct drm_connector *connector) 973 { 974 drm_mode_object_get(&connector->base); 975 } 976 977 /** 978 * drm_connector_put - release a connector reference 979 * @connector: DRM connector 980 * 981 * This function decrements the connector's reference count and frees the 982 * object if the reference count drops to zero. 983 */ 984 static inline void drm_connector_put(struct drm_connector *connector) 985 { 986 drm_mode_object_put(&connector->base); 987 } 988 989 /** 990 * drm_connector_reference - acquire a connector reference 991 * @connector: DRM connector 992 * 993 * This is a compatibility alias for drm_connector_get() and should not be 994 * used by new code. 995 */ 996 static inline void drm_connector_reference(struct drm_connector *connector) 997 { 998 drm_connector_get(connector); 999 } 1000 1001 /** 1002 * drm_connector_unreference - release a connector reference 1003 * @connector: DRM connector 1004 * 1005 * This is a compatibility alias for drm_connector_put() and should not be 1006 * used by new code. 1007 */ 1008 static inline void drm_connector_unreference(struct drm_connector *connector) 1009 { 1010 drm_connector_put(connector); 1011 } 1012 1013 const char *drm_get_connector_status_name(enum drm_connector_status status); 1014 const char *drm_get_subpixel_order_name(enum subpixel_order order); 1015 const char *drm_get_dpms_name(int val); 1016 const char *drm_get_dvi_i_subconnector_name(int val); 1017 const char *drm_get_dvi_i_select_name(int val); 1018 const char *drm_get_tv_subconnector_name(int val); 1019 const char *drm_get_tv_select_name(int val); 1020 1021 int drm_mode_create_dvi_i_properties(struct drm_device *dev); 1022 int drm_mode_create_tv_properties(struct drm_device *dev, 1023 unsigned int num_modes, 1024 const char * const modes[]); 1025 int drm_mode_create_scaling_mode_property(struct drm_device *dev); 1026 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector, 1027 u32 scaling_mode_mask); 1028 int drm_mode_create_aspect_ratio_property(struct drm_device *dev); 1029 int drm_mode_create_suggested_offset_properties(struct drm_device *dev); 1030 1031 int drm_mode_connector_set_path_property(struct drm_connector *connector, 1032 const char *path); 1033 int drm_mode_connector_set_tile_property(struct drm_connector *connector); 1034 int drm_mode_connector_update_edid_property(struct drm_connector *connector, 1035 const struct edid *edid); 1036 void drm_mode_connector_set_link_status_property(struct drm_connector *connector, 1037 uint64_t link_status); 1038 1039 /** 1040 * struct drm_tile_group - Tile group metadata 1041 * @refcount: reference count 1042 * @dev: DRM device 1043 * @id: tile group id exposed to userspace 1044 * @group_data: Sink-private data identifying this group 1045 * 1046 * @group_data corresponds to displayid vend/prod/serial for external screens 1047 * with an EDID. 1048 */ 1049 struct drm_tile_group { 1050 struct kref refcount; 1051 struct drm_device *dev; 1052 int id; 1053 u8 group_data[8]; 1054 }; 1055 1056 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev, 1057 char topology[8]); 1058 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev, 1059 char topology[8]); 1060 void drm_mode_put_tile_group(struct drm_device *dev, 1061 struct drm_tile_group *tg); 1062 1063 /** 1064 * struct drm_connector_list_iter - connector_list iterator 1065 * 1066 * This iterator tracks state needed to be able to walk the connector_list 1067 * within struct drm_mode_config. Only use together with 1068 * drm_connector_list_iter_begin(), drm_connector_list_iter_end() and 1069 * drm_connector_list_iter_next() respectively the convenience macro 1070 * drm_for_each_connector_iter(). 1071 */ 1072 struct drm_connector_list_iter { 1073 /* private: */ 1074 struct drm_device *dev; 1075 struct drm_connector *conn; 1076 }; 1077 1078 void drm_connector_list_iter_begin(struct drm_device *dev, 1079 struct drm_connector_list_iter *iter); 1080 struct drm_connector * 1081 drm_connector_list_iter_next(struct drm_connector_list_iter *iter); 1082 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter); 1083 1084 /** 1085 * drm_for_each_connector_iter - connector_list iterator macro 1086 * @connector: &struct drm_connector pointer used as cursor 1087 * @iter: &struct drm_connector_list_iter 1088 * 1089 * Note that @connector is only valid within the list body, if you want to use 1090 * @connector after calling drm_connector_list_iter_end() then you need to grab 1091 * your own reference first using drm_connector_get(). 1092 */ 1093 #define drm_for_each_connector_iter(connector, iter) \ 1094 while ((connector = drm_connector_list_iter_next(iter))) 1095 1096 #endif 1097