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