Linux Audio

Check our new training course

Yocto distribution development and maintenance

Need a Yocto distribution for your embedded project?
Loading...
Note: File does not exist in v4.6.
   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#include <drm/drm_util.h>
  32
  33#include <uapi/drm/drm_mode.h>
  34
  35struct drm_connector_helper_funcs;
  36struct drm_modeset_acquire_ctx;
  37struct drm_device;
  38struct drm_crtc;
  39struct drm_encoder;
  40struct drm_property;
  41struct drm_property_blob;
  42struct drm_printer;
  43struct edid;
  44struct i2c_adapter;
  45
  46enum drm_connector_force {
  47	DRM_FORCE_UNSPECIFIED,
  48	DRM_FORCE_OFF,
  49	DRM_FORCE_ON,         /* force on analog part normally */
  50	DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
  51};
  52
  53/**
  54 * enum drm_connector_status - status for a &drm_connector
  55 *
  56 * This enum is used to track the connector status. There are no separate
  57 * #defines for the uapi!
  58 */
  59enum drm_connector_status {
  60	/**
  61	 * @connector_status_connected: The connector is definitely connected to
  62	 * a sink device, and can be enabled.
  63	 */
  64	connector_status_connected = 1,
  65	/**
  66	 * @connector_status_disconnected: The connector isn't connected to a
  67	 * sink device which can be autodetect. For digital outputs like DP or
  68	 * HDMI (which can be realiable probed) this means there's really
  69	 * nothing there. It is driver-dependent whether a connector with this
  70	 * status can be lit up or not.
  71	 */
  72	connector_status_disconnected = 2,
  73	/**
  74	 * @connector_status_unknown: The connector's status could not be
  75	 * reliably detected. This happens when probing would either cause
  76	 * flicker (like load-detection when the connector is in use), or when a
  77	 * hardware resource isn't available (like when load-detection needs a
  78	 * free CRTC). It should be possible to light up the connector with one
  79	 * of the listed fallback modes. For default configuration userspace
  80	 * should only try to light up connectors with unknown status when
  81	 * there's not connector with @connector_status_connected.
  82	 */
  83	connector_status_unknown = 3,
  84};
  85
  86/**
  87 * enum drm_connector_registration_status - userspace registration status for
  88 * a &drm_connector
  89 *
  90 * This enum is used to track the status of initializing a connector and
  91 * registering it with userspace, so that DRM can prevent bogus modesets on
  92 * connectors that no longer exist.
  93 */
  94enum drm_connector_registration_state {
  95	/**
  96	 * @DRM_CONNECTOR_INITIALIZING: The connector has just been created,
  97	 * but has yet to be exposed to userspace. There should be no
  98	 * additional restrictions to how the state of this connector may be
  99	 * modified.
 100	 */
 101	DRM_CONNECTOR_INITIALIZING = 0,
 102
 103	/**
 104	 * @DRM_CONNECTOR_REGISTERED: The connector has been fully initialized
 105	 * and registered with sysfs, as such it has been exposed to
 106	 * userspace. There should be no additional restrictions to how the
 107	 * state of this connector may be modified.
 108	 */
 109	DRM_CONNECTOR_REGISTERED = 1,
 110
 111	/**
 112	 * @DRM_CONNECTOR_UNREGISTERED: The connector has either been exposed
 113	 * to userspace and has since been unregistered and removed from
 114	 * userspace, or the connector was unregistered before it had a chance
 115	 * to be exposed to userspace (e.g. still in the
 116	 * @DRM_CONNECTOR_INITIALIZING state). When a connector is
 117	 * unregistered, there are additional restrictions to how its state
 118	 * may be modified:
 119	 *
 120	 * - An unregistered connector may only have its DPMS changed from
 121	 *   On->Off. Once DPMS is changed to Off, it may not be switched back
 122	 *   to On.
 123	 * - Modesets are not allowed on unregistered connectors, unless they
 124	 *   would result in disabling its assigned CRTCs. This means
 125	 *   disabling a CRTC on an unregistered connector is OK, but enabling
 126	 *   one is not.
 127	 * - Removing a CRTC from an unregistered connector is OK, but new
 128	 *   CRTCs may never be assigned to an unregistered connector.
 129	 */
 130	DRM_CONNECTOR_UNREGISTERED = 2,
 131};
 132
 133enum subpixel_order {
 134	SubPixelUnknown = 0,
 135	SubPixelHorizontalRGB,
 136	SubPixelHorizontalBGR,
 137	SubPixelVerticalRGB,
 138	SubPixelVerticalBGR,
 139	SubPixelNone,
 140
 141};
 142
 143/**
 144 * struct drm_scrambling: sink's scrambling support.
 145 */
 146struct drm_scrambling {
 147	/**
 148	 * @supported: scrambling supported for rates > 340 Mhz.
 149	 */
 150	bool supported;
 151	/**
 152	 * @low_rates: scrambling supported for rates <= 340 Mhz.
 153	 */
 154	bool low_rates;
 155};
 156
 157/*
 158 * struct drm_scdc - Information about scdc capabilities of a HDMI 2.0 sink
 159 *
 160 * Provides SCDC register support and capabilities related information on a
 161 * HDMI 2.0 sink. In case of a HDMI 1.4 sink, all parameter must be 0.
 162 */
 163struct drm_scdc {
 164	/**
 165	 * @supported: status control & data channel present.
 166	 */
 167	bool supported;
 168	/**
 169	 * @read_request: sink is capable of generating scdc read request.
 170	 */
 171	bool read_request;
 172	/**
 173	 * @scrambling: sink's scrambling capabilities
 174	 */
 175	struct drm_scrambling scrambling;
 176};
 177
 178
 179/**
 180 * struct drm_hdmi_info - runtime information about the connected HDMI sink
 181 *
 182 * Describes if a given display supports advanced HDMI 2.0 features.
 183 * This information is available in CEA-861-F extension blocks (like HF-VSDB).
 184 */
 185struct drm_hdmi_info {
 186	/** @scdc: sink's scdc support and capabilities */
 187	struct drm_scdc scdc;
 188
 189	/**
 190	 * @y420_vdb_modes: bitmap of modes which can support ycbcr420
 191	 * output only (not normal RGB/YCBCR444/422 outputs). The max VIC
 192	 * defined by the CEA-861-G spec is 219, so the size is 256 bits to map
 193	 * up to 256 VICs.
 194	 */
 195	unsigned long y420_vdb_modes[BITS_TO_LONGS(256)];
 196
 197	/**
 198	 * @y420_cmdb_modes: bitmap of modes which can support ycbcr420
 199	 * output also, along with normal HDMI outputs. The max VIC defined by
 200	 * the CEA-861-G spec is 219, so the size is 256 bits to map up to 256
 201	 * VICs.
 202	 */
 203	unsigned long y420_cmdb_modes[BITS_TO_LONGS(256)];
 204
 205	/** @y420_cmdb_map: bitmap of SVD index, to extraxt vcb modes */
 206	u64 y420_cmdb_map;
 207
 208	/** @y420_dc_modes: bitmap of deep color support index */
 209	u8 y420_dc_modes;
 210};
 211
 212/**
 213 * enum drm_link_status - connector's link_status property value
 214 *
 215 * This enum is used as the connector's link status property value.
 216 * It is set to the values defined in uapi.
 217 *
 218 * @DRM_LINK_STATUS_GOOD: DP Link is Good as a result of successful
 219 *                        link training
 220 * @DRM_LINK_STATUS_BAD: DP Link is BAD as a result of link training
 221 *                       failure
 222 */
 223enum drm_link_status {
 224	DRM_LINK_STATUS_GOOD = DRM_MODE_LINK_STATUS_GOOD,
 225	DRM_LINK_STATUS_BAD = DRM_MODE_LINK_STATUS_BAD,
 226};
 227
 228/**
 229 * enum drm_panel_orientation - panel_orientation info for &drm_display_info
 230 *
 231 * This enum is used to track the (LCD) panel orientation. There are no
 232 * separate #defines for the uapi!
 233 *
 234 * @DRM_MODE_PANEL_ORIENTATION_UNKNOWN: The drm driver has not provided any
 235 *					panel orientation information (normal
 236 *					for non panels) in this case the "panel
 237 *					orientation" connector prop will not be
 238 *					attached.
 239 * @DRM_MODE_PANEL_ORIENTATION_NORMAL:	The top side of the panel matches the
 240 *					top side of the device's casing.
 241 * @DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP: The top side of the panel matches the
 242 *					bottom side of the device's casing, iow
 243 *					the panel is mounted upside-down.
 244 * @DRM_MODE_PANEL_ORIENTATION_LEFT_UP:	The left side of the panel matches the
 245 *					top side of the device's casing.
 246 * @DRM_MODE_PANEL_ORIENTATION_RIGHT_UP: The right side of the panel matches the
 247 *					top side of the device's casing.
 248 */
 249enum drm_panel_orientation {
 250	DRM_MODE_PANEL_ORIENTATION_UNKNOWN = -1,
 251	DRM_MODE_PANEL_ORIENTATION_NORMAL = 0,
 252	DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP,
 253	DRM_MODE_PANEL_ORIENTATION_LEFT_UP,
 254	DRM_MODE_PANEL_ORIENTATION_RIGHT_UP,
 255};
 256
 257/**
 258 * struct drm_monitor_range_info - Panel's Monitor range in EDID for
 259 * &drm_display_info
 260 *
 261 * This struct is used to store a frequency range supported by panel
 262 * as parsed from EDID's detailed monitor range descriptor block.
 263 *
 264 * @min_vfreq: This is the min supported refresh rate in Hz from
 265 *             EDID's detailed monitor range.
 266 * @max_vfreq: This is the max supported refresh rate in Hz from
 267 *             EDID's detailed monitor range
 268 */
 269struct drm_monitor_range_info {
 270	u8 min_vfreq;
 271	u8 max_vfreq;
 272};
 273
 274/*
 275 * This is a consolidated colorimetry list supported by HDMI and
 276 * DP protocol standard. The respective connectors will register
 277 * a property with the subset of this list (supported by that
 278 * respective protocol). Userspace will set the colorspace through
 279 * a colorspace property which will be created and exposed to
 280 * userspace.
 281 */
 282
 283/* For Default case, driver will set the colorspace */
 284#define DRM_MODE_COLORIMETRY_DEFAULT			0
 285/* CEA 861 Normal Colorimetry options */
 286#define DRM_MODE_COLORIMETRY_NO_DATA			0
 287#define DRM_MODE_COLORIMETRY_SMPTE_170M_YCC		1
 288#define DRM_MODE_COLORIMETRY_BT709_YCC			2
 289/* CEA 861 Extended Colorimetry Options */
 290#define DRM_MODE_COLORIMETRY_XVYCC_601			3
 291#define DRM_MODE_COLORIMETRY_XVYCC_709			4
 292#define DRM_MODE_COLORIMETRY_SYCC_601			5
 293#define DRM_MODE_COLORIMETRY_OPYCC_601			6
 294#define DRM_MODE_COLORIMETRY_OPRGB			7
 295#define DRM_MODE_COLORIMETRY_BT2020_CYCC		8
 296#define DRM_MODE_COLORIMETRY_BT2020_RGB			9
 297#define DRM_MODE_COLORIMETRY_BT2020_YCC			10
 298/* Additional Colorimetry extension added as part of CTA 861.G */
 299#define DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65		11
 300#define DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER		12
 301/* Additional Colorimetry Options added for DP 1.4a VSC Colorimetry Format */
 302#define DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED		13
 303#define DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT		14
 304#define DRM_MODE_COLORIMETRY_BT601_YCC			15
 305
 306/**
 307 * enum drm_bus_flags - bus_flags info for &drm_display_info
 308 *
 309 * This enum defines signal polarities and clock edge information for signals on
 310 * a bus as bitmask flags.
 311 *
 312 * The clock edge information is conveyed by two sets of symbols,
 313 * DRM_BUS_FLAGS_*_DRIVE_\* and DRM_BUS_FLAGS_*_SAMPLE_\*. When this enum is
 314 * used to describe a bus from the point of view of the transmitter, the
 315 * \*_DRIVE_\* flags should be used. When used from the point of view of the
 316 * receiver, the \*_SAMPLE_\* flags should be used. The \*_DRIVE_\* and
 317 * \*_SAMPLE_\* flags alias each other, with the \*_SAMPLE_POSEDGE and
 318 * \*_SAMPLE_NEGEDGE flags being equal to \*_DRIVE_NEGEDGE and \*_DRIVE_POSEDGE
 319 * respectively. This simplifies code as signals are usually sampled on the
 320 * opposite edge of the driving edge. Transmitters and receivers may however
 321 * need to take other signal timings into account to convert between driving
 322 * and sample edges.
 323 */
 324enum drm_bus_flags {
 325	/**
 326	 * @DRM_BUS_FLAG_DE_LOW:
 327	 *
 328	 * The Data Enable signal is active low
 329	 */
 330	DRM_BUS_FLAG_DE_LOW = BIT(0),
 331
 332	/**
 333	 * @DRM_BUS_FLAG_DE_HIGH:
 334	 *
 335	 * The Data Enable signal is active high
 336	 */
 337	DRM_BUS_FLAG_DE_HIGH = BIT(1),
 338
 339	/**
 340	 * @DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE:
 341	 *
 342	 * Data is driven on the rising edge of the pixel clock
 343	 */
 344	DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE = BIT(2),
 345
 346	/**
 347	 * @DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE:
 348	 *
 349	 * Data is driven on the falling edge of the pixel clock
 350	 */
 351	DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE = BIT(3),
 352
 353	/**
 354	 * @DRM_BUS_FLAG_PIXDATA_SAMPLE_POSEDGE:
 355	 *
 356	 * Data is sampled on the rising edge of the pixel clock
 357	 */
 358	DRM_BUS_FLAG_PIXDATA_SAMPLE_POSEDGE = DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE,
 359
 360	/**
 361	 * @DRM_BUS_FLAG_PIXDATA_SAMPLE_NEGEDGE:
 362	 *
 363	 * Data is sampled on the falling edge of the pixel clock
 364	 */
 365	DRM_BUS_FLAG_PIXDATA_SAMPLE_NEGEDGE = DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE,
 366
 367	/**
 368	 * @DRM_BUS_FLAG_DATA_MSB_TO_LSB:
 369	 *
 370	 * Data is transmitted MSB to LSB on the bus
 371	 */
 372	DRM_BUS_FLAG_DATA_MSB_TO_LSB = BIT(4),
 373
 374	/**
 375	 * @DRM_BUS_FLAG_DATA_LSB_TO_MSB:
 376	 *
 377	 * Data is transmitted LSB to MSB on the bus
 378	 */
 379	DRM_BUS_FLAG_DATA_LSB_TO_MSB = BIT(5),
 380
 381	/**
 382	 * @DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE:
 383	 *
 384	 * Sync signals are driven on the rising edge of the pixel clock
 385	 */
 386	DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE = BIT(6),
 387
 388	/**
 389	 * @DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE:
 390	 *
 391	 * Sync signals are driven on the falling edge of the pixel clock
 392	 */
 393	DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE = BIT(7),
 394
 395	/**
 396	 * @DRM_BUS_FLAG_SYNC_SAMPLE_POSEDGE:
 397	 *
 398	 * Sync signals are sampled on the rising edge of the pixel clock
 399	 */
 400	DRM_BUS_FLAG_SYNC_SAMPLE_POSEDGE = DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE,
 401
 402	/**
 403	 * @DRM_BUS_FLAG_SYNC_SAMPLE_NEGEDGE:
 404	 *
 405	 * Sync signals are sampled on the falling edge of the pixel clock
 406	 */
 407	DRM_BUS_FLAG_SYNC_SAMPLE_NEGEDGE = DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE,
 408
 409	/**
 410	 * @DRM_BUS_FLAG_SHARP_SIGNALS:
 411	 *
 412	 *  Set if the Sharp-specific signals (SPL, CLS, PS, REV) must be used
 413	 */
 414	DRM_BUS_FLAG_SHARP_SIGNALS = BIT(8),
 415};
 416
 417/**
 418 * struct drm_display_info - runtime data about the connected sink
 419 *
 420 * Describes a given display (e.g. CRT or flat panel) and its limitations. For
 421 * fixed display sinks like built-in panels there's not much difference between
 422 * this and &struct drm_connector. But for sinks with a real cable this
 423 * structure is meant to describe all the things at the other end of the cable.
 424 *
 425 * For sinks which provide an EDID this can be filled out by calling
 426 * drm_add_edid_modes().
 427 */
 428struct drm_display_info {
 429	/**
 430	 * @width_mm: Physical width in mm.
 431	 */
 432	unsigned int width_mm;
 433
 434	/**
 435	 * @height_mm: Physical height in mm.
 436	 */
 437	unsigned int height_mm;
 438
 439	/**
 440	 * @bpc: Maximum bits per color channel. Used by HDMI and DP outputs.
 441	 */
 442	unsigned int bpc;
 443
 444	/**
 445	 * @subpixel_order: Subpixel order of LCD panels.
 446	 */
 447	enum subpixel_order subpixel_order;
 448
 449#define DRM_COLOR_FORMAT_RGB444		(1<<0)
 450#define DRM_COLOR_FORMAT_YCRCB444	(1<<1)
 451#define DRM_COLOR_FORMAT_YCRCB422	(1<<2)
 452#define DRM_COLOR_FORMAT_YCRCB420	(1<<3)
 453
 454	/**
 455	 * @panel_orientation: Read only connector property for built-in panels,
 456	 * indicating the orientation of the panel vs the device's casing.
 457	 * drm_connector_init() sets this to DRM_MODE_PANEL_ORIENTATION_UNKNOWN.
 458	 * When not UNKNOWN this gets used by the drm_fb_helpers to rotate the
 459	 * fb to compensate and gets exported as prop to userspace.
 460	 */
 461	int panel_orientation;
 462
 463	/**
 464	 * @color_formats: HDMI Color formats, selects between RGB and YCrCb
 465	 * modes. Used DRM_COLOR_FORMAT\_ defines, which are _not_ the same ones
 466	 * as used to describe the pixel format in framebuffers, and also don't
 467	 * match the formats in @bus_formats which are shared with v4l.
 468	 */
 469	u32 color_formats;
 470
 471	/**
 472	 * @bus_formats: Pixel data format on the wire, somewhat redundant with
 473	 * @color_formats. Array of size @num_bus_formats encoded using
 474	 * MEDIA_BUS_FMT\_ defines shared with v4l and media drivers.
 475	 */
 476	const u32 *bus_formats;
 477	/**
 478	 * @num_bus_formats: Size of @bus_formats array.
 479	 */
 480	unsigned int num_bus_formats;
 481
 482	/**
 483	 * @bus_flags: Additional information (like pixel signal polarity) for
 484	 * the pixel data on the bus, using &enum drm_bus_flags values
 485	 * DRM_BUS_FLAGS\_.
 486	 */
 487	u32 bus_flags;
 488
 489	/**
 490	 * @max_tmds_clock: Maximum TMDS clock rate supported by the
 491	 * sink in kHz. 0 means undefined.
 492	 */
 493	int max_tmds_clock;
 494
 495	/**
 496	 * @dvi_dual: Dual-link DVI sink?
 497	 */
 498	bool dvi_dual;
 499
 500	/**
 501	 * @is_hdmi: True if the sink is an HDMI device.
 502	 *
 503	 * This field shall be used instead of calling
 504	 * drm_detect_hdmi_monitor() when possible.
 505	 */
 506	bool is_hdmi;
 507
 508	/**
 509	 * @has_hdmi_infoframe: Does the sink support the HDMI infoframe?
 510	 */
 511	bool has_hdmi_infoframe;
 512
 513	/**
 514	 * @rgb_quant_range_selectable: Does the sink support selecting
 515	 * the RGB quantization range?
 516	 */
 517	bool rgb_quant_range_selectable;
 518
 519	/**
 520	 * @edid_hdmi_dc_modes: Mask of supported hdmi deep color modes. Even
 521	 * more stuff redundant with @bus_formats.
 522	 */
 523	u8 edid_hdmi_dc_modes;
 524
 525	/**
 526	 * @cea_rev: CEA revision of the HDMI sink.
 527	 */
 528	u8 cea_rev;
 529
 530	/**
 531	 * @hdmi: advance features of a HDMI sink.
 532	 */
 533	struct drm_hdmi_info hdmi;
 534
 535	/**
 536	 * @non_desktop: Non desktop display (HMD).
 537	 */
 538	bool non_desktop;
 539
 540	/**
 541	 * @monitor_range: Frequency range supported by monitor range descriptor
 542	 */
 543	struct drm_monitor_range_info monitor_range;
 544};
 545
 546int drm_display_info_set_bus_formats(struct drm_display_info *info,
 547				     const u32 *formats,
 548				     unsigned int num_formats);
 549
 550/**
 551 * struct drm_connector_tv_margins - TV connector related margins
 552 *
 553 * Describes the margins in pixels to put around the image on TV
 554 * connectors to deal with overscan.
 555 */
 556struct drm_connector_tv_margins {
 557	/**
 558	 * @bottom: Bottom margin in pixels.
 559	 */
 560	unsigned int bottom;
 561
 562	/**
 563	 * @left: Left margin in pixels.
 564	 */
 565	unsigned int left;
 566
 567	/**
 568	 * @right: Right margin in pixels.
 569	 */
 570	unsigned int right;
 571
 572	/**
 573	 * @top: Top margin in pixels.
 574	 */
 575	unsigned int top;
 576};
 577
 578/**
 579 * struct drm_tv_connector_state - TV connector related states
 580 * @subconnector: selected subconnector
 581 * @margins: TV margins
 582 * @mode: TV mode
 583 * @brightness: brightness in percent
 584 * @contrast: contrast in percent
 585 * @flicker_reduction: flicker reduction in percent
 586 * @overscan: overscan in percent
 587 * @saturation: saturation in percent
 588 * @hue: hue in percent
 589 */
 590struct drm_tv_connector_state {
 591	enum drm_mode_subconnector subconnector;
 592	struct drm_connector_tv_margins margins;
 593	unsigned int mode;
 594	unsigned int brightness;
 595	unsigned int contrast;
 596	unsigned int flicker_reduction;
 597	unsigned int overscan;
 598	unsigned int saturation;
 599	unsigned int hue;
 600};
 601
 602/**
 603 * struct drm_connector_state - mutable connector state
 604 */
 605struct drm_connector_state {
 606	/** @connector: backpointer to the connector */
 607	struct drm_connector *connector;
 608
 609	/**
 610	 * @crtc: CRTC to connect connector to, NULL if disabled.
 611	 *
 612	 * Do not change this directly, use drm_atomic_set_crtc_for_connector()
 613	 * instead.
 614	 */
 615	struct drm_crtc *crtc;
 616
 617	/**
 618	 * @best_encoder:
 619	 *
 620	 * Used by the atomic helpers to select the encoder, through the
 621	 * &drm_connector_helper_funcs.atomic_best_encoder or
 622	 * &drm_connector_helper_funcs.best_encoder callbacks.
 623	 *
 624	 * This is also used in the atomic helpers to map encoders to their
 625	 * current and previous connectors, see
 626	 * drm_atomic_get_old_connector_for_encoder() and
 627	 * drm_atomic_get_new_connector_for_encoder().
 628	 *
 629	 * NOTE: Atomic drivers must fill this out (either themselves or through
 630	 * helpers), for otherwise the GETCONNECTOR and GETENCODER IOCTLs will
 631	 * not return correct data to userspace.
 632	 */
 633	struct drm_encoder *best_encoder;
 634
 635	/**
 636	 * @link_status: Connector link_status to keep track of whether link is
 637	 * GOOD or BAD to notify userspace if retraining is necessary.
 638	 */
 639	enum drm_link_status link_status;
 640
 641	/** @state: backpointer to global drm_atomic_state */
 642	struct drm_atomic_state *state;
 643
 644	/**
 645	 * @commit: Tracks the pending commit to prevent use-after-free conditions.
 646	 *
 647	 * Is only set when @crtc is NULL.
 648	 */
 649	struct drm_crtc_commit *commit;
 650
 651	/** @tv: TV connector state */
 652	struct drm_tv_connector_state tv;
 653
 654	/**
 655	 * @self_refresh_aware:
 656	 *
 657	 * This tracks whether a connector is aware of the self refresh state.
 658	 * It should be set to true for those connector implementations which
 659	 * understand the self refresh state. This is needed since the crtc
 660	 * registers the self refresh helpers and it doesn't know if the
 661	 * connectors downstream have implemented self refresh entry/exit.
 662	 *
 663	 * Drivers should set this to true in atomic_check if they know how to
 664	 * handle self_refresh requests.
 665	 */
 666	bool self_refresh_aware;
 667
 668	/**
 669	 * @picture_aspect_ratio: Connector property to control the
 670	 * HDMI infoframe aspect ratio setting.
 671	 *
 672	 * The %DRM_MODE_PICTURE_ASPECT_\* values much match the
 673	 * values for &enum hdmi_picture_aspect
 674	 */
 675	enum hdmi_picture_aspect picture_aspect_ratio;
 676
 677	/**
 678	 * @content_type: Connector property to control the
 679	 * HDMI infoframe content type setting.
 680	 * The %DRM_MODE_CONTENT_TYPE_\* values much
 681	 * match the values.
 682	 */
 683	unsigned int content_type;
 684
 685	/**
 686	 * @hdcp_content_type: Connector property to pass the type of
 687	 * protected content. This is most commonly used for HDCP.
 688	 */
 689	unsigned int hdcp_content_type;
 690
 691	/**
 692	 * @scaling_mode: Connector property to control the
 693	 * upscaling, mostly used for built-in panels.
 694	 */
 695	unsigned int scaling_mode;
 696
 697	/**
 698	 * @content_protection: Connector property to request content
 699	 * protection. This is most commonly used for HDCP.
 700	 */
 701	unsigned int content_protection;
 702
 703	/**
 704	 * @colorspace: State variable for Connector property to request
 705	 * colorspace change on Sink. This is most commonly used to switch
 706	 * to wider color gamuts like BT2020.
 707	 */
 708	u32 colorspace;
 709
 710	/**
 711	 * @writeback_job: Writeback job for writeback connectors
 712	 *
 713	 * Holds the framebuffer and out-fence for a writeback connector. As
 714	 * the writeback completion may be asynchronous to the normal commit
 715	 * cycle, the writeback job lifetime is managed separately from the
 716	 * normal atomic state by this object.
 717	 *
 718	 * See also: drm_writeback_queue_job() and
 719	 * drm_writeback_signal_completion()
 720	 */
 721	struct drm_writeback_job *writeback_job;
 722
 723	/**
 724	 * @max_requested_bpc: Connector property to limit the maximum bit
 725	 * depth of the pixels.
 726	 */
 727	u8 max_requested_bpc;
 728
 729	/**
 730	 * @max_bpc: Connector max_bpc based on the requested max_bpc property
 731	 * and the connector bpc limitations obtained from edid.
 732	 */
 733	u8 max_bpc;
 734
 735	/**
 736	 * @hdr_output_metadata:
 737	 * DRM blob property for HDR output metadata
 738	 */
 739	struct drm_property_blob *hdr_output_metadata;
 740};
 741
 742/**
 743 * struct drm_connector_funcs - control connectors on a given device
 744 *
 745 * Each CRTC may have one or more connectors attached to it.  The functions
 746 * below allow the core DRM code to control connectors, enumerate available modes,
 747 * etc.
 748 */
 749struct drm_connector_funcs {
 750	/**
 751	 * @dpms:
 752	 *
 753	 * Legacy entry point to set the per-connector DPMS state. Legacy DPMS
 754	 * is exposed as a standard property on the connector, but diverted to
 755	 * this callback in the drm core. Note that atomic drivers don't
 756	 * implement the 4 level DPMS support on the connector any more, but
 757	 * instead only have an on/off "ACTIVE" property on the CRTC object.
 758	 *
 759	 * This hook is not used by atomic drivers, remapping of the legacy DPMS
 760	 * property is entirely handled in the DRM core.
 761	 *
 762	 * RETURNS:
 763	 *
 764	 * 0 on success or a negative error code on failure.
 765	 */
 766	int (*dpms)(struct drm_connector *connector, int mode);
 767
 768	/**
 769	 * @reset:
 770	 *
 771	 * Reset connector hardware and software state to off. This function isn't
 772	 * called by the core directly, only through drm_mode_config_reset().
 773	 * It's not a helper hook only for historical reasons.
 774	 *
 775	 * Atomic drivers can use drm_atomic_helper_connector_reset() to reset
 776	 * atomic state using this hook.
 777	 */
 778	void (*reset)(struct drm_connector *connector);
 779
 780	/**
 781	 * @detect:
 782	 *
 783	 * Check to see if anything is attached to the connector. The parameter
 784	 * force is set to false whilst polling, true when checking the
 785	 * connector due to a user request. force can be used by the driver to
 786	 * avoid expensive, destructive operations during automated probing.
 787	 *
 788	 * This callback is optional, if not implemented the connector will be
 789	 * considered as always being attached.
 790	 *
 791	 * FIXME:
 792	 *
 793	 * Note that this hook is only called by the probe helper. It's not in
 794	 * the helper library vtable purely for historical reasons. The only DRM
 795	 * core	entry point to probe connector state is @fill_modes.
 796	 *
 797	 * Note that the helper library will already hold
 798	 * &drm_mode_config.connection_mutex. Drivers which need to grab additional
 799	 * locks to avoid races with concurrent modeset changes need to use
 800	 * &drm_connector_helper_funcs.detect_ctx instead.
 801	 *
 802	 * RETURNS:
 803	 *
 804	 * drm_connector_status indicating the connector's status.
 805	 */
 806	enum drm_connector_status (*detect)(struct drm_connector *connector,
 807					    bool force);
 808
 809	/**
 810	 * @force:
 811	 *
 812	 * This function is called to update internal encoder state when the
 813	 * connector is forced to a certain state by userspace, either through
 814	 * the sysfs interfaces or on the kernel cmdline. In that case the
 815	 * @detect callback isn't called.
 816	 *
 817	 * FIXME:
 818	 *
 819	 * Note that this hook is only called by the probe helper. It's not in
 820	 * the helper library vtable purely for historical reasons. The only DRM
 821	 * core	entry point to probe connector state is @fill_modes.
 822	 */
 823	void (*force)(struct drm_connector *connector);
 824
 825	/**
 826	 * @fill_modes:
 827	 *
 828	 * Entry point for output detection and basic mode validation. The
 829	 * driver should reprobe the output if needed (e.g. when hotplug
 830	 * handling is unreliable), add all detected modes to &drm_connector.modes
 831	 * and filter out any the device can't support in any configuration. It
 832	 * also needs to filter out any modes wider or higher than the
 833	 * parameters max_width and max_height indicate.
 834	 *
 835	 * The drivers must also prune any modes no longer valid from
 836	 * &drm_connector.modes. Furthermore it must update
 837	 * &drm_connector.status and &drm_connector.edid.  If no EDID has been
 838	 * received for this output connector->edid must be NULL.
 839	 *
 840	 * Drivers using the probe helpers should use
 841	 * drm_helper_probe_single_connector_modes() to implement this
 842	 * function.
 843	 *
 844	 * RETURNS:
 845	 *
 846	 * The number of modes detected and filled into &drm_connector.modes.
 847	 */
 848	int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
 849
 850	/**
 851	 * @set_property:
 852	 *
 853	 * This is the legacy entry point to update a property attached to the
 854	 * connector.
 855	 *
 856	 * This callback is optional if the driver does not support any legacy
 857	 * driver-private properties. For atomic drivers it is not used because
 858	 * property handling is done entirely in the DRM core.
 859	 *
 860	 * RETURNS:
 861	 *
 862	 * 0 on success or a negative error code on failure.
 863	 */
 864	int (*set_property)(struct drm_connector *connector, struct drm_property *property,
 865			     uint64_t val);
 866
 867	/**
 868	 * @late_register:
 869	 *
 870	 * This optional hook can be used to register additional userspace
 871	 * interfaces attached to the connector, light backlight control, i2c,
 872	 * DP aux or similar interfaces. It is called late in the driver load
 873	 * sequence from drm_connector_register() when registering all the
 874	 * core drm connector interfaces. Everything added from this callback
 875	 * should be unregistered in the early_unregister callback.
 876	 *
 877	 * This is called while holding &drm_connector.mutex.
 878	 *
 879	 * Returns:
 880	 *
 881	 * 0 on success, or a negative error code on failure.
 882	 */
 883	int (*late_register)(struct drm_connector *connector);
 884
 885	/**
 886	 * @early_unregister:
 887	 *
 888	 * This optional hook should be used to unregister the additional
 889	 * userspace interfaces attached to the connector from
 890	 * late_register(). It is called from drm_connector_unregister(),
 891	 * early in the driver unload sequence to disable userspace access
 892	 * before data structures are torndown.
 893	 *
 894	 * This is called while holding &drm_connector.mutex.
 895	 */
 896	void (*early_unregister)(struct drm_connector *connector);
 897
 898	/**
 899	 * @destroy:
 900	 *
 901	 * Clean up connector resources. This is called at driver unload time
 902	 * through drm_mode_config_cleanup(). It can also be called at runtime
 903	 * when a connector is being hot-unplugged for drivers that support
 904	 * connector hotplugging (e.g. DisplayPort MST).
 905	 */
 906	void (*destroy)(struct drm_connector *connector);
 907
 908	/**
 909	 * @atomic_duplicate_state:
 910	 *
 911	 * Duplicate the current atomic state for this connector and return it.
 912	 * The core and helpers guarantee that any atomic state duplicated with
 913	 * this hook and still owned by the caller (i.e. not transferred to the
 914	 * driver by calling &drm_mode_config_funcs.atomic_commit) will be
 915	 * cleaned up by calling the @atomic_destroy_state hook in this
 916	 * structure.
 917	 *
 918	 * This callback is mandatory for atomic drivers.
 919	 *
 920	 * Atomic drivers which don't subclass &struct drm_connector_state should use
 921	 * drm_atomic_helper_connector_duplicate_state(). Drivers that subclass the
 922	 * state structure to extend it with driver-private state should use
 923	 * __drm_atomic_helper_connector_duplicate_state() to make sure shared state is
 924	 * duplicated in a consistent fashion across drivers.
 925	 *
 926	 * It is an error to call this hook before &drm_connector.state has been
 927	 * initialized correctly.
 928	 *
 929	 * NOTE:
 930	 *
 931	 * If the duplicate state references refcounted resources this hook must
 932	 * acquire a reference for each of them. The driver must release these
 933	 * references again in @atomic_destroy_state.
 934	 *
 935	 * RETURNS:
 936	 *
 937	 * Duplicated atomic state or NULL when the allocation failed.
 938	 */
 939	struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector);
 940
 941	/**
 942	 * @atomic_destroy_state:
 943	 *
 944	 * Destroy a state duplicated with @atomic_duplicate_state and release
 945	 * or unreference all resources it references
 946	 *
 947	 * This callback is mandatory for atomic drivers.
 948	 */
 949	void (*atomic_destroy_state)(struct drm_connector *connector,
 950				     struct drm_connector_state *state);
 951
 952	/**
 953	 * @atomic_set_property:
 954	 *
 955	 * Decode a driver-private property value and store the decoded value
 956	 * into the passed-in state structure. Since the atomic core decodes all
 957	 * standardized properties (even for extensions beyond the core set of
 958	 * properties which might not be implemented by all drivers) this
 959	 * requires drivers to subclass the state structure.
 960	 *
 961	 * Such driver-private properties should really only be implemented for
 962	 * truly hardware/vendor specific state. Instead it is preferred to
 963	 * standardize atomic extension and decode the properties used to expose
 964	 * such an extension in the core.
 965	 *
 966	 * Do not call this function directly, use
 967	 * drm_atomic_connector_set_property() instead.
 968	 *
 969	 * This callback is optional if the driver does not support any
 970	 * driver-private atomic properties.
 971	 *
 972	 * NOTE:
 973	 *
 974	 * This function is called in the state assembly phase of atomic
 975	 * modesets, which can be aborted for any reason (including on
 976	 * userspace's request to just check whether a configuration would be
 977	 * possible). Drivers MUST NOT touch any persistent state (hardware or
 978	 * software) or data structures except the passed in @state parameter.
 979	 *
 980	 * Also since userspace controls in which order properties are set this
 981	 * function must not do any input validation (since the state update is
 982	 * incomplete and hence likely inconsistent). Instead any such input
 983	 * validation must be done in the various atomic_check callbacks.
 984	 *
 985	 * RETURNS:
 986	 *
 987	 * 0 if the property has been found, -EINVAL if the property isn't
 988	 * implemented by the driver (which shouldn't ever happen, the core only
 989	 * asks for properties attached to this connector). No other validation
 990	 * is allowed by the driver. The core already checks that the property
 991	 * value is within the range (integer, valid enum value, ...) the driver
 992	 * set when registering the property.
 993	 */
 994	int (*atomic_set_property)(struct drm_connector *connector,
 995				   struct drm_connector_state *state,
 996				   struct drm_property *property,
 997				   uint64_t val);
 998
 999	/**
1000	 * @atomic_get_property:
1001	 *
1002	 * Reads out the decoded driver-private property. This is used to
1003	 * implement the GETCONNECTOR IOCTL.
1004	 *
1005	 * Do not call this function directly, use
1006	 * drm_atomic_connector_get_property() instead.
1007	 *
1008	 * This callback is optional if the driver does not support any
1009	 * driver-private atomic properties.
1010	 *
1011	 * RETURNS:
1012	 *
1013	 * 0 on success, -EINVAL if the property isn't implemented by the
1014	 * driver (which shouldn't ever happen, the core only asks for
1015	 * properties attached to this connector).
1016	 */
1017	int (*atomic_get_property)(struct drm_connector *connector,
1018				   const struct drm_connector_state *state,
1019				   struct drm_property *property,
1020				   uint64_t *val);
1021
1022	/**
1023	 * @atomic_print_state:
1024	 *
1025	 * If driver subclasses &struct drm_connector_state, it should implement
1026	 * this optional hook for printing additional driver specific state.
1027	 *
1028	 * Do not call this directly, use drm_atomic_connector_print_state()
1029	 * instead.
1030	 */
1031	void (*atomic_print_state)(struct drm_printer *p,
1032				   const struct drm_connector_state *state);
1033};
1034
1035/**
1036 * struct drm_cmdline_mode - DRM Mode passed through the kernel command-line
1037 *
1038 * Each connector can have an initial mode with additional options
1039 * passed through the kernel command line. This structure allows to
1040 * express those parameters and will be filled by the command-line
1041 * parser.
1042 */
1043struct drm_cmdline_mode {
1044	/**
1045	 * @name:
1046	 *
1047	 * Name of the mode.
1048	 */
1049	char name[DRM_DISPLAY_MODE_LEN];
1050
1051	/**
1052	 * @specified:
1053	 *
1054	 * Has a mode been read from the command-line?
1055	 */
1056	bool specified;
1057
1058	/**
1059	 * @refresh_specified:
1060	 *
1061	 * Did the mode have a preferred refresh rate?
1062	 */
1063	bool refresh_specified;
1064
1065	/**
1066	 * @bpp_specified:
1067	 *
1068	 * Did the mode have a preferred BPP?
1069	 */
1070	bool bpp_specified;
1071
1072	/**
1073	 * @xres:
1074	 *
1075	 * Active resolution on the X axis, in pixels.
1076	 */
1077	int xres;
1078
1079	/**
1080	 * @yres:
1081	 *
1082	 * Active resolution on the Y axis, in pixels.
1083	 */
1084	int yres;
1085
1086	/**
1087	 * @bpp:
1088	 *
1089	 * Bits per pixels for the mode.
1090	 */
1091	int bpp;
1092
1093	/**
1094	 * @refresh:
1095	 *
1096	 * Refresh rate, in Hertz.
1097	 */
1098	int refresh;
1099
1100	/**
1101	 * @rb:
1102	 *
1103	 * Do we need to use reduced blanking?
1104	 */
1105	bool rb;
1106
1107	/**
1108	 * @interlace:
1109	 *
1110	 * The mode is interlaced.
1111	 */
1112	bool interlace;
1113
1114	/**
1115	 * @cvt:
1116	 *
1117	 * The timings will be calculated using the VESA Coordinated
1118	 * Video Timings instead of looking up the mode from a table.
1119	 */
1120	bool cvt;
1121
1122	/**
1123	 * @margins:
1124	 *
1125	 * Add margins to the mode calculation (1.8% of xres rounded
1126	 * down to 8 pixels and 1.8% of yres).
1127	 */
1128	bool margins;
1129
1130	/**
1131	 * @force:
1132	 *
1133	 * Ignore the hotplug state of the connector, and force its
1134	 * state to one of the DRM_FORCE_* values.
1135	 */
1136	enum drm_connector_force force;
1137
1138	/**
1139	 * @rotation_reflection:
1140	 *
1141	 * Initial rotation and reflection of the mode setup from the
1142	 * command line. See DRM_MODE_ROTATE_* and
1143	 * DRM_MODE_REFLECT_*. The only rotations supported are
1144	 * DRM_MODE_ROTATE_0 and DRM_MODE_ROTATE_180.
1145	 */
1146	unsigned int rotation_reflection;
1147
1148	/**
1149	 * @panel_orientation:
1150	 *
1151	 * drm-connector "panel orientation" property override value,
1152	 * DRM_MODE_PANEL_ORIENTATION_UNKNOWN if not set.
1153	 */
1154	enum drm_panel_orientation panel_orientation;
1155
1156	/**
1157	 * @tv_margins: TV margins to apply to the mode.
1158	 */
1159	struct drm_connector_tv_margins tv_margins;
1160};
1161
1162/**
1163 * struct drm_connector - central DRM connector control structure
1164 *
1165 * Each connector may be connected to one or more CRTCs, or may be clonable by
1166 * another connector if they can share a CRTC.  Each connector also has a specific
1167 * position in the broader display (referred to as a 'screen' though it could
1168 * span multiple monitors).
1169 */
1170struct drm_connector {
1171	/** @dev: parent DRM device */
1172	struct drm_device *dev;
1173	/** @kdev: kernel device for sysfs attributes */
1174	struct device *kdev;
1175	/** @attr: sysfs attributes */
1176	struct device_attribute *attr;
1177
1178	/**
1179	 * @head:
1180	 *
1181	 * List of all connectors on a @dev, linked from
1182	 * &drm_mode_config.connector_list. Protected by
1183	 * &drm_mode_config.connector_list_lock, but please only use
1184	 * &drm_connector_list_iter to walk this list.
1185	 */
1186	struct list_head head;
1187
1188	/** @base: base KMS object */
1189	struct drm_mode_object base;
1190
1191	/** @name: human readable name, can be overwritten by the driver */
1192	char *name;
1193
1194	/**
1195	 * @mutex: Lock for general connector state, but currently only protects
1196	 * @registered. Most of the connector state is still protected by
1197	 * &drm_mode_config.mutex.
1198	 */
1199	struct mutex mutex;
1200
1201	/**
1202	 * @index: Compacted connector index, which matches the position inside
1203	 * the mode_config.list for drivers not supporting hot-add/removing. Can
1204	 * be used as an array index. It is invariant over the lifetime of the
1205	 * connector.
1206	 */
1207	unsigned index;
1208
1209	/**
1210	 * @connector_type:
1211	 * one of the DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
1212	 */
1213	int connector_type;
1214	/** @connector_type_id: index into connector type enum */
1215	int connector_type_id;
1216	/**
1217	 * @interlace_allowed:
1218	 * Can this connector handle interlaced modes? Only used by
1219	 * drm_helper_probe_single_connector_modes() for mode filtering.
1220	 */
1221	bool interlace_allowed;
1222	/**
1223	 * @doublescan_allowed:
1224	 * Can this connector handle doublescan? Only used by
1225	 * drm_helper_probe_single_connector_modes() for mode filtering.
1226	 */
1227	bool doublescan_allowed;
1228	/**
1229	 * @stereo_allowed:
1230	 * Can this connector handle stereo modes? Only used by
1231	 * drm_helper_probe_single_connector_modes() for mode filtering.
1232	 */
1233	bool stereo_allowed;
1234
1235	/**
1236	 * @ycbcr_420_allowed : This bool indicates if this connector is
1237	 * capable of handling YCBCR 420 output. While parsing the EDID
1238	 * blocks it's very helpful to know if the source is capable of
1239	 * handling YCBCR 420 outputs.
1240	 */
1241	bool ycbcr_420_allowed;
1242
1243	/**
1244	 * @registration_state: Is this connector initializing, exposed
1245	 * (registered) with userspace, or unregistered?
1246	 *
1247	 * Protected by @mutex.
1248	 */
1249	enum drm_connector_registration_state registration_state;
1250
1251	/**
1252	 * @modes:
1253	 * Modes available on this connector (from fill_modes() + user).
1254	 * Protected by &drm_mode_config.mutex.
1255	 */
1256	struct list_head modes;
1257
1258	/**
1259	 * @status:
1260	 * One of the drm_connector_status enums (connected, not, or unknown).
1261	 * Protected by &drm_mode_config.mutex.
1262	 */
1263	enum drm_connector_status status;
1264
1265	/**
1266	 * @probed_modes:
1267	 * These are modes added by probing with DDC or the BIOS, before
1268	 * filtering is applied. Used by the probe helpers. Protected by
1269	 * &drm_mode_config.mutex.
1270	 */
1271	struct list_head probed_modes;
1272
1273	/**
1274	 * @display_info: Display information is filled from EDID information
1275	 * when a display is detected. For non hot-pluggable displays such as
1276	 * flat panels in embedded systems, the driver should initialize the
1277	 * &drm_display_info.width_mm and &drm_display_info.height_mm fields
1278	 * with the physical size of the display.
1279	 *
1280	 * Protected by &drm_mode_config.mutex.
1281	 */
1282	struct drm_display_info display_info;
1283
1284	/** @funcs: connector control functions */
1285	const struct drm_connector_funcs *funcs;
1286
1287	/**
1288	 * @edid_blob_ptr: DRM property containing EDID if present. Protected by
1289	 * &drm_mode_config.mutex. This should be updated only by calling
1290	 * drm_connector_update_edid_property().
1291	 */
1292	struct drm_property_blob *edid_blob_ptr;
1293
1294	/** @properties: property tracking for this connector */
1295	struct drm_object_properties properties;
1296
1297	/**
1298	 * @scaling_mode_property: Optional atomic property to control the
1299	 * upscaling. See drm_connector_attach_content_protection_property().
1300	 */
1301	struct drm_property *scaling_mode_property;
1302
1303	/**
1304	 * @vrr_capable_property: Optional property to help userspace
1305	 * query hardware support for variable refresh rate on a connector.
1306	 * connector. Drivers can add the property to a connector by
1307	 * calling drm_connector_attach_vrr_capable_property().
1308	 *
1309	 * This should be updated only by calling
1310	 * drm_connector_set_vrr_capable_property().
1311	 */
1312	struct drm_property *vrr_capable_property;
1313
1314	/**
1315	 * @colorspace_property: Connector property to set the suitable
1316	 * colorspace supported by the sink.
1317	 */
1318	struct drm_property *colorspace_property;
1319
1320	/**
1321	 * @path_blob_ptr:
1322	 *
1323	 * DRM blob property data for the DP MST path property. This should only
1324	 * be updated by calling drm_connector_set_path_property().
1325	 */
1326	struct drm_property_blob *path_blob_ptr;
1327
1328	/**
1329	 * @max_bpc_property: Default connector property for the max bpc to be
1330	 * driven out of the connector.
1331	 */
1332	struct drm_property *max_bpc_property;
1333
1334#define DRM_CONNECTOR_POLL_HPD (1 << 0)
1335#define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
1336#define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
1337
1338	/**
1339	 * @polled:
1340	 *
1341	 * Connector polling mode, a combination of
1342	 *
1343	 * DRM_CONNECTOR_POLL_HPD
1344	 *     The connector generates hotplug events and doesn't need to be
1345	 *     periodically polled. The CONNECT and DISCONNECT flags must not
1346	 *     be set together with the HPD flag.
1347	 *
1348	 * DRM_CONNECTOR_POLL_CONNECT
1349	 *     Periodically poll the connector for connection.
1350	 *
1351	 * DRM_CONNECTOR_POLL_DISCONNECT
1352	 *     Periodically poll the connector for disconnection, without
1353	 *     causing flickering even when the connector is in use. DACs should
1354	 *     rarely do this without a lot of testing.
1355	 *
1356	 * Set to 0 for connectors that don't support connection status
1357	 * discovery.
1358	 */
1359	uint8_t polled;
1360
1361	/**
1362	 * @dpms: Current dpms state. For legacy drivers the
1363	 * &drm_connector_funcs.dpms callback must update this. For atomic
1364	 * drivers, this is handled by the core atomic code, and drivers must
1365	 * only take &drm_crtc_state.active into account.
1366	 */
1367	int dpms;
1368
1369	/** @helper_private: mid-layer private data */
1370	const struct drm_connector_helper_funcs *helper_private;
1371
1372	/** @cmdline_mode: mode line parsed from the kernel cmdline for this connector */
1373	struct drm_cmdline_mode cmdline_mode;
1374	/** @force: a DRM_FORCE_<foo> state for forced mode sets */
1375	enum drm_connector_force force;
1376	/** @override_edid: has the EDID been overwritten through debugfs for testing? */
1377	bool override_edid;
1378	/** @epoch_counter: used to detect any other changes in connector, besides status */
1379	u64 epoch_counter;
1380
1381	/**
1382	 * @possible_encoders: Bit mask of encoders that can drive this
1383	 * connector, drm_encoder_index() determines the index into the bitfield
1384	 * and the bits are set with drm_connector_attach_encoder().
1385	 */
1386	u32 possible_encoders;
1387
1388	/**
1389	 * @encoder: Currently bound encoder driving this connector, if any.
1390	 * Only really meaningful for non-atomic drivers. Atomic drivers should
1391	 * instead look at &drm_connector_state.best_encoder, and in case they
1392	 * need the CRTC driving this output, &drm_connector_state.crtc.
1393	 */
1394	struct drm_encoder *encoder;
1395
1396#define MAX_ELD_BYTES	128
1397	/** @eld: EDID-like data, if present */
1398	uint8_t eld[MAX_ELD_BYTES];
1399	/** @latency_present: AV delay info from ELD, if found */
1400	bool latency_present[2];
1401	/**
1402	 * @video_latency: Video latency info from ELD, if found.
1403	 * [0]: progressive, [1]: interlaced
1404	 */
1405	int video_latency[2];
1406	/**
1407	 * @audio_latency: audio latency info from ELD, if found
1408	 * [0]: progressive, [1]: interlaced
1409	 */
1410	int audio_latency[2];
1411
1412	/**
1413	 * @ddc: associated ddc adapter.
1414	 * A connector usually has its associated ddc adapter. If a driver uses
1415	 * this field, then an appropriate symbolic link is created in connector
1416	 * sysfs directory to make it easy for the user to tell which i2c
1417	 * adapter is for a particular display.
1418	 *
1419	 * The field should be set by calling drm_connector_init_with_ddc().
1420	 */
1421	struct i2c_adapter *ddc;
1422
1423	/**
1424	 * @null_edid_counter: track sinks that give us all zeros for the EDID.
1425	 * Needed to workaround some HW bugs where we get all 0s
1426	 */
1427	int null_edid_counter;
1428
1429	/** @bad_edid_counter: track sinks that give us an EDID with invalid checksum */
1430	unsigned bad_edid_counter;
1431
1432	/**
1433	 * @edid_corrupt: Indicates whether the last read EDID was corrupt. Used
1434	 * in Displayport compliance testing - Displayport Link CTS Core 1.2
1435	 * rev1.1 4.2.2.6
1436	 */
1437	bool edid_corrupt;
1438	/**
1439	 * @real_edid_checksum: real edid checksum for corrupted edid block.
1440	 * Required in Displayport 1.4 compliance testing
1441	 * rev1.1 4.2.2.6
1442	 */
1443	u8 real_edid_checksum;
1444
1445	/** @debugfs_entry: debugfs directory for this connector */
1446	struct dentry *debugfs_entry;
1447
1448	/**
1449	 * @state:
1450	 *
1451	 * Current atomic state for this connector.
1452	 *
1453	 * This is protected by &drm_mode_config.connection_mutex. Note that
1454	 * nonblocking atomic commits access the current connector state without
1455	 * taking locks. Either by going through the &struct drm_atomic_state
1456	 * pointers, see for_each_oldnew_connector_in_state(),
1457	 * for_each_old_connector_in_state() and
1458	 * for_each_new_connector_in_state(). Or through careful ordering of
1459	 * atomic commit operations as implemented in the atomic helpers, see
1460	 * &struct drm_crtc_commit.
1461	 */
1462	struct drm_connector_state *state;
1463
1464	/* DisplayID bits. FIXME: Extract into a substruct? */
1465
1466	/**
1467	 * @tile_blob_ptr:
1468	 *
1469	 * DRM blob property data for the tile property (used mostly by DP MST).
1470	 * This is meant for screens which are driven through separate display
1471	 * pipelines represented by &drm_crtc, which might not be running with
1472	 * genlocked clocks. For tiled panels which are genlocked, like
1473	 * dual-link LVDS or dual-link DSI, the driver should try to not expose
1474	 * the tiling and virtualize both &drm_crtc and &drm_plane if needed.
1475	 *
1476	 * This should only be updated by calling
1477	 * drm_connector_set_tile_property().
1478	 */
1479	struct drm_property_blob *tile_blob_ptr;
1480
1481	/** @has_tile: is this connector connected to a tiled monitor */
1482	bool has_tile;
1483	/** @tile_group: tile group for the connected monitor */
1484	struct drm_tile_group *tile_group;
1485	/** @tile_is_single_monitor: whether the tile is one monitor housing */
1486	bool tile_is_single_monitor;
1487
1488	/** @num_h_tile: number of horizontal tiles in the tile group */
1489	/** @num_v_tile: number of vertical tiles in the tile group */
1490	uint8_t num_h_tile, num_v_tile;
1491	/** @tile_h_loc: horizontal location of this tile */
1492	/** @tile_v_loc: vertical location of this tile */
1493	uint8_t tile_h_loc, tile_v_loc;
1494	/** @tile_h_size: horizontal size of this tile. */
1495	/** @tile_v_size: vertical size of this tile. */
1496	uint16_t tile_h_size, tile_v_size;
1497
1498	/**
1499	 * @free_node:
1500	 *
1501	 * List used only by &drm_connector_list_iter to be able to clean up a
1502	 * connector from any context, in conjunction with
1503	 * &drm_mode_config.connector_free_work.
1504	 */
1505	struct llist_node free_node;
1506
1507	/** @hdr_sink_metadata: HDR Metadata Information read from sink */
1508	struct hdr_sink_metadata hdr_sink_metadata;
1509};
1510
1511#define obj_to_connector(x) container_of(x, struct drm_connector, base)
1512
1513int drm_connector_init(struct drm_device *dev,
1514		       struct drm_connector *connector,
1515		       const struct drm_connector_funcs *funcs,
1516		       int connector_type);
1517int drm_connector_init_with_ddc(struct drm_device *dev,
1518				struct drm_connector *connector,
1519				const struct drm_connector_funcs *funcs,
1520				int connector_type,
1521				struct i2c_adapter *ddc);
1522void drm_connector_attach_edid_property(struct drm_connector *connector);
1523int drm_connector_register(struct drm_connector *connector);
1524void drm_connector_unregister(struct drm_connector *connector);
1525int drm_connector_attach_encoder(struct drm_connector *connector,
1526				      struct drm_encoder *encoder);
1527
1528void drm_connector_cleanup(struct drm_connector *connector);
1529
1530static inline unsigned int drm_connector_index(const struct drm_connector *connector)
1531{
1532	return connector->index;
1533}
1534
1535static inline u32 drm_connector_mask(const struct drm_connector *connector)
1536{
1537	return 1 << connector->index;
1538}
1539
1540/**
1541 * drm_connector_lookup - lookup connector object
1542 * @dev: DRM device
1543 * @file_priv: drm file to check for lease against.
1544 * @id: connector object id
1545 *
1546 * This function looks up the connector object specified by id
1547 * add takes a reference to it.
1548 */
1549static inline struct drm_connector *drm_connector_lookup(struct drm_device *dev,
1550		struct drm_file *file_priv,
1551		uint32_t id)
1552{
1553	struct drm_mode_object *mo;
1554	mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_CONNECTOR);
1555	return mo ? obj_to_connector(mo) : NULL;
1556}
1557
1558/**
1559 * drm_connector_get - acquire a connector reference
1560 * @connector: DRM connector
1561 *
1562 * This function increments the connector's refcount.
1563 */
1564static inline void drm_connector_get(struct drm_connector *connector)
1565{
1566	drm_mode_object_get(&connector->base);
1567}
1568
1569/**
1570 * drm_connector_put - release a connector reference
1571 * @connector: DRM connector
1572 *
1573 * This function decrements the connector's reference count and frees the
1574 * object if the reference count drops to zero.
1575 */
1576static inline void drm_connector_put(struct drm_connector *connector)
1577{
1578	drm_mode_object_put(&connector->base);
1579}
1580
1581/**
1582 * drm_connector_is_unregistered - has the connector been unregistered from
1583 * userspace?
1584 * @connector: DRM connector
1585 *
1586 * Checks whether or not @connector has been unregistered from userspace.
1587 *
1588 * Returns:
1589 * True if the connector was unregistered, false if the connector is
1590 * registered or has not yet been registered with userspace.
1591 */
1592static inline bool
1593drm_connector_is_unregistered(struct drm_connector *connector)
1594{
1595	return READ_ONCE(connector->registration_state) ==
1596		DRM_CONNECTOR_UNREGISTERED;
1597}
1598
1599const char *drm_get_connector_type_name(unsigned int connector_type);
1600const char *drm_get_connector_status_name(enum drm_connector_status status);
1601const char *drm_get_subpixel_order_name(enum subpixel_order order);
1602const char *drm_get_dpms_name(int val);
1603const char *drm_get_dvi_i_subconnector_name(int val);
1604const char *drm_get_dvi_i_select_name(int val);
1605const char *drm_get_tv_subconnector_name(int val);
1606const char *drm_get_tv_select_name(int val);
1607const char *drm_get_content_protection_name(int val);
1608const char *drm_get_hdcp_content_type_name(int val);
1609
1610int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1611int drm_mode_create_tv_margin_properties(struct drm_device *dev);
1612int drm_mode_create_tv_properties(struct drm_device *dev,
1613				  unsigned int num_modes,
1614				  const char * const modes[]);
1615void drm_connector_attach_tv_margin_properties(struct drm_connector *conn);
1616int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1617int drm_connector_attach_content_type_property(struct drm_connector *dev);
1618int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
1619					       u32 scaling_mode_mask);
1620int drm_connector_attach_vrr_capable_property(
1621		struct drm_connector *connector);
1622int drm_mode_create_aspect_ratio_property(struct drm_device *dev);
1623int drm_mode_create_hdmi_colorspace_property(struct drm_connector *connector);
1624int drm_mode_create_dp_colorspace_property(struct drm_connector *connector);
1625int drm_mode_create_content_type_property(struct drm_device *dev);
1626void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame,
1627					 const struct drm_connector_state *conn_state);
1628
1629int drm_mode_create_suggested_offset_properties(struct drm_device *dev);
1630
1631int drm_connector_set_path_property(struct drm_connector *connector,
1632				    const char *path);
1633int drm_connector_set_tile_property(struct drm_connector *connector);
1634int drm_connector_update_edid_property(struct drm_connector *connector,
1635				       const struct edid *edid);
1636void drm_connector_set_link_status_property(struct drm_connector *connector,
1637					    uint64_t link_status);
1638void drm_connector_set_vrr_capable_property(
1639		struct drm_connector *connector, bool capable);
1640int drm_connector_set_panel_orientation(
1641	struct drm_connector *connector,
1642	enum drm_panel_orientation panel_orientation);
1643int drm_connector_set_panel_orientation_with_quirk(
1644	struct drm_connector *connector,
1645	enum drm_panel_orientation panel_orientation,
1646	int width, int height);
1647int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
1648					  int min, int max);
1649
1650/**
1651 * struct drm_tile_group - Tile group metadata
1652 * @refcount: reference count
1653 * @dev: DRM device
1654 * @id: tile group id exposed to userspace
1655 * @group_data: Sink-private data identifying this group
1656 *
1657 * @group_data corresponds to displayid vend/prod/serial for external screens
1658 * with an EDID.
1659 */
1660struct drm_tile_group {
1661	struct kref refcount;
1662	struct drm_device *dev;
1663	int id;
1664	u8 group_data[8];
1665};
1666
1667struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
1668						  const char topology[8]);
1669struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
1670					       const char topology[8]);
1671void drm_mode_put_tile_group(struct drm_device *dev,
1672			     struct drm_tile_group *tg);
1673
1674/**
1675 * struct drm_connector_list_iter - connector_list iterator
1676 *
1677 * This iterator tracks state needed to be able to walk the connector_list
1678 * within struct drm_mode_config. Only use together with
1679 * drm_connector_list_iter_begin(), drm_connector_list_iter_end() and
1680 * drm_connector_list_iter_next() respectively the convenience macro
1681 * drm_for_each_connector_iter().
1682 */
1683struct drm_connector_list_iter {
1684/* private: */
1685	struct drm_device *dev;
1686	struct drm_connector *conn;
1687};
1688
1689void drm_connector_list_iter_begin(struct drm_device *dev,
1690				   struct drm_connector_list_iter *iter);
1691struct drm_connector *
1692drm_connector_list_iter_next(struct drm_connector_list_iter *iter);
1693void drm_connector_list_iter_end(struct drm_connector_list_iter *iter);
1694
1695bool drm_connector_has_possible_encoder(struct drm_connector *connector,
1696					struct drm_encoder *encoder);
1697
1698/**
1699 * drm_for_each_connector_iter - connector_list iterator macro
1700 * @connector: &struct drm_connector pointer used as cursor
1701 * @iter: &struct drm_connector_list_iter
1702 *
1703 * Note that @connector is only valid within the list body, if you want to use
1704 * @connector after calling drm_connector_list_iter_end() then you need to grab
1705 * your own reference first using drm_connector_get().
1706 */
1707#define drm_for_each_connector_iter(connector, iter) \
1708	while ((connector = drm_connector_list_iter_next(iter)))
1709
1710/**
1711 * drm_connector_for_each_possible_encoder - iterate connector's possible encoders
1712 * @connector: &struct drm_connector pointer
1713 * @encoder: &struct drm_encoder pointer used as cursor
1714 */
1715#define drm_connector_for_each_possible_encoder(connector, encoder) \
1716	drm_for_each_encoder_mask(encoder, (connector)->dev, \
1717				  (connector)->possible_encoders)
1718
1719#endif