Subversion Repositories Kolibri OS

Rev

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