Linux Audio

Check our new training course

Real-Time Linux with PREEMPT_RT training

Feb 18-20, 2025
Register
Loading...
Note: File does not exist in v6.2.
   1/**
   2 * \file drmP.h
   3 * Private header for Direct Rendering Manager
   4 *
   5 * \author Rickard E. (Rik) Faith <faith@valinux.com>
   6 * \author Gareth Hughes <gareth@valinux.com>
   7 */
   8
   9/*
  10 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
  11 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
  12 * Copyright (c) 2009-2010, Code Aurora Forum.
  13 * All rights reserved.
  14 *
  15 * Permission is hereby granted, free of charge, to any person obtaining a
  16 * copy of this software and associated documentation files (the "Software"),
  17 * to deal in the Software without restriction, including without limitation
  18 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  19 * and/or sell copies of the Software, and to permit persons to whom the
  20 * Software is furnished to do so, subject to the following conditions:
  21 *
  22 * The above copyright notice and this permission notice (including the next
  23 * paragraph) shall be included in all copies or substantial portions of the
  24 * Software.
  25 *
  26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  27 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  28 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  29 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  30 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  31 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  32 * OTHER DEALINGS IN THE SOFTWARE.
  33 */
  34
  35#ifndef _DRM_P_H_
  36#define _DRM_P_H_
  37
  38#ifdef __KERNEL__
  39#ifdef __alpha__
  40/* add include of current.h so that "current" is defined
  41 * before static inline funcs in wait.h. Doing this so we
  42 * can build the DRM (part of PI DRI). 4/21/2000 S + B */
  43#include <asm/current.h>
  44#endif				/* __alpha__ */
  45#include <linux/module.h>
  46#include <linux/kernel.h>
  47#include <linux/miscdevice.h>
  48#include <linux/fs.h>
  49#include <linux/proc_fs.h>
  50#include <linux/init.h>
  51#include <linux/file.h>
  52#include <linux/platform_device.h>
  53#include <linux/pci.h>
  54#include <linux/jiffies.h>
  55#include <linux/dma-mapping.h>
  56#include <linux/mm.h>
  57#include <linux/cdev.h>
  58#include <linux/mutex.h>
  59#include <linux/slab.h>
  60#if defined(__alpha__) || defined(__powerpc__)
  61#include <asm/pgtable.h>	/* For pte_wrprotect */
  62#endif
  63#include <asm/io.h>
  64#include <asm/mman.h>
  65#include <asm/uaccess.h>
  66#ifdef CONFIG_MTRR
  67#include <asm/mtrr.h>
  68#endif
  69#if defined(CONFIG_AGP) || defined(CONFIG_AGP_MODULE)
  70#include <linux/types.h>
  71#include <linux/agp_backend.h>
  72#endif
  73#include <linux/workqueue.h>
  74#include <linux/poll.h>
  75#include <asm/pgalloc.h>
  76#include "drm.h"
  77
  78#include <linux/idr.h>
  79
  80#define __OS_HAS_AGP (defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE)))
  81#define __OS_HAS_MTRR (defined(CONFIG_MTRR))
  82
  83struct drm_file;
  84struct drm_device;
  85
  86#include "drm_os_linux.h"
  87#include "drm_hashtab.h"
  88#include "drm_mm.h"
  89
  90#define DRM_UT_CORE 		0x01
  91#define DRM_UT_DRIVER		0x02
  92#define DRM_UT_KMS		0x04
  93/*
  94 * Three debug levels are defined.
  95 * drm_core, drm_driver, drm_kms
  96 * drm_core level can be used in the generic drm code. For example:
  97 * 	drm_ioctl, drm_mm, drm_memory
  98 * The macro definition of DRM_DEBUG is used.
  99 * 	DRM_DEBUG(fmt, args...)
 100 * 	The debug info by using the DRM_DEBUG can be obtained by adding
 101 * 	the boot option of "drm.debug=1".
 102 *
 103 * drm_driver level can be used in the specific drm driver. It is used
 104 * to add the debug info related with the drm driver. For example:
 105 * i915_drv, i915_dma, i915_gem, radeon_drv,
 106 * 	The macro definition of DRM_DEBUG_DRIVER can be used.
 107 * 	DRM_DEBUG_DRIVER(fmt, args...)
 108 * 	The debug info by using the DRM_DEBUG_DRIVER can be obtained by
 109 * 	adding the boot option of "drm.debug=0x02"
 110 *
 111 * drm_kms level can be used in the KMS code related with specific drm driver.
 112 * It is used to add the debug info related with KMS mode. For example:
 113 * the connector/crtc ,
 114 * 	The macro definition of DRM_DEBUG_KMS can be used.
 115 * 	DRM_DEBUG_KMS(fmt, args...)
 116 * 	The debug info by using the DRM_DEBUG_KMS can be obtained by
 117 * 	adding the boot option of "drm.debug=0x04"
 118 *
 119 * If we add the boot option of "drm.debug=0x06", we can get the debug info by
 120 * using the DRM_DEBUG_KMS and DRM_DEBUG_DRIVER.
 121 * If we add the boot option of "drm.debug=0x05", we can get the debug info by
 122 * using the DRM_DEBUG_KMS and DRM_DEBUG.
 123 */
 124
 125extern __attribute__((format (printf, 4, 5)))
 126void drm_ut_debug_printk(unsigned int request_level,
 127				const char *prefix,
 128				const char *function_name,
 129				const char *format, ...);
 130extern __attribute__((format (printf, 2, 3)))
 131int drm_err(const char *func, const char *format, ...);
 132
 133/***********************************************************************/
 134/** \name DRM template customization defaults */
 135/*@{*/
 136
 137/* driver capabilities and requirements mask */
 138#define DRIVER_USE_AGP     0x1
 139#define DRIVER_REQUIRE_AGP 0x2
 140#define DRIVER_USE_MTRR    0x4
 141#define DRIVER_PCI_DMA     0x8
 142#define DRIVER_SG          0x10
 143#define DRIVER_HAVE_DMA    0x20
 144#define DRIVER_HAVE_IRQ    0x40
 145#define DRIVER_IRQ_SHARED  0x80
 146#define DRIVER_IRQ_VBL     0x100
 147#define DRIVER_DMA_QUEUE   0x200
 148#define DRIVER_FB_DMA      0x400
 149#define DRIVER_IRQ_VBL2    0x800
 150#define DRIVER_GEM         0x1000
 151#define DRIVER_MODESET     0x2000
 152
 153#define DRIVER_BUS_PCI 0x1
 154#define DRIVER_BUS_PLATFORM 0x2
 155#define DRIVER_BUS_USB 0x3
 156
 157/***********************************************************************/
 158/** \name Begin the DRM... */
 159/*@{*/
 160
 161#define DRM_DEBUG_CODE 2	  /**< Include debugging code if > 1, then
 162				     also include looping detection. */
 163
 164#define DRM_MAGIC_HASH_ORDER  4  /**< Size of key hash table. Must be power of 2. */
 165#define DRM_KERNEL_CONTEXT    0	 /**< Change drm_resctx if changed */
 166#define DRM_RESERVED_CONTEXTS 1	 /**< Change drm_resctx if changed */
 167#define DRM_LOOPING_LIMIT     5000000
 168#define DRM_TIME_SLICE	      (HZ/20)  /**< Time slice for GLXContexts */
 169#define DRM_LOCK_SLICE	      1	/**< Time slice for lock, in jiffies */
 170
 171#define DRM_FLAG_DEBUG	  0x01
 172
 173#define DRM_MAX_CTXBITMAP (PAGE_SIZE * 8)
 174#define DRM_MAP_HASH_OFFSET 0x10000000
 175
 176/*@}*/
 177
 178/***********************************************************************/
 179/** \name Macros to make printk easier */
 180/*@{*/
 181
 182/**
 183 * Error output.
 184 *
 185 * \param fmt printf() like format string.
 186 * \param arg arguments
 187 */
 188#define DRM_ERROR(fmt, ...)				\
 189	drm_err(__func__, fmt, ##__VA_ARGS__)
 190
 191#define DRM_INFO(fmt, ...)				\
 192	printk(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
 193
 194/**
 195 * Debug output.
 196 *
 197 * \param fmt printf() like format string.
 198 * \param arg arguments
 199 */
 200#if DRM_DEBUG_CODE
 201#define DRM_DEBUG(fmt, args...)						\
 202	do {								\
 203		drm_ut_debug_printk(DRM_UT_CORE, DRM_NAME, 		\
 204					__func__, fmt, ##args);		\
 205	} while (0)
 206
 207#define DRM_DEBUG_DRIVER(fmt, args...)					\
 208	do {								\
 209		drm_ut_debug_printk(DRM_UT_DRIVER, DRM_NAME,		\
 210					__func__, fmt, ##args);		\
 211	} while (0)
 212#define DRM_DEBUG_KMS(fmt, args...)				\
 213	do {								\
 214		drm_ut_debug_printk(DRM_UT_KMS, DRM_NAME, 		\
 215					 __func__, fmt, ##args);	\
 216	} while (0)
 217#define DRM_LOG(fmt, args...)						\
 218	do {								\
 219		drm_ut_debug_printk(DRM_UT_CORE, NULL,			\
 220					NULL, fmt, ##args);		\
 221	} while (0)
 222#define DRM_LOG_KMS(fmt, args...)					\
 223	do {								\
 224		drm_ut_debug_printk(DRM_UT_KMS, NULL,			\
 225					NULL, fmt, ##args);		\
 226	} while (0)
 227#define DRM_LOG_MODE(fmt, args...)					\
 228	do {								\
 229		drm_ut_debug_printk(DRM_UT_MODE, NULL,			\
 230					NULL, fmt, ##args);		\
 231	} while (0)
 232#define DRM_LOG_DRIVER(fmt, args...)					\
 233	do {								\
 234		drm_ut_debug_printk(DRM_UT_DRIVER, NULL,		\
 235					NULL, fmt, ##args);		\
 236	} while (0)
 237#else
 238#define DRM_DEBUG_DRIVER(fmt, args...) do { } while (0)
 239#define DRM_DEBUG_KMS(fmt, args...)	do { } while (0)
 240#define DRM_DEBUG(fmt, arg...)		 do { } while (0)
 241#define DRM_LOG(fmt, arg...)		do { } while (0)
 242#define DRM_LOG_KMS(fmt, args...) do { } while (0)
 243#define DRM_LOG_MODE(fmt, arg...) do { } while (0)
 244#define DRM_LOG_DRIVER(fmt, arg...) do { } while (0)
 245
 246#endif
 247
 248/*@}*/
 249
 250/***********************************************************************/
 251/** \name Internal types and structures */
 252/*@{*/
 253
 254#define DRM_ARRAY_SIZE(x) ARRAY_SIZE(x)
 255
 256#define DRM_LEFTCOUNT(x) (((x)->rp + (x)->count - (x)->wp) % ((x)->count + 1))
 257#define DRM_BUFCOUNT(x) ((x)->count - DRM_LEFTCOUNT(x))
 258
 259#define DRM_IF_VERSION(maj, min) (maj << 16 | min)
 260
 261/**
 262 * Test that the hardware lock is held by the caller, returning otherwise.
 263 *
 264 * \param dev DRM device.
 265 * \param filp file pointer of the caller.
 266 */
 267#define LOCK_TEST_WITH_RETURN( dev, _file_priv )				\
 268do {										\
 269	if (!_DRM_LOCK_IS_HELD(_file_priv->master->lock.hw_lock->lock) ||	\
 270	    _file_priv->master->lock.file_priv != _file_priv)	{		\
 271		DRM_ERROR( "%s called without lock held, held  %d owner %p %p\n",\
 272			   __func__, _DRM_LOCK_IS_HELD(_file_priv->master->lock.hw_lock->lock),\
 273			   _file_priv->master->lock.file_priv, _file_priv);	\
 274		return -EINVAL;							\
 275	}									\
 276} while (0)
 277
 278/**
 279 * Ioctl function type.
 280 *
 281 * \param inode device inode.
 282 * \param file_priv DRM file private pointer.
 283 * \param cmd command.
 284 * \param arg argument.
 285 */
 286typedef int drm_ioctl_t(struct drm_device *dev, void *data,
 287			struct drm_file *file_priv);
 288
 289typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd,
 290			       unsigned long arg);
 291
 292#define DRM_IOCTL_NR(n)                _IOC_NR(n)
 293#define DRM_MAJOR       226
 294
 295#define DRM_AUTH	0x1
 296#define	DRM_MASTER	0x2
 297#define DRM_ROOT_ONLY	0x4
 298#define DRM_CONTROL_ALLOW 0x8
 299#define DRM_UNLOCKED	0x10
 300
 301struct drm_ioctl_desc {
 302	unsigned int cmd;
 303	int flags;
 304	drm_ioctl_t *func;
 305	unsigned int cmd_drv;
 306};
 307
 308/**
 309 * Creates a driver or general drm_ioctl_desc array entry for the given
 310 * ioctl, for use by drm_ioctl().
 311 */
 312
 313#define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags)			\
 314	[DRM_IOCTL_NR(DRM_##ioctl)] = {.cmd = DRM_##ioctl, .func = _func, .flags = _flags, .cmd_drv = DRM_IOCTL_##ioctl}
 315
 316struct drm_magic_entry {
 317	struct list_head head;
 318	struct drm_hash_item hash_item;
 319	struct drm_file *priv;
 320};
 321
 322struct drm_vma_entry {
 323	struct list_head head;
 324	struct vm_area_struct *vma;
 325	pid_t pid;
 326};
 327
 328/**
 329 * DMA buffer.
 330 */
 331struct drm_buf {
 332	int idx;		       /**< Index into master buflist */
 333	int total;		       /**< Buffer size */
 334	int order;		       /**< log-base-2(total) */
 335	int used;		       /**< Amount of buffer in use (for DMA) */
 336	unsigned long offset;	       /**< Byte offset (used internally) */
 337	void *address;		       /**< Address of buffer */
 338	unsigned long bus_address;     /**< Bus address of buffer */
 339	struct drm_buf *next;	       /**< Kernel-only: used for free list */
 340	__volatile__ int waiting;      /**< On kernel DMA queue */
 341	__volatile__ int pending;      /**< On hardware DMA queue */
 342	wait_queue_head_t dma_wait;    /**< Processes waiting */
 343	struct drm_file *file_priv;    /**< Private of holding file descr */
 344	int context;		       /**< Kernel queue for this buffer */
 345	int while_locked;	       /**< Dispatch this buffer while locked */
 346	enum {
 347		DRM_LIST_NONE = 0,
 348		DRM_LIST_FREE = 1,
 349		DRM_LIST_WAIT = 2,
 350		DRM_LIST_PEND = 3,
 351		DRM_LIST_PRIO = 4,
 352		DRM_LIST_RECLAIM = 5
 353	} list;			       /**< Which list we're on */
 354
 355	int dev_priv_size;		 /**< Size of buffer private storage */
 356	void *dev_private;		 /**< Per-buffer private storage */
 357};
 358
 359/** bufs is one longer than it has to be */
 360struct drm_waitlist {
 361	int count;			/**< Number of possible buffers */
 362	struct drm_buf **bufs;		/**< List of pointers to buffers */
 363	struct drm_buf **rp;			/**< Read pointer */
 364	struct drm_buf **wp;			/**< Write pointer */
 365	struct drm_buf **end;		/**< End pointer */
 366	spinlock_t read_lock;
 367	spinlock_t write_lock;
 368};
 369
 370struct drm_freelist {
 371	int initialized;	       /**< Freelist in use */
 372	atomic_t count;		       /**< Number of free buffers */
 373	struct drm_buf *next;	       /**< End pointer */
 374
 375	wait_queue_head_t waiting;     /**< Processes waiting on free bufs */
 376	int low_mark;		       /**< Low water mark */
 377	int high_mark;		       /**< High water mark */
 378	atomic_t wfh;		       /**< If waiting for high mark */
 379	spinlock_t lock;
 380};
 381
 382typedef struct drm_dma_handle {
 383	dma_addr_t busaddr;
 384	void *vaddr;
 385	size_t size;
 386} drm_dma_handle_t;
 387
 388/**
 389 * Buffer entry.  There is one of this for each buffer size order.
 390 */
 391struct drm_buf_entry {
 392	int buf_size;			/**< size */
 393	int buf_count;			/**< number of buffers */
 394	struct drm_buf *buflist;		/**< buffer list */
 395	int seg_count;
 396	int page_order;
 397	struct drm_dma_handle **seglist;
 398
 399	struct drm_freelist freelist;
 400};
 401
 402/* Event queued up for userspace to read */
 403struct drm_pending_event {
 404	struct drm_event *event;
 405	struct list_head link;
 406	struct drm_file *file_priv;
 407	pid_t pid; /* pid of requester, no guarantee it's valid by the time
 408		      we deliver the event, for tracing only */
 409	void (*destroy)(struct drm_pending_event *event);
 410};
 411
 412/** File private data */
 413struct drm_file {
 414	int authenticated;
 415	pid_t pid;
 416	uid_t uid;
 417	drm_magic_t magic;
 418	unsigned long ioctl_count;
 419	struct list_head lhead;
 420	struct drm_minor *minor;
 421	unsigned long lock_count;
 422
 423	/** Mapping of mm object handles to object pointers. */
 424	struct idr object_idr;
 425	/** Lock for synchronization of access to object_idr. */
 426	spinlock_t table_lock;
 427
 428	struct file *filp;
 429	void *driver_priv;
 430
 431	int is_master; /* this file private is a master for a minor */
 432	struct drm_master *master; /* master this node is currently associated with
 433				      N.B. not always minor->master */
 434	struct list_head fbs;
 435
 436	wait_queue_head_t event_wait;
 437	struct list_head event_list;
 438	int event_space;
 439};
 440
 441/** Wait queue */
 442struct drm_queue {
 443	atomic_t use_count;		/**< Outstanding uses (+1) */
 444	atomic_t finalization;		/**< Finalization in progress */
 445	atomic_t block_count;		/**< Count of processes waiting */
 446	atomic_t block_read;		/**< Queue blocked for reads */
 447	wait_queue_head_t read_queue;	/**< Processes waiting on block_read */
 448	atomic_t block_write;		/**< Queue blocked for writes */
 449	wait_queue_head_t write_queue;	/**< Processes waiting on block_write */
 450	atomic_t total_queued;		/**< Total queued statistic */
 451	atomic_t total_flushed;		/**< Total flushes statistic */
 452	atomic_t total_locks;		/**< Total locks statistics */
 453	enum drm_ctx_flags flags;	/**< Context preserving and 2D-only */
 454	struct drm_waitlist waitlist;	/**< Pending buffers */
 455	wait_queue_head_t flush_queue;	/**< Processes waiting until flush */
 456};
 457
 458/**
 459 * Lock data.
 460 */
 461struct drm_lock_data {
 462	struct drm_hw_lock *hw_lock;	/**< Hardware lock */
 463	/** Private of lock holder's file (NULL=kernel) */
 464	struct drm_file *file_priv;
 465	wait_queue_head_t lock_queue;	/**< Queue of blocked processes */
 466	unsigned long lock_time;	/**< Time of last lock in jiffies */
 467	spinlock_t spinlock;
 468	uint32_t kernel_waiters;
 469	uint32_t user_waiters;
 470	int idle_has_lock;
 471};
 472
 473/**
 474 * DMA data.
 475 */
 476struct drm_device_dma {
 477
 478	struct drm_buf_entry bufs[DRM_MAX_ORDER + 1];	/**< buffers, grouped by their size order */
 479	int buf_count;			/**< total number of buffers */
 480	struct drm_buf **buflist;		/**< Vector of pointers into drm_device_dma::bufs */
 481	int seg_count;
 482	int page_count;			/**< number of pages */
 483	unsigned long *pagelist;	/**< page list */
 484	unsigned long byte_count;
 485	enum {
 486		_DRM_DMA_USE_AGP = 0x01,
 487		_DRM_DMA_USE_SG = 0x02,
 488		_DRM_DMA_USE_FB = 0x04,
 489		_DRM_DMA_USE_PCI_RO = 0x08
 490	} flags;
 491
 492};
 493
 494/**
 495 * AGP memory entry.  Stored as a doubly linked list.
 496 */
 497struct drm_agp_mem {
 498	unsigned long handle;		/**< handle */
 499	DRM_AGP_MEM *memory;
 500	unsigned long bound;		/**< address */
 501	int pages;
 502	struct list_head head;
 503};
 504
 505/**
 506 * AGP data.
 507 *
 508 * \sa drm_agp_init() and drm_device::agp.
 509 */
 510struct drm_agp_head {
 511	DRM_AGP_KERN agp_info;		/**< AGP device information */
 512	struct list_head memory;
 513	unsigned long mode;		/**< AGP mode */
 514	struct agp_bridge_data *bridge;
 515	int enabled;			/**< whether the AGP bus as been enabled */
 516	int acquired;			/**< whether the AGP device has been acquired */
 517	unsigned long base;
 518	int agp_mtrr;
 519	int cant_use_aperture;
 520	unsigned long page_mask;
 521};
 522
 523/**
 524 * Scatter-gather memory.
 525 */
 526struct drm_sg_mem {
 527	unsigned long handle;
 528	void *virtual;
 529	int pages;
 530	struct page **pagelist;
 531	dma_addr_t *busaddr;
 532};
 533
 534struct drm_sigdata {
 535	int context;
 536	struct drm_hw_lock *lock;
 537};
 538
 539
 540/**
 541 * Kernel side of a mapping
 542 */
 543struct drm_local_map {
 544	resource_size_t offset;	 /**< Requested physical address (0 for SAREA)*/
 545	unsigned long size;	 /**< Requested physical size (bytes) */
 546	enum drm_map_type type;	 /**< Type of memory to map */
 547	enum drm_map_flags flags;	 /**< Flags */
 548	void *handle;		 /**< User-space: "Handle" to pass to mmap() */
 549				 /**< Kernel-space: kernel-virtual address */
 550	int mtrr;		 /**< MTRR slot used */
 551};
 552
 553typedef struct drm_local_map drm_local_map_t;
 554
 555/**
 556 * Mappings list
 557 */
 558struct drm_map_list {
 559	struct list_head head;		/**< list head */
 560	struct drm_hash_item hash;
 561	struct drm_local_map *map;	/**< mapping */
 562	uint64_t user_token;
 563	struct drm_master *master;
 564	struct drm_mm_node *file_offset_node;	/**< fake offset */
 565};
 566
 567/**
 568 * Context handle list
 569 */
 570struct drm_ctx_list {
 571	struct list_head head;		/**< list head */
 572	drm_context_t handle;		/**< context handle */
 573	struct drm_file *tag;		/**< associated fd private data */
 574};
 575
 576/* location of GART table */
 577#define DRM_ATI_GART_MAIN 1
 578#define DRM_ATI_GART_FB   2
 579
 580#define DRM_ATI_GART_PCI 1
 581#define DRM_ATI_GART_PCIE 2
 582#define DRM_ATI_GART_IGP 3
 583
 584struct drm_ati_pcigart_info {
 585	int gart_table_location;
 586	int gart_reg_if;
 587	void *addr;
 588	dma_addr_t bus_addr;
 589	dma_addr_t table_mask;
 590	struct drm_dma_handle *table_handle;
 591	struct drm_local_map mapping;
 592	int table_size;
 593};
 594
 595/**
 596 * GEM specific mm private for tracking GEM objects
 597 */
 598struct drm_gem_mm {
 599	struct drm_mm offset_manager;	/**< Offset mgmt for buffer objects */
 600	struct drm_open_hash offset_hash; /**< User token hash table for maps */
 601};
 602
 603/**
 604 * This structure defines the drm_mm memory object, which will be used by the
 605 * DRM for its buffer objects.
 606 */
 607struct drm_gem_object {
 608	/** Reference count of this object */
 609	struct kref refcount;
 610
 611	/** Handle count of this object. Each handle also holds a reference */
 612	atomic_t handle_count; /* number of handles on this object */
 613
 614	/** Related drm device */
 615	struct drm_device *dev;
 616
 617	/** File representing the shmem storage */
 618	struct file *filp;
 619
 620	/* Mapping info for this object */
 621	struct drm_map_list map_list;
 622
 623	/**
 624	 * Size of the object, in bytes.  Immutable over the object's
 625	 * lifetime.
 626	 */
 627	size_t size;
 628
 629	/**
 630	 * Global name for this object, starts at 1. 0 means unnamed.
 631	 * Access is covered by the object_name_lock in the related drm_device
 632	 */
 633	int name;
 634
 635	/**
 636	 * Memory domains. These monitor which caches contain read/write data
 637	 * related to the object. When transitioning from one set of domains
 638	 * to another, the driver is called to ensure that caches are suitably
 639	 * flushed and invalidated
 640	 */
 641	uint32_t read_domains;
 642	uint32_t write_domain;
 643
 644	/**
 645	 * While validating an exec operation, the
 646	 * new read/write domain values are computed here.
 647	 * They will be transferred to the above values
 648	 * at the point that any cache flushing occurs
 649	 */
 650	uint32_t pending_read_domains;
 651	uint32_t pending_write_domain;
 652
 653	void *driver_private;
 654};
 655
 656#include "drm_crtc.h"
 657
 658/* per-master structure */
 659struct drm_master {
 660
 661	struct kref refcount; /* refcount for this master */
 662
 663	struct list_head head; /**< each minor contains a list of masters */
 664	struct drm_minor *minor; /**< link back to minor we are a master for */
 665
 666	char *unique;			/**< Unique identifier: e.g., busid */
 667	int unique_len;			/**< Length of unique field */
 668	int unique_size;		/**< amount allocated */
 669
 670	int blocked;			/**< Blocked due to VC switch? */
 671
 672	/** \name Authentication */
 673	/*@{ */
 674	struct drm_open_hash magiclist;
 675	struct list_head magicfree;
 676	/*@} */
 677
 678	struct drm_lock_data lock;	/**< Information on hardware lock */
 679
 680	void *driver_priv; /**< Private structure for driver to use */
 681};
 682
 683/* Size of ringbuffer for vblank timestamps. Just double-buffer
 684 * in initial implementation.
 685 */
 686#define DRM_VBLANKTIME_RBSIZE 2
 687
 688/* Flags and return codes for get_vblank_timestamp() driver function. */
 689#define DRM_CALLED_FROM_VBLIRQ 1
 690#define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
 691#define DRM_VBLANKTIME_INVBL             (1 << 1)
 692
 693/* get_scanout_position() return flags */
 694#define DRM_SCANOUTPOS_VALID        (1 << 0)
 695#define DRM_SCANOUTPOS_INVBL        (1 << 1)
 696#define DRM_SCANOUTPOS_ACCURATE     (1 << 2)
 697
 698struct drm_bus {
 699	int bus_type;
 700	int (*get_irq)(struct drm_device *dev);
 701	const char *(*get_name)(struct drm_device *dev);
 702	int (*set_busid)(struct drm_device *dev, struct drm_master *master);
 703	int (*set_unique)(struct drm_device *dev, struct drm_master *master,
 704			  struct drm_unique *unique);
 705	int (*irq_by_busid)(struct drm_device *dev, struct drm_irq_busid *p);
 706	/* hooks that are for PCI */
 707	int (*agp_init)(struct drm_device *dev);
 708
 709};
 710
 711/**
 712 * DRM driver structure. This structure represent the common code for
 713 * a family of cards. There will one drm_device for each card present
 714 * in this family
 715 */
 716struct drm_driver {
 717	int (*load) (struct drm_device *, unsigned long flags);
 718	int (*firstopen) (struct drm_device *);
 719	int (*open) (struct drm_device *, struct drm_file *);
 720	void (*preclose) (struct drm_device *, struct drm_file *file_priv);
 721	void (*postclose) (struct drm_device *, struct drm_file *);
 722	void (*lastclose) (struct drm_device *);
 723	int (*unload) (struct drm_device *);
 724	int (*suspend) (struct drm_device *, pm_message_t state);
 725	int (*resume) (struct drm_device *);
 726	int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
 727	int (*dma_quiescent) (struct drm_device *);
 728	int (*context_dtor) (struct drm_device *dev, int context);
 729
 730	/**
 731	 * get_vblank_counter - get raw hardware vblank counter
 732	 * @dev: DRM device
 733	 * @crtc: counter to fetch
 734	 *
 735	 * Driver callback for fetching a raw hardware vblank counter
 736	 * for @crtc.  If a device doesn't have a hardware counter, the
 737	 * driver can simply return the value of drm_vblank_count and
 738	 * make the enable_vblank() and disable_vblank() hooks into no-ops,
 739	 * leaving interrupts enabled at all times.
 740	 *
 741	 * Wraparound handling and loss of events due to modesetting is dealt
 742	 * with in the DRM core code.
 743	 *
 744	 * RETURNS
 745	 * Raw vblank counter value.
 746	 */
 747	u32 (*get_vblank_counter) (struct drm_device *dev, int crtc);
 748
 749	/**
 750	 * enable_vblank - enable vblank interrupt events
 751	 * @dev: DRM device
 752	 * @crtc: which irq to enable
 753	 *
 754	 * Enable vblank interrupts for @crtc.  If the device doesn't have
 755	 * a hardware vblank counter, this routine should be a no-op, since
 756	 * interrupts will have to stay on to keep the count accurate.
 757	 *
 758	 * RETURNS
 759	 * Zero on success, appropriate errno if the given @crtc's vblank
 760	 * interrupt cannot be enabled.
 761	 */
 762	int (*enable_vblank) (struct drm_device *dev, int crtc);
 763
 764	/**
 765	 * disable_vblank - disable vblank interrupt events
 766	 * @dev: DRM device
 767	 * @crtc: which irq to enable
 768	 *
 769	 * Disable vblank interrupts for @crtc.  If the device doesn't have
 770	 * a hardware vblank counter, this routine should be a no-op, since
 771	 * interrupts will have to stay on to keep the count accurate.
 772	 */
 773	void (*disable_vblank) (struct drm_device *dev, int crtc);
 774
 775	/**
 776	 * Called by \c drm_device_is_agp.  Typically used to determine if a
 777	 * card is really attached to AGP or not.
 778	 *
 779	 * \param dev  DRM device handle
 780	 *
 781	 * \returns
 782	 * One of three values is returned depending on whether or not the
 783	 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
 784	 * (return of 1), or may or may not be AGP (return of 2).
 785	 */
 786	int (*device_is_agp) (struct drm_device *dev);
 787
 788	/**
 789	 * Called by vblank timestamping code.
 790	 *
 791	 * Return the current display scanout position from a crtc.
 792	 *
 793	 * \param dev  DRM device.
 794	 * \param crtc Id of the crtc to query.
 795	 * \param *vpos Target location for current vertical scanout position.
 796	 * \param *hpos Target location for current horizontal scanout position.
 797	 *
 798	 * Returns vpos as a positive number while in active scanout area.
 799	 * Returns vpos as a negative number inside vblank, counting the number
 800	 * of scanlines to go until end of vblank, e.g., -1 means "one scanline
 801	 * until start of active scanout / end of vblank."
 802	 *
 803	 * \return Flags, or'ed together as follows:
 804	 *
 805	 * DRM_SCANOUTPOS_VALID = Query successful.
 806	 * DRM_SCANOUTPOS_INVBL = Inside vblank.
 807	 * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
 808	 * this flag means that returned position may be offset by a constant
 809	 * but unknown small number of scanlines wrt. real scanout position.
 810	 *
 811	 */
 812	int (*get_scanout_position) (struct drm_device *dev, int crtc,
 813				     int *vpos, int *hpos);
 814
 815	/**
 816	 * Called by \c drm_get_last_vbltimestamp. Should return a precise
 817	 * timestamp when the most recent VBLANK interval ended or will end.
 818	 *
 819	 * Specifically, the timestamp in @vblank_time should correspond as
 820	 * closely as possible to the time when the first video scanline of
 821	 * the video frame after the end of VBLANK will start scanning out,
 822	 * the time immmediately after end of the VBLANK interval. If the
 823	 * @crtc is currently inside VBLANK, this will be a time in the future.
 824	 * If the @crtc is currently scanning out a frame, this will be the
 825	 * past start time of the current scanout. This is meant to adhere
 826	 * to the OpenML OML_sync_control extension specification.
 827	 *
 828	 * \param dev dev DRM device handle.
 829	 * \param crtc crtc for which timestamp should be returned.
 830	 * \param *max_error Maximum allowable timestamp error in nanoseconds.
 831	 *                   Implementation should strive to provide timestamp
 832	 *                   with an error of at most *max_error nanoseconds.
 833	 *                   Returns true upper bound on error for timestamp.
 834	 * \param *vblank_time Target location for returned vblank timestamp.
 835	 * \param flags 0 = Defaults, no special treatment needed.
 836	 * \param       DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
 837	 *	        irq handler. Some drivers need to apply some workarounds
 838	 *              for gpu-specific vblank irq quirks if flag is set.
 839	 *
 840	 * \returns
 841	 * Zero if timestamping isn't supported in current display mode or a
 842	 * negative number on failure. A positive status code on success,
 843	 * which describes how the vblank_time timestamp was computed.
 844	 */
 845	int (*get_vblank_timestamp) (struct drm_device *dev, int crtc,
 846				     int *max_error,
 847				     struct timeval *vblank_time,
 848				     unsigned flags);
 849
 850	/* these have to be filled in */
 851
 852	irqreturn_t(*irq_handler) (DRM_IRQ_ARGS);
 853	void (*irq_preinstall) (struct drm_device *dev);
 854	int (*irq_postinstall) (struct drm_device *dev);
 855	void (*irq_uninstall) (struct drm_device *dev);
 856	void (*reclaim_buffers) (struct drm_device *dev,
 857				 struct drm_file * file_priv);
 858	void (*reclaim_buffers_locked) (struct drm_device *dev,
 859					struct drm_file *file_priv);
 860	void (*reclaim_buffers_idlelocked) (struct drm_device *dev,
 861					    struct drm_file *file_priv);
 862	void (*set_version) (struct drm_device *dev,
 863			     struct drm_set_version *sv);
 864
 865	/* Master routines */
 866	int (*master_create)(struct drm_device *dev, struct drm_master *master);
 867	void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
 868	/**
 869	 * master_set is called whenever the minor master is set.
 870	 * master_drop is called whenever the minor master is dropped.
 871	 */
 872
 873	int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
 874			  bool from_open);
 875	void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv,
 876			    bool from_release);
 877
 878	int (*debugfs_init)(struct drm_minor *minor);
 879	void (*debugfs_cleanup)(struct drm_minor *minor);
 880
 881	/**
 882	 * Driver-specific constructor for drm_gem_objects, to set up
 883	 * obj->driver_private.
 884	 *
 885	 * Returns 0 on success.
 886	 */
 887	int (*gem_init_object) (struct drm_gem_object *obj);
 888	void (*gem_free_object) (struct drm_gem_object *obj);
 889	int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
 890	void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
 891
 892	/* vga arb irq handler */
 893	void (*vgaarb_irq)(struct drm_device *dev, bool state);
 894
 895	/* dumb alloc support */
 896	int (*dumb_create)(struct drm_file *file_priv,
 897			   struct drm_device *dev,
 898			   struct drm_mode_create_dumb *args);
 899	int (*dumb_map_offset)(struct drm_file *file_priv,
 900			       struct drm_device *dev, uint32_t handle,
 901			       uint64_t *offset);
 902	int (*dumb_destroy)(struct drm_file *file_priv,
 903			    struct drm_device *dev,
 904			    uint32_t handle);
 905
 906	/* Driver private ops for this object */
 907	struct vm_operations_struct *gem_vm_ops;
 908
 909	int major;
 910	int minor;
 911	int patchlevel;
 912	char *name;
 913	char *desc;
 914	char *date;
 915
 916	u32 driver_features;
 917	int dev_priv_size;
 918	struct drm_ioctl_desc *ioctls;
 919	int num_ioctls;
 920	struct file_operations fops;
 921	union {
 922		struct pci_driver *pci;
 923		struct platform_device *platform_device;
 924		struct usb_driver *usb;
 925	} kdriver;
 926	struct drm_bus *bus;
 927
 928	/* List of devices hanging off this driver */
 929	struct list_head device_list;
 930};
 931
 932#define DRM_MINOR_UNASSIGNED 0
 933#define DRM_MINOR_LEGACY 1
 934#define DRM_MINOR_CONTROL 2
 935#define DRM_MINOR_RENDER 3
 936
 937
 938/**
 939 * debugfs node list. This structure represents a debugfs file to
 940 * be created by the drm core
 941 */
 942struct drm_debugfs_list {
 943	const char *name; /** file name */
 944	int (*show)(struct seq_file*, void*); /** show callback */
 945	u32 driver_features; /**< Required driver features for this entry */
 946};
 947
 948/**
 949 * debugfs node structure. This structure represents a debugfs file.
 950 */
 951struct drm_debugfs_node {
 952	struct list_head list;
 953	struct drm_minor *minor;
 954	struct drm_debugfs_list *debugfs_ent;
 955	struct dentry *dent;
 956};
 957
 958/**
 959 * Info file list entry. This structure represents a debugfs or proc file to
 960 * be created by the drm core
 961 */
 962struct drm_info_list {
 963	const char *name; /** file name */
 964	int (*show)(struct seq_file*, void*); /** show callback */
 965	u32 driver_features; /**< Required driver features for this entry */
 966	void *data;
 967};
 968
 969/**
 970 * debugfs node structure. This structure represents a debugfs file.
 971 */
 972struct drm_info_node {
 973	struct list_head list;
 974	struct drm_minor *minor;
 975	struct drm_info_list *info_ent;
 976	struct dentry *dent;
 977};
 978
 979/**
 980 * DRM minor structure. This structure represents a drm minor number.
 981 */
 982struct drm_minor {
 983	int index;			/**< Minor device number */
 984	int type;                       /**< Control or render */
 985	dev_t device;			/**< Device number for mknod */
 986	struct device kdev;		/**< Linux device */
 987	struct drm_device *dev;
 988
 989	struct proc_dir_entry *proc_root;  /**< proc directory entry */
 990	struct drm_info_node proc_nodes;
 991	struct dentry *debugfs_root;
 992	struct drm_info_node debugfs_nodes;
 993
 994	struct drm_master *master; /* currently active master for this node */
 995	struct list_head master_list;
 996	struct drm_mode_group mode_group;
 997};
 998
 999/* mode specified on the command line */
1000struct drm_cmdline_mode {
1001	bool specified;
1002	bool refresh_specified;
1003	bool bpp_specified;
1004	int xres, yres;
1005	int bpp;
1006	int refresh;
1007	bool rb;
1008	bool interlace;
1009	bool cvt;
1010	bool margins;
1011	enum drm_connector_force force;
1012};
1013
1014
1015struct drm_pending_vblank_event {
1016	struct drm_pending_event base;
1017	int pipe;
1018	struct drm_event_vblank event;
1019};
1020
1021/**
1022 * DRM device structure. This structure represent a complete card that
1023 * may contain multiple heads.
1024 */
1025struct drm_device {
1026	struct list_head driver_item;	/**< list of devices per driver */
1027	char *devname;			/**< For /proc/interrupts */
1028	int if_version;			/**< Highest interface version set */
1029
1030	/** \name Locks */
1031	/*@{ */
1032	spinlock_t count_lock;		/**< For inuse, drm_device::open_count, drm_device::buf_use */
1033	struct mutex struct_mutex;	/**< For others */
1034	/*@} */
1035
1036	/** \name Usage Counters */
1037	/*@{ */
1038	int open_count;			/**< Outstanding files open */
1039	atomic_t ioctl_count;		/**< Outstanding IOCTLs pending */
1040	atomic_t vma_count;		/**< Outstanding vma areas open */
1041	int buf_use;			/**< Buffers in use -- cannot alloc */
1042	atomic_t buf_alloc;		/**< Buffer allocation in progress */
1043	/*@} */
1044
1045	/** \name Performance counters */
1046	/*@{ */
1047	unsigned long counters;
1048	enum drm_stat_type types[15];
1049	atomic_t counts[15];
1050	/*@} */
1051
1052	struct list_head filelist;
1053
1054	/** \name Memory management */
1055	/*@{ */
1056	struct list_head maplist;	/**< Linked list of regions */
1057	int map_count;			/**< Number of mappable regions */
1058	struct drm_open_hash map_hash;	/**< User token hash table for maps */
1059
1060	/** \name Context handle management */
1061	/*@{ */
1062	struct list_head ctxlist;	/**< Linked list of context handles */
1063	int ctx_count;			/**< Number of context handles */
1064	struct mutex ctxlist_mutex;	/**< For ctxlist */
1065
1066	struct idr ctx_idr;
1067
1068	struct list_head vmalist;	/**< List of vmas (for debugging) */
1069
1070	/*@} */
1071
1072	/** \name DMA queues (contexts) */
1073	/*@{ */
1074	int queue_count;		/**< Number of active DMA queues */
1075	int queue_reserved;		  /**< Number of reserved DMA queues */
1076	int queue_slots;		/**< Actual length of queuelist */
1077	struct drm_queue **queuelist;	/**< Vector of pointers to DMA queues */
1078	struct drm_device_dma *dma;		/**< Optional pointer for DMA support */
1079	/*@} */
1080
1081	/** \name Context support */
1082	/*@{ */
1083	int irq_enabled;		/**< True if irq handler is enabled */
1084	__volatile__ long context_flag;	/**< Context swapping flag */
1085	__volatile__ long interrupt_flag; /**< Interruption handler flag */
1086	__volatile__ long dma_flag;	/**< DMA dispatch flag */
1087	wait_queue_head_t context_wait;	/**< Processes waiting on ctx switch */
1088	int last_checked;		/**< Last context checked for DMA */
1089	int last_context;		/**< Last current context */
1090	unsigned long last_switch;	/**< jiffies at last context switch */
1091	/*@} */
1092
1093	struct work_struct work;
1094	/** \name VBLANK IRQ support */
1095	/*@{ */
1096
1097	/*
1098	 * At load time, disabling the vblank interrupt won't be allowed since
1099	 * old clients may not call the modeset ioctl and therefore misbehave.
1100	 * Once the modeset ioctl *has* been called though, we can safely
1101	 * disable them when unused.
1102	 */
1103	int vblank_disable_allowed;
1104
1105	wait_queue_head_t *vbl_queue;   /**< VBLANK wait queue */
1106	atomic_t *_vblank_count;        /**< number of VBLANK interrupts (driver must alloc the right number of counters) */
1107	struct timeval *_vblank_time;   /**< timestamp of current vblank_count (drivers must alloc right number of fields) */
1108	spinlock_t vblank_time_lock;    /**< Protects vblank count and time updates during vblank enable/disable */
1109	spinlock_t vbl_lock;
1110	atomic_t *vblank_refcount;      /* number of users of vblank interruptsper crtc */
1111	u32 *last_vblank;               /* protected by dev->vbl_lock, used */
1112					/* for wraparound handling */
1113	int *vblank_enabled;            /* so we don't call enable more than
1114					   once per disable */
1115	int *vblank_inmodeset;          /* Display driver is setting mode */
1116	u32 *last_vblank_wait;		/* Last vblank seqno waited per CRTC */
1117	struct timer_list vblank_disable_timer;
1118
1119	u32 max_vblank_count;           /**< size of vblank counter register */
1120
1121	/**
1122	 * List of events
1123	 */
1124	struct list_head vblank_event_list;
1125	spinlock_t event_lock;
1126
1127	/*@} */
1128	cycles_t ctx_start;
1129	cycles_t lck_start;
1130
1131	struct fasync_struct *buf_async;/**< Processes waiting for SIGIO */
1132	wait_queue_head_t buf_readers;	/**< Processes waiting to read */
1133	wait_queue_head_t buf_writers;	/**< Processes waiting to ctx switch */
1134
1135	struct drm_agp_head *agp;	/**< AGP data */
1136
1137	struct device *dev;             /**< Device structure */
1138	struct pci_dev *pdev;		/**< PCI device structure */
1139	int pci_vendor;			/**< PCI vendor id */
1140	int pci_device;			/**< PCI device id */
1141#ifdef __alpha__
1142	struct pci_controller *hose;
1143#endif
1144
1145	struct platform_device *platformdev; /**< Platform device struture */
1146	struct usb_device *usbdev;
1147
1148	struct drm_sg_mem *sg;	/**< Scatter gather memory */
1149	unsigned int num_crtcs;                  /**< Number of CRTCs on this device */
1150	void *dev_private;		/**< device private data */
1151	void *mm_private;
1152	struct address_space *dev_mapping;
1153	struct drm_sigdata sigdata;	   /**< For block_all_signals */
1154	sigset_t sigmask;
1155
1156	struct drm_driver *driver;
1157	struct drm_local_map *agp_buffer_map;
1158	unsigned int agp_buffer_token;
1159	struct drm_minor *control;		/**< Control node for card */
1160	struct drm_minor *primary;		/**< render type primary screen head */
1161
1162        struct drm_mode_config mode_config;	/**< Current mode config */
1163
1164	/** \name GEM information */
1165	/*@{ */
1166	spinlock_t object_name_lock;
1167	struct idr object_name_idr;
1168	/*@} */
1169	int switch_power_state;
1170};
1171
1172#define DRM_SWITCH_POWER_ON 0
1173#define DRM_SWITCH_POWER_OFF 1
1174#define DRM_SWITCH_POWER_CHANGING 2
1175
1176static __inline__ int drm_core_check_feature(struct drm_device *dev,
1177					     int feature)
1178{
1179	return ((dev->driver->driver_features & feature) ? 1 : 0);
1180}
1181
1182static inline int drm_dev_to_irq(struct drm_device *dev)
1183{
1184	return dev->driver->bus->get_irq(dev);
1185}
1186
1187
1188#if __OS_HAS_AGP
1189static inline int drm_core_has_AGP(struct drm_device *dev)
1190{
1191	return drm_core_check_feature(dev, DRIVER_USE_AGP);
1192}
1193#else
1194#define drm_core_has_AGP(dev) (0)
1195#endif
1196
1197#if __OS_HAS_MTRR
1198static inline int drm_core_has_MTRR(struct drm_device *dev)
1199{
1200	return drm_core_check_feature(dev, DRIVER_USE_MTRR);
1201}
1202
1203#define DRM_MTRR_WC		MTRR_TYPE_WRCOMB
1204
1205static inline int drm_mtrr_add(unsigned long offset, unsigned long size,
1206			       unsigned int flags)
1207{
1208	return mtrr_add(offset, size, flags, 1);
1209}
1210
1211static inline int drm_mtrr_del(int handle, unsigned long offset,
1212			       unsigned long size, unsigned int flags)
1213{
1214	return mtrr_del(handle, offset, size);
1215}
1216
1217#else
1218#define drm_core_has_MTRR(dev) (0)
1219
1220#define DRM_MTRR_WC		0
1221
1222static inline int drm_mtrr_add(unsigned long offset, unsigned long size,
1223			       unsigned int flags)
1224{
1225	return 0;
1226}
1227
1228static inline int drm_mtrr_del(int handle, unsigned long offset,
1229			       unsigned long size, unsigned int flags)
1230{
1231	return 0;
1232}
1233#endif
1234
1235/******************************************************************/
1236/** \name Internal function definitions */
1237/*@{*/
1238
1239				/* Driver support (drm_drv.h) */
1240extern long drm_ioctl(struct file *filp,
1241		      unsigned int cmd, unsigned long arg);
1242extern long drm_compat_ioctl(struct file *filp,
1243			     unsigned int cmd, unsigned long arg);
1244extern int drm_lastclose(struct drm_device *dev);
1245
1246				/* Device support (drm_fops.h) */
1247extern struct mutex drm_global_mutex;
1248extern int drm_open(struct inode *inode, struct file *filp);
1249extern int drm_stub_open(struct inode *inode, struct file *filp);
1250extern int drm_fasync(int fd, struct file *filp, int on);
1251extern ssize_t drm_read(struct file *filp, char __user *buffer,
1252			size_t count, loff_t *offset);
1253extern int drm_release(struct inode *inode, struct file *filp);
1254
1255				/* Mapping support (drm_vm.h) */
1256extern int drm_mmap(struct file *filp, struct vm_area_struct *vma);
1257extern int drm_mmap_locked(struct file *filp, struct vm_area_struct *vma);
1258extern void drm_vm_open_locked(struct vm_area_struct *vma);
1259extern void drm_vm_close_locked(struct vm_area_struct *vma);
1260extern unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait);
1261
1262				/* Memory management support (drm_memory.h) */
1263#include "drm_memory.h"
1264extern void drm_mem_init(void);
1265extern int drm_mem_info(char *buf, char **start, off_t offset,
1266			int request, int *eof, void *data);
1267extern void *drm_realloc(void *oldpt, size_t oldsize, size_t size, int area);
1268
1269extern void drm_free_agp(DRM_AGP_MEM * handle, int pages);
1270extern int drm_bind_agp(DRM_AGP_MEM * handle, unsigned int start);
1271extern DRM_AGP_MEM *drm_agp_bind_pages(struct drm_device *dev,
1272				       struct page **pages,
1273				       unsigned long num_pages,
1274				       uint32_t gtt_offset,
1275				       uint32_t type);
1276extern int drm_unbind_agp(DRM_AGP_MEM * handle);
1277
1278				/* Misc. IOCTL support (drm_ioctl.h) */
1279extern int drm_irq_by_busid(struct drm_device *dev, void *data,
1280			    struct drm_file *file_priv);
1281extern int drm_getunique(struct drm_device *dev, void *data,
1282			 struct drm_file *file_priv);
1283extern int drm_setunique(struct drm_device *dev, void *data,
1284			 struct drm_file *file_priv);
1285extern int drm_getmap(struct drm_device *dev, void *data,
1286		      struct drm_file *file_priv);
1287extern int drm_getclient(struct drm_device *dev, void *data,
1288			 struct drm_file *file_priv);
1289extern int drm_getstats(struct drm_device *dev, void *data,
1290			struct drm_file *file_priv);
1291extern int drm_getcap(struct drm_device *dev, void *data,
1292		      struct drm_file *file_priv);
1293extern int drm_setversion(struct drm_device *dev, void *data,
1294			  struct drm_file *file_priv);
1295extern int drm_noop(struct drm_device *dev, void *data,
1296		    struct drm_file *file_priv);
1297
1298				/* Context IOCTL support (drm_context.h) */
1299extern int drm_resctx(struct drm_device *dev, void *data,
1300		      struct drm_file *file_priv);
1301extern int drm_addctx(struct drm_device *dev, void *data,
1302		      struct drm_file *file_priv);
1303extern int drm_modctx(struct drm_device *dev, void *data,
1304		      struct drm_file *file_priv);
1305extern int drm_getctx(struct drm_device *dev, void *data,
1306		      struct drm_file *file_priv);
1307extern int drm_switchctx(struct drm_device *dev, void *data,
1308			 struct drm_file *file_priv);
1309extern int drm_newctx(struct drm_device *dev, void *data,
1310		      struct drm_file *file_priv);
1311extern int drm_rmctx(struct drm_device *dev, void *data,
1312		     struct drm_file *file_priv);
1313
1314extern int drm_ctxbitmap_init(struct drm_device *dev);
1315extern void drm_ctxbitmap_cleanup(struct drm_device *dev);
1316extern void drm_ctxbitmap_free(struct drm_device *dev, int ctx_handle);
1317
1318extern int drm_setsareactx(struct drm_device *dev, void *data,
1319			   struct drm_file *file_priv);
1320extern int drm_getsareactx(struct drm_device *dev, void *data,
1321			   struct drm_file *file_priv);
1322
1323				/* Authentication IOCTL support (drm_auth.h) */
1324extern int drm_getmagic(struct drm_device *dev, void *data,
1325			struct drm_file *file_priv);
1326extern int drm_authmagic(struct drm_device *dev, void *data,
1327			 struct drm_file *file_priv);
1328
1329/* Cache management (drm_cache.c) */
1330void drm_clflush_pages(struct page *pages[], unsigned long num_pages);
1331
1332				/* Locking IOCTL support (drm_lock.h) */
1333extern int drm_lock(struct drm_device *dev, void *data,
1334		    struct drm_file *file_priv);
1335extern int drm_unlock(struct drm_device *dev, void *data,
1336		      struct drm_file *file_priv);
1337extern int drm_lock_free(struct drm_lock_data *lock_data, unsigned int context);
1338extern void drm_idlelock_take(struct drm_lock_data *lock_data);
1339extern void drm_idlelock_release(struct drm_lock_data *lock_data);
1340
1341/*
1342 * These are exported to drivers so that they can implement fencing using
1343 * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
1344 */
1345
1346extern int drm_i_have_hw_lock(struct drm_device *dev, struct drm_file *file_priv);
1347
1348				/* Buffer management support (drm_bufs.h) */
1349extern int drm_addbufs_agp(struct drm_device *dev, struct drm_buf_desc * request);
1350extern int drm_addbufs_pci(struct drm_device *dev, struct drm_buf_desc * request);
1351extern int drm_addmap(struct drm_device *dev, resource_size_t offset,
1352		      unsigned int size, enum drm_map_type type,
1353		      enum drm_map_flags flags, struct drm_local_map **map_ptr);
1354extern int drm_addmap_ioctl(struct drm_device *dev, void *data,
1355			    struct drm_file *file_priv);
1356extern int drm_rmmap(struct drm_device *dev, struct drm_local_map *map);
1357extern int drm_rmmap_locked(struct drm_device *dev, struct drm_local_map *map);
1358extern int drm_rmmap_ioctl(struct drm_device *dev, void *data,
1359			   struct drm_file *file_priv);
1360extern int drm_addbufs(struct drm_device *dev, void *data,
1361		       struct drm_file *file_priv);
1362extern int drm_infobufs(struct drm_device *dev, void *data,
1363			struct drm_file *file_priv);
1364extern int drm_markbufs(struct drm_device *dev, void *data,
1365			struct drm_file *file_priv);
1366extern int drm_freebufs(struct drm_device *dev, void *data,
1367			struct drm_file *file_priv);
1368extern int drm_mapbufs(struct drm_device *dev, void *data,
1369		       struct drm_file *file_priv);
1370extern int drm_order(unsigned long size);
1371
1372				/* DMA support (drm_dma.h) */
1373extern int drm_dma_setup(struct drm_device *dev);
1374extern void drm_dma_takedown(struct drm_device *dev);
1375extern void drm_free_buffer(struct drm_device *dev, struct drm_buf * buf);
1376extern void drm_core_reclaim_buffers(struct drm_device *dev,
1377				     struct drm_file *filp);
1378
1379				/* IRQ support (drm_irq.h) */
1380extern int drm_control(struct drm_device *dev, void *data,
1381		       struct drm_file *file_priv);
1382extern irqreturn_t drm_irq_handler(DRM_IRQ_ARGS);
1383extern int drm_irq_install(struct drm_device *dev);
1384extern int drm_irq_uninstall(struct drm_device *dev);
1385extern void drm_driver_irq_preinstall(struct drm_device *dev);
1386extern void drm_driver_irq_postinstall(struct drm_device *dev);
1387extern void drm_driver_irq_uninstall(struct drm_device *dev);
1388
1389extern int drm_vblank_init(struct drm_device *dev, int num_crtcs);
1390extern int drm_wait_vblank(struct drm_device *dev, void *data,
1391			   struct drm_file *filp);
1392extern int drm_vblank_wait(struct drm_device *dev, unsigned int *vbl_seq);
1393extern u32 drm_vblank_count(struct drm_device *dev, int crtc);
1394extern u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
1395				     struct timeval *vblanktime);
1396extern bool drm_handle_vblank(struct drm_device *dev, int crtc);
1397extern int drm_vblank_get(struct drm_device *dev, int crtc);
1398extern void drm_vblank_put(struct drm_device *dev, int crtc);
1399extern void drm_vblank_off(struct drm_device *dev, int crtc);
1400extern void drm_vblank_cleanup(struct drm_device *dev);
1401extern u32 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
1402				     struct timeval *tvblank, unsigned flags);
1403extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
1404						 int crtc, int *max_error,
1405						 struct timeval *vblank_time,
1406						 unsigned flags,
1407						 struct drm_crtc *refcrtc);
1408extern void drm_calc_timestamping_constants(struct drm_crtc *crtc);
1409
1410extern bool
1411drm_mode_parse_command_line_for_connector(const char *mode_option,
1412					  struct drm_connector *connector,
1413					  struct drm_cmdline_mode *mode);
1414
1415extern struct drm_display_mode *
1416drm_mode_create_from_cmdline_mode(struct drm_device *dev,
1417				  struct drm_cmdline_mode *cmd);
1418
1419/* Modesetting support */
1420extern void drm_vblank_pre_modeset(struct drm_device *dev, int crtc);
1421extern void drm_vblank_post_modeset(struct drm_device *dev, int crtc);
1422extern int drm_modeset_ctl(struct drm_device *dev, void *data,
1423			   struct drm_file *file_priv);
1424
1425				/* AGP/GART support (drm_agpsupport.h) */
1426extern struct drm_agp_head *drm_agp_init(struct drm_device *dev);
1427extern int drm_agp_acquire(struct drm_device *dev);
1428extern int drm_agp_acquire_ioctl(struct drm_device *dev, void *data,
1429				 struct drm_file *file_priv);
1430extern int drm_agp_release(struct drm_device *dev);
1431extern int drm_agp_release_ioctl(struct drm_device *dev, void *data,
1432				 struct drm_file *file_priv);
1433extern int drm_agp_enable(struct drm_device *dev, struct drm_agp_mode mode);
1434extern int drm_agp_enable_ioctl(struct drm_device *dev, void *data,
1435				struct drm_file *file_priv);
1436extern int drm_agp_info(struct drm_device *dev, struct drm_agp_info *info);
1437extern int drm_agp_info_ioctl(struct drm_device *dev, void *data,
1438			struct drm_file *file_priv);
1439extern int drm_agp_alloc(struct drm_device *dev, struct drm_agp_buffer *request);
1440extern int drm_agp_alloc_ioctl(struct drm_device *dev, void *data,
1441			 struct drm_file *file_priv);
1442extern int drm_agp_free(struct drm_device *dev, struct drm_agp_buffer *request);
1443extern int drm_agp_free_ioctl(struct drm_device *dev, void *data,
1444			struct drm_file *file_priv);
1445extern int drm_agp_unbind(struct drm_device *dev, struct drm_agp_binding *request);
1446extern int drm_agp_unbind_ioctl(struct drm_device *dev, void *data,
1447			  struct drm_file *file_priv);
1448extern int drm_agp_bind(struct drm_device *dev, struct drm_agp_binding *request);
1449extern int drm_agp_bind_ioctl(struct drm_device *dev, void *data,
1450			struct drm_file *file_priv);
1451
1452				/* Stub support (drm_stub.h) */
1453extern int drm_setmaster_ioctl(struct drm_device *dev, void *data,
1454			       struct drm_file *file_priv);
1455extern int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
1456				struct drm_file *file_priv);
1457struct drm_master *drm_master_create(struct drm_minor *minor);
1458extern struct drm_master *drm_master_get(struct drm_master *master);
1459extern void drm_master_put(struct drm_master **master);
1460
1461extern void drm_put_dev(struct drm_device *dev);
1462extern int drm_put_minor(struct drm_minor **minor);
1463extern unsigned int drm_debug;
1464
1465extern unsigned int drm_vblank_offdelay;
1466extern unsigned int drm_timestamp_precision;
1467
1468extern struct class *drm_class;
1469extern struct proc_dir_entry *drm_proc_root;
1470extern struct dentry *drm_debugfs_root;
1471
1472extern struct idr drm_minors_idr;
1473
1474extern struct drm_local_map *drm_getsarea(struct drm_device *dev);
1475
1476				/* Proc support (drm_proc.h) */
1477extern int drm_proc_init(struct drm_minor *minor, int minor_id,
1478			 struct proc_dir_entry *root);
1479extern int drm_proc_cleanup(struct drm_minor *minor, struct proc_dir_entry *root);
1480
1481				/* Debugfs support */
1482#if defined(CONFIG_DEBUG_FS)
1483extern int drm_debugfs_init(struct drm_minor *minor, int minor_id,
1484			    struct dentry *root);
1485extern int drm_debugfs_create_files(struct drm_info_list *files, int count,
1486				    struct dentry *root, struct drm_minor *minor);
1487extern int drm_debugfs_remove_files(struct drm_info_list *files, int count,
1488                                    struct drm_minor *minor);
1489extern int drm_debugfs_cleanup(struct drm_minor *minor);
1490#endif
1491
1492				/* Info file support */
1493extern int drm_name_info(struct seq_file *m, void *data);
1494extern int drm_vm_info(struct seq_file *m, void *data);
1495extern int drm_queues_info(struct seq_file *m, void *data);
1496extern int drm_bufs_info(struct seq_file *m, void *data);
1497extern int drm_vblank_info(struct seq_file *m, void *data);
1498extern int drm_clients_info(struct seq_file *m, void* data);
1499extern int drm_gem_name_info(struct seq_file *m, void *data);
1500
1501#if DRM_DEBUG_CODE
1502extern int drm_vma_info(struct seq_file *m, void *data);
1503#endif
1504
1505				/* Scatter Gather Support (drm_scatter.h) */
1506extern void drm_sg_cleanup(struct drm_sg_mem * entry);
1507extern int drm_sg_alloc_ioctl(struct drm_device *dev, void *data,
1508			struct drm_file *file_priv);
1509extern int drm_sg_alloc(struct drm_device *dev, struct drm_scatter_gather * request);
1510extern int drm_sg_free(struct drm_device *dev, void *data,
1511		       struct drm_file *file_priv);
1512
1513			       /* ATI PCIGART support (ati_pcigart.h) */
1514extern int drm_ati_pcigart_init(struct drm_device *dev,
1515				struct drm_ati_pcigart_info * gart_info);
1516extern int drm_ati_pcigart_cleanup(struct drm_device *dev,
1517				   struct drm_ati_pcigart_info * gart_info);
1518
1519extern drm_dma_handle_t *drm_pci_alloc(struct drm_device *dev, size_t size,
1520				       size_t align);
1521extern void __drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
1522extern void drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
1523
1524			       /* sysfs support (drm_sysfs.c) */
1525struct drm_sysfs_class;
1526extern struct class *drm_sysfs_create(struct module *owner, char *name);
1527extern void drm_sysfs_destroy(void);
1528extern int drm_sysfs_device_add(struct drm_minor *minor);
1529extern void drm_sysfs_hotplug_event(struct drm_device *dev);
1530extern void drm_sysfs_device_remove(struct drm_minor *minor);
1531extern char *drm_get_connector_status_name(enum drm_connector_status status);
1532extern int drm_sysfs_connector_add(struct drm_connector *connector);
1533extern void drm_sysfs_connector_remove(struct drm_connector *connector);
1534
1535/* Graphics Execution Manager library functions (drm_gem.c) */
1536int drm_gem_init(struct drm_device *dev);
1537void drm_gem_destroy(struct drm_device *dev);
1538void drm_gem_object_release(struct drm_gem_object *obj);
1539void drm_gem_object_free(struct kref *kref);
1540struct drm_gem_object *drm_gem_object_alloc(struct drm_device *dev,
1541					    size_t size);
1542int drm_gem_object_init(struct drm_device *dev,
1543			struct drm_gem_object *obj, size_t size);
1544int drm_gem_private_object_init(struct drm_device *dev,
1545			struct drm_gem_object *obj, size_t size);
1546void drm_gem_object_handle_free(struct drm_gem_object *obj);
1547void drm_gem_vm_open(struct vm_area_struct *vma);
1548void drm_gem_vm_close(struct vm_area_struct *vma);
1549int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma);
1550
1551#include "drm_global.h"
1552
1553static inline void
1554drm_gem_object_reference(struct drm_gem_object *obj)
1555{
1556	kref_get(&obj->refcount);
1557}
1558
1559static inline void
1560drm_gem_object_unreference(struct drm_gem_object *obj)
1561{
1562	if (obj != NULL)
1563		kref_put(&obj->refcount, drm_gem_object_free);
1564}
1565
1566static inline void
1567drm_gem_object_unreference_unlocked(struct drm_gem_object *obj)
1568{
1569	if (obj != NULL) {
1570		struct drm_device *dev = obj->dev;
1571		mutex_lock(&dev->struct_mutex);
1572		kref_put(&obj->refcount, drm_gem_object_free);
1573		mutex_unlock(&dev->struct_mutex);
1574	}
1575}
1576
1577int drm_gem_handle_create(struct drm_file *file_priv,
1578			  struct drm_gem_object *obj,
1579			  u32 *handlep);
1580int drm_gem_handle_delete(struct drm_file *filp, u32 handle);
1581
1582static inline void
1583drm_gem_object_handle_reference(struct drm_gem_object *obj)
1584{
1585	drm_gem_object_reference(obj);
1586	atomic_inc(&obj->handle_count);
1587}
1588
1589static inline void
1590drm_gem_object_handle_unreference(struct drm_gem_object *obj)
1591{
1592	if (obj == NULL)
1593		return;
1594
1595	if (atomic_read(&obj->handle_count) == 0)
1596		return;
1597	/*
1598	 * Must bump handle count first as this may be the last
1599	 * ref, in which case the object would disappear before we
1600	 * checked for a name
1601	 */
1602	if (atomic_dec_and_test(&obj->handle_count))
1603		drm_gem_object_handle_free(obj);
1604	drm_gem_object_unreference(obj);
1605}
1606
1607static inline void
1608drm_gem_object_handle_unreference_unlocked(struct drm_gem_object *obj)
1609{
1610	if (obj == NULL)
1611		return;
1612
1613	if (atomic_read(&obj->handle_count) == 0)
1614		return;
1615
1616	/*
1617	* Must bump handle count first as this may be the last
1618	* ref, in which case the object would disappear before we
1619	* checked for a name
1620	*/
1621
1622	if (atomic_dec_and_test(&obj->handle_count))
1623		drm_gem_object_handle_free(obj);
1624	drm_gem_object_unreference_unlocked(obj);
1625}
1626
1627struct drm_gem_object *drm_gem_object_lookup(struct drm_device *dev,
1628					     struct drm_file *filp,
1629					     u32 handle);
1630int drm_gem_close_ioctl(struct drm_device *dev, void *data,
1631			struct drm_file *file_priv);
1632int drm_gem_flink_ioctl(struct drm_device *dev, void *data,
1633			struct drm_file *file_priv);
1634int drm_gem_open_ioctl(struct drm_device *dev, void *data,
1635		       struct drm_file *file_priv);
1636void drm_gem_open(struct drm_device *dev, struct drm_file *file_private);
1637void drm_gem_release(struct drm_device *dev, struct drm_file *file_private);
1638
1639extern void drm_core_ioremap(struct drm_local_map *map, struct drm_device *dev);
1640extern void drm_core_ioremap_wc(struct drm_local_map *map, struct drm_device *dev);
1641extern void drm_core_ioremapfree(struct drm_local_map *map, struct drm_device *dev);
1642
1643static __inline__ struct drm_local_map *drm_core_findmap(struct drm_device *dev,
1644							 unsigned int token)
1645{
1646	struct drm_map_list *_entry;
1647	list_for_each_entry(_entry, &dev->maplist, head)
1648	    if (_entry->user_token == token)
1649		return _entry->map;
1650	return NULL;
1651}
1652
1653static __inline__ void drm_core_dropmap(struct drm_local_map *map)
1654{
1655}
1656
1657#include "drm_mem_util.h"
1658
1659extern int drm_fill_in_dev(struct drm_device *dev,
1660			   const struct pci_device_id *ent,
1661			   struct drm_driver *driver);
1662int drm_get_minor(struct drm_device *dev, struct drm_minor **minor, int type);
1663/*@}*/
1664
1665/* PCI section */
1666static __inline__ int drm_pci_device_is_agp(struct drm_device *dev)
1667{
1668	if (dev->driver->device_is_agp != NULL) {
1669		int err = (*dev->driver->device_is_agp) (dev);
1670
1671		if (err != 2) {
1672			return err;
1673		}
1674	}
1675
1676	return pci_find_capability(dev->pdev, PCI_CAP_ID_AGP);
1677}
1678
1679extern int drm_pci_init(struct drm_driver *driver, struct pci_driver *pdriver);
1680extern void drm_pci_exit(struct drm_driver *driver, struct pci_driver *pdriver);
1681extern int drm_get_pci_dev(struct pci_dev *pdev,
1682			   const struct pci_device_id *ent,
1683			   struct drm_driver *driver);
1684
1685
1686/* platform section */
1687extern int drm_platform_init(struct drm_driver *driver, struct platform_device *platform_device);
1688extern void drm_platform_exit(struct drm_driver *driver, struct platform_device *platform_device);
1689
1690extern int drm_get_platform_dev(struct platform_device *pdev,
1691				struct drm_driver *driver);
1692
1693#endif				/* __KERNEL__ */
1694#endif