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