Subversion Repositories Kolibri OS

Rev

Rev 6102 | Rev 6659 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

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