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