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> 32 #include <linux/fb.h> 33 #include <linux/hdmi.h> 34 #include <uapi_drm/drm_mode.h> 35 #include <uapi_drm/drm_fourcc.h> 36 #include <drm/drm_modeset_lock.h> 37 38 struct drm_device; 39 struct drm_mode_set; 40 struct drm_framebuffer; 41 struct drm_object_properties; 42 struct drm_file; 43 struct drm_clip_rect; 44 45 #define DRM_MODE_OBJECT_CRTC 0xcccccccc 46 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0 47 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0 48 #define DRM_MODE_OBJECT_MODE 0xdededede 49 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0 50 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb 51 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb 52 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee 53 #define DRM_MODE_OBJECT_BRIDGE 0xbdbdbdbd 54 #define DRM_MODE_OBJECT_ANY 0 55 56 struct drm_mode_object { 57 uint32_t id; 58 uint32_t type; 59 struct drm_object_properties *properties; 60 }; 61 62 #define DRM_OBJECT_MAX_PROPERTY 24 63 struct drm_object_properties { 64 int count; 65 uint32_t ids[DRM_OBJECT_MAX_PROPERTY]; 66 uint64_t values[DRM_OBJECT_MAX_PROPERTY]; 67 }; 68 69 static inline int64_t U642I64(uint64_t val) 70 { 71 return (int64_t)*((int64_t *)&val); 72 } 73 static inline uint64_t I642U64(int64_t val) 74 { 75 return (uint64_t)*((uint64_t *)&val); 76 } 77 78 enum drm_connector_force { 79 DRM_FORCE_UNSPECIFIED, 80 DRM_FORCE_OFF, 81 DRM_FORCE_ON, /* force on analog part normally */ 82 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */ 83 }; 84 85 #include <drm/drm_modes.h> 86 87 enum drm_connector_status { 88 connector_status_connected = 1, 89 connector_status_disconnected = 2, 90 connector_status_unknown = 3, 91 }; 92 93 enum subpixel_order { 94 SubPixelUnknown = 0, 95 SubPixelHorizontalRGB, 96 SubPixelHorizontalBGR, 97 SubPixelVerticalRGB, 98 SubPixelVerticalBGR, 99 SubPixelNone, 100 }; 101 102 #define DRM_COLOR_FORMAT_RGB444 (1<<0) 103 #define DRM_COLOR_FORMAT_YCRCB444 (1<<1) 104 #define DRM_COLOR_FORMAT_YCRCB422 (1<<2) 105 /* 106 * Describes a given display (e.g. CRT or flat panel) and its limitations. 107 */ 108 struct drm_display_info { 109 char name[DRM_DISPLAY_INFO_LEN]; 110 111 /* Physical size */ 112 unsigned int width_mm; 113 unsigned int height_mm; 114 115 /* Clock limits FIXME: storage format */ 116 unsigned int min_vfreq, max_vfreq; 117 unsigned int min_hfreq, max_hfreq; 118 unsigned int pixel_clock; 119 unsigned int bpc; 120 121 enum subpixel_order subpixel_order; 122 u32 color_formats; 123 124 /* Mask of supported hdmi deep color modes */ 125 u8 edid_hdmi_dc_modes; 126 127 u8 cea_rev; 128 }; 129 130 struct drm_framebuffer_funcs { 131 /* note: use drm_framebuffer_remove() */ 132 void (*destroy)(struct drm_framebuffer *framebuffer); 133 int (*create_handle)(struct drm_framebuffer *fb, 134 struct drm_file *file_priv, 135 unsigned int *handle); 136 /** 137 * Optinal callback for the dirty fb ioctl. 138 * 139 * Userspace can notify the driver via this callback 140 * that a area of the framebuffer has changed and should 141 * be flushed to the display hardware. 142 * 143 * See documentation in drm_mode.h for the struct 144 * drm_mode_fb_dirty_cmd for more information as all 145 * the semantics and arguments have a one to one mapping 146 * on this function. 147 */ 148 int (*dirty)(struct drm_framebuffer *framebuffer, 149 struct drm_file *file_priv, unsigned flags, 150 unsigned color, struct drm_clip_rect *clips, 151 unsigned num_clips); 152 }; 153 154 struct drm_framebuffer { 155 struct drm_device *dev; 156 /* 157 * Note that the fb is refcounted for the benefit of driver internals, 158 * for example some hw, disabling a CRTC/plane is asynchronous, and 159 * scanout does not actually complete until the next vblank. So some 160 * cleanup (like releasing the reference(s) on the backing GEM bo(s)) 161 * should be deferred. In cases like this, the driver would like to 162 * hold a ref to the fb even though it has already been removed from 163 * userspace perspective. 164 */ 165 struct kref refcount; 166 /* 167 * Place on the dev->mode_config.fb_list, access protected by 168 * dev->mode_config.fb_lock. 169 */ 170 struct list_head head; 171 struct drm_mode_object base; 172 const struct drm_framebuffer_funcs *funcs; 173 unsigned int pitches[4]; 174 unsigned int offsets[4]; 175 unsigned int width; 176 unsigned int height; 177 /* depth can be 15 or 16 */ 178 unsigned int depth; 179 int bits_per_pixel; 180 int flags; 181 uint32_t pixel_format; /* fourcc format */ 182 struct list_head filp_head; 183 /* if you are using the helper */ 184 void *helper_private; 185 }; 186 187 struct drm_property_blob { 188 struct drm_mode_object base; 189 struct list_head head; 190 unsigned int length; 191 unsigned char data[]; 192 }; 193 194 struct drm_property_enum { 195 uint64_t value; 196 struct list_head head; 197 char name[DRM_PROP_NAME_LEN]; 198 }; 199 200 struct drm_property { 201 struct list_head head; 202 struct drm_mode_object base; 203 uint32_t flags; 204 char name[DRM_PROP_NAME_LEN]; 205 uint32_t num_values; 206 uint64_t *values; 207 struct drm_device *dev; 208 209 struct list_head enum_blob_list; 210 }; 211 212 void drm_modeset_lock_all(struct drm_device *dev); 213 void drm_modeset_unlock_all(struct drm_device *dev); 214 void drm_warn_on_modeset_not_all_locked(struct drm_device *dev); 215 216 struct drm_crtc; 217 struct drm_connector; 218 struct drm_encoder; 219 struct drm_pending_vblank_event; 220 struct drm_plane; 221 struct drm_bridge; 222 223 /** 224 * drm_crtc_funcs - control CRTCs for a given device 225 * @save: save CRTC state 226 * @restore: restore CRTC state 227 * @reset: reset CRTC after state has been invalidated (e.g. resume) 228 * @cursor_set: setup the cursor 229 * @cursor_move: move the cursor 230 * @gamma_set: specify color ramp for CRTC 231 * @destroy: deinit and free object 232 * @set_property: called when a property is changed 233 * @set_config: apply a new CRTC configuration 234 * @page_flip: initiate a page flip 235 * 236 * The drm_crtc_funcs structure is the central CRTC management structure 237 * in the DRM. Each CRTC controls one or more connectors (note that the name 238 * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc. 239 * connectors, not just CRTs). 240 * 241 * Each driver is responsible for filling out this structure at startup time, 242 * in addition to providing other modesetting features, like i2c and DDC 243 * bus accessors. 244 */ 245 struct drm_crtc_funcs { 246 /* Save CRTC state */ 247 void (*save)(struct drm_crtc *crtc); /* suspend? */ 248 /* Restore CRTC state */ 249 void (*restore)(struct drm_crtc *crtc); /* resume? */ 250 /* Reset CRTC state */ 251 void (*reset)(struct drm_crtc *crtc); 252 253 /* cursor controls */ 254 int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv, 255 uint32_t handle, uint32_t width, uint32_t height); 256 int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv, 257 uint32_t handle, uint32_t width, uint32_t height, 258 int32_t hot_x, int32_t hot_y); 259 int (*cursor_move)(struct drm_crtc *crtc, int x, int y); 260 261 /* Set gamma on the CRTC */ 262 void (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b, 263 uint32_t start, uint32_t size); 264 /* Object destroy routine */ 265 void (*destroy)(struct drm_crtc *crtc); 266 267 int (*set_config)(struct drm_mode_set *set); 268 269 /* 270 * Flip to the given framebuffer. This implements the page 271 * flip ioctl described in drm_mode.h, specifically, the 272 * implementation must return immediately and block all 273 * rendering to the current fb until the flip has completed. 274 * If userspace set the event flag in the ioctl, the event 275 * argument will point to an event to send back when the flip 276 * completes, otherwise it will be NULL. 277 */ 278 int (*page_flip)(struct drm_crtc *crtc, 279 struct drm_framebuffer *fb, 280 struct drm_pending_vblank_event *event, 281 uint32_t flags); 282 283 int (*set_property)(struct drm_crtc *crtc, 284 struct drm_property *property, uint64_t val); 285 }; 286 287 /** 288 * drm_crtc - central CRTC control structure 289 * @dev: parent DRM device 290 * @head: list management 291 * @mutex: per-CRTC locking 292 * @base: base KMS object for ID tracking etc. 293 * @primary: primary plane for this CRTC 294 * @cursor: cursor plane for this CRTC 295 * @enabled: is this CRTC enabled? 296 * @mode: current mode timings 297 * @hwmode: mode timings as programmed to hw regs 298 * @invert_dimensions: for purposes of error checking crtc vs fb sizes, 299 * invert the width/height of the crtc. This is used if the driver 300 * is performing 90 or 270 degree rotated scanout 301 * @x: x position on screen 302 * @y: y position on screen 303 * @funcs: CRTC control functions 304 * @gamma_size: size of gamma ramp 305 * @gamma_store: gamma ramp values 306 * @framedur_ns: precise frame timing 307 * @framedur_ns: precise line timing 308 * @pixeldur_ns: precise pixel timing 309 * @helper_private: mid-layer private data 310 * @properties: property tracking for this CRTC 311 * 312 * Each CRTC may have one or more connectors associated with it. This structure 313 * allows the CRTC to be controlled. 314 */ 315 struct drm_crtc { 316 struct drm_device *dev; 317 struct list_head head; 318 319 /** 320 * crtc mutex 321 * 322 * This provides a read lock for the overall crtc state (mode, dpms 323 * state, ...) and a write lock for everything which can be update 324 * without a full modeset (fb, cursor data, ...) 325 */ 326 struct drm_modeset_lock mutex; 327 328 struct drm_mode_object base; 329 330 /* primary and cursor planes for CRTC */ 331 struct drm_plane *primary; 332 struct drm_plane *cursor; 333 334 /* position of cursor plane on crtc */ 335 int cursor_x; 336 int cursor_y; 337 338 /* Temporary tracking of the old fb while a modeset is ongoing. Used 339 * by drm_mode_set_config_internal to implement correct refcounting. */ 340 struct drm_framebuffer *old_fb; 341 342 bool enabled; 343 344 /* Requested mode from modesetting. */ 345 struct drm_display_mode mode; 346 347 /* Programmed mode in hw, after adjustments for encoders, 348 * crtc, panel scaling etc. Needed for timestamping etc. 349 */ 350 struct drm_display_mode hwmode; 351 352 bool invert_dimensions; 353 354 int x, y; 355 const struct drm_crtc_funcs *funcs; 356 357 /* CRTC gamma size for reporting to userspace */ 358 uint32_t gamma_size; 359 uint16_t *gamma_store; 360 361 /* Constants needed for precise vblank and swap timestamping. */ 362 int framedur_ns, linedur_ns, pixeldur_ns; 363 364 /* if you are using the helper */ 365 void *helper_private; 366 367 struct drm_object_properties properties; 368 }; 369 370 371 /** 372 * drm_connector_funcs - control connectors on a given device 373 * @dpms: set power state (see drm_crtc_funcs above) 374 * @save: save connector state 375 * @restore: restore connector state 376 * @reset: reset connector after state has been invalidated (e.g. resume) 377 * @detect: is this connector active? 378 * @fill_modes: fill mode list for this connector 379 * @set_property: property for this connector may need an update 380 * @destroy: make object go away 381 * @force: notify the driver that the connector is forced on 382 * 383 * Each CRTC may have one or more connectors attached to it. The functions 384 * below allow the core DRM code to control connectors, enumerate available modes, 385 * etc. 386 */ 387 struct drm_connector_funcs { 388 void (*dpms)(struct drm_connector *connector, int mode); 389 void (*save)(struct drm_connector *connector); 390 void (*restore)(struct drm_connector *connector); 391 void (*reset)(struct drm_connector *connector); 392 393 /* Check to see if anything is attached to the connector. 394 * @force is set to false whilst polling, true when checking the 395 * connector due to user request. @force can be used by the driver 396 * to avoid expensive, destructive operations during automated 397 * probing. 398 */ 399 enum drm_connector_status (*detect)(struct drm_connector *connector, 400 bool force); 401 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height); 402 int (*set_property)(struct drm_connector *connector, struct drm_property *property, 403 uint64_t val); 404 void (*destroy)(struct drm_connector *connector); 405 void (*force)(struct drm_connector *connector); 406 }; 407 408 /** 409 * drm_encoder_funcs - encoder controls 410 * @reset: reset state (e.g. at init or resume time) 411 * @destroy: cleanup and free associated data 412 * 413 * Encoders sit between CRTCs and connectors. 414 */ 415 struct drm_encoder_funcs { 416 void (*reset)(struct drm_encoder *encoder); 417 void (*destroy)(struct drm_encoder *encoder); 418 }; 419 420 #define DRM_CONNECTOR_MAX_ENCODER 3 421 422 /** 423 * drm_encoder - central DRM encoder structure 424 * @dev: parent DRM device 425 * @head: list management 426 * @base: base KMS object 427 * @name: encoder name 428 * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h 429 * @possible_crtcs: bitmask of potential CRTC bindings 430 * @possible_clones: bitmask of potential sibling encoders for cloning 431 * @crtc: currently bound CRTC 432 * @bridge: bridge associated to the encoder 433 * @funcs: control functions 434 * @helper_private: mid-layer private data 435 * 436 * CRTCs drive pixels to encoders, which convert them into signals 437 * appropriate for a given connector or set of connectors. 438 */ 439 struct drm_encoder { 440 struct drm_device *dev; 441 struct list_head head; 442 443 struct drm_mode_object base; 444 char *name; 445 int encoder_type; 446 uint32_t possible_crtcs; 447 uint32_t possible_clones; 448 449 struct drm_crtc *crtc; 450 struct drm_bridge *bridge; 451 const struct drm_encoder_funcs *funcs; 452 void *helper_private; 453 }; 454 455 /* should we poll this connector for connects and disconnects */ 456 /* hot plug detectable */ 457 #define DRM_CONNECTOR_POLL_HPD (1 << 0) 458 /* poll for connections */ 459 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1) 460 /* can cleanly poll for disconnections without flickering the screen */ 461 /* DACs should rarely do this without a lot of testing */ 462 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2) 463 464 #define MAX_ELD_BYTES 128 465 466 /** 467 * drm_connector - central DRM connector control structure 468 * @dev: parent DRM device 469 * @kdev: kernel device for sysfs attributes 470 * @attr: sysfs attributes 471 * @head: list management 472 * @base: base KMS object 473 * @name: connector name 474 * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h 475 * @connector_type_id: index into connector type enum 476 * @interlace_allowed: can this connector handle interlaced modes? 477 * @doublescan_allowed: can this connector handle doublescan? 478 * @modes: modes available on this connector (from fill_modes() + user) 479 * @status: one of the drm_connector_status enums (connected, not, or unknown) 480 * @probed_modes: list of modes derived directly from the display 481 * @display_info: information about attached display (e.g. from EDID) 482 * @funcs: connector control functions 483 * @edid_blob_ptr: DRM property containing EDID if present 484 * @properties: property tracking for this connector 485 * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling 486 * @dpms: current dpms state 487 * @helper_private: mid-layer private data 488 * @force: a %DRM_FORCE_<foo> state for forced mode sets 489 * @encoder_ids: valid encoders for this connector 490 * @encoder: encoder driving this connector, if any 491 * @eld: EDID-like data, if present 492 * @dvi_dual: dual link DVI, if found 493 * @max_tmds_clock: max clock rate, if found 494 * @latency_present: AV delay info from ELD, if found 495 * @video_latency: video latency info from ELD, if found 496 * @audio_latency: audio latency info from ELD, if found 497 * @null_edid_counter: track sinks that give us all zeros for the EDID 498 * 499 * Each connector may be connected to one or more CRTCs, or may be clonable by 500 * another connector if they can share a CRTC. Each connector also has a specific 501 * position in the broader display (referred to as a 'screen' though it could 502 * span multiple monitors). 503 */ 504 struct drm_connector { 505 struct drm_device *dev; 506 struct device *kdev; 507 struct device_attribute *attr; 508 struct list_head head; 509 510 struct drm_mode_object base; 511 512 char *name; 513 int connector_type; 514 int connector_type_id; 515 bool interlace_allowed; 516 bool doublescan_allowed; 517 bool stereo_allowed; 518 struct list_head modes; /* list of modes on this connector */ 519 520 enum drm_connector_status status; 521 522 /* these are modes added by probing with DDC or the BIOS */ 523 struct list_head probed_modes; 524 525 struct drm_display_info display_info; 526 const struct drm_connector_funcs *funcs; 527 528 struct drm_property_blob *edid_blob_ptr; 529 struct drm_object_properties properties; 530 531 struct drm_property_blob *path_blob_ptr; 532 533 uint8_t polled; /* DRM_CONNECTOR_POLL_* */ 534 535 /* requested DPMS state */ 536 int dpms; 537 538 void *helper_private; 539 540 /* forced on connector */ 541 enum drm_connector_force force; 542 bool override_edid; 543 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER]; 544 struct drm_encoder *encoder; /* currently active encoder */ 545 546 /* EDID bits */ 547 uint8_t eld[MAX_ELD_BYTES]; 548 bool dvi_dual; 549 int max_tmds_clock; /* in MHz */ 550 bool latency_present[2]; 551 int video_latency[2]; /* [0]: progressive, [1]: interlaced */ 552 int audio_latency[2]; 553 int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */ 554 unsigned bad_edid_counter; 555 556 void *debugfs_entry; 557 }; 558 559 /** 560 * drm_plane_funcs - driver plane control functions 561 * @update_plane: update the plane configuration 562 * @disable_plane: shut down the plane 563 * @destroy: clean up plane resources 564 * @set_property: called when a property is changed 565 */ 566 struct drm_plane_funcs { 567 int (*update_plane)(struct drm_plane *plane, 568 struct drm_crtc *crtc, struct drm_framebuffer *fb, 569 int crtc_x, int crtc_y, 570 unsigned int crtc_w, unsigned int crtc_h, 571 uint32_t src_x, uint32_t src_y, 572 uint32_t src_w, uint32_t src_h); 573 int (*disable_plane)(struct drm_plane *plane); 574 void (*destroy)(struct drm_plane *plane); 575 576 int (*set_property)(struct drm_plane *plane, 577 struct drm_property *property, uint64_t val); 578 }; 579 580 enum drm_plane_type { 581 DRM_PLANE_TYPE_OVERLAY, 582 DRM_PLANE_TYPE_PRIMARY, 583 DRM_PLANE_TYPE_CURSOR, 584 }; 585 586 /** 587 * drm_plane - central DRM plane control structure 588 * @dev: DRM device this plane belongs to 589 * @head: for list management 590 * @base: base mode object 591 * @possible_crtcs: pipes this plane can be bound to 592 * @format_types: array of formats supported by this plane 593 * @format_count: number of formats supported 594 * @crtc: currently bound CRTC 595 * @fb: currently bound fb 596 * @funcs: helper functions 597 * @properties: property tracking for this plane 598 * @type: type of plane (overlay, primary, cursor) 599 */ 600 struct drm_plane { 601 struct drm_device *dev; 602 struct list_head head; 603 604 struct drm_mode_object base; 605 606 uint32_t possible_crtcs; 607 uint32_t *format_types; 608 uint32_t format_count; 609 610 struct drm_crtc *crtc; 611 struct drm_framebuffer *fb; 612 613 const struct drm_plane_funcs *funcs; 614 615 struct drm_object_properties properties; 616 617 enum drm_plane_type type; 618 }; 619 620 /** 621 * drm_bridge_funcs - drm_bridge control functions 622 * @mode_fixup: Try to fixup (or reject entirely) proposed mode for this bridge 623 * @disable: Called right before encoder prepare, disables the bridge 624 * @post_disable: Called right after encoder prepare, for lockstepped disable 625 * @mode_set: Set this mode to the bridge 626 * @pre_enable: Called right before encoder commit, for lockstepped commit 627 * @enable: Called right after encoder commit, enables the bridge 628 * @destroy: make object go away 629 */ 630 struct drm_bridge_funcs { 631 bool (*mode_fixup)(struct drm_bridge *bridge, 632 const struct drm_display_mode *mode, 633 struct drm_display_mode *adjusted_mode); 634 void (*disable)(struct drm_bridge *bridge); 635 void (*post_disable)(struct drm_bridge *bridge); 636 void (*mode_set)(struct drm_bridge *bridge, 637 struct drm_display_mode *mode, 638 struct drm_display_mode *adjusted_mode); 639 void (*pre_enable)(struct drm_bridge *bridge); 640 void (*enable)(struct drm_bridge *bridge); 641 void (*destroy)(struct drm_bridge *bridge); 642 }; 643 644 /** 645 * drm_bridge - central DRM bridge control structure 646 * @dev: DRM device this bridge belongs to 647 * @head: list management 648 * @base: base mode object 649 * @funcs: control functions 650 * @driver_private: pointer to the bridge driver's internal context 651 */ 652 struct drm_bridge { 653 struct drm_device *dev; 654 struct list_head head; 655 656 struct drm_mode_object base; 657 658 const struct drm_bridge_funcs *funcs; 659 void *driver_private; 660 }; 661 662 /** 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 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 */ 678 struct drm_mode_set { 679 struct drm_framebuffer *fb; 680 struct drm_crtc *crtc; 681 struct drm_display_mode *mode; 682 683 uint32_t x; 684 uint32_t y; 685 686 struct drm_connector **connectors; 687 size_t num_connectors; 688 }; 689 690 /** 691 * struct drm_mode_config_funcs - basic driver provided mode setting functions 692 * @fb_create: create a new framebuffer object 693 * @output_poll_changed: function to handle output configuration changes 694 * 695 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that 696 * involve drivers. 697 */ 698 struct drm_mode_config_funcs { 699 struct drm_framebuffer *(*fb_create)(struct drm_device *dev, 700 struct drm_file *file_priv, 701 struct drm_mode_fb_cmd2 *mode_cmd); 702 void (*output_poll_changed)(struct drm_device *dev); 703 }; 704 705 /** 706 * drm_mode_group - group of mode setting resources for potential sub-grouping 707 * @num_crtcs: CRTC count 708 * @num_encoders: encoder count 709 * @num_connectors: connector count 710 * @id_list: list of KMS object IDs in this group 711 * 712 * Currently this simply tracks the global mode setting state. But in the 713 * future it could allow groups of objects to be set aside into independent 714 * control groups for use by different user level processes (e.g. two X servers 715 * running simultaneously on different heads, each with their own mode 716 * configuration and freedom of mode setting). 717 */ 718 struct drm_mode_group { 719 uint32_t num_crtcs; 720 uint32_t num_encoders; 721 uint32_t num_connectors; 722 uint32_t num_bridges; 723 724 /* list of object IDs for this group */ 725 uint32_t *id_list; 726 }; 727 728 /** 729 * drm_mode_config - Mode configuration control structure 730 * @mutex: mutex protecting KMS related lists and structures 731 * @idr_mutex: mutex for KMS ID allocation and management 732 * @crtc_idr: main KMS ID tracking object 733 * @num_fb: number of fbs available 734 * @fb_list: list of framebuffers available 735 * @num_connector: number of connectors on this device 736 * @connector_list: list of connector objects 737 * @num_bridge: number of bridges on this device 738 * @bridge_list: list of bridge objects 739 * @num_encoder: number of encoders on this device 740 * @encoder_list: list of encoder objects 741 * @num_crtc: number of CRTCs on this device 742 * @crtc_list: list of CRTC objects 743 * @min_width: minimum pixel width on this device 744 * @min_height: minimum pixel height on this device 745 * @max_width: maximum pixel width on this device 746 * @max_height: maximum pixel height on this device 747 * @funcs: core driver provided mode setting functions 748 * @fb_base: base address of the framebuffer 749 * @poll_enabled: track polling status for this device 750 * @output_poll_work: delayed work for polling in process context 751 * @*_property: core property tracking 752 * 753 * Core mode resource tracking structure. All CRTC, encoders, and connectors 754 * enumerated by the driver are added here, as are global properties. Some 755 * global restrictions are also here, e.g. dimension restrictions. 756 */ 757 struct drm_mode_config { 758 struct lock mutex; /* protects configuration (mode lists etc.) */ 759 struct drm_modeset_lock connection_mutex; /* protects connector->encoder and encoder->crtc links */ 760 struct drm_modeset_acquire_ctx *acquire_ctx; /* for legacy _lock_all() / _unlock_all() */ 761 struct lock idr_mutex; /* for IDR management */ 762 struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */ 763 /* this is limited to one for now */ 764 765 766 /** 767 * fb_lock - mutex to protect fb state 768 * 769 * Besides the global fb list his also protects the fbs list in the 770 * file_priv 771 */ 772 struct lock fb_lock; 773 int num_fb; 774 struct list_head fb_list; 775 776 int num_connector; 777 struct list_head connector_list; 778 int num_bridge; 779 struct list_head bridge_list; 780 int num_encoder; 781 struct list_head encoder_list; 782 783 /* 784 * Track # of overlay planes separately from # of total planes. By 785 * default we only advertise overlay planes to userspace; if userspace 786 * sets the "universal plane" capability bit, we'll go ahead and 787 * expose all planes. 788 */ 789 int num_overlay_plane; 790 int num_total_plane; 791 struct list_head plane_list; 792 793 int num_crtc; 794 struct list_head crtc_list; 795 796 struct list_head property_list; 797 798 int min_width, min_height; 799 int max_width, max_height; 800 const struct drm_mode_config_funcs *funcs; 801 resource_size_t fb_base; 802 803 /* output poll support */ 804 bool poll_enabled; 805 bool poll_running; 806 struct delayed_work output_poll_work; 807 808 /* pointers to standard properties */ 809 struct list_head property_blob_list; 810 struct drm_property *edid_property; 811 struct drm_property *dpms_property; 812 struct drm_property *path_property; 813 struct drm_property *plane_type_property; 814 815 /* DVI-I properties */ 816 struct drm_property *dvi_i_subconnector_property; 817 struct drm_property *dvi_i_select_subconnector_property; 818 819 /* TV properties */ 820 struct drm_property *tv_subconnector_property; 821 struct drm_property *tv_select_subconnector_property; 822 struct drm_property *tv_mode_property; 823 struct drm_property *tv_left_margin_property; 824 struct drm_property *tv_right_margin_property; 825 struct drm_property *tv_top_margin_property; 826 struct drm_property *tv_bottom_margin_property; 827 struct drm_property *tv_brightness_property; 828 struct drm_property *tv_contrast_property; 829 struct drm_property *tv_flicker_reduction_property; 830 struct drm_property *tv_overscan_property; 831 struct drm_property *tv_saturation_property; 832 struct drm_property *tv_hue_property; 833 834 /* Optional properties */ 835 struct drm_property *scaling_mode_property; 836 struct drm_property *aspect_ratio_property; 837 struct drm_property *dirty_info_property; 838 839 /* dumb ioctl parameters */ 840 uint32_t preferred_depth, prefer_shadow; 841 842 /* whether async page flip is supported or not */ 843 bool async_page_flip; 844 845 /* cursor size */ 846 uint32_t cursor_width, cursor_height; 847 }; 848 849 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base) 850 #define obj_to_connector(x) container_of(x, struct drm_connector, base) 851 #define obj_to_encoder(x) container_of(x, struct drm_encoder, base) 852 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base) 853 #define obj_to_fb(x) container_of(x, struct drm_framebuffer, base) 854 #define obj_to_property(x) container_of(x, struct drm_property, base) 855 #define obj_to_blob(x) container_of(x, struct drm_property_blob, base) 856 #define obj_to_plane(x) container_of(x, struct drm_plane, base) 857 858 struct drm_prop_enum_list { 859 int type; 860 char *name; 861 }; 862 863 extern int drm_crtc_init_with_planes(struct drm_device *dev, 864 struct drm_crtc *crtc, 865 struct drm_plane *primary, 866 struct drm_plane *cursor, 867 const struct drm_crtc_funcs *funcs); 868 extern int drm_crtc_init(struct drm_device *dev, 869 struct drm_crtc *crtc, 870 const struct drm_crtc_funcs *funcs); 871 extern void drm_crtc_cleanup(struct drm_crtc *crtc); 872 extern unsigned int drm_crtc_index(struct drm_crtc *crtc); 873 874 /** 875 * drm_crtc_mask - find the mask of a registered CRTC 876 * @crtc: CRTC to find mask for 877 * 878 * Given a registered CRTC, return the mask bit of that CRTC for an 879 * encoder's possible_crtcs field. 880 */ 881 static inline uint32_t drm_crtc_mask(struct drm_crtc *crtc) 882 { 883 return 1 << drm_crtc_index(crtc); 884 } 885 886 extern void drm_connector_ida_init(void); 887 extern void drm_connector_ida_destroy(void); 888 extern int drm_connector_init(struct drm_device *dev, 889 struct drm_connector *connector, 890 const struct drm_connector_funcs *funcs, 891 int connector_type); 892 int drm_connector_register(struct drm_connector *connector); 893 void drm_connector_unregister(struct drm_connector *connector); 894 895 extern void drm_connector_cleanup(struct drm_connector *connector); 896 /* helper to unplug all connectors from sysfs for device */ 897 extern void drm_connector_unplug_all(struct drm_device *dev); 898 899 extern int drm_bridge_init(struct drm_device *dev, struct drm_bridge *bridge, 900 const struct drm_bridge_funcs *funcs); 901 extern void drm_bridge_cleanup(struct drm_bridge *bridge); 902 903 extern int drm_encoder_init(struct drm_device *dev, 904 struct drm_encoder *encoder, 905 const struct drm_encoder_funcs *funcs, 906 int encoder_type); 907 908 /** 909 * drm_encoder_crtc_ok - can a given crtc drive a given encoder? 910 * @encoder: encoder to test 911 * @crtc: crtc to test 912 * 913 * Return false if @encoder can't be driven by @crtc, true otherwise. 914 */ 915 static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder, 916 struct drm_crtc *crtc) 917 { 918 return !!(encoder->possible_crtcs & drm_crtc_mask(crtc)); 919 } 920 921 extern int drm_universal_plane_init(struct drm_device *dev, 922 struct drm_plane *plane, 923 unsigned long possible_crtcs, 924 const struct drm_plane_funcs *funcs, 925 const uint32_t *formats, 926 uint32_t format_count, 927 enum drm_plane_type type); 928 extern int drm_plane_init(struct drm_device *dev, 929 struct drm_plane *plane, 930 unsigned long possible_crtcs, 931 const struct drm_plane_funcs *funcs, 932 const uint32_t *formats, uint32_t format_count, 933 bool is_primary); 934 extern void drm_plane_cleanup(struct drm_plane *plane); 935 extern void drm_plane_force_disable(struct drm_plane *plane); 936 extern int drm_crtc_check_viewport(const struct drm_crtc *crtc, 937 int x, int y, 938 const struct drm_display_mode *mode, 939 const struct drm_framebuffer *fb); 940 941 extern void drm_encoder_cleanup(struct drm_encoder *encoder); 942 943 extern const char *drm_get_connector_status_name(enum drm_connector_status status); 944 extern const char *drm_get_subpixel_order_name(enum subpixel_order order); 945 extern const char *drm_get_dpms_name(int val); 946 extern const char *drm_get_dvi_i_subconnector_name(int val); 947 extern const char *drm_get_dvi_i_select_name(int val); 948 extern const char *drm_get_tv_subconnector_name(int val); 949 extern const char *drm_get_tv_select_name(int val); 950 extern void drm_fb_release(struct drm_file *file_priv); 951 extern int drm_mode_group_init_legacy_group(struct drm_device *dev, struct drm_mode_group *group); 952 extern void drm_mode_group_destroy(struct drm_mode_group *group); 953 extern void drm_reinit_primary_mode_group(struct drm_device *dev); 954 extern bool drm_probe_ddc(struct i2c_adapter *adapter); 955 extern struct edid *drm_get_edid(struct drm_connector *connector, 956 struct i2c_adapter *adapter); 957 extern struct edid *drm_edid_duplicate(const struct edid *edid); 958 extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid); 959 extern void drm_mode_config_init(struct drm_device *dev); 960 extern void drm_mode_config_reset(struct drm_device *dev); 961 extern void drm_mode_config_cleanup(struct drm_device *dev); 962 963 extern int drm_mode_connector_set_path_property(struct drm_connector *connector, 964 char *path); 965 extern int drm_mode_connector_update_edid_property(struct drm_connector *connector, 966 struct edid *edid); 967 968 static inline bool drm_property_type_is(struct drm_property *property, 969 uint32_t type) 970 { 971 /* instanceof for props.. handles extended type vs original types: */ 972 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) 973 return (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) == type; 974 return property->flags & type; 975 } 976 977 static inline bool drm_property_type_valid(struct drm_property *property) 978 { 979 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) 980 return !(property->flags & DRM_MODE_PROP_LEGACY_TYPE); 981 return !!(property->flags & DRM_MODE_PROP_LEGACY_TYPE); 982 } 983 984 extern int drm_object_property_set_value(struct drm_mode_object *obj, 985 struct drm_property *property, 986 uint64_t val); 987 extern int drm_object_property_get_value(struct drm_mode_object *obj, 988 struct drm_property *property, 989 uint64_t *value); 990 extern int drm_framebuffer_init(struct drm_device *dev, 991 struct drm_framebuffer *fb, 992 const struct drm_framebuffer_funcs *funcs); 993 extern struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev, 994 uint32_t id); 995 extern void drm_framebuffer_unreference(struct drm_framebuffer *fb); 996 extern void drm_framebuffer_reference(struct drm_framebuffer *fb); 997 extern void drm_framebuffer_remove(struct drm_framebuffer *fb); 998 extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb); 999 extern void drm_framebuffer_unregister_private(struct drm_framebuffer *fb); 1000 1001 extern void drm_object_attach_property(struct drm_mode_object *obj, 1002 struct drm_property *property, 1003 uint64_t init_val); 1004 extern struct drm_property *drm_property_create(struct drm_device *dev, int flags, 1005 const char *name, int num_values); 1006 extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags, 1007 const char *name, 1008 const struct drm_prop_enum_list *props, 1009 int num_values); 1010 struct drm_property *drm_property_create_bitmask(struct drm_device *dev, 1011 int flags, const char *name, 1012 const struct drm_prop_enum_list *props, 1013 int num_values); 1014 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags, 1015 const char *name, 1016 uint64_t min, uint64_t max); 1017 struct drm_property *drm_property_create_signed_range(struct drm_device *dev, 1018 int flags, const char *name, 1019 int64_t min, int64_t max); 1020 struct drm_property *drm_property_create_object(struct drm_device *dev, 1021 int flags, const char *name, uint32_t type); 1022 extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property); 1023 extern int drm_property_add_enum(struct drm_property *property, int index, 1024 uint64_t value, const char *name); 1025 extern int drm_mode_create_dvi_i_properties(struct drm_device *dev); 1026 extern int drm_mode_create_tv_properties(struct drm_device *dev, int num_formats, 1027 char *formats[]); 1028 extern int drm_mode_create_scaling_mode_property(struct drm_device *dev); 1029 extern int drm_mode_create_aspect_ratio_property(struct drm_device *dev); 1030 extern int drm_mode_create_dirty_info_property(struct drm_device *dev); 1031 1032 extern int drm_mode_connector_attach_encoder(struct drm_connector *connector, 1033 struct drm_encoder *encoder); 1034 extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc, 1035 int gamma_size); 1036 extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev, 1037 uint32_t id, uint32_t type); 1038 1039 /* IOCTLs */ 1040 extern int drm_mode_getresources(struct drm_device *dev, 1041 void *data, struct drm_file *file_priv); 1042 extern int drm_mode_getplane_res(struct drm_device *dev, void *data, 1043 struct drm_file *file_priv); 1044 extern int drm_mode_getcrtc(struct drm_device *dev, 1045 void *data, struct drm_file *file_priv); 1046 extern int drm_mode_getconnector(struct drm_device *dev, 1047 void *data, struct drm_file *file_priv); 1048 extern int drm_mode_set_config_internal(struct drm_mode_set *set); 1049 extern int drm_mode_setcrtc(struct drm_device *dev, 1050 void *data, struct drm_file *file_priv); 1051 extern int drm_mode_getplane(struct drm_device *dev, 1052 void *data, struct drm_file *file_priv); 1053 extern int drm_mode_setplane(struct drm_device *dev, 1054 void *data, struct drm_file *file_priv); 1055 extern int drm_mode_cursor_ioctl(struct drm_device *dev, 1056 void *data, struct drm_file *file_priv); 1057 extern int drm_mode_cursor2_ioctl(struct drm_device *dev, 1058 void *data, struct drm_file *file_priv); 1059 extern int drm_mode_addfb(struct drm_device *dev, 1060 void *data, struct drm_file *file_priv); 1061 extern int drm_mode_addfb2(struct drm_device *dev, 1062 void *data, struct drm_file *file_priv); 1063 extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth); 1064 extern int drm_mode_rmfb(struct drm_device *dev, 1065 void *data, struct drm_file *file_priv); 1066 extern int drm_mode_getfb(struct drm_device *dev, 1067 void *data, struct drm_file *file_priv); 1068 extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev, 1069 void *data, struct drm_file *file_priv); 1070 1071 extern int drm_mode_getproperty_ioctl(struct drm_device *dev, 1072 void *data, struct drm_file *file_priv); 1073 extern int drm_mode_getblob_ioctl(struct drm_device *dev, 1074 void *data, struct drm_file *file_priv); 1075 extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev, 1076 void *data, struct drm_file *file_priv); 1077 extern int drm_mode_getencoder(struct drm_device *dev, 1078 void *data, struct drm_file *file_priv); 1079 extern int drm_mode_gamma_get_ioctl(struct drm_device *dev, 1080 void *data, struct drm_file *file_priv); 1081 extern int drm_mode_gamma_set_ioctl(struct drm_device *dev, 1082 void *data, struct drm_file *file_priv); 1083 extern u8 drm_match_cea_mode(const struct drm_display_mode *to_match); 1084 extern enum hdmi_picture_aspect drm_get_cea_aspect_ratio(const u8 video_code); 1085 extern bool drm_detect_hdmi_monitor(struct edid *edid); 1086 extern bool drm_detect_monitor_audio(struct edid *edid); 1087 extern bool drm_rgb_quant_range_selectable(struct edid *edid); 1088 extern int drm_mode_page_flip_ioctl(struct drm_device *dev, 1089 void *data, struct drm_file *file_priv); 1090 extern int drm_add_modes_noedid(struct drm_connector *connector, 1091 int hdisplay, int vdisplay); 1092 extern void drm_set_preferred_mode(struct drm_connector *connector, 1093 int hpref, int vpref); 1094 1095 extern int drm_edid_header_is_valid(const u8 *raw_edid); 1096 extern bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid); 1097 extern bool drm_edid_is_valid(struct edid *edid); 1098 struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev, 1099 int hsize, int vsize, int fresh, 1100 bool rb); 1101 1102 extern int drm_mode_create_dumb_ioctl(struct drm_device *dev, 1103 void *data, struct drm_file *file_priv); 1104 extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev, 1105 void *data, struct drm_file *file_priv); 1106 extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev, 1107 void *data, struct drm_file *file_priv); 1108 extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data, 1109 struct drm_file *file_priv); 1110 extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data, 1111 struct drm_file *file_priv); 1112 1113 extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth, 1114 int *bpp); 1115 extern int drm_format_num_planes(uint32_t format); 1116 extern int drm_format_plane_cpp(uint32_t format, int plane); 1117 extern int drm_format_horz_chroma_subsampling(uint32_t format); 1118 extern int drm_format_vert_chroma_subsampling(uint32_t format); 1119 extern const char *drm_get_format_name(uint32_t format); 1120 1121 /* Helpers */ 1122 1123 static inline struct drm_plane *drm_plane_find(struct drm_device *dev, 1124 uint32_t id) 1125 { 1126 struct drm_mode_object *mo; 1127 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PLANE); 1128 return mo ? obj_to_plane(mo) : NULL; 1129 } 1130 1131 static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev, 1132 uint32_t id) 1133 { 1134 struct drm_mode_object *mo; 1135 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC); 1136 return mo ? obj_to_crtc(mo) : NULL; 1137 } 1138 1139 static inline struct drm_encoder *drm_encoder_find(struct drm_device *dev, 1140 uint32_t id) 1141 { 1142 struct drm_mode_object *mo; 1143 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_ENCODER); 1144 return mo ? obj_to_encoder(mo) : NULL; 1145 } 1146 1147 static inline struct drm_connector *drm_connector_find(struct drm_device *dev, 1148 uint32_t id) 1149 { 1150 struct drm_mode_object *mo; 1151 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CONNECTOR); 1152 return mo ? obj_to_connector(mo) : NULL; 1153 } 1154 1155 static inline struct drm_property *drm_property_find(struct drm_device *dev, 1156 uint32_t id) 1157 { 1158 struct drm_mode_object *mo; 1159 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PROPERTY); 1160 return mo ? obj_to_property(mo) : NULL; 1161 } 1162 1163 static inline struct drm_property_blob * 1164 drm_property_blob_find(struct drm_device *dev, uint32_t id) 1165 { 1166 struct drm_mode_object *mo; 1167 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_BLOB); 1168 return mo ? obj_to_blob(mo) : NULL; 1169 } 1170 1171 /* Plane list iterator for legacy (overlay only) planes. */ 1172 #define drm_for_each_legacy_plane(plane, planelist) \ 1173 list_for_each_entry(plane, planelist, head) \ 1174 if (plane->type == DRM_PLANE_TYPE_OVERLAY) 1175 1176 #endif /* __DRM_CRTC_H__ */ 1177