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 */
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_minor
*minor
);
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
;
83 struct drm_minor
*minor
;
86 struct address_space
*old_mapping
;
87 struct address_space
*old_imapping
;
89 minor
= drm_minor_acquire(iminor(inode
));
91 return PTR_ERR(minor
);
94 if (!dev
->open_count
++)
96 mutex_lock(&dev
->struct_mutex
);
97 old_imapping
= inode
->i_mapping
;
98 old_mapping
= dev
->dev_mapping
;
99 if (old_mapping
== NULL
)
100 dev
->dev_mapping
= &inode
->i_data
;
101 /* ihold ensures nobody can remove inode with our i_data */
102 ihold(container_of(dev
->dev_mapping
, struct inode
, i_data
));
103 inode
->i_mapping
= dev
->dev_mapping
;
104 filp
->f_mapping
= dev
->dev_mapping
;
105 mutex_unlock(&dev
->struct_mutex
);
107 retcode
= drm_open_helper(inode
, filp
, minor
);
111 retcode
= drm_setup(dev
);
118 mutex_lock(&dev
->struct_mutex
);
119 filp
->f_mapping
= old_imapping
;
120 inode
->i_mapping
= old_imapping
;
121 iput(container_of(dev
->dev_mapping
, struct inode
, i_data
));
122 dev
->dev_mapping
= old_mapping
;
123 mutex_unlock(&dev
->struct_mutex
);
125 drm_minor_release(minor
);
128 EXPORT_SYMBOL(drm_open
);
131 * File \c open operation.
133 * \param inode device inode.
134 * \param filp file pointer.
136 * Puts the dev->fops corresponding to the device minor number into
137 * \p filp, call the \c open method, and restore the file operations.
139 int drm_stub_open(struct inode
*inode
, struct file
*filp
)
141 struct drm_device
*dev
;
142 struct drm_minor
*minor
;
144 const struct file_operations
*new_fops
;
148 mutex_lock(&drm_global_mutex
);
149 minor
= drm_minor_acquire(iminor(inode
));
154 new_fops
= fops_get(dev
->driver
->fops
);
158 replace_fops(filp
, new_fops
);
159 if (filp
->f_op
->open
)
160 err
= filp
->f_op
->open(inode
, filp
);
163 drm_minor_release(minor
);
165 mutex_unlock(&drm_global_mutex
);
170 * Check whether DRI will run on this CPU.
172 * \return non-zero if the DRI will run on this CPU, or zero otherwise.
174 static int drm_cpu_valid(void)
176 #if defined(__i386__)
177 if (boot_cpu_data
.x86
== 3)
178 return 0; /* No cmpxchg on a 386 */
180 #if defined(__sparc__) && !defined(__sparc_v9__)
181 return 0; /* No cmpxchg before v9 sparc. */
187 * Called whenever a process opens /dev/drm.
189 * \param inode device inode.
190 * \param filp file pointer.
191 * \param minor acquired minor-object.
192 * \return zero on success or a negative number on failure.
194 * Creates and initializes a drm_file structure for the file private data in \p
195 * filp and add it into the double linked list in \p dev.
197 static int drm_open_helper(struct inode
*inode
, struct file
*filp
,
198 struct drm_minor
*minor
)
200 struct drm_device
*dev
= minor
->dev
;
201 struct drm_file
*priv
;
204 if (filp
->f_flags
& O_EXCL
)
205 return -EBUSY
; /* No exclusive opens */
206 if (!drm_cpu_valid())
208 if (dev
->switch_power_state
!= DRM_SWITCH_POWER_ON
&& dev
->switch_power_state
!= DRM_SWITCH_POWER_DYNAMIC_OFF
)
211 DRM_DEBUG("pid = %d, minor = %d\n", task_pid_nr(current
), minor
->index
);
213 priv
= kzalloc(sizeof(*priv
), GFP_KERNEL
);
217 filp
->private_data
= priv
;
219 priv
->uid
= current_euid();
220 priv
->pid
= get_pid(task_pid(current
));
223 /* for compatibility root is always authenticated */
224 priv
->always_authenticated
= capable(CAP_SYS_ADMIN
);
225 priv
->authenticated
= priv
->always_authenticated
;
226 priv
->lock_count
= 0;
228 INIT_LIST_HEAD(&priv
->lhead
);
229 INIT_LIST_HEAD(&priv
->fbs
);
230 mutex_init(&priv
->fbs_lock
);
231 INIT_LIST_HEAD(&priv
->event_list
);
232 init_waitqueue_head(&priv
->event_wait
);
233 priv
->event_space
= 4096; /* set aside 4k for event buffer */
235 if (dev
->driver
->driver_features
& DRIVER_GEM
)
236 drm_gem_open(dev
, priv
);
238 if (drm_core_check_feature(dev
, DRIVER_PRIME
))
239 drm_prime_init_file_private(&priv
->prime
);
241 if (dev
->driver
->open
) {
242 ret
= dev
->driver
->open(dev
, priv
);
244 goto out_prime_destroy
;
247 /* if there is no current master make this fd it, but do not create
248 * any master object for render clients */
249 mutex_lock(&dev
->struct_mutex
);
250 if (!priv
->minor
->master
&& !drm_is_render_client(priv
)) {
251 /* create a new master */
252 priv
->minor
->master
= drm_master_create(priv
->minor
);
253 if (!priv
->minor
->master
) {
254 mutex_unlock(&dev
->struct_mutex
);
260 /* take another reference for the copy in the local file priv */
261 priv
->master
= drm_master_get(priv
->minor
->master
);
263 priv
->authenticated
= 1;
265 mutex_unlock(&dev
->struct_mutex
);
266 if (dev
->driver
->master_create
) {
267 ret
= dev
->driver
->master_create(dev
, priv
->master
);
269 mutex_lock(&dev
->struct_mutex
);
270 /* drop both references if this fails */
271 drm_master_put(&priv
->minor
->master
);
272 drm_master_put(&priv
->master
);
273 mutex_unlock(&dev
->struct_mutex
);
277 mutex_lock(&dev
->struct_mutex
);
278 if (dev
->driver
->master_set
) {
279 ret
= dev
->driver
->master_set(dev
, priv
, true);
281 /* drop both references if this fails */
282 drm_master_put(&priv
->minor
->master
);
283 drm_master_put(&priv
->master
);
284 mutex_unlock(&dev
->struct_mutex
);
288 } else if (!drm_is_render_client(priv
)) {
289 /* get a reference to the master */
290 priv
->master
= drm_master_get(priv
->minor
->master
);
292 mutex_unlock(&dev
->struct_mutex
);
294 mutex_lock(&dev
->struct_mutex
);
295 list_add(&priv
->lhead
, &dev
->filelist
);
296 mutex_unlock(&dev
->struct_mutex
);
303 struct pci_dev
*pci_dev
;
304 pci_dev
= pci_get_class(PCI_CLASS_DISPLAY_VGA
<< 8, NULL
);
306 dev
->hose
= pci_dev
->sysdata
;
307 pci_dev_put(pci_dev
);
310 struct pci_bus
*b
= pci_bus_b(pci_root_buses
.next
);
312 dev
->hose
= b
->sysdata
;
320 if (dev
->driver
->postclose
)
321 dev
->driver
->postclose(dev
, priv
);
323 if (drm_core_check_feature(dev
, DRIVER_PRIME
))
324 drm_prime_destroy_file_private(&priv
->prime
);
325 if (dev
->driver
->driver_features
& DRIVER_GEM
)
326 drm_gem_release(dev
, priv
);
329 filp
->private_data
= NULL
;
333 static void drm_master_release(struct drm_device
*dev
, struct file
*filp
)
335 struct drm_file
*file_priv
= filp
->private_data
;
337 if (drm_i_have_hw_lock(dev
, file_priv
)) {
338 DRM_DEBUG("File %p released, freeing lock for context %d\n",
339 filp
, _DRM_LOCKING_CONTEXT(file_priv
->master
->lock
.hw_lock
->lock
));
340 drm_lock_free(&file_priv
->master
->lock
,
341 _DRM_LOCKING_CONTEXT(file_priv
->master
->lock
.hw_lock
->lock
));
345 static void drm_events_release(struct drm_file
*file_priv
)
347 struct drm_device
*dev
= file_priv
->minor
->dev
;
348 struct drm_pending_event
*e
, *et
;
349 struct drm_pending_vblank_event
*v
, *vt
;
352 spin_lock_irqsave(&dev
->event_lock
, flags
);
354 /* Remove pending flips */
355 list_for_each_entry_safe(v
, vt
, &dev
->vblank_event_list
, base
.link
)
356 if (v
->base
.file_priv
== file_priv
) {
357 list_del(&v
->base
.link
);
358 drm_vblank_put(dev
, v
->pipe
);
359 v
->base
.destroy(&v
->base
);
362 /* Remove unconsumed events */
363 list_for_each_entry_safe(e
, et
, &file_priv
->event_list
, link
) {
368 spin_unlock_irqrestore(&dev
->event_lock
, flags
);
372 * drm_legacy_dev_reinit
374 * Reinitializes a legacy/ums drm device in it's lastclose function.
376 static void drm_legacy_dev_reinit(struct drm_device
*dev
)
378 if (drm_core_check_feature(dev
, DRIVER_MODESET
))
381 dev
->sigdata
.lock
= NULL
;
383 dev
->context_flag
= 0;
384 dev
->last_context
= 0;
389 * Take down the DRM device.
391 * \param dev DRM device structure.
393 * Frees every resource in \p dev.
397 int drm_lastclose(struct drm_device
* dev
)
399 struct drm_vma_entry
*vma
, *vma_temp
;
403 if (dev
->driver
->lastclose
)
404 dev
->driver
->lastclose(dev
);
405 DRM_DEBUG("driver lastclose completed\n");
407 if (dev
->irq_enabled
&& !drm_core_check_feature(dev
, DRIVER_MODESET
))
408 drm_irq_uninstall(dev
);
410 mutex_lock(&dev
->struct_mutex
);
414 drm_legacy_sg_cleanup(dev
);
416 /* Clear vma list (only built for debugging) */
417 list_for_each_entry_safe(vma
, vma_temp
, &dev
->vmalist
, head
) {
418 list_del(&vma
->head
);
422 drm_legacy_dma_takedown(dev
);
424 dev
->dev_mapping
= NULL
;
425 mutex_unlock(&dev
->struct_mutex
);
427 drm_legacy_dev_reinit(dev
);
429 DRM_DEBUG("lastclose completed\n");
436 * \param inode device inode
437 * \param file_priv DRM file private.
438 * \return zero on success or a negative number on failure.
440 * If the hardware lock is held then free it, and take it again for the kernel
441 * context since it's necessary to reclaim buffers. Unlink the file private
442 * data from its list and free it. Decreases the open count and if it reaches
443 * zero calls drm_lastclose().
445 int drm_release(struct inode
*inode
, struct file
*filp
)
447 struct drm_file
*file_priv
= filp
->private_data
;
448 struct drm_minor
*minor
= file_priv
->minor
;
449 struct drm_device
*dev
= minor
->dev
;
452 mutex_lock(&drm_global_mutex
);
454 DRM_DEBUG("open_count = %d\n", dev
->open_count
);
456 if (dev
->driver
->preclose
)
457 dev
->driver
->preclose(dev
, file_priv
);
459 /* ========================================================
460 * Begin inline drm_release
463 DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
464 task_pid_nr(current
),
465 (long)old_encode_dev(file_priv
->minor
->kdev
->devt
),
468 /* Release any auth tokens that might point to this file_priv,
469 (do that under the drm_global_mutex) */
470 if (file_priv
->magic
)
471 (void) drm_remove_magic(file_priv
->master
, file_priv
->magic
);
473 /* if the master has gone away we can't do anything with the lock */
474 if (file_priv
->minor
->master
)
475 drm_master_release(dev
, filp
);
477 if (drm_core_check_feature(dev
, DRIVER_HAVE_DMA
))
478 drm_core_reclaim_buffers(dev
, file_priv
);
480 drm_events_release(file_priv
);
482 if (dev
->driver
->driver_features
& DRIVER_MODESET
)
483 drm_fb_release(file_priv
);
485 if (dev
->driver
->driver_features
& DRIVER_GEM
)
486 drm_gem_release(dev
, file_priv
);
488 mutex_lock(&dev
->ctxlist_mutex
);
489 if (!list_empty(&dev
->ctxlist
)) {
490 struct drm_ctx_list
*pos
, *n
;
492 list_for_each_entry_safe(pos
, n
, &dev
->ctxlist
, head
) {
493 if (pos
->tag
== file_priv
&&
494 pos
->handle
!= DRM_KERNEL_CONTEXT
) {
495 if (dev
->driver
->context_dtor
)
496 dev
->driver
->context_dtor(dev
,
499 drm_ctxbitmap_free(dev
, pos
->handle
);
501 list_del(&pos
->head
);
506 mutex_unlock(&dev
->ctxlist_mutex
);
508 mutex_lock(&dev
->struct_mutex
);
510 if (file_priv
->is_master
) {
511 struct drm_master
*master
= file_priv
->master
;
512 struct drm_file
*temp
;
513 list_for_each_entry(temp
, &dev
->filelist
, lhead
) {
514 if ((temp
->master
== file_priv
->master
) &&
516 temp
->authenticated
= temp
->always_authenticated
;
520 * Since the master is disappearing, so is the
521 * possibility to lock.
524 if (master
->lock
.hw_lock
) {
525 if (dev
->sigdata
.lock
== master
->lock
.hw_lock
)
526 dev
->sigdata
.lock
= NULL
;
527 master
->lock
.hw_lock
= NULL
;
528 master
->lock
.file_priv
= NULL
;
529 wake_up_interruptible_all(&master
->lock
.lock_queue
);
532 if (file_priv
->minor
->master
== file_priv
->master
) {
533 /* drop the reference held my the minor */
534 if (dev
->driver
->master_drop
)
535 dev
->driver
->master_drop(dev
, file_priv
, true);
536 drm_master_put(&file_priv
->minor
->master
);
540 BUG_ON(dev
->dev_mapping
== NULL
);
541 iput(container_of(dev
->dev_mapping
, struct inode
, i_data
));
543 /* drop the reference held my the file priv */
544 if (file_priv
->master
)
545 drm_master_put(&file_priv
->master
);
546 file_priv
->is_master
= 0;
547 list_del(&file_priv
->lhead
);
548 mutex_unlock(&dev
->struct_mutex
);
550 if (dev
->driver
->postclose
)
551 dev
->driver
->postclose(dev
, file_priv
);
554 if (drm_core_check_feature(dev
, DRIVER_PRIME
))
555 drm_prime_destroy_file_private(&file_priv
->prime
);
557 put_pid(file_priv
->pid
);
560 /* ========================================================
561 * End inline drm_release
564 if (!--dev
->open_count
) {
565 retcode
= drm_lastclose(dev
);
566 if (drm_device_is_unplugged(dev
))
569 mutex_unlock(&drm_global_mutex
);
571 drm_minor_release(minor
);
575 EXPORT_SYMBOL(drm_release
);
578 drm_dequeue_event(struct drm_file
*file_priv
,
579 size_t total
, size_t max
, struct drm_pending_event
**out
)
581 struct drm_device
*dev
= file_priv
->minor
->dev
;
582 struct drm_pending_event
*e
;
586 spin_lock_irqsave(&dev
->event_lock
, flags
);
589 if (list_empty(&file_priv
->event_list
))
591 e
= list_first_entry(&file_priv
->event_list
,
592 struct drm_pending_event
, link
);
593 if (e
->event
->length
+ total
> max
)
596 file_priv
->event_space
+= e
->event
->length
;
602 spin_unlock_irqrestore(&dev
->event_lock
, flags
);
606 ssize_t
drm_read(struct file
*filp
, char __user
*buffer
,
607 size_t count
, loff_t
*offset
)
609 struct drm_file
*file_priv
= filp
->private_data
;
610 struct drm_pending_event
*e
;
614 ret
= wait_event_interruptible(file_priv
->event_wait
,
615 !list_empty(&file_priv
->event_list
));
620 while (drm_dequeue_event(file_priv
, total
, count
, &e
)) {
621 if (copy_to_user(buffer
+ total
,
622 e
->event
, e
->event
->length
)) {
627 total
+= e
->event
->length
;
633 EXPORT_SYMBOL(drm_read
);
635 unsigned int drm_poll(struct file
*filp
, struct poll_table_struct
*wait
)
637 struct drm_file
*file_priv
= filp
->private_data
;
638 unsigned int mask
= 0;
640 poll_wait(filp
, &file_priv
->event_wait
, wait
);
642 if (!list_empty(&file_priv
->event_list
))
643 mask
|= POLLIN
| POLLRDNORM
;
647 EXPORT_SYMBOL(drm_poll
);