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