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
;
87 minor
= drm_minor_acquire(iminor(inode
));
89 return PTR_ERR(minor
);
92 if (!dev
->open_count
++)
95 /* share address_space across all char-devs of a single device */
96 filp
->f_mapping
= dev
->anon_inode
->i_mapping
;
98 retcode
= drm_open_helper(inode
, filp
, minor
);
102 retcode
= drm_setup(dev
);
110 drm_minor_release(minor
);
113 EXPORT_SYMBOL(drm_open
);
116 * File \c open operation.
118 * \param inode device inode.
119 * \param filp file pointer.
121 * Puts the dev->fops corresponding to the device minor number into
122 * \p filp, call the \c open method, and restore the file operations.
124 int drm_stub_open(struct inode
*inode
, struct file
*filp
)
126 struct drm_device
*dev
;
127 struct drm_minor
*minor
;
129 const struct file_operations
*new_fops
;
133 mutex_lock(&drm_global_mutex
);
134 minor
= drm_minor_acquire(iminor(inode
));
139 new_fops
= fops_get(dev
->driver
->fops
);
143 replace_fops(filp
, new_fops
);
144 if (filp
->f_op
->open
)
145 err
= filp
->f_op
->open(inode
, filp
);
148 drm_minor_release(minor
);
150 mutex_unlock(&drm_global_mutex
);
155 * Check whether DRI will run on this CPU.
157 * \return non-zero if the DRI will run on this CPU, or zero otherwise.
159 static int drm_cpu_valid(void)
161 #if defined(__i386__)
162 if (boot_cpu_data
.x86
== 3)
163 return 0; /* No cmpxchg on a 386 */
165 #if defined(__sparc__) && !defined(__sparc_v9__)
166 return 0; /* No cmpxchg before v9 sparc. */
172 * Called whenever a process opens /dev/drm.
174 * \param inode device inode.
175 * \param filp file pointer.
176 * \param minor acquired minor-object.
177 * \return zero on success or a negative number on failure.
179 * Creates and initializes a drm_file structure for the file private data in \p
180 * filp and add it into the double linked list in \p dev.
182 static int drm_open_helper(struct inode
*inode
, struct file
*filp
,
183 struct drm_minor
*minor
)
185 struct drm_device
*dev
= minor
->dev
;
186 struct drm_file
*priv
;
189 if (filp
->f_flags
& O_EXCL
)
190 return -EBUSY
; /* No exclusive opens */
191 if (!drm_cpu_valid())
193 if (dev
->switch_power_state
!= DRM_SWITCH_POWER_ON
&& dev
->switch_power_state
!= DRM_SWITCH_POWER_DYNAMIC_OFF
)
196 DRM_DEBUG("pid = %d, minor = %d\n", task_pid_nr(current
), minor
->index
);
198 priv
= kzalloc(sizeof(*priv
), GFP_KERNEL
);
202 filp
->private_data
= priv
;
204 priv
->uid
= current_euid();
205 priv
->pid
= get_pid(task_pid(current
));
208 /* for compatibility root is always authenticated */
209 priv
->always_authenticated
= capable(CAP_SYS_ADMIN
);
210 priv
->authenticated
= priv
->always_authenticated
;
211 priv
->lock_count
= 0;
213 INIT_LIST_HEAD(&priv
->lhead
);
214 INIT_LIST_HEAD(&priv
->fbs
);
215 mutex_init(&priv
->fbs_lock
);
216 INIT_LIST_HEAD(&priv
->event_list
);
217 init_waitqueue_head(&priv
->event_wait
);
218 priv
->event_space
= 4096; /* set aside 4k for event buffer */
220 if (dev
->driver
->driver_features
& DRIVER_GEM
)
221 drm_gem_open(dev
, priv
);
223 if (drm_core_check_feature(dev
, DRIVER_PRIME
))
224 drm_prime_init_file_private(&priv
->prime
);
226 if (dev
->driver
->open
) {
227 ret
= dev
->driver
->open(dev
, priv
);
229 goto out_prime_destroy
;
232 /* if there is no current master make this fd it, but do not create
233 * any master object for render clients */
234 mutex_lock(&dev
->struct_mutex
);
235 if (drm_is_primary_client(priv
) && !priv
->minor
->master
) {
236 /* create a new master */
237 priv
->minor
->master
= drm_master_create(priv
->minor
);
238 if (!priv
->minor
->master
) {
239 mutex_unlock(&dev
->struct_mutex
);
245 /* take another reference for the copy in the local file priv */
246 priv
->master
= drm_master_get(priv
->minor
->master
);
248 priv
->authenticated
= 1;
250 mutex_unlock(&dev
->struct_mutex
);
251 if (dev
->driver
->master_create
) {
252 ret
= dev
->driver
->master_create(dev
, priv
->master
);
254 mutex_lock(&dev
->struct_mutex
);
255 /* drop both references if this fails */
256 drm_master_put(&priv
->minor
->master
);
257 drm_master_put(&priv
->master
);
258 mutex_unlock(&dev
->struct_mutex
);
262 mutex_lock(&dev
->struct_mutex
);
263 if (dev
->driver
->master_set
) {
264 ret
= dev
->driver
->master_set(dev
, priv
, true);
266 /* drop both references if this fails */
267 drm_master_put(&priv
->minor
->master
);
268 drm_master_put(&priv
->master
);
269 mutex_unlock(&dev
->struct_mutex
);
273 } else if (drm_is_primary_client(priv
)) {
274 /* get a reference to the master */
275 priv
->master
= drm_master_get(priv
->minor
->master
);
277 mutex_unlock(&dev
->struct_mutex
);
279 mutex_lock(&dev
->struct_mutex
);
280 list_add(&priv
->lhead
, &dev
->filelist
);
281 mutex_unlock(&dev
->struct_mutex
);
288 struct pci_dev
*pci_dev
;
289 pci_dev
= pci_get_class(PCI_CLASS_DISPLAY_VGA
<< 8, NULL
);
291 dev
->hose
= pci_dev
->sysdata
;
292 pci_dev_put(pci_dev
);
295 struct pci_bus
*b
= pci_bus_b(pci_root_buses
.next
);
297 dev
->hose
= b
->sysdata
;
305 if (dev
->driver
->postclose
)
306 dev
->driver
->postclose(dev
, priv
);
308 if (drm_core_check_feature(dev
, DRIVER_PRIME
))
309 drm_prime_destroy_file_private(&priv
->prime
);
310 if (dev
->driver
->driver_features
& DRIVER_GEM
)
311 drm_gem_release(dev
, priv
);
314 filp
->private_data
= NULL
;
318 static void drm_master_release(struct drm_device
*dev
, struct file
*filp
)
320 struct drm_file
*file_priv
= filp
->private_data
;
322 if (drm_i_have_hw_lock(dev
, file_priv
)) {
323 DRM_DEBUG("File %p released, freeing lock for context %d\n",
324 filp
, _DRM_LOCKING_CONTEXT(file_priv
->master
->lock
.hw_lock
->lock
));
325 drm_lock_free(&file_priv
->master
->lock
,
326 _DRM_LOCKING_CONTEXT(file_priv
->master
->lock
.hw_lock
->lock
));
330 static void drm_events_release(struct drm_file
*file_priv
)
332 struct drm_device
*dev
= file_priv
->minor
->dev
;
333 struct drm_pending_event
*e
, *et
;
334 struct drm_pending_vblank_event
*v
, *vt
;
337 spin_lock_irqsave(&dev
->event_lock
, flags
);
339 /* Remove pending flips */
340 list_for_each_entry_safe(v
, vt
, &dev
->vblank_event_list
, base
.link
)
341 if (v
->base
.file_priv
== file_priv
) {
342 list_del(&v
->base
.link
);
343 drm_vblank_put(dev
, v
->pipe
);
344 v
->base
.destroy(&v
->base
);
347 /* Remove unconsumed events */
348 list_for_each_entry_safe(e
, et
, &file_priv
->event_list
, link
) {
353 spin_unlock_irqrestore(&dev
->event_lock
, flags
);
357 * drm_legacy_dev_reinit
359 * Reinitializes a legacy/ums drm device in it's lastclose function.
361 static void drm_legacy_dev_reinit(struct drm_device
*dev
)
363 if (drm_core_check_feature(dev
, DRIVER_MODESET
))
366 dev
->sigdata
.lock
= NULL
;
368 dev
->context_flag
= 0;
369 dev
->last_context
= 0;
374 * Take down the DRM device.
376 * \param dev DRM device structure.
378 * Frees every resource in \p dev.
382 int drm_lastclose(struct drm_device
* dev
)
384 struct drm_vma_entry
*vma
, *vma_temp
;
388 if (dev
->driver
->lastclose
)
389 dev
->driver
->lastclose(dev
);
390 DRM_DEBUG("driver lastclose completed\n");
392 if (dev
->irq_enabled
&& !drm_core_check_feature(dev
, DRIVER_MODESET
))
393 drm_irq_uninstall(dev
);
395 mutex_lock(&dev
->struct_mutex
);
399 drm_legacy_sg_cleanup(dev
);
401 /* Clear vma list (only built for debugging) */
402 list_for_each_entry_safe(vma
, vma_temp
, &dev
->vmalist
, head
) {
403 list_del(&vma
->head
);
407 drm_legacy_dma_takedown(dev
);
409 mutex_unlock(&dev
->struct_mutex
);
411 drm_legacy_dev_reinit(dev
);
413 DRM_DEBUG("lastclose completed\n");
420 * \param inode device inode
421 * \param file_priv DRM file private.
422 * \return zero on success or a negative number on failure.
424 * If the hardware lock is held then free it, and take it again for the kernel
425 * context since it's necessary to reclaim buffers. Unlink the file private
426 * data from its list and free it. Decreases the open count and if it reaches
427 * zero calls drm_lastclose().
429 int drm_release(struct inode
*inode
, struct file
*filp
)
431 struct drm_file
*file_priv
= filp
->private_data
;
432 struct drm_minor
*minor
= file_priv
->minor
;
433 struct drm_device
*dev
= minor
->dev
;
436 mutex_lock(&drm_global_mutex
);
438 DRM_DEBUG("open_count = %d\n", dev
->open_count
);
440 if (dev
->driver
->preclose
)
441 dev
->driver
->preclose(dev
, file_priv
);
443 /* ========================================================
444 * Begin inline drm_release
447 DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
448 task_pid_nr(current
),
449 (long)old_encode_dev(file_priv
->minor
->kdev
->devt
),
452 /* Release any auth tokens that might point to this file_priv,
453 (do that under the drm_global_mutex) */
454 if (file_priv
->magic
)
455 (void) drm_remove_magic(file_priv
->master
, file_priv
->magic
);
457 /* if the master has gone away we can't do anything with the lock */
458 if (file_priv
->minor
->master
)
459 drm_master_release(dev
, filp
);
461 if (drm_core_check_feature(dev
, DRIVER_HAVE_DMA
))
462 drm_core_reclaim_buffers(dev
, file_priv
);
464 drm_events_release(file_priv
);
466 if (dev
->driver
->driver_features
& DRIVER_MODESET
)
467 drm_fb_release(file_priv
);
469 if (dev
->driver
->driver_features
& DRIVER_GEM
)
470 drm_gem_release(dev
, file_priv
);
472 mutex_lock(&dev
->ctxlist_mutex
);
473 if (!list_empty(&dev
->ctxlist
)) {
474 struct drm_ctx_list
*pos
, *n
;
476 list_for_each_entry_safe(pos
, n
, &dev
->ctxlist
, head
) {
477 if (pos
->tag
== file_priv
&&
478 pos
->handle
!= DRM_KERNEL_CONTEXT
) {
479 if (dev
->driver
->context_dtor
)
480 dev
->driver
->context_dtor(dev
,
483 drm_ctxbitmap_free(dev
, pos
->handle
);
485 list_del(&pos
->head
);
490 mutex_unlock(&dev
->ctxlist_mutex
);
492 mutex_lock(&dev
->struct_mutex
);
494 if (file_priv
->is_master
) {
495 struct drm_master
*master
= file_priv
->master
;
496 struct drm_file
*temp
;
497 list_for_each_entry(temp
, &dev
->filelist
, lhead
) {
498 if ((temp
->master
== file_priv
->master
) &&
500 temp
->authenticated
= temp
->always_authenticated
;
504 * Since the master is disappearing, so is the
505 * possibility to lock.
508 if (master
->lock
.hw_lock
) {
509 if (dev
->sigdata
.lock
== master
->lock
.hw_lock
)
510 dev
->sigdata
.lock
= NULL
;
511 master
->lock
.hw_lock
= NULL
;
512 master
->lock
.file_priv
= NULL
;
513 wake_up_interruptible_all(&master
->lock
.lock_queue
);
516 if (file_priv
->minor
->master
== file_priv
->master
) {
517 /* drop the reference held my the minor */
518 if (dev
->driver
->master_drop
)
519 dev
->driver
->master_drop(dev
, file_priv
, true);
520 drm_master_put(&file_priv
->minor
->master
);
524 /* drop the reference held my the file priv */
525 if (file_priv
->master
)
526 drm_master_put(&file_priv
->master
);
527 file_priv
->is_master
= 0;
528 list_del(&file_priv
->lhead
);
529 mutex_unlock(&dev
->struct_mutex
);
531 if (dev
->driver
->postclose
)
532 dev
->driver
->postclose(dev
, file_priv
);
535 if (drm_core_check_feature(dev
, DRIVER_PRIME
))
536 drm_prime_destroy_file_private(&file_priv
->prime
);
538 put_pid(file_priv
->pid
);
541 /* ========================================================
542 * End inline drm_release
545 if (!--dev
->open_count
) {
546 retcode
= drm_lastclose(dev
);
547 if (drm_device_is_unplugged(dev
))
550 mutex_unlock(&drm_global_mutex
);
552 drm_minor_release(minor
);
556 EXPORT_SYMBOL(drm_release
);
559 drm_dequeue_event(struct drm_file
*file_priv
,
560 size_t total
, size_t max
, struct drm_pending_event
**out
)
562 struct drm_device
*dev
= file_priv
->minor
->dev
;
563 struct drm_pending_event
*e
;
567 spin_lock_irqsave(&dev
->event_lock
, flags
);
570 if (list_empty(&file_priv
->event_list
))
572 e
= list_first_entry(&file_priv
->event_list
,
573 struct drm_pending_event
, link
);
574 if (e
->event
->length
+ total
> max
)
577 file_priv
->event_space
+= e
->event
->length
;
583 spin_unlock_irqrestore(&dev
->event_lock
, flags
);
587 ssize_t
drm_read(struct file
*filp
, char __user
*buffer
,
588 size_t count
, loff_t
*offset
)
590 struct drm_file
*file_priv
= filp
->private_data
;
591 struct drm_pending_event
*e
;
595 ret
= wait_event_interruptible(file_priv
->event_wait
,
596 !list_empty(&file_priv
->event_list
));
601 while (drm_dequeue_event(file_priv
, total
, count
, &e
)) {
602 if (copy_to_user(buffer
+ total
,
603 e
->event
, e
->event
->length
)) {
608 total
+= e
->event
->length
;
614 EXPORT_SYMBOL(drm_read
);
616 unsigned int drm_poll(struct file
*filp
, struct poll_table_struct
*wait
)
618 struct drm_file
*file_priv
= filp
->private_data
;
619 unsigned int mask
= 0;
621 poll_wait(filp
, &file_priv
->event_wait
, wait
);
623 if (!list_empty(&file_priv
->event_list
))
624 mask
|= POLLIN
| POLLRDNORM
;
628 EXPORT_SYMBOL(drm_poll
);