3 * Copyright (c) 2007-2008 Intel Corporation
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice (including the next
14 * paragraph) shall be included in all copies or substantial portions of the
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
25 #ifndef __INTEL_DRV_H__
26 #define __INTEL_DRV_H__
28 #include <linux/i2c.h>
29 #include <drm/i915_drm.h>
31 #include <drm/drm_crtc.h>
32 #include <drm/drm_crtc_helper.h>
33 #include <drm/drm_fb_helper.h>
34 #include <drm/drm_dp_helper.h>
36 #define _wait_for(COND, MS, W) ({ \
37 unsigned long timeout__ = jiffies + msecs_to_jiffies(MS); \
40 if (time_after(jiffies, timeout__)) { \
44 if (W && drm_can_sleep()) { \
53 #define wait_for_atomic_us(COND, US) ({ \
54 unsigned long timeout__ = jiffies + usecs_to_jiffies(US); \
57 if (time_after(jiffies, timeout__)) { \
66 #define wait_for(COND, MS) _wait_for(COND, MS, 1)
67 #define wait_for_atomic(COND, MS) _wait_for(COND, MS, 0)
69 #define KHz(x) (1000*x)
70 #define MHz(x) KHz(1000*x)
73 * Display related stuff
76 /* store information about an Ixxx DVO */
77 /* The i830->i865 use multiple DVOs with multiple i2cs */
78 /* the i915, i945 have a single sDVO i2c bus - which is different */
80 /* maximum connectors per crtcs in the mode set */
81 #define INTELFB_CONN_LIMIT 4
83 #define INTEL_I2C_BUS_DVO 1
84 #define INTEL_I2C_BUS_SDVO 2
86 /* these are outputs from the chip - integrated only
87 external chips are via DVO or SDVO output */
88 #define INTEL_OUTPUT_UNUSED 0
89 #define INTEL_OUTPUT_ANALOG 1
90 #define INTEL_OUTPUT_DVO 2
91 #define INTEL_OUTPUT_SDVO 3
92 #define INTEL_OUTPUT_LVDS 4
93 #define INTEL_OUTPUT_TVOUT 5
94 #define INTEL_OUTPUT_HDMI 6
95 #define INTEL_OUTPUT_DISPLAYPORT 7
96 #define INTEL_OUTPUT_EDP 8
98 #define INTEL_DVO_CHIP_NONE 0
99 #define INTEL_DVO_CHIP_LVDS 1
100 #define INTEL_DVO_CHIP_TMDS 2
101 #define INTEL_DVO_CHIP_TVOUT 4
103 /* drm_display_mode->private_flags */
104 #define INTEL_MODE_PIXEL_MULTIPLIER_SHIFT (0x0)
105 #define INTEL_MODE_PIXEL_MULTIPLIER_MASK (0xf << INTEL_MODE_PIXEL_MULTIPLIER_SHIFT)
106 #define INTEL_MODE_DP_FORCE_6BPC (0x10)
107 /* This flag must be set by the encoder's mode_fixup if it changes the crtc
108 * timings in the mode to prevent the crtc fixup from overwriting them.
109 * Currently only lvds needs that. */
110 #define INTEL_MODE_CRTC_TIMINGS_SET (0x20)
113 intel_mode_set_pixel_multiplier(struct drm_display_mode *mode,
116 mode->clock *= multiplier;
117 mode->private_flags |= multiplier;
121 intel_mode_get_pixel_multiplier(const struct drm_display_mode *mode)
123 return (mode->private_flags & INTEL_MODE_PIXEL_MULTIPLIER_MASK) >> INTEL_MODE_PIXEL_MULTIPLIER_SHIFT;
126 struct intel_framebuffer {
127 struct drm_framebuffer base;
128 struct drm_i915_gem_object *obj;
132 struct drm_fb_helper helper;
133 struct intel_framebuffer ifb;
134 struct list_head fbdev_list;
135 struct drm_display_mode *our_mode;
138 struct intel_encoder {
139 struct drm_encoder base;
141 * The new crtc this encoder will be driven from. Only differs from
142 * base->crtc while a modeset is in progress.
144 struct intel_crtc *new_crtc;
149 * Intel hw has only one MUX where encoders could be clone, hence a
150 * simple flag is enough to compute the possible_clones mask.
153 bool connectors_active;
154 void (*hot_plug)(struct intel_encoder *);
155 void (*pre_enable)(struct intel_encoder *);
156 void (*enable)(struct intel_encoder *);
157 void (*disable)(struct intel_encoder *);
158 void (*post_disable)(struct intel_encoder *);
159 /* Read out the current hw state of this connector, returning true if
160 * the encoder is active. If the encoder is enabled it also set the pipe
161 * it is connected to in the pipe parameter. */
162 bool (*get_hw_state)(struct intel_encoder *, enum pipe *pipe);
166 struct intel_connector {
167 struct drm_connector base;
169 * The fixed encoder this connector is connected to.
171 struct intel_encoder *encoder;
174 * The new encoder this connector will be driven. Only differs from
175 * encoder while a modeset is in progress.
177 struct intel_encoder *new_encoder;
179 /* Reads out the current hw, returning true if the connector is enabled
180 * and active (i.e. dpms ON state). */
181 bool (*get_hw_state)(struct intel_connector *);
185 struct drm_crtc base;
188 u8 lut_r[256], lut_g[256], lut_b[256];
190 * Whether the crtc and the connected output pipeline is active. Implies
191 * that crtc->enabled is set, i.e. the current mode configuration has
192 * some outputs connected to this crtc.
195 bool primary_disabled; /* is the crtc obscured by a plane? */
197 struct intel_overlay *overlay;
198 struct intel_unpin_work *unpin_work;
201 /* Display surface base address adjustement for pageflips. Note that on
202 * gen4+ this only adjusts up to a tile, offsets within a tile are
203 * handled in the hw itself (with the TILEOFF register). */
204 unsigned long dspaddr_offset;
206 struct drm_i915_gem_object *cursor_bo;
207 uint32_t cursor_addr;
208 int16_t cursor_x, cursor_y;
209 int16_t cursor_width, cursor_height;
213 /* We can share PLLs across outputs if the timings match */
214 struct intel_pch_pll *pch_pll;
218 struct drm_plane base;
220 struct drm_i915_gem_object *obj;
222 u32 lut_r[1024], lut_g[1024], lut_b[1024];
223 void (*update_plane)(struct drm_plane *plane,
224 struct drm_framebuffer *fb,
225 struct drm_i915_gem_object *obj,
226 int crtc_x, int crtc_y,
227 unsigned int crtc_w, unsigned int crtc_h,
228 uint32_t x, uint32_t y,
229 uint32_t src_w, uint32_t src_h);
230 void (*disable_plane)(struct drm_plane *plane);
231 int (*update_colorkey)(struct drm_plane *plane,
232 struct drm_intel_sprite_colorkey *key);
233 void (*get_colorkey)(struct drm_plane *plane,
234 struct drm_intel_sprite_colorkey *key);
237 struct intel_watermark_params {
238 unsigned long fifo_size;
239 unsigned long max_wm;
240 unsigned long default_wm;
241 unsigned long guard_size;
242 unsigned long cacheline_size;
245 struct cxsr_latency {
248 unsigned long fsb_freq;
249 unsigned long mem_freq;
250 unsigned long display_sr;
251 unsigned long display_hpll_disable;
252 unsigned long cursor_sr;
253 unsigned long cursor_hpll_disable;
256 #define to_intel_crtc(x) container_of(x, struct intel_crtc, base)
257 #define to_intel_connector(x) container_of(x, struct intel_connector, base)
258 #define to_intel_encoder(x) container_of(x, struct intel_encoder, base)
259 #define to_intel_framebuffer(x) container_of(x, struct intel_framebuffer, base)
260 #define to_intel_plane(x) container_of(x, struct intel_plane, base)
262 #define DIP_HEADER_SIZE 5
264 #define DIP_TYPE_AVI 0x82
265 #define DIP_VERSION_AVI 0x2
266 #define DIP_LEN_AVI 13
267 #define DIP_AVI_PR_1 0
268 #define DIP_AVI_PR_2 1
270 #define DIP_TYPE_SPD 0x83
271 #define DIP_VERSION_SPD 0x1
272 #define DIP_LEN_SPD 25
273 #define DIP_SPD_UNKNOWN 0
274 #define DIP_SPD_DSTB 0x1
275 #define DIP_SPD_DVDP 0x2
276 #define DIP_SPD_DVHS 0x3
277 #define DIP_SPD_HDDVR 0x4
278 #define DIP_SPD_DVC 0x5
279 #define DIP_SPD_DSC 0x6
280 #define DIP_SPD_VCD 0x7
281 #define DIP_SPD_GAME 0x8
282 #define DIP_SPD_PC 0x9
283 #define DIP_SPD_BD 0xa
284 #define DIP_SPD_SCD 0xb
286 struct dip_infoframe {
287 uint8_t type; /* HB0 */
288 uint8_t ver; /* HB1 */
289 uint8_t len; /* HB2 - body len, not including checksum */
290 uint8_t ecc; /* Header ECC */
291 uint8_t checksum; /* PB0 */
294 /* PB1 - Y 6:5, A 4:4, B 3:2, S 1:0 */
296 /* PB2 - C 7:6, M 5:4, R 3:0 */
298 /* PB3 - ITC 7:7, EC 6:4, Q 3:2, SC 1:0 */
302 /* PB5 - YQ 7:6, CN 5:4, PR 3:0 */
305 uint16_t top_bar_end;
306 uint16_t bottom_bar_start;
307 uint16_t left_bar_end;
308 uint16_t right_bar_start;
309 } __attribute__ ((packed)) avi;
314 } __attribute__ ((packed)) spd;
316 } __attribute__ ((packed)) body;
317 } __attribute__((packed));
320 struct intel_encoder base;
324 uint32_t color_range;
327 enum hdmi_force_audio force_audio;
328 void (*write_infoframe)(struct drm_encoder *encoder,
329 struct dip_infoframe *frame);
330 void (*set_infoframes)(struct drm_encoder *encoder,
331 struct drm_display_mode *adjusted_mode);
334 #define DP_RECEIVER_CAP_SIZE 0xf
335 #define DP_LINK_CONFIGURATION_SIZE 9
338 struct intel_encoder base;
341 uint8_t link_configuration[DP_LINK_CONFIGURATION_SIZE];
343 enum hdmi_force_audio force_audio;
345 uint32_t color_range;
348 uint8_t dpcd[DP_RECEIVER_CAP_SIZE];
349 struct i2c_adapter adapter;
350 struct i2c_algo_dp_aux_data algo;
352 uint8_t train_set[4];
353 int panel_power_up_delay;
354 int panel_power_down_delay;
355 int panel_power_cycle_delay;
356 int backlight_on_delay;
357 int backlight_off_delay;
358 struct drm_display_mode *panel_fixed_mode; /* for eDP */
359 struct delayed_work panel_vdd_work;
361 struct edid *edid; /* cached EDID for eDP */
365 static inline struct drm_crtc *
366 intel_get_crtc_for_pipe(struct drm_device *dev, int pipe)
368 struct drm_i915_private *dev_priv = dev->dev_private;
369 return dev_priv->pipe_to_crtc_mapping[pipe];
372 static inline struct drm_crtc *
373 intel_get_crtc_for_plane(struct drm_device *dev, int plane)
375 struct drm_i915_private *dev_priv = dev->dev_private;
376 return dev_priv->plane_to_crtc_mapping[plane];
379 struct intel_unpin_work {
380 struct work_struct work;
381 struct drm_device *dev;
382 struct drm_i915_gem_object *old_fb_obj;
383 struct drm_i915_gem_object *pending_flip_obj;
384 struct drm_pending_vblank_event *event;
386 bool enable_stall_check;
389 struct intel_fbc_work {
390 struct delayed_work work;
391 struct drm_crtc *crtc;
392 struct drm_framebuffer *fb;
396 int intel_connector_update_modes(struct drm_connector *connector,
398 int intel_ddc_get_modes(struct drm_connector *c, struct i2c_adapter *adapter);
400 extern void intel_attach_force_audio_property(struct drm_connector *connector);
401 extern void intel_attach_broadcast_rgb_property(struct drm_connector *connector);
403 extern void intel_crt_init(struct drm_device *dev);
404 extern void intel_hdmi_init(struct drm_device *dev,
405 int sdvox_reg, enum port port);
406 extern struct intel_hdmi *enc_to_intel_hdmi(struct drm_encoder *encoder);
407 extern void intel_dip_infoframe_csum(struct dip_infoframe *avi_if);
408 extern bool intel_sdvo_init(struct drm_device *dev, uint32_t sdvo_reg,
410 extern void intel_dvo_init(struct drm_device *dev);
411 extern void intel_tv_init(struct drm_device *dev);
412 extern void intel_mark_busy(struct drm_device *dev);
413 extern void intel_mark_idle(struct drm_device *dev);
414 extern void intel_mark_fb_busy(struct drm_i915_gem_object *obj);
415 extern void intel_mark_fb_idle(struct drm_i915_gem_object *obj);
416 extern bool intel_lvds_init(struct drm_device *dev);
417 extern void intel_dp_init(struct drm_device *dev, int output_reg,
420 intel_dp_set_m_n(struct drm_crtc *crtc, struct drm_display_mode *mode,
421 struct drm_display_mode *adjusted_mode);
422 extern bool intel_dpd_is_edp(struct drm_device *dev);
423 extern void intel_edp_link_config(struct intel_encoder *, int *, int *);
424 extern int intel_edp_target_clock(struct intel_encoder *,
425 struct drm_display_mode *mode);
426 extern bool intel_encoder_is_pch_edp(struct drm_encoder *encoder);
427 extern int intel_plane_init(struct drm_device *dev, enum pipe pipe);
428 extern void intel_flush_display_plane(struct drm_i915_private *dev_priv,
432 extern void intel_fixed_panel_mode(struct drm_display_mode *fixed_mode,
433 struct drm_display_mode *adjusted_mode);
434 extern void intel_pch_panel_fitting(struct drm_device *dev,
436 const struct drm_display_mode *mode,
437 struct drm_display_mode *adjusted_mode);
438 extern u32 intel_panel_get_max_backlight(struct drm_device *dev);
439 extern void intel_panel_set_backlight(struct drm_device *dev, u32 level);
440 extern int intel_panel_setup_backlight(struct drm_device *dev);
441 extern void intel_panel_enable_backlight(struct drm_device *dev,
443 extern void intel_panel_disable_backlight(struct drm_device *dev);
444 extern void intel_panel_destroy_backlight(struct drm_device *dev);
445 extern enum drm_connector_status intel_panel_detect(struct drm_device *dev);
447 struct intel_set_config {
448 struct drm_encoder **save_connector_encoders;
449 struct drm_crtc **save_encoder_crtcs;
455 extern bool intel_set_mode(struct drm_crtc *crtc, struct drm_display_mode *mode,
456 int x, int y, struct drm_framebuffer *old_fb);
457 extern void intel_modeset_disable(struct drm_device *dev);
458 extern void intel_crtc_load_lut(struct drm_crtc *crtc);
459 extern void intel_crtc_update_dpms(struct drm_crtc *crtc);
460 extern void intel_encoder_noop(struct drm_encoder *encoder);
461 extern void intel_encoder_destroy(struct drm_encoder *encoder);
462 extern void intel_encoder_dpms(struct intel_encoder *encoder, int mode);
463 extern bool intel_encoder_check_is_cloned(struct intel_encoder *encoder);
464 extern void intel_connector_dpms(struct drm_connector *, int mode);
465 extern bool intel_connector_get_hw_state(struct intel_connector *connector);
466 extern void intel_modeset_check_state(struct drm_device *dev);
469 static inline struct intel_encoder *intel_attached_encoder(struct drm_connector *connector)
471 return to_intel_connector(connector)->encoder;
474 extern void intel_connector_attach_encoder(struct intel_connector *connector,
475 struct intel_encoder *encoder);
476 extern struct drm_encoder *intel_best_encoder(struct drm_connector *connector);
478 extern struct drm_display_mode *intel_crtc_mode_get(struct drm_device *dev,
479 struct drm_crtc *crtc);
480 int intel_get_pipe_from_crtc_id(struct drm_device *dev, void *data,
481 struct drm_file *file_priv);
482 extern void intel_wait_for_vblank(struct drm_device *dev, int pipe);
483 extern void intel_wait_for_pipe_off(struct drm_device *dev, int pipe);
485 struct intel_load_detect_pipe {
486 struct drm_framebuffer *release_fb;
487 bool load_detect_temp;
490 extern bool intel_get_load_detect_pipe(struct drm_connector *connector,
491 struct drm_display_mode *mode,
492 struct intel_load_detect_pipe *old);
493 extern void intel_release_load_detect_pipe(struct drm_connector *connector,
494 struct intel_load_detect_pipe *old);
496 extern void intelfb_restore(void);
497 extern void intel_crtc_fb_gamma_set(struct drm_crtc *crtc, u16 red, u16 green,
498 u16 blue, int regno);
499 extern void intel_crtc_fb_gamma_get(struct drm_crtc *crtc, u16 *red, u16 *green,
500 u16 *blue, int regno);
501 extern void intel_enable_clock_gating(struct drm_device *dev);
503 extern int intel_pin_and_fence_fb_obj(struct drm_device *dev,
504 struct drm_i915_gem_object *obj,
505 struct intel_ring_buffer *pipelined);
506 extern void intel_unpin_fb_obj(struct drm_i915_gem_object *obj);
508 extern int intel_framebuffer_init(struct drm_device *dev,
509 struct intel_framebuffer *ifb,
510 struct drm_mode_fb_cmd2 *mode_cmd,
511 struct drm_i915_gem_object *obj);
512 extern int intel_fbdev_init(struct drm_device *dev);
513 extern void intel_fbdev_fini(struct drm_device *dev);
514 extern void intel_fbdev_set_suspend(struct drm_device *dev, int state);
515 extern void intel_prepare_page_flip(struct drm_device *dev, int plane);
516 extern void intel_finish_page_flip(struct drm_device *dev, int pipe);
517 extern void intel_finish_page_flip_plane(struct drm_device *dev, int plane);
519 extern void intel_setup_overlay(struct drm_device *dev);
520 extern void intel_cleanup_overlay(struct drm_device *dev);
521 extern int intel_overlay_switch_off(struct intel_overlay *overlay);
522 extern int intel_overlay_put_image(struct drm_device *dev, void *data,
523 struct drm_file *file_priv);
524 extern int intel_overlay_attrs(struct drm_device *dev, void *data,
525 struct drm_file *file_priv);
527 extern void intel_fb_output_poll_changed(struct drm_device *dev);
528 extern void intel_fb_restore_mode(struct drm_device *dev);
530 extern void assert_pipe(struct drm_i915_private *dev_priv, enum pipe pipe,
532 #define assert_pipe_enabled(d, p) assert_pipe(d, p, true)
533 #define assert_pipe_disabled(d, p) assert_pipe(d, p, false)
535 extern void intel_init_clock_gating(struct drm_device *dev);
536 extern void intel_write_eld(struct drm_encoder *encoder,
537 struct drm_display_mode *mode);
538 extern void intel_cpt_verify_modeset(struct drm_device *dev, int pipe);
539 extern void intel_prepare_ddi(struct drm_device *dev);
540 extern void hsw_fdi_link_train(struct drm_crtc *crtc);
541 extern void intel_ddi_init(struct drm_device *dev, enum port port);
543 /* For use by IVB LP watermark workaround in intel_sprite.c */
544 extern void intel_update_watermarks(struct drm_device *dev);
545 extern void intel_update_sprite_watermarks(struct drm_device *dev, int pipe,
546 uint32_t sprite_width,
548 extern void intel_update_linetime_watermarks(struct drm_device *dev, int pipe,
549 struct drm_display_mode *mode);
551 extern int intel_sprite_set_colorkey(struct drm_device *dev, void *data,
552 struct drm_file *file_priv);
553 extern int intel_sprite_get_colorkey(struct drm_device *dev, void *data,
554 struct drm_file *file_priv);
556 extern u32 intel_dpio_read(struct drm_i915_private *dev_priv, int reg);
558 /* Power-related functions, located in intel_pm.c */
559 extern void intel_init_pm(struct drm_device *dev);
561 extern bool intel_fbc_enabled(struct drm_device *dev);
562 extern void intel_enable_fbc(struct drm_crtc *crtc, unsigned long interval);
563 extern void intel_update_fbc(struct drm_device *dev);
565 extern void intel_gpu_ips_init(struct drm_i915_private *dev_priv);
566 extern void intel_gpu_ips_teardown(void);
568 extern void intel_init_power_wells(struct drm_device *dev);
569 extern void intel_enable_gt_powersave(struct drm_device *dev);
570 extern void intel_disable_gt_powersave(struct drm_device *dev);
571 extern void gen6_gt_check_fifodbg(struct drm_i915_private *dev_priv);
572 extern void ironlake_teardown_rc6(struct drm_device *dev);
574 extern void intel_enable_ddi(struct intel_encoder *encoder);
575 extern void intel_disable_ddi(struct intel_encoder *encoder);
576 extern bool intel_ddi_get_hw_state(struct intel_encoder *encoder,
578 extern void intel_ddi_mode_set(struct drm_encoder *encoder,
579 struct drm_display_mode *mode,
580 struct drm_display_mode *adjusted_mode);
582 #endif /* __INTEL_DRV_H__ */