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