projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
drm: make the connector properties code use the object properties code
[linux-2.6-block.git] / include / drm / drm_crtc.h
CommitLineData
f453ba04
DA		 1/*
2 * Copyright © 2006 Keith Packard
3 * Copyright © 2007-2008 Dave Airlie
4 * Copyright © 2007-2008 Intel Corporation
5 * Jesse Barnes <jesse.barnes@intel.com>
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
21 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
22 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
23 * OTHER DEALINGS IN THE SOFTWARE.
24 */
25#ifndef __DRM_CRTC_H__
26#define __DRM_CRTC_H__
27
28#include <linux/i2c.h>
29#include <linux/spinlock.h>
30#include <linux/types.h>
31#include <linux/idr.h>
f453ba04
DA		 32#include <linux/fb.h>
33
308e5bcb
JB		 34#include <drm/drm_fourcc.h>
35
f453ba04
DA		 36struct drm_device;
37struct drm_mode_set;
38struct drm_framebuffer;
7e3bdf4a 39struct drm_object_properties;
f453ba04
DA		 40
41
42#define DRM_MODE_OBJECT_CRTC 0xcccccccc
43#define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
44#define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
45#define DRM_MODE_OBJECT_MODE 0xdededede
46#define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
47#define DRM_MODE_OBJECT_FB 0xfbfbfbfb
48#define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
8cf5c917 49#define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
f453ba04
DA		 50
51struct drm_mode_object {
52 uint32_t id;
53 uint32_t type;
7e3bdf4a
PZ		 54 struct drm_object_properties *properties;
55};
56
57#define DRM_OBJECT_MAX_PROPERTY 16
58struct drm_object_properties {
59 uint32_t ids[DRM_OBJECT_MAX_PROPERTY];
60 uint64_t values[DRM_OBJECT_MAX_PROPERTY];
f453ba04
DA		 61};
62
63/*
64 * Note on terminology: here, for brevity and convenience, we refer to connector
65 * control chips as 'CRTCs'. They can control any type of connector, VGA, LVDS,
66 * DVI, etc. And 'screen' refers to the whole of the visible display, which
67 * may span multiple monitors (and therefore multiple CRTC and connector
68 * structures).
69 */
70
71enum drm_mode_status {
72 MODE_OK = 0, /* Mode OK */
73 MODE_HSYNC, /* hsync out of range */
74 MODE_VSYNC, /* vsync out of range */
75 MODE_H_ILLEGAL, /* mode has illegal horizontal timings */
76 MODE_V_ILLEGAL, /* mode has illegal horizontal timings */
77 MODE_BAD_WIDTH, /* requires an unsupported linepitch */
25985edc 78 MODE_NOMODE, /* no mode with a matching name */
f453ba04
DA		 79 MODE_NO_INTERLACE, /* interlaced mode not supported */
80 MODE_NO_DBLESCAN, /* doublescan mode not supported */
81 MODE_NO_VSCAN, /* multiscan mode not supported */
82 MODE_MEM, /* insufficient video memory */
83 MODE_VIRTUAL_X, /* mode width too large for specified virtual size */
84 MODE_VIRTUAL_Y, /* mode height too large for specified virtual size */
85 MODE_MEM_VIRT, /* insufficient video memory given virtual size */
86 MODE_NOCLOCK, /* no fixed clock available */
87 MODE_CLOCK_HIGH, /* clock required is too high */
88 MODE_CLOCK_LOW, /* clock required is too low */
89 MODE_CLOCK_RANGE, /* clock/mode isn't in a ClockRange */
90 MODE_BAD_HVALUE, /* horizontal timing was out of range */
91 MODE_BAD_VVALUE, /* vertical timing was out of range */
92 MODE_BAD_VSCAN, /* VScan value out of range */
93 MODE_HSYNC_NARROW, /* horizontal sync too narrow */
94 MODE_HSYNC_WIDE, /* horizontal sync too wide */
95 MODE_HBLANK_NARROW, /* horizontal blanking too narrow */
96 MODE_HBLANK_WIDE, /* horizontal blanking too wide */
97 MODE_VSYNC_NARROW, /* vertical sync too narrow */
98 MODE_VSYNC_WIDE, /* vertical sync too wide */
99 MODE_VBLANK_NARROW, /* vertical blanking too narrow */
100 MODE_VBLANK_WIDE, /* vertical blanking too wide */
101 MODE_PANEL, /* exceeds panel dimensions */
102 MODE_INTERLACE_WIDTH, /* width too large for interlaced mode */
103 MODE_ONE_WIDTH, /* only one width is supported */
104 MODE_ONE_HEIGHT, /* only one height is supported */
105 MODE_ONE_SIZE, /* only one resolution is supported */
106 MODE_NO_REDUCED, /* monitor doesn't accept reduced blanking */
107 MODE_UNVERIFIED = -3, /* mode needs to reverified */
108 MODE_BAD = -2, /* unspecified reason */
109 MODE_ERROR = -1 /* error condition */
110};
111
112#define DRM_MODE_TYPE_CLOCK_CRTC_C (DRM_MODE_TYPE_CLOCK_C | \
113 DRM_MODE_TYPE_CRTC_C)
114
115#define DRM_MODE(nm, t, c, hd, hss, hse, ht, hsk, vd, vss, vse, vt, vs, f) \
116 .name = nm, .status = 0, .type = (t), .clock = (c), \
117 .hdisplay = (hd), .hsync_start = (hss), .hsync_end = (hse), \
118 .htotal = (ht), .hskew = (hsk), .vdisplay = (vd), \
119 .vsync_start = (vss), .vsync_end = (vse), .vtotal = (vt), \
120 .vscan = (vs), .flags = (f), .vrefresh = 0
121
122#define CRTC_INTERLACE_HALVE_V 0x1 /* halve V values for interlacing */
123
124struct drm_display_mode {
125 /* Header */
126 struct list_head head;
127 struct drm_mode_object base;
128
129 char name[DRM_DISPLAY_MODE_LEN];
130
f453ba04 131 enum drm_mode_status status;
2fcfc75b 132 unsigned int type;
f453ba04
DA		 133
134 /* Proposed mode values */
7ac96a9c 135 int clock; /* in kHz */
f453ba04
DA		 136 int hdisplay;
137 int hsync_start;
138 int hsync_end;
139 int htotal;
140 int hskew;
141 int vdisplay;
142 int vsync_start;
143 int vsync_end;
144 int vtotal;
145 int vscan;
146 unsigned int flags;
147
148 /* Addressable image size (may be 0 for projectors, etc.) */
149 int width_mm;
150 int height_mm;
151
152 /* Actual mode we give to hw */
153 int clock_index;
154 int synth_clock;
155 int crtc_hdisplay;
156 int crtc_hblank_start;
157 int crtc_hblank_end;
158 int crtc_hsync_start;
159 int crtc_hsync_end;
160 int crtc_htotal;
161 int crtc_hskew;
162 int crtc_vdisplay;
163 int crtc_vblank_start;
164 int crtc_vblank_end;
165 int crtc_vsync_start;
166 int crtc_vsync_end;
167 int crtc_vtotal;
168 int crtc_hadjusted;
169 int crtc_vadjusted;
170
171 /* Driver private mode info */
172 int private_size;
173 int *private;
174 int private_flags;
175
7ac96a9c
AJ		 176 int vrefresh; /* in Hz */
177 int hsync; /* in kHz */
f453ba04
DA		 178};
179
180enum drm_connector_status {
181 connector_status_connected = 1,
182 connector_status_disconnected = 2,
183 connector_status_unknown = 3,
184};
185
186enum subpixel_order {
187 SubPixelUnknown = 0,
188 SubPixelHorizontalRGB,
189 SubPixelHorizontalBGR,
190 SubPixelVerticalRGB,
191 SubPixelVerticalBGR,
192 SubPixelNone,
193};
194
da05a5a7
JB		 195#define DRM_COLOR_FORMAT_RGB444 (1<<0)
196#define DRM_COLOR_FORMAT_YCRCB444 (1<<1)
197#define DRM_COLOR_FORMAT_YCRCB422 (1<<2)
f453ba04
DA		 198/*
199 * Describes a given display (e.g. CRT or flat panel) and its limitations.
200 */
201struct drm_display_info {
202 char name[DRM_DISPLAY_INFO_LEN];
fb439640 203
f453ba04
DA		 204 /* Physical size */
205 unsigned int width_mm;
206 unsigned int height_mm;
207
f453ba04
DA		 208 /* Clock limits FIXME: storage format */
209 unsigned int min_vfreq, max_vfreq;
210 unsigned int min_hfreq, max_hfreq;
211 unsigned int pixel_clock;
3b11228b 212 unsigned int bpc;
f453ba04 213
f453ba04 214 enum subpixel_order subpixel_order;
da05a5a7 215 u32 color_formats;
f453ba04 216
ebec9a7b
JB		 217 u8 cea_rev;
218
f453ba04
DA		 219 char *raw_edid; /* if any */
220};
221
222struct drm_framebuffer_funcs {
223 void (*destroy)(struct drm_framebuffer *framebuffer);
224 int (*create_handle)(struct drm_framebuffer *fb,
225 struct drm_file *file_priv,
226 unsigned int *handle);
884840aa
JB		 227 /**
228 * Optinal callback for the dirty fb ioctl.
229 *
230 * Userspace can notify the driver via this callback
231 * that a area of the framebuffer has changed and should
232 * be flushed to the display hardware.
233 *
234 * See documentation in drm_mode.h for the struct
235 * drm_mode_fb_dirty_cmd for more information as all
236 * the semantics and arguments have a one to one mapping
237 * on this function.
238 */
02b00162
TH		 239 int (*dirty)(struct drm_framebuffer *framebuffer,
240 struct drm_file *file_priv, unsigned flags,
884840aa
JB		 241 unsigned color, struct drm_clip_rect *clips,
242 unsigned num_clips);
f453ba04
DA		 243};
244
245struct drm_framebuffer {
246 struct drm_device *dev;
247 struct list_head head;
248 struct drm_mode_object base;
249 const struct drm_framebuffer_funcs *funcs;
01f2c773
VS		 250 unsigned int pitches[4];
251 unsigned int offsets[4];
f453ba04
DA		 252 unsigned int width;
253 unsigned int height;
254 /* depth can be 15 or 16 */
255 unsigned int depth;
256 int bits_per_pixel;
257 int flags;
308e5bcb 258 uint32_t pixel_format; /* fourcc format */
f453ba04 259 struct list_head filp_head;
785b93ef
DA		 260 /* if you are using the helper */
261 void *helper_private;
f453ba04
DA		 262};
263
264struct drm_property_blob {
265 struct drm_mode_object base;
266 struct list_head head;
267 unsigned int length;
d63f5e6b 268 unsigned char data[];
f453ba04
DA		 269};
270
271struct drm_property_enum {
272 uint64_t value;
273 struct list_head head;
274 char name[DRM_PROP_NAME_LEN];
275};
276
277struct drm_property {
278 struct list_head head;
279 struct drm_mode_object base;
280 uint32_t flags;
281 char name[DRM_PROP_NAME_LEN];
282 uint32_t num_values;
283 uint64_t *values;
284
285 struct list_head enum_blob_list;
286};
287
288struct drm_crtc;
289struct drm_connector;
290struct drm_encoder;
d91d8a3f 291struct drm_pending_vblank_event;
8cf5c917 292struct drm_plane;
f453ba04
DA		 293
294/**
295 * drm_crtc_funcs - control CRTCs for a given device
eb033556 296 * @reset: reset CRTC after state has been invalidate (e.g. resume)
f453ba04
DA		 297 * @dpms: control display power levels
298 * @save: save CRTC state
299 * @resore: restore CRTC state
300 * @lock: lock the CRTC
301 * @unlock: unlock the CRTC
302 * @shadow_allocate: allocate shadow pixmap
303 * @shadow_create: create shadow pixmap for rotation support
304 * @shadow_destroy: free shadow pixmap
305 * @mode_fixup: fixup proposed mode
306 * @mode_set: set the desired mode on the CRTC
307 * @gamma_set: specify color ramp for CRTC
308 * @destroy: deinit and free object.
309 *
310 * The drm_crtc_funcs structure is the central CRTC management structure
311 * in the DRM. Each CRTC controls one or more connectors (note that the name
312 * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
313 * connectors, not just CRTs).
314 *
315 * Each driver is responsible for filling out this structure at startup time,
316 * in addition to providing other modesetting features, like i2c and DDC
317 * bus accessors.
318 */
319struct drm_crtc_funcs {
320 /* Save CRTC state */
321 void (*save)(struct drm_crtc *crtc); /* suspend? */
322 /* Restore CRTC state */
323 void (*restore)(struct drm_crtc *crtc); /* resume? */
eb033556
CW		 324 /* Reset CRTC state */
325 void (*reset)(struct drm_crtc *crtc);
f453ba04
DA		 326
327 /* cursor controls */
328 int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
329 uint32_t handle, uint32_t width, uint32_t height);
330 int (*cursor_move)(struct drm_crtc *crtc, int x, int y);
331
332 /* Set gamma on the CRTC */
333 void (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
7203425a 334 uint32_t start, uint32_t size);
f453ba04
DA		 335 /* Object destroy routine */
336 void (*destroy)(struct drm_crtc *crtc);
337
338 int (*set_config)(struct drm_mode_set *set);
d91d8a3f
KH		 339
340 /*
341 * Flip to the given framebuffer. This implements the page
25985edc 342 * flip ioctl described in drm_mode.h, specifically, the
d91d8a3f
KH		 343 * implementation must return immediately and block all
344 * rendering to the current fb until the flip has completed.
345 * If userspace set the event flag in the ioctl, the event
346 * argument will point to an event to send back when the flip
347 * completes, otherwise it will be NULL.
348 */
349 int (*page_flip)(struct drm_crtc *crtc,
350 struct drm_framebuffer *fb,
351 struct drm_pending_vblank_event *event);
f453ba04
DA		 352};
353
354/**
355 * drm_crtc - central CRTC control structure
7749163e
JB		 356 * @dev: parent DRM device
357 * @head: list management
358 * @base: base KMS object for ID tracking etc.
f453ba04 359 * @enabled: is this CRTC enabled?
7749163e
JB		 360 * @mode: current mode timings
361 * @hwmode: mode timings as programmed to hw regs
f453ba04
DA		 362 * @x: x position on screen
363 * @y: y position on screen
f453ba04 364 * @funcs: CRTC control functions
7749163e
JB		 365 * @gamma_size: size of gamma ramp
366 * @gamma_store: gamma ramp values
367 * @framedur_ns: precise frame timing
368 * @framedur_ns: precise line timing
369 * @pixeldur_ns: precise pixel timing
370 * @helper_private: mid-layer private data
f453ba04
DA		 371 *
372 * Each CRTC may have one or more connectors associated with it. This structure
373 * allows the CRTC to be controlled.
374 */
375struct drm_crtc {
376 struct drm_device *dev;
377 struct list_head head;
378
379 struct drm_mode_object base;
380
381 /* framebuffer the connector is currently bound to */
382 struct drm_framebuffer *fb;
383
384 bool enabled;
385
27641c3f 386 /* Requested mode from modesetting. */
f453ba04
DA		 387 struct drm_display_mode mode;
388
27641c3f
MK		 389 /* Programmed mode in hw, after adjustments for encoders,
390 * crtc, panel scaling etc. Needed for timestamping etc.
391 */
392 struct drm_display_mode hwmode;
393
f453ba04 394 int x, y;
f453ba04
DA		 395 const struct drm_crtc_funcs *funcs;
396
397 /* CRTC gamma size for reporting to userspace */
398 uint32_t gamma_size;
399 uint16_t *gamma_store;
400
27641c3f
MK		 401 /* Constants needed for precise vblank and swap timestamping. */
402 s64 framedur_ns, linedur_ns, pixeldur_ns;
403
f453ba04
DA		 404 /* if you are using the helper */
405 void *helper_private;
406};
407
408
409/**
410 * drm_connector_funcs - control connectors on a given device
411 * @dpms: set power state (see drm_crtc_funcs above)
412 * @save: save connector state
413 * @restore: restore connector state
eb033556 414 * @reset: reset connector after state has been invalidate (e.g. resume)
f453ba04
DA		 415 * @mode_valid: is this mode valid on the given connector?
416 * @mode_fixup: try to fixup proposed mode for this connector
417 * @mode_set: set this mode
418 * @detect: is this connector active?
419 * @get_modes: get mode list for this connector
420 * @set_property: property for this connector may need update
421 * @destroy: make object go away
d50ba256 422 * @force: notify the driver the connector is forced on
f453ba04
DA		 423 *
424 * Each CRTC may have one or more connectors attached to it. The functions
425 * below allow the core DRM code to control connectors, enumerate available modes,
426 * etc.
427 */
428struct drm_connector_funcs {
429 void (*dpms)(struct drm_connector *connector, int mode);
430 void (*save)(struct drm_connector *connector);
431 void (*restore)(struct drm_connector *connector);
eb033556 432 void (*reset)(struct drm_connector *connector);
930a9e28
CW		 433
434 /* Check to see if anything is attached to the connector.
435 * @force is set to false whilst polling, true when checking the
436 * connector due to user request. @force can be used by the driver
437 * to avoid expensive, destructive operations during automated
438 * probing.
439 */
7b334fcb 440 enum drm_connector_status (*detect)(struct drm_connector *connector,
930a9e28 441 bool force);
40a518d9 442 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
f453ba04
DA		 443 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
444 uint64_t val);
445 void (*destroy)(struct drm_connector *connector);
d50ba256 446 void (*force)(struct drm_connector *connector);
f453ba04
DA		 447};
448
6c3db920
JB		 449/**
450 * drm_encoder_funcs - encoder controls
451 * @reset: reset state (e.g. at init or resume time)
452 * @destroy: cleanup and free associated data
453 *
454 * Encoders sit between CRTCs and connectors.
455 */
f453ba04 456struct drm_encoder_funcs {
eb033556 457 void (*reset)(struct drm_encoder *encoder);
f453ba04
DA		 458 void (*destroy)(struct drm_encoder *encoder);
459};
460
461#define DRM_CONNECTOR_MAX_UMODES 16
f453ba04 462#define DRM_CONNECTOR_LEN 32
afe887df 463#define DRM_CONNECTOR_MAX_ENCODER 3
f453ba04
DA		 464
465/**
466 * drm_encoder - central DRM encoder structure
db3e4499
JB		 467 * @dev: parent DRM device
468 * @head: list management
469 * @base: base KMS object
470 * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
471 * @possible_crtcs: bitmask of potential CRTC bindings
472 * @possible_clones: bitmask of potential sibling encoders for cloning
473 * @crtc: currently bound CRTC
474 * @funcs: control functions
475 * @helper_private: mid-layer private data
476 *
477 * CRTCs drive pixels to encoders, which convert them into signals
478 * appropriate for a given connector or set of connectors.
f453ba04
DA		 479 */
480struct drm_encoder {
481 struct drm_device *dev;
482 struct list_head head;
483
484 struct drm_mode_object base;
485 int encoder_type;
486 uint32_t possible_crtcs;
487 uint32_t possible_clones;
488
489 struct drm_crtc *crtc;
490 const struct drm_encoder_funcs *funcs;
491 void *helper_private;
492};
493
d50ba256
DA		 494enum drm_connector_force {
495 DRM_FORCE_UNSPECIFIED,
496 DRM_FORCE_OFF,
497 DRM_FORCE_ON, /* force on analog part normally */
498 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
499};
500
eb1f8e4f
DA		 501/* should we poll this connector for connects and disconnects */
502/* hot plug detectable */
503#define DRM_CONNECTOR_POLL_HPD (1 << 0)
504/* poll for connections */
505#define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
506/* can cleanly poll for disconnections without flickering the screen */
507/* DACs should rarely do this without a lot of testing */
508#define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
509
76adaa34
WF		 510#define MAX_ELD_BYTES 128
511
f453ba04
DA		 512/**
513 * drm_connector - central DRM connector control structure
72252548
JB		 514 * @dev: parent DRM device
515 * @kdev: kernel device for sysfs attributes
516 * @attr: sysfs attributes
517 * @head: list management
518 * @base: base KMS object
519 * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
520 * @connector_type_id: index into connector type enum
f453ba04
DA		 521 * @interlace_allowed: can this connector handle interlaced modes?
522 * @doublescan_allowed: can this connector handle doublescan?
72252548
JB		 523 * @modes: modes available on this connector (from fill_modes() + user)
524 * @status: one of the drm_connector_status enums (connected, not, or unknown)
525 * @probed_modes: list of modes derived directly from the display
526 * @display_info: information about attached display (e.g. from EDID)
f453ba04 527 * @funcs: connector control functions
72252548
JB		 528 * @user_modes: user added mode list
529 * @edid_blob_ptr: DRM property containing EDID if present
7e3bdf4a 530 * @properties: property tracking for this connector
72252548
JB		 531 * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
532 * @dpms: current dpms state
533 * @helper_private: mid-layer private data
534 * @force: a %DRM_FORCE_<foo> state for forced mode sets
535 * @encoder_ids: valid encoders for this connector
536 * @encoder: encoder driving this connector, if any
537 * @eld: EDID-like data, if present
538 * @dvi_dual: dual link DVI, if found
539 * @max_tmds_clock: max clock rate, if found
540 * @latency_present: AV delay info from ELD, if found
541 * @video_latency: video latency info from ELD, if found
542 * @audio_latency: audio latency info from ELD, if found
543 * @null_edid_counter: track sinks that give us all zeros for the EDID
f453ba04
DA		 544 *
545 * Each connector may be connected to one or more CRTCs, or may be clonable by
546 * another connector if they can share a CRTC. Each connector also has a specific
547 * position in the broader display (referred to as a 'screen' though it could
548 * span multiple monitors).
549 */
550struct drm_connector {
551 struct drm_device *dev;
552 struct device kdev;
553 struct device_attribute *attr;
554 struct list_head head;
555
556 struct drm_mode_object base;
557
558 int connector_type;
559 int connector_type_id;
560 bool interlace_allowed;
561 bool doublescan_allowed;
562 struct list_head modes; /* list of modes on this connector */
563
f453ba04
DA		 564 enum drm_connector_status status;
565
566 /* these are modes added by probing with DDC or the BIOS */
567 struct list_head probed_modes;
568
569 struct drm_display_info display_info;
570 const struct drm_connector_funcs *funcs;
571
572 struct list_head user_modes;
573 struct drm_property_blob *edid_blob_ptr;
7e3bdf4a 574 struct drm_object_properties properties;
f453ba04 575
eb1f8e4f
DA		 576 uint8_t polled; /* DRM_CONNECTOR_POLL_* */
577
c9fb15f6
KP		 578 /* requested DPMS state */
579 int dpms;
580
f453ba04
DA		 581 void *helper_private;
582
d50ba256
DA		 583 /* forced on connector */
584 enum drm_connector_force force;
f453ba04 585 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
f453ba04 586 struct drm_encoder *encoder; /* currently active encoder */
4a9a8b71 587
76adaa34
WF		 588 /* EDID bits */
589 uint8_t eld[MAX_ELD_BYTES];
590 bool dvi_dual;
591 int max_tmds_clock; /* in MHz */
592 bool latency_present[2];
593 int video_latency[2]; /* [0]: progressive, [1]: interlaced */
594 int audio_latency[2];
4a9a8b71 595 int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
f453ba04
DA		 596};
597
8cf5c917
JB		 598/**
599 * drm_plane_funcs - driver plane control functions
600 * @update_plane: update the plane configuration
601 * @disable_plane: shut down the plane
602 * @destroy: clean up plane resources
603 */
604struct drm_plane_funcs {
605 int (*update_plane)(struct drm_plane *plane,
606 struct drm_crtc *crtc, struct drm_framebuffer *fb,
607 int crtc_x, int crtc_y,
608 unsigned int crtc_w, unsigned int crtc_h,
609 uint32_t src_x, uint32_t src_y,
610 uint32_t src_w, uint32_t src_h);
611 int (*disable_plane)(struct drm_plane *plane);
612 void (*destroy)(struct drm_plane *plane);
613};
614
615/**
616 * drm_plane - central DRM plane control structure
617 * @dev: DRM device this plane belongs to
618 * @head: for list management
619 * @base: base mode object
620 * @possible_crtcs: pipes this plane can be bound to
621 * @format_types: array of formats supported by this plane
622 * @format_count: number of formats supported
623 * @crtc: currently bound CRTC
624 * @fb: currently bound fb
625 * @gamma_size: size of gamma table
626 * @gamma_store: gamma correction table
627 * @enabled: enabled flag
628 * @funcs: helper functions
629 * @helper_private: storage for drver layer
630 */
631struct drm_plane {
632 struct drm_device *dev;
633 struct list_head head;
634
635 struct drm_mode_object base;
636
637 uint32_t possible_crtcs;
638 uint32_t *format_types;
639 uint32_t format_count;
640
641 struct drm_crtc *crtc;
642 struct drm_framebuffer *fb;
643
644 /* CRTC gamma size for reporting to userspace */
645 uint32_t gamma_size;
646 uint16_t *gamma_store;
647
648 bool enabled;
649
650 const struct drm_plane_funcs *funcs;
651 void *helper_private;
652};
653
f453ba04 654/**
ef27351a
JB		 655 * drm_mode_set - new values for a CRTC config change
656 * @head: list management
657 * @fb: framebuffer to use for new config
658 * @crtc: CRTC whose configuration we're about to change
659 * @mode: mode timings to use
660 * @x: position of this CRTC relative to @fb
661 * @y: position of this CRTC relative to @fb
662 * @connectors: array of connectors to drive with this CRTC if possible
663 * @num_connectors: size of @connectors array
f453ba04
DA		 664 *
665 * Represents a single crtc the connectors that it drives with what mode
666 * and from which framebuffer it scans out from.
667 *
668 * This is used to set modes.
669 */
670struct drm_mode_set {
671 struct list_head head;
672
673 struct drm_framebuffer *fb;
674 struct drm_crtc *crtc;
675 struct drm_display_mode *mode;
676
677 uint32_t x;
678 uint32_t y;
679
680 struct drm_connector **connectors;
681 size_t num_connectors;
682};
683
684/**
550cebcd
JB		 685 * struct drm_mode_config_funcs - basic driver provided mode setting functions
686 * @fb_create: create a new framebuffer object
687 * @output_poll_changed: function to handle output configuration changes
688 *
689 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
690 * involve drivers.
f453ba04
DA		 691 */
692struct drm_mode_config_funcs {
550cebcd
JB		 693 struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
694 struct drm_file *file_priv,
695 struct drm_mode_fb_cmd2 *mode_cmd);
eb1f8e4f 696 void (*output_poll_changed)(struct drm_device *dev);
f453ba04
DA		 697};
698
c1aaca23
JB		 699/**
700 * drm_mode_group - group of mode setting resources for potential sub-grouping
701 * @num_crtcs: CRTC count
702 * @num_encoders: encoder count
703 * @num_connectors: connector count
704 * @id_list: list of KMS object IDs in this group
705 *
706 * Currently this simply tracks the global mode setting state. But in the
707 * future it could allow groups of objects to be set aside into independent
708 * control groups for use by different user level processes (e.g. two X servers
709 * running simultaneously on different heads, each with their own mode
710 * configuration and freedom of mode setting).
711 */
f453ba04
DA		 712struct drm_mode_group {
713 uint32_t num_crtcs;
714 uint32_t num_encoders;
715 uint32_t num_connectors;
716
717 /* list of object IDs for this group */
718 uint32_t *id_list;
719};
720
721/**
722 * drm_mode_config - Mode configuration control structure
a62c93d5
JB		 723 * @mutex: mutex protecting KMS related lists and structures
724 * @idr_mutex: mutex for KMS ID allocation and management
725 * @crtc_idr: main KMS ID tracking object
726 * @num_fb: number of fbs available
727 * @fb_list: list of framebuffers available
728 * @num_connector: number of connectors on this device
729 * @connector_list: list of connector objects
730 * @num_encoder: number of encoders on this device
731 * @encoder_list: list of encoder objects
732 * @num_crtc: number of CRTCs on this device
733 * @crtc_list: list of CRTC objects
734 * @min_width: minimum pixel width on this device
735 * @min_height: minimum pixel height on this device
736 * @max_width: maximum pixel width on this device
737 * @max_height: maximum pixel height on this device
738 * @funcs: core driver provided mode setting functions
739 * @fb_base: base address of the framebuffer
740 * @poll_enabled: track polling status for this device
741 * @output_poll_work: delayed work for polling in process context
742 * @*_property: core property tracking
f453ba04 743 *
a62c93d5
JB		 744 * Core mode resource tracking structure. All CRTC, encoders, and connectors
745 * enumerated by the driver are added here, as are global properties. Some
746 * global restrictions are also here, e.g. dimension restrictions.
f453ba04
DA		 747 */
748struct drm_mode_config {
ad2563c2
JB		 749 struct mutex mutex; /* protects configuration (mode lists etc.) */
750 struct mutex idr_mutex; /* for IDR management */
f453ba04
DA		 751 struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
752 /* this is limited to one for now */
753 int num_fb;
754 struct list_head fb_list;
755 int num_connector;
756 struct list_head connector_list;
757 int num_encoder;
758 struct list_head encoder_list;
8cf5c917
JB		 759 int num_plane;
760 struct list_head plane_list;
f453ba04
DA		 761
762 int num_crtc;
763 struct list_head crtc_list;
764
765 struct list_head property_list;
766
f453ba04
DA		 767 int min_width, min_height;
768 int max_width, max_height;
769 struct drm_mode_config_funcs *funcs;
d883f7f1 770 resource_size_t fb_base;
f453ba04 771
eb1f8e4f
DA		 772 /* output poll support */
773 bool poll_enabled;
991ea75c 774 struct delayed_work output_poll_work;
eb1f8e4f 775
f453ba04
DA		 776 /* pointers to standard properties */
777 struct list_head property_blob_list;
778 struct drm_property *edid_property;
779 struct drm_property *dpms_property;
780
781 /* DVI-I properties */
782 struct drm_property *dvi_i_subconnector_property;
783 struct drm_property *dvi_i_select_subconnector_property;
784
785 /* TV properties */
786 struct drm_property *tv_subconnector_property;
787 struct drm_property *tv_select_subconnector_property;
788 struct drm_property *tv_mode_property;
789 struct drm_property *tv_left_margin_property;
790 struct drm_property *tv_right_margin_property;
791 struct drm_property *tv_top_margin_property;
792 struct drm_property *tv_bottom_margin_property;
b6b7902e
FJ		 793 struct drm_property *tv_brightness_property;
794 struct drm_property *tv_contrast_property;
795 struct drm_property *tv_flicker_reduction_property;
a75f0236
FJ		 796 struct drm_property *tv_overscan_property;
797 struct drm_property *tv_saturation_property;
798 struct drm_property *tv_hue_property;
f453ba04
DA		 799
800 /* Optional properties */
801 struct drm_property *scaling_mode_property;
802 struct drm_property *dithering_mode_property;
884840aa 803 struct drm_property *dirty_info_property;
019d96cb
DA		 804
805 /* dumb ioctl parameters */
806 uint32_t preferred_depth, prefer_shadow;
f453ba04
DA		 807};
808
809#define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
810#define obj_to_connector(x) container_of(x, struct drm_connector, base)
811#define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
812#define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
813#define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
814#define obj_to_property(x) container_of(x, struct drm_property, base)
815#define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
8cf5c917 816#define obj_to_plane(x) container_of(x, struct drm_plane, base)
f453ba04 817
4a67d391
SH		 818struct drm_prop_enum_list {
819 int type;
820 char *name;
821};
f453ba04 822
6bfc56aa
VS		 823extern int drm_crtc_init(struct drm_device *dev,
824 struct drm_crtc *crtc,
825 const struct drm_crtc_funcs *funcs);
f453ba04
DA		 826extern void drm_crtc_cleanup(struct drm_crtc *crtc);
827
6bfc56aa
VS		 828extern int drm_connector_init(struct drm_device *dev,
829 struct drm_connector *connector,
830 const struct drm_connector_funcs *funcs,
831 int connector_type);
f453ba04
DA		 832
833extern void drm_connector_cleanup(struct drm_connector *connector);
cbc7e221
DA		 834/* helper to unplug all connectors from sysfs for device */
835extern void drm_connector_unplug_all(struct drm_device *dev);
f453ba04 836
6bfc56aa
VS		 837extern int drm_encoder_init(struct drm_device *dev,
838 struct drm_encoder *encoder,
839 const struct drm_encoder_funcs *funcs,
840 int encoder_type);
f453ba04 841
8cf5c917
JB		 842extern int drm_plane_init(struct drm_device *dev,
843 struct drm_plane *plane,
844 unsigned long possible_crtcs,
845 const struct drm_plane_funcs *funcs,
0a7eb243
RC		 846 const uint32_t *formats, uint32_t format_count,
847 bool priv);
8cf5c917
JB		 848extern void drm_plane_cleanup(struct drm_plane *plane);
849
f453ba04
DA		 850extern void drm_encoder_cleanup(struct drm_encoder *encoder);
851
852extern char *drm_get_connector_name(struct drm_connector *connector);
853extern char *drm_get_dpms_name(int val);
854extern char *drm_get_dvi_i_subconnector_name(int val);
855extern char *drm_get_dvi_i_select_name(int val);
856extern char *drm_get_tv_subconnector_name(int val);
857extern char *drm_get_tv_select_name(int val);
ea39f835 858extern void drm_fb_release(struct drm_file *file_priv);
f453ba04
DA		 859extern int drm_mode_group_init_legacy_group(struct drm_device *dev, struct drm_mode_group *group);
860extern struct edid *drm_get_edid(struct drm_connector *connector,
861 struct i2c_adapter *adapter);
f453ba04
DA		 862extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);
863extern void drm_mode_probed_add(struct drm_connector *connector, struct drm_display_mode *mode);
864extern void drm_mode_remove(struct drm_connector *connector, struct drm_display_mode *mode);
c3c50e8b 865extern void drm_mode_copy(struct drm_display_mode *dst, const struct drm_display_mode *src);
f453ba04 866extern struct drm_display_mode *drm_mode_duplicate(struct drm_device *dev,
b1f559ec 867 const struct drm_display_mode *mode);
f453ba04
DA		 868extern void drm_mode_debug_printmodeline(struct drm_display_mode *mode);
869extern void drm_mode_config_init(struct drm_device *dev);
eb033556 870extern void drm_mode_config_reset(struct drm_device *dev);
f453ba04
DA		 871extern void drm_mode_config_cleanup(struct drm_device *dev);
872extern void drm_mode_set_name(struct drm_display_mode *mode);
873extern bool drm_mode_equal(struct drm_display_mode *mode1, struct drm_display_mode *mode2);
874extern int drm_mode_width(struct drm_display_mode *mode);
875extern int drm_mode_height(struct drm_display_mode *mode);
876
877/* for us by fb module */
878extern int drm_mode_attachmode_crtc(struct drm_device *dev,
879 struct drm_crtc *crtc,
ac235daf 880 const struct drm_display_mode *mode);
f453ba04
DA		 881extern int drm_mode_detachmode_crtc(struct drm_device *dev, struct drm_display_mode *mode);
882
883extern struct drm_display_mode *drm_mode_create(struct drm_device *dev);
884extern void drm_mode_destroy(struct drm_device *dev, struct drm_display_mode *mode);
885extern void drm_mode_list_concat(struct list_head *head,
886 struct list_head *new);
887extern void drm_mode_validate_size(struct drm_device *dev,
888 struct list_head *mode_list,
889 int maxX, int maxY, int maxPitch);
890extern void drm_mode_prune_invalid(struct drm_device *dev,
891 struct list_head *mode_list, bool verbose);
892extern void drm_mode_sort(struct list_head *mode_list);
b1f559ec
CW		 893extern int drm_mode_hsync(const struct drm_display_mode *mode);
894extern int drm_mode_vrefresh(const struct drm_display_mode *mode);
f453ba04
DA		 895extern void drm_mode_set_crtcinfo(struct drm_display_mode *p,
896 int adjust_flags);
897extern void drm_mode_connector_list_update(struct drm_connector *connector);
898extern int drm_mode_connector_update_edid_property(struct drm_connector *connector,
899 struct edid *edid);
900extern int drm_connector_property_set_value(struct drm_connector *connector,
901 struct drm_property *property,
902 uint64_t value);
903extern int drm_connector_property_get_value(struct drm_connector *connector,
904 struct drm_property *property,
905 uint64_t *value);
c543188a
PZ		 906extern int drm_object_property_set_value(struct drm_mode_object *obj,
907 struct drm_property *property,
908 uint64_t val);
909extern int drm_object_property_get_value(struct drm_mode_object *obj,
910 struct drm_property *property,
911 uint64_t *value);
f453ba04
DA		 912extern struct drm_display_mode *drm_crtc_mode_create(struct drm_device *dev);
913extern void drm_framebuffer_set_object(struct drm_device *dev,
914 unsigned long handle);
915extern int drm_framebuffer_init(struct drm_device *dev,
916 struct drm_framebuffer *fb,
917 const struct drm_framebuffer_funcs *funcs);
918extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb);
919extern int drmfb_probe(struct drm_device *dev, struct drm_crtc *crtc);
920extern int drmfb_remove(struct drm_device *dev, struct drm_framebuffer *fb);
921extern void drm_crtc_probe_connector_modes(struct drm_device *dev, int maxX, int maxY);
922extern bool drm_crtc_in_use(struct drm_crtc *crtc);
923
afea2ad5
PZ		 924extern void drm_connector_attach_property(struct drm_connector *connector,
925 struct drm_property *property, uint64_t init_val);
c543188a
PZ		 926extern void drm_object_attach_property(struct drm_mode_object *obj,
927 struct drm_property *property,
928 uint64_t init_val);
f453ba04
DA		 929extern struct drm_property *drm_property_create(struct drm_device *dev, int flags,
930 const char *name, int num_values);
4a67d391
SH		 931extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
932 const char *name,
933 const struct drm_prop_enum_list *props,
934 int num_values);
d9bc3c02
SH		 935struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
936 const char *name,
937 uint64_t min, uint64_t max);
f453ba04
DA		 938extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property);
939extern int drm_property_add_enum(struct drm_property *property, int index,
940 uint64_t value, const char *name);
941extern int drm_mode_create_dvi_i_properties(struct drm_device *dev);
942extern int drm_mode_create_tv_properties(struct drm_device *dev, int num_formats,
943 char *formats[]);
944extern int drm_mode_create_scaling_mode_property(struct drm_device *dev);
945extern int drm_mode_create_dithering_property(struct drm_device *dev);
884840aa 946extern int drm_mode_create_dirty_info_property(struct drm_device *dev);
f453ba04
DA		 947extern char *drm_get_encoder_name(struct drm_encoder *encoder);
948
949extern int drm_mode_connector_attach_encoder(struct drm_connector *connector,
950 struct drm_encoder *encoder);
951extern void drm_mode_connector_detach_encoder(struct drm_connector *connector,
952 struct drm_encoder *encoder);
4cae5b84 953extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
f453ba04 954 int gamma_size);
7a9c9060
DV		 955extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
956 uint32_t id, uint32_t type);
f453ba04
DA		 957/* IOCTLs */
958extern int drm_mode_getresources(struct drm_device *dev,
959 void *data, struct drm_file *file_priv);
8cf5c917
JB		 960extern int drm_mode_getplane_res(struct drm_device *dev, void *data,
961 struct drm_file *file_priv);
f453ba04
DA		 962extern int drm_mode_getcrtc(struct drm_device *dev,
963 void *data, struct drm_file *file_priv);
964extern int drm_mode_getconnector(struct drm_device *dev,
965 void *data, struct drm_file *file_priv);
966extern int drm_mode_setcrtc(struct drm_device *dev,
967 void *data, struct drm_file *file_priv);
8cf5c917
JB		 968extern int drm_mode_getplane(struct drm_device *dev,
969 void *data, struct drm_file *file_priv);
970extern int drm_mode_setplane(struct drm_device *dev,
971 void *data, struct drm_file *file_priv);
f453ba04
DA		 972extern int drm_mode_cursor_ioctl(struct drm_device *dev,
973 void *data, struct drm_file *file_priv);
974extern int drm_mode_addfb(struct drm_device *dev,
975 void *data, struct drm_file *file_priv);
308e5bcb
JB		 976extern int drm_mode_addfb2(struct drm_device *dev,
977 void *data, struct drm_file *file_priv);
978extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
f453ba04
DA		 979extern int drm_mode_rmfb(struct drm_device *dev,
980 void *data, struct drm_file *file_priv);
981extern int drm_mode_getfb(struct drm_device *dev,
982 void *data, struct drm_file *file_priv);
884840aa
JB		 983extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
984 void *data, struct drm_file *file_priv);
f453ba04
DA		 985extern int drm_mode_addmode_ioctl(struct drm_device *dev,
986 void *data, struct drm_file *file_priv);
987extern int drm_mode_rmmode_ioctl(struct drm_device *dev,
988 void *data, struct drm_file *file_priv);
989extern int drm_mode_attachmode_ioctl(struct drm_device *dev,
990 void *data, struct drm_file *file_priv);
991extern int drm_mode_detachmode_ioctl(struct drm_device *dev,
992 void *data, struct drm_file *file_priv);
993
994extern int drm_mode_getproperty_ioctl(struct drm_device *dev,
995 void *data, struct drm_file *file_priv);
996extern int drm_mode_getblob_ioctl(struct drm_device *dev,
997 void *data, struct drm_file *file_priv);
998extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
999 void *data, struct drm_file *file_priv);
1000extern int drm_mode_hotplug_ioctl(struct drm_device *dev,
1001 void *data, struct drm_file *file_priv);
1002extern int drm_mode_replacefb(struct drm_device *dev,
1003 void *data, struct drm_file *file_priv);
1004extern int drm_mode_getencoder(struct drm_device *dev,
1005 void *data, struct drm_file *file_priv);
1006extern int drm_mode_gamma_get_ioctl(struct drm_device *dev,
1007 void *data, struct drm_file *file_priv);
1008extern int drm_mode_gamma_set_ioctl(struct drm_device *dev,
1009 void *data, struct drm_file *file_priv);
eccaca28 1010extern u8 *drm_find_cea_extension(struct edid *edid);
f23c20c8 1011extern bool drm_detect_hdmi_monitor(struct edid *edid);
8fe9790d 1012extern bool drm_detect_monitor_audio(struct edid *edid);
d91d8a3f
KH		 1013extern int drm_mode_page_flip_ioctl(struct drm_device *dev,
1014 void *data, struct drm_file *file_priv);
d782c3f9
ZY		 1015extern struct drm_display_mode *drm_cvt_mode(struct drm_device *dev,
1016 int hdisplay, int vdisplay, int vrefresh,
d50ba256 1017 bool reduced, bool interlaced, bool margins);
26bbdada
ZY		 1018extern struct drm_display_mode *drm_gtf_mode(struct drm_device *dev,
1019 int hdisplay, int vdisplay, int vrefresh,
1020 bool interlaced, int margins);
7a374350
AJ		 1021extern struct drm_display_mode *drm_gtf_mode_complex(struct drm_device *dev,
1022 int hdisplay, int vdisplay, int vrefresh,
1023 bool interlaced, int margins, int GTF_M,
1024 int GTF_2C, int GTF_K, int GTF_2J);
f0fda0a4
ZY		 1025extern int drm_add_modes_noedid(struct drm_connector *connector,
1026 int hdisplay, int vdisplay);
3c537889 1027
051963d4 1028extern int drm_edid_header_is_valid(const u8 *raw_edid);
f89ec8a4 1029extern bool drm_edid_block_valid(u8 *raw_edid, int block);
3c537889 1030extern bool drm_edid_is_valid(struct edid *edid);
1d42bbc8 1031struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
f6e252ba
AJ		 1032 int hsize, int vsize, int fresh,
1033 bool rb);
ff72145b
DA		 1034
1035extern int drm_mode_create_dumb_ioctl(struct drm_device *dev,
1036 void *data, struct drm_file *file_priv);
1037extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
1038 void *data, struct drm_file *file_priv);
1039extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
1040 void *data, struct drm_file *file_priv);
c543188a
PZ		 1041extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
1042 struct drm_file *file_priv);
1043extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
1044 struct drm_file *file_priv);
248dbc23
DA		 1045
1046extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
1047 int *bpp);
141670e9 1048extern int drm_format_num_planes(uint32_t format);
5a86bd55 1049extern int drm_format_plane_cpp(uint32_t format, int plane);
01b68b04
VS		 1050extern int drm_format_horz_chroma_subsampling(uint32_t format);
1051extern int drm_format_vert_chroma_subsampling(uint32_t format);
141670e9 1052
f453ba04 1053#endif /* __DRM_CRTC_H__ */
Linux 6.x block layer and io_uring tree(s)