Merge branch 'topic/pcm-delay' into for-linus
[linux-2.6] / drivers / gpu / drm / drm_irq.c
1 /**
2  * \file drm_irq.c
3  * IRQ support
4  *
5  * \author Rickard E. (Rik) Faith <faith@valinux.com>
6  * \author Gareth Hughes <gareth@valinux.com>
7  */
8
9 /*
10  * Created: Fri Mar 19 14:30:16 1999 by faith@valinux.com
11  *
12  * Copyright 1999, 2000 Precision Insight, Inc., Cedar Park, Texas.
13  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
14  * All Rights Reserved.
15  *
16  * Permission is hereby granted, free of charge, to any person obtaining a
17  * copy of this software and associated documentation files (the "Software"),
18  * to deal in the Software without restriction, including without limitation
19  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
20  * and/or sell copies of the Software, and to permit persons to whom the
21  * Software is furnished to do so, subject to the following conditions:
22  *
23  * The above copyright notice and this permission notice (including the next
24  * paragraph) shall be included in all copies or substantial portions of the
25  * Software.
26  *
27  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
28  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
29  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
30  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
31  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
32  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
33  * OTHER DEALINGS IN THE SOFTWARE.
34  */
35
36 #include "drmP.h"
37
38 #include <linux/interrupt.h>    /* For task queue support */
39
40 /**
41  * Get interrupt from bus id.
42  *
43  * \param inode device inode.
44  * \param file_priv DRM file private.
45  * \param cmd command.
46  * \param arg user argument, pointing to a drm_irq_busid structure.
47  * \return zero on success or a negative number on failure.
48  *
49  * Finds the PCI device with the specified bus id and gets its IRQ number.
50  * This IOCTL is deprecated, and will now return EINVAL for any busid not equal
51  * to that of the device that this DRM instance attached to.
52  */
53 int drm_irq_by_busid(struct drm_device *dev, void *data,
54                      struct drm_file *file_priv)
55 {
56         struct drm_irq_busid *p = data;
57
58         if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
59                 return -EINVAL;
60
61         if ((p->busnum >> 8) != drm_get_pci_domain(dev) ||
62             (p->busnum & 0xff) != dev->pdev->bus->number ||
63             p->devnum != PCI_SLOT(dev->pdev->devfn) || p->funcnum != PCI_FUNC(dev->pdev->devfn))
64                 return -EINVAL;
65
66         p->irq = dev->pdev->irq;
67
68         DRM_DEBUG("%d:%d:%d => IRQ %d\n", p->busnum, p->devnum, p->funcnum,
69                   p->irq);
70
71         return 0;
72 }
73
74 static void vblank_disable_fn(unsigned long arg)
75 {
76         struct drm_device *dev = (struct drm_device *)arg;
77         unsigned long irqflags;
78         int i;
79
80         if (!dev->vblank_disable_allowed)
81                 return;
82
83         for (i = 0; i < dev->num_crtcs; i++) {
84                 spin_lock_irqsave(&dev->vbl_lock, irqflags);
85                 if (atomic_read(&dev->vblank_refcount[i]) == 0 &&
86                     dev->vblank_enabled[i]) {
87                         DRM_DEBUG("disabling vblank on crtc %d\n", i);
88                         dev->last_vblank[i] =
89                                 dev->driver->get_vblank_counter(dev, i);
90                         dev->driver->disable_vblank(dev, i);
91                         dev->vblank_enabled[i] = 0;
92                 }
93                 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
94         }
95 }
96
97 void drm_vblank_cleanup(struct drm_device *dev)
98 {
99         /* Bail if the driver didn't call drm_vblank_init() */
100         if (dev->num_crtcs == 0)
101                 return;
102
103         del_timer(&dev->vblank_disable_timer);
104
105         vblank_disable_fn((unsigned long)dev);
106
107         drm_free(dev->vbl_queue, sizeof(*dev->vbl_queue) * dev->num_crtcs,
108                  DRM_MEM_DRIVER);
109         drm_free(dev->_vblank_count, sizeof(*dev->_vblank_count) *
110                  dev->num_crtcs, DRM_MEM_DRIVER);
111         drm_free(dev->vblank_refcount, sizeof(*dev->vblank_refcount) *
112                  dev->num_crtcs, DRM_MEM_DRIVER);
113         drm_free(dev->vblank_enabled, sizeof(*dev->vblank_enabled) *
114                  dev->num_crtcs, DRM_MEM_DRIVER);
115         drm_free(dev->last_vblank, sizeof(*dev->last_vblank) * dev->num_crtcs,
116                  DRM_MEM_DRIVER);
117         drm_free(dev->last_vblank_wait,
118                  sizeof(*dev->last_vblank_wait) * dev->num_crtcs,
119                  DRM_MEM_DRIVER);
120         drm_free(dev->vblank_inmodeset, sizeof(*dev->vblank_inmodeset) *
121                  dev->num_crtcs, DRM_MEM_DRIVER);
122
123         dev->num_crtcs = 0;
124 }
125
126 int drm_vblank_init(struct drm_device *dev, int num_crtcs)
127 {
128         int i, ret = -ENOMEM;
129
130         setup_timer(&dev->vblank_disable_timer, vblank_disable_fn,
131                     (unsigned long)dev);
132         spin_lock_init(&dev->vbl_lock);
133         dev->num_crtcs = num_crtcs;
134
135         dev->vbl_queue = drm_alloc(sizeof(wait_queue_head_t) * num_crtcs,
136                                    DRM_MEM_DRIVER);
137         if (!dev->vbl_queue)
138                 goto err;
139
140         dev->_vblank_count = drm_alloc(sizeof(atomic_t) * num_crtcs,
141                                       DRM_MEM_DRIVER);
142         if (!dev->_vblank_count)
143                 goto err;
144
145         dev->vblank_refcount = drm_alloc(sizeof(atomic_t) * num_crtcs,
146                                          DRM_MEM_DRIVER);
147         if (!dev->vblank_refcount)
148                 goto err;
149
150         dev->vblank_enabled = drm_calloc(num_crtcs, sizeof(int),
151                                          DRM_MEM_DRIVER);
152         if (!dev->vblank_enabled)
153                 goto err;
154
155         dev->last_vblank = drm_calloc(num_crtcs, sizeof(u32), DRM_MEM_DRIVER);
156         if (!dev->last_vblank)
157                 goto err;
158
159         dev->last_vblank_wait = drm_calloc(num_crtcs, sizeof(u32),
160                                            DRM_MEM_DRIVER);
161         if (!dev->last_vblank_wait)
162                 goto err;
163
164         dev->vblank_inmodeset = drm_calloc(num_crtcs, sizeof(int),
165                                          DRM_MEM_DRIVER);
166         if (!dev->vblank_inmodeset)
167                 goto err;
168
169         /* Zero per-crtc vblank stuff */
170         for (i = 0; i < num_crtcs; i++) {
171                 init_waitqueue_head(&dev->vbl_queue[i]);
172                 atomic_set(&dev->_vblank_count[i], 0);
173                 atomic_set(&dev->vblank_refcount[i], 0);
174         }
175
176         dev->vblank_disable_allowed = 0;
177
178         return 0;
179
180 err:
181         drm_vblank_cleanup(dev);
182         return ret;
183 }
184 EXPORT_SYMBOL(drm_vblank_init);
185
186 /**
187  * Install IRQ handler.
188  *
189  * \param dev DRM device.
190  *
191  * Initializes the IRQ related data. Installs the handler, calling the driver
192  * \c drm_driver_irq_preinstall() and \c drm_driver_irq_postinstall() functions
193  * before and after the installation.
194  */
195 int drm_irq_install(struct drm_device *dev)
196 {
197         int ret = 0;
198         unsigned long sh_flags = 0;
199         char *irqname;
200
201         if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
202                 return -EINVAL;
203
204         if (dev->pdev->irq == 0)
205                 return -EINVAL;
206
207         mutex_lock(&dev->struct_mutex);
208
209         /* Driver must have been initialized */
210         if (!dev->dev_private) {
211                 mutex_unlock(&dev->struct_mutex);
212                 return -EINVAL;
213         }
214
215         if (dev->irq_enabled) {
216                 mutex_unlock(&dev->struct_mutex);
217                 return -EBUSY;
218         }
219         dev->irq_enabled = 1;
220         mutex_unlock(&dev->struct_mutex);
221
222         DRM_DEBUG("irq=%d\n", dev->pdev->irq);
223
224         /* Before installing handler */
225         dev->driver->irq_preinstall(dev);
226
227         /* Install handler */
228         if (drm_core_check_feature(dev, DRIVER_IRQ_SHARED))
229                 sh_flags = IRQF_SHARED;
230
231         if (dev->devname)
232                 irqname = dev->devname;
233         else
234                 irqname = dev->driver->name;
235
236         ret = request_irq(drm_dev_to_irq(dev), dev->driver->irq_handler,
237                           sh_flags, irqname, dev);
238
239         if (ret < 0) {
240                 mutex_lock(&dev->struct_mutex);
241                 dev->irq_enabled = 0;
242                 mutex_unlock(&dev->struct_mutex);
243                 return ret;
244         }
245
246         /* After installing handler */
247         ret = dev->driver->irq_postinstall(dev);
248         if (ret < 0) {
249                 mutex_lock(&dev->struct_mutex);
250                 dev->irq_enabled = 0;
251                 mutex_unlock(&dev->struct_mutex);
252         }
253
254         return ret;
255 }
256 EXPORT_SYMBOL(drm_irq_install);
257
258 /**
259  * Uninstall the IRQ handler.
260  *
261  * \param dev DRM device.
262  *
263  * Calls the driver's \c drm_driver_irq_uninstall() function, and stops the irq.
264  */
265 int drm_irq_uninstall(struct drm_device * dev)
266 {
267         unsigned long irqflags;
268         int irq_enabled, i;
269
270         if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
271                 return -EINVAL;
272
273         mutex_lock(&dev->struct_mutex);
274         irq_enabled = dev->irq_enabled;
275         dev->irq_enabled = 0;
276         mutex_unlock(&dev->struct_mutex);
277
278         /*
279          * Wake up any waiters so they don't hang.
280          */
281         spin_lock_irqsave(&dev->vbl_lock, irqflags);
282         for (i = 0; i < dev->num_crtcs; i++) {
283                 DRM_WAKEUP(&dev->vbl_queue[i]);
284                 dev->vblank_enabled[i] = 0;
285                 dev->last_vblank[i] = dev->driver->get_vblank_counter(dev, i);
286         }
287         spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
288
289         if (!irq_enabled)
290                 return -EINVAL;
291
292         DRM_DEBUG("irq=%d\n", dev->pdev->irq);
293
294         dev->driver->irq_uninstall(dev);
295
296         free_irq(dev->pdev->irq, dev);
297
298         return 0;
299 }
300 EXPORT_SYMBOL(drm_irq_uninstall);
301
302 /**
303  * IRQ control ioctl.
304  *
305  * \param inode device inode.
306  * \param file_priv DRM file private.
307  * \param cmd command.
308  * \param arg user argument, pointing to a drm_control structure.
309  * \return zero on success or a negative number on failure.
310  *
311  * Calls irq_install() or irq_uninstall() according to \p arg.
312  */
313 int drm_control(struct drm_device *dev, void *data,
314                 struct drm_file *file_priv)
315 {
316         struct drm_control *ctl = data;
317
318         /* if we haven't irq we fallback for compatibility reasons - this used to be a separate function in drm_dma.h */
319
320
321         switch (ctl->func) {
322         case DRM_INST_HANDLER:
323                 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
324                         return 0;
325                 if (drm_core_check_feature(dev, DRIVER_MODESET))
326                         return 0;
327                 if (dev->if_version < DRM_IF_VERSION(1, 2) &&
328                     ctl->irq != dev->pdev->irq)
329                         return -EINVAL;
330                 return drm_irq_install(dev);
331         case DRM_UNINST_HANDLER:
332                 if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
333                         return 0;
334                 if (drm_core_check_feature(dev, DRIVER_MODESET))
335                         return 0;
336                 return drm_irq_uninstall(dev);
337         default:
338                 return -EINVAL;
339         }
340 }
341
342 /**
343  * drm_vblank_count - retrieve "cooked" vblank counter value
344  * @dev: DRM device
345  * @crtc: which counter to retrieve
346  *
347  * Fetches the "cooked" vblank count value that represents the number of
348  * vblank events since the system was booted, including lost events due to
349  * modesetting activity.
350  */
351 u32 drm_vblank_count(struct drm_device *dev, int crtc)
352 {
353         return atomic_read(&dev->_vblank_count[crtc]);
354 }
355 EXPORT_SYMBOL(drm_vblank_count);
356
357 /**
358  * drm_update_vblank_count - update the master vblank counter
359  * @dev: DRM device
360  * @crtc: counter to update
361  *
362  * Call back into the driver to update the appropriate vblank counter
363  * (specified by @crtc).  Deal with wraparound, if it occurred, and
364  * update the last read value so we can deal with wraparound on the next
365  * call if necessary.
366  *
367  * Only necessary when going from off->on, to account for frames we
368  * didn't get an interrupt for.
369  *
370  * Note: caller must hold dev->vbl_lock since this reads & writes
371  * device vblank fields.
372  */
373 static void drm_update_vblank_count(struct drm_device *dev, int crtc)
374 {
375         u32 cur_vblank, diff;
376
377         /*
378          * Interrupts were disabled prior to this call, so deal with counter
379          * wrap if needed.
380          * NOTE!  It's possible we lost a full dev->max_vblank_count events
381          * here if the register is small or we had vblank interrupts off for
382          * a long time.
383          */
384         cur_vblank = dev->driver->get_vblank_counter(dev, crtc);
385         diff = cur_vblank - dev->last_vblank[crtc];
386         if (cur_vblank < dev->last_vblank[crtc]) {
387                 diff += dev->max_vblank_count;
388
389                 DRM_DEBUG("last_vblank[%d]=0x%x, cur_vblank=0x%x => diff=0x%x\n",
390                           crtc, dev->last_vblank[crtc], cur_vblank, diff);
391         }
392
393         DRM_DEBUG("enabling vblank interrupts on crtc %d, missed %d\n",
394                   crtc, diff);
395
396         atomic_add(diff, &dev->_vblank_count[crtc]);
397 }
398
399 /**
400  * drm_vblank_get - get a reference count on vblank events
401  * @dev: DRM device
402  * @crtc: which CRTC to own
403  *
404  * Acquire a reference count on vblank events to avoid having them disabled
405  * while in use.
406  *
407  * RETURNS
408  * Zero on success, nonzero on failure.
409  */
410 int drm_vblank_get(struct drm_device *dev, int crtc)
411 {
412         unsigned long irqflags;
413         int ret = 0;
414
415         spin_lock_irqsave(&dev->vbl_lock, irqflags);
416         /* Going from 0->1 means we have to enable interrupts again */
417         if (atomic_add_return(1, &dev->vblank_refcount[crtc]) == 1 &&
418             !dev->vblank_enabled[crtc]) {
419                 ret = dev->driver->enable_vblank(dev, crtc);
420                 DRM_DEBUG("enabling vblank on crtc %d, ret: %d\n", crtc, ret);
421                 if (ret)
422                         atomic_dec(&dev->vblank_refcount[crtc]);
423                 else {
424                         dev->vblank_enabled[crtc] = 1;
425                         drm_update_vblank_count(dev, crtc);
426                 }
427         }
428         spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
429
430         return ret;
431 }
432 EXPORT_SYMBOL(drm_vblank_get);
433
434 /**
435  * drm_vblank_put - give up ownership of vblank events
436  * @dev: DRM device
437  * @crtc: which counter to give up
438  *
439  * Release ownership of a given vblank counter, turning off interrupts
440  * if possible.
441  */
442 void drm_vblank_put(struct drm_device *dev, int crtc)
443 {
444         BUG_ON (atomic_read (&dev->vblank_refcount[crtc]) == 0);
445
446         /* Last user schedules interrupt disable */
447         if (atomic_dec_and_test(&dev->vblank_refcount[crtc]))
448                 mod_timer(&dev->vblank_disable_timer, jiffies + 5*DRM_HZ);
449 }
450 EXPORT_SYMBOL(drm_vblank_put);
451
452 /**
453  * drm_vblank_pre_modeset - account for vblanks across mode sets
454  * @dev: DRM device
455  * @crtc: CRTC in question
456  * @post: post or pre mode set?
457  *
458  * Account for vblank events across mode setting events, which will likely
459  * reset the hardware frame counter.
460  */
461 void drm_vblank_pre_modeset(struct drm_device *dev, int crtc)
462 {
463         /*
464          * To avoid all the problems that might happen if interrupts
465          * were enabled/disabled around or between these calls, we just
466          * have the kernel take a reference on the CRTC (just once though
467          * to avoid corrupting the count if multiple, mismatch calls occur),
468          * so that interrupts remain enabled in the interim.
469          */
470         if (!dev->vblank_inmodeset[crtc]) {
471                 dev->vblank_inmodeset[crtc] = 0x1;
472                 if (drm_vblank_get(dev, crtc) == 0)
473                         dev->vblank_inmodeset[crtc] |= 0x2;
474         }
475 }
476 EXPORT_SYMBOL(drm_vblank_pre_modeset);
477
478 void drm_vblank_post_modeset(struct drm_device *dev, int crtc)
479 {
480         unsigned long irqflags;
481
482         if (dev->vblank_inmodeset[crtc]) {
483                 spin_lock_irqsave(&dev->vbl_lock, irqflags);
484                 dev->vblank_disable_allowed = 1;
485                 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
486
487                 if (dev->vblank_inmodeset[crtc] & 0x2)
488                         drm_vblank_put(dev, crtc);
489
490                 dev->vblank_inmodeset[crtc] = 0;
491         }
492 }
493 EXPORT_SYMBOL(drm_vblank_post_modeset);
494
495 /**
496  * drm_modeset_ctl - handle vblank event counter changes across mode switch
497  * @DRM_IOCTL_ARGS: standard ioctl arguments
498  *
499  * Applications should call the %_DRM_PRE_MODESET and %_DRM_POST_MODESET
500  * ioctls around modesetting so that any lost vblank events are accounted for.
501  *
502  * Generally the counter will reset across mode sets.  If interrupts are
503  * enabled around this call, we don't have to do anything since the counter
504  * will have already been incremented.
505  */
506 int drm_modeset_ctl(struct drm_device *dev, void *data,
507                     struct drm_file *file_priv)
508 {
509         struct drm_modeset_ctl *modeset = data;
510         int crtc, ret = 0;
511
512         /* If drm_vblank_init() hasn't been called yet, just no-op */
513         if (!dev->num_crtcs)
514                 goto out;
515
516         crtc = modeset->crtc;
517         if (crtc >= dev->num_crtcs) {
518                 ret = -EINVAL;
519                 goto out;
520         }
521
522         switch (modeset->cmd) {
523         case _DRM_PRE_MODESET:
524                 drm_vblank_pre_modeset(dev, crtc);
525                 break;
526         case _DRM_POST_MODESET:
527                 drm_vblank_post_modeset(dev, crtc);
528                 break;
529         default:
530                 ret = -EINVAL;
531                 break;
532         }
533
534 out:
535         return ret;
536 }
537
538 /**
539  * Wait for VBLANK.
540  *
541  * \param inode device inode.
542  * \param file_priv DRM file private.
543  * \param cmd command.
544  * \param data user argument, pointing to a drm_wait_vblank structure.
545  * \return zero on success or a negative number on failure.
546  *
547  * This function enables the vblank interrupt on the pipe requested, then
548  * sleeps waiting for the requested sequence number to occur, and drops
549  * the vblank interrupt refcount afterwards. (vblank irq disable follows that
550  * after a timeout with no further vblank waits scheduled).
551  */
552 int drm_wait_vblank(struct drm_device *dev, void *data,
553                     struct drm_file *file_priv)
554 {
555         union drm_wait_vblank *vblwait = data;
556         int ret = 0;
557         unsigned int flags, seq, crtc;
558
559         if ((!dev->pdev->irq) || (!dev->irq_enabled))
560                 return -EINVAL;
561
562         if (vblwait->request.type & _DRM_VBLANK_SIGNAL)
563                 return -EINVAL;
564
565         if (vblwait->request.type &
566             ~(_DRM_VBLANK_TYPES_MASK | _DRM_VBLANK_FLAGS_MASK)) {
567                 DRM_ERROR("Unsupported type value 0x%x, supported mask 0x%x\n",
568                           vblwait->request.type,
569                           (_DRM_VBLANK_TYPES_MASK | _DRM_VBLANK_FLAGS_MASK));
570                 return -EINVAL;
571         }
572
573         flags = vblwait->request.type & _DRM_VBLANK_FLAGS_MASK;
574         crtc = flags & _DRM_VBLANK_SECONDARY ? 1 : 0;
575
576         if (crtc >= dev->num_crtcs)
577                 return -EINVAL;
578
579         ret = drm_vblank_get(dev, crtc);
580         if (ret) {
581                 DRM_ERROR("failed to acquire vblank counter, %d\n", ret);
582                 return ret;
583         }
584         seq = drm_vblank_count(dev, crtc);
585
586         switch (vblwait->request.type & _DRM_VBLANK_TYPES_MASK) {
587         case _DRM_VBLANK_RELATIVE:
588                 vblwait->request.sequence += seq;
589                 vblwait->request.type &= ~_DRM_VBLANK_RELATIVE;
590         case _DRM_VBLANK_ABSOLUTE:
591                 break;
592         default:
593                 ret = -EINVAL;
594                 goto done;
595         }
596
597         if ((flags & _DRM_VBLANK_NEXTONMISS) &&
598             (seq - vblwait->request.sequence) <= (1<<23)) {
599                 vblwait->request.sequence = seq + 1;
600         }
601
602         DRM_DEBUG("waiting on vblank count %d, crtc %d\n",
603                   vblwait->request.sequence, crtc);
604         dev->last_vblank_wait[crtc] = vblwait->request.sequence;
605         DRM_WAIT_ON(ret, dev->vbl_queue[crtc], 3 * DRM_HZ,
606                     (((drm_vblank_count(dev, crtc) -
607                        vblwait->request.sequence) <= (1 << 23)) ||
608                      !dev->irq_enabled));
609
610         if (ret != -EINTR) {
611                 struct timeval now;
612
613                 do_gettimeofday(&now);
614
615                 vblwait->reply.tval_sec = now.tv_sec;
616                 vblwait->reply.tval_usec = now.tv_usec;
617                 vblwait->reply.sequence = drm_vblank_count(dev, crtc);
618                 DRM_DEBUG("returning %d to client\n",
619                           vblwait->reply.sequence);
620         } else {
621                 DRM_DEBUG("vblank wait interrupted by signal\n");
622         }
623
624 done:
625         drm_vblank_put(dev, crtc);
626         return ret;
627 }
628
629 /**
630  * drm_handle_vblank - handle a vblank event
631  * @dev: DRM device
632  * @crtc: where this event occurred
633  *
634  * Drivers should call this routine in their vblank interrupt handlers to
635  * update the vblank counter and send any signals that may be pending.
636  */
637 void drm_handle_vblank(struct drm_device *dev, int crtc)
638 {
639         atomic_inc(&dev->_vblank_count[crtc]);
640         DRM_WAKEUP(&dev->vbl_queue[crtc]);
641 }
642 EXPORT_SYMBOL(drm_handle_vblank);