drm/i915: Update to Linux 3.17
[dragonfly.git] / sys / dev / drm / i915 / i915_drv.h
1 /* i915_drv.h -- Private header for the I915 driver -*- linux-c -*-
2  */
3 /*
4  *
5  * Copyright 2003 Tungsten Graphics, Inc., Cedar Park, Texas.
6  * All Rights Reserved.
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining a
9  * copy of this software and associated documentation files (the
10  * "Software"), to deal in the Software without restriction, including
11  * without limitation the rights to use, copy, modify, merge, publish,
12  * distribute, sub license, and/or sell copies of the Software, and to
13  * permit persons to whom the Software is furnished to do so, subject to
14  * the following conditions:
15  *
16  * The above copyright notice and this permission notice (including the
17  * next paragraph) shall be included in all copies or substantial portions
18  * of the Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
21  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
23  * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
24  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
25  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
26  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27  *
28  */
29
30 #ifndef _I915_DRV_H_
31 #define _I915_DRV_H_
32
33 #include <uapi_drm/i915_drm.h>
34
35 #include "i915_reg.h"
36 #include "intel_bios.h"
37 #include "intel_ringbuffer.h"
38 #include "i915_gem_gtt.h"
39 #include <linux/io-mapping.h>
40 #include <linux/i2c.h>
41 #include <drm/intel-gtt.h>
42 #include <linux/backlight.h>
43 #include <linux/hashtable.h>
44 #include <linux/kref.h>
45 #include <linux/kconfig.h>
46 #include <linux/pm_qos.h>
47 #include <linux/seq_file.h>
48 #include <linux/delay.h>
49
50 #define CONFIG_ACPI 1
51
52 /* General customization:
53  */
54
55 #define DRIVER_AUTHOR           "Tungsten Graphics, Inc."
56
57 #define DRIVER_NAME             "i915"
58 #define DRIVER_DESC             "Intel Graphics"
59 #define DRIVER_DATE             "20140725"
60
61 enum i915_pipe {
62         INVALID_PIPE = -1,
63         PIPE_A = 0,
64         PIPE_B,
65         PIPE_C,
66         _PIPE_EDP,
67         I915_MAX_PIPES = _PIPE_EDP
68 };
69 #define pipe_name(p) ((p) + 'A')
70
71 enum transcoder {
72         TRANSCODER_A = 0,
73         TRANSCODER_B,
74         TRANSCODER_C,
75         TRANSCODER_EDP,
76         I915_MAX_TRANSCODERS
77 };
78 #define transcoder_name(t) ((t) + 'A')
79
80 enum plane {
81         PLANE_A = 0,
82         PLANE_B,
83         PLANE_C,
84 };
85 #define plane_name(p) ((p) + 'A')
86
87 #define sprite_name(p, s) ((p) * INTEL_INFO(dev)->num_sprites[(p)] + (s) + 'A')
88
89 enum port {
90         PORT_A = 0,
91         PORT_B,
92         PORT_C,
93         PORT_D,
94         PORT_E,
95         I915_MAX_PORTS
96 };
97 #define port_name(p) ((p) + 'A')
98
99 #define I915_NUM_PHYS_VLV 2
100
101 enum dpio_channel {
102         DPIO_CH0,
103         DPIO_CH1
104 };
105
106 enum dpio_phy {
107         DPIO_PHY0,
108         DPIO_PHY1
109 };
110
111 enum intel_display_power_domain {
112         POWER_DOMAIN_PIPE_A,
113         POWER_DOMAIN_PIPE_B,
114         POWER_DOMAIN_PIPE_C,
115         POWER_DOMAIN_PIPE_A_PANEL_FITTER,
116         POWER_DOMAIN_PIPE_B_PANEL_FITTER,
117         POWER_DOMAIN_PIPE_C_PANEL_FITTER,
118         POWER_DOMAIN_TRANSCODER_A,
119         POWER_DOMAIN_TRANSCODER_B,
120         POWER_DOMAIN_TRANSCODER_C,
121         POWER_DOMAIN_TRANSCODER_EDP,
122         POWER_DOMAIN_PORT_DDI_A_2_LANES,
123         POWER_DOMAIN_PORT_DDI_A_4_LANES,
124         POWER_DOMAIN_PORT_DDI_B_2_LANES,
125         POWER_DOMAIN_PORT_DDI_B_4_LANES,
126         POWER_DOMAIN_PORT_DDI_C_2_LANES,
127         POWER_DOMAIN_PORT_DDI_C_4_LANES,
128         POWER_DOMAIN_PORT_DDI_D_2_LANES,
129         POWER_DOMAIN_PORT_DDI_D_4_LANES,
130         POWER_DOMAIN_PORT_DSI,
131         POWER_DOMAIN_PORT_CRT,
132         POWER_DOMAIN_PORT_OTHER,
133         POWER_DOMAIN_VGA,
134         POWER_DOMAIN_AUDIO,
135         POWER_DOMAIN_PLLS,
136         POWER_DOMAIN_INIT,
137
138         POWER_DOMAIN_NUM,
139 };
140
141 #define POWER_DOMAIN_PIPE(pipe) ((pipe) + POWER_DOMAIN_PIPE_A)
142 #define POWER_DOMAIN_PIPE_PANEL_FITTER(pipe) \
143                 ((pipe) + POWER_DOMAIN_PIPE_A_PANEL_FITTER)
144 #define POWER_DOMAIN_TRANSCODER(tran) \
145         ((tran) == TRANSCODER_EDP ? POWER_DOMAIN_TRANSCODER_EDP : \
146          (tran) + POWER_DOMAIN_TRANSCODER_A)
147
148 enum hpd_pin {
149         HPD_NONE = 0,
150         HPD_PORT_A = HPD_NONE, /* PORT_A is internal */
151         HPD_TV = HPD_NONE,     /* TV is known to be unreliable */
152         HPD_CRT,
153         HPD_SDVO_B,
154         HPD_SDVO_C,
155         HPD_PORT_B,
156         HPD_PORT_C,
157         HPD_PORT_D,
158         HPD_NUM_PINS
159 };
160
161 #define I915_GEM_GPU_DOMAINS \
162         (I915_GEM_DOMAIN_RENDER | \
163          I915_GEM_DOMAIN_SAMPLER | \
164          I915_GEM_DOMAIN_COMMAND | \
165          I915_GEM_DOMAIN_INSTRUCTION | \
166          I915_GEM_DOMAIN_VERTEX)
167
168 #define for_each_pipe(p) for ((p) = 0; (p) < INTEL_INFO(dev)->num_pipes; (p)++)
169 #define for_each_sprite(p, s) for ((s) = 0; (s) < INTEL_INFO(dev)->num_sprites[(p)]; (s)++)
170
171 #define for_each_crtc(dev, crtc) \
172         list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
173
174 #define for_each_intel_crtc(dev, intel_crtc) \
175         list_for_each_entry(intel_crtc, &dev->mode_config.crtc_list, base.head)
176
177 #define for_each_encoder_on_crtc(dev, __crtc, intel_encoder) \
178         list_for_each_entry((intel_encoder), &(dev)->mode_config.encoder_list, base.head) \
179                 if ((intel_encoder)->base.crtc == (__crtc))
180
181 #define for_each_connector_on_encoder(dev, __encoder, intel_connector) \
182         list_for_each_entry((intel_connector), &(dev)->mode_config.connector_list, base.head) \
183                 if ((intel_connector)->base.encoder == (__encoder))
184
185 #define for_each_power_domain(domain, mask)                             \
186         for ((domain) = 0; (domain) < POWER_DOMAIN_NUM; (domain)++)     \
187                 if ((1 << (domain)) & (mask))
188
189 struct drm_i915_private;
190 struct i915_mmu_object;
191
192 enum intel_dpll_id {
193         DPLL_ID_PRIVATE = -1, /* non-shared dpll in use */
194         /* real shared dpll ids must be >= 0 */
195         DPLL_ID_PCH_PLL_A = 0,
196         DPLL_ID_PCH_PLL_B = 1,
197         DPLL_ID_WRPLL1 = 0,
198         DPLL_ID_WRPLL2 = 1,
199 };
200 #define I915_NUM_PLLS 2
201
202 struct intel_dpll_hw_state {
203         uint32_t dpll;
204         uint32_t dpll_md;
205         uint32_t fp0;
206         uint32_t fp1;
207         uint32_t wrpll;
208 };
209
210 struct intel_shared_dpll {
211         int refcount; /* count of number of CRTCs sharing this PLL */
212         int active; /* count of number of active CRTCs (i.e. DPMS on) */
213         bool on; /* is the PLL actually active? Disabled during modeset */
214         const char *name;
215         /* should match the index in the dev_priv->shared_dplls array */
216         enum intel_dpll_id id;
217         struct intel_dpll_hw_state hw_state;
218         /* The mode_set hook is optional and should be used together with the
219          * intel_prepare_shared_dpll function. */
220         void (*mode_set)(struct drm_i915_private *dev_priv,
221                          struct intel_shared_dpll *pll);
222         void (*enable)(struct drm_i915_private *dev_priv,
223                        struct intel_shared_dpll *pll);
224         void (*disable)(struct drm_i915_private *dev_priv,
225                         struct intel_shared_dpll *pll);
226         bool (*get_hw_state)(struct drm_i915_private *dev_priv,
227                              struct intel_shared_dpll *pll,
228                              struct intel_dpll_hw_state *hw_state);
229 };
230
231 /* Used by dp and fdi links */
232 struct intel_link_m_n {
233         uint32_t        tu;
234         uint32_t        gmch_m;
235         uint32_t        gmch_n;
236         uint32_t        link_m;
237         uint32_t        link_n;
238 };
239
240 void intel_link_compute_m_n(int bpp, int nlanes,
241                             int pixel_clock, int link_clock,
242                             struct intel_link_m_n *m_n);
243
244 /* Interface history:
245  *
246  * 1.1: Original.
247  * 1.2: Add Power Management
248  * 1.3: Add vblank support
249  * 1.4: Fix cmdbuffer path, add heap destroy
250  * 1.5: Add vblank pipe configuration
251  * 1.6: - New ioctl for scheduling buffer swaps on vertical blank
252  *      - Support vertical blank on secondary display pipe
253  */
254 #define DRIVER_MAJOR            1
255 #define DRIVER_MINOR            6
256 #define DRIVER_PATCHLEVEL       0
257
258 #define WATCH_LISTS     0
259 #define WATCH_GTT       0
260
261 struct opregion_header;
262 struct opregion_acpi;
263 struct opregion_swsci;
264 struct opregion_asle;
265
266 struct intel_opregion {
267         struct opregion_header __iomem *header;
268         struct opregion_acpi __iomem *acpi;
269         struct opregion_swsci __iomem *swsci;
270         u32 swsci_gbda_sub_functions;
271         u32 swsci_sbcb_sub_functions;
272         struct opregion_asle __iomem *asle;
273         void __iomem *vbt;
274         u32 __iomem *lid_state;
275         struct work_struct asle_work;
276 };
277 #define OPREGION_SIZE            (8*1024)
278
279 struct intel_overlay;
280 struct intel_overlay_error_state;
281
282 struct drm_i915_master_private {
283         drm_local_map_t *sarea;
284         struct _drm_i915_sarea *sarea_priv;
285 };
286 #define I915_FENCE_REG_NONE -1
287 #define I915_MAX_NUM_FENCES 32
288 /* 32 fences + sign bit for FENCE_REG_NONE */
289 #define I915_MAX_NUM_FENCE_BITS 6
290
291 struct drm_i915_fence_reg {
292         struct list_head lru_list;
293         struct drm_i915_gem_object *obj;
294         int pin_count;
295 };
296
297 struct sdvo_device_mapping {
298         u8 initialized;
299         u8 dvo_port;
300         u8 slave_addr;
301         u8 dvo_wiring;
302         u8 i2c_pin;
303         u8 ddc_pin;
304 };
305
306 struct intel_display_error_state;
307
308 struct drm_i915_error_state {
309         struct kref ref;
310         struct timeval time;
311
312         char error_msg[128];
313         u32 reset_count;
314         u32 suspend_count;
315
316         /* Generic register state */
317         u32 eir;
318         u32 pgtbl_er;
319         u32 ier;
320         u32 gtier[4];
321         u32 ccid;
322         u32 derrmr;
323         u32 forcewake;
324         u32 error; /* gen6+ */
325         u32 err_int; /* gen7 */
326         u32 done_reg;
327         u32 gac_eco;
328         u32 gam_ecochk;
329         u32 gab_ctl;
330         u32 gfx_mode;
331         u32 extra_instdone[I915_NUM_INSTDONE_REG];
332         u64 fence[I915_MAX_NUM_FENCES];
333         struct intel_overlay_error_state *overlay;
334         struct intel_display_error_state *display;
335         struct drm_i915_error_object *semaphore_obj;
336
337         struct drm_i915_error_ring {
338                 bool valid;
339                 /* Software tracked state */
340                 bool waiting;
341                 int hangcheck_score;
342                 enum intel_ring_hangcheck_action hangcheck_action;
343                 int num_requests;
344
345                 /* our own tracking of ring head and tail */
346                 u32 cpu_ring_head;
347                 u32 cpu_ring_tail;
348
349                 u32 semaphore_seqno[I915_NUM_RINGS - 1];
350
351                 /* Register state */
352                 u32 tail;
353                 u32 head;
354                 u32 ctl;
355                 u32 hws;
356                 u32 ipeir;
357                 u32 ipehr;
358                 u32 instdone;
359                 u32 bbstate;
360                 u32 instpm;
361                 u32 instps;
362                 u32 seqno;
363                 u64 bbaddr;
364                 u64 acthd;
365                 u32 fault_reg;
366                 u64 faddr;
367                 u32 rc_psmi; /* sleep state */
368                 u32 semaphore_mboxes[I915_NUM_RINGS - 1];
369
370                 struct drm_i915_error_object {
371                         int page_count;
372                         u32 gtt_offset;
373                         u32 *pages[0];
374                 } *ringbuffer, *batchbuffer, *wa_batchbuffer, *ctx, *hws_page;
375
376                 struct drm_i915_error_request {
377                         long jiffies;
378                         u32 seqno;
379                         u32 tail;
380                 } *requests;
381
382                 struct {
383                         u32 gfx_mode;
384                         union {
385                                 u64 pdp[4];
386                                 u32 pp_dir_base;
387                         };
388                 } vm_info;
389
390                 pid_t pid;
391                 char comm[TASK_COMM_LEN];
392         } ring[I915_NUM_RINGS];
393         struct drm_i915_error_buffer {
394                 u32 size;
395                 u32 name;
396                 u32 rseqno, wseqno;
397                 u32 gtt_offset;
398                 u32 read_domains;
399                 u32 write_domain;
400                 s32 fence_reg:I915_MAX_NUM_FENCE_BITS;
401                 s32 pinned:2;
402                 u32 tiling:2;
403                 u32 dirty:1;
404                 u32 purgeable:1;
405                 u32 userptr:1;
406                 s32 ring:4;
407                 u32 cache_level:3;
408         } **active_bo, **pinned_bo;
409
410         u32 *active_bo_count, *pinned_bo_count;
411 };
412
413 struct intel_connector;
414 struct intel_crtc_config;
415 struct intel_plane_config;
416 struct intel_crtc;
417 struct intel_limit;
418 struct dpll;
419
420 struct drm_i915_display_funcs {
421         bool (*fbc_enabled)(struct drm_device *dev);
422         void (*enable_fbc)(struct drm_crtc *crtc);
423         void (*disable_fbc)(struct drm_device *dev);
424         int (*get_display_clock_speed)(struct drm_device *dev);
425         int (*get_fifo_size)(struct drm_device *dev, int plane);
426         /**
427          * find_dpll() - Find the best values for the PLL
428          * @limit: limits for the PLL
429          * @crtc: current CRTC
430          * @target: target frequency in kHz
431          * @refclk: reference clock frequency in kHz
432          * @match_clock: if provided, @best_clock P divider must
433          *               match the P divider from @match_clock
434          *               used for LVDS downclocking
435          * @best_clock: best PLL values found
436          *
437          * Returns true on success, false on failure.
438          */
439         bool (*find_dpll)(const struct intel_limit *limit,
440                           struct drm_crtc *crtc,
441                           int target, int refclk,
442                           struct dpll *match_clock,
443                           struct dpll *best_clock);
444         void (*update_wm)(struct drm_crtc *crtc);
445         void (*update_sprite_wm)(struct drm_plane *plane,
446                                  struct drm_crtc *crtc,
447                                  uint32_t sprite_width, uint32_t sprite_height,
448                                  int pixel_size, bool enable, bool scaled);
449         void (*modeset_global_resources)(struct drm_device *dev);
450         /* Returns the active state of the crtc, and if the crtc is active,
451          * fills out the pipe-config with the hw state. */
452         bool (*get_pipe_config)(struct intel_crtc *,
453                                 struct intel_crtc_config *);
454         void (*get_plane_config)(struct intel_crtc *,
455                                  struct intel_plane_config *);
456         int (*crtc_mode_set)(struct drm_crtc *crtc,
457                              int x, int y,
458                              struct drm_framebuffer *old_fb);
459         void (*crtc_enable)(struct drm_crtc *crtc);
460         void (*crtc_disable)(struct drm_crtc *crtc);
461         void (*off)(struct drm_crtc *crtc);
462         void (*write_eld)(struct drm_connector *connector,
463                           struct drm_crtc *crtc,
464                           struct drm_display_mode *mode);
465         void (*fdi_link_train)(struct drm_crtc *crtc);
466         void (*init_clock_gating)(struct drm_device *dev);
467         int (*queue_flip)(struct drm_device *dev, struct drm_crtc *crtc,
468                           struct drm_framebuffer *fb,
469                           struct drm_i915_gem_object *obj,
470                           struct intel_engine_cs *ring,
471                           uint32_t flags);
472         void (*update_primary_plane)(struct drm_crtc *crtc,
473                                      struct drm_framebuffer *fb,
474                                      int x, int y);
475         void (*hpd_irq_setup)(struct drm_device *dev);
476         /* clock updates for mode set */
477         /* cursor updates */
478         /* render clock increase/decrease */
479         /* display clock increase/decrease */
480         /* pll clock increase/decrease */
481
482         int (*setup_backlight)(struct intel_connector *connector);
483         uint32_t (*get_backlight)(struct intel_connector *connector);
484         void (*set_backlight)(struct intel_connector *connector,
485                               uint32_t level);
486         void (*disable_backlight)(struct intel_connector *connector);
487         void (*enable_backlight)(struct intel_connector *connector);
488 };
489
490 struct intel_uncore_funcs {
491         void (*force_wake_get)(struct drm_i915_private *dev_priv,
492                                                         int fw_engine);
493         void (*force_wake_put)(struct drm_i915_private *dev_priv,
494                                                         int fw_engine);
495
496         uint8_t  (*mmio_readb)(struct drm_i915_private *dev_priv, off_t offset, bool trace);
497         uint16_t (*mmio_readw)(struct drm_i915_private *dev_priv, off_t offset, bool trace);
498         uint32_t (*mmio_readl)(struct drm_i915_private *dev_priv, off_t offset, bool trace);
499         uint64_t (*mmio_readq)(struct drm_i915_private *dev_priv, off_t offset, bool trace);
500
501         void (*mmio_writeb)(struct drm_i915_private *dev_priv, off_t offset,
502                                 uint8_t val, bool trace);
503         void (*mmio_writew)(struct drm_i915_private *dev_priv, off_t offset,
504                                 uint16_t val, bool trace);
505         void (*mmio_writel)(struct drm_i915_private *dev_priv, off_t offset,
506                                 uint32_t val, bool trace);
507         void (*mmio_writeq)(struct drm_i915_private *dev_priv, off_t offset,
508                                 uint64_t val, bool trace);
509 };
510
511 struct intel_uncore {
512         struct lock lock; /** lock is also taken in irq contexts. */
513
514         struct intel_uncore_funcs funcs;
515
516         unsigned fifo_count;
517         unsigned forcewake_count;
518
519         unsigned fw_rendercount;
520         unsigned fw_mediacount;
521
522         struct timer_list force_wake_timer;
523 };
524
525 #define DEV_INFO_FOR_EACH_FLAG(func, sep) \
526         func(is_mobile) sep \
527         func(is_i85x) sep \
528         func(is_i915g) sep \
529         func(is_i945gm) sep \
530         func(is_g33) sep \
531         func(need_gfx_hws) sep \
532         func(is_g4x) sep \
533         func(is_pineview) sep \
534         func(is_broadwater) sep \
535         func(is_crestline) sep \
536         func(is_ivybridge) sep \
537         func(is_valleyview) sep \
538         func(is_haswell) sep \
539         func(is_preliminary) sep \
540         func(has_fbc) sep \
541         func(has_pipe_cxsr) sep \
542         func(has_hotplug) sep \
543         func(cursor_needs_physical) sep \
544         func(has_overlay) sep \
545         func(overlay_needs_physical) sep \
546         func(supports_tv) sep \
547         func(has_llc) sep \
548         func(has_ddi) sep \
549         func(has_fpga_dbg)
550
551 #define DEFINE_FLAG(name) u8 name:1
552 #define SEP_SEMICOLON ;
553
554 struct intel_device_info {
555         u32 display_mmio_offset;
556         u8 num_pipes:3;
557         u8 num_sprites[I915_MAX_PIPES];
558         u8 gen;
559         u8 ring_mask; /* Rings supported by the HW */
560         DEV_INFO_FOR_EACH_FLAG(DEFINE_FLAG, SEP_SEMICOLON);
561         /* Register offsets for the various display pipes and transcoders */
562         int pipe_offsets[I915_MAX_TRANSCODERS];
563         int trans_offsets[I915_MAX_TRANSCODERS];
564         int palette_offsets[I915_MAX_PIPES];
565         int cursor_offsets[I915_MAX_PIPES];
566 };
567
568 #undef DEFINE_FLAG
569 #undef SEP_SEMICOLON
570
571 enum i915_cache_level {
572         I915_CACHE_NONE = 0,
573         I915_CACHE_LLC, /* also used for snoopable memory on non-LLC */
574         I915_CACHE_L3_LLC, /* gen7+, L3 sits between the domain specifc
575                               caches, eg sampler/render caches, and the
576                               large Last-Level-Cache. LLC is coherent with
577                               the CPU, but L3 is only visible to the GPU. */
578         I915_CACHE_WT, /* hsw:gt3e WriteThrough for scanouts */
579 };
580
581 struct i915_ctx_hang_stats {
582         /* This context had batch pending when hang was declared */
583         unsigned batch_pending;
584
585         /* This context had batch active when hang was declared */
586         unsigned batch_active;
587
588         /* Time when this context was last blamed for a GPU reset */
589         unsigned long guilty_ts;
590
591         /* This context is banned to submit more work */
592         bool banned;
593 };
594
595 /* This must match up with the value previously used for execbuf2.rsvd1. */
596 #define DEFAULT_CONTEXT_HANDLE 0
597 /**
598  * struct intel_context - as the name implies, represents a context.
599  * @ref: reference count.
600  * @user_handle: userspace tracking identity for this context.
601  * @remap_slice: l3 row remapping information.
602  * @file_priv: filp associated with this context (NULL for global default
603  *             context).
604  * @hang_stats: information about the role of this context in possible GPU
605  *              hangs.
606  * @vm: virtual memory space used by this context.
607  * @legacy_hw_ctx: render context backing object and whether it is correctly
608  *                initialized (legacy ring submission mechanism only).
609  * @link: link in the global list of contexts.
610  *
611  * Contexts are memory images used by the hardware to store copies of their
612  * internal state.
613  */
614 struct intel_context {
615         struct kref ref;
616         int user_handle;
617         uint8_t remap_slice;
618         struct drm_i915_file_private *file_priv;
619         struct i915_ctx_hang_stats hang_stats;
620         struct i915_address_space *vm;
621
622         struct {
623                 struct drm_i915_gem_object *rcs_state;
624                 bool initialized;
625         } legacy_hw_ctx;
626
627         struct list_head link;
628 };
629
630 struct i915_fbc {
631         unsigned long size;
632         unsigned threshold;
633         unsigned int fb_id;
634         enum plane plane;
635         int y;
636
637         struct drm_mm_node compressed_fb;
638         struct drm_mm_node *compressed_llb;
639
640         struct intel_fbc_work {
641                 struct delayed_work work;
642                 struct drm_crtc *crtc;
643                 struct drm_framebuffer *fb;
644         } *fbc_work;
645
646         enum no_fbc_reason {
647                 FBC_OK, /* FBC is enabled */
648                 FBC_UNSUPPORTED, /* FBC is not supported by this chipset */
649                 FBC_NO_OUTPUT, /* no outputs enabled to compress */
650                 FBC_STOLEN_TOO_SMALL, /* not enough space for buffers */
651                 FBC_UNSUPPORTED_MODE, /* interlace or doublescanned mode */
652                 FBC_MODE_TOO_LARGE, /* mode too large for compression */
653                 FBC_BAD_PLANE, /* fbc not supported on plane */
654                 FBC_NOT_TILED, /* buffer not tiled */
655                 FBC_MULTIPLE_PIPES, /* more than one pipe active */
656                 FBC_MODULE_PARAM,
657                 FBC_CHIP_DEFAULT, /* disabled by default on this chip */
658         } no_fbc_reason;
659 };
660
661 struct i915_drrs {
662         struct intel_connector *connector;
663 };
664
665 struct intel_dp;
666 struct i915_psr {
667         struct lock lock;
668         bool sink_support;
669         bool source_ok;
670         struct intel_dp *enabled;
671         bool active;
672         struct delayed_work work;
673         unsigned busy_frontbuffer_bits;
674 };
675
676 enum intel_pch {
677         PCH_NONE = 0,   /* No PCH present */
678         PCH_IBX,        /* Ibexpeak PCH */
679         PCH_CPT,        /* Cougarpoint PCH */
680         PCH_LPT,        /* Lynxpoint PCH */
681         PCH_NOP,
682 };
683
684 enum intel_sbi_destination {
685         SBI_ICLK,
686         SBI_MPHY,
687 };
688
689 #define QUIRK_PIPEA_FORCE (1<<0)
690 #define QUIRK_LVDS_SSC_DISABLE (1<<1)
691 #define QUIRK_INVERT_BRIGHTNESS (1<<2)
692 #define QUIRK_BACKLIGHT_PRESENT (1<<3)
693
694 struct intel_fbdev;
695 struct intel_fbc_work;
696
697 struct intel_gmbus {
698         u32 force_bit;
699         u32 reg0;
700         u32 gpio_reg;
701         struct drm_i915_private *dev_priv;
702 };
703
704 struct intel_iic_softc {
705         struct drm_device *drm_dev;
706         device_t iic_dev;
707         bool force_bit_dev;
708         char name[32];
709         uint32_t reg;
710         uint32_t reg0;
711 };
712
713 struct i915_suspend_saved_registers {
714         u8 saveLBB;
715         u32 saveDSPACNTR;
716         u32 saveDSPBCNTR;
717         u32 saveDSPARB;
718         u32 savePIPEACONF;
719         u32 savePIPEBCONF;
720         u32 savePIPEASRC;
721         u32 savePIPEBSRC;
722         u32 saveFPA0;
723         u32 saveFPA1;
724         u32 saveDPLL_A;
725         u32 saveDPLL_A_MD;
726         u32 saveHTOTAL_A;
727         u32 saveHBLANK_A;
728         u32 saveHSYNC_A;
729         u32 saveVTOTAL_A;
730         u32 saveVBLANK_A;
731         u32 saveVSYNC_A;
732         u32 saveBCLRPAT_A;
733         u32 saveTRANSACONF;
734         u32 saveTRANS_HTOTAL_A;
735         u32 saveTRANS_HBLANK_A;
736         u32 saveTRANS_HSYNC_A;
737         u32 saveTRANS_VTOTAL_A;
738         u32 saveTRANS_VBLANK_A;
739         u32 saveTRANS_VSYNC_A;
740         u32 savePIPEASTAT;
741         u32 saveDSPASTRIDE;
742         u32 saveDSPASIZE;
743         u32 saveDSPAPOS;
744         u32 saveDSPAADDR;
745         u32 saveDSPASURF;
746         u32 saveDSPATILEOFF;
747         u32 savePFIT_PGM_RATIOS;
748         u32 saveBLC_HIST_CTL;
749         u32 saveBLC_PWM_CTL;
750         u32 saveBLC_PWM_CTL2;
751         u32 saveBLC_HIST_CTL_B;
752         u32 saveBLC_CPU_PWM_CTL;
753         u32 saveBLC_CPU_PWM_CTL2;
754         u32 saveFPB0;
755         u32 saveFPB1;
756         u32 saveDPLL_B;
757         u32 saveDPLL_B_MD;
758         u32 saveHTOTAL_B;
759         u32 saveHBLANK_B;
760         u32 saveHSYNC_B;
761         u32 saveVTOTAL_B;
762         u32 saveVBLANK_B;
763         u32 saveVSYNC_B;
764         u32 saveBCLRPAT_B;
765         u32 saveTRANSBCONF;
766         u32 saveTRANS_HTOTAL_B;
767         u32 saveTRANS_HBLANK_B;
768         u32 saveTRANS_HSYNC_B;
769         u32 saveTRANS_VTOTAL_B;
770         u32 saveTRANS_VBLANK_B;
771         u32 saveTRANS_VSYNC_B;
772         u32 savePIPEBSTAT;
773         u32 saveDSPBSTRIDE;
774         u32 saveDSPBSIZE;
775         u32 saveDSPBPOS;
776         u32 saveDSPBADDR;
777         u32 saveDSPBSURF;
778         u32 saveDSPBTILEOFF;
779         u32 saveVGA0;
780         u32 saveVGA1;
781         u32 saveVGA_PD;
782         u32 saveVGACNTRL;
783         u32 saveADPA;
784         u32 saveLVDS;
785         u32 savePP_ON_DELAYS;
786         u32 savePP_OFF_DELAYS;
787         u32 saveDVOA;
788         u32 saveDVOB;
789         u32 saveDVOC;
790         u32 savePP_ON;
791         u32 savePP_OFF;
792         u32 savePP_CONTROL;
793         u32 savePP_DIVISOR;
794         u32 savePFIT_CONTROL;
795         u32 save_palette_a[256];
796         u32 save_palette_b[256];
797         u32 saveFBC_CONTROL;
798         u32 saveIER;
799         u32 saveIIR;
800         u32 saveIMR;
801         u32 saveDEIER;
802         u32 saveDEIMR;
803         u32 saveGTIER;
804         u32 saveGTIMR;
805         u32 saveFDI_RXA_IMR;
806         u32 saveFDI_RXB_IMR;
807         u32 saveCACHE_MODE_0;
808         u32 saveMI_ARB_STATE;
809         u32 saveSWF0[16];
810         u32 saveSWF1[16];
811         u32 saveSWF2[3];
812         u8 saveMSR;
813         u8 saveSR[8];
814         u8 saveGR[25];
815         u8 saveAR_INDEX;
816         u8 saveAR[21];
817         u8 saveDACMASK;
818         u8 saveCR[37];
819         uint64_t saveFENCE[I915_MAX_NUM_FENCES];
820         u32 saveCURACNTR;
821         u32 saveCURAPOS;
822         u32 saveCURABASE;
823         u32 saveCURBCNTR;
824         u32 saveCURBPOS;
825         u32 saveCURBBASE;
826         u32 saveCURSIZE;
827         u32 saveDP_B;
828         u32 saveDP_C;
829         u32 saveDP_D;
830         u32 savePIPEA_GMCH_DATA_M;
831         u32 savePIPEB_GMCH_DATA_M;
832         u32 savePIPEA_GMCH_DATA_N;
833         u32 savePIPEB_GMCH_DATA_N;
834         u32 savePIPEA_DP_LINK_M;
835         u32 savePIPEB_DP_LINK_M;
836         u32 savePIPEA_DP_LINK_N;
837         u32 savePIPEB_DP_LINK_N;
838         u32 saveFDI_RXA_CTL;
839         u32 saveFDI_TXA_CTL;
840         u32 saveFDI_RXB_CTL;
841         u32 saveFDI_TXB_CTL;
842         u32 savePFA_CTL_1;
843         u32 savePFB_CTL_1;
844         u32 savePFA_WIN_SZ;
845         u32 savePFB_WIN_SZ;
846         u32 savePFA_WIN_POS;
847         u32 savePFB_WIN_POS;
848         u32 savePCH_DREF_CONTROL;
849         u32 saveDISP_ARB_CTL;
850         u32 savePIPEA_DATA_M1;
851         u32 savePIPEA_DATA_N1;
852         u32 savePIPEA_LINK_M1;
853         u32 savePIPEA_LINK_N1;
854         u32 savePIPEB_DATA_M1;
855         u32 savePIPEB_DATA_N1;
856         u32 savePIPEB_LINK_M1;
857         u32 savePIPEB_LINK_N1;
858         u32 saveMCHBAR_RENDER_STANDBY;
859         u32 savePCH_PORT_HOTPLUG;
860 };
861
862 struct vlv_s0ix_state {
863         /* GAM */
864         u32 wr_watermark;
865         u32 gfx_prio_ctrl;
866         u32 arb_mode;
867         u32 gfx_pend_tlb0;
868         u32 gfx_pend_tlb1;
869         u32 lra_limits[GEN7_LRA_LIMITS_REG_NUM];
870         u32 media_max_req_count;
871         u32 gfx_max_req_count;
872         u32 render_hwsp;
873         u32 ecochk;
874         u32 bsd_hwsp;
875         u32 blt_hwsp;
876         u32 tlb_rd_addr;
877
878         /* MBC */
879         u32 g3dctl;
880         u32 gsckgctl;
881         u32 mbctl;
882
883         /* GCP */
884         u32 ucgctl1;
885         u32 ucgctl3;
886         u32 rcgctl1;
887         u32 rcgctl2;
888         u32 rstctl;
889         u32 misccpctl;
890
891         /* GPM */
892         u32 gfxpause;
893         u32 rpdeuhwtc;
894         u32 rpdeuc;
895         u32 ecobus;
896         u32 pwrdwnupctl;
897         u32 rp_down_timeout;
898         u32 rp_deucsw;
899         u32 rcubmabdtmr;
900         u32 rcedata;
901         u32 spare2gh;
902
903         /* Display 1 CZ domain */
904         u32 gt_imr;
905         u32 gt_ier;
906         u32 pm_imr;
907         u32 pm_ier;
908         u32 gt_scratch[GEN7_GT_SCRATCH_REG_NUM];
909
910         /* GT SA CZ domain */
911         u32 tilectl;
912         u32 gt_fifoctl;
913         u32 gtlc_wake_ctrl;
914         u32 gtlc_survive;
915         u32 pmwgicz;
916
917         /* Display 2 CZ domain */
918         u32 gu_ctl0;
919         u32 gu_ctl1;
920         u32 clock_gate_dis2;
921 };
922
923 struct intel_rps_ei {
924         u32 cz_clock;
925         u32 render_c0;
926         u32 media_c0;
927 };
928
929 struct intel_gen6_power_mgmt {
930         /* work and pm_iir are protected by dev_priv->irq_lock */
931         struct work_struct work;
932         u32 pm_iir;
933
934         /* Frequencies are stored in potentially platform dependent multiples.
935          * In other words, *_freq needs to be multiplied by X to be interesting.
936          * Soft limits are those which are used for the dynamic reclocking done
937          * by the driver (raise frequencies under heavy loads, and lower for
938          * lighter loads). Hard limits are those imposed by the hardware.
939          *
940          * A distinction is made for overclocking, which is never enabled by
941          * default, and is considered to be above the hard limit if it's
942          * possible at all.
943          */
944         u8 cur_freq;            /* Current frequency (cached, may not == HW) */
945         u8 min_freq_softlimit;  /* Minimum frequency permitted by the driver */
946         u8 max_freq_softlimit;  /* Max frequency permitted by the driver */
947         u8 max_freq;            /* Maximum frequency, RP0 if not overclocking */
948         u8 min_freq;            /* AKA RPn. Minimum frequency */
949         u8 efficient_freq;      /* AKA RPe. Pre-determined balanced frequency */
950         u8 rp1_freq;            /* "less than" RP0 power/freqency */
951         u8 rp0_freq;            /* Non-overclocked max frequency. */
952         u32 cz_freq;
953
954         u32 ei_interrupt_count;
955
956         int last_adj;
957         enum { LOW_POWER, BETWEEN, HIGH_POWER } power;
958
959         bool enabled;
960         struct delayed_work delayed_resume_work;
961
962         /* manual wa residency calculations */
963         struct intel_rps_ei up_ei, down_ei;
964
965         /*
966          * Protects RPS/RC6 register access and PCU communication.
967          * Must be taken after struct_mutex if nested.
968          */
969         struct lock hw_lock;
970 };
971
972 /* defined intel_pm.c */
973 extern struct lock mchdev_lock;
974
975 struct intel_ilk_power_mgmt {
976         u8 cur_delay;
977         u8 min_delay;
978         u8 max_delay;
979         u8 fmax;
980         u8 fstart;
981
982         u64 last_count1;
983         unsigned long last_time1;
984         unsigned long chipset_power;
985         u64 last_count2;
986         struct timespec last_time2;
987         unsigned long gfx_power;
988         u8 corr;
989
990         int c_m;
991         int r_t;
992
993         struct drm_i915_gem_object *pwrctx;
994         struct drm_i915_gem_object *renderctx;
995 };
996
997 struct drm_i915_private;
998 struct i915_power_well;
999
1000 struct i915_power_well_ops {
1001         /*
1002          * Synchronize the well's hw state to match the current sw state, for
1003          * example enable/disable it based on the current refcount. Called
1004          * during driver init and resume time, possibly after first calling
1005          * the enable/disable handlers.
1006          */
1007         void (*sync_hw)(struct drm_i915_private *dev_priv,
1008                         struct i915_power_well *power_well);
1009         /*
1010          * Enable the well and resources that depend on it (for example
1011          * interrupts located on the well). Called after the 0->1 refcount
1012          * transition.
1013          */
1014         void (*enable)(struct drm_i915_private *dev_priv,
1015                        struct i915_power_well *power_well);
1016         /*
1017          * Disable the well and resources that depend on it. Called after
1018          * the 1->0 refcount transition.
1019          */
1020         void (*disable)(struct drm_i915_private *dev_priv,
1021                         struct i915_power_well *power_well);
1022         /* Returns the hw enabled state. */
1023         bool (*is_enabled)(struct drm_i915_private *dev_priv,
1024                            struct i915_power_well *power_well);
1025 };
1026
1027 /* Power well structure for haswell */
1028 struct i915_power_well {
1029         const char *name;
1030         bool always_on;
1031         /* power well enable/disable usage count */
1032         int count;
1033         /* cached hw enabled state */
1034         bool hw_enabled;
1035         unsigned long domains;
1036         unsigned long data;
1037         const struct i915_power_well_ops *ops;
1038 };
1039
1040 struct i915_power_domains {
1041         /*
1042          * Power wells needed for initialization at driver init and suspend
1043          * time are on. They are kept on until after the first modeset.
1044          */
1045         bool init_power_on;
1046         bool initializing;
1047         int power_well_count;
1048
1049         struct lock lock;
1050         int domain_use_count[POWER_DOMAIN_NUM];
1051         struct i915_power_well *power_wells;
1052 };
1053
1054 struct i915_dri1_state {
1055         unsigned allow_batchbuffer : 1;
1056         u32 __iomem *gfx_hws_cpu_addr;
1057
1058         unsigned int cpp;
1059         int back_offset;
1060         int front_offset;
1061         int current_page;
1062         int page_flipping;
1063
1064         uint32_t counter;
1065 };
1066
1067 struct i915_ums_state {
1068         /**
1069          * Flag if the X Server, and thus DRM, is not currently in
1070          * control of the device.
1071          *
1072          * This is set between LeaveVT and EnterVT.  It needs to be
1073          * replaced with a semaphore.  It also needs to be
1074          * transitioned away from for kernel modesetting.
1075          */
1076         int mm_suspended;
1077 };
1078
1079 #define MAX_L3_SLICES 2
1080 struct intel_l3_parity {
1081         u32 *remap_info[MAX_L3_SLICES];
1082         struct work_struct error_work;
1083         int which_slice;
1084 };
1085
1086 struct i915_gem_mm {
1087         /** Memory allocator for GTT stolen memory */
1088         struct drm_mm stolen;
1089         /** List of all objects in gtt_space. Used to restore gtt
1090          * mappings on resume */
1091         struct list_head bound_list;
1092         /**
1093          * List of objects which are not bound to the GTT (thus
1094          * are idle and not used by the GPU) but still have
1095          * (presumably uncached) pages still attached.
1096          */
1097         struct list_head unbound_list;
1098
1099         /** Usable portion of the GTT for GEM */
1100         unsigned long stolen_base; /* limited to low memory (32-bit) */
1101
1102         /** PPGTT used for aliasing the PPGTT with the GTT */
1103         struct i915_hw_ppgtt *aliasing_ppgtt;
1104
1105         eventhandler_tag inactive_shrinker;
1106         bool shrinker_no_lock_stealing;
1107
1108         /** LRU list of objects with fence regs on them. */
1109         struct list_head fence_list;
1110
1111         /**
1112          * We leave the user IRQ off as much as possible,
1113          * but this means that requests will finish and never
1114          * be retired once the system goes idle. Set a timer to
1115          * fire periodically while the ring is running. When it
1116          * fires, go retire requests.
1117          */
1118         struct delayed_work retire_work;
1119
1120         /**
1121          * When we detect an idle GPU, we want to turn on
1122          * powersaving features. So once we see that there
1123          * are no more requests outstanding and no more
1124          * arrive within a small period of time, we fire
1125          * off the idle_work.
1126          */
1127         struct delayed_work idle_work;
1128
1129         /**
1130          * Are we in a non-interruptible section of code like
1131          * modesetting?
1132          */
1133         bool interruptible;
1134
1135         /**
1136          * Is the GPU currently considered idle, or busy executing userspace
1137          * requests?  Whilst idle, we attempt to power down the hardware and
1138          * display clocks. In order to reduce the effect on performance, there
1139          * is a slight delay before we do so.
1140          */
1141         bool busy;
1142
1143         /* the indicator for dispatch video commands on two BSD rings */
1144         int bsd_ring_dispatch_index;
1145
1146         /** Bit 6 swizzling required for X tiling */
1147         uint32_t bit_6_swizzle_x;
1148         /** Bit 6 swizzling required for Y tiling */
1149         uint32_t bit_6_swizzle_y;
1150
1151         /* accounting, useful for userland debugging */
1152         struct spinlock object_stat_lock;
1153         size_t object_memory;
1154         u32 object_count;
1155 };
1156
1157 struct drm_i915_error_state_buf {
1158         unsigned bytes;
1159         unsigned size;
1160         int err;
1161         u8 *buf;
1162         loff_t start;
1163         loff_t pos;
1164 };
1165
1166 struct i915_error_state_file_priv {
1167         struct drm_device *dev;
1168         struct drm_i915_error_state *error;
1169 };
1170
1171 struct i915_gpu_error {
1172         /* For hangcheck timer */
1173 #define DRM_I915_HANGCHECK_PERIOD 1500 /* in ms */
1174 #define DRM_I915_HANGCHECK_JIFFIES msecs_to_jiffies(DRM_I915_HANGCHECK_PERIOD)
1175         /* Hang gpu twice in this window and your context gets banned */
1176 #define DRM_I915_CTX_BAN_PERIOD DIV_ROUND_UP(8*DRM_I915_HANGCHECK_PERIOD, 1000)
1177
1178         struct timer_list hangcheck_timer;
1179
1180         /* For reset and error_state handling. */
1181         struct lock lock;
1182         /* Protected by the above dev->gpu_error.lock. */
1183         struct drm_i915_error_state *first_error;
1184         struct work_struct work;
1185
1186
1187         unsigned long missed_irq_rings;
1188
1189         /**
1190          * State variable controlling the reset flow and count
1191          *
1192          * This is a counter which gets incremented when reset is triggered,
1193          * and again when reset has been handled. So odd values (lowest bit set)
1194          * means that reset is in progress and even values that
1195          * (reset_counter >> 1):th reset was successfully completed.
1196          *
1197          * If reset is not completed succesfully, the I915_WEDGE bit is
1198          * set meaning that hardware is terminally sour and there is no
1199          * recovery. All waiters on the reset_queue will be woken when
1200          * that happens.
1201          *
1202          * This counter is used by the wait_seqno code to notice that reset
1203          * event happened and it needs to restart the entire ioctl (since most
1204          * likely the seqno it waited for won't ever signal anytime soon).
1205          *
1206          * This is important for lock-free wait paths, where no contended lock
1207          * naturally enforces the correct ordering between the bail-out of the
1208          * waiter and the gpu reset work code.
1209          */
1210         atomic_t reset_counter;
1211
1212 #define I915_RESET_IN_PROGRESS_FLAG     1
1213 #define I915_WEDGED                     (1 << 31)
1214
1215         /**
1216          * Waitqueue to signal when the reset has completed. Used by clients
1217          * that wait for dev_priv->mm.wedged to settle.
1218          */
1219         wait_queue_head_t reset_queue;
1220
1221         /* Userspace knobs for gpu hang simulation;
1222          * combines both a ring mask, and extra flags
1223          */
1224         u32 stop_rings;
1225 #define I915_STOP_RING_ALLOW_BAN       (1 << 31)
1226 #define I915_STOP_RING_ALLOW_WARN      (1 << 30)
1227
1228         /* For missed irq/seqno simulation. */
1229         unsigned int test_irq_rings;
1230 };
1231
1232 enum modeset_restore {
1233         MODESET_ON_LID_OPEN,
1234         MODESET_DONE,
1235         MODESET_SUSPENDED,
1236 };
1237
1238 struct ddi_vbt_port_info {
1239         uint8_t hdmi_level_shift;
1240
1241         uint8_t supports_dvi:1;
1242         uint8_t supports_hdmi:1;
1243         uint8_t supports_dp:1;
1244 };
1245
1246 enum drrs_support_type {
1247         DRRS_NOT_SUPPORTED = 0,
1248         STATIC_DRRS_SUPPORT = 1,
1249         SEAMLESS_DRRS_SUPPORT = 2
1250 };
1251
1252 struct intel_vbt_data {
1253         struct drm_display_mode *lfp_lvds_vbt_mode; /* if any */
1254         struct drm_display_mode *sdvo_lvds_vbt_mode; /* if any */
1255
1256         /* Feature bits */
1257         unsigned int int_tv_support:1;
1258         unsigned int lvds_dither:1;
1259         unsigned int lvds_vbt:1;
1260         unsigned int int_crt_support:1;
1261         unsigned int lvds_use_ssc:1;
1262         unsigned int display_clock_mode:1;
1263         unsigned int fdi_rx_polarity_inverted:1;
1264         unsigned int has_mipi:1;
1265         int lvds_ssc_freq;
1266         unsigned int bios_lvds_val; /* initial [PCH_]LVDS reg val in VBIOS */
1267
1268         enum drrs_support_type drrs_type;
1269
1270         /* eDP */
1271         int edp_rate;
1272         int edp_lanes;
1273         int edp_preemphasis;
1274         int edp_vswing;
1275         bool edp_initialized;
1276         bool edp_support;
1277         int edp_bpp;
1278         struct edp_power_seq edp_pps;
1279
1280         struct {
1281                 u16 pwm_freq_hz;
1282                 bool present;
1283                 bool active_low_pwm;
1284                 u8 min_brightness;      /* min_brightness/255 of max */
1285         } backlight;
1286
1287         /* MIPI DSI */
1288         struct {
1289                 u16 port;
1290                 u16 panel_id;
1291                 struct mipi_config *config;
1292                 struct mipi_pps_data *pps;
1293                 u8 seq_version;
1294                 u32 size;
1295                 u8 *data;
1296                 u8 *sequence[MIPI_SEQ_MAX];
1297         } dsi;
1298
1299         int crt_ddc_pin;
1300
1301         int child_dev_num;
1302         union child_device_config *child_dev;
1303
1304         struct ddi_vbt_port_info ddi_port_info[I915_MAX_PORTS];
1305 };
1306
1307 enum intel_ddb_partitioning {
1308         INTEL_DDB_PART_1_2,
1309         INTEL_DDB_PART_5_6, /* IVB+ */
1310 };
1311
1312 struct intel_wm_level {
1313         bool enable;
1314         uint32_t pri_val;
1315         uint32_t spr_val;
1316         uint32_t cur_val;
1317         uint32_t fbc_val;
1318 };
1319
1320 struct ilk_wm_values {
1321         uint32_t wm_pipe[3];
1322         uint32_t wm_lp[3];
1323         uint32_t wm_lp_spr[3];
1324         uint32_t wm_linetime[3];
1325         bool enable_fbc_wm;
1326         enum intel_ddb_partitioning partitioning;
1327 };
1328
1329 /*
1330  * This struct helps tracking the state needed for runtime PM, which puts the
1331  * device in PCI D3 state. Notice that when this happens, nothing on the
1332  * graphics device works, even register access, so we don't get interrupts nor
1333  * anything else.
1334  *
1335  * Every piece of our code that needs to actually touch the hardware needs to
1336  * either call intel_runtime_pm_get or call intel_display_power_get with the
1337  * appropriate power domain.
1338  *
1339  * Our driver uses the autosuspend delay feature, which means we'll only really
1340  * suspend if we stay with zero refcount for a certain amount of time. The
1341  * default value is currently very conservative (see intel_init_runtime_pm), but
1342  * it can be changed with the standard runtime PM files from sysfs.
1343  *
1344  * The irqs_disabled variable becomes true exactly after we disable the IRQs and
1345  * goes back to false exactly before we reenable the IRQs. We use this variable
1346  * to check if someone is trying to enable/disable IRQs while they're supposed
1347  * to be disabled. This shouldn't happen and we'll print some error messages in
1348  * case it happens.
1349  *
1350  * For more, read the Documentation/power/runtime_pm.txt.
1351  */
1352 struct i915_runtime_pm {
1353         bool suspended;
1354         bool _irqs_disabled;
1355 };
1356
1357 enum intel_pipe_crc_source {
1358         INTEL_PIPE_CRC_SOURCE_NONE,
1359         INTEL_PIPE_CRC_SOURCE_PLANE1,
1360         INTEL_PIPE_CRC_SOURCE_PLANE2,
1361         INTEL_PIPE_CRC_SOURCE_PF,
1362         INTEL_PIPE_CRC_SOURCE_PIPE,
1363         /* TV/DP on pre-gen5/vlv can't use the pipe source. */
1364         INTEL_PIPE_CRC_SOURCE_TV,
1365         INTEL_PIPE_CRC_SOURCE_DP_B,
1366         INTEL_PIPE_CRC_SOURCE_DP_C,
1367         INTEL_PIPE_CRC_SOURCE_DP_D,
1368         INTEL_PIPE_CRC_SOURCE_AUTO,
1369         INTEL_PIPE_CRC_SOURCE_MAX,
1370 };
1371
1372 struct intel_pipe_crc_entry {
1373         uint32_t frame;
1374         uint32_t crc[5];
1375 };
1376
1377 #define INTEL_PIPE_CRC_ENTRIES_NR       128
1378 struct intel_pipe_crc {
1379         struct spinlock lock;
1380         bool opened;            /* exclusive access to the result file */
1381         struct intel_pipe_crc_entry *entries;
1382         enum intel_pipe_crc_source source;
1383         int head, tail;
1384         wait_queue_head_t wq;
1385 };
1386
1387 struct i915_frontbuffer_tracking {
1388         struct lock lock;
1389
1390         /*
1391          * Tracking bits for delayed frontbuffer flushing du to gpu activity or
1392          * scheduled flips.
1393          */
1394         unsigned busy_bits;
1395         unsigned flip_bits;
1396 };
1397
1398 struct drm_i915_private {
1399         struct drm_device *dev;
1400         struct kmem_cache *slab;
1401
1402         struct intel_device_info info;
1403
1404         int relative_constants_mode;
1405
1406         device_t *gmbus_bridge;
1407         device_t *bbbus_bridge;
1408         device_t *bbbus;
1409
1410         drm_local_map_t *sarea;
1411         drm_local_map_t *mmio_map;
1412         char __iomem *regs;
1413
1414         struct intel_uncore uncore;
1415
1416         device_t *gmbus;
1417
1418
1419         /** gmbus_mutex protects against concurrent usage of the single hw gmbus
1420          * controller on different i2c buses. */
1421         struct lock gmbus_mutex;
1422
1423         struct _drm_i915_sarea *sarea_priv;
1424         /**
1425          * Base address of the gmbus and gpio block.
1426          */
1427         uint32_t gpio_mmio_base;
1428
1429         /* MMIO base address for MIPI regs */
1430         uint32_t mipi_mmio_base;
1431
1432         wait_queue_head_t gmbus_wait_queue;
1433
1434         struct pci_dev *bridge_dev;
1435         struct intel_engine_cs ring[I915_NUM_RINGS];
1436         struct drm_i915_gem_object *semaphore_obj;
1437         uint32_t last_seqno, next_seqno;
1438
1439         drm_dma_handle_t *status_page_dmah;
1440         struct resource *mch_res;
1441         int mch_res_rid;
1442
1443         /* protects the irq masks */
1444         struct lock irq_lock;
1445
1446         /* protects the mmio flip data */
1447         struct spinlock mmio_flip_lock;
1448
1449         bool display_irqs_enabled;
1450
1451         /* To control wakeup latency, e.g. for irq-driven dp aux transfers. */
1452         struct pm_qos_request pm_qos;
1453
1454         /* DPIO indirect register protection */
1455         struct lock dpio_lock;
1456
1457         /** Cached value of IMR to avoid reads in updating the bitfield */
1458         union {
1459                 u32 irq_mask;
1460                 u32 de_irq_mask[I915_MAX_PIPES];
1461         };
1462         u32 gt_irq_mask;
1463         u32 pm_irq_mask;
1464         u32 pm_rps_events;
1465         u32 pipestat_irq_mask[I915_MAX_PIPES];
1466
1467         struct work_struct hotplug_work;
1468         bool enable_hotplug_processing;
1469         struct {
1470                 unsigned long hpd_last_jiffies;
1471                 int hpd_cnt;
1472                 enum {
1473                         HPD_ENABLED = 0,
1474                         HPD_DISABLED = 1,
1475                         HPD_MARK_DISABLED = 2
1476                 } hpd_mark;
1477         } hpd_stats[HPD_NUM_PINS];
1478         u32 hpd_event_bits;
1479         struct delayed_work hotplug_reenable_work;
1480
1481         struct i915_fbc fbc;
1482         struct i915_drrs drrs;
1483         struct intel_opregion opregion;
1484         struct intel_vbt_data vbt;
1485
1486         /* overlay */
1487         struct intel_overlay *overlay;
1488
1489         /* backlight registers and fields in struct intel_panel */
1490         struct spinlock backlight_lock;
1491
1492         /* LVDS info */
1493         bool no_aux_handshake;
1494
1495         struct drm_i915_fence_reg fence_regs[I915_MAX_NUM_FENCES]; /* assume 965 */
1496         int fence_reg_start; /* 4 if userland hasn't ioctl'd us yet */
1497         int num_fence_regs; /* 8 on pre-965, 16 otherwise */
1498
1499         unsigned int fsb_freq, mem_freq, is_ddr3;
1500         unsigned int vlv_cdclk_freq;
1501
1502         /**
1503          * wq - Driver workqueue for GEM.
1504          *
1505          * NOTE: Work items scheduled here are not allowed to grab any modeset
1506          * locks, for otherwise the flushing done in the pageflip code will
1507          * result in deadlocks.
1508          */
1509         struct workqueue_struct *wq;
1510
1511         /* Display functions */
1512         struct drm_i915_display_funcs display;
1513
1514         /* PCH chipset type */
1515         enum intel_pch pch_type;
1516         unsigned short pch_id;
1517
1518         unsigned long quirks;
1519
1520         enum modeset_restore modeset_restore;
1521         struct lock modeset_restore_lock;
1522
1523         struct list_head vm_list; /* Global list of all address spaces */
1524         struct i915_gtt gtt; /* VM representing the global address space */
1525
1526         struct i915_gem_mm mm;
1527 #if defined(CONFIG_MMU_NOTIFIER)
1528         DECLARE_HASHTABLE(mmu_notifiers, 7);
1529 #endif
1530
1531         /* Kernel Modesetting */
1532
1533         struct sdvo_device_mapping sdvo_mappings[2];
1534
1535         struct drm_crtc *plane_to_crtc_mapping[I915_MAX_PIPES];
1536         struct drm_crtc *pipe_to_crtc_mapping[I915_MAX_PIPES];
1537         wait_queue_head_t pending_flip_queue;
1538
1539 #ifdef CONFIG_DEBUG_FS
1540         struct intel_pipe_crc pipe_crc[I915_MAX_PIPES];
1541 #endif
1542
1543         int num_shared_dpll;
1544         struct intel_shared_dpll shared_dplls[I915_NUM_PLLS];
1545         int dpio_phy_iosf_port[I915_NUM_PHYS_VLV];
1546
1547         /* Reclocking support */
1548         bool render_reclock_avail;
1549         bool lvds_downclock_avail;
1550         /* indicates the reduced downclock for LVDS*/
1551         int lvds_downclock;
1552
1553         struct i915_frontbuffer_tracking fb_tracking;
1554
1555         u16 orig_clock;
1556
1557         bool mchbar_need_disable;
1558
1559         struct intel_l3_parity l3_parity;
1560
1561         /* Cannot be determined by PCIID. You must always read a register. */
1562         size_t ellc_size;
1563
1564         /* gen6+ rps state */
1565         struct intel_gen6_power_mgmt rps;
1566
1567         /* ilk-only ips/rps state. Everything in here is protected by the global
1568          * mchdev_lock in intel_pm.c */
1569         struct intel_ilk_power_mgmt ips;
1570
1571         struct i915_power_domains power_domains;
1572
1573         struct i915_psr psr;
1574
1575         struct i915_gpu_error gpu_error;
1576
1577         struct drm_i915_gem_object *vlv_pctx;
1578
1579 #ifdef CONFIG_DRM_I915_FBDEV
1580         /* list of fbdev register on this device */
1581         struct intel_fbdev *fbdev;
1582 #endif
1583
1584         /*
1585          * The console may be contended at resume, but we don't
1586          * want it to block on it.
1587          */
1588         struct work_struct console_resume_work;
1589
1590         struct drm_property *broadcast_rgb_property;
1591         struct drm_property *force_audio_property;
1592
1593         uint32_t hw_context_size;
1594         struct list_head context_list;
1595
1596         u32 fdi_rx_config;
1597
1598         u32 suspend_count;
1599         struct i915_suspend_saved_registers regfile;
1600         struct vlv_s0ix_state vlv_s0ix_state;
1601
1602         struct {
1603                 /*
1604                  * Raw watermark latency values:
1605                  * in 0.1us units for WM0,
1606                  * in 0.5us units for WM1+.
1607                  */
1608                 /* primary */
1609                 uint16_t pri_latency[5];
1610                 /* sprite */
1611                 uint16_t spr_latency[5];
1612                 /* cursor */
1613                 uint16_t cur_latency[5];
1614
1615                 /* current hardware state */
1616                 struct ilk_wm_values hw;
1617         } wm;
1618
1619         struct i915_runtime_pm pm;
1620
1621         struct intel_digital_port *hpd_irq_port[I915_MAX_PORTS];
1622         u32 long_hpd_port_mask;
1623         u32 short_hpd_port_mask;
1624         struct work_struct dig_port_work;
1625
1626         /*
1627          * if we get a HPD irq from DP and a HPD irq from non-DP
1628          * the non-DP HPD could block the workqueue on a mode config
1629          * mutex getting, that userspace may have taken. However
1630          * userspace is waiting on the DP workqueue to run which is
1631          * blocked behind the non-DP one.
1632          */
1633         struct workqueue_struct *dp_wq;
1634
1635         /* Old dri1 support infrastructure, beware the dragons ya fools entering
1636          * here! */
1637         struct i915_dri1_state dri1;
1638         /* Old ums support infrastructure, same warning applies. */
1639         struct i915_ums_state ums;
1640
1641         /*
1642          * NOTE: This is the dri1/ums dungeon, don't add stuff here. Your patch
1643          * will be rejected. Instead look for a better place.
1644          */
1645 };
1646
1647 static inline struct drm_i915_private *to_i915(const struct drm_device *dev)
1648 {
1649         return dev->dev_private;
1650 }
1651
1652 /* Iterate over initialised rings */
1653 #define for_each_ring(ring__, dev_priv__, i__) \
1654         for ((i__) = 0; (i__) < I915_NUM_RINGS; (i__)++) \
1655                 if (((ring__) = &(dev_priv__)->ring[(i__)]), intel_ring_initialized((ring__)))
1656
1657 enum hdmi_force_audio {
1658         HDMI_AUDIO_OFF_DVI = -2,        /* no aux data for HDMI-DVI converter */
1659         HDMI_AUDIO_OFF,                 /* force turn off HDMI audio */
1660         HDMI_AUDIO_AUTO,                /* trust EDID */
1661         HDMI_AUDIO_ON,                  /* force turn on HDMI audio */
1662 };
1663
1664 #define I915_GTT_OFFSET_NONE ((u32)-1)
1665
1666 struct drm_i915_gem_object_ops {
1667         /* Interface between the GEM object and its backing storage.
1668          * get_pages() is called once prior to the use of the associated set
1669          * of pages before to binding them into the GTT, and put_pages() is
1670          * called after we no longer need them. As we expect there to be
1671          * associated cost with migrating pages between the backing storage
1672          * and making them available for the GPU (e.g. clflush), we may hold
1673          * onto the pages after they are no longer referenced by the GPU
1674          * in case they may be used again shortly (for example migrating the
1675          * pages to a different memory domain within the GTT). put_pages()
1676          * will therefore most likely be called when the object itself is
1677          * being released or under memory pressure (where we attempt to
1678          * reap pages for the shrinker).
1679          */
1680         int (*get_pages)(struct drm_i915_gem_object *);
1681         void (*put_pages)(struct drm_i915_gem_object *);
1682         int (*dmabuf_export)(struct drm_i915_gem_object *);
1683         void (*release)(struct drm_i915_gem_object *);
1684 };
1685
1686 /*
1687  * Frontbuffer tracking bits. Set in obj->frontbuffer_bits while a gem bo is
1688  * considered to be the frontbuffer for the given plane interface-vise. This
1689  * doesn't mean that the hw necessarily already scans it out, but that any
1690  * rendering (by the cpu or gpu) will land in the frontbuffer eventually.
1691  *
1692  * We have one bit per pipe and per scanout plane type.
1693  */
1694 #define INTEL_FRONTBUFFER_BITS_PER_PIPE 4
1695 #define INTEL_FRONTBUFFER_BITS \
1696         (INTEL_FRONTBUFFER_BITS_PER_PIPE * I915_MAX_PIPES)
1697 #define INTEL_FRONTBUFFER_PRIMARY(pipe) \
1698         (1 << (INTEL_FRONTBUFFER_BITS_PER_PIPE * (pipe)))
1699 #define INTEL_FRONTBUFFER_CURSOR(pipe) \
1700         (1 << (1 +(INTEL_FRONTBUFFER_BITS_PER_PIPE * (pipe))))
1701 #define INTEL_FRONTBUFFER_SPRITE(pipe) \
1702         (1 << (2 +(INTEL_FRONTBUFFER_BITS_PER_PIPE * (pipe))))
1703 #define INTEL_FRONTBUFFER_OVERLAY(pipe) \
1704         (1 << (3 +(INTEL_FRONTBUFFER_BITS_PER_PIPE * (pipe))))
1705 #define INTEL_FRONTBUFFER_ALL_MASK(pipe) \
1706         (0xf << (INTEL_FRONTBUFFER_BITS_PER_PIPE * (pipe)))
1707
1708 struct drm_i915_gem_object {
1709         struct drm_gem_object base;
1710
1711         const struct drm_i915_gem_object_ops *ops;
1712
1713         /** List of VMAs backed by this object */
1714         struct list_head vma_list;
1715
1716         /** Stolen memory for this object, instead of being backed by shmem. */
1717         struct drm_mm_node *stolen;
1718         struct list_head global_list;
1719
1720         struct list_head ring_list;
1721         /** Used in execbuf to temporarily hold a ref */
1722         struct list_head obj_exec_link;
1723
1724         /**
1725          * This is set if the object is on the active lists (has pending
1726          * rendering and so a non-zero seqno), and is not set if it i s on
1727          * inactive (ready to be unbound) list.
1728          */
1729         unsigned int active:1;
1730
1731         /**
1732          * This is set if the object has been written to since last bound
1733          * to the GTT
1734          */
1735         unsigned int dirty:1;
1736
1737         /**
1738          * Fence register bits (if any) for this object.  Will be set
1739          * as needed when mapped into the GTT.
1740          * Protected by dev->struct_mutex.
1741          */
1742         signed int fence_reg:I915_MAX_NUM_FENCE_BITS;
1743
1744         /**
1745          * Advice: are the backing pages purgeable?
1746          */
1747         unsigned int madv:2;
1748
1749         /**
1750          * Current tiling mode for the object.
1751          */
1752         unsigned int tiling_mode:2;
1753         /**
1754          * Whether the tiling parameters for the currently associated fence
1755          * register have changed. Note that for the purposes of tracking
1756          * tiling changes we also treat the unfenced register, the register
1757          * slot that the object occupies whilst it executes a fenced
1758          * command (such as BLT on gen2/3), as a "fence".
1759          */
1760         unsigned int fence_dirty:1;
1761
1762         /**
1763          * Is the object at the current location in the gtt mappable and
1764          * fenceable? Used to avoid costly recalculations.
1765          */
1766         unsigned int map_and_fenceable:1;
1767
1768         /**
1769          * Whether the current gtt mapping needs to be mappable (and isn't just
1770          * mappable by accident). Track pin and fault separate for a more
1771          * accurate mappable working set.
1772          */
1773         unsigned int fault_mappable:1;
1774         unsigned int pin_mappable:1;
1775         unsigned int pin_display:1;
1776
1777         /*
1778          * Is the object to be mapped as read-only to the GPU
1779          * Only honoured if hardware has relevant pte bit
1780          */
1781         unsigned long gt_ro:1;
1782
1783         /*
1784          * Is the GPU currently using a fence to access this buffer,
1785          */
1786         unsigned int pending_fenced_gpu_access:1;
1787         unsigned int fenced_gpu_access:1;
1788
1789         unsigned int cache_level:3;
1790
1791         unsigned int has_aliasing_ppgtt_mapping:1;
1792         unsigned int has_global_gtt_mapping:1;
1793         unsigned int has_dma_mapping:1;
1794
1795         unsigned int frontbuffer_bits:INTEL_FRONTBUFFER_BITS;
1796
1797         vm_page_t *pages;
1798         int pages_pin_count;
1799
1800         /* prime dma-buf support */
1801         void *dma_buf_vmapping;
1802         int vmapping_count;
1803
1804         struct intel_engine_cs *ring;
1805
1806         /** Breadcrumb of last rendering to the buffer. */
1807         uint32_t last_read_seqno;
1808         uint32_t last_write_seqno;
1809         /** Breadcrumb of last fenced GPU access to the buffer. */
1810         uint32_t last_fenced_seqno;
1811
1812         /** Current tiling stride for the object, if it's tiled. */
1813         uint32_t stride;
1814
1815         /** References from framebuffers, locks out tiling changes. */
1816         unsigned long framebuffer_references;
1817
1818         /** Record of address bit 17 of each page at last unbind. */
1819         unsigned long *bit_17;
1820
1821         /** User space pin count and filp owning the pin */
1822         unsigned long user_pin_count;
1823         struct drm_file *pin_filp;
1824
1825         /** for phy allocated objects */
1826         drm_dma_handle_t *phys_handle;
1827
1828         union {
1829                 struct i915_gem_userptr {
1830                         uintptr_t ptr;
1831                         unsigned read_only :1;
1832                         unsigned workers :4;
1833 #define I915_GEM_USERPTR_MAX_WORKERS 15
1834
1835                         struct mm_struct *mm;
1836                         struct i915_mmu_object *mn;
1837                         struct work_struct *work;
1838                 } userptr;
1839         };
1840 };
1841 #define to_intel_bo(x) container_of(x, struct drm_i915_gem_object, base)
1842
1843 void i915_gem_track_fb(struct drm_i915_gem_object *old,
1844                        struct drm_i915_gem_object *new,
1845                        unsigned frontbuffer_bits);
1846
1847 /**
1848  * Request queue structure.
1849  *
1850  * The request queue allows us to note sequence numbers that have been emitted
1851  * and may be associated with active buffers to be retired.
1852  *
1853  * By keeping this list, we can avoid having to do questionable
1854  * sequence-number comparisons on buffer last_rendering_seqnos, and associate
1855  * an emission time with seqnos for tracking how far ahead of the GPU we are.
1856  */
1857 struct drm_i915_gem_request {
1858         /** On Which ring this request was generated */
1859         struct intel_engine_cs *ring;
1860
1861         /** GEM sequence number associated with this request. */
1862         uint32_t seqno;
1863
1864         /** Position in the ringbuffer of the start of the request */
1865         u32 head;
1866
1867         /** Position in the ringbuffer of the end of the request */
1868         u32 tail;
1869
1870         /** Context related to this request */
1871         struct intel_context *ctx;
1872
1873         /** Batch buffer related to this request if any */
1874         struct drm_i915_gem_object *batch_obj;
1875
1876         /** Time at which this request was emitted, in jiffies. */
1877         unsigned long emitted_jiffies;
1878
1879         /** global list entry for this request */
1880         struct list_head list;
1881
1882         struct drm_i915_file_private *file_priv;
1883         /** file_priv list entry for this request */
1884         struct list_head client_list;
1885 };
1886
1887 struct drm_i915_file_private {
1888         struct drm_i915_private *dev_priv;
1889         struct drm_file *file;
1890
1891         struct {
1892                 struct spinlock lock;
1893                 struct list_head request_list;
1894                 struct delayed_work idle_work;
1895         } mm;
1896         struct idr context_idr;
1897
1898         atomic_t rps_wait_boost;
1899         struct  intel_engine_cs *bsd_ring;
1900 };
1901
1902 /*
1903  * A command that requires special handling by the command parser.
1904  */
1905 struct drm_i915_cmd_descriptor {
1906         /*
1907          * Flags describing how the command parser processes the command.
1908          *
1909          * CMD_DESC_FIXED: The command has a fixed length if this is set,
1910          *                 a length mask if not set
1911          * CMD_DESC_SKIP: The command is allowed but does not follow the
1912          *                standard length encoding for the opcode range in
1913          *                which it falls
1914          * CMD_DESC_REJECT: The command is never allowed
1915          * CMD_DESC_REGISTER: The command should be checked against the
1916          *                    register whitelist for the appropriate ring
1917          * CMD_DESC_MASTER: The command is allowed if the submitting process
1918          *                  is the DRM master
1919          */
1920         u32 flags;
1921 #define CMD_DESC_FIXED    (1<<0)
1922 #define CMD_DESC_SKIP     (1<<1)
1923 #define CMD_DESC_REJECT   (1<<2)
1924 #define CMD_DESC_REGISTER (1<<3)
1925 #define CMD_DESC_BITMASK  (1<<4)
1926 #define CMD_DESC_MASTER   (1<<5)
1927
1928         /*
1929          * The command's unique identification bits and the bitmask to get them.
1930          * This isn't strictly the opcode field as defined in the spec and may
1931          * also include type, subtype, and/or subop fields.
1932          */
1933         struct {
1934                 u32 value;
1935                 u32 mask;
1936         } cmd;
1937
1938         /*
1939          * The command's length. The command is either fixed length (i.e. does
1940          * not include a length field) or has a length field mask. The flag
1941          * CMD_DESC_FIXED indicates a fixed length. Otherwise, the command has
1942          * a length mask. All command entries in a command table must include
1943          * length information.
1944          */
1945         union {
1946                 u32 fixed;
1947                 u32 mask;
1948         } length;
1949
1950         /*
1951          * Describes where to find a register address in the command to check
1952          * against the ring's register whitelist. Only valid if flags has the
1953          * CMD_DESC_REGISTER bit set.
1954          */
1955         struct {
1956                 u32 offset;
1957                 u32 mask;
1958         } reg;
1959
1960 #define MAX_CMD_DESC_BITMASKS 3
1961         /*
1962          * Describes command checks where a particular dword is masked and
1963          * compared against an expected value. If the command does not match
1964          * the expected value, the parser rejects it. Only valid if flags has
1965          * the CMD_DESC_BITMASK bit set. Only entries where mask is non-zero
1966          * are valid.
1967          *
1968          * If the check specifies a non-zero condition_mask then the parser
1969          * only performs the check when the bits specified by condition_mask
1970          * are non-zero.
1971          */
1972         struct {
1973                 u32 offset;
1974                 u32 mask;
1975                 u32 expected;
1976                 u32 condition_offset;
1977                 u32 condition_mask;
1978         } bits[MAX_CMD_DESC_BITMASKS];
1979 };
1980
1981 /*
1982  * A table of commands requiring special handling by the command parser.
1983  *
1984  * Each ring has an array of tables. Each table consists of an array of command
1985  * descriptors, which must be sorted with command opcodes in ascending order.
1986  */
1987 struct drm_i915_cmd_table {
1988         const struct drm_i915_cmd_descriptor *table;
1989         int count;
1990 };
1991
1992 #define INTEL_INFO(dev) (&to_i915(dev)->info)
1993
1994 #define IS_I830(dev)            ((dev)->pdev->device == 0x3577)
1995 #define IS_845G(dev)            ((dev)->pdev->device == 0x2562)
1996 #define IS_I85X(dev)            (INTEL_INFO(dev)->is_i85x)
1997 #define IS_I865G(dev)           ((dev)->pdev->device == 0x2572)
1998 #define IS_I915G(dev)           (INTEL_INFO(dev)->is_i915g)
1999 #define IS_I915GM(dev)          ((dev)->pdev->device == 0x2592)
2000 #define IS_I945G(dev)           ((dev)->pdev->device == 0x2772)
2001 #define IS_I945GM(dev)          (INTEL_INFO(dev)->is_i945gm)
2002 #define IS_BROADWATER(dev)      (INTEL_INFO(dev)->is_broadwater)
2003 #define IS_CRESTLINE(dev)       (INTEL_INFO(dev)->is_crestline)
2004 #define IS_GM45(dev)            ((dev)->pdev->device == 0x2A42)
2005 #define IS_G4X(dev)             (INTEL_INFO(dev)->is_g4x)
2006 #define IS_PINEVIEW_G(dev)      ((dev)->pdev->device == 0xa001)
2007 #define IS_PINEVIEW_M(dev)      ((dev)->pdev->device == 0xa011)
2008 #define IS_PINEVIEW(dev)        (INTEL_INFO(dev)->is_pineview)
2009 #define IS_G33(dev)             (INTEL_INFO(dev)->is_g33)
2010 #define IS_IRONLAKE_M(dev)      ((dev)->pdev->device == 0x0046)
2011 #define IS_IVYBRIDGE(dev)       (INTEL_INFO(dev)->is_ivybridge)
2012 #define IS_IVB_GT1(dev)         ((dev)->pdev->device == 0x0156 || \
2013                                  (dev)->pdev->device == 0x0152 || \
2014                                  (dev)->pdev->device == 0x015a)
2015 #define IS_SNB_GT1(dev)         ((dev)->pdev->device == 0x0102 || \
2016                                  (dev)->pdev->device == 0x0106 || \
2017                                  (dev)->pdev->device == 0x010A)
2018 #define IS_VALLEYVIEW(dev)      (INTEL_INFO(dev)->is_valleyview)
2019 #define IS_CHERRYVIEW(dev)      (INTEL_INFO(dev)->is_valleyview && IS_GEN8(dev))
2020 #define IS_HASWELL(dev) (INTEL_INFO(dev)->is_haswell)
2021 #define IS_BROADWELL(dev)       (!INTEL_INFO(dev)->is_valleyview && IS_GEN8(dev))
2022 #define IS_MOBILE(dev)          (INTEL_INFO(dev)->is_mobile)
2023 #define IS_HSW_EARLY_SDV(dev)   (IS_HASWELL(dev) && \
2024                                  ((dev)->pdev->device & 0xFF00) == 0x0C00)
2025 #define IS_BDW_ULT(dev)         (IS_BROADWELL(dev) && \
2026                                  (((dev)->pdev->device & 0xf) == 0x2  || \
2027                                  ((dev)->pdev->device & 0xf) == 0x6 || \
2028                                  ((dev)->pdev->device & 0xf) == 0xe))
2029 #define IS_HSW_ULT(dev)         (IS_HASWELL(dev) && \
2030                                  ((dev)->pdev->device & 0xFF00) == 0x0A00)
2031 #define IS_ULT(dev)             (IS_HSW_ULT(dev) || IS_BDW_ULT(dev))
2032 #define IS_HSW_GT3(dev)         (IS_HASWELL(dev) && \
2033                                  ((dev)->pdev->device & 0x00F0) == 0x0020)
2034 /* ULX machines are also considered ULT. */
2035 #define IS_HSW_ULX(dev)         ((dev)->pdev->device == 0x0A0E || \
2036                                  (dev)->pdev->device == 0x0A1E)
2037 #define IS_PRELIMINARY_HW(intel_info) ((intel_info)->is_preliminary)
2038
2039 /*
2040  * The genX designation typically refers to the render engine, so render
2041  * capability related checks should use IS_GEN, while display and other checks
2042  * have their own (e.g. HAS_PCH_SPLIT for ILK+ display, IS_foo for particular
2043  * chips, etc.).
2044  */
2045 #define IS_GEN2(dev)    (INTEL_INFO(dev)->gen == 2)
2046 #define IS_GEN3(dev)    (INTEL_INFO(dev)->gen == 3)
2047 #define IS_GEN4(dev)    (INTEL_INFO(dev)->gen == 4)
2048 #define IS_GEN5(dev)    (INTEL_INFO(dev)->gen == 5)
2049 #define IS_GEN6(dev)    (INTEL_INFO(dev)->gen == 6)
2050 #define IS_GEN7(dev)    (INTEL_INFO(dev)->gen == 7)
2051 #define IS_GEN8(dev)    (INTEL_INFO(dev)->gen == 8)
2052
2053 #define RENDER_RING             (1<<RCS)
2054 #define BSD_RING                (1<<VCS)
2055 #define BLT_RING                (1<<BCS)
2056 #define VEBOX_RING              (1<<VECS)
2057 #define BSD2_RING               (1<<VCS2)
2058 #define HAS_BSD(dev)            (INTEL_INFO(dev)->ring_mask & BSD_RING)
2059 #define HAS_BSD2(dev)           (INTEL_INFO(dev)->ring_mask & BSD2_RING)
2060 #define HAS_BLT(dev)            (INTEL_INFO(dev)->ring_mask & BLT_RING)
2061 #define HAS_VEBOX(dev)          (INTEL_INFO(dev)->ring_mask & VEBOX_RING)
2062 #define HAS_LLC(dev)            (INTEL_INFO(dev)->has_llc)
2063 #define HAS_WT(dev)             ((IS_HASWELL(dev) || IS_BROADWELL(dev)) && \
2064                                  to_i915(dev)->ellc_size)
2065 #define I915_NEED_GFX_HWS(dev)  (INTEL_INFO(dev)->need_gfx_hws)
2066
2067 #define HAS_HW_CONTEXTS(dev)    (INTEL_INFO(dev)->gen >= 6)
2068 #define HAS_ALIASING_PPGTT(dev) (INTEL_INFO(dev)->gen >= 6)
2069 #define HAS_PPGTT(dev)          (INTEL_INFO(dev)->gen >= 7 && !IS_GEN8(dev))
2070 #define USES_PPGTT(dev)         intel_enable_ppgtt(dev, false)
2071 #define USES_FULL_PPGTT(dev)    intel_enable_ppgtt(dev, true)
2072
2073 #define HAS_OVERLAY(dev)                (INTEL_INFO(dev)->has_overlay)
2074 #define OVERLAY_NEEDS_PHYSICAL(dev)     (INTEL_INFO(dev)->overlay_needs_physical)
2075
2076 /* Early gen2 have a totally busted CS tlb and require pinned batches. */
2077 #define HAS_BROKEN_CS_TLB(dev)          (IS_I830(dev) || IS_845G(dev))
2078 /*
2079  * dp aux and gmbus irq on gen4 seems to be able to generate legacy interrupts
2080  * even when in MSI mode. This results in spurious interrupt warnings if the
2081  * legacy irq no. is shared with another device. The kernel then disables that
2082  * interrupt source and so prevents the other device from working properly.
2083  */
2084 #define HAS_AUX_IRQ(dev) (INTEL_INFO(dev)->gen >= 5)
2085 #define HAS_GMBUS_IRQ(dev) (INTEL_INFO(dev)->gen >= 5)
2086
2087 /* With the 945 and later, Y tiling got adjusted so that it was 32 128-byte
2088  * rows, which changed the alignment requirements and fence programming.
2089  */
2090 #define HAS_128_BYTE_Y_TILING(dev) (!IS_GEN2(dev) && !(IS_I915G(dev) || \
2091                                                       IS_I915GM(dev)))
2092 #define SUPPORTS_DIGITAL_OUTPUTS(dev)   (!IS_GEN2(dev) && !IS_PINEVIEW(dev))
2093 #define SUPPORTS_INTEGRATED_HDMI(dev)   (IS_G4X(dev) || IS_GEN5(dev))
2094 #define SUPPORTS_INTEGRATED_DP(dev)     (IS_G4X(dev) || IS_GEN5(dev))
2095 #define SUPPORTS_TV(dev)                (INTEL_INFO(dev)->supports_tv)
2096 #define I915_HAS_HOTPLUG(dev)            (INTEL_INFO(dev)->has_hotplug)
2097
2098 #define HAS_FW_BLC(dev) (INTEL_INFO(dev)->gen > 2)
2099 #define HAS_PIPE_CXSR(dev) (INTEL_INFO(dev)->has_pipe_cxsr)
2100 #define HAS_FBC(dev) (INTEL_INFO(dev)->has_fbc)
2101
2102 #define HAS_IPS(dev)            (IS_ULT(dev) || IS_BROADWELL(dev))
2103
2104 #define HAS_DDI(dev)            (INTEL_INFO(dev)->has_ddi)
2105 #define HAS_FPGA_DBG_UNCLAIMED(dev)     (INTEL_INFO(dev)->has_fpga_dbg)
2106 #define HAS_PSR(dev)            (IS_HASWELL(dev) || IS_BROADWELL(dev))
2107 #define HAS_RUNTIME_PM(dev)     (IS_GEN6(dev) || IS_HASWELL(dev) || \
2108                                  IS_BROADWELL(dev) || IS_VALLEYVIEW(dev))
2109
2110 #define INTEL_PCH_DEVICE_ID_MASK                0xff00
2111 #define INTEL_PCH_IBX_DEVICE_ID_TYPE            0x3b00
2112 #define INTEL_PCH_CPT_DEVICE_ID_TYPE            0x1c00
2113 #define INTEL_PCH_PPT_DEVICE_ID_TYPE            0x1e00
2114 #define INTEL_PCH_LPT_DEVICE_ID_TYPE            0x8c00
2115 #define INTEL_PCH_LPT_LP_DEVICE_ID_TYPE         0x9c00
2116
2117 #define INTEL_PCH_TYPE(dev) (to_i915(dev)->pch_type)
2118 #define HAS_PCH_LPT(dev) (INTEL_PCH_TYPE(dev) == PCH_LPT)
2119 #define HAS_PCH_CPT(dev) (INTEL_PCH_TYPE(dev) == PCH_CPT)
2120 #define HAS_PCH_IBX(dev) (INTEL_PCH_TYPE(dev) == PCH_IBX)
2121 #define HAS_PCH_NOP(dev) (INTEL_PCH_TYPE(dev) == PCH_NOP)
2122 #define HAS_PCH_SPLIT(dev) (INTEL_PCH_TYPE(dev) != PCH_NONE)
2123
2124 #define HAS_GMCH_DISPLAY(dev) (INTEL_INFO(dev)->gen < 5 || IS_VALLEYVIEW(dev))
2125
2126 /* DPF == dynamic parity feature */
2127 #define HAS_L3_DPF(dev) (IS_IVYBRIDGE(dev) || IS_HASWELL(dev))
2128 #define NUM_L3_SLICES(dev) (IS_HSW_GT3(dev) ? 2 : HAS_L3_DPF(dev))
2129
2130 #define GT_FREQUENCY_MULTIPLIER 50
2131
2132 #include "i915_trace.h"
2133
2134 extern const struct drm_ioctl_desc i915_ioctls[];
2135 extern int i915_max_ioctl;
2136
2137 extern int i915_suspend(device_t kdev);
2138 extern int i915_resume(struct drm_device *dev);
2139 extern int i915_master_create(struct drm_device *dev, struct drm_master *master);
2140 extern void i915_master_destroy(struct drm_device *dev, struct drm_master *master);
2141
2142 /* i915_params.c */
2143 struct i915_params {
2144         int modeset;
2145         int panel_ignore_lid;
2146         unsigned int powersave;
2147         int semaphores;
2148         unsigned int lvds_downclock;
2149         int lvds_channel_mode;
2150         int panel_use_ssc;
2151         int vbt_sdvo_panel_type;
2152         int enable_rc6;
2153         int enable_fbc;
2154         int enable_ppgtt;
2155         int enable_psr;
2156         unsigned int preliminary_hw_support;
2157         int disable_power_well;
2158         int enable_ips;
2159         int invert_brightness;
2160         int enable_cmd_parser;
2161         /* leave bools at the end to not create holes */
2162         bool enable_hangcheck;
2163         bool fastboot;
2164         bool prefault_disable;
2165         int reset;
2166         bool disable_display;
2167         bool disable_vtd_wa;
2168         int use_mmio_flip;
2169         bool mmio_debug;
2170 };
2171 extern struct i915_params i915 __read_mostly;
2172
2173                                 /* i915_dma.c */
2174 void i915_update_dri1_breadcrumb(struct drm_device *dev);
2175 extern void i915_kernel_lost_context(struct drm_device * dev);
2176 extern int i915_driver_load(struct drm_device *, unsigned long flags);
2177 extern int i915_driver_unload(struct drm_device *);
2178 extern int i915_driver_open(struct drm_device *dev, struct drm_file *file);
2179 extern void i915_driver_lastclose(struct drm_device * dev);
2180 extern void i915_driver_preclose(struct drm_device *dev,
2181                                  struct drm_file *file);
2182 extern void i915_driver_postclose(struct drm_device *dev,
2183                                   struct drm_file *file);
2184 extern int i915_driver_device_is_agp(struct drm_device * dev);
2185 #ifdef CONFIG_COMPAT
2186 extern long i915_compat_ioctl(struct file *filp, unsigned int cmd,
2187                               unsigned long arg);
2188 #endif
2189 extern int i915_emit_box(struct drm_device *dev,
2190                          struct drm_clip_rect *box,
2191                          int DR1, int DR4);
2192 extern int intel_gpu_reset(struct drm_device *dev);
2193 extern int i915_reset(struct drm_device *dev);
2194 extern unsigned long i915_chipset_val(struct drm_i915_private *dev_priv);
2195 extern unsigned long i915_mch_val(struct drm_i915_private *dev_priv);
2196 extern unsigned long i915_gfx_val(struct drm_i915_private *dev_priv);
2197 extern void i915_update_gfx_val(struct drm_i915_private *dev_priv);
2198 int vlv_force_gfx_clock(struct drm_i915_private *dev_priv, bool on);
2199 void intel_hpd_cancel_work(struct drm_i915_private *dev_priv);
2200
2201 extern void intel_console_resume(struct work_struct *work);
2202
2203 /* i915_irq.c */
2204 void i915_queue_hangcheck(struct drm_device *dev);
2205 __printf(3, 4)
2206 void i915_handle_error(struct drm_device *dev, bool wedged,
2207                        const char *fmt, ...);
2208
2209 void gen6_set_pm_mask(struct drm_i915_private *dev_priv, u32 pm_iir,
2210                                                         int new_delay);
2211 extern void intel_irq_init(struct drm_device *dev);
2212 extern void intel_hpd_init(struct drm_device *dev);
2213
2214 extern void intel_uncore_sanitize(struct drm_device *dev);
2215 extern void intel_uncore_early_sanitize(struct drm_device *dev,
2216                                         bool restore_forcewake);
2217 extern void intel_uncore_init(struct drm_device *dev);
2218 extern void intel_uncore_check_errors(struct drm_device *dev);
2219 extern void intel_uncore_fini(struct drm_device *dev);
2220
2221 void
2222 i915_enable_pipestat(struct drm_i915_private *dev_priv, enum i915_pipe pipe,
2223                      u32 status_mask);
2224
2225 void
2226 i915_disable_pipestat(struct drm_i915_private *dev_priv, enum i915_pipe pipe,
2227                       u32 status_mask);
2228
2229 void valleyview_enable_display_irqs(struct drm_i915_private *dev_priv);
2230 void valleyview_disable_display_irqs(struct drm_i915_private *dev_priv);
2231
2232 /* i915_gem.c */
2233 int i915_gem_init_ioctl(struct drm_device *dev, void *data,
2234                         struct drm_file *file_priv);
2235 int i915_gem_create_ioctl(struct drm_device *dev, void *data,
2236                           struct drm_file *file_priv);
2237 int i915_gem_pread_ioctl(struct drm_device *dev, void *data,
2238                          struct drm_file *file_priv);
2239 int i915_gem_pwrite_ioctl(struct drm_device *dev, void *data,
2240                           struct drm_file *file_priv);
2241 int i915_gem_mmap_ioctl(struct drm_device *dev, void *data,
2242                         struct drm_file *file_priv);
2243 int i915_gem_mmap_gtt_ioctl(struct drm_device *dev, void *data,
2244                         struct drm_file *file_priv);
2245 int i915_gem_set_domain_ioctl(struct drm_device *dev, void *data,
2246                               struct drm_file *file_priv);
2247 int i915_gem_sw_finish_ioctl(struct drm_device *dev, void *data,
2248                              struct drm_file *file_priv);
2249 int i915_gem_execbuffer(struct drm_device *dev, void *data,
2250                         struct drm_file *file_priv);
2251 int i915_gem_execbuffer2(struct drm_device *dev, void *data,
2252                          struct drm_file *file_priv);
2253 int i915_gem_pin_ioctl(struct drm_device *dev, void *data,
2254                        struct drm_file *file_priv);
2255 int i915_gem_unpin_ioctl(struct drm_device *dev, void *data,
2256                          struct drm_file *file_priv);
2257 int i915_gem_busy_ioctl(struct drm_device *dev, void *data,
2258                         struct drm_file *file_priv);
2259 int i915_gem_get_caching_ioctl(struct drm_device *dev, void *data,
2260                                struct drm_file *file);
2261 int i915_gem_set_caching_ioctl(struct drm_device *dev, void *data,
2262                                struct drm_file *file);
2263 int i915_gem_throttle_ioctl(struct drm_device *dev, void *data,
2264                             struct drm_file *file_priv);
2265 int i915_gem_madvise_ioctl(struct drm_device *dev, void *data,
2266                            struct drm_file *file_priv);
2267 int i915_gem_entervt_ioctl(struct drm_device *dev, void *data,
2268                            struct drm_file *file_priv);
2269 int i915_gem_leavevt_ioctl(struct drm_device *dev, void *data,
2270                            struct drm_file *file_priv);
2271 int i915_gem_set_tiling(struct drm_device *dev, void *data,
2272                         struct drm_file *file_priv);
2273 int i915_gem_get_tiling(struct drm_device *dev, void *data,
2274                         struct drm_file *file_priv);
2275 int i915_gem_init_userptr(struct drm_device *dev);
2276 int i915_gem_userptr_ioctl(struct drm_device *dev, void *data,
2277                            struct drm_file *file);
2278 int i915_gem_get_aperture_ioctl(struct drm_device *dev, void *data,
2279                                 struct drm_file *file_priv);
2280 int i915_gem_wait_ioctl(struct drm_device *dev, void *data,
2281                         struct drm_file *file_priv);
2282 void i915_gem_load(struct drm_device *dev);
2283 void *i915_gem_object_alloc(struct drm_device *dev);
2284 void i915_gem_object_free(struct drm_i915_gem_object *obj);
2285 void i915_gem_object_init(struct drm_i915_gem_object *obj,
2286                          const struct drm_i915_gem_object_ops *ops);
2287 struct drm_i915_gem_object *i915_gem_alloc_object(struct drm_device *dev,
2288                                                   size_t size);
2289 void i915_init_vm(struct drm_i915_private *dev_priv,
2290                   struct i915_address_space *vm);
2291 void i915_gem_free_object(struct drm_gem_object *obj);
2292 void i915_gem_vma_destroy(struct i915_vma *vma);
2293
2294 #define PIN_MAPPABLE 0x1
2295 #define PIN_NONBLOCK 0x2
2296 #define PIN_GLOBAL 0x4
2297 #define PIN_OFFSET_BIAS 0x8
2298 #define PIN_OFFSET_MASK (~4095)
2299 int __must_check i915_gem_object_pin(struct drm_i915_gem_object *obj,
2300                                      struct i915_address_space *vm,
2301                                      uint32_t alignment,
2302                                      uint64_t flags);
2303 int __must_check i915_vma_unbind(struct i915_vma *vma);
2304 int i915_gem_object_put_pages(struct drm_i915_gem_object *obj);
2305 void i915_gem_release_all_mmaps(struct drm_i915_private *dev_priv);
2306 void i915_gem_release_mmap(struct drm_i915_gem_object *obj);
2307 void i915_gem_lastclose(struct drm_device *dev);
2308
2309 int i915_gem_obj_prepare_shmem_read(struct drm_i915_gem_object *obj,
2310                                     int *needs_clflush);
2311
2312 int __must_check i915_gem_object_get_pages(struct drm_i915_gem_object *obj);
2313 static inline struct vm_page *i915_gem_object_get_page(struct drm_i915_gem_object *obj, int n)
2314 {
2315         return obj->pages[n];
2316 }
2317 static inline void i915_gem_object_pin_pages(struct drm_i915_gem_object *obj)
2318 {
2319         BUG_ON(obj->pages == NULL);
2320         obj->pages_pin_count++;
2321 }
2322 static inline void i915_gem_object_unpin_pages(struct drm_i915_gem_object *obj)
2323 {
2324         BUG_ON(obj->pages_pin_count == 0);
2325         obj->pages_pin_count--;
2326 }
2327
2328 int __must_check i915_mutex_lock_interruptible(struct drm_device *dev);
2329 int i915_gem_object_sync(struct drm_i915_gem_object *obj,
2330                          struct intel_engine_cs *to);
2331 void i915_vma_move_to_active(struct i915_vma *vma,
2332                              struct intel_engine_cs *ring);
2333 int i915_gem_dumb_create(struct drm_file *file_priv,
2334                          struct drm_device *dev,
2335                          struct drm_mode_create_dumb *args);
2336 int i915_gem_mmap_gtt(struct drm_file *file_priv, struct drm_device *dev,
2337                       uint32_t handle, uint64_t *offset);
2338 /**
2339  * Returns true if seq1 is later than seq2.
2340  */
2341 static inline bool
2342 i915_seqno_passed(uint32_t seq1, uint32_t seq2)
2343 {
2344         return (int32_t)(seq1 - seq2) >= 0;
2345 }
2346
2347 int __must_check i915_gem_get_seqno(struct drm_device *dev, u32 *seqno);
2348 int __must_check i915_gem_set_seqno(struct drm_device *dev, u32 seqno);
2349 int __must_check i915_gem_object_get_fence(struct drm_i915_gem_object *obj);
2350 int __must_check i915_gem_object_put_fence(struct drm_i915_gem_object *obj);
2351
2352 bool i915_gem_object_pin_fence(struct drm_i915_gem_object *obj);
2353 void i915_gem_object_unpin_fence(struct drm_i915_gem_object *obj);
2354
2355 struct drm_i915_gem_request *
2356 i915_gem_find_active_request(struct intel_engine_cs *ring);
2357
2358 bool i915_gem_retire_requests(struct drm_device *dev);
2359 void i915_gem_retire_requests_ring(struct intel_engine_cs *ring);
2360 int __must_check i915_gem_check_wedge(struct i915_gpu_error *error,
2361                                       bool interruptible);
2362 int __must_check i915_gem_check_olr(struct intel_engine_cs *ring, u32 seqno);
2363
2364 static inline bool i915_reset_in_progress(struct i915_gpu_error *error)
2365 {
2366         return unlikely(atomic_read(&error->reset_counter)
2367                         & (I915_RESET_IN_PROGRESS_FLAG | I915_WEDGED));
2368 }
2369
2370 static inline bool i915_terminally_wedged(struct i915_gpu_error *error)
2371 {
2372         return atomic_read(&error->reset_counter) & I915_WEDGED;
2373 }
2374
2375 static inline u32 i915_reset_count(struct i915_gpu_error *error)
2376 {
2377         return ((atomic_read(&error->reset_counter) & ~I915_WEDGED) + 1) / 2;
2378 }
2379
2380 static inline bool i915_stop_ring_allow_ban(struct drm_i915_private *dev_priv)
2381 {
2382         return dev_priv->gpu_error.stop_rings == 0 ||
2383                 dev_priv->gpu_error.stop_rings & I915_STOP_RING_ALLOW_BAN;
2384 }
2385
2386 static inline bool i915_stop_ring_allow_warn(struct drm_i915_private *dev_priv)
2387 {
2388         return dev_priv->gpu_error.stop_rings == 0 ||
2389                 dev_priv->gpu_error.stop_rings & I915_STOP_RING_ALLOW_WARN;
2390 }
2391
2392 void i915_gem_reset(struct drm_device *dev);
2393 bool i915_gem_clflush_object(struct drm_i915_gem_object *obj, bool force);
2394 int __must_check i915_gem_object_finish_gpu(struct drm_i915_gem_object *obj);
2395 int __must_check i915_gem_init(struct drm_device *dev);
2396 int __must_check i915_gem_init_hw(struct drm_device *dev);
2397 int i915_gem_l3_remap(struct intel_engine_cs *ring, int slice);
2398 void i915_gem_init_swizzling(struct drm_device *dev);
2399 void i915_gem_cleanup_ringbuffer(struct drm_device *dev);
2400 int __must_check i915_gpu_idle(struct drm_device *dev);
2401 int __must_check i915_gem_suspend(struct drm_device *dev);
2402 int __i915_add_request(struct intel_engine_cs *ring,
2403                        struct drm_file *file,
2404                        struct drm_i915_gem_object *batch_obj,
2405                        u32 *seqno);
2406 #define i915_add_request(ring, seqno) \
2407         __i915_add_request(ring, NULL, NULL, seqno)
2408 int __must_check i915_wait_seqno(struct intel_engine_cs *ring,
2409                                  uint32_t seqno);
2410 int i915_gem_fault(vm_object_t vm_obj, vm_ooffset_t offset, int prot, vm_page_t *mres);
2411 int __must_check
2412 i915_gem_object_set_to_gtt_domain(struct drm_i915_gem_object *obj,
2413                                   bool write);
2414 int __must_check
2415 i915_gem_object_set_to_cpu_domain(struct drm_i915_gem_object *obj, bool write);
2416 int __must_check
2417 i915_gem_object_pin_to_display_plane(struct drm_i915_gem_object *obj,
2418                                      u32 alignment,
2419                                      struct intel_engine_cs *pipelined);
2420 void i915_gem_object_unpin_from_display_plane(struct drm_i915_gem_object *obj);
2421 int i915_gem_object_attach_phys(struct drm_i915_gem_object *obj,
2422                                 int align);
2423 int i915_gem_open(struct drm_device *dev, struct drm_file *file);
2424 void i915_gem_release(struct drm_device *dev, struct drm_file *file);
2425
2426 uint32_t
2427 i915_gem_get_gtt_size(struct drm_device *dev, uint32_t size, int tiling_mode);
2428 uint32_t
2429 i915_gem_get_gtt_alignment(struct drm_device *dev, uint32_t size,
2430                             int tiling_mode, bool fenced);
2431
2432 int i915_gem_object_set_cache_level(struct drm_i915_gem_object *obj,
2433                                     enum i915_cache_level cache_level);
2434
2435 #if 0
2436 struct drm_gem_object *i915_gem_prime_import(struct drm_device *dev,
2437                                 struct dma_buf *dma_buf);
2438
2439 struct dma_buf *i915_gem_prime_export(struct drm_device *dev,
2440                                 struct drm_gem_object *gem_obj, int flags);
2441 #endif
2442
2443 void i915_gem_restore_fences(struct drm_device *dev);
2444
2445 unsigned long i915_gem_obj_offset(struct drm_i915_gem_object *o,
2446                                   struct i915_address_space *vm);
2447 bool i915_gem_obj_bound_any(struct drm_i915_gem_object *o);
2448 bool i915_gem_obj_bound(struct drm_i915_gem_object *o,
2449                         struct i915_address_space *vm);
2450 unsigned long i915_gem_obj_size(struct drm_i915_gem_object *o,
2451                                 struct i915_address_space *vm);
2452 struct i915_vma *i915_gem_obj_to_vma(struct drm_i915_gem_object *obj,
2453                                      struct i915_address_space *vm);
2454 struct i915_vma *
2455 i915_gem_obj_lookup_or_create_vma(struct drm_i915_gem_object *obj,
2456                                   struct i915_address_space *vm);
2457
2458 struct i915_vma *i915_gem_obj_to_ggtt(struct drm_i915_gem_object *obj);
2459 static inline bool i915_gem_obj_is_pinned(struct drm_i915_gem_object *obj) {
2460         struct i915_vma *vma;
2461         list_for_each_entry(vma, &obj->vma_list, vma_link)
2462                 if (vma->pin_count > 0)
2463                         return true;
2464         return false;
2465 }
2466
2467 /* Some GGTT VM helpers */
2468 #define obj_to_ggtt(obj) \
2469         (&((struct drm_i915_private *)(obj)->base.dev->dev_private)->gtt.base)
2470 static inline bool i915_is_ggtt(struct i915_address_space *vm)
2471 {
2472         struct i915_address_space *ggtt =
2473                 &((struct drm_i915_private *)(vm)->dev->dev_private)->gtt.base;
2474         return vm == ggtt;
2475 }
2476
2477 static inline bool i915_gem_obj_ggtt_bound(struct drm_i915_gem_object *obj)
2478 {
2479         return i915_gem_obj_bound(obj, obj_to_ggtt(obj));
2480 }
2481
2482 static inline unsigned long
2483 i915_gem_obj_ggtt_offset(struct drm_i915_gem_object *obj)
2484 {
2485         return i915_gem_obj_offset(obj, obj_to_ggtt(obj));
2486 }
2487
2488 static inline unsigned long
2489 i915_gem_obj_ggtt_size(struct drm_i915_gem_object *obj)
2490 {
2491         return i915_gem_obj_size(obj, obj_to_ggtt(obj));
2492 }
2493
2494 static inline int __must_check
2495 i915_gem_obj_ggtt_pin(struct drm_i915_gem_object *obj,
2496                       uint32_t alignment,
2497                       unsigned flags)
2498 {
2499         return i915_gem_object_pin(obj, obj_to_ggtt(obj), alignment, flags | PIN_GLOBAL);
2500 }
2501
2502 static inline int
2503 i915_gem_object_ggtt_unbind(struct drm_i915_gem_object *obj)
2504 {
2505         return i915_vma_unbind(i915_gem_obj_to_ggtt(obj));
2506 }
2507
2508 void i915_gem_object_ggtt_unpin(struct drm_i915_gem_object *obj);
2509
2510 /* i915_gem_context.c */
2511 #define ctx_to_ppgtt(ctx) container_of((ctx)->vm, struct i915_hw_ppgtt, base)
2512 int __must_check i915_gem_context_init(struct drm_device *dev);
2513 void i915_gem_context_fini(struct drm_device *dev);
2514 void i915_gem_context_reset(struct drm_device *dev);
2515 int i915_gem_context_open(struct drm_device *dev, struct drm_file *file);
2516 int i915_gem_context_enable(struct drm_i915_private *dev_priv);
2517 void i915_gem_context_close(struct drm_device *dev, struct drm_file *file);
2518 int i915_switch_context(struct intel_engine_cs *ring,
2519                         struct intel_context *to);
2520 struct intel_context *
2521 i915_gem_context_get(struct drm_i915_file_private *file_priv, u32 id);
2522 void i915_gem_context_free(struct kref *ctx_ref);
2523 static inline void i915_gem_context_reference(struct intel_context *ctx)
2524 {
2525         kref_get(&ctx->ref);
2526 }
2527
2528 static inline void i915_gem_context_unreference(struct intel_context *ctx)
2529 {
2530         kref_put(&ctx->ref, i915_gem_context_free);
2531 }
2532
2533 static inline bool i915_gem_context_is_default(const struct intel_context *c)
2534 {
2535         return c->user_handle == DEFAULT_CONTEXT_HANDLE;
2536 }
2537
2538 int i915_gem_context_create_ioctl(struct drm_device *dev, void *data,
2539                                   struct drm_file *file);
2540 int i915_gem_context_destroy_ioctl(struct drm_device *dev, void *data,
2541                                    struct drm_file *file);
2542
2543 /* i915_gem_render_state.c */
2544 int i915_gem_render_state_init(struct intel_engine_cs *ring);
2545 /* i915_gem_evict.c */
2546 int __must_check i915_gem_evict_something(struct drm_device *dev,
2547                                           struct i915_address_space *vm,
2548                                           int min_size,
2549                                           unsigned alignment,
2550                                           unsigned cache_level,
2551                                           unsigned long start,
2552                                           unsigned long end,
2553                                           unsigned flags);
2554 int i915_gem_evict_vm(struct i915_address_space *vm, bool do_idle);
2555 int i915_gem_evict_everything(struct drm_device *dev);
2556
2557 /* belongs in i915_gem_gtt.h */
2558 static inline void i915_gem_chipset_flush(struct drm_device *dev)
2559 {
2560         if (INTEL_INFO(dev)->gen < 6)
2561                 intel_gtt_chipset_flush();
2562 }
2563
2564 /* i915_gem_stolen.c */
2565 int i915_gem_init_stolen(struct drm_device *dev);
2566 int i915_gem_stolen_setup_compression(struct drm_device *dev, int size, int fb_cpp);
2567 void i915_gem_stolen_cleanup_compression(struct drm_device *dev);
2568 void i915_gem_cleanup_stolen(struct drm_device *dev);
2569 struct drm_i915_gem_object *
2570 i915_gem_object_create_stolen(struct drm_device *dev, u32 size);
2571 struct drm_i915_gem_object *
2572 i915_gem_object_create_stolen_for_preallocated(struct drm_device *dev,
2573                                                u32 stolen_offset,
2574                                                u32 gtt_offset,
2575                                                u32 size);
2576
2577 /* i915_gem_tiling.c */
2578 static inline bool i915_gem_object_needs_bit17_swizzle(struct drm_i915_gem_object *obj)
2579 {
2580         struct drm_i915_private *dev_priv = obj->base.dev->dev_private;
2581
2582         return dev_priv->mm.bit_6_swizzle_x == I915_BIT_6_SWIZZLE_9_10_17 &&
2583                 obj->tiling_mode != I915_TILING_NONE;
2584 }
2585
2586 void i915_gem_detect_bit_6_swizzle(struct drm_device *dev);
2587 void i915_gem_object_do_bit_17_swizzle(struct drm_i915_gem_object *obj);
2588 void i915_gem_object_save_bit_17_swizzle(struct drm_i915_gem_object *obj);
2589
2590 /* i915_gem_debug.c */
2591 #if WATCH_LISTS
2592 int i915_verify_lists(struct drm_device *dev);
2593 #else
2594 #define i915_verify_lists(dev) 0
2595 #endif
2596
2597 /* i915_debugfs.c */
2598 int i915_debugfs_init(struct drm_minor *minor);
2599 void i915_debugfs_cleanup(struct drm_minor *minor);
2600 #ifdef CONFIG_DEBUG_FS
2601 void intel_display_crc_init(struct drm_device *dev);
2602 #else
2603 static inline void intel_display_crc_init(struct drm_device *dev) {}
2604 #endif
2605
2606 /* i915_gpu_error.c */
2607 __printf(2, 3)
2608 void i915_error_printf(struct drm_i915_error_state_buf *e, const char *f, ...);
2609 int i915_error_state_to_str(struct drm_i915_error_state_buf *estr,
2610                             const struct i915_error_state_file_priv *error);
2611 int i915_error_state_buf_init(struct drm_i915_error_state_buf *eb,
2612                               size_t count, loff_t pos);
2613 static inline void i915_error_state_buf_release(
2614         struct drm_i915_error_state_buf *eb)
2615 {
2616         kfree(eb->buf);
2617 }
2618 void i915_capture_error_state(struct drm_device *dev, bool wedge,
2619                               const char *error_msg);
2620 void i915_error_state_get(struct drm_device *dev,
2621                           struct i915_error_state_file_priv *error_priv);
2622 void i915_error_state_put(struct i915_error_state_file_priv *error_priv);
2623 void i915_destroy_error_state(struct drm_device *dev);
2624
2625 void i915_get_extra_instdone(struct drm_device *dev, uint32_t *instdone);
2626 const char *i915_cache_level_str(int type);
2627
2628 /* i915_cmd_parser.c */
2629 int i915_cmd_parser_get_version(void);
2630 int i915_cmd_parser_init_ring(struct intel_engine_cs *ring);
2631 void i915_cmd_parser_fini_ring(struct intel_engine_cs *ring);
2632 bool i915_needs_cmd_parser(struct intel_engine_cs *ring);
2633 int i915_parse_cmds(struct intel_engine_cs *ring,
2634                     struct drm_i915_gem_object *batch_obj,
2635                     u32 batch_start_offset,
2636                     bool is_master);
2637
2638 /* i915_suspend.c */
2639 extern int i915_save_state(struct drm_device *dev);
2640 extern int i915_restore_state(struct drm_device *dev);
2641
2642 /* i915_ums.c */
2643 void i915_save_display_reg(struct drm_device *dev);
2644 void i915_restore_display_reg(struct drm_device *dev);
2645
2646 /* i915_sysfs.c */
2647 void i915_setup_sysfs(struct drm_device *dev_priv);
2648 void i915_teardown_sysfs(struct drm_device *dev_priv);
2649
2650 /* intel_i2c.c */
2651 extern int intel_setup_gmbus(struct drm_device *dev);
2652 extern void intel_teardown_gmbus(struct drm_device *dev);
2653 static inline bool intel_gmbus_is_port_valid(unsigned port)
2654 {
2655         return (port >= GMBUS_PORT_SSC && port <= GMBUS_PORT_DPD);
2656 }
2657
2658 extern struct device *intel_gmbus_get_adapter(
2659                 struct drm_i915_private *dev_priv, unsigned port);
2660 extern void intel_gmbus_set_speed(struct device *adapter, int speed);
2661 extern void intel_gmbus_force_bit(struct device *adapter, bool force_bit);
2662 static inline bool intel_gmbus_is_forced_bit(struct device *adapter)
2663 {
2664         struct intel_iic_softc *sc;
2665         sc = device_get_softc(device_get_parent(adapter));
2666
2667         return sc->force_bit_dev;
2668 }
2669 extern void intel_i2c_reset(struct drm_device *dev);
2670
2671 /* intel_opregion.c */
2672 struct intel_encoder;
2673 #ifdef CONFIG_ACPI
2674 extern int intel_opregion_setup(struct drm_device *dev);
2675 extern void intel_opregion_init(struct drm_device *dev);
2676 extern void intel_opregion_fini(struct drm_device *dev);
2677 extern void intel_opregion_asle_intr(struct drm_device *dev);
2678 extern int intel_opregion_notify_encoder(struct intel_encoder *intel_encoder,
2679                                          bool enable);
2680 extern int intel_opregion_notify_adapter(struct drm_device *dev,
2681                                          pci_power_t state);
2682 #else
2683 static inline int intel_opregion_setup(struct drm_device *dev) { return 0; }
2684 static inline void intel_opregion_init(struct drm_device *dev) { return; }
2685 static inline void intel_opregion_fini(struct drm_device *dev) { return; }
2686 static inline void intel_opregion_asle_intr(struct drm_device *dev) { return; }
2687 static inline int
2688 intel_opregion_notify_encoder(struct intel_encoder *intel_encoder, bool enable)
2689 {
2690         return 0;
2691 }
2692 static inline int
2693 intel_opregion_notify_adapter(struct drm_device *dev, pci_power_t state)
2694 {
2695         return 0;
2696 }
2697 #endif
2698
2699 /* intel_acpi.c */
2700 #ifdef CONFIG_ACPI
2701 extern void intel_register_dsm_handler(void);
2702 extern void intel_unregister_dsm_handler(void);
2703 #else
2704 static inline void intel_register_dsm_handler(void) { return; }
2705 static inline void intel_unregister_dsm_handler(void) { return; }
2706 #endif /* CONFIG_ACPI */
2707
2708 /* modesetting */
2709 extern void intel_modeset_init_hw(struct drm_device *dev);
2710 extern void intel_modeset_suspend_hw(struct drm_device *dev);
2711 extern void intel_modeset_init(struct drm_device *dev);
2712 extern void intel_modeset_gem_init(struct drm_device *dev);
2713 extern void intel_modeset_cleanup(struct drm_device *dev);
2714 extern void intel_connector_unregister(struct intel_connector *);
2715 extern int intel_modeset_vga_set_state(struct drm_device *dev, bool state);
2716 extern void intel_modeset_setup_hw_state(struct drm_device *dev,
2717                                          bool force_restore);
2718 extern void i915_redisable_vga(struct drm_device *dev);
2719 extern void i915_redisable_vga_power_on(struct drm_device *dev);
2720 extern void intel_disable_fbc(struct drm_device *dev);
2721 extern bool ironlake_set_drps(struct drm_device *dev, u8 val);
2722 extern void intel_init_pch_refclk(struct drm_device *dev);
2723 extern void gen6_set_rps(struct drm_device *dev, u8 val);
2724 extern void valleyview_set_rps(struct drm_device *dev, u8 val);
2725 extern void intel_set_memory_cxsr(struct drm_i915_private *dev_priv,
2726                                   bool enable);
2727 extern void intel_detect_pch(struct drm_device *dev);
2728 extern int intel_trans_dp_port_sel(struct drm_crtc *crtc);
2729 extern int intel_enable_rc6(const struct drm_device *dev);
2730
2731 extern bool i915_semaphore_is_enabled(struct drm_device *dev);
2732 int i915_reg_read_ioctl(struct drm_device *dev, void *data,
2733                         struct drm_file *file);
2734 int i915_get_reset_stats_ioctl(struct drm_device *dev, void *data,
2735                                struct drm_file *file);
2736
2737 struct intel_device_info *i915_get_device_id(int device);
2738
2739 void intel_notify_mmio_flip(struct intel_engine_cs *ring);
2740
2741 /* overlay */
2742 extern struct intel_overlay_error_state *intel_overlay_capture_error_state(struct drm_device *dev);
2743 extern void intel_overlay_print_error_state(struct drm_i915_error_state_buf *e,
2744                                             struct intel_overlay_error_state *error);
2745
2746 extern struct intel_display_error_state *intel_display_capture_error_state(struct drm_device *dev);
2747 extern void intel_display_print_error_state(struct drm_i915_error_state_buf *e,
2748                                             struct drm_device *dev,
2749                                             struct intel_display_error_state *error);
2750
2751 /* On SNB platform, before reading ring registers forcewake bit
2752  * must be set to prevent GT core from power down and stale values being
2753  * returned.
2754  */
2755 void gen6_gt_force_wake_get(struct drm_i915_private *dev_priv, int fw_engine);
2756 void gen6_gt_force_wake_put(struct drm_i915_private *dev_priv, int fw_engine);
2757 void assert_force_wake_inactive(struct drm_i915_private *dev_priv);
2758
2759 int sandybridge_pcode_read(struct drm_i915_private *dev_priv, u8 mbox, u32 *val);
2760 int sandybridge_pcode_write(struct drm_i915_private *dev_priv, u8 mbox, u32 val);
2761
2762 /* intel_sideband.c */
2763 u32 vlv_punit_read(struct drm_i915_private *dev_priv, u8 addr);
2764 void vlv_punit_write(struct drm_i915_private *dev_priv, u8 addr, u32 val);
2765 u32 vlv_nc_read(struct drm_i915_private *dev_priv, u8 addr);
2766 u32 vlv_gpio_nc_read(struct drm_i915_private *dev_priv, u32 reg);
2767 void vlv_gpio_nc_write(struct drm_i915_private *dev_priv, u32 reg, u32 val);
2768 u32 vlv_cck_read(struct drm_i915_private *dev_priv, u32 reg);
2769 void vlv_cck_write(struct drm_i915_private *dev_priv, u32 reg, u32 val);
2770 u32 vlv_ccu_read(struct drm_i915_private *dev_priv, u32 reg);
2771 void vlv_ccu_write(struct drm_i915_private *dev_priv, u32 reg, u32 val);
2772 u32 vlv_bunit_read(struct drm_i915_private *dev_priv, u32 reg);
2773 void vlv_bunit_write(struct drm_i915_private *dev_priv, u32 reg, u32 val);
2774 u32 vlv_gps_core_read(struct drm_i915_private *dev_priv, u32 reg);
2775 void vlv_gps_core_write(struct drm_i915_private *dev_priv, u32 reg, u32 val);
2776 u32 vlv_dpio_read(struct drm_i915_private *dev_priv, enum i915_pipe pipe, int reg);
2777 void vlv_dpio_write(struct drm_i915_private *dev_priv, enum i915_pipe pipe, int reg, u32 val);
2778 u32 intel_sbi_read(struct drm_i915_private *dev_priv, u16 reg,
2779                    enum intel_sbi_destination destination);
2780 void intel_sbi_write(struct drm_i915_private *dev_priv, u16 reg, u32 value,
2781                      enum intel_sbi_destination destination);
2782 u32 vlv_flisdsi_read(struct drm_i915_private *dev_priv, u32 reg);
2783 void vlv_flisdsi_write(struct drm_i915_private *dev_priv, u32 reg, u32 val);
2784
2785 int vlv_gpu_freq(struct drm_i915_private *dev_priv, int val);
2786 int vlv_freq_opcode(struct drm_i915_private *dev_priv, int val);
2787
2788 #define FORCEWAKE_RENDER        (1 << 0)
2789 #define FORCEWAKE_MEDIA         (1 << 1)
2790 #define FORCEWAKE_ALL           (FORCEWAKE_RENDER | FORCEWAKE_MEDIA)
2791
2792
2793 #define I915_READ8(reg)         dev_priv->uncore.funcs.mmio_readb(dev_priv, (reg), true)
2794 #define I915_WRITE8(reg, val)   dev_priv->uncore.funcs.mmio_writeb(dev_priv, (reg), (val), true)
2795
2796 #define I915_READ16(reg)        dev_priv->uncore.funcs.mmio_readw(dev_priv, (reg), true)
2797 #define I915_WRITE16(reg, val)  dev_priv->uncore.funcs.mmio_writew(dev_priv, (reg), (val), true)
2798 #define I915_READ16_NOTRACE(reg)        dev_priv->uncore.funcs.mmio_readw(dev_priv, (reg), false)
2799 #define I915_WRITE16_NOTRACE(reg, val)  dev_priv->uncore.funcs.mmio_writew(dev_priv, (reg), (val), false)
2800
2801 #define I915_READ(reg)          dev_priv->uncore.funcs.mmio_readl(dev_priv, (reg), true)
2802 #define I915_WRITE(reg, val)    dev_priv->uncore.funcs.mmio_writel(dev_priv, (reg), (val), true)
2803 #define I915_READ_NOTRACE(reg)          dev_priv->uncore.funcs.mmio_readl(dev_priv, (reg), false)
2804 #define I915_WRITE_NOTRACE(reg, val)    dev_priv->uncore.funcs.mmio_writel(dev_priv, (reg), (val), false)
2805
2806 /* Be very careful with read/write 64-bit values. On 32-bit machines, they
2807  * will be implemented using 2 32-bit writes in an arbitrary order with
2808  * an arbitrary delay between them. This can cause the hardware to
2809  * act upon the intermediate value, possibly leading to corruption and
2810  * machine death. You have been warned.
2811  */
2812 #define I915_WRITE64(reg, val)  dev_priv->uncore.funcs.mmio_writeq(dev_priv, (reg), (val), true)
2813 #define I915_READ64(reg)        dev_priv->uncore.funcs.mmio_readq(dev_priv, (reg), true)
2814
2815 #define I915_READ64_2x32(lower_reg, upper_reg) ({                       \
2816                 u32 upper = I915_READ(upper_reg);                       \
2817                 u32 lower = I915_READ(lower_reg);                       \
2818                 u32 tmp = I915_READ(upper_reg);                         \
2819                 if (upper != tmp) {                                     \
2820                         upper = tmp;                                    \
2821                         lower = I915_READ(lower_reg);                   \
2822                         WARN_ON(I915_READ(upper_reg) != upper);         \
2823                 }                                                       \
2824                 (u64)upper << 32 | lower; })
2825
2826 #define POSTING_READ(reg)       (void)I915_READ_NOTRACE(reg)
2827 #define POSTING_READ16(reg)     (void)I915_READ16_NOTRACE(reg)
2828
2829 /* "Broadcast RGB" property */
2830 #define INTEL_BROADCAST_RGB_AUTO 0
2831 #define INTEL_BROADCAST_RGB_FULL 1
2832 #define INTEL_BROADCAST_RGB_LIMITED 2
2833
2834 static inline uint32_t i915_vgacntrl_reg(struct drm_device *dev)
2835 {
2836         if (IS_VALLEYVIEW(dev))
2837                 return VLV_VGACNTRL;
2838         else if (INTEL_INFO(dev)->gen >= 5)
2839                 return CPU_VGACNTRL;
2840         else
2841                 return VGACNTRL;
2842 }
2843
2844 static inline void __user *to_user_ptr(u64 address)
2845 {
2846         return (void __user *)(uintptr_t)address;
2847 }
2848
2849 static inline unsigned long msecs_to_jiffies_timeout(const unsigned int m)
2850 {
2851         unsigned long j = msecs_to_jiffies(m);
2852
2853         return min_t(unsigned long, MAX_JIFFY_OFFSET, j + 1);
2854 }
2855
2856 static inline unsigned long
2857 timespec_to_jiffies_timeout(const struct timespec *value)
2858 {
2859         unsigned long j = timespec_to_jiffies(value);
2860
2861         return min_t(unsigned long, MAX_JIFFY_OFFSET, j + 1);
2862 }
2863
2864 /*
2865  * If you need to wait X milliseconds between events A and B, but event B
2866  * doesn't happen exactly after event A, you record the timestamp (jiffies) of
2867  * when event A happened, then just before event B you call this function and
2868  * pass the timestamp as the first argument, and X as the second argument.
2869  */
2870 static inline void
2871 wait_remaining_ms_from_jiffies(unsigned long timestamp_jiffies, int to_wait_ms)
2872 {
2873         unsigned long target_jiffies, tmp_jiffies, remaining_jiffies;
2874
2875         /*
2876          * Don't re-read the value of "jiffies" every time since it may change
2877          * behind our back and break the math.
2878          */
2879         tmp_jiffies = jiffies;
2880         target_jiffies = timestamp_jiffies +
2881                          msecs_to_jiffies_timeout(to_wait_ms);
2882
2883         if (time_after(target_jiffies, tmp_jiffies)) {
2884                 remaining_jiffies = target_jiffies - tmp_jiffies;
2885
2886 #if 0
2887                 while (remaining_jiffies)
2888                         remaining_jiffies =
2889                             schedule_timeout_uninterruptible(remaining_jiffies);
2890 #else
2891                 msleep(jiffies_to_msecs(remaining_jiffies));
2892 #endif
2893         }
2894 }
2895
2896 #endif