3 * File operations for DRM
5 * \author Rickard E. (Rik) Faith <faith@valinux.com>
6 * \author Daryll Strauss <daryll@valinux.com>
7 * \author Gareth Hughes <gareth@valinux.com>
11 * Created: Mon Jan 4 08:58:31 1999 by faith@valinux.com
13 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
14 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
15 * All Rights Reserved.
17 * Permission is hereby granted, free of charge, to any person obtaining a
18 * copy of this software and associated documentation files (the "Software"),
19 * to deal in the Software without restriction, including without limitation
20 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
21 * and/or sell copies of the Software, and to permit persons to whom the
22 * Software is furnished to do so, subject to the following conditions:
24 * The above copyright notice and this permission notice (including the next
25 * paragraph) shall be included in all copies or substantial portions of the
28 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
29 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
30 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
31 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
32 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
33 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
34 * OTHER DEALINGS IN THE SOFTWARE.
38 #include <linux/poll.h>
39 #include <linux/slab.h>
40 #include <linux/module.h>
42 /* from BKL pushdown: note that nothing else serializes idr_find() */
43 DEFINE_MUTEX(drm_global_mutex
);
44 EXPORT_SYMBOL(drm_global_mutex
);
46 static int drm_open_helper(struct inode
*inode
, struct file
*filp
,
47 struct drm_device
* dev
);
49 static int drm_setup(struct drm_device
* dev
)
53 if (dev
->driver
->firstopen
&&
54 !drm_core_check_feature(dev
, DRIVER_MODESET
)) {
55 ret
= dev
->driver
->firstopen(dev
);
60 ret
= drm_legacy_dma_setup(dev
);
72 * \param inode device inode
73 * \param filp file pointer.
74 * \return zero on success or a negative number on failure.
76 * Searches the DRM device with the same minor number, calls open_helper(), and
77 * increments the device open count. If the open count was previous at zero,
78 * i.e., it's the first that the device is open, then calls setup().
80 int drm_open(struct inode
*inode
, struct file
*filp
)
82 struct drm_device
*dev
= NULL
;
83 int minor_id
= iminor(inode
);
84 struct drm_minor
*minor
;
87 struct address_space
*old_mapping
;
88 struct address_space
*old_imapping
;
90 minor
= idr_find(&drm_minors_idr
, minor_id
);
94 if (!(dev
= minor
->dev
))
97 if (drm_device_is_unplugged(dev
))
100 if (!dev
->open_count
++)
102 mutex_lock(&dev
->struct_mutex
);
103 old_imapping
= inode
->i_mapping
;
104 old_mapping
= dev
->dev_mapping
;
105 if (old_mapping
== NULL
)
106 dev
->dev_mapping
= &inode
->i_data
;
107 /* ihold ensures nobody can remove inode with our i_data */
108 ihold(container_of(dev
->dev_mapping
, struct inode
, i_data
));
109 inode
->i_mapping
= dev
->dev_mapping
;
110 filp
->f_mapping
= dev
->dev_mapping
;
111 mutex_unlock(&dev
->struct_mutex
);
113 retcode
= drm_open_helper(inode
, filp
, dev
);
116 atomic_inc(&dev
->counts
[_DRM_STAT_OPENS
]);
118 retcode
= drm_setup(dev
);
125 mutex_lock(&dev
->struct_mutex
);
126 filp
->f_mapping
= old_imapping
;
127 inode
->i_mapping
= old_imapping
;
128 iput(container_of(dev
->dev_mapping
, struct inode
, i_data
));
129 dev
->dev_mapping
= old_mapping
;
130 mutex_unlock(&dev
->struct_mutex
);
134 EXPORT_SYMBOL(drm_open
);
137 * File \c open operation.
139 * \param inode device inode.
140 * \param filp file pointer.
142 * Puts the dev->fops corresponding to the device minor number into
143 * \p filp, call the \c open method, and restore the file operations.
145 int drm_stub_open(struct inode
*inode
, struct file
*filp
)
147 struct drm_device
*dev
= NULL
;
148 struct drm_minor
*minor
;
149 int minor_id
= iminor(inode
);
151 const struct file_operations
*old_fops
;
155 mutex_lock(&drm_global_mutex
);
156 minor
= idr_find(&drm_minors_idr
, minor_id
);
160 if (!(dev
= minor
->dev
))
163 if (drm_device_is_unplugged(dev
))
166 old_fops
= filp
->f_op
;
167 filp
->f_op
= fops_get(dev
->driver
->fops
);
168 if (filp
->f_op
== NULL
) {
169 filp
->f_op
= old_fops
;
172 if (filp
->f_op
->open
&& (err
= filp
->f_op
->open(inode
, filp
))) {
173 fops_put(filp
->f_op
);
174 filp
->f_op
= fops_get(old_fops
);
179 mutex_unlock(&drm_global_mutex
);
184 * Check whether DRI will run on this CPU.
186 * \return non-zero if the DRI will run on this CPU, or zero otherwise.
188 static int drm_cpu_valid(void)
190 #if defined(__i386__)
191 if (boot_cpu_data
.x86
== 3)
192 return 0; /* No cmpxchg on a 386 */
194 #if defined(__sparc__) && !defined(__sparc_v9__)
195 return 0; /* No cmpxchg before v9 sparc. */
201 * Called whenever a process opens /dev/drm.
203 * \param inode device inode.
204 * \param filp file pointer.
206 * \return zero on success or a negative number on failure.
208 * Creates and initializes a drm_file structure for the file private data in \p
209 * filp and add it into the double linked list in \p dev.
211 static int drm_open_helper(struct inode
*inode
, struct file
*filp
,
212 struct drm_device
* dev
)
214 int minor_id
= iminor(inode
);
215 struct drm_file
*priv
;
218 if (filp
->f_flags
& O_EXCL
)
219 return -EBUSY
; /* No exclusive opens */
220 if (!drm_cpu_valid())
222 if (dev
->switch_power_state
!= DRM_SWITCH_POWER_ON
&& dev
->switch_power_state
!= DRM_SWITCH_POWER_DYNAMIC_OFF
)
225 DRM_DEBUG("pid = %d, minor = %d\n", task_pid_nr(current
), minor_id
);
227 priv
= kzalloc(sizeof(*priv
), GFP_KERNEL
);
231 filp
->private_data
= priv
;
233 priv
->uid
= current_euid();
234 priv
->pid
= get_pid(task_pid(current
));
235 priv
->minor
= idr_find(&drm_minors_idr
, minor_id
);
241 priv
->ioctl_count
= 0;
242 /* for compatibility root is always authenticated */
243 priv
->authenticated
= capable(CAP_SYS_ADMIN
);
244 priv
->lock_count
= 0;
246 INIT_LIST_HEAD(&priv
->lhead
);
247 INIT_LIST_HEAD(&priv
->fbs
);
248 mutex_init(&priv
->fbs_lock
);
249 INIT_LIST_HEAD(&priv
->event_list
);
250 init_waitqueue_head(&priv
->event_wait
);
251 priv
->event_space
= 4096; /* set aside 4k for event buffer */
253 if (dev
->driver
->driver_features
& DRIVER_GEM
)
254 drm_gem_open(dev
, priv
);
256 if (drm_core_check_feature(dev
, DRIVER_PRIME
))
257 drm_prime_init_file_private(&priv
->prime
);
259 if (dev
->driver
->open
) {
260 ret
= dev
->driver
->open(dev
, priv
);
262 goto out_prime_destroy
;
266 /* if there is no current master make this fd it */
267 mutex_lock(&dev
->struct_mutex
);
268 if (!priv
->minor
->master
) {
269 /* create a new master */
270 priv
->minor
->master
= drm_master_create(priv
->minor
);
271 if (!priv
->minor
->master
) {
272 mutex_unlock(&dev
->struct_mutex
);
278 /* take another reference for the copy in the local file priv */
279 priv
->master
= drm_master_get(priv
->minor
->master
);
281 priv
->authenticated
= 1;
283 mutex_unlock(&dev
->struct_mutex
);
284 if (dev
->driver
->master_create
) {
285 ret
= dev
->driver
->master_create(dev
, priv
->master
);
287 mutex_lock(&dev
->struct_mutex
);
288 /* drop both references if this fails */
289 drm_master_put(&priv
->minor
->master
);
290 drm_master_put(&priv
->master
);
291 mutex_unlock(&dev
->struct_mutex
);
295 mutex_lock(&dev
->struct_mutex
);
296 if (dev
->driver
->master_set
) {
297 ret
= dev
->driver
->master_set(dev
, priv
, true);
299 /* drop both references if this fails */
300 drm_master_put(&priv
->minor
->master
);
301 drm_master_put(&priv
->master
);
302 mutex_unlock(&dev
->struct_mutex
);
306 mutex_unlock(&dev
->struct_mutex
);
308 /* get a reference to the master */
309 priv
->master
= drm_master_get(priv
->minor
->master
);
310 mutex_unlock(&dev
->struct_mutex
);
313 mutex_lock(&dev
->struct_mutex
);
314 list_add(&priv
->lhead
, &dev
->filelist
);
315 mutex_unlock(&dev
->struct_mutex
);
322 struct pci_dev
*pci_dev
;
323 pci_dev
= pci_get_class(PCI_CLASS_DISPLAY_VGA
<< 8, NULL
);
325 dev
->hose
= pci_dev
->sysdata
;
326 pci_dev_put(pci_dev
);
329 struct pci_bus
*b
= pci_bus_b(pci_root_buses
.next
);
331 dev
->hose
= b
->sysdata
;
339 if (dev
->driver
->postclose
)
340 dev
->driver
->postclose(dev
, priv
);
342 if (drm_core_check_feature(dev
, DRIVER_PRIME
))
343 drm_prime_destroy_file_private(&priv
->prime
);
344 if (dev
->driver
->driver_features
& DRIVER_GEM
)
345 drm_gem_release(dev
, priv
);
349 filp
->private_data
= NULL
;
353 static void drm_master_release(struct drm_device
*dev
, struct file
*filp
)
355 struct drm_file
*file_priv
= filp
->private_data
;
357 if (drm_i_have_hw_lock(dev
, file_priv
)) {
358 DRM_DEBUG("File %p released, freeing lock for context %d\n",
359 filp
, _DRM_LOCKING_CONTEXT(file_priv
->master
->lock
.hw_lock
->lock
));
360 drm_lock_free(&file_priv
->master
->lock
,
361 _DRM_LOCKING_CONTEXT(file_priv
->master
->lock
.hw_lock
->lock
));
365 static void drm_events_release(struct drm_file
*file_priv
)
367 struct drm_device
*dev
= file_priv
->minor
->dev
;
368 struct drm_pending_event
*e
, *et
;
369 struct drm_pending_vblank_event
*v
, *vt
;
372 spin_lock_irqsave(&dev
->event_lock
, flags
);
374 /* Remove pending flips */
375 list_for_each_entry_safe(v
, vt
, &dev
->vblank_event_list
, base
.link
)
376 if (v
->base
.file_priv
== file_priv
) {
377 list_del(&v
->base
.link
);
378 drm_vblank_put(dev
, v
->pipe
);
379 v
->base
.destroy(&v
->base
);
382 /* Remove unconsumed events */
383 list_for_each_entry_safe(e
, et
, &file_priv
->event_list
, link
)
386 spin_unlock_irqrestore(&dev
->event_lock
, flags
);
392 * \param inode device inode
393 * \param file_priv DRM file private.
394 * \return zero on success or a negative number on failure.
396 * If the hardware lock is held then free it, and take it again for the kernel
397 * context since it's necessary to reclaim buffers. Unlink the file private
398 * data from its list and free it. Decreases the open count and if it reaches
399 * zero calls drm_lastclose().
401 int drm_release(struct inode
*inode
, struct file
*filp
)
403 struct drm_file
*file_priv
= filp
->private_data
;
404 struct drm_device
*dev
= file_priv
->minor
->dev
;
407 mutex_lock(&drm_global_mutex
);
409 DRM_DEBUG("open_count = %d\n", dev
->open_count
);
411 if (dev
->driver
->preclose
)
412 dev
->driver
->preclose(dev
, file_priv
);
414 /* ========================================================
415 * Begin inline drm_release
418 DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
419 task_pid_nr(current
),
420 (long)old_encode_dev(file_priv
->minor
->device
),
423 /* Release any auth tokens that might point to this file_priv,
424 (do that under the drm_global_mutex) */
425 if (file_priv
->magic
)
426 (void) drm_remove_magic(file_priv
->master
, file_priv
->magic
);
428 /* if the master has gone away we can't do anything with the lock */
429 if (file_priv
->minor
->master
)
430 drm_master_release(dev
, filp
);
432 if (drm_core_check_feature(dev
, DRIVER_HAVE_DMA
))
433 drm_core_reclaim_buffers(dev
, file_priv
);
435 drm_events_release(file_priv
);
437 if (dev
->driver
->driver_features
& DRIVER_MODESET
)
438 drm_fb_release(file_priv
);
440 if (dev
->driver
->driver_features
& DRIVER_GEM
)
441 drm_gem_release(dev
, file_priv
);
443 drm_legacy_ctxbitmap_release(dev
, file_priv
);
445 mutex_lock(&dev
->struct_mutex
);
447 if (file_priv
->is_master
) {
448 struct drm_master
*master
= file_priv
->master
;
449 struct drm_file
*temp
;
450 list_for_each_entry(temp
, &dev
->filelist
, lhead
) {
451 if ((temp
->master
== file_priv
->master
) &&
453 temp
->authenticated
= 0;
457 * Since the master is disappearing, so is the
458 * possibility to lock.
461 if (master
->lock
.hw_lock
) {
462 if (dev
->sigdata
.lock
== master
->lock
.hw_lock
)
463 dev
->sigdata
.lock
= NULL
;
464 master
->lock
.hw_lock
= NULL
;
465 master
->lock
.file_priv
= NULL
;
466 wake_up_interruptible_all(&master
->lock
.lock_queue
);
469 if (file_priv
->minor
->master
== file_priv
->master
) {
470 /* drop the reference held my the minor */
471 if (dev
->driver
->master_drop
)
472 dev
->driver
->master_drop(dev
, file_priv
, true);
473 drm_master_put(&file_priv
->minor
->master
);
477 BUG_ON(dev
->dev_mapping
== NULL
);
478 iput(container_of(dev
->dev_mapping
, struct inode
, i_data
));
480 /* drop the reference held my the file priv */
481 drm_master_put(&file_priv
->master
);
482 file_priv
->is_master
= 0;
483 list_del(&file_priv
->lhead
);
484 mutex_unlock(&dev
->struct_mutex
);
486 if (dev
->driver
->postclose
)
487 dev
->driver
->postclose(dev
, file_priv
);
490 if (drm_core_check_feature(dev
, DRIVER_PRIME
))
491 drm_prime_destroy_file_private(&file_priv
->prime
);
493 put_pid(file_priv
->pid
);
496 /* ========================================================
497 * End inline drm_release
500 atomic_inc(&dev
->counts
[_DRM_STAT_CLOSES
]);
501 if (!--dev
->open_count
) {
502 if (atomic_read(&dev
->ioctl_count
)) {
503 DRM_ERROR("Device busy: %d\n",
504 atomic_read(&dev
->ioctl_count
));
507 retcode
= drm_lastclose(dev
);
508 if (drm_device_is_unplugged(dev
))
511 mutex_unlock(&drm_global_mutex
);
515 EXPORT_SYMBOL(drm_release
);
518 drm_dequeue_event(struct drm_file
*file_priv
,
519 size_t total
, size_t max
, struct drm_pending_event
**out
)
521 struct drm_device
*dev
= file_priv
->minor
->dev
;
522 struct drm_pending_event
*e
;
526 spin_lock_irqsave(&dev
->event_lock
, flags
);
529 if (list_empty(&file_priv
->event_list
))
531 e
= list_first_entry(&file_priv
->event_list
,
532 struct drm_pending_event
, link
);
533 if (e
->event
->length
+ total
> max
)
536 file_priv
->event_space
+= e
->event
->length
;
542 spin_unlock_irqrestore(&dev
->event_lock
, flags
);
546 ssize_t
drm_read(struct file
*filp
, char __user
*buffer
,
547 size_t count
, loff_t
*offset
)
549 struct drm_file
*file_priv
= filp
->private_data
;
550 struct drm_pending_event
*e
;
554 ret
= wait_event_interruptible(file_priv
->event_wait
,
555 !list_empty(&file_priv
->event_list
));
560 while (drm_dequeue_event(file_priv
, total
, count
, &e
)) {
561 if (copy_to_user(buffer
+ total
,
562 e
->event
, e
->event
->length
)) {
567 total
+= e
->event
->length
;
573 EXPORT_SYMBOL(drm_read
);
575 unsigned int drm_poll(struct file
*filp
, struct poll_table_struct
*wait
)
577 struct drm_file
*file_priv
= filp
->private_data
;
578 unsigned int mask
= 0;
580 poll_wait(filp
, &file_priv
->event_wait
, wait
);
582 if (!list_empty(&file_priv
->event_list
))
583 mask
|= POLLIN
| POLLRDNORM
;
587 EXPORT_SYMBOL(drm_poll
);