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