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>
41 #include "drm_legacy.h"
42 #include "drm_internal.h"
44 /* from BKL pushdown */
45 DEFINE_MUTEX(drm_global_mutex
);
46 EXPORT_SYMBOL(drm_global_mutex
);
48 static int drm_open_helper(struct file
*filp
, struct drm_minor
*minor
);
50 static int drm_setup(struct drm_device
* dev
)
54 if (dev
->driver
->firstopen
&&
55 !drm_core_check_feature(dev
, DRIVER_MODESET
)) {
56 ret
= dev
->driver
->firstopen(dev
);
61 ret
= drm_legacy_dma_setup(dev
);
73 * \param inode device inode
74 * \param filp file pointer.
75 * \return zero on success or a negative number on failure.
77 * Searches the DRM device with the same minor number, calls open_helper(), and
78 * increments the device open count. If the open count was previous at zero,
79 * i.e., it's the first that the device is open, then calls setup().
81 int drm_open(struct inode
*inode
, struct file
*filp
)
83 struct drm_device
*dev
;
84 struct drm_minor
*minor
;
88 minor
= drm_minor_acquire(iminor(inode
));
90 return PTR_ERR(minor
);
93 if (!dev
->open_count
++)
96 /* share address_space across all char-devs of a single device */
97 filp
->f_mapping
= dev
->anon_inode
->i_mapping
;
99 retcode
= drm_open_helper(filp
, minor
);
103 retcode
= drm_setup(dev
);
111 drm_minor_release(minor
);
114 EXPORT_SYMBOL(drm_open
);
117 * Check whether DRI will run on this CPU.
119 * \return non-zero if the DRI will run on this CPU, or zero otherwise.
121 static int drm_cpu_valid(void)
123 #if defined(__sparc__) && !defined(__sparc_v9__)
124 return 0; /* No cmpxchg before v9 sparc. */
130 * Called whenever a process opens /dev/drm.
132 * \param filp file pointer.
133 * \param minor acquired minor-object.
134 * \return zero on success or a negative number on failure.
136 * Creates and initializes a drm_file structure for the file private data in \p
137 * filp and add it into the double linked list in \p dev.
139 static int drm_open_helper(struct file
*filp
, struct drm_minor
*minor
)
141 struct drm_device
*dev
= minor
->dev
;
142 struct drm_file
*priv
;
145 if (filp
->f_flags
& O_EXCL
)
146 return -EBUSY
; /* No exclusive opens */
147 if (!drm_cpu_valid())
149 if (dev
->switch_power_state
!= DRM_SWITCH_POWER_ON
&& dev
->switch_power_state
!= DRM_SWITCH_POWER_DYNAMIC_OFF
)
152 DRM_DEBUG("pid = %d, minor = %d\n", task_pid_nr(current
), minor
->index
);
154 priv
= kzalloc(sizeof(*priv
), GFP_KERNEL
);
158 filp
->private_data
= priv
;
160 priv
->uid
= current_euid();
161 priv
->pid
= get_pid(task_pid(current
));
164 /* for compatibility root is always authenticated */
165 priv
->authenticated
= capable(CAP_SYS_ADMIN
);
166 priv
->lock_count
= 0;
168 INIT_LIST_HEAD(&priv
->lhead
);
169 INIT_LIST_HEAD(&priv
->fbs
);
170 mutex_init(&priv
->fbs_lock
);
171 INIT_LIST_HEAD(&priv
->event_list
);
172 init_waitqueue_head(&priv
->event_wait
);
173 priv
->event_space
= 4096; /* set aside 4k for event buffer */
175 if (dev
->driver
->driver_features
& DRIVER_GEM
)
176 drm_gem_open(dev
, priv
);
178 if (drm_core_check_feature(dev
, DRIVER_PRIME
))
179 drm_prime_init_file_private(&priv
->prime
);
181 if (dev
->driver
->open
) {
182 ret
= dev
->driver
->open(dev
, priv
);
184 goto out_prime_destroy
;
187 /* if there is no current master make this fd it, but do not create
188 * any master object for render clients */
189 mutex_lock(&dev
->master_mutex
);
190 if (drm_is_primary_client(priv
) && !priv
->minor
->master
) {
191 /* create a new master */
192 priv
->minor
->master
= drm_master_create(priv
->minor
);
193 if (!priv
->minor
->master
) {
199 /* take another reference for the copy in the local file priv */
200 priv
->master
= drm_master_get(priv
->minor
->master
);
201 priv
->authenticated
= 1;
203 if (dev
->driver
->master_create
) {
204 ret
= dev
->driver
->master_create(dev
, priv
->master
);
206 /* drop both references if this fails */
207 drm_master_put(&priv
->minor
->master
);
208 drm_master_put(&priv
->master
);
212 if (dev
->driver
->master_set
) {
213 ret
= dev
->driver
->master_set(dev
, priv
, true);
215 /* drop both references if this fails */
216 drm_master_put(&priv
->minor
->master
);
217 drm_master_put(&priv
->master
);
221 } else if (drm_is_primary_client(priv
)) {
222 /* get a reference to the master */
223 priv
->master
= drm_master_get(priv
->minor
->master
);
225 mutex_unlock(&dev
->master_mutex
);
227 mutex_lock(&dev
->struct_mutex
);
228 list_add(&priv
->lhead
, &dev
->filelist
);
229 mutex_unlock(&dev
->struct_mutex
);
236 struct pci_dev
*pci_dev
;
237 pci_dev
= pci_get_class(PCI_CLASS_DISPLAY_VGA
<< 8, NULL
);
239 dev
->hose
= pci_dev
->sysdata
;
240 pci_dev_put(pci_dev
);
243 struct pci_bus
*b
= list_entry(pci_root_buses
.next
,
244 struct pci_bus
, node
);
246 dev
->hose
= b
->sysdata
;
254 mutex_unlock(&dev
->master_mutex
);
255 if (dev
->driver
->postclose
)
256 dev
->driver
->postclose(dev
, priv
);
258 if (drm_core_check_feature(dev
, DRIVER_PRIME
))
259 drm_prime_destroy_file_private(&priv
->prime
);
260 if (dev
->driver
->driver_features
& DRIVER_GEM
)
261 drm_gem_release(dev
, priv
);
264 filp
->private_data
= NULL
;
268 static void drm_master_release(struct drm_device
*dev
, struct file
*filp
)
270 struct drm_file
*file_priv
= filp
->private_data
;
272 if (drm_legacy_i_have_hw_lock(dev
, file_priv
)) {
273 DRM_DEBUG("File %p released, freeing lock for context %d\n",
274 filp
, _DRM_LOCKING_CONTEXT(file_priv
->master
->lock
.hw_lock
->lock
));
275 drm_legacy_lock_free(&file_priv
->master
->lock
,
276 _DRM_LOCKING_CONTEXT(file_priv
->master
->lock
.hw_lock
->lock
));
280 static void drm_events_release(struct drm_file
*file_priv
)
282 struct drm_device
*dev
= file_priv
->minor
->dev
;
283 struct drm_pending_event
*e
, *et
;
284 struct drm_pending_vblank_event
*v
, *vt
;
287 spin_lock_irqsave(&dev
->event_lock
, flags
);
289 /* Remove pending flips */
290 list_for_each_entry_safe(v
, vt
, &dev
->vblank_event_list
, base
.link
)
291 if (v
->base
.file_priv
== file_priv
) {
292 list_del(&v
->base
.link
);
293 drm_vblank_put(dev
, v
->pipe
);
294 v
->base
.destroy(&v
->base
);
297 /* Remove unconsumed events */
298 list_for_each_entry_safe(e
, et
, &file_priv
->event_list
, link
) {
303 spin_unlock_irqrestore(&dev
->event_lock
, flags
);
307 * drm_legacy_dev_reinit
309 * Reinitializes a legacy/ums drm device in it's lastclose function.
311 static void drm_legacy_dev_reinit(struct drm_device
*dev
)
313 if (drm_core_check_feature(dev
, DRIVER_MODESET
))
316 dev
->sigdata
.lock
= NULL
;
318 dev
->context_flag
= 0;
319 dev
->last_context
= 0;
324 * Take down the DRM device.
326 * \param dev DRM device structure.
328 * Frees every resource in \p dev.
332 int drm_lastclose(struct drm_device
* dev
)
336 if (dev
->driver
->lastclose
)
337 dev
->driver
->lastclose(dev
);
338 DRM_DEBUG("driver lastclose completed\n");
340 if (dev
->irq_enabled
&& !drm_core_check_feature(dev
, DRIVER_MODESET
))
341 drm_irq_uninstall(dev
);
343 mutex_lock(&dev
->struct_mutex
);
347 drm_legacy_sg_cleanup(dev
);
348 drm_legacy_vma_flush(dev
);
349 drm_legacy_dma_takedown(dev
);
351 mutex_unlock(&dev
->struct_mutex
);
353 drm_legacy_dev_reinit(dev
);
355 DRM_DEBUG("lastclose completed\n");
362 * \param inode device inode
363 * \param file_priv DRM file private.
364 * \return zero on success or a negative number on failure.
366 * If the hardware lock is held then free it, and take it again for the kernel
367 * context since it's necessary to reclaim buffers. Unlink the file private
368 * data from its list and free it. Decreases the open count and if it reaches
369 * zero calls drm_lastclose().
371 int drm_release(struct inode
*inode
, struct file
*filp
)
373 struct drm_file
*file_priv
= filp
->private_data
;
374 struct drm_minor
*minor
= file_priv
->minor
;
375 struct drm_device
*dev
= minor
->dev
;
378 mutex_lock(&drm_global_mutex
);
380 DRM_DEBUG("open_count = %d\n", dev
->open_count
);
382 mutex_lock(&dev
->struct_mutex
);
383 list_del(&file_priv
->lhead
);
384 mutex_unlock(&dev
->struct_mutex
);
386 if (dev
->driver
->preclose
)
387 dev
->driver
->preclose(dev
, file_priv
);
389 /* ========================================================
390 * Begin inline drm_release
393 DRM_DEBUG("pid = %d, device = 0x%lx, open_count = %d\n",
394 task_pid_nr(current
),
395 (long)old_encode_dev(file_priv
->minor
->kdev
->devt
),
398 /* Release any auth tokens that might point to this file_priv,
399 (do that under the drm_global_mutex) */
400 if (file_priv
->magic
)
401 (void) drm_remove_magic(file_priv
->master
, file_priv
->magic
);
403 /* if the master has gone away we can't do anything with the lock */
404 if (file_priv
->minor
->master
)
405 drm_master_release(dev
, filp
);
407 if (drm_core_check_feature(dev
, DRIVER_HAVE_DMA
))
408 drm_legacy_reclaim_buffers(dev
, file_priv
);
410 drm_events_release(file_priv
);
412 if (dev
->driver
->driver_features
& DRIVER_MODESET
)
413 drm_fb_release(file_priv
);
415 if (dev
->driver
->driver_features
& DRIVER_GEM
)
416 drm_gem_release(dev
, file_priv
);
418 drm_legacy_ctxbitmap_flush(dev
, file_priv
);
420 mutex_lock(&dev
->master_mutex
);
422 if (file_priv
->is_master
) {
423 struct drm_master
*master
= file_priv
->master
;
426 * Since the master is disappearing, so is the
427 * possibility to lock.
429 mutex_lock(&dev
->struct_mutex
);
430 if (master
->lock
.hw_lock
) {
431 if (dev
->sigdata
.lock
== master
->lock
.hw_lock
)
432 dev
->sigdata
.lock
= NULL
;
433 master
->lock
.hw_lock
= NULL
;
434 master
->lock
.file_priv
= NULL
;
435 wake_up_interruptible_all(&master
->lock
.lock_queue
);
437 mutex_unlock(&dev
->struct_mutex
);
439 if (file_priv
->minor
->master
== file_priv
->master
) {
440 /* drop the reference held my the minor */
441 if (dev
->driver
->master_drop
)
442 dev
->driver
->master_drop(dev
, file_priv
, true);
443 drm_master_put(&file_priv
->minor
->master
);
447 /* drop the master reference held by the file priv */
448 if (file_priv
->master
)
449 drm_master_put(&file_priv
->master
);
450 file_priv
->is_master
= 0;
451 mutex_unlock(&dev
->master_mutex
);
453 if (dev
->driver
->postclose
)
454 dev
->driver
->postclose(dev
, file_priv
);
457 if (drm_core_check_feature(dev
, DRIVER_PRIME
))
458 drm_prime_destroy_file_private(&file_priv
->prime
);
460 WARN_ON(!list_empty(&file_priv
->event_list
));
462 put_pid(file_priv
->pid
);
465 /* ========================================================
466 * End inline drm_release
469 if (!--dev
->open_count
) {
470 retcode
= drm_lastclose(dev
);
471 if (drm_device_is_unplugged(dev
))
474 mutex_unlock(&drm_global_mutex
);
476 drm_minor_release(minor
);
480 EXPORT_SYMBOL(drm_release
);
483 drm_dequeue_event(struct drm_file
*file_priv
,
484 size_t total
, size_t max
, struct drm_pending_event
**out
)
486 struct drm_device
*dev
= file_priv
->minor
->dev
;
487 struct drm_pending_event
*e
;
491 spin_lock_irqsave(&dev
->event_lock
, flags
);
494 if (list_empty(&file_priv
->event_list
))
496 e
= list_first_entry(&file_priv
->event_list
,
497 struct drm_pending_event
, link
);
498 if (e
->event
->length
+ total
> max
)
501 file_priv
->event_space
+= e
->event
->length
;
507 spin_unlock_irqrestore(&dev
->event_lock
, flags
);
511 ssize_t
drm_read(struct file
*filp
, char __user
*buffer
,
512 size_t count
, loff_t
*offset
)
514 struct drm_file
*file_priv
= filp
->private_data
;
515 struct drm_pending_event
*e
;
519 ret
= wait_event_interruptible(file_priv
->event_wait
,
520 !list_empty(&file_priv
->event_list
));
525 while (drm_dequeue_event(file_priv
, total
, count
, &e
)) {
526 if (copy_to_user(buffer
+ total
,
527 e
->event
, e
->event
->length
)) {
532 total
+= e
->event
->length
;
538 EXPORT_SYMBOL(drm_read
);
540 unsigned int drm_poll(struct file
*filp
, struct poll_table_struct
*wait
)
542 struct drm_file
*file_priv
= filp
->private_data
;
543 unsigned int mask
= 0;
545 poll_wait(filp
, &file_priv
->event_wait
, wait
);
547 if (!list_empty(&file_priv
->event_list
))
548 mask
|= POLLIN
| POLLRDNORM
;
552 EXPORT_SYMBOL(drm_poll
);