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