OSDN Git Service

Merge tag 'drm/tegra/for-4.1-rc1' of git://anongit.freedesktop.org/tegra/linux into...
[uclinux-h8/linux.git] / drivers / gpu / drm / drm_irq.c
1 /*
2  * drm_irq.c IRQ and vblank support
3  *
4  * \author Rickard E. (Rik) Faith <faith@valinux.com>
5  * \author Gareth Hughes <gareth@valinux.com>
6  */
7
8 /*
9  * Created: Fri Mar 19 14:30:16 1999 by faith@valinux.com
10  *
11  * Copyright 1999, 2000 Precision Insight, Inc., Cedar Park, Texas.
12  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
13  * All Rights Reserved.
14  *
15  * Permission is hereby granted, free of charge, to any person obtaining a
16  * copy of this software and associated documentation files (the "Software"),
17  * to deal in the Software without restriction, including without limitation
18  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
19  * and/or sell copies of the Software, and to permit persons to whom the
20  * Software is furnished to do so, subject to the following conditions:
21  *
22  * The above copyright notice and this permission notice (including the next
23  * paragraph) shall be included in all copies or substantial portions of the
24  * Software.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
27  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
28  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
29  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
30  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
31  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
32  * OTHER DEALINGS IN THE SOFTWARE.
33  */
34
35 #include <drm/drmP.h>
36 #include "drm_trace.h"
37 #include "drm_internal.h"
38
39 #include <linux/interrupt.h>    /* For task queue support */
40 #include <linux/slab.h>
41
42 #include <linux/vgaarb.h>
43 #include <linux/export.h>
44
45 /* Access macro for slots in vblank timestamp ringbuffer. */
46 #define vblanktimestamp(dev, crtc, count) \
47         ((dev)->vblank[crtc].time[(count) % DRM_VBLANKTIME_RBSIZE])
48
49 /* Retry timestamp calculation up to 3 times to satisfy
50  * drm_timestamp_precision before giving up.
51  */
52 #define DRM_TIMESTAMP_MAXRETRIES 3
53
54 /* Threshold in nanoseconds for detection of redundant
55  * vblank irq in drm_handle_vblank(). 1 msec should be ok.
56  */
57 #define DRM_REDUNDANT_VBLIRQ_THRESH_NS 1000000
58
59 static bool
60 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
61                           struct timeval *tvblank, unsigned flags);
62
63 static unsigned int drm_timestamp_precision = 20;  /* Default to 20 usecs. */
64
65 /*
66  * Default to use monotonic timestamps for wait-for-vblank and page-flip
67  * complete events.
68  */
69 unsigned int drm_timestamp_monotonic = 1;
70
71 static int drm_vblank_offdelay = 5000;    /* Default to 5000 msecs. */
72
73 module_param_named(vblankoffdelay, drm_vblank_offdelay, int, 0600);
74 module_param_named(timestamp_precision_usec, drm_timestamp_precision, int, 0600);
75 module_param_named(timestamp_monotonic, drm_timestamp_monotonic, int, 0600);
76
77 /**
78  * drm_update_vblank_count - update the master vblank counter
79  * @dev: DRM device
80  * @crtc: counter to update
81  *
82  * Call back into the driver to update the appropriate vblank counter
83  * (specified by @crtc).  Deal with wraparound, if it occurred, and
84  * update the last read value so we can deal with wraparound on the next
85  * call if necessary.
86  *
87  * Only necessary when going from off->on, to account for frames we
88  * didn't get an interrupt for.
89  *
90  * Note: caller must hold dev->vbl_lock since this reads & writes
91  * device vblank fields.
92  */
93 static void drm_update_vblank_count(struct drm_device *dev, int crtc)
94 {
95         struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
96         u32 cur_vblank, diff, tslot;
97         bool rc;
98         struct timeval t_vblank;
99
100         /*
101          * Interrupts were disabled prior to this call, so deal with counter
102          * wrap if needed.
103          * NOTE!  It's possible we lost a full dev->max_vblank_count events
104          * here if the register is small or we had vblank interrupts off for
105          * a long time.
106          *
107          * We repeat the hardware vblank counter & timestamp query until
108          * we get consistent results. This to prevent races between gpu
109          * updating its hardware counter while we are retrieving the
110          * corresponding vblank timestamp.
111          */
112         do {
113                 cur_vblank = dev->driver->get_vblank_counter(dev, crtc);
114                 rc = drm_get_last_vbltimestamp(dev, crtc, &t_vblank, 0);
115         } while (cur_vblank != dev->driver->get_vblank_counter(dev, crtc));
116
117         /* Deal with counter wrap */
118         diff = cur_vblank - vblank->last;
119         if (cur_vblank < vblank->last) {
120                 diff += dev->max_vblank_count;
121
122                 DRM_DEBUG("last_vblank[%d]=0x%x, cur_vblank=0x%x => diff=0x%x\n",
123                           crtc, vblank->last, cur_vblank, diff);
124         }
125
126         DRM_DEBUG("updating vblank count on crtc %d, missed %d\n",
127                   crtc, diff);
128
129         if (diff == 0)
130                 return;
131
132         /* Reinitialize corresponding vblank timestamp if high-precision query
133          * available. Skip this step if query unsupported or failed. Will
134          * reinitialize delayed at next vblank interrupt in that case.
135          */
136         if (rc) {
137                 tslot = atomic_read(&vblank->count) + diff;
138                 vblanktimestamp(dev, crtc, tslot) = t_vblank;
139         }
140
141         smp_mb__before_atomic();
142         atomic_add(diff, &vblank->count);
143         smp_mb__after_atomic();
144 }
145
146 /*
147  * Disable vblank irq's on crtc, make sure that last vblank count
148  * of hardware and corresponding consistent software vblank counter
149  * are preserved, even if there are any spurious vblank irq's after
150  * disable.
151  */
152 static void vblank_disable_and_save(struct drm_device *dev, int crtc)
153 {
154         struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
155         unsigned long irqflags;
156         u32 vblcount;
157         s64 diff_ns;
158         bool vblrc;
159         struct timeval tvblank;
160         int count = DRM_TIMESTAMP_MAXRETRIES;
161
162         /* Prevent vblank irq processing while disabling vblank irqs,
163          * so no updates of timestamps or count can happen after we've
164          * disabled. Needed to prevent races in case of delayed irq's.
165          */
166         spin_lock_irqsave(&dev->vblank_time_lock, irqflags);
167
168         /*
169          * If the vblank interrupt was already disabled update the count
170          * and timestamp to maintain the appearance that the counter
171          * has been ticking all along until this time. This makes the
172          * count account for the entire time between drm_vblank_on() and
173          * drm_vblank_off().
174          *
175          * But only do this if precise vblank timestamps are available.
176          * Otherwise we might read a totally bogus timestamp since drivers
177          * lacking precise timestamp support rely upon sampling the system clock
178          * at vblank interrupt time. Which obviously won't work out well if the
179          * vblank interrupt is disabled.
180          */
181         if (!vblank->enabled &&
182             drm_get_last_vbltimestamp(dev, crtc, &tvblank, 0)) {
183                 drm_update_vblank_count(dev, crtc);
184                 spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags);
185                 return;
186         }
187
188         /*
189          * Only disable vblank interrupts if they're enabled. This avoids
190          * calling the ->disable_vblank() operation in atomic context with the
191          * hardware potentially runtime suspended.
192          */
193         if (vblank->enabled) {
194                 dev->driver->disable_vblank(dev, crtc);
195                 vblank->enabled = false;
196         }
197
198         /* No further vblank irq's will be processed after
199          * this point. Get current hardware vblank count and
200          * vblank timestamp, repeat until they are consistent.
201          *
202          * FIXME: There is still a race condition here and in
203          * drm_update_vblank_count() which can cause off-by-one
204          * reinitialization of software vblank counter. If gpu
205          * vblank counter doesn't increment exactly at the leading
206          * edge of a vblank interval, then we can lose 1 count if
207          * we happen to execute between start of vblank and the
208          * delayed gpu counter increment.
209          */
210         do {
211                 vblank->last = dev->driver->get_vblank_counter(dev, crtc);
212                 vblrc = drm_get_last_vbltimestamp(dev, crtc, &tvblank, 0);
213         } while (vblank->last != dev->driver->get_vblank_counter(dev, crtc) && (--count) && vblrc);
214
215         if (!count)
216                 vblrc = 0;
217
218         /* Compute time difference to stored timestamp of last vblank
219          * as updated by last invocation of drm_handle_vblank() in vblank irq.
220          */
221         vblcount = atomic_read(&vblank->count);
222         diff_ns = timeval_to_ns(&tvblank) -
223                   timeval_to_ns(&vblanktimestamp(dev, crtc, vblcount));
224
225         /* If there is at least 1 msec difference between the last stored
226          * timestamp and tvblank, then we are currently executing our
227          * disable inside a new vblank interval, the tvblank timestamp
228          * corresponds to this new vblank interval and the irq handler
229          * for this vblank didn't run yet and won't run due to our disable.
230          * Therefore we need to do the job of drm_handle_vblank() and
231          * increment the vblank counter by one to account for this vblank.
232          *
233          * Skip this step if there isn't any high precision timestamp
234          * available. In that case we can't account for this and just
235          * hope for the best.
236          */
237         if (vblrc && (abs64(diff_ns) > 1000000)) {
238                 /* Store new timestamp in ringbuffer. */
239                 vblanktimestamp(dev, crtc, vblcount + 1) = tvblank;
240
241                 /* Increment cooked vblank count. This also atomically commits
242                  * the timestamp computed above.
243                  */
244                 smp_mb__before_atomic();
245                 atomic_inc(&vblank->count);
246                 smp_mb__after_atomic();
247         }
248
249         spin_unlock_irqrestore(&dev->vblank_time_lock, irqflags);
250 }
251
252 static void vblank_disable_fn(unsigned long arg)
253 {
254         struct drm_vblank_crtc *vblank = (void *)arg;
255         struct drm_device *dev = vblank->dev;
256         unsigned long irqflags;
257         int crtc = vblank->crtc;
258
259         if (!dev->vblank_disable_allowed)
260                 return;
261
262         spin_lock_irqsave(&dev->vbl_lock, irqflags);
263         if (atomic_read(&vblank->refcount) == 0 && vblank->enabled) {
264                 DRM_DEBUG("disabling vblank on crtc %d\n", crtc);
265                 vblank_disable_and_save(dev, crtc);
266         }
267         spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
268 }
269
270 /**
271  * drm_vblank_cleanup - cleanup vblank support
272  * @dev: DRM device
273  *
274  * This function cleans up any resources allocated in drm_vblank_init.
275  */
276 void drm_vblank_cleanup(struct drm_device *dev)
277 {
278         int crtc;
279
280         /* Bail if the driver didn't call drm_vblank_init() */
281         if (dev->num_crtcs == 0)
282                 return;
283
284         for (crtc = 0; crtc < dev->num_crtcs; crtc++) {
285                 struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
286
287                 WARN_ON(vblank->enabled &&
288                         drm_core_check_feature(dev, DRIVER_MODESET));
289
290                 del_timer_sync(&vblank->disable_timer);
291         }
292
293         kfree(dev->vblank);
294
295         dev->num_crtcs = 0;
296 }
297 EXPORT_SYMBOL(drm_vblank_cleanup);
298
299 /**
300  * drm_vblank_init - initialize vblank support
301  * @dev: drm_device
302  * @num_crtcs: number of crtcs supported by @dev
303  *
304  * This function initializes vblank support for @num_crtcs display pipelines.
305  *
306  * Returns:
307  * Zero on success or a negative error code on failure.
308  */
309 int drm_vblank_init(struct drm_device *dev, int num_crtcs)
310 {
311         int i, ret = -ENOMEM;
312
313         spin_lock_init(&dev->vbl_lock);
314         spin_lock_init(&dev->vblank_time_lock);
315
316         dev->num_crtcs = num_crtcs;
317
318         dev->vblank = kcalloc(num_crtcs, sizeof(*dev->vblank), GFP_KERNEL);
319         if (!dev->vblank)
320                 goto err;
321
322         for (i = 0; i < num_crtcs; i++) {
323                 struct drm_vblank_crtc *vblank = &dev->vblank[i];
324
325                 vblank->dev = dev;
326                 vblank->crtc = i;
327                 init_waitqueue_head(&vblank->queue);
328                 setup_timer(&vblank->disable_timer, vblank_disable_fn,
329                             (unsigned long)vblank);
330         }
331
332         DRM_INFO("Supports vblank timestamp caching Rev 2 (21.10.2013).\n");
333
334         /* Driver specific high-precision vblank timestamping supported? */
335         if (dev->driver->get_vblank_timestamp)
336                 DRM_INFO("Driver supports precise vblank timestamp query.\n");
337         else
338                 DRM_INFO("No driver support for vblank timestamp query.\n");
339
340         dev->vblank_disable_allowed = false;
341
342         return 0;
343
344 err:
345         dev->num_crtcs = 0;
346         return ret;
347 }
348 EXPORT_SYMBOL(drm_vblank_init);
349
350 static void drm_irq_vgaarb_nokms(void *cookie, bool state)
351 {
352         struct drm_device *dev = cookie;
353
354         if (dev->driver->vgaarb_irq) {
355                 dev->driver->vgaarb_irq(dev, state);
356                 return;
357         }
358
359         if (!dev->irq_enabled)
360                 return;
361
362         if (state) {
363                 if (dev->driver->irq_uninstall)
364                         dev->driver->irq_uninstall(dev);
365         } else {
366                 if (dev->driver->irq_preinstall)
367                         dev->driver->irq_preinstall(dev);
368                 if (dev->driver->irq_postinstall)
369                         dev->driver->irq_postinstall(dev);
370         }
371 }
372
373 /**
374  * drm_irq_install - install IRQ handler
375  * @dev: DRM device
376  * @irq: IRQ number to install the handler for
377  *
378  * Initializes the IRQ related data. Installs the handler, calling the driver
379  * irq_preinstall() and irq_postinstall() functions before and after the
380  * installation.
381  *
382  * This is the simplified helper interface provided for drivers with no special
383  * needs. Drivers which need to install interrupt handlers for multiple
384  * interrupts must instead set drm_device->irq_enabled to signal the DRM core
385  * that vblank interrupts are available.
386  *
387  * Returns:
388  * Zero on success or a negative error code on failure.
389  */
390 int drm_irq_install(struct drm_device *dev, int irq)
391 {
392         int ret;
393         unsigned long sh_flags = 0;
394
395         if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
396                 return -EINVAL;
397
398         if (irq == 0)
399                 return -EINVAL;
400
401         /* Driver must have been initialized */
402         if (!dev->dev_private)
403                 return -EINVAL;
404
405         if (dev->irq_enabled)
406                 return -EBUSY;
407         dev->irq_enabled = true;
408
409         DRM_DEBUG("irq=%d\n", irq);
410
411         /* Before installing handler */
412         if (dev->driver->irq_preinstall)
413                 dev->driver->irq_preinstall(dev);
414
415         /* Install handler */
416         if (drm_core_check_feature(dev, DRIVER_IRQ_SHARED))
417                 sh_flags = IRQF_SHARED;
418
419         ret = request_irq(irq, dev->driver->irq_handler,
420                           sh_flags, dev->driver->name, dev);
421
422         if (ret < 0) {
423                 dev->irq_enabled = false;
424                 return ret;
425         }
426
427         if (!drm_core_check_feature(dev, DRIVER_MODESET))
428                 vga_client_register(dev->pdev, (void *)dev, drm_irq_vgaarb_nokms, NULL);
429
430         /* After installing handler */
431         if (dev->driver->irq_postinstall)
432                 ret = dev->driver->irq_postinstall(dev);
433
434         if (ret < 0) {
435                 dev->irq_enabled = false;
436                 if (!drm_core_check_feature(dev, DRIVER_MODESET))
437                         vga_client_register(dev->pdev, NULL, NULL, NULL);
438                 free_irq(irq, dev);
439         } else {
440                 dev->irq = irq;
441         }
442
443         return ret;
444 }
445 EXPORT_SYMBOL(drm_irq_install);
446
447 /**
448  * drm_irq_uninstall - uninstall the IRQ handler
449  * @dev: DRM device
450  *
451  * Calls the driver's irq_uninstall() function and unregisters the IRQ handler.
452  * This should only be called by drivers which used drm_irq_install() to set up
453  * their interrupt handler. Other drivers must only reset
454  * drm_device->irq_enabled to false.
455  *
456  * Note that for kernel modesetting drivers it is a bug if this function fails.
457  * The sanity checks are only to catch buggy user modesetting drivers which call
458  * the same function through an ioctl.
459  *
460  * Returns:
461  * Zero on success or a negative error code on failure.
462  */
463 int drm_irq_uninstall(struct drm_device *dev)
464 {
465         unsigned long irqflags;
466         bool irq_enabled;
467         int i;
468
469         if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
470                 return -EINVAL;
471
472         irq_enabled = dev->irq_enabled;
473         dev->irq_enabled = false;
474
475         /*
476          * Wake up any waiters so they don't hang. This is just to paper over
477          * isssues for UMS drivers which aren't in full control of their
478          * vblank/irq handling. KMS drivers must ensure that vblanks are all
479          * disabled when uninstalling the irq handler.
480          */
481         if (dev->num_crtcs) {
482                 spin_lock_irqsave(&dev->vbl_lock, irqflags);
483                 for (i = 0; i < dev->num_crtcs; i++) {
484                         struct drm_vblank_crtc *vblank = &dev->vblank[i];
485
486                         if (!vblank->enabled)
487                                 continue;
488
489                         WARN_ON(drm_core_check_feature(dev, DRIVER_MODESET));
490
491                         vblank_disable_and_save(dev, i);
492                         wake_up(&vblank->queue);
493                 }
494                 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
495         }
496
497         if (!irq_enabled)
498                 return -EINVAL;
499
500         DRM_DEBUG("irq=%d\n", dev->irq);
501
502         if (!drm_core_check_feature(dev, DRIVER_MODESET))
503                 vga_client_register(dev->pdev, NULL, NULL, NULL);
504
505         if (dev->driver->irq_uninstall)
506                 dev->driver->irq_uninstall(dev);
507
508         free_irq(dev->irq, dev);
509
510         return 0;
511 }
512 EXPORT_SYMBOL(drm_irq_uninstall);
513
514 /*
515  * IRQ control ioctl.
516  *
517  * \param inode device inode.
518  * \param file_priv DRM file private.
519  * \param cmd command.
520  * \param arg user argument, pointing to a drm_control structure.
521  * \return zero on success or a negative number on failure.
522  *
523  * Calls irq_install() or irq_uninstall() according to \p arg.
524  */
525 int drm_control(struct drm_device *dev, void *data,
526                 struct drm_file *file_priv)
527 {
528         struct drm_control *ctl = data;
529         int ret = 0, irq;
530
531         /* if we haven't irq we fallback for compatibility reasons -
532          * this used to be a separate function in drm_dma.h
533          */
534
535         if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
536                 return 0;
537         if (drm_core_check_feature(dev, DRIVER_MODESET))
538                 return 0;
539         /* UMS was only ever support on pci devices. */
540         if (WARN_ON(!dev->pdev))
541                 return -EINVAL;
542
543         switch (ctl->func) {
544         case DRM_INST_HANDLER:
545                 irq = dev->pdev->irq;
546
547                 if (dev->if_version < DRM_IF_VERSION(1, 2) &&
548                     ctl->irq != irq)
549                         return -EINVAL;
550                 mutex_lock(&dev->struct_mutex);
551                 ret = drm_irq_install(dev, irq);
552                 mutex_unlock(&dev->struct_mutex);
553
554                 return ret;
555         case DRM_UNINST_HANDLER:
556                 mutex_lock(&dev->struct_mutex);
557                 ret = drm_irq_uninstall(dev);
558                 mutex_unlock(&dev->struct_mutex);
559
560                 return ret;
561         default:
562                 return -EINVAL;
563         }
564 }
565
566 /**
567  * drm_calc_timestamping_constants - calculate vblank timestamp constants
568  * @crtc: drm_crtc whose timestamp constants should be updated.
569  * @mode: display mode containing the scanout timings
570  *
571  * Calculate and store various constants which are later
572  * needed by vblank and swap-completion timestamping, e.g,
573  * by drm_calc_vbltimestamp_from_scanoutpos(). They are
574  * derived from CRTC's true scanout timing, so they take
575  * things like panel scaling or other adjustments into account.
576  */
577 void drm_calc_timestamping_constants(struct drm_crtc *crtc,
578                                      const struct drm_display_mode *mode)
579 {
580         int linedur_ns = 0, pixeldur_ns = 0, framedur_ns = 0;
581         int dotclock = mode->crtc_clock;
582
583         /* Valid dotclock? */
584         if (dotclock > 0) {
585                 int frame_size = mode->crtc_htotal * mode->crtc_vtotal;
586
587                 /*
588                  * Convert scanline length in pixels and video
589                  * dot clock to line duration, frame duration
590                  * and pixel duration in nanoseconds:
591                  */
592                 pixeldur_ns = 1000000 / dotclock;
593                 linedur_ns  = div_u64((u64) mode->crtc_htotal * 1000000, dotclock);
594                 framedur_ns = div_u64((u64) frame_size * 1000000, dotclock);
595
596                 /*
597                  * Fields of interlaced scanout modes are only half a frame duration.
598                  */
599                 if (mode->flags & DRM_MODE_FLAG_INTERLACE)
600                         framedur_ns /= 2;
601         } else
602                 DRM_ERROR("crtc %d: Can't calculate constants, dotclock = 0!\n",
603                           crtc->base.id);
604
605         crtc->pixeldur_ns = pixeldur_ns;
606         crtc->linedur_ns  = linedur_ns;
607         crtc->framedur_ns = framedur_ns;
608
609         DRM_DEBUG("crtc %d: hwmode: htotal %d, vtotal %d, vdisplay %d\n",
610                   crtc->base.id, mode->crtc_htotal,
611                   mode->crtc_vtotal, mode->crtc_vdisplay);
612         DRM_DEBUG("crtc %d: clock %d kHz framedur %d linedur %d, pixeldur %d\n",
613                   crtc->base.id, dotclock, framedur_ns,
614                   linedur_ns, pixeldur_ns);
615 }
616 EXPORT_SYMBOL(drm_calc_timestamping_constants);
617
618 /**
619  * drm_calc_vbltimestamp_from_scanoutpos - precise vblank timestamp helper
620  * @dev: DRM device
621  * @crtc: Which CRTC's vblank timestamp to retrieve
622  * @max_error: Desired maximum allowable error in timestamps (nanosecs)
623  *             On return contains true maximum error of timestamp
624  * @vblank_time: Pointer to struct timeval which should receive the timestamp
625  * @flags: Flags to pass to driver:
626  *         0 = Default,
627  *         DRM_CALLED_FROM_VBLIRQ = If function is called from vbl IRQ handler
628  * @refcrtc: CRTC which defines scanout timing
629  * @mode: mode which defines the scanout timings
630  *
631  * Implements calculation of exact vblank timestamps from given drm_display_mode
632  * timings and current video scanout position of a CRTC. This can be called from
633  * within get_vblank_timestamp() implementation of a kms driver to implement the
634  * actual timestamping.
635  *
636  * Should return timestamps conforming to the OML_sync_control OpenML
637  * extension specification. The timestamp corresponds to the end of
638  * the vblank interval, aka start of scanout of topmost-leftmost display
639  * pixel in the following video frame.
640  *
641  * Requires support for optional dev->driver->get_scanout_position()
642  * in kms driver, plus a bit of setup code to provide a drm_display_mode
643  * that corresponds to the true scanout timing.
644  *
645  * The current implementation only handles standard video modes. It
646  * returns as no operation if a doublescan or interlaced video mode is
647  * active. Higher level code is expected to handle this.
648  *
649  * Returns:
650  * Negative value on error, failure or if not supported in current
651  * video mode:
652  *
653  * -EINVAL   - Invalid CRTC.
654  * -EAGAIN   - Temporary unavailable, e.g., called before initial modeset.
655  * -ENOTSUPP - Function not supported in current display mode.
656  * -EIO      - Failed, e.g., due to failed scanout position query.
657  *
658  * Returns or'ed positive status flags on success:
659  *
660  * DRM_VBLANKTIME_SCANOUTPOS_METHOD - Signal this method used for timestamping.
661  * DRM_VBLANKTIME_INVBL - Timestamp taken while scanout was in vblank interval.
662  *
663  */
664 int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev, int crtc,
665                                           int *max_error,
666                                           struct timeval *vblank_time,
667                                           unsigned flags,
668                                           const struct drm_crtc *refcrtc,
669                                           const struct drm_display_mode *mode)
670 {
671         struct timeval tv_etime;
672         ktime_t stime, etime;
673         int vbl_status;
674         int vpos, hpos, i;
675         int framedur_ns, linedur_ns, pixeldur_ns, delta_ns, duration_ns;
676         bool invbl;
677
678         if (crtc < 0 || crtc >= dev->num_crtcs) {
679                 DRM_ERROR("Invalid crtc %d\n", crtc);
680                 return -EINVAL;
681         }
682
683         /* Scanout position query not supported? Should not happen. */
684         if (!dev->driver->get_scanout_position) {
685                 DRM_ERROR("Called from driver w/o get_scanout_position()!?\n");
686                 return -EIO;
687         }
688
689         /* Durations of frames, lines, pixels in nanoseconds. */
690         framedur_ns = refcrtc->framedur_ns;
691         linedur_ns  = refcrtc->linedur_ns;
692         pixeldur_ns = refcrtc->pixeldur_ns;
693
694         /* If mode timing undefined, just return as no-op:
695          * Happens during initial modesetting of a crtc.
696          */
697         if (framedur_ns == 0) {
698                 DRM_DEBUG("crtc %d: Noop due to uninitialized mode.\n", crtc);
699                 return -EAGAIN;
700         }
701
702         /* Get current scanout position with system timestamp.
703          * Repeat query up to DRM_TIMESTAMP_MAXRETRIES times
704          * if single query takes longer than max_error nanoseconds.
705          *
706          * This guarantees a tight bound on maximum error if
707          * code gets preempted or delayed for some reason.
708          */
709         for (i = 0; i < DRM_TIMESTAMP_MAXRETRIES; i++) {
710                 /*
711                  * Get vertical and horizontal scanout position vpos, hpos,
712                  * and bounding timestamps stime, etime, pre/post query.
713                  */
714                 vbl_status = dev->driver->get_scanout_position(dev, crtc, flags, &vpos,
715                                                                &hpos, &stime, &etime);
716
717                 /* Return as no-op if scanout query unsupported or failed. */
718                 if (!(vbl_status & DRM_SCANOUTPOS_VALID)) {
719                         DRM_DEBUG("crtc %d : scanoutpos query failed [%d].\n",
720                                   crtc, vbl_status);
721                         return -EIO;
722                 }
723
724                 /* Compute uncertainty in timestamp of scanout position query. */
725                 duration_ns = ktime_to_ns(etime) - ktime_to_ns(stime);
726
727                 /* Accept result with <  max_error nsecs timing uncertainty. */
728                 if (duration_ns <= *max_error)
729                         break;
730         }
731
732         /* Noisy system timing? */
733         if (i == DRM_TIMESTAMP_MAXRETRIES) {
734                 DRM_DEBUG("crtc %d: Noisy timestamp %d us > %d us [%d reps].\n",
735                           crtc, duration_ns/1000, *max_error/1000, i);
736         }
737
738         /* Return upper bound of timestamp precision error. */
739         *max_error = duration_ns;
740
741         /* Check if in vblank area:
742          * vpos is >=0 in video scanout area, but negative
743          * within vblank area, counting down the number of lines until
744          * start of scanout.
745          */
746         invbl = vbl_status & DRM_SCANOUTPOS_IN_VBLANK;
747
748         /* Convert scanout position into elapsed time at raw_time query
749          * since start of scanout at first display scanline. delta_ns
750          * can be negative if start of scanout hasn't happened yet.
751          */
752         delta_ns = vpos * linedur_ns + hpos * pixeldur_ns;
753
754         if (!drm_timestamp_monotonic)
755                 etime = ktime_mono_to_real(etime);
756
757         /* save this only for debugging purposes */
758         tv_etime = ktime_to_timeval(etime);
759         /* Subtract time delta from raw timestamp to get final
760          * vblank_time timestamp for end of vblank.
761          */
762         if (delta_ns < 0)
763                 etime = ktime_add_ns(etime, -delta_ns);
764         else
765                 etime = ktime_sub_ns(etime, delta_ns);
766         *vblank_time = ktime_to_timeval(etime);
767
768         DRM_DEBUG("crtc %d : v %d p(%d,%d)@ %ld.%ld -> %ld.%ld [e %d us, %d rep]\n",
769                   crtc, (int)vbl_status, hpos, vpos,
770                   (long)tv_etime.tv_sec, (long)tv_etime.tv_usec,
771                   (long)vblank_time->tv_sec, (long)vblank_time->tv_usec,
772                   duration_ns/1000, i);
773
774         vbl_status = DRM_VBLANKTIME_SCANOUTPOS_METHOD;
775         if (invbl)
776                 vbl_status |= DRM_VBLANKTIME_IN_VBLANK;
777
778         return vbl_status;
779 }
780 EXPORT_SYMBOL(drm_calc_vbltimestamp_from_scanoutpos);
781
782 static struct timeval get_drm_timestamp(void)
783 {
784         ktime_t now;
785
786         now = drm_timestamp_monotonic ? ktime_get() : ktime_get_real();
787         return ktime_to_timeval(now);
788 }
789
790 /**
791  * drm_get_last_vbltimestamp - retrieve raw timestamp for the most recent
792  *                             vblank interval
793  * @dev: DRM device
794  * @crtc: which CRTC's vblank timestamp to retrieve
795  * @tvblank: Pointer to target struct timeval which should receive the timestamp
796  * @flags: Flags to pass to driver:
797  *         0 = Default,
798  *         DRM_CALLED_FROM_VBLIRQ = If function is called from vbl IRQ handler
799  *
800  * Fetches the system timestamp corresponding to the time of the most recent
801  * vblank interval on specified CRTC. May call into kms-driver to
802  * compute the timestamp with a high-precision GPU specific method.
803  *
804  * Returns zero if timestamp originates from uncorrected do_gettimeofday()
805  * call, i.e., it isn't very precisely locked to the true vblank.
806  *
807  * Returns:
808  * True if timestamp is considered to be very precise, false otherwise.
809  */
810 static bool
811 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
812                           struct timeval *tvblank, unsigned flags)
813 {
814         int ret;
815
816         /* Define requested maximum error on timestamps (nanoseconds). */
817         int max_error = (int) drm_timestamp_precision * 1000;
818
819         /* Query driver if possible and precision timestamping enabled. */
820         if (dev->driver->get_vblank_timestamp && (max_error > 0)) {
821                 ret = dev->driver->get_vblank_timestamp(dev, crtc, &max_error,
822                                                         tvblank, flags);
823                 if (ret > 0)
824                         return true;
825         }
826
827         /* GPU high precision timestamp query unsupported or failed.
828          * Return current monotonic/gettimeofday timestamp as best estimate.
829          */
830         *tvblank = get_drm_timestamp();
831
832         return false;
833 }
834
835 /**
836  * drm_vblank_count - retrieve "cooked" vblank counter value
837  * @dev: DRM device
838  * @crtc: which counter to retrieve
839  *
840  * Fetches the "cooked" vblank count value that represents the number of
841  * vblank events since the system was booted, including lost events due to
842  * modesetting activity.
843  *
844  * This is the legacy version of drm_crtc_vblank_count().
845  *
846  * Returns:
847  * The software vblank counter.
848  */
849 u32 drm_vblank_count(struct drm_device *dev, int crtc)
850 {
851         struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
852
853         if (WARN_ON(crtc >= dev->num_crtcs))
854                 return 0;
855         return atomic_read(&vblank->count);
856 }
857 EXPORT_SYMBOL(drm_vblank_count);
858
859 /**
860  * drm_crtc_vblank_count - retrieve "cooked" vblank counter value
861  * @crtc: which counter to retrieve
862  *
863  * Fetches the "cooked" vblank count value that represents the number of
864  * vblank events since the system was booted, including lost events due to
865  * modesetting activity.
866  *
867  * This is the native KMS version of drm_vblank_count().
868  *
869  * Returns:
870  * The software vblank counter.
871  */
872 u32 drm_crtc_vblank_count(struct drm_crtc *crtc)
873 {
874         return drm_vblank_count(crtc->dev, drm_crtc_index(crtc));
875 }
876 EXPORT_SYMBOL(drm_crtc_vblank_count);
877
878 /**
879  * drm_vblank_count_and_time - retrieve "cooked" vblank counter value
880  * and the system timestamp corresponding to that vblank counter value.
881  *
882  * @dev: DRM device
883  * @crtc: which counter to retrieve
884  * @vblanktime: Pointer to struct timeval to receive the vblank timestamp.
885  *
886  * Fetches the "cooked" vblank count value that represents the number of
887  * vblank events since the system was booted, including lost events due to
888  * modesetting activity. Returns corresponding system timestamp of the time
889  * of the vblank interval that corresponds to the current vblank counter value.
890  */
891 u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
892                               struct timeval *vblanktime)
893 {
894         struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
895         u32 cur_vblank;
896
897         if (WARN_ON(crtc >= dev->num_crtcs))
898                 return 0;
899
900         /* Read timestamp from slot of _vblank_time ringbuffer
901          * that corresponds to current vblank count. Retry if
902          * count has incremented during readout. This works like
903          * a seqlock.
904          */
905         do {
906                 cur_vblank = atomic_read(&vblank->count);
907                 *vblanktime = vblanktimestamp(dev, crtc, cur_vblank);
908                 smp_rmb();
909         } while (cur_vblank != atomic_read(&vblank->count));
910
911         return cur_vblank;
912 }
913 EXPORT_SYMBOL(drm_vblank_count_and_time);
914
915 static void send_vblank_event(struct drm_device *dev,
916                 struct drm_pending_vblank_event *e,
917                 unsigned long seq, struct timeval *now)
918 {
919         WARN_ON_SMP(!spin_is_locked(&dev->event_lock));
920         e->event.sequence = seq;
921         e->event.tv_sec = now->tv_sec;
922         e->event.tv_usec = now->tv_usec;
923
924         list_add_tail(&e->base.link,
925                       &e->base.file_priv->event_list);
926         wake_up_interruptible(&e->base.file_priv->event_wait);
927         trace_drm_vblank_event_delivered(e->base.pid, e->pipe,
928                                          e->event.sequence);
929 }
930
931 /**
932  * drm_send_vblank_event - helper to send vblank event after pageflip
933  * @dev: DRM device
934  * @crtc: CRTC in question
935  * @e: the event to send
936  *
937  * Updates sequence # and timestamp on event, and sends it to userspace.
938  * Caller must hold event lock.
939  *
940  * This is the legacy version of drm_crtc_send_vblank_event().
941  */
942 void drm_send_vblank_event(struct drm_device *dev, int crtc,
943                 struct drm_pending_vblank_event *e)
944 {
945         struct timeval now;
946         unsigned int seq;
947
948         if (crtc >= 0) {
949                 seq = drm_vblank_count_and_time(dev, crtc, &now);
950         } else {
951                 seq = 0;
952
953                 now = get_drm_timestamp();
954         }
955         e->pipe = crtc;
956         send_vblank_event(dev, e, seq, &now);
957 }
958 EXPORT_SYMBOL(drm_send_vblank_event);
959
960 /**
961  * drm_crtc_send_vblank_event - helper to send vblank event after pageflip
962  * @crtc: the source CRTC of the vblank event
963  * @e: the event to send
964  *
965  * Updates sequence # and timestamp on event, and sends it to userspace.
966  * Caller must hold event lock.
967  *
968  * This is the native KMS version of drm_send_vblank_event().
969  */
970 void drm_crtc_send_vblank_event(struct drm_crtc *crtc,
971                                 struct drm_pending_vblank_event *e)
972 {
973         drm_send_vblank_event(crtc->dev, drm_crtc_index(crtc), e);
974 }
975 EXPORT_SYMBOL(drm_crtc_send_vblank_event);
976
977 /**
978  * drm_vblank_enable - enable the vblank interrupt on a CRTC
979  * @dev: DRM device
980  * @crtc: CRTC in question
981  */
982 static int drm_vblank_enable(struct drm_device *dev, int crtc)
983 {
984         struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
985         int ret = 0;
986
987         assert_spin_locked(&dev->vbl_lock);
988
989         spin_lock(&dev->vblank_time_lock);
990
991         if (!vblank->enabled) {
992                 /*
993                  * Enable vblank irqs under vblank_time_lock protection.
994                  * All vblank count & timestamp updates are held off
995                  * until we are done reinitializing master counter and
996                  * timestamps. Filtercode in drm_handle_vblank() will
997                  * prevent double-accounting of same vblank interval.
998                  */
999                 ret = dev->driver->enable_vblank(dev, crtc);
1000                 DRM_DEBUG("enabling vblank on crtc %d, ret: %d\n", crtc, ret);
1001                 if (ret)
1002                         atomic_dec(&vblank->refcount);
1003                 else {
1004                         vblank->enabled = true;
1005                         drm_update_vblank_count(dev, crtc);
1006                 }
1007         }
1008
1009         spin_unlock(&dev->vblank_time_lock);
1010
1011         return ret;
1012 }
1013
1014 /**
1015  * drm_vblank_get - get a reference count on vblank events
1016  * @dev: DRM device
1017  * @crtc: which CRTC to own
1018  *
1019  * Acquire a reference count on vblank events to avoid having them disabled
1020  * while in use.
1021  *
1022  * This is the legacy version of drm_crtc_vblank_get().
1023  *
1024  * Returns:
1025  * Zero on success, nonzero on failure.
1026  */
1027 int drm_vblank_get(struct drm_device *dev, int crtc)
1028 {
1029         struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
1030         unsigned long irqflags;
1031         int ret = 0;
1032
1033         if (WARN_ON(crtc >= dev->num_crtcs))
1034                 return -EINVAL;
1035
1036         spin_lock_irqsave(&dev->vbl_lock, irqflags);
1037         /* Going from 0->1 means we have to enable interrupts again */
1038         if (atomic_add_return(1, &vblank->refcount) == 1) {
1039                 ret = drm_vblank_enable(dev, crtc);
1040         } else {
1041                 if (!vblank->enabled) {
1042                         atomic_dec(&vblank->refcount);
1043                         ret = -EINVAL;
1044                 }
1045         }
1046         spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
1047
1048         return ret;
1049 }
1050 EXPORT_SYMBOL(drm_vblank_get);
1051
1052 /**
1053  * drm_crtc_vblank_get - get a reference count on vblank events
1054  * @crtc: which CRTC to own
1055  *
1056  * Acquire a reference count on vblank events to avoid having them disabled
1057  * while in use.
1058  *
1059  * This is the native kms version of drm_vblank_get().
1060  *
1061  * Returns:
1062  * Zero on success, nonzero on failure.
1063  */
1064 int drm_crtc_vblank_get(struct drm_crtc *crtc)
1065 {
1066         return drm_vblank_get(crtc->dev, drm_crtc_index(crtc));
1067 }
1068 EXPORT_SYMBOL(drm_crtc_vblank_get);
1069
1070 /**
1071  * drm_vblank_put - give up ownership of vblank events
1072  * @dev: DRM device
1073  * @crtc: which counter to give up
1074  *
1075  * Release ownership of a given vblank counter, turning off interrupts
1076  * if possible. Disable interrupts after drm_vblank_offdelay milliseconds.
1077  *
1078  * This is the legacy version of drm_crtc_vblank_put().
1079  */
1080 void drm_vblank_put(struct drm_device *dev, int crtc)
1081 {
1082         struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
1083
1084         if (WARN_ON(atomic_read(&vblank->refcount) == 0))
1085                 return;
1086
1087         if (WARN_ON(crtc >= dev->num_crtcs))
1088                 return;
1089
1090         /* Last user schedules interrupt disable */
1091         if (atomic_dec_and_test(&vblank->refcount)) {
1092                 if (drm_vblank_offdelay == 0)
1093                         return;
1094                 else if (dev->vblank_disable_immediate || drm_vblank_offdelay < 0)
1095                         vblank_disable_fn((unsigned long)vblank);
1096                 else
1097                         mod_timer(&vblank->disable_timer,
1098                                   jiffies + ((drm_vblank_offdelay * HZ)/1000));
1099         }
1100 }
1101 EXPORT_SYMBOL(drm_vblank_put);
1102
1103 /**
1104  * drm_crtc_vblank_put - give up ownership of vblank events
1105  * @crtc: which counter to give up
1106  *
1107  * Release ownership of a given vblank counter, turning off interrupts
1108  * if possible. Disable interrupts after drm_vblank_offdelay milliseconds.
1109  *
1110  * This is the native kms version of drm_vblank_put().
1111  */
1112 void drm_crtc_vblank_put(struct drm_crtc *crtc)
1113 {
1114         drm_vblank_put(crtc->dev, drm_crtc_index(crtc));
1115 }
1116 EXPORT_SYMBOL(drm_crtc_vblank_put);
1117
1118 /**
1119  * drm_wait_one_vblank - wait for one vblank
1120  * @dev: DRM device
1121  * @crtc: crtc index
1122  *
1123  * This waits for one vblank to pass on @crtc, using the irq driver interfaces.
1124  * It is a failure to call this when the vblank irq for @crtc is disabled, e.g.
1125  * due to lack of driver support or because the crtc is off.
1126  */
1127 void drm_wait_one_vblank(struct drm_device *dev, int crtc)
1128 {
1129         int ret;
1130         u32 last;
1131
1132         ret = drm_vblank_get(dev, crtc);
1133         if (WARN(ret, "vblank not available on crtc %i, ret=%i\n", crtc, ret))
1134                 return;
1135
1136         last = drm_vblank_count(dev, crtc);
1137
1138         ret = wait_event_timeout(dev->vblank[crtc].queue,
1139                                  last != drm_vblank_count(dev, crtc),
1140                                  msecs_to_jiffies(100));
1141
1142         WARN(ret == 0, "vblank wait timed out on crtc %i\n", crtc);
1143
1144         drm_vblank_put(dev, crtc);
1145 }
1146 EXPORT_SYMBOL(drm_wait_one_vblank);
1147
1148 /**
1149  * drm_crtc_wait_one_vblank - wait for one vblank
1150  * @crtc: DRM crtc
1151  *
1152  * This waits for one vblank to pass on @crtc, using the irq driver interfaces.
1153  * It is a failure to call this when the vblank irq for @crtc is disabled, e.g.
1154  * due to lack of driver support or because the crtc is off.
1155  */
1156 void drm_crtc_wait_one_vblank(struct drm_crtc *crtc)
1157 {
1158         drm_wait_one_vblank(crtc->dev, drm_crtc_index(crtc));
1159 }
1160 EXPORT_SYMBOL(drm_crtc_wait_one_vblank);
1161
1162 /**
1163  * drm_vblank_off - disable vblank events on a CRTC
1164  * @dev: DRM device
1165  * @crtc: CRTC in question
1166  *
1167  * Drivers can use this function to shut down the vblank interrupt handling when
1168  * disabling a crtc. This function ensures that the latest vblank frame count is
1169  * stored so that drm_vblank_on() can restore it again.
1170  *
1171  * Drivers must use this function when the hardware vblank counter can get
1172  * reset, e.g. when suspending.
1173  *
1174  * This is the legacy version of drm_crtc_vblank_off().
1175  */
1176 void drm_vblank_off(struct drm_device *dev, int crtc)
1177 {
1178         struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
1179         struct drm_pending_vblank_event *e, *t;
1180         struct timeval now;
1181         unsigned long irqflags;
1182         unsigned int seq;
1183
1184         if (WARN_ON(crtc >= dev->num_crtcs))
1185                 return;
1186
1187         spin_lock_irqsave(&dev->event_lock, irqflags);
1188
1189         spin_lock(&dev->vbl_lock);
1190         vblank_disable_and_save(dev, crtc);
1191         wake_up(&vblank->queue);
1192
1193         /*
1194          * Prevent subsequent drm_vblank_get() from re-enabling
1195          * the vblank interrupt by bumping the refcount.
1196          */
1197         if (!vblank->inmodeset) {
1198                 atomic_inc(&vblank->refcount);
1199                 vblank->inmodeset = 1;
1200         }
1201         spin_unlock(&dev->vbl_lock);
1202
1203         /* Send any queued vblank events, lest the natives grow disquiet */
1204         seq = drm_vblank_count_and_time(dev, crtc, &now);
1205
1206         list_for_each_entry_safe(e, t, &dev->vblank_event_list, base.link) {
1207                 if (e->pipe != crtc)
1208                         continue;
1209                 DRM_DEBUG("Sending premature vblank event on disable: \
1210                           wanted %d, current %d\n",
1211                           e->event.sequence, seq);
1212                 list_del(&e->base.link);
1213                 drm_vblank_put(dev, e->pipe);
1214                 send_vblank_event(dev, e, seq, &now);
1215         }
1216         spin_unlock_irqrestore(&dev->event_lock, irqflags);
1217 }
1218 EXPORT_SYMBOL(drm_vblank_off);
1219
1220 /**
1221  * drm_crtc_vblank_off - disable vblank events on a CRTC
1222  * @crtc: CRTC in question
1223  *
1224  * Drivers can use this function to shut down the vblank interrupt handling when
1225  * disabling a crtc. This function ensures that the latest vblank frame count is
1226  * stored so that drm_vblank_on can restore it again.
1227  *
1228  * Drivers must use this function when the hardware vblank counter can get
1229  * reset, e.g. when suspending.
1230  *
1231  * This is the native kms version of drm_vblank_off().
1232  */
1233 void drm_crtc_vblank_off(struct drm_crtc *crtc)
1234 {
1235         drm_vblank_off(crtc->dev, drm_crtc_index(crtc));
1236 }
1237 EXPORT_SYMBOL(drm_crtc_vblank_off);
1238
1239 /**
1240  * drm_crtc_vblank_reset - reset vblank state to off on a CRTC
1241  * @crtc: CRTC in question
1242  *
1243  * Drivers can use this function to reset the vblank state to off at load time.
1244  * Drivers should use this together with the drm_crtc_vblank_off() and
1245  * drm_crtc_vblank_on() functions. The difference compared to
1246  * drm_crtc_vblank_off() is that this function doesn't save the vblank counter
1247  * and hence doesn't need to call any driver hooks.
1248  */
1249 void drm_crtc_vblank_reset(struct drm_crtc *drm_crtc)
1250 {
1251         struct drm_device *dev = drm_crtc->dev;
1252         unsigned long irqflags;
1253         int crtc = drm_crtc_index(drm_crtc);
1254         struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
1255
1256         spin_lock_irqsave(&dev->vbl_lock, irqflags);
1257         /*
1258          * Prevent subsequent drm_vblank_get() from enabling the vblank
1259          * interrupt by bumping the refcount.
1260          */
1261         if (!vblank->inmodeset) {
1262                 atomic_inc(&vblank->refcount);
1263                 vblank->inmodeset = 1;
1264         }
1265         spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
1266
1267         WARN_ON(!list_empty(&dev->vblank_event_list));
1268 }
1269 EXPORT_SYMBOL(drm_crtc_vblank_reset);
1270
1271 /**
1272  * drm_vblank_on - enable vblank events on a CRTC
1273  * @dev: DRM device
1274  * @crtc: CRTC in question
1275  *
1276  * This functions restores the vblank interrupt state captured with
1277  * drm_vblank_off() again. Note that calls to drm_vblank_on() and
1278  * drm_vblank_off() can be unbalanced and so can also be unconditionally called
1279  * in driver load code to reflect the current hardware state of the crtc.
1280  *
1281  * This is the legacy version of drm_crtc_vblank_on().
1282  */
1283 void drm_vblank_on(struct drm_device *dev, int crtc)
1284 {
1285         struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
1286         unsigned long irqflags;
1287
1288         if (WARN_ON(crtc >= dev->num_crtcs))
1289                 return;
1290
1291         spin_lock_irqsave(&dev->vbl_lock, irqflags);
1292         /* Drop our private "prevent drm_vblank_get" refcount */
1293         if (vblank->inmodeset) {
1294                 atomic_dec(&vblank->refcount);
1295                 vblank->inmodeset = 0;
1296         }
1297
1298         /*
1299          * sample the current counter to avoid random jumps
1300          * when drm_vblank_enable() applies the diff
1301          *
1302          * -1 to make sure user will never see the same
1303          * vblank counter value before and after a modeset
1304          */
1305         vblank->last =
1306                 (dev->driver->get_vblank_counter(dev, crtc) - 1) &
1307                 dev->max_vblank_count;
1308         /*
1309          * re-enable interrupts if there are users left, or the
1310          * user wishes vblank interrupts to be enabled all the time.
1311          */
1312         if (atomic_read(&vblank->refcount) != 0 ||
1313             (!dev->vblank_disable_immediate && drm_vblank_offdelay == 0))
1314                 WARN_ON(drm_vblank_enable(dev, crtc));
1315         spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
1316 }
1317 EXPORT_SYMBOL(drm_vblank_on);
1318
1319 /**
1320  * drm_crtc_vblank_on - enable vblank events on a CRTC
1321  * @crtc: CRTC in question
1322  *
1323  * This functions restores the vblank interrupt state captured with
1324  * drm_vblank_off() again. Note that calls to drm_vblank_on() and
1325  * drm_vblank_off() can be unbalanced and so can also be unconditionally called
1326  * in driver load code to reflect the current hardware state of the crtc.
1327  *
1328  * This is the native kms version of drm_vblank_on().
1329  */
1330 void drm_crtc_vblank_on(struct drm_crtc *crtc)
1331 {
1332         drm_vblank_on(crtc->dev, drm_crtc_index(crtc));
1333 }
1334 EXPORT_SYMBOL(drm_crtc_vblank_on);
1335
1336 /**
1337  * drm_vblank_pre_modeset - account for vblanks across mode sets
1338  * @dev: DRM device
1339  * @crtc: CRTC in question
1340  *
1341  * Account for vblank events across mode setting events, which will likely
1342  * reset the hardware frame counter.
1343  *
1344  * This is done by grabbing a temporary vblank reference to ensure that the
1345  * vblank interrupt keeps running across the modeset sequence. With this the
1346  * software-side vblank frame counting will ensure that there are no jumps or
1347  * discontinuities.
1348  *
1349  * Unfortunately this approach is racy and also doesn't work when the vblank
1350  * interrupt stops running, e.g. across system suspend resume. It is therefore
1351  * highly recommended that drivers use the newer drm_vblank_off() and
1352  * drm_vblank_on() instead. drm_vblank_pre_modeset() only works correctly when
1353  * using "cooked" software vblank frame counters and not relying on any hardware
1354  * counters.
1355  *
1356  * Drivers must call drm_vblank_post_modeset() when re-enabling the same crtc
1357  * again.
1358  */
1359 void drm_vblank_pre_modeset(struct drm_device *dev, int crtc)
1360 {
1361         struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
1362
1363         /* vblank is not initialized (IRQ not installed ?), or has been freed */
1364         if (!dev->num_crtcs)
1365                 return;
1366
1367         if (WARN_ON(crtc >= dev->num_crtcs))
1368                 return;
1369
1370         /*
1371          * To avoid all the problems that might happen if interrupts
1372          * were enabled/disabled around or between these calls, we just
1373          * have the kernel take a reference on the CRTC (just once though
1374          * to avoid corrupting the count if multiple, mismatch calls occur),
1375          * so that interrupts remain enabled in the interim.
1376          */
1377         if (!vblank->inmodeset) {
1378                 vblank->inmodeset = 0x1;
1379                 if (drm_vblank_get(dev, crtc) == 0)
1380                         vblank->inmodeset |= 0x2;
1381         }
1382 }
1383 EXPORT_SYMBOL(drm_vblank_pre_modeset);
1384
1385 /**
1386  * drm_vblank_post_modeset - undo drm_vblank_pre_modeset changes
1387  * @dev: DRM device
1388  * @crtc: CRTC in question
1389  *
1390  * This function again drops the temporary vblank reference acquired in
1391  * drm_vblank_pre_modeset.
1392  */
1393 void drm_vblank_post_modeset(struct drm_device *dev, int crtc)
1394 {
1395         struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
1396         unsigned long irqflags;
1397
1398         /* vblank is not initialized (IRQ not installed ?), or has been freed */
1399         if (!dev->num_crtcs)
1400                 return;
1401
1402         if (vblank->inmodeset) {
1403                 spin_lock_irqsave(&dev->vbl_lock, irqflags);
1404                 dev->vblank_disable_allowed = true;
1405                 spin_unlock_irqrestore(&dev->vbl_lock, irqflags);
1406
1407                 if (vblank->inmodeset & 0x2)
1408                         drm_vblank_put(dev, crtc);
1409
1410                 vblank->inmodeset = 0;
1411         }
1412 }
1413 EXPORT_SYMBOL(drm_vblank_post_modeset);
1414
1415 /*
1416  * drm_modeset_ctl - handle vblank event counter changes across mode switch
1417  * @DRM_IOCTL_ARGS: standard ioctl arguments
1418  *
1419  * Applications should call the %_DRM_PRE_MODESET and %_DRM_POST_MODESET
1420  * ioctls around modesetting so that any lost vblank events are accounted for.
1421  *
1422  * Generally the counter will reset across mode sets.  If interrupts are
1423  * enabled around this call, we don't have to do anything since the counter
1424  * will have already been incremented.
1425  */
1426 int drm_modeset_ctl(struct drm_device *dev, void *data,
1427                     struct drm_file *file_priv)
1428 {
1429         struct drm_modeset_ctl *modeset = data;
1430         unsigned int crtc;
1431
1432         /* If drm_vblank_init() hasn't been called yet, just no-op */
1433         if (!dev->num_crtcs)
1434                 return 0;
1435
1436         /* KMS drivers handle this internally */
1437         if (drm_core_check_feature(dev, DRIVER_MODESET))
1438                 return 0;
1439
1440         crtc = modeset->crtc;
1441         if (crtc >= dev->num_crtcs)
1442                 return -EINVAL;
1443
1444         switch (modeset->cmd) {
1445         case _DRM_PRE_MODESET:
1446                 drm_vblank_pre_modeset(dev, crtc);
1447                 break;
1448         case _DRM_POST_MODESET:
1449                 drm_vblank_post_modeset(dev, crtc);
1450                 break;
1451         default:
1452                 return -EINVAL;
1453         }
1454
1455         return 0;
1456 }
1457
1458 static int drm_queue_vblank_event(struct drm_device *dev, int pipe,
1459                                   union drm_wait_vblank *vblwait,
1460                                   struct drm_file *file_priv)
1461 {
1462         struct drm_vblank_crtc *vblank = &dev->vblank[pipe];
1463         struct drm_pending_vblank_event *e;
1464         struct timeval now;
1465         unsigned long flags;
1466         unsigned int seq;
1467         int ret;
1468
1469         e = kzalloc(sizeof(*e), GFP_KERNEL);
1470         if (e == NULL) {
1471                 ret = -ENOMEM;
1472                 goto err_put;
1473         }
1474
1475         e->pipe = pipe;
1476         e->base.pid = current->pid;
1477         e->event.base.type = DRM_EVENT_VBLANK;
1478         e->event.base.length = sizeof(e->event);
1479         e->event.user_data = vblwait->request.signal;
1480         e->base.event = &e->event.base;
1481         e->base.file_priv = file_priv;
1482         e->base.destroy = (void (*) (struct drm_pending_event *)) kfree;
1483
1484         spin_lock_irqsave(&dev->event_lock, flags);
1485
1486         /*
1487          * drm_vblank_off() might have been called after we called
1488          * drm_vblank_get(). drm_vblank_off() holds event_lock
1489          * around the vblank disable, so no need for further locking.
1490          * The reference from drm_vblank_get() protects against
1491          * vblank disable from another source.
1492          */
1493         if (!vblank->enabled) {
1494                 ret = -EINVAL;
1495                 goto err_unlock;
1496         }
1497
1498         if (file_priv->event_space < sizeof(e->event)) {
1499                 ret = -EBUSY;
1500                 goto err_unlock;
1501         }
1502
1503         file_priv->event_space -= sizeof(e->event);
1504         seq = drm_vblank_count_and_time(dev, pipe, &now);
1505
1506         if ((vblwait->request.type & _DRM_VBLANK_NEXTONMISS) &&
1507             (seq - vblwait->request.sequence) <= (1 << 23)) {
1508                 vblwait->request.sequence = seq + 1;
1509                 vblwait->reply.sequence = vblwait->request.sequence;
1510         }
1511
1512         DRM_DEBUG("event on vblank count %d, current %d, crtc %d\n",
1513                   vblwait->request.sequence, seq, pipe);
1514
1515         trace_drm_vblank_event_queued(current->pid, pipe,
1516                                       vblwait->request.sequence);
1517
1518         e->event.sequence = vblwait->request.sequence;
1519         if ((seq - vblwait->request.sequence) <= (1 << 23)) {
1520                 drm_vblank_put(dev, pipe);
1521                 send_vblank_event(dev, e, seq, &now);
1522                 vblwait->reply.sequence = seq;
1523         } else {
1524                 /* drm_handle_vblank_events will call drm_vblank_put */
1525                 list_add_tail(&e->base.link, &dev->vblank_event_list);
1526                 vblwait->reply.sequence = vblwait->request.sequence;
1527         }
1528
1529         spin_unlock_irqrestore(&dev->event_lock, flags);
1530
1531         return 0;
1532
1533 err_unlock:
1534         spin_unlock_irqrestore(&dev->event_lock, flags);
1535         kfree(e);
1536 err_put:
1537         drm_vblank_put(dev, pipe);
1538         return ret;
1539 }
1540
1541 /*
1542  * Wait for VBLANK.
1543  *
1544  * \param inode device inode.
1545  * \param file_priv DRM file private.
1546  * \param cmd command.
1547  * \param data user argument, pointing to a drm_wait_vblank structure.
1548  * \return zero on success or a negative number on failure.
1549  *
1550  * This function enables the vblank interrupt on the pipe requested, then
1551  * sleeps waiting for the requested sequence number to occur, and drops
1552  * the vblank interrupt refcount afterwards. (vblank IRQ disable follows that
1553  * after a timeout with no further vblank waits scheduled).
1554  */
1555 int drm_wait_vblank(struct drm_device *dev, void *data,
1556                     struct drm_file *file_priv)
1557 {
1558         struct drm_vblank_crtc *vblank;
1559         union drm_wait_vblank *vblwait = data;
1560         int ret;
1561         unsigned int flags, seq, crtc, high_crtc;
1562
1563         if (!dev->irq_enabled)
1564                 return -EINVAL;
1565
1566         if (vblwait->request.type & _DRM_VBLANK_SIGNAL)
1567                 return -EINVAL;
1568
1569         if (vblwait->request.type &
1570             ~(_DRM_VBLANK_TYPES_MASK | _DRM_VBLANK_FLAGS_MASK |
1571               _DRM_VBLANK_HIGH_CRTC_MASK)) {
1572                 DRM_ERROR("Unsupported type value 0x%x, supported mask 0x%x\n",
1573                           vblwait->request.type,
1574                           (_DRM_VBLANK_TYPES_MASK | _DRM_VBLANK_FLAGS_MASK |
1575                            _DRM_VBLANK_HIGH_CRTC_MASK));
1576                 return -EINVAL;
1577         }
1578
1579         flags = vblwait->request.type & _DRM_VBLANK_FLAGS_MASK;
1580         high_crtc = (vblwait->request.type & _DRM_VBLANK_HIGH_CRTC_MASK);
1581         if (high_crtc)
1582                 crtc = high_crtc >> _DRM_VBLANK_HIGH_CRTC_SHIFT;
1583         else
1584                 crtc = flags & _DRM_VBLANK_SECONDARY ? 1 : 0;
1585         if (crtc >= dev->num_crtcs)
1586                 return -EINVAL;
1587
1588         vblank = &dev->vblank[crtc];
1589
1590         ret = drm_vblank_get(dev, crtc);
1591         if (ret) {
1592                 DRM_DEBUG("failed to acquire vblank counter, %d\n", ret);
1593                 return ret;
1594         }
1595         seq = drm_vblank_count(dev, crtc);
1596
1597         switch (vblwait->request.type & _DRM_VBLANK_TYPES_MASK) {
1598         case _DRM_VBLANK_RELATIVE:
1599                 vblwait->request.sequence += seq;
1600                 vblwait->request.type &= ~_DRM_VBLANK_RELATIVE;
1601         case _DRM_VBLANK_ABSOLUTE:
1602                 break;
1603         default:
1604                 ret = -EINVAL;
1605                 goto done;
1606         }
1607
1608         if (flags & _DRM_VBLANK_EVENT) {
1609                 /* must hold on to the vblank ref until the event fires
1610                  * drm_vblank_put will be called asynchronously
1611                  */
1612                 return drm_queue_vblank_event(dev, crtc, vblwait, file_priv);
1613         }
1614
1615         if ((flags & _DRM_VBLANK_NEXTONMISS) &&
1616             (seq - vblwait->request.sequence) <= (1<<23)) {
1617                 vblwait->request.sequence = seq + 1;
1618         }
1619
1620         DRM_DEBUG("waiting on vblank count %d, crtc %d\n",
1621                   vblwait->request.sequence, crtc);
1622         vblank->last_wait = vblwait->request.sequence;
1623         DRM_WAIT_ON(ret, vblank->queue, 3 * HZ,
1624                     (((drm_vblank_count(dev, crtc) -
1625                        vblwait->request.sequence) <= (1 << 23)) ||
1626                      !vblank->enabled ||
1627                      !dev->irq_enabled));
1628
1629         if (ret != -EINTR) {
1630                 struct timeval now;
1631
1632                 vblwait->reply.sequence = drm_vblank_count_and_time(dev, crtc, &now);
1633                 vblwait->reply.tval_sec = now.tv_sec;
1634                 vblwait->reply.tval_usec = now.tv_usec;
1635
1636                 DRM_DEBUG("returning %d to client\n",
1637                           vblwait->reply.sequence);
1638         } else {
1639                 DRM_DEBUG("vblank wait interrupted by signal\n");
1640         }
1641
1642 done:
1643         drm_vblank_put(dev, crtc);
1644         return ret;
1645 }
1646
1647 static void drm_handle_vblank_events(struct drm_device *dev, int crtc)
1648 {
1649         struct drm_pending_vblank_event *e, *t;
1650         struct timeval now;
1651         unsigned int seq;
1652
1653         assert_spin_locked(&dev->event_lock);
1654
1655         seq = drm_vblank_count_and_time(dev, crtc, &now);
1656
1657         list_for_each_entry_safe(e, t, &dev->vblank_event_list, base.link) {
1658                 if (e->pipe != crtc)
1659                         continue;
1660                 if ((seq - e->event.sequence) > (1<<23))
1661                         continue;
1662
1663                 DRM_DEBUG("vblank event on %d, current %d\n",
1664                           e->event.sequence, seq);
1665
1666                 list_del(&e->base.link);
1667                 drm_vblank_put(dev, e->pipe);
1668                 send_vblank_event(dev, e, seq, &now);
1669         }
1670
1671         trace_drm_vblank_event(crtc, seq);
1672 }
1673
1674 /**
1675  * drm_handle_vblank - handle a vblank event
1676  * @dev: DRM device
1677  * @crtc: where this event occurred
1678  *
1679  * Drivers should call this routine in their vblank interrupt handlers to
1680  * update the vblank counter and send any signals that may be pending.
1681  *
1682  * This is the legacy version of drm_crtc_handle_vblank().
1683  */
1684 bool drm_handle_vblank(struct drm_device *dev, int crtc)
1685 {
1686         struct drm_vblank_crtc *vblank = &dev->vblank[crtc];
1687         u32 vblcount;
1688         s64 diff_ns;
1689         struct timeval tvblank;
1690         unsigned long irqflags;
1691
1692         if (WARN_ON_ONCE(!dev->num_crtcs))
1693                 return false;
1694
1695         if (WARN_ON(crtc >= dev->num_crtcs))
1696                 return false;
1697
1698         spin_lock_irqsave(&dev->event_lock, irqflags);
1699
1700         /* Need timestamp lock to prevent concurrent execution with
1701          * vblank enable/disable, as this would cause inconsistent
1702          * or corrupted timestamps and vblank counts.
1703          */
1704         spin_lock(&dev->vblank_time_lock);
1705
1706         /* Vblank irq handling disabled. Nothing to do. */
1707         if (!vblank->enabled) {
1708                 spin_unlock(&dev->vblank_time_lock);
1709                 spin_unlock_irqrestore(&dev->event_lock, irqflags);
1710                 return false;
1711         }
1712
1713         /* Fetch corresponding timestamp for this vblank interval from
1714          * driver and store it in proper slot of timestamp ringbuffer.
1715          */
1716
1717         /* Get current timestamp and count. */
1718         vblcount = atomic_read(&vblank->count);
1719         drm_get_last_vbltimestamp(dev, crtc, &tvblank, DRM_CALLED_FROM_VBLIRQ);
1720
1721         /* Compute time difference to timestamp of last vblank */
1722         diff_ns = timeval_to_ns(&tvblank) -
1723                   timeval_to_ns(&vblanktimestamp(dev, crtc, vblcount));
1724
1725         /* Update vblank timestamp and count if at least
1726          * DRM_REDUNDANT_VBLIRQ_THRESH_NS nanoseconds
1727          * difference between last stored timestamp and current
1728          * timestamp. A smaller difference means basically
1729          * identical timestamps. Happens if this vblank has
1730          * been already processed and this is a redundant call,
1731          * e.g., due to spurious vblank interrupts. We need to
1732          * ignore those for accounting.
1733          */
1734         if (abs64(diff_ns) > DRM_REDUNDANT_VBLIRQ_THRESH_NS) {
1735                 /* Store new timestamp in ringbuffer. */
1736                 vblanktimestamp(dev, crtc, vblcount + 1) = tvblank;
1737
1738                 /* Increment cooked vblank count. This also atomically commits
1739                  * the timestamp computed above.
1740                  */
1741                 smp_mb__before_atomic();
1742                 atomic_inc(&vblank->count);
1743                 smp_mb__after_atomic();
1744         } else {
1745                 DRM_DEBUG("crtc %d: Redundant vblirq ignored. diff_ns = %d\n",
1746                           crtc, (int) diff_ns);
1747         }
1748
1749         spin_unlock(&dev->vblank_time_lock);
1750
1751         wake_up(&vblank->queue);
1752         drm_handle_vblank_events(dev, crtc);
1753
1754         spin_unlock_irqrestore(&dev->event_lock, irqflags);
1755
1756         return true;
1757 }
1758 EXPORT_SYMBOL(drm_handle_vblank);
1759
1760 /**
1761  * drm_crtc_handle_vblank - handle a vblank event
1762  * @crtc: where this event occurred
1763  *
1764  * Drivers should call this routine in their vblank interrupt handlers to
1765  * update the vblank counter and send any signals that may be pending.
1766  *
1767  * This is the native KMS version of drm_handle_vblank().
1768  *
1769  * Returns:
1770  * True if the event was successfully handled, false on failure.
1771  */
1772 bool drm_crtc_handle_vblank(struct drm_crtc *crtc)
1773 {
1774         return drm_handle_vblank(crtc->dev, drm_crtc_index(crtc));
1775 }
1776 EXPORT_SYMBOL(drm_crtc_handle_vblank);