1 /* 2 * Copyright 2016 Intel Corp. 3 * 4 * Permission is hereby granted, free of charge, to any person obtaining a 5 * copy of this software and associated documentation files (the "Software"), 6 * to deal in the Software without restriction, including without limitation 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 * and/or sell copies of the Software, and to permit persons to whom the 9 * Software is furnished to do so, subject to the following conditions: 10 * 11 * The above copyright notice and this permission notice (including the next 12 * paragraph) shall be included in all copies or substantial portions of the 13 * Software. 14 * 15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 18 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR 19 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 20 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 21 * OTHER DEALINGS IN THE SOFTWARE. 22 */ 23 24 #ifndef _DRM_VBLANK_H_ 25 #define _DRM_VBLANK_H_ 26 27 #include <linux/seqlock.h> 28 #include <linux/idr.h> 29 #include <linux/poll.h> 30 31 #include <drm/drm_file.h> 32 #include <drm/drm_modes.h> 33 #include <uapi/drm/drm.h> 34 35 struct drm_device; 36 struct drm_crtc; 37 38 /** 39 * struct drm_pending_vblank_event - pending vblank event tracking 40 */ 41 struct drm_pending_vblank_event { 42 /** 43 * @base: Base structure for tracking pending DRM events. 44 */ 45 struct drm_pending_event base; 46 /** 47 * @pipe: drm_crtc_index() of the &drm_crtc this event is for. 48 */ 49 unsigned int pipe; 50 /** 51 * @sequence: frame event should be triggered at 52 */ 53 u64 sequence; 54 /** 55 * @event: Actual event which will be sent to userspace. 56 */ 57 struct drm_event_vblank event; 58 }; 59 60 /** 61 * struct drm_vblank_crtc - vblank tracking for a CRTC 62 * 63 * This structure tracks the vblank state for one CRTC. 64 * 65 * Note that for historical reasons - the vblank handling code is still shared 66 * with legacy/non-kms drivers - this is a free-standing structure not directly 67 * connected to &struct drm_crtc. But all public interface functions are taking 68 * a &struct drm_crtc to hide this implementation detail. 69 */ 70 struct drm_vblank_crtc { 71 /** 72 * @dev: Pointer to the &drm_device. 73 */ 74 struct drm_device *dev; 75 /** 76 * @queue: Wait queue for vblank waiters. 77 */ 78 wait_queue_head_t queue; /**< VBLANK wait queue */ 79 /** 80 * @disable_timer: Disable timer for the delayed vblank disabling 81 * hysteresis logic. Vblank disabling is controlled through the 82 * drm_vblank_offdelay module option and the setting of the 83 * &drm_device.max_vblank_count value. 84 */ 85 struct timer_list disable_timer; 86 87 /** 88 * @seqlock: Protect vblank count and time. 89 */ 90 seqlock_t seqlock; /* protects vblank count and time */ 91 92 /** 93 * @count: Current software vblank counter. 94 */ 95 u64 count; 96 /** 97 * @time: Vblank timestamp corresponding to @count. 98 */ 99 ktime_t time; 100 101 /** 102 * @refcount: Number of users/waiters of the vblank interrupt. Only when 103 * this refcount reaches 0 can the hardware interrupt be disabled using 104 * @disable_timer. 105 */ 106 atomic_t refcount; /* number of users of vblank interruptsper crtc */ 107 /** 108 * @last: Protected by &drm_device.vbl_lock, used for wraparound handling. 109 */ 110 u32 last; 111 /** 112 * @inmodeset: Tracks whether the vblank is disabled due to a modeset. 113 * For legacy driver bit 2 additionally tracks whether an additional 114 * temporary vblank reference has been acquired to paper over the 115 * hardware counter resetting/jumping. KMS drivers should instead just 116 * call drm_crtc_vblank_off() and drm_crtc_vblank_on(), which explicitly 117 * save and restore the vblank count. 118 */ 119 unsigned int inmodeset; /* Display driver is setting mode */ 120 /** 121 * @pipe: drm_crtc_index() of the &drm_crtc corresponding to this 122 * structure. 123 */ 124 unsigned int pipe; 125 /** 126 * @framedur_ns: Frame/Field duration in ns, used by 127 * drm_calc_vbltimestamp_from_scanoutpos() and computed by 128 * drm_calc_timestamping_constants(). 129 */ 130 int framedur_ns; 131 /** 132 * @linedur_ns: Line duration in ns, used by 133 * drm_calc_vbltimestamp_from_scanoutpos() and computed by 134 * drm_calc_timestamping_constants(). 135 */ 136 int linedur_ns; 137 138 /** 139 * @hwmode: 140 * 141 * Cache of the current hardware display mode. Only valid when @enabled 142 * is set. This is used by helpers like 143 * drm_calc_vbltimestamp_from_scanoutpos(). We can't just access the 144 * hardware mode by e.g. looking at &drm_crtc_state.adjusted_mode, 145 * because that one is really hard to get from interrupt context. 146 */ 147 struct drm_display_mode hwmode; 148 149 /** 150 * @enabled: Tracks the enabling state of the corresponding &drm_crtc to 151 * avoid double-disabling and hence corrupting saved state. Needed by 152 * drivers not using atomic KMS, since those might go through their CRTC 153 * disabling functions multiple times. 154 */ 155 bool enabled; 156 }; 157 158 int drm_vblank_init(struct drm_device *dev, unsigned int num_crtcs); 159 u64 drm_crtc_vblank_count(struct drm_crtc *crtc); 160 u64 drm_crtc_vblank_count_and_time(struct drm_crtc *crtc, 161 ktime_t *vblanktime); 162 void drm_crtc_send_vblank_event(struct drm_crtc *crtc, 163 struct drm_pending_vblank_event *e); 164 void drm_crtc_arm_vblank_event(struct drm_crtc *crtc, 165 struct drm_pending_vblank_event *e); 166 bool drm_handle_vblank(struct drm_device *dev, unsigned int pipe); 167 bool drm_crtc_handle_vblank(struct drm_crtc *crtc); 168 int drm_crtc_vblank_get(struct drm_crtc *crtc); 169 void drm_crtc_vblank_put(struct drm_crtc *crtc); 170 void drm_wait_one_vblank(struct drm_device *dev, unsigned int pipe); 171 void drm_crtc_wait_one_vblank(struct drm_crtc *crtc); 172 void drm_crtc_vblank_off(struct drm_crtc *crtc); 173 void drm_crtc_vblank_reset(struct drm_crtc *crtc); 174 void drm_crtc_vblank_on(struct drm_crtc *crtc); 175 u32 drm_crtc_accurate_vblank_count(struct drm_crtc *crtc); 176 177 bool drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev, 178 unsigned int pipe, int *max_error, 179 ktime_t *vblank_time, 180 bool in_vblank_irq); 181 void drm_calc_timestamping_constants(struct drm_crtc *crtc, 182 const struct drm_display_mode *mode); 183 wait_queue_head_t *drm_crtc_vblank_waitqueue(struct drm_crtc *crtc); 184 #endif 185