1/* 2 * Internal Header for the Direct Rendering Manager 3 * 4 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas. 5 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California. 6 * Copyright (c) 2009-2010, Code Aurora Forum. 7 * All rights reserved. 8 * 9 * Author: Rickard E. (Rik) Faith <faith@valinux.com> 10 * Author: Gareth Hughes <gareth@valinux.com> 11 * 12 * Permission is hereby granted, free of charge, to any person obtaining a 13 * copy of this software and associated documentation files (the "Software"), 14 * to deal in the Software without restriction, including without limitation 15 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 16 * and/or sell copies of the Software, and to permit persons to whom the 17 * Software is furnished to do so, subject to the following conditions: 18 * 19 * The above copyright notice and this permission notice (including the next 20 * paragraph) shall be included in all copies or substantial portions of the 21 * Software. 22 * 23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 24 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 25 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 26 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR 27 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 28 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 29 * OTHER DEALINGS IN THE SOFTWARE. 30 */ 31 32#ifndef _DRM_P_H_ 33#define _DRM_P_H_ 34 35#include <linux/agp_backend.h> 36#include <linux/cdev.h> 37#include <linux/dma-mapping.h> 38#include <linux/file.h> 39#include <linux/fs.h> 40#include <linux/highmem.h> 41#include <linux/idr.h> 42#include <linux/init.h> 43#include <linux/io.h> 44#include <linux/jiffies.h> 45#include <linux/kernel.h> 46#include <linux/kref.h> 47#include <linux/miscdevice.h> 48#include <linux/mm.h> 49#include <linux/mutex.h> 50#include <linux/pci.h> 51#include <linux/platform_device.h> 52#include <linux/poll.h> 53#include <linux/ratelimit.h> 54#include <linux/sched.h> 55#include <linux/slab.h> 56#include <linux/types.h> 57#include <linux/vmalloc.h> 58#include <linux/workqueue.h> 59 60#include <asm/mman.h> 61#include <asm/pgalloc.h> 62#include <asm/uaccess.h> 63 64#include <uapi/drm/drm.h> 65#include <uapi/drm/drm_mode.h> 66 67#include <drm/drm_agpsupport.h> 68#include <drm/drm_crtc.h> 69#include <drm/drm_global.h> 70#include <drm/drm_hashtab.h> 71#include <drm/drm_mem_util.h> 72#include <drm/drm_mm.h> 73#include <drm/drm_os_linux.h> 74#include <drm/drm_sarea.h> 75#include <drm/drm_vma_manager.h> 76 77struct module; 78 79struct drm_file; 80struct drm_device; 81struct drm_agp_head; 82struct drm_local_map; 83struct drm_device_dma; 84struct drm_dma_handle; 85struct drm_gem_object; 86 87struct device_node; 88struct videomode; 89struct reservation_object; 90struct dma_buf_attachment; 91 92/* 93 * 4 debug categories are defined: 94 * 95 * CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c, drm_memory.c, ... 96 * This is the category used by the DRM_DEBUG() macro. 97 * 98 * DRIVER: Used in the vendor specific part of the driver: i915, radeon, ... 99 * This is the category used by the DRM_DEBUG_DRIVER() macro. 100 * 101 * KMS: used in the modesetting code. 102 * This is the category used by the DRM_DEBUG_KMS() macro. 103 * 104 * PRIME: used in the prime code. 105 * This is the category used by the DRM_DEBUG_PRIME() macro. 106 * 107 * Enabling verbose debug messages is done through the drm.debug parameter, 108 * each category being enabled by a bit. 109 * 110 * drm.debug=0x1 will enable CORE messages 111 * drm.debug=0x2 will enable DRIVER messages 112 * drm.debug=0x3 will enable CORE and DRIVER messages 113 * ... 114 * drm.debug=0xf will enable all messages 115 * 116 * An interesting feature is that it's possible to enable verbose logging at 117 * run-time by echoing the debug value in its sysfs node: 118 * # echo 0xf > /sys/module/drm/parameters/debug 119 */ 120#define DRM_UT_CORE 0x01 121#define DRM_UT_DRIVER 0x02 122#define DRM_UT_KMS 0x04 123#define DRM_UT_PRIME 0x08 124 125extern __printf(2, 3) 126void drm_ut_debug_printk(const char *function_name, 127 const char *format, ...); 128extern __printf(2, 3) 129void drm_err(const char *func, const char *format, ...); 130 131/***********************************************************************/ 132/** \name DRM template customization defaults */ 133/*@{*/ 134 135/* driver capabilities and requirements mask */ 136#define DRIVER_USE_AGP 0x1 137#define DRIVER_PCI_DMA 0x8 138#define DRIVER_SG 0x10 139#define DRIVER_HAVE_DMA 0x20 140#define DRIVER_HAVE_IRQ 0x40 141#define DRIVER_IRQ_SHARED 0x80 142#define DRIVER_GEM 0x1000 143#define DRIVER_MODESET 0x2000 144#define DRIVER_PRIME 0x4000 145#define DRIVER_RENDER 0x8000 146 147/***********************************************************************/ 148/** \name Macros to make printk easier */ 149/*@{*/ 150 151/** 152 * Error output. 153 * 154 * \param fmt printf() like format string. 155 * \param arg arguments 156 */ 157#define DRM_ERROR(fmt, ...) \ 158 drm_err(__func__, fmt, ##__VA_ARGS__) 159 160/** 161 * Rate limited error output. Like DRM_ERROR() but won't flood the log. 162 * 163 * \param fmt printf() like format string. 164 * \param arg arguments 165 */ 166#define DRM_ERROR_RATELIMITED(fmt, ...) \ 167({ \ 168 static DEFINE_RATELIMIT_STATE(_rs, \ 169 DEFAULT_RATELIMIT_INTERVAL, \ 170 DEFAULT_RATELIMIT_BURST); \ 171 \ 172 if (__ratelimit(&_rs)) \ 173 drm_err(__func__, fmt, ##__VA_ARGS__); \ 174}) 175 176#define DRM_INFO(fmt, ...) \ 177 printk(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__) 178 179#define DRM_INFO_ONCE(fmt, ...) \ 180 printk_once(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__) 181 182/** 183 * Debug output. 184 * 185 * \param fmt printf() like format string. 186 * \param arg arguments 187 */ 188#define DRM_DEBUG(fmt, args...) \ 189 do { \ 190 if (unlikely(drm_debug & DRM_UT_CORE)) \ 191 drm_ut_debug_printk(__func__, fmt, ##args); \ 192 } while (0) 193 194#define DRM_DEBUG_DRIVER(fmt, args...) \ 195 do { \ 196 if (unlikely(drm_debug & DRM_UT_DRIVER)) \ 197 drm_ut_debug_printk(__func__, fmt, ##args); \ 198 } while (0) 199#define DRM_DEBUG_KMS(fmt, args...) \ 200 do { \ 201 if (unlikely(drm_debug & DRM_UT_KMS)) \ 202 drm_ut_debug_printk(__func__, fmt, ##args); \ 203 } while (0) 204#define DRM_DEBUG_PRIME(fmt, args...) \ 205 do { \ 206 if (unlikely(drm_debug & DRM_UT_PRIME)) \ 207 drm_ut_debug_printk(__func__, fmt, ##args); \ 208 } while (0) 209 210/*@}*/ 211 212/***********************************************************************/ 213/** \name Internal types and structures */ 214/*@{*/ 215 216#define DRM_IF_VERSION(maj, min) (maj << 16 | min) 217 218/** 219 * Ioctl function type. 220 * 221 * \param inode device inode. 222 * \param file_priv DRM file private pointer. 223 * \param cmd command. 224 * \param arg argument. 225 */ 226typedef int drm_ioctl_t(struct drm_device *dev, void *data, 227 struct drm_file *file_priv); 228 229typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd, 230 unsigned long arg); 231 232#define DRM_IOCTL_NR(n) _IOC_NR(n) 233#define DRM_MAJOR 226 234 235#define DRM_AUTH 0x1 236#define DRM_MASTER 0x2 237#define DRM_ROOT_ONLY 0x4 238#define DRM_CONTROL_ALLOW 0x8 239#define DRM_UNLOCKED 0x10 240#define DRM_RENDER_ALLOW 0x20 241 242struct drm_ioctl_desc { 243 unsigned int cmd; 244 int flags; 245 drm_ioctl_t *func; 246 unsigned int cmd_drv; 247 const char *name; 248}; 249 250/** 251 * Creates a driver or general drm_ioctl_desc array entry for the given 252 * ioctl, for use by drm_ioctl(). 253 */ 254 255#define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags) \ 256 [DRM_IOCTL_NR(DRM_##ioctl)] = {.cmd = DRM_##ioctl, .func = _func, .flags = _flags, .cmd_drv = DRM_IOCTL_##ioctl, .name = #ioctl} 257 258/* Event queued up for userspace to read */ 259struct drm_pending_event { 260 struct drm_event *event; 261 struct list_head link; 262 struct drm_file *file_priv; 263 pid_t pid; /* pid of requester, no guarantee it's valid by the time 264 we deliver the event, for tracing only */ 265 void (*destroy)(struct drm_pending_event *event); 266}; 267 268/* initial implementaton using a linked list - todo hashtab */ 269struct drm_prime_file_private { 270 struct list_head head; 271 struct mutex lock; 272}; 273 274/** File private data */ 275struct drm_file { 276 unsigned authenticated :1; 277 /* Whether we're master for a minor. Protected by master_mutex */ 278 unsigned is_master :1; 279 /* true when the client has asked us to expose stereo 3D mode flags */ 280 unsigned stereo_allowed :1; 281 /* 282 * true if client understands CRTC primary planes and cursor planes 283 * in the plane list 284 */ 285 unsigned universal_planes:1; 286 287 struct pid *pid; 288 kuid_t uid; 289 drm_magic_t magic; 290 struct list_head lhead; 291 struct drm_minor *minor; 292 unsigned long lock_count; 293 294 /** Mapping of mm object handles to object pointers. */ 295 struct idr object_idr; 296 /** Lock for synchronization of access to object_idr. */ 297 spinlock_t table_lock; 298 299 struct file *filp; 300 void *driver_priv; 301 302 struct drm_master *master; /* master this node is currently associated with 303 N.B. not always minor->master */ 304 /** 305 * fbs - List of framebuffers associated with this file. 306 * 307 * Protected by fbs_lock. Note that the fbs list holds a reference on 308 * the fb object to prevent it from untimely disappearing. 309 */ 310 struct list_head fbs; 311 struct mutex fbs_lock; 312 313 wait_queue_head_t event_wait; 314 struct list_head event_list; 315 int event_space; 316 317 struct drm_prime_file_private prime; 318}; 319 320/** 321 * Lock data. 322 */ 323struct drm_lock_data { 324 struct drm_hw_lock *hw_lock; /**< Hardware lock */ 325 /** Private of lock holder's file (NULL=kernel) */ 326 struct drm_file *file_priv; 327 wait_queue_head_t lock_queue; /**< Queue of blocked processes */ 328 unsigned long lock_time; /**< Time of last lock in jiffies */ 329 spinlock_t spinlock; 330 uint32_t kernel_waiters; 331 uint32_t user_waiters; 332 int idle_has_lock; 333}; 334 335/** 336 * struct drm_master - drm master structure 337 * 338 * @refcount: Refcount for this master object. 339 * @minor: Link back to minor char device we are master for. Immutable. 340 * @unique: Unique identifier: e.g. busid. Protected by drm_global_mutex. 341 * @unique_len: Length of unique field. Protected by drm_global_mutex. 342 * @magiclist: Hash of used authentication tokens. Protected by struct_mutex. 343 * @magicfree: List of used authentication tokens. Protected by struct_mutex. 344 * @lock: DRI lock information. 345 * @driver_priv: Pointer to driver-private information. 346 */ 347struct drm_master { 348 struct kref refcount; 349 struct drm_minor *minor; 350 char *unique; 351 int unique_len; 352 struct drm_open_hash magiclist; 353 struct list_head magicfree; 354 struct drm_lock_data lock; 355 void *driver_priv; 356}; 357 358/* Size of ringbuffer for vblank timestamps. Just double-buffer 359 * in initial implementation. 360 */ 361#define DRM_VBLANKTIME_RBSIZE 2 362 363/* Flags and return codes for get_vblank_timestamp() driver function. */ 364#define DRM_CALLED_FROM_VBLIRQ 1 365#define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0) 366#define DRM_VBLANKTIME_IN_VBLANK (1 << 1) 367 368/* get_scanout_position() return flags */ 369#define DRM_SCANOUTPOS_VALID (1 << 0) 370#define DRM_SCANOUTPOS_IN_VBLANK (1 << 1) 371#define DRM_SCANOUTPOS_ACCURATE (1 << 2) 372 373/** 374 * DRM driver structure. This structure represent the common code for 375 * a family of cards. There will one drm_device for each card present 376 * in this family 377 */ 378struct drm_driver { 379 int (*load) (struct drm_device *, unsigned long flags); 380 int (*firstopen) (struct drm_device *); 381 int (*open) (struct drm_device *, struct drm_file *); 382 void (*preclose) (struct drm_device *, struct drm_file *file_priv); 383 void (*postclose) (struct drm_device *, struct drm_file *); 384 void (*lastclose) (struct drm_device *); 385 int (*unload) (struct drm_device *); 386 int (*suspend) (struct drm_device *, pm_message_t state); 387 int (*resume) (struct drm_device *); 388 int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv); 389 int (*dma_quiescent) (struct drm_device *); 390 int (*context_dtor) (struct drm_device *dev, int context); 391 int (*set_busid)(struct drm_device *dev, struct drm_master *master); 392 393 /** 394 * get_vblank_counter - get raw hardware vblank counter 395 * @dev: DRM device 396 * @crtc: counter to fetch 397 * 398 * Driver callback for fetching a raw hardware vblank counter for @crtc. 399 * If a device doesn't have a hardware counter, the driver can simply 400 * return the value of drm_vblank_count. The DRM core will account for 401 * missed vblank events while interrupts where disabled based on system 402 * timestamps. 403 * 404 * Wraparound handling and loss of events due to modesetting is dealt 405 * with in the DRM core code. 406 * 407 * RETURNS 408 * Raw vblank counter value. 409 */ 410 u32 (*get_vblank_counter) (struct drm_device *dev, int crtc); 411 412 /** 413 * enable_vblank - enable vblank interrupt events 414 * @dev: DRM device 415 * @crtc: which irq to enable 416 * 417 * Enable vblank interrupts for @crtc. If the device doesn't have 418 * a hardware vblank counter, this routine should be a no-op, since 419 * interrupts will have to stay on to keep the count accurate. 420 * 421 * RETURNS 422 * Zero on success, appropriate errno if the given @crtc's vblank 423 * interrupt cannot be enabled. 424 */ 425 int (*enable_vblank) (struct drm_device *dev, int crtc); 426 427 /** 428 * disable_vblank - disable vblank interrupt events 429 * @dev: DRM device 430 * @crtc: which irq to enable 431 * 432 * Disable vblank interrupts for @crtc. If the device doesn't have 433 * a hardware vblank counter, this routine should be a no-op, since 434 * interrupts will have to stay on to keep the count accurate. 435 */ 436 void (*disable_vblank) (struct drm_device *dev, int crtc); 437 438 /** 439 * Called by \c drm_device_is_agp. Typically used to determine if a 440 * card is really attached to AGP or not. 441 * 442 * \param dev DRM device handle 443 * 444 * \returns 445 * One of three values is returned depending on whether or not the 446 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP 447 * (return of 1), or may or may not be AGP (return of 2). 448 */ 449 int (*device_is_agp) (struct drm_device *dev); 450 451 /** 452 * Called by vblank timestamping code. 453 * 454 * Return the current display scanout position from a crtc, and an 455 * optional accurate ktime_get timestamp of when position was measured. 456 * 457 * \param dev DRM device. 458 * \param crtc Id of the crtc to query. 459 * \param flags Flags from the caller (DRM_CALLED_FROM_VBLIRQ or 0). 460 * \param *vpos Target location for current vertical scanout position. 461 * \param *hpos Target location for current horizontal scanout position. 462 * \param *stime Target location for timestamp taken immediately before 463 * scanout position query. Can be NULL to skip timestamp. 464 * \param *etime Target location for timestamp taken immediately after 465 * scanout position query. Can be NULL to skip timestamp. 466 * 467 * Returns vpos as a positive number while in active scanout area. 468 * Returns vpos as a negative number inside vblank, counting the number 469 * of scanlines to go until end of vblank, e.g., -1 means "one scanline 470 * until start of active scanout / end of vblank." 471 * 472 * \return Flags, or'ed together as follows: 473 * 474 * DRM_SCANOUTPOS_VALID = Query successful. 475 * DRM_SCANOUTPOS_INVBL = Inside vblank. 476 * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of 477 * this flag means that returned position may be offset by a constant 478 * but unknown small number of scanlines wrt. real scanout position. 479 * 480 */ 481 int (*get_scanout_position) (struct drm_device *dev, int crtc, 482 unsigned int flags, 483 int *vpos, int *hpos, ktime_t *stime, 484 ktime_t *etime); 485 486 /** 487 * Called by \c drm_get_last_vbltimestamp. Should return a precise 488 * timestamp when the most recent VBLANK interval ended or will end. 489 * 490 * Specifically, the timestamp in @vblank_time should correspond as 491 * closely as possible to the time when the first video scanline of 492 * the video frame after the end of VBLANK will start scanning out, 493 * the time immediately after end of the VBLANK interval. If the 494 * @crtc is currently inside VBLANK, this will be a time in the future. 495 * If the @crtc is currently scanning out a frame, this will be the 496 * past start time of the current scanout. This is meant to adhere 497 * to the OpenML OML_sync_control extension specification. 498 * 499 * \param dev dev DRM device handle. 500 * \param crtc crtc for which timestamp should be returned. 501 * \param *max_error Maximum allowable timestamp error in nanoseconds. 502 * Implementation should strive to provide timestamp 503 * with an error of at most *max_error nanoseconds. 504 * Returns true upper bound on error for timestamp. 505 * \param *vblank_time Target location for returned vblank timestamp. 506 * \param flags 0 = Defaults, no special treatment needed. 507 * \param DRM_CALLED_FROM_VBLIRQ = Function is called from vblank 508 * irq handler. Some drivers need to apply some workarounds 509 * for gpu-specific vblank irq quirks if flag is set. 510 * 511 * \returns 512 * Zero if timestamping isn't supported in current display mode or a 513 * negative number on failure. A positive status code on success, 514 * which describes how the vblank_time timestamp was computed. 515 */ 516 int (*get_vblank_timestamp) (struct drm_device *dev, int crtc, 517 int *max_error, 518 struct timeval *vblank_time, 519 unsigned flags); 520 521 /* these have to be filled in */ 522 523 irqreturn_t(*irq_handler) (int irq, void *arg); 524 void (*irq_preinstall) (struct drm_device *dev); 525 int (*irq_postinstall) (struct drm_device *dev); 526 void (*irq_uninstall) (struct drm_device *dev); 527 528 /* Master routines */ 529 int (*master_create)(struct drm_device *dev, struct drm_master *master); 530 void (*master_destroy)(struct drm_device *dev, struct drm_master *master); 531 /** 532 * master_set is called whenever the minor master is set. 533 * master_drop is called whenever the minor master is dropped. 534 */ 535 536 int (*master_set)(struct drm_device *dev, struct drm_file *file_priv, 537 bool from_open); 538 void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv, 539 bool from_release); 540 541 int (*debugfs_init)(struct drm_minor *minor); 542 void (*debugfs_cleanup)(struct drm_minor *minor); 543 544 /** 545 * Driver-specific constructor for drm_gem_objects, to set up 546 * obj->driver_private. 547 * 548 * Returns 0 on success. 549 */ 550 void (*gem_free_object) (struct drm_gem_object *obj); 551 int (*gem_open_object) (struct drm_gem_object *, struct drm_file *); 552 void (*gem_close_object) (struct drm_gem_object *, struct drm_file *); 553 554 /* prime: */ 555 /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */ 556 int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv, 557 uint32_t handle, uint32_t flags, int *prime_fd); 558 /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */ 559 int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv, 560 int prime_fd, uint32_t *handle); 561 /* export GEM -> dmabuf */ 562 struct dma_buf * (*gem_prime_export)(struct drm_device *dev, 563 struct drm_gem_object *obj, int flags); 564 /* import dmabuf -> GEM */ 565 struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev, 566 struct dma_buf *dma_buf); 567 /* low-level interface used by drm_gem_prime_{import,export} */ 568 int (*gem_prime_pin)(struct drm_gem_object *obj); 569 void (*gem_prime_unpin)(struct drm_gem_object *obj); 570 struct reservation_object * (*gem_prime_res_obj)( 571 struct drm_gem_object *obj); 572 struct sg_table *(*gem_prime_get_sg_table)(struct drm_gem_object *obj); 573 struct drm_gem_object *(*gem_prime_import_sg_table)( 574 struct drm_device *dev, 575 struct dma_buf_attachment *attach, 576 struct sg_table *sgt); 577 void *(*gem_prime_vmap)(struct drm_gem_object *obj); 578 void (*gem_prime_vunmap)(struct drm_gem_object *obj, void *vaddr); 579 int (*gem_prime_mmap)(struct drm_gem_object *obj, 580 struct vm_area_struct *vma); 581 582 /* vga arb irq handler */ 583 void (*vgaarb_irq)(struct drm_device *dev, bool state); 584 585 /* dumb alloc support */ 586 int (*dumb_create)(struct drm_file *file_priv, 587 struct drm_device *dev, 588 struct drm_mode_create_dumb *args); 589 int (*dumb_map_offset)(struct drm_file *file_priv, 590 struct drm_device *dev, uint32_t handle, 591 uint64_t *offset); 592 int (*dumb_destroy)(struct drm_file *file_priv, 593 struct drm_device *dev, 594 uint32_t handle); 595 596 /* Driver private ops for this object */ 597 const struct vm_operations_struct *gem_vm_ops; 598 599 int major; 600 int minor; 601 int patchlevel; 602 char *name; 603 char *desc; 604 char *date; 605 606 u32 driver_features; 607 int dev_priv_size; 608 const struct drm_ioctl_desc *ioctls; 609 int num_ioctls; 610 const struct file_operations *fops; 611 612 /* List of devices hanging off this driver with stealth attach. */ 613 struct list_head legacy_dev_list; 614}; 615 616enum drm_minor_type { 617 DRM_MINOR_LEGACY, 618 DRM_MINOR_CONTROL, 619 DRM_MINOR_RENDER, 620 DRM_MINOR_CNT, 621}; 622 623/** 624 * Info file list entry. This structure represents a debugfs or proc file to 625 * be created by the drm core 626 */ 627struct drm_info_list { 628 const char *name; /** file name */ 629 int (*show)(struct seq_file*, void*); /** show callback */ 630 u32 driver_features; /**< Required driver features for this entry */ 631 void *data; 632}; 633 634/** 635 * debugfs node structure. This structure represents a debugfs file. 636 */ 637struct drm_info_node { 638 struct list_head list; 639 struct drm_minor *minor; 640 const struct drm_info_list *info_ent; 641 struct dentry *dent; 642}; 643 644/** 645 * DRM minor structure. This structure represents a drm minor number. 646 */ 647struct drm_minor { 648 int index; /**< Minor device number */ 649 int type; /**< Control or render */ 650 struct device *kdev; /**< Linux device */ 651 struct drm_device *dev; 652 653 struct dentry *debugfs_root; 654 655 struct list_head debugfs_list; 656 struct mutex debugfs_lock; /* Protects debugfs_list. */ 657 658 /* currently active master for this node. Protected by master_mutex */ 659 struct drm_master *master; 660 struct drm_mode_group mode_group; 661}; 662 663 664struct drm_pending_vblank_event { 665 struct drm_pending_event base; 666 int pipe; 667 struct drm_event_vblank event; 668}; 669 670struct drm_vblank_crtc { 671 struct drm_device *dev; /* pointer to the drm_device */ 672 wait_queue_head_t queue; /**< VBLANK wait queue */ 673 struct timeval time[DRM_VBLANKTIME_RBSIZE]; /**< timestamp of current count */ 674 struct timer_list disable_timer; /* delayed disable timer */ 675 atomic_t count; /**< number of VBLANK interrupts */ 676 atomic_t refcount; /* number of users of vblank interruptsper crtc */ 677 u32 last; /* protected by dev->vbl_lock, used */ 678 /* for wraparound handling */ 679 u32 last_wait; /* Last vblank seqno waited per CRTC */ 680 unsigned int inmodeset; /* Display driver is setting mode */ 681 int crtc; /* crtc index */ 682 bool enabled; /* so we don't call enable more than 683 once per disable */ 684}; 685 686/** 687 * DRM device structure. This structure represent a complete card that 688 * may contain multiple heads. 689 */ 690struct drm_device { 691 struct list_head legacy_dev_list;/**< list of devices per driver for stealth attach cleanup */ 692 int if_version; /**< Highest interface version set */ 693 694 /** \name Lifetime Management */ 695 /*@{ */ 696 struct kref ref; /**< Object ref-count */ 697 struct device *dev; /**< Device structure of bus-device */ 698 struct drm_driver *driver; /**< DRM driver managing the device */ 699 void *dev_private; /**< DRM driver private data */ 700 struct drm_minor *control; /**< Control node */ 701 struct drm_minor *primary; /**< Primary node */ 702 struct drm_minor *render; /**< Render node */ 703 atomic_t unplugged; /**< Flag whether dev is dead */ 704 struct inode *anon_inode; /**< inode for private address-space */ 705 char *unique; /**< unique name of the device */ 706 /*@} */ 707 708 /** \name Locks */ 709 /*@{ */ 710 struct mutex struct_mutex; /**< For others */ 711 struct mutex master_mutex; /**< For drm_minor::master and drm_file::is_master */ 712 /*@} */ 713 714 /** \name Usage Counters */ 715 /*@{ */ 716 int open_count; /**< Outstanding files open, protected by drm_global_mutex. */ 717 spinlock_t buf_lock; /**< For drm_device::buf_use and a few other things. */ 718 int buf_use; /**< Buffers in use -- cannot alloc */ 719 atomic_t buf_alloc; /**< Buffer allocation in progress */ 720 /*@} */ 721 722 struct list_head filelist; 723 724 /** \name Memory management */ 725 /*@{ */ 726 struct list_head maplist; /**< Linked list of regions */ 727 struct drm_open_hash map_hash; /**< User token hash table for maps */ 728 729 /** \name Context handle management */ 730 /*@{ */ 731 struct list_head ctxlist; /**< Linked list of context handles */ 732 struct mutex ctxlist_mutex; /**< For ctxlist */ 733 734 struct idr ctx_idr; 735 736 struct list_head vmalist; /**< List of vmas (for debugging) */ 737 738 /*@} */ 739 740 /** \name DMA support */ 741 /*@{ */ 742 struct drm_device_dma *dma; /**< Optional pointer for DMA support */ 743 /*@} */ 744 745 /** \name Context support */ 746 /*@{ */ 747 bool irq_enabled; /**< True if irq handler is enabled */ 748 int irq; 749 750 __volatile__ long context_flag; /**< Context swapping flag */ 751 int last_context; /**< Last current context */ 752 /*@} */ 753 754 /** \name VBLANK IRQ support */ 755 /*@{ */ 756 757 /* 758 * At load time, disabling the vblank interrupt won't be allowed since 759 * old clients may not call the modeset ioctl and therefore misbehave. 760 * Once the modeset ioctl *has* been called though, we can safely 761 * disable them when unused. 762 */ 763 bool vblank_disable_allowed; 764 765 /* 766 * If true, vblank interrupt will be disabled immediately when the 767 * refcount drops to zero, as opposed to via the vblank disable 768 * timer. 769 * This can be set to true it the hardware has a working vblank 770 * counter and the driver uses drm_vblank_on() and drm_vblank_off() 771 * appropriately. 772 */ 773 bool vblank_disable_immediate; 774 775 /* array of size num_crtcs */ 776 struct drm_vblank_crtc *vblank; 777 778 spinlock_t vblank_time_lock; /**< Protects vblank count and time updates during vblank enable/disable */ 779 spinlock_t vbl_lock; 780 781 u32 max_vblank_count; /**< size of vblank counter register */ 782 783 /** 784 * List of events 785 */ 786 struct list_head vblank_event_list; 787 spinlock_t event_lock; 788 789 /*@} */ 790 791 struct drm_agp_head *agp; /**< AGP data */ 792 793 struct pci_dev *pdev; /**< PCI device structure */ 794#ifdef __alpha__ 795 struct pci_controller *hose; 796#endif 797 798 struct platform_device *platformdev; /**< Platform device struture */ 799 800 struct drm_sg_mem *sg; /**< Scatter gather memory */ 801 unsigned int num_crtcs; /**< Number of CRTCs on this device */ 802 sigset_t sigmask; 803 804 struct { 805 int context; 806 struct drm_hw_lock *lock; 807 } sigdata; 808 809 struct drm_local_map *agp_buffer_map; 810 unsigned int agp_buffer_token; 811 812 struct drm_mode_config mode_config; /**< Current mode config */ 813 814 /** \name GEM information */ 815 /*@{ */ 816 struct mutex object_name_lock; 817 struct idr object_name_idr; 818 struct drm_vma_offset_manager *vma_offset_manager; 819 /*@} */ 820 int switch_power_state; 821}; 822 823#define DRM_SWITCH_POWER_ON 0 824#define DRM_SWITCH_POWER_OFF 1 825#define DRM_SWITCH_POWER_CHANGING 2 826#define DRM_SWITCH_POWER_DYNAMIC_OFF 3 827 828static __inline__ int drm_core_check_feature(struct drm_device *dev, 829 int feature) 830{ 831 return ((dev->driver->driver_features & feature) ? 1 : 0); 832} 833 834static inline void drm_device_set_unplugged(struct drm_device *dev) 835{ 836 smp_wmb(); 837 atomic_set(&dev->unplugged, 1); 838} 839 840static inline int drm_device_is_unplugged(struct drm_device *dev) 841{ 842 int ret = atomic_read(&dev->unplugged); 843 smp_rmb(); 844 return ret; 845} 846 847static inline bool drm_is_render_client(const struct drm_file *file_priv) 848{ 849 return file_priv->minor->type == DRM_MINOR_RENDER; 850} 851 852static inline bool drm_is_control_client(const struct drm_file *file_priv) 853{ 854 return file_priv->minor->type == DRM_MINOR_CONTROL; 855} 856 857static inline bool drm_is_primary_client(const struct drm_file *file_priv) 858{ 859 return file_priv->minor->type == DRM_MINOR_LEGACY; 860} 861 862/******************************************************************/ 863/** \name Internal function definitions */ 864/*@{*/ 865 866 /* Driver support (drm_drv.h) */ 867extern long drm_ioctl(struct file *filp, 868 unsigned int cmd, unsigned long arg); 869extern long drm_compat_ioctl(struct file *filp, 870 unsigned int cmd, unsigned long arg); 871extern bool drm_ioctl_flags(unsigned int nr, unsigned int *flags); 872 873 /* Device support (drm_fops.h) */ 874extern int drm_open(struct inode *inode, struct file *filp); 875extern ssize_t drm_read(struct file *filp, char __user *buffer, 876 size_t count, loff_t *offset); 877extern int drm_release(struct inode *inode, struct file *filp); 878 879 /* Mapping support (drm_vm.h) */ 880extern unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait); 881 882/* Misc. IOCTL support (drm_ioctl.c) */ 883int drm_noop(struct drm_device *dev, void *data, 884 struct drm_file *file_priv); 885 886/* Cache management (drm_cache.c) */ 887void drm_clflush_pages(struct page *pages[], unsigned long num_pages); 888void drm_clflush_sg(struct sg_table *st); 889void drm_clflush_virt_range(void *addr, unsigned long length); 890 891/* 892 * These are exported to drivers so that they can implement fencing using 893 * DMA quiscent + idle. DMA quiescent usually requires the hardware lock. 894 */ 895 896 /* IRQ support (drm_irq.h) */ 897extern int drm_irq_install(struct drm_device *dev, int irq); 898extern int drm_irq_uninstall(struct drm_device *dev); 899 900extern int drm_vblank_init(struct drm_device *dev, int num_crtcs); 901extern int drm_wait_vblank(struct drm_device *dev, void *data, 902 struct drm_file *filp); 903extern u32 drm_vblank_count(struct drm_device *dev, int crtc); 904extern u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc, 905 struct timeval *vblanktime); 906extern void drm_send_vblank_event(struct drm_device *dev, int crtc, 907 struct drm_pending_vblank_event *e); 908extern bool drm_handle_vblank(struct drm_device *dev, int crtc); 909extern int drm_vblank_get(struct drm_device *dev, int crtc); 910extern void drm_vblank_put(struct drm_device *dev, int crtc); 911extern int drm_crtc_vblank_get(struct drm_crtc *crtc); 912extern void drm_crtc_vblank_put(struct drm_crtc *crtc); 913extern void drm_wait_one_vblank(struct drm_device *dev, int crtc); 914extern void drm_crtc_wait_one_vblank(struct drm_crtc *crtc); 915extern void drm_vblank_off(struct drm_device *dev, int crtc); 916extern void drm_vblank_on(struct drm_device *dev, int crtc); 917extern void drm_crtc_vblank_off(struct drm_crtc *crtc); 918extern void drm_crtc_vblank_on(struct drm_crtc *crtc); 919extern void drm_vblank_cleanup(struct drm_device *dev); 920 921extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev, 922 int crtc, int *max_error, 923 struct timeval *vblank_time, 924 unsigned flags, 925 const struct drm_crtc *refcrtc, 926 const struct drm_display_mode *mode); 927extern void drm_calc_timestamping_constants(struct drm_crtc *crtc, 928 const struct drm_display_mode *mode); 929 930/** 931 * drm_crtc_vblank_waitqueue - get vblank waitqueue for the CRTC 932 * @crtc: which CRTC's vblank waitqueue to retrieve 933 * 934 * This function returns a pointer to the vblank waitqueue for the CRTC. 935 * Drivers can use this to implement vblank waits using wait_event() & co. 936 */ 937static inline wait_queue_head_t *drm_crtc_vblank_waitqueue(struct drm_crtc *crtc) 938{ 939 return &crtc->dev->vblank[drm_crtc_index(crtc)].queue; 940} 941 942/* Modesetting support */ 943extern void drm_vblank_pre_modeset(struct drm_device *dev, int crtc); 944extern void drm_vblank_post_modeset(struct drm_device *dev, int crtc); 945 946 /* Stub support (drm_stub.h) */ 947extern struct drm_master *drm_master_get(struct drm_master *master); 948extern void drm_master_put(struct drm_master **master); 949 950extern void drm_put_dev(struct drm_device *dev); 951extern void drm_unplug_dev(struct drm_device *dev); 952extern unsigned int drm_debug; 953 954 /* Debugfs support */ 955#if defined(CONFIG_DEBUG_FS) 956extern int drm_debugfs_create_files(const struct drm_info_list *files, 957 int count, struct dentry *root, 958 struct drm_minor *minor); 959extern int drm_debugfs_remove_files(const struct drm_info_list *files, 960 int count, struct drm_minor *minor); 961#else 962static inline int drm_debugfs_create_files(const struct drm_info_list *files, 963 int count, struct dentry *root, 964 struct drm_minor *minor) 965{ 966 return 0; 967} 968 969static inline int drm_debugfs_remove_files(const struct drm_info_list *files, 970 int count, struct drm_minor *minor) 971{ 972 return 0; 973} 974#endif 975 976extern struct dma_buf *drm_gem_prime_export(struct drm_device *dev, 977 struct drm_gem_object *obj, int flags); 978extern int drm_gem_prime_handle_to_fd(struct drm_device *dev, 979 struct drm_file *file_priv, uint32_t handle, uint32_t flags, 980 int *prime_fd); 981extern struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev, 982 struct dma_buf *dma_buf); 983extern int drm_gem_prime_fd_to_handle(struct drm_device *dev, 984 struct drm_file *file_priv, int prime_fd, uint32_t *handle); 985extern void drm_gem_dmabuf_release(struct dma_buf *dma_buf); 986 987extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages, 988 dma_addr_t *addrs, int max_pages); 989extern struct sg_table *drm_prime_pages_to_sg(struct page **pages, int nr_pages); 990extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg); 991 992 993extern struct drm_dma_handle *drm_pci_alloc(struct drm_device *dev, size_t size, 994 size_t align); 995extern void drm_pci_free(struct drm_device *dev, struct drm_dma_handle * dmah); 996 997 /* sysfs support (drm_sysfs.c) */ 998extern void drm_sysfs_hotplug_event(struct drm_device *dev); 999 1000 1001struct drm_device *drm_dev_alloc(struct drm_driver *driver, 1002 struct device *parent); 1003void drm_dev_ref(struct drm_device *dev); 1004void drm_dev_unref(struct drm_device *dev); 1005int drm_dev_register(struct drm_device *dev, unsigned long flags); 1006void drm_dev_unregister(struct drm_device *dev); 1007int drm_dev_set_unique(struct drm_device *dev, const char *fmt, ...); 1008 1009struct drm_minor *drm_minor_acquire(unsigned int minor_id); 1010void drm_minor_release(struct drm_minor *minor); 1011 1012/*@}*/ 1013 1014/* PCI section */ 1015static __inline__ int drm_pci_device_is_agp(struct drm_device *dev) 1016{ 1017 if (dev->driver->device_is_agp != NULL) { 1018 int err = (*dev->driver->device_is_agp) (dev); 1019 1020 if (err != 2) { 1021 return err; 1022 } 1023 } 1024 1025 return pci_find_capability(dev->pdev, PCI_CAP_ID_AGP); 1026} 1027void drm_pci_agp_destroy(struct drm_device *dev); 1028 1029extern int drm_pci_init(struct drm_driver *driver, struct pci_driver *pdriver); 1030extern void drm_pci_exit(struct drm_driver *driver, struct pci_driver *pdriver); 1031extern int drm_get_pci_dev(struct pci_dev *pdev, 1032 const struct pci_device_id *ent, 1033 struct drm_driver *driver); 1034extern int drm_pci_set_busid(struct drm_device *dev, struct drm_master *master); 1035 1036#define DRM_PCIE_SPEED_25 1 1037#define DRM_PCIE_SPEED_50 2 1038#define DRM_PCIE_SPEED_80 4 1039 1040extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask); 1041 1042/* platform section */ 1043extern int drm_platform_init(struct drm_driver *driver, struct platform_device *platform_device); 1044extern int drm_platform_set_busid(struct drm_device *d, struct drm_master *m); 1045 1046/* returns true if currently okay to sleep */ 1047static __inline__ bool drm_can_sleep(void) 1048{ 1049 if (in_atomic() || in_dbg_master() || irqs_disabled()) 1050 return false; 1051 return true; 1052} 1053 1054#endif 1055