drm: simplify authentication management
[dragonfly.git] / sys / dev / drm / include / drm / drmP.h
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 #if defined(_KERNEL) || defined(__KERNEL__)
36
37 #include <sys/param.h>
38 #include <sys/queue.h>
39 #include <sys/malloc.h>
40 #include <sys/kernel.h>
41 #include <sys/ktr.h>
42 #include <sys/module.h>
43 #include <sys/systm.h>
44 #include <sys/device.h>
45 #include <sys/sglist.h>
46 #include <sys/stat.h>
47 #include <sys/priv.h>
48 #include <sys/proc.h>
49 #include <sys/lock.h>
50 #include <sys/spinlock.h>
51 #include <sys/spinlock2.h>
52 #include <sys/fcntl.h>
53 #include <sys/uio.h>
54 #include <sys/filio.h>
55 #include <sys/sysctl.h>
56 #include <sys/bus.h>
57 #include <sys/signalvar.h>
58 #include <sys/poll.h>
59 #include <linux/highmem.h>
60 #include <sys/sbuf.h>
61 #include <sys/taskqueue.h>
62 #include <sys/tree.h>
63 #include <vm/vm.h>
64 #include <vm/pmap.h>
65 #include <vm/vm_extern.h>
66 #include <vm/vm_kern.h>
67 #include <vm/vm_map.h>
68 #include <vm/vm_object.h>
69 #include <vm/vm_page2.h>
70 #include <vm/vm_pager.h>
71 #include <vm/vm_param.h>
72 #include <machine/param.h>
73 #include <machine/pmap.h>
74 #ifdef __x86_64__
75 #include <machine/specialreg.h>
76 #endif
77 #include <machine/sysarch.h>
78 #include <sys/endian.h>
79 #include <sys/mman.h>
80 #include <sys/rman.h>
81 #include <sys/memrange.h>
82 #include <sys/mutex.h>
83
84 #include <linux/agp_backend.h>
85 #include <linux/atomic.h>
86 #include <linux/bug.h>
87 #include <linux/dma-mapping.h>
88 #include <linux/capability.h>
89 #include <linux/err.h>
90 #include <linux/idr.h>
91 #include <linux/pci.h>
92 #include <linux/jiffies.h>
93 #include <linux/kernel.h>
94 #include <linux/fs.h>
95 #include <linux/kref.h>
96 #include <linux/list.h>
97 #include <linux/mm.h>
98 #include <linux/moduleparam.h>
99 #include <linux/mutex.h>
100 #include <linux/slab.h>
101 #include <linux/scatterlist.h>
102 #include <linux/timer.h>
103 #include <asm/io.h>
104 #include <linux/seq_file.h>
105 #include <linux/types.h>
106 #include <linux/vmalloc.h>
107 #include <linux/wait.h>
108 #include <linux/workqueue.h>
109
110 #include <asm/uaccess.h>
111
112 #include <uapi_drm/drm.h>
113 #include <uapi_drm/drm_mode.h>
114
115 #include <drm/drm_agpsupport.h>
116 #include <drm/drm_crtc.h>
117 #include <drm/drm_global.h>
118 #include <drm/drm_hashtab.h>
119 #include <drm/drm_mem_util.h>
120 #include <drm/drm_mm.h>
121 #include <drm/drm_os_linux.h>
122 #include <uapi_drm/drm_sarea.h>
123 #include <drm/drm_vma_manager.h>
124
125 struct drm_file;
126 struct drm_device;
127 struct drm_agp_head;
128 struct drm_local_map;
129 struct drm_device_dma;
130 struct drm_dma_handle;
131 struct drm_gem_object;
132
133 struct device_node;
134 #ifdef CONFIG_VIDEOMODE_HELPERS
135 struct videomode;       /* XXX empty struct in videomode.h ? */
136 #endif
137 struct reservation_object;
138 struct dma_buf_attachment;
139
140 /*
141  * 4 debug categories are defined:
142  *
143  * CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c, drm_memory.c, ...
144  *       This is the category used by the DRM_DEBUG() macro.
145  *
146  * DRIVER: Used in the vendor specific part of the driver: i915, radeon, ...
147  *         This is the category used by the DRM_DEBUG_DRIVER() macro.
148  *
149  * KMS: used in the modesetting code.
150  *      This is the category used by the DRM_DEBUG_KMS() macro.
151  *
152  * PRIME: used in the prime code.
153  *        This is the category used by the DRM_DEBUG_PRIME() macro.
154  *
155  * ATOMIC: used in the atomic code.
156  *        This is the category used by the DRM_DEBUG_ATOMIC() macro.
157  *
158  *
159  * PID: used as modifier to include PID number in messages.
160  *        This is the category used by the all debug macros.
161  *
162  * FIOCTL: used in failed ioctl debugging.
163  *        This is the category used by the DRM_DEBUG_FIOCTL() macro.
164  *
165  * IOCTL: used in ioctl debugging.
166  *        This is the category used by the DRM_DEBUG_IOCTL() macro.
167  *
168  * VBLANK: used in vblank debugging.
169  *        This is the category used by the DRM_DEBUG_VBLANK() macro.
170  *
171  * Enabling verbose debug messages is done through the drm.debug parameter,
172  * each category being enabled by a bit.
173  *
174  * drm.debug=0x1 will enable CORE messages
175  * drm.debug=0x2 will enable DRIVER messages
176  * drm.debug=0x3 will enable CORE and DRIVER messages
177  * ...
178  * drm.debug=0xf will enable all messages
179  *
180  * An interesting feature is that it's possible to enable verbose logging at
181  * run-time by using hw.drm.debug sysctl variable:
182  *   # sysctl hw.drm.debug=0xfff
183  */
184 #define DRM_UT_CORE             0x01
185 #define DRM_UT_DRIVER           0x02
186 #define DRM_UT_KMS              0x04
187 #define DRM_UT_PRIME            0x08
188 #define DRM_UT_ATOMIC           0x10
189 #define DRM_UT_VBL              0x20
190 /* Extra DragonFly debug categories */
191 #ifdef __DragonFly__
192 #define DRM_UT_RES7             0x40    /* reserved for future expansion */
193 #define DRM_UT_RES8             0x80    /* reserved for future expansion */
194 #define DRM_UT_PID              0x100
195 #define DRM_UT_FIOCTL           0x200
196 #define DRM_UT_IOCTL            0x400
197 #define DRM_UT_VBLANK           0x800
198 #endif
199
200 extern __printflike(2, 3)
201 void drm_ut_debug_printk(const char *function_name,
202                          const char *format, ...);
203 extern __printflike(2, 3)
204 void drm_err(const char *func, const char *format, ...);
205
206 /***********************************************************************/
207 /** \name DRM template customization defaults */
208 /*@{*/
209
210 /* driver capabilities and requirements mask */
211 #define DRIVER_USE_AGP                  0x1
212 #define DRIVER_PCI_DMA                  0x8
213 #define DRIVER_SG                       0x10
214 #define DRIVER_HAVE_DMA                 0x20
215 #define DRIVER_HAVE_IRQ                 0x40
216 #define DRIVER_IRQ_SHARED               0x80
217 #define DRIVER_GEM                      0x1000
218 #define DRIVER_MODESET                  0x2000
219 #define DRIVER_PRIME                    0x4000
220 #define DRIVER_RENDER                   0x8000
221 #define DRIVER_ATOMIC                   0x10000
222 #define DRIVER_KMS_LEGACY_CONTEXT       0x20000
223
224 #define DRM_MAGIC_HASH_ORDER  4  /**< Size of key hash table. Must be power of 2. */
225
226 /***********************************************************************/
227 /** \name Macros to make printk easier */
228 /*@{*/
229
230 /**
231  * Error output.
232  *
233  * \param fmt printf() like format string.
234  * \param arg arguments
235  */
236 #define DRM_ERROR(fmt, ...)                             \
237         drm_err(__func__, fmt, ##__VA_ARGS__)
238
239 /**
240  * Rate limited error output.  Like DRM_ERROR() but won't flood the log.
241  *
242  * \param fmt printf() like format string.
243  * \param arg arguments
244  */
245 #define DRM_ERROR_RATELIMITED(fmt, ...)                         \
246 ({                                                                      \
247         static struct krate krate_derr = { .freq = 1, .count = -16 };   \
248                                                                         \
249         krateprintf(&krate_derr, "error: [" DRM_NAME ":%s] *ERROR* "    \
250             fmt, __func__, ##__VA_ARGS__);                              \
251 })
252
253 #define DRM_INFO(fmt, ...)                              \
254         printk(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
255
256 #define DRM_INFO_ONCE(fmt, ...)                         \
257         printk_once(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
258
259 /**
260  * Debug output.
261  *
262  * \param fmt printf() like format string.
263  * \param arg arguments
264  */
265 #define DRM_DEBUG(fmt, args...)                                         \
266         do {                                                            \
267                 if (unlikely(drm_debug & DRM_UT_CORE))                  \
268                         drm_ut_debug_printk(__func__, fmt, ##args);     \
269         } while (0)
270
271 #define DRM_DEBUG_DRIVER(fmt, args...)                                  \
272         do {                                                            \
273                 if (unlikely(drm_debug & DRM_UT_DRIVER))                \
274                         drm_ut_debug_printk(__func__, fmt, ##args);     \
275         } while (0)
276 #define DRM_DEBUG_KMS(fmt, args...)                                     \
277         do {                                                            \
278                 if (unlikely(drm_debug & DRM_UT_KMS))                   \
279                         drm_ut_debug_printk(__func__, fmt, ##args);     \
280         } while (0)
281 #define DRM_DEBUG_PRIME(fmt, args...)                                   \
282         do {                                                            \
283                 if (unlikely(drm_debug & DRM_UT_PRIME))                 \
284                         drm_ut_debug_printk(__func__, fmt, ##args);     \
285         } while (0)
286 #define DRM_DEBUG_ATOMIC(fmt, args...)                                  \
287         do {                                                            \
288                 if (unlikely(drm_debug & DRM_UT_ATOMIC))                \
289                         drm_ut_debug_printk(__func__, fmt, ##args);     \
290         } while (0)
291
292 #ifdef __DragonFly__
293 #define DRM_DEBUG_FIOCTL(fmt, args...)                                  \
294         do {                                                            \
295                 if (unlikely(drm_debug & DRM_UT_FIOCTL))                \
296                         drm_ut_debug_printk(__func__, fmt, ##args);     \
297         } while (0)
298 #define DRM_DEBUG_IOCTL(fmt, args...)                                   \
299         do {                                                            \
300                 if (unlikely(drm_debug & DRM_UT_IOCTL))                 \
301                         drm_ut_debug_printk(__func__, fmt, ##args);     \
302         } while (0)
303 #define DRM_DEBUG_VBLANK(fmt, args...)                                  \
304         do {                                                            \
305                 if (unlikely(drm_debug & DRM_UT_VBLANK))                \
306                         drm_ut_debug_printk(__func__, fmt, ##args);     \
307         } while (0)
308 #define DRM_DEBUG_VBL(fmt, args...)                                     \
309         do {                                                            \
310                 if (unlikely(drm_debug & DRM_UT_VBL))           \
311                         drm_ut_debug_printk(__func__, fmt, ##args);     \
312         } while (0)
313 #endif
314
315 /*@}*/
316
317 /***********************************************************************/
318 /** \name Internal types and structures */
319 /*@{*/
320
321 SYSCTL_DECL(_hw_drm);
322
323 #define DRM_MAX(a,b) ((a)>(b)?(a):(b))
324
325 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
326
327 #define DRM_DEV_MODE    (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
328 #define DRM_DEV_UID     UID_ROOT
329 #define DRM_DEV_GID     GID_WHEEL
330
331 #define DRM_CURPROC             curthread
332 #define DRM_STRUCTPROC          struct thread
333 #define DRM_LOCK(dev)           lockmgr(&(dev)->struct_mutex, LK_EXCLUSIVE)
334 #define DRM_UNLOCK(dev)         lockmgr(&(dev)->struct_mutex, LK_RELEASE)
335 #define DRM_LOCK_SLEEP(dev, chan, flags, msg, timeout)                  \
336     (lksleep((chan), &(dev)->struct_mutex, (flags), (msg), (timeout)))
337 #if defined(INVARIANTS)
338 #define DRM_LOCK_ASSERT(dev)    KKASSERT(lockstatus(&(dev)->struct_mutex, curthread) != 0);
339 #define DRM_UNLOCK_ASSERT(dev)  KKASSERT(lockstatus(&(dev)->struct_mutex, curthread) == 0);
340 #else
341 #define DRM_LOCK_ASSERT(d)
342 #define DRM_UNLOCK_ASSERT(d)
343 #endif
344
345 #define DRM_SYSCTL_HANDLER_ARGS (SYSCTL_HANDLER_ARGS)
346
347 #define drm_get_device_from_kdev(_kdev) (_kdev->si_drv1)
348
349 #define DRM_MTRR_WC             MDF_WRITECOMBINE
350
351 int vm_phys_fictitious_reg_range(vm_paddr_t start, vm_paddr_t end,
352     vm_memattr_t memattr);
353 void vm_phys_fictitious_unreg_range(vm_paddr_t start, vm_paddr_t end);
354 vm_page_t vm_phys_fictitious_to_vm_page(vm_paddr_t pa);
355
356 /* drm_memory.c */
357 int     drm_mtrr_add(unsigned long offset, size_t size, int flags);
358 int     drm_mtrr_del(int handle, unsigned long offset, size_t size, int flags);
359
360 typedef struct drm_pci_id_list
361 {
362         int vendor;
363         int device;
364         long driver_private;
365         char *name;
366 } drm_pci_id_list_t;
367
368 /**
369  * Ioctl function type.
370  *
371  * \param inode device inode.
372  * \param file_priv DRM file private pointer.
373  * \param cmd command.
374  * \param arg argument.
375  */
376 typedef int drm_ioctl_t(struct drm_device *dev, void *data,
377                         struct drm_file *file_priv);
378
379 typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd,
380                                unsigned long arg);
381
382 #define DRM_IOCTL_NR(n)                ((n) & 0xff)
383
384 #define DRM_AUTH        0x1
385 #define DRM_MASTER      0x2
386 #define DRM_ROOT_ONLY   0x4
387 #define DRM_CONTROL_ALLOW 0x8
388 #define DRM_UNLOCKED    0x10
389 #define DRM_RENDER_ALLOW 0x20
390
391 struct drm_ioctl_desc {
392         unsigned int cmd;
393         int flags;
394         drm_ioctl_t *func;
395         unsigned int cmd_drv;
396         const char *name;
397 };
398
399 /**
400  * Creates a driver or general drm_ioctl_desc array entry for the given
401  * ioctl, for use by drm_ioctl().
402  */
403
404 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags)                         \
405         [DRM_IOCTL_NR(DRM_##ioctl)] = {                                 \
406                 .cmd = DRM_##ioctl,                                     \
407                 .func = _func,                                          \
408                 .flags = _flags,                                        \
409                 .cmd_drv = DRM_IOCTL_##ioctl,                           \
410                 .name = #ioctl                                          \
411         }
412
413 typedef struct drm_magic_entry {
414         struct list_head head;
415         struct drm_hash_item hash_item;
416         struct drm_file        *priv;
417         struct drm_magic_entry *next;
418 } drm_magic_entry_t;
419
420 /* Event queued up for userspace to read */
421 struct drm_pending_event {
422         struct drm_event *event;
423         struct list_head link;
424         struct list_head pending_link;
425         struct drm_file *file_priv;
426         pid_t pid; /* pid of requester, no guarantee it's valid by the time
427                       we deliver the event, for tracing only */
428         void (*destroy)(struct drm_pending_event *event);
429 };
430
431 /* initial implementaton using a linked list - todo hashtab */
432 struct drm_prime_file_private {
433         struct list_head head;
434         struct lock lock;
435 };
436
437 /** File private data */
438 struct drm_file {
439         unsigned authenticated :1;
440         /* Whether we're master for a minor. Protected by master_mutex */
441         unsigned is_master :1;
442
443         /* true when the client has asked us to expose stereo 3D mode flags */
444         unsigned stereo_allowed :1;
445         /*
446          * true if client understands CRTC primary planes and cursor planes
447          * in the plane list
448          */
449         unsigned universal_planes:1;
450         /* true if client understands atomic properties */
451         unsigned atomic:1;
452
453         pid_t             pid;
454         uid_t             uid;
455         drm_magic_t       magic;
456         struct list_head lhead;
457         unsigned long lock_count;
458
459         struct kqinfo     dkq;
460
461         /** Mapping of mm object handles to object pointers. */
462         struct idr object_idr;
463         /** Lock for synchronization of access to object_idr. */
464         struct lock table_lock;
465
466         struct file *filp;
467         void *driver_priv;
468
469         struct drm_master *masterp;
470
471         /**
472          * fbs - List of framebuffers associated with this file.
473          *
474          * Protected by fbs_lock. Note that the fbs list holds a reference on
475          * the fb object to prevent it from untimely disappearing.
476          */
477         struct list_head fbs;
478         struct lock fbs_lock;
479
480         /** User-created blob properties; this retains a reference on the
481          *  property. */
482         struct list_head blobs;
483
484         wait_queue_head_t event_wait;
485         struct list_head pending_event_list;
486         struct list_head event_list;
487         int event_space;
488
489         struct lock event_read_lock;
490
491         struct drm_prime_file_private prime;
492
493 #ifdef __DragonFly__
494         struct drm_device *dev;
495         int               master;
496         unsigned long ioctl_count;
497 #endif
498 };
499
500 /**
501  * Lock data.
502  */
503 struct drm_lock_data {
504         struct drm_hw_lock *hw_lock;    /**< Hardware lock */
505         /** Private of lock holder's file (NULL=kernel) */
506         struct drm_file *file_priv;
507         wait_queue_head_t lock_queue;   /**< Queue of blocked processes */
508         unsigned long lock_time;        /**< Time of last lock in jiffies */
509 };
510
511 /**
512  * GEM specific mm private for tracking GEM objects
513  */
514 struct drm_gem_mm {
515         struct drm_vma_offset_manager vma_manager;
516         struct drm_mm offset_manager;   /**< Offset mgmt for buffer objects */
517         struct drm_open_hash offset_hash; /**< User token hash table for maps */
518         struct unrhdr *idxunr;
519 };
520
521 /**
522  * struct drm_master - drm master structure
523  *
524  * @refcount: Refcount for this master object.
525  * @minor: Link back to minor char device we are master for. Immutable.
526  * @unique: Unique identifier: e.g. busid. Protected by drm_global_mutex.
527  * @unique_len: Length of unique field. Protected by drm_global_mutex.
528  * @magic_map: Map of used authentication tokens. Protected by struct_mutex.
529  * @lock: DRI lock information.
530  * @driver_priv: Pointer to driver-private information.
531  */
532 struct drm_master {
533         struct kref refcount;           /* refcount for this master */
534         struct list_head head;          /**< each minor contains a list of masters */
535         struct drm_minor *minor;        /**< link back to minor we are a master for */
536         char *unique;                   /**< Unique identifier: e.g., busid */
537         int unique_len;                 /**< Length of unique field */
538         int unique_size;                /**< amount allocated */
539         int blocked;                    /**< Blocked due to VC switch? */
540         struct idr magic_map;
541         struct drm_lock_data lock;
542         void *driver_priv;
543 };
544
545 /* Size of ringbuffer for vblank timestamps. Just double-buffer
546  * in initial implementation.
547  */
548 #define DRM_VBLANKTIME_RBSIZE 2
549
550 /* Flags and return codes for get_vblank_timestamp() driver function. */
551 #define DRM_CALLED_FROM_VBLIRQ 1
552 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
553 #define DRM_VBLANKTIME_IN_VBLANK         (1 << 1)
554
555 /* get_scanout_position() return flags */
556 #define DRM_SCANOUTPOS_VALID        (1 << 0)
557 #define DRM_SCANOUTPOS_IN_VBLANK    (1 << 1)
558 #define DRM_SCANOUTPOS_ACCURATE     (1 << 2)
559
560 /**
561  * DRM driver structure. This structure represent the common code for
562  * a family of cards. There will one drm_device for each card present
563  * in this family
564  */
565 struct drm_driver {
566         int (*load) (struct drm_device *, unsigned long flags);
567         int (*use_msi) (struct drm_device *, unsigned long flags);
568         int (*firstopen) (struct drm_device *);
569         int (*open) (struct drm_device *, struct drm_file *);
570         void (*preclose) (struct drm_device *, struct drm_file *file_priv);
571         void (*postclose) (struct drm_device *, struct drm_file *);
572         void (*lastclose) (struct drm_device *);
573         int (*unload) (struct drm_device *);
574         void (*reclaim_buffers_locked) (struct drm_device *,
575                                         struct drm_file *file_priv);
576         int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
577         int (*dma_quiescent) (struct drm_device *);
578         int (*context_ctor) (struct drm_device *dev, int context);
579         int (*context_dtor) (struct drm_device *dev, int context);
580
581         /**
582          * get_vblank_counter - get raw hardware vblank counter
583          * @dev: DRM device
584          * @pipe: counter to fetch
585          *
586          * Driver callback for fetching a raw hardware vblank counter for @crtc.
587          * If a device doesn't have a hardware counter, the driver can simply
588          * return the value of drm_vblank_count. The DRM core will account for
589          * missed vblank events while interrupts where disabled based on system
590          * timestamps.
591          *
592          * Wraparound handling and loss of events due to modesetting is dealt
593          * with in the DRM core code.
594          *
595          * RETURNS
596          * Raw vblank counter value.
597          */
598         u32 (*get_vblank_counter) (struct drm_device *dev, unsigned int pipe);
599
600         /**
601          * enable_vblank - enable vblank interrupt events
602          * @dev: DRM device
603          * @pipe: which irq to enable
604          *
605          * Enable vblank interrupts for @crtc.  If the device doesn't have
606          * a hardware vblank counter, this routine should be a no-op, since
607          * interrupts will have to stay on to keep the count accurate.
608          *
609          * RETURNS
610          * Zero on success, appropriate errno if the given @crtc's vblank
611          * interrupt cannot be enabled.
612          */
613         int (*enable_vblank) (struct drm_device *dev, unsigned int pipe);
614
615         /**
616          * disable_vblank - disable vblank interrupt events
617          * @dev: DRM device
618          * @pipe: which irq to enable
619          *
620          * Disable vblank interrupts for @crtc.  If the device doesn't have
621          * a hardware vblank counter, this routine should be a no-op, since
622          * interrupts will have to stay on to keep the count accurate.
623          */
624         void (*disable_vblank) (struct drm_device *dev, unsigned int pipe);
625
626         /**
627          * Called by \c drm_device_is_agp.  Typically used to determine if a
628          * card is really attached to AGP or not.
629          *
630          * \param dev  DRM device handle
631          *
632          * \returns
633          * One of three values is returned depending on whether or not the
634          * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
635          * (return of 1), or may or may not be AGP (return of 2).
636          */
637         int (*device_is_agp) (struct drm_device *dev);
638
639         /**
640          * Called by vblank timestamping code.
641          *
642          * Return the current display scanout position from a crtc, and an
643          * optional accurate ktime_get timestamp of when position was measured.
644          *
645          * \param dev  DRM device.
646          * \param pipe Id of the crtc to query.
647          * \param flags Flags from the caller (DRM_CALLED_FROM_VBLIRQ or 0).
648          * \param *vpos Target location for current vertical scanout position.
649          * \param *hpos Target location for current horizontal scanout position.
650          * \param *stime Target location for timestamp taken immediately before
651          *               scanout position query. Can be NULL to skip timestamp.
652          * \param *etime Target location for timestamp taken immediately after
653          *               scanout position query. Can be NULL to skip timestamp.
654          *
655          * Returns vpos as a positive number while in active scanout area.
656          * Returns vpos as a negative number inside vblank, counting the number
657          * of scanlines to go until end of vblank, e.g., -1 means "one scanline
658          * until start of active scanout / end of vblank."
659          *
660          * \return Flags, or'ed together as follows:
661          *
662          * DRM_SCANOUTPOS_VALID = Query successful.
663          * DRM_SCANOUTPOS_INVBL = Inside vblank.
664          * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
665          * this flag means that returned position may be offset by a constant
666          * but unknown small number of scanlines wrt. real scanout position.
667          *
668          */
669         int (*get_scanout_position) (struct drm_device *dev, unsigned int pipe,
670                                      unsigned int flags, int *vpos, int *hpos,
671                                      ktime_t *stime, ktime_t *etime,
672                                      const struct drm_display_mode *mode);
673
674         /**
675          * Called by \c drm_get_last_vbltimestamp. Should return a precise
676          * timestamp when the most recent VBLANK interval ended or will end.
677          *
678          * Specifically, the timestamp in @vblank_time should correspond as
679          * closely as possible to the time when the first video scanline of
680          * the video frame after the end of VBLANK will start scanning out,
681          * the time immediately after end of the VBLANK interval. If the
682          * @crtc is currently inside VBLANK, this will be a time in the future.
683          * If the @crtc is currently scanning out a frame, this will be the
684          * past start time of the current scanout. This is meant to adhere
685          * to the OpenML OML_sync_control extension specification.
686          *
687          * \param dev dev DRM device handle.
688          * \param pipe crtc for which timestamp should be returned.
689          * \param *max_error Maximum allowable timestamp error in nanoseconds.
690          *                   Implementation should strive to provide timestamp
691          *                   with an error of at most *max_error nanoseconds.
692          *                   Returns true upper bound on error for timestamp.
693          * \param *vblank_time Target location for returned vblank timestamp.
694          * \param flags 0 = Defaults, no special treatment needed.
695          * \param       DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
696          *              irq handler. Some drivers need to apply some workarounds
697          *              for gpu-specific vblank irq quirks if flag is set.
698          *
699          * \returns
700          * Zero if timestamping isn't supported in current display mode or a
701          * negative number on failure. A positive status code on success,
702          * which describes how the vblank_time timestamp was computed.
703          */
704         int (*get_vblank_timestamp) (struct drm_device *dev, unsigned int pipe,
705                                      int *max_error,
706                                      struct timeval *vblank_time,
707                                      unsigned flags);
708
709         /* these have to be filled in */
710
711         irqreturn_t(*irq_handler) (int irq, void *arg);
712         void (*irq_preinstall) (struct drm_device *dev);
713         int (*irq_postinstall) (struct drm_device *dev);
714         void (*irq_uninstall) (struct drm_device *dev);
715
716         /**
717          * Driver-specific constructor for drm_gem_objects, to set up
718          * obj->driver_private.
719          *
720          * Returns 0 on success.
721          */
722         void (*gem_free_object) (struct drm_gem_object *obj);
723         int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
724         void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
725
726         int (*sysctl_init) (struct drm_device *dev,
727                     struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
728         void (*sysctl_cleanup) (struct drm_device *dev);
729
730         drm_pci_id_list_t *id_entry;    /* PCI ID, name, and chipset private */
731
732         /* dumb alloc support */
733         int (*dumb_create)(struct drm_file *file_priv,
734                            struct drm_device *dev,
735                            struct drm_mode_create_dumb *args);
736         int (*dumb_map_offset)(struct drm_file *file_priv,
737                                struct drm_device *dev, uint32_t handle,
738                                uint64_t *offset);
739         int (*dumb_destroy)(struct drm_file *file_priv,
740                             struct drm_device *dev,
741                             uint32_t handle);
742
743         /* Driver private ops for this object */
744         struct cdev_pager_ops *gem_pager_ops;
745
746         int major;
747         int minor;
748         int patchlevel;
749         const char *name;               /* Simple driver name              */
750         const char *desc;               /* Longer driver name              */
751         const char *date;               /* Date of last major changes.     */
752
753         u32 driver_features;
754         int dev_priv_size;
755         const struct drm_ioctl_desc *ioctls;
756         int num_ioctls;
757 };
758
759 /**
760  * Info file list entry. This structure represents a debugfs or proc file to
761  * be created by the drm core
762  */
763 struct drm_info_list {
764         const char *name; /** file name */
765         int (*show)(struct seq_file*, void*); /** show callback */
766         u32 driver_features; /**< Required driver features for this entry */
767         void *data;
768 };
769
770 /**
771  * debugfs node structure. This structure represents a debugfs file.
772  */
773 struct drm_info_node {
774         struct list_head list;
775         struct drm_minor *minor;
776         const struct drm_info_list *info_ent;
777         struct dentry *dent;
778 };
779
780 /**
781  * DRM minor structure. This structure represents a drm minor number.
782  */
783 struct drm_minor {
784         int index;                      /**< Minor device number */
785         int type;                       /**< Control or render */
786         struct device *kdev;            /**< Linux device */
787         struct drm_device *dev;
788
789         /* currently active master for this node. Protected by master_mutex */
790         struct drm_master *master;
791 };
792
793 struct drm_pending_vblank_event {
794         struct drm_pending_event base;
795         unsigned int pipe;
796         struct drm_event_vblank event;
797 };
798
799 struct drm_vblank_crtc {
800         struct drm_device *dev;         /* pointer to the drm_device */
801         wait_queue_head_t queue;        /**< VBLANK wait queue */
802         struct timer_list disable_timer;                /* delayed disable timer */
803
804         /* vblank counter, protected by dev->vblank_time_lock for writes */
805         u32 count;
806         /* vblank timestamps, protected by dev->vblank_time_lock for writes */
807         struct timeval time[DRM_VBLANKTIME_RBSIZE];
808
809         atomic_t refcount;              /* number of users of vblank interruptsper crtc */
810         u32 last;                       /* protected by dev->vbl_lock, used */
811                                         /* for wraparound handling */
812         u32 last_wait;                  /* Last vblank seqno waited per CRTC */
813         unsigned int inmodeset;         /* Display driver is setting mode */
814         unsigned int pipe;              /* crtc index */
815         int framedur_ns;                /* frame/field duration in ns */
816         int linedur_ns;                 /* line duration in ns */
817         int pixeldur_ns;                /* pixel duration in ns */
818         bool enabled;                   /* so we don't call enable more than
819                                            once per disable */
820 };
821
822 struct drm_sysctl_info {
823         struct sysctl_ctx_list ctx;
824         char   name[2];
825 };
826
827 /* Length for the array of resource pointers for drm_get_resource_*. */
828 #define DRM_MAX_PCI_RESOURCE    6
829
830 /**
831  * DRM device structure. This structure represent a complete card that
832  * may contain multiple heads.
833  */
834 struct drm_device {
835         drm_pci_id_list_t *id_entry;    /* PCI ID, name, and chipset private */
836
837         char              *unique;      /* Unique identifier: e.g., busid  */
838         int               unique_len;   /* Length of unique field          */
839         struct cdev       *devnode;     /* Device number for mknod         */
840         int               if_version;   /* Highest interface version set */
841
842         int               flags;        /* Flags to open(2)                */
843
844                                 /* Locks */
845         struct lwkt_serialize irq_lock; /* protects irq condition checks */
846         struct lock       dev_lock;     /* protects everything else */
847
848         /** \name Locks */
849         /*@{ */
850         struct lock struct_mutex;       /**< For others */
851         struct lock master_mutex;       /**< For drm_minor::master */
852         /*@} */
853
854         /** \name Usage Counters */
855         /*@{ */
856         int open_count;                 /**< Outstanding files open, protected by drm_global_mutex. */
857         struct spinlock buf_lock;       /**< For drm_device::buf_use and a few other things. */
858         int buf_use;                    /**< Buffers in use -- cannot alloc */
859         atomic_t buf_alloc;             /**< Buffer allocation in progress */
860         /*@} */
861
862
863         /** \name Performance counters */
864         /*@{ */
865         unsigned long     counters;
866         enum drm_stat_type      types[15];
867         atomic_t          counts[15];
868         /*@} */
869
870                                 /* Authentication */
871         struct idr magic_map;
872
873         struct lock filelist_mutex;
874         struct list_head filelist;
875
876         /** \name Memory management */
877         /*@{ */
878         struct list_head maplist;       /**< Linked list of regions */
879         int map_count;                  /**< Number of mappable regions */
880         struct drm_open_hash map_hash;  /**< User token hash table for maps */
881
882         /** \name Context handle management */
883         /*@{ */
884         struct list_head ctxlist;       /**< Linked list of context handles */
885         struct lock ctxlist_mutex;      /**< For ctxlist */
886
887         struct idr ctx_idr;
888
889         /*@} */
890
891         struct drm_lock_data lock;      /* Information on hardware lock    */
892
893         /** \name DMA support */
894         /*@{ */
895         struct drm_device_dma *dma;             /**< Optional pointer for DMA support */
896         /*@} */
897
898         /* Storage of resource pointers for drm_get_resource_* */
899         struct resource   *pcir[DRM_MAX_PCI_RESOURCE];
900         int               pcirid[DRM_MAX_PCI_RESOURCE];
901
902         int               pci_domain;
903         int               pci_bus;
904         int               pci_slot;
905         int               pci_func;
906
907         /** \name Context support */
908         /*@{ */
909
910         __volatile__ long context_flag; /**< Context swapping flag */
911         __volatile__ long interrupt_flag; /**< Interruption handler flag */
912         __volatile__ long dma_flag;     /**< DMA dispatch flag */
913         wait_queue_head_t context_wait; /**< Processes waiting on ctx switch */
914         int last_checked;               /**< Last context checked for DMA */
915         int last_context;               /**< Last current context */
916         unsigned long last_switch;      /**< jiffies at last context switch */
917         /*@} */
918
919         /** \name VBLANK IRQ support */
920         /*@{ */
921         int irq_enabled;                /**< True if irq handler is enabled */
922         int irq;                        /* Interrupt used by board */
923
924         /*
925          * If true, vblank interrupt will be disabled immediately when the
926          * refcount drops to zero, as opposed to via the vblank disable
927          * timer.
928          * This can be set to true it the hardware has a working vblank
929          * counter and the driver uses drm_vblank_on() and drm_vblank_off()
930          * appropriately.
931          */
932         bool vblank_disable_immediate;
933
934         /* array of size num_crtcs */
935         struct drm_vblank_crtc *vblank;
936
937         struct lock vblank_time_lock;    /**< Protects vblank count and time updates during vblank enable/disable */
938         struct lock vbl_lock;
939         struct timer_list vblank_disable_timer;
940
941         u32 max_vblank_count;           /**< size of vblank counter register */
942
943         /**
944          * List of events
945          */
946         struct list_head vblank_event_list;
947         struct lock event_lock;
948
949         /*@} */
950
951         struct sigio      *buf_sigio;   /* Processes waiting for SIGIO     */
952
953                                 /* Sysctl support */
954         struct drm_sysctl_info *sysctl;
955
956
957         struct drm_sg_mem *sg;  /**< Scatter gather memory */
958         unsigned int num_crtcs;                  /**< Number of CRTCs on this device */
959
960         unsigned long     *ctx_bitmap;
961         void              *dev_private;
962
963         void              *drm_ttm_bdev;
964
965         /*@} */
966
967         struct {
968                 int context;
969                 struct drm_hw_lock *lock;
970         } sigdata;
971
972         struct drm_agp_head *agp;       /**< AGP data */
973
974         struct device *dev;             /**< Device structure */
975         struct pci_dev *pdev;           /**< PCI device structure */
976
977         struct drm_driver *driver;
978         struct drm_local_map *agp_buffer_map;
979         unsigned int agp_buffer_token;
980         struct drm_minor *control;              /**< Control node for card */
981         struct drm_minor *primary;              /**< render type primary screen head */
982
983         struct drm_mode_config mode_config;     /**< Current mode config */
984
985         /** \name GEM information */
986         /*@{ */
987         struct lock object_name_lock;
988         struct idr object_name_idr;
989         /*@} */
990         void             *mm_private;
991
992         void *sysctl_private;
993         char busid_str[128];
994         int modesetting;
995
996         int switch_power_state;
997
998 #ifdef __DragonFly__
999         atomic_t unplugged; /* device has been unplugged or gone away */
1000 #endif  /* __DragonFly__ */
1001 };
1002
1003 #define DRM_SWITCH_POWER_ON 0
1004 #define DRM_SWITCH_POWER_OFF 1
1005 #define DRM_SWITCH_POWER_CHANGING 2
1006 #define DRM_SWITCH_POWER_DYNAMIC_OFF 3
1007
1008 static __inline__ int drm_core_check_feature(struct drm_device *dev,
1009                                              int feature)
1010 {
1011         return ((dev->driver->driver_features & feature) ? 1 : 0);
1012 }
1013
1014 static inline void drm_device_set_unplugged(struct drm_device *dev)
1015 {
1016         smp_wmb();
1017         atomic_set(&dev->unplugged, 1);
1018 }
1019
1020 static inline int drm_device_is_unplugged(struct drm_device *dev)
1021 {
1022         int ret = atomic_read(&dev->unplugged);
1023         smp_rmb();
1024         return ret;
1025 }
1026
1027 static inline bool drm_is_primary_client(const struct drm_file *file_priv)
1028 {
1029         return 0 /* file_priv->minor->type == DRM_MINOR_LEGACY */;
1030 }
1031
1032 /**
1033  * drm_is_master() - Check whether a DRM open-file is DRM-Master
1034  * @file: DRM open-file context
1035  *
1036  * This checks whether a DRM open-file context is owner of the master context
1037  * attached to it. If a file owns a master context, it's called DRM-Master.
1038  * Per DRM device, only one such file can be DRM-Master at a time.
1039  *
1040  * Returns: True if the file is DRM-Master, otherwise false.
1041  */
1042 static inline bool drm_is_master(const struct drm_file *file)
1043 {
1044 #if 0
1045         return file->master && file->master == file->minor->master;
1046 #else
1047         return true;
1048 #endif
1049 }
1050
1051 /******************************************************************/
1052 /** \name Internal function definitions */
1053 /*@{*/
1054
1055                                 /* Driver support (drm_drv.h) */
1056 extern int drm_ioctl_permit(u32 flags, struct drm_file *file_priv);
1057 int     drm_probe(device_t kdev, drm_pci_id_list_t *idlist);
1058 int     drm_attach(device_t kdev, drm_pci_id_list_t *idlist);
1059 int     drm_create_cdevs(device_t kdev);
1060 d_ioctl_t drm_ioctl;
1061 extern bool drm_ioctl_flags(unsigned int nr, unsigned int *flags);
1062
1063                                 /* Device support (drm_fops.h) */
1064 d_open_t drm_open;
1065 d_close_t drm_close;
1066 d_read_t drm_read;
1067 d_kqfilter_t drm_kqfilter;
1068 int drm_release(device_t kdev);
1069
1070 d_mmap_t drm_mmap;
1071 d_mmap_single_t drm_mmap_single;
1072
1073 void drm_cdevpriv_dtor(void *cd);
1074
1075 int drm_add_busid_modesetting(struct drm_device *dev,
1076     struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
1077
1078 /* File operations helpers (drm_fops.c) */
1079 extern int              drm_open_helper(struct cdev *kdev, int flags, int fmt,
1080                                          DRM_STRUCTPROC *p,
1081                                         struct drm_device *dev,
1082                                         struct file *fp);
1083 int drm_event_reserve_init_locked(struct drm_device *dev,
1084                                   struct drm_file *file_priv,
1085                                   struct drm_pending_event *p,
1086                                   struct drm_event *e);
1087 int drm_event_reserve_init(struct drm_device *dev,
1088                            struct drm_file *file_priv,
1089                            struct drm_pending_event *p,
1090                            struct drm_event *e);
1091 void drm_event_cancel_free(struct drm_device *dev,
1092                            struct drm_pending_event *p);
1093 void drm_send_event_locked(struct drm_device *dev, struct drm_pending_event *e);
1094 void drm_send_event(struct drm_device *dev, struct drm_pending_event *e);
1095
1096 /* Misc. IOCTL support (drm_ioctl.c) */
1097 int drm_noop(struct drm_device *dev, void *data,
1098              struct drm_file *file_priv);
1099 int drm_invalid_op(struct drm_device *dev, void *data,
1100                    struct drm_file *file_priv);
1101
1102 /* Cache management (drm_cache.c) */
1103 void drm_clflush_pages(struct page *pages[], unsigned long num_pages);
1104 void drm_clflush_sg(struct sg_table *st);
1105 void drm_clflush_virt_range(void *addr, unsigned long length);
1106
1107 /*
1108  * These are exported to drivers so that they can implement fencing using
1109  * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
1110  */
1111
1112 unsigned long drm_get_resource_start(struct drm_device *dev,
1113                                      unsigned int resource);
1114 unsigned long drm_get_resource_len(struct drm_device *dev,
1115                                    unsigned int resource);
1116
1117                                 /* IRQ support (drm_irq.h) */
1118 extern int drm_irq_install(struct drm_device *dev, int irq);
1119 extern int drm_irq_uninstall(struct drm_device *dev);
1120
1121 extern int drm_vblank_init(struct drm_device *dev, unsigned int num_crtcs);
1122 extern int drm_wait_vblank(struct drm_device *dev, void *data,
1123                            struct drm_file *filp);
1124 extern u32 drm_vblank_count(struct drm_device *dev, unsigned int pipe);
1125 extern u32 drm_crtc_vblank_count(struct drm_crtc *crtc);
1126 extern u32 drm_vblank_count_and_time(struct drm_device *dev, unsigned int pipe,
1127                                      struct timeval *vblanktime);
1128 extern u32 drm_crtc_vblank_count_and_time(struct drm_crtc *crtc,
1129                                           struct timeval *vblanktime);
1130 extern void drm_send_vblank_event(struct drm_device *dev, unsigned int pipe,
1131                                   struct drm_pending_vblank_event *e);
1132 extern void drm_crtc_send_vblank_event(struct drm_crtc *crtc,
1133                                        struct drm_pending_vblank_event *e);
1134 extern void drm_arm_vblank_event(struct drm_device *dev, unsigned int pipe,
1135                                  struct drm_pending_vblank_event *e);
1136 extern void drm_crtc_arm_vblank_event(struct drm_crtc *crtc,
1137                                       struct drm_pending_vblank_event *e);
1138 extern bool drm_handle_vblank(struct drm_device *dev, unsigned int pipe);
1139 extern bool drm_crtc_handle_vblank(struct drm_crtc *crtc);
1140 extern int drm_vblank_get(struct drm_device *dev, unsigned int pipe);
1141 extern void drm_vblank_put(struct drm_device *dev, unsigned int pipe);
1142 extern int drm_crtc_vblank_get(struct drm_crtc *crtc);
1143 extern void drm_crtc_vblank_put(struct drm_crtc *crtc);
1144 extern void drm_wait_one_vblank(struct drm_device *dev, unsigned int pipe);
1145 extern void drm_crtc_wait_one_vblank(struct drm_crtc *crtc);
1146 extern void drm_vblank_off(struct drm_device *dev, unsigned int pipe);
1147 extern void drm_vblank_on(struct drm_device *dev, unsigned int pipe);
1148 extern void drm_crtc_vblank_off(struct drm_crtc *crtc);
1149 extern void drm_crtc_vblank_reset(struct drm_crtc *crtc);
1150 extern void drm_crtc_vblank_on(struct drm_crtc *crtc);
1151 extern void drm_vblank_cleanup(struct drm_device *dev);
1152 extern u32 drm_vblank_no_hw_counter(struct drm_device *dev, unsigned int pipe);
1153
1154 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
1155                                                  unsigned int pipe, int *max_error,
1156                                                  struct timeval *vblank_time,
1157                                                  unsigned flags,
1158                                                  const struct drm_display_mode *mode);
1159 extern void drm_calc_timestamping_constants(struct drm_crtc *crtc,
1160                                             const struct drm_display_mode *mode);
1161
1162 /**
1163  * drm_crtc_vblank_waitqueue - get vblank waitqueue for the CRTC
1164  * @crtc: which CRTC's vblank waitqueue to retrieve
1165  *
1166  * This function returns a pointer to the vblank waitqueue for the CRTC.
1167  * Drivers can use this to implement vblank waits using wait_event() & co.
1168  */
1169 static inline wait_queue_head_t *drm_crtc_vblank_waitqueue(struct drm_crtc *crtc)
1170 {
1171         return &crtc->dev->vblank[drm_crtc_index(crtc)].queue;
1172 }
1173
1174 /* Modesetting support */
1175 extern void drm_vblank_pre_modeset(struct drm_device *dev, unsigned int pipe);
1176 extern void drm_vblank_post_modeset(struct drm_device *dev, unsigned int pipe);
1177
1178                                 /* Stub support (drm_stub.h) */
1179
1180 extern void drm_put_dev(struct drm_device *dev);
1181 extern void drm_unplug_dev(struct drm_device *dev);
1182 extern unsigned int drm_debug;
1183 extern bool drm_atomic;
1184
1185 /* consistent PCI memory functions (drm_pci.c) */
1186 extern struct drm_dma_handle *drm_pci_alloc(struct drm_device *dev, size_t size,
1187                                             size_t align);
1188 extern void drm_pci_free(struct drm_device *dev, struct drm_dma_handle * dmah);
1189
1190                                /* sysfs support (drm_sysfs.c) */
1191 extern void drm_sysfs_hotplug_event(struct drm_device *dev);
1192
1193 /* sysctl support (drm_sysctl.h) */
1194 extern int drm_sysctl_init(struct drm_device *dev);
1195 extern int drm_sysctl_cleanup(struct drm_device *dev);
1196
1197 /* XXX: These are here only because of drm_sysctl.c */
1198 extern int drm_vblank_offdelay;
1199 extern unsigned int drm_timestamp_precision;
1200
1201 int drm_gem_mmap_single(struct drm_device *dev, vm_ooffset_t *offset,
1202     vm_size_t size, struct vm_object **obj_res, int nprot);
1203
1204 struct ttm_bo_device;
1205 int ttm_bo_mmap_single(struct ttm_bo_device *bdev, vm_ooffset_t *offset,
1206     vm_size_t size, struct vm_object **obj_res, int nprot);
1207 struct ttm_buffer_object;
1208 void ttm_bo_release_mmap(struct ttm_buffer_object *bo);
1209
1210 /* simplified version of kvasnprintf() for drm needs. */
1211 char *drm_vasprintf(int flags, const char *format, __va_list ap) __printflike(2, 0);
1212 char *drm_asprintf(int flags, const char *format, ...) __printflike(2, 3);
1213
1214 /* XXX glue logic, should be done in drm_pci_init(), pending drm update */
1215 void drm_init_pdev(device_t dev, struct pci_dev **pdev);
1216 void drm_fini_pdev(struct pci_dev **pdev);
1217 void drm_print_pdev(struct pci_dev *pdev);
1218
1219 /* Inline drm_free() helper for area kfree() */
1220 static __inline__ void
1221 drm_free(void *pt, struct malloc_type *area)
1222 {
1223         /* kfree is special!!! */
1224         if (pt != NULL)
1225                 (kfree)(pt, area);
1226 }
1227
1228 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
1229                                  struct device *parent);
1230 void drm_dev_ref(struct drm_device *dev);
1231 void drm_dev_unref(struct drm_device *dev);
1232 int drm_dev_register(struct drm_device *dev, unsigned long flags);
1233 void drm_dev_unregister(struct drm_device *dev);
1234 int drm_dev_set_unique(struct drm_device *dev, const char *fmt, ...);
1235
1236
1237 /* PCI section */
1238 static __inline__ int drm_pci_device_is_agp(struct drm_device *dev)
1239 {
1240         if (dev->driver->device_is_agp != NULL) {
1241                 int err = (*dev->driver->device_is_agp) (dev);
1242
1243                 if (err != 2) {
1244                         return err;
1245                 }
1246         }
1247
1248         return (pci_find_extcap(dev->pdev->dev.bsddev, PCIY_AGP, NULL) == 0);
1249 }
1250
1251 #define DRM_PCIE_SPEED_25 1
1252 #define DRM_PCIE_SPEED_50 2
1253 #define DRM_PCIE_SPEED_80 4
1254
1255 extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
1256
1257 /* XXX bad */
1258 #define drm_can_sleep() (HZ & 1)
1259
1260 #endif /* __KERNEL__ */
1261
1262 /* helper for handling conditionals in various for_each macros */
1263 #define for_each_if(condition) if (!(condition)) {} else
1264
1265 #endif /* _DRM_P_H_ */