2 * Copyright © 2006-2019 Intel Corporation
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
25 #ifndef _INTEL_DISPLAY_H_
26 #define _INTEL_DISPLAY_H_
28 #include <drm/drm_util.h>
31 enum drm_scaling_filter;
35 struct drm_display_mode;
38 struct drm_format_info;
39 struct drm_framebuffer;
40 struct drm_i915_error_state_buf;
41 struct drm_i915_gem_object;
42 struct drm_i915_private;
43 struct drm_mode_fb_cmd2;
44 struct drm_modeset_acquire_ctx;
46 struct drm_plane_state;
47 struct i915_ggtt_view;
48 struct intel_atomic_state;
50 struct intel_crtc_state;
51 struct intel_crtc_state;
52 struct intel_digital_port;
55 struct intel_load_detect_pipe;
57 struct intel_plane_state;
58 struct intel_remapped_info;
59 struct intel_rotation_info;
80 * Keep the pipe enum values fixed: the code assumes that PIPE_A=0, the
81 * rest have consecutive values and match the enum values of transcoders
82 * with a 1:1 transcoder -> pipe mapping.
93 I915_MAX_PIPES = _PIPE_EDP
96 #define pipe_name(p) ((p) + 'A')
99 INVALID_TRANSCODER = -1,
101 * The following transcoders have a 1:1 transcoder -> pipe mapping,
102 * keep their values fixed: the code assumes that TRANSCODER_A=0, the
103 * rest have consecutive values and match the enum values of the pipes
106 TRANSCODER_A = PIPE_A,
107 TRANSCODER_B = PIPE_B,
108 TRANSCODER_C = PIPE_C,
109 TRANSCODER_D = PIPE_D,
112 * The following transcoders can map to any pipe, their enum value
113 * doesn't need to stay fixed.
118 TRANSCODER_DSI_A = TRANSCODER_DSI_0, /* legacy DSI */
119 TRANSCODER_DSI_C = TRANSCODER_DSI_1, /* legacy DSI */
124 static inline const char *transcoder_name(enum transcoder transcoder)
126 switch (transcoder) {
137 case TRANSCODER_DSI_A:
139 case TRANSCODER_DSI_C:
146 static inline bool transcoder_is_dsi(enum transcoder transcoder)
148 return transcoder == TRANSCODER_DSI_A || transcoder == TRANSCODER_DSI_C;
152 * Global legacy plane identifier. Valid only for primary/sprite
153 * planes on pre-g4x, and only for primary planes on g4x-bdw.
161 #define plane_name(p) ((p) + 'A')
162 #define sprite_name(p, s) ((p) * RUNTIME_INFO(dev_priv)->num_sprites[(p)] + (s) + 'A')
165 * Per-pipe plane identifier.
166 * I915_MAX_PLANES in the enum below is the maximum (across all platforms)
167 * number of planes per CRTC. Not all platforms really have this many planes,
168 * which means some arrays of size I915_MAX_PLANES may have unused entries
169 * between the topmost sprite plane and the cursor plane.
171 * This is expected to be passed to various register macros
172 * (eg. PLANE_CTL(), PS_PLANE_SEL(), etc.) so adjust with care.
187 #define for_each_plane_id_on_crtc(__crtc, __p) \
188 for ((__p) = PLANE_PRIMARY; (__p) < I915_MAX_PLANES; (__p)++) \
189 for_each_if((__crtc)->plane_ids_mask & BIT(__p))
191 #define for_each_dbuf_slice_in_mask(__slice, __mask) \
192 for ((__slice) = DBUF_S1; (__slice) < I915_MAX_DBUF_SLICES; (__slice)++) \
193 for_each_if((BIT(__slice)) & (__mask))
195 #define for_each_dbuf_slice(__slice) \
196 for_each_dbuf_slice_in_mask(__slice, BIT(I915_MAX_DBUF_SLICES) - 1)
222 #define port_name(p) ((p) + 'A')
225 * Ports identifier referenced from other drivers.
226 * Expected to remain stable over time
228 static inline const char *port_identifier(enum port port)
296 AUX_CH_USBC1 = AUX_CH_D,
304 #define aux_ch_name(a) ((a) + 'A')
306 /* Used by dp and fdi links */
307 struct intel_link_m_n {
331 #define phy_name(a) ((a) + 'A')
339 #define for_each_pipe(__dev_priv, __p) \
340 for ((__p) = 0; (__p) < I915_MAX_PIPES; (__p)++) \
341 for_each_if(INTEL_INFO(__dev_priv)->pipe_mask & BIT(__p))
343 #define for_each_pipe_masked(__dev_priv, __p, __mask) \
344 for_each_pipe(__dev_priv, __p) \
345 for_each_if((__mask) & BIT(__p))
347 #define for_each_cpu_transcoder(__dev_priv, __t) \
348 for ((__t) = 0; (__t) < I915_MAX_TRANSCODERS; (__t)++) \
349 for_each_if (INTEL_INFO(__dev_priv)->cpu_transcoder_mask & BIT(__t))
351 #define for_each_cpu_transcoder_masked(__dev_priv, __t, __mask) \
352 for_each_cpu_transcoder(__dev_priv, __t) \
353 for_each_if ((__mask) & BIT(__t))
355 #define for_each_universal_plane(__dev_priv, __pipe, __p) \
357 (__p) < RUNTIME_INFO(__dev_priv)->num_sprites[(__pipe)] + 1; \
360 #define for_each_sprite(__dev_priv, __p, __s) \
362 (__s) < RUNTIME_INFO(__dev_priv)->num_sprites[(__p)]; \
365 #define for_each_port(__port) \
366 for ((__port) = PORT_A; (__port) < I915_MAX_PORTS; (__port)++)
368 #define for_each_port_masked(__port, __ports_mask) \
369 for_each_port(__port) \
370 for_each_if((__ports_mask) & BIT(__port))
372 #define for_each_phy_masked(__phy, __phys_mask) \
373 for ((__phy) = PHY_A; (__phy) < I915_MAX_PHYS; (__phy)++) \
374 for_each_if((__phys_mask) & BIT(__phy))
376 #define for_each_crtc(dev, crtc) \
377 list_for_each_entry(crtc, &(dev)->mode_config.crtc_list, head)
379 #define for_each_intel_plane(dev, intel_plane) \
380 list_for_each_entry(intel_plane, \
381 &(dev)->mode_config.plane_list, \
384 #define for_each_intel_plane_mask(dev, intel_plane, plane_mask) \
385 list_for_each_entry(intel_plane, \
386 &(dev)->mode_config.plane_list, \
388 for_each_if((plane_mask) & \
389 drm_plane_mask(&intel_plane->base))
391 #define for_each_intel_plane_on_crtc(dev, intel_crtc, intel_plane) \
392 list_for_each_entry(intel_plane, \
393 &(dev)->mode_config.plane_list, \
395 for_each_if((intel_plane)->pipe == (intel_crtc)->pipe)
397 #define for_each_intel_crtc(dev, intel_crtc) \
398 list_for_each_entry(intel_crtc, \
399 &(dev)->mode_config.crtc_list, \
402 #define for_each_intel_crtc_mask(dev, intel_crtc, crtc_mask) \
403 list_for_each_entry(intel_crtc, \
404 &(dev)->mode_config.crtc_list, \
406 for_each_if((crtc_mask) & drm_crtc_mask(&intel_crtc->base))
408 #define for_each_intel_encoder(dev, intel_encoder) \
409 list_for_each_entry(intel_encoder, \
410 &(dev)->mode_config.encoder_list, \
413 #define for_each_intel_encoder_mask(dev, intel_encoder, encoder_mask) \
414 list_for_each_entry(intel_encoder, \
415 &(dev)->mode_config.encoder_list, \
417 for_each_if((encoder_mask) & \
418 drm_encoder_mask(&intel_encoder->base))
420 #define for_each_intel_dp(dev, intel_encoder) \
421 for_each_intel_encoder(dev, intel_encoder) \
422 for_each_if(intel_encoder_is_dp(intel_encoder))
424 #define for_each_intel_connector_iter(intel_connector, iter) \
425 while ((intel_connector = to_intel_connector(drm_connector_list_iter_next(iter))))
427 #define for_each_encoder_on_crtc(dev, __crtc, intel_encoder) \
428 list_for_each_entry((intel_encoder), &(dev)->mode_config.encoder_list, base.head) \
429 for_each_if((intel_encoder)->base.crtc == (__crtc))
431 #define for_each_connector_on_encoder(dev, __encoder, intel_connector) \
432 list_for_each_entry((intel_connector), &(dev)->mode_config.connector_list, base.head) \
433 for_each_if((intel_connector)->base.encoder == (__encoder))
435 #define for_each_old_intel_plane_in_state(__state, plane, old_plane_state, __i) \
437 (__i) < (__state)->base.dev->mode_config.num_total_plane && \
438 ((plane) = to_intel_plane((__state)->base.planes[__i].ptr), \
439 (old_plane_state) = to_intel_plane_state((__state)->base.planes[__i].old_state), 1); \
443 #define for_each_new_intel_plane_in_state(__state, plane, new_plane_state, __i) \
445 (__i) < (__state)->base.dev->mode_config.num_total_plane && \
446 ((plane) = to_intel_plane((__state)->base.planes[__i].ptr), \
447 (new_plane_state) = to_intel_plane_state((__state)->base.planes[__i].new_state), 1); \
451 #define for_each_new_intel_crtc_in_state(__state, crtc, new_crtc_state, __i) \
453 (__i) < (__state)->base.dev->mode_config.num_crtc && \
454 ((crtc) = to_intel_crtc((__state)->base.crtcs[__i].ptr), \
455 (new_crtc_state) = to_intel_crtc_state((__state)->base.crtcs[__i].new_state), 1); \
459 #define for_each_oldnew_intel_plane_in_state(__state, plane, old_plane_state, new_plane_state, __i) \
461 (__i) < (__state)->base.dev->mode_config.num_total_plane && \
462 ((plane) = to_intel_plane((__state)->base.planes[__i].ptr), \
463 (old_plane_state) = to_intel_plane_state((__state)->base.planes[__i].old_state), \
464 (new_plane_state) = to_intel_plane_state((__state)->base.planes[__i].new_state), 1); \
468 #define for_each_oldnew_intel_crtc_in_state(__state, crtc, old_crtc_state, new_crtc_state, __i) \
470 (__i) < (__state)->base.dev->mode_config.num_crtc && \
471 ((crtc) = to_intel_crtc((__state)->base.crtcs[__i].ptr), \
472 (old_crtc_state) = to_intel_crtc_state((__state)->base.crtcs[__i].old_state), \
473 (new_crtc_state) = to_intel_crtc_state((__state)->base.crtcs[__i].new_state), 1); \
477 #define for_each_oldnew_intel_crtc_in_state_reverse(__state, crtc, old_crtc_state, new_crtc_state, __i) \
478 for ((__i) = (__state)->base.dev->mode_config.num_crtc - 1; \
480 ((crtc) = to_intel_crtc((__state)->base.crtcs[__i].ptr), \
481 (old_crtc_state) = to_intel_crtc_state((__state)->base.crtcs[__i].old_state), \
482 (new_crtc_state) = to_intel_crtc_state((__state)->base.crtcs[__i].new_state), 1); \
486 #define intel_atomic_crtc_state_for_each_plane_state( \
487 plane, plane_state, \
489 for_each_intel_plane_mask(((crtc_state)->uapi.state->dev), (plane), \
490 ((crtc_state)->uapi.plane_mask)) \
491 for_each_if ((plane_state = \
492 to_intel_plane_state(__drm_atomic_get_current_plane_state((crtc_state)->uapi.state, &plane->base))))
494 #define for_each_new_intel_connector_in_state(__state, connector, new_connector_state, __i) \
496 (__i) < (__state)->base.num_connector; \
498 for_each_if ((__state)->base.connectors[__i].ptr && \
499 ((connector) = to_intel_connector((__state)->base.connectors[__i].ptr), \
500 (new_connector_state) = to_intel_digital_connector_state((__state)->base.connectors[__i].new_state), 1))
502 u8 intel_calc_active_pipes(struct intel_atomic_state *state,
504 void intel_link_compute_m_n(u16 bpp, int nlanes,
505 int pixel_clock, int link_clock,
506 struct intel_link_m_n *m_n,
507 bool constant_n, bool fec_enable);
508 bool is_ccs_modifier(u64 modifier);
509 int intel_main_to_aux_plane(const struct drm_framebuffer *fb, int main_plane);
510 void lpt_disable_clkout_dp(struct drm_i915_private *dev_priv);
511 u32 intel_plane_fb_max_stride(struct drm_i915_private *dev_priv,
512 u32 pixel_format, u64 modifier);
513 bool intel_plane_can_remap(const struct intel_plane_state *plane_state);
515 intel_mode_valid_max_plane_size(struct drm_i915_private *dev_priv,
516 const struct drm_display_mode *mode,
518 enum phy intel_port_to_phy(struct drm_i915_private *i915, enum port port);
519 bool is_trans_port_sync_mode(const struct intel_crtc_state *state);
521 void intel_plane_destroy(struct drm_plane *plane);
522 void intel_enable_pipe(const struct intel_crtc_state *new_crtc_state);
523 void intel_disable_pipe(const struct intel_crtc_state *old_crtc_state);
524 void i830_enable_pipe(struct drm_i915_private *dev_priv, enum pipe pipe);
525 void i830_disable_pipe(struct drm_i915_private *dev_priv, enum pipe pipe);
526 enum pipe intel_crtc_pch_transcoder(struct intel_crtc *crtc);
527 int vlv_get_hpll_vco(struct drm_i915_private *dev_priv);
528 int vlv_get_cck_clock(struct drm_i915_private *dev_priv,
529 const char *name, u32 reg, int ref_freq);
530 int vlv_get_cck_clock_hpll(struct drm_i915_private *dev_priv,
531 const char *name, u32 reg);
532 void lpt_pch_enable(const struct intel_crtc_state *crtc_state);
533 void lpt_disable_pch_transcoder(struct drm_i915_private *dev_priv);
534 void lpt_disable_iclkip(struct drm_i915_private *dev_priv);
535 void intel_init_display_hooks(struct drm_i915_private *dev_priv);
536 unsigned int intel_fb_xy_to_linear(int x, int y,
537 const struct intel_plane_state *state,
539 unsigned int intel_fb_align_height(const struct drm_framebuffer *fb,
540 int color_plane, unsigned int height);
541 void intel_add_fb_offsets(int *x, int *y,
542 const struct intel_plane_state *state, int plane);
543 unsigned int intel_rotation_info_size(const struct intel_rotation_info *rot_info);
544 unsigned int intel_remapped_info_size(const struct intel_remapped_info *rem_info);
545 bool intel_has_pending_fb_unpin(struct drm_i915_private *dev_priv);
546 int intel_display_suspend(struct drm_device *dev);
547 void intel_pps_unlock_regs_wa(struct drm_i915_private *dev_priv);
548 void intel_encoder_destroy(struct drm_encoder *encoder);
549 struct drm_display_mode *
550 intel_encoder_current_mode(struct intel_encoder *encoder);
551 bool intel_phy_is_combo(struct drm_i915_private *dev_priv, enum phy phy);
552 bool intel_phy_is_tc(struct drm_i915_private *dev_priv, enum phy phy);
553 enum tc_port intel_port_to_tc(struct drm_i915_private *dev_priv,
555 int intel_get_pipe_from_crtc_id_ioctl(struct drm_device *dev, void *data,
556 struct drm_file *file_priv);
557 u32 intel_crtc_get_vblank_counter(struct intel_crtc *crtc);
558 void intel_crtc_vblank_on(const struct intel_crtc_state *crtc_state);
559 void intel_crtc_vblank_off(const struct intel_crtc_state *crtc_state);
561 int ilk_get_lanes_required(int target_clock, int link_bw, int bpp);
562 void vlv_wait_port_ready(struct drm_i915_private *dev_priv,
563 struct intel_digital_port *dig_port,
564 unsigned int expected_mask);
565 int intel_get_load_detect_pipe(struct drm_connector *connector,
566 struct intel_load_detect_pipe *old,
567 struct drm_modeset_acquire_ctx *ctx);
568 void intel_release_load_detect_pipe(struct drm_connector *connector,
569 struct intel_load_detect_pipe *old,
570 struct drm_modeset_acquire_ctx *ctx);
572 intel_pin_and_fence_fb_obj(struct drm_framebuffer *fb,
573 const struct i915_ggtt_view *view,
575 unsigned long *out_flags);
576 void intel_unpin_fb_vma(struct i915_vma *vma, unsigned long flags);
577 struct drm_framebuffer *
578 intel_framebuffer_create(struct drm_i915_gem_object *obj,
579 struct drm_mode_fb_cmd2 *mode_cmd);
580 int intel_prepare_plane_fb(struct drm_plane *plane,
581 struct drm_plane_state *new_state);
582 void intel_cleanup_plane_fb(struct drm_plane *plane,
583 struct drm_plane_state *old_state);
585 void assert_pch_transcoder_disabled(struct drm_i915_private *dev_priv,
588 int vlv_force_pll_on(struct drm_i915_private *dev_priv, enum pipe pipe,
589 const struct dpll *dpll);
590 void vlv_force_pll_off(struct drm_i915_private *dev_priv, enum pipe pipe);
591 int lpt_get_iclkip(struct drm_i915_private *dev_priv);
592 bool intel_fuzzy_clock_check(int clock1, int clock2);
594 void intel_display_prepare_reset(struct drm_i915_private *dev_priv);
595 void intel_display_finish_reset(struct drm_i915_private *dev_priv);
596 void intel_dp_get_m_n(struct intel_crtc *crtc,
597 struct intel_crtc_state *pipe_config);
598 void intel_dp_set_m_n(const struct intel_crtc_state *crtc_state,
599 enum link_m_n_set m_n);
600 int intel_dotclock_calculate(int link_freq, const struct intel_link_m_n *m_n);
601 bool bxt_find_best_dpll(struct intel_crtc_state *crtc_state,
602 struct dpll *best_clock);
603 int chv_calc_dpll_params(int refclk, struct dpll *pll_clock);
605 bool hsw_crtc_state_ips_capable(const struct intel_crtc_state *crtc_state);
606 void hsw_enable_ips(const struct intel_crtc_state *crtc_state);
607 void hsw_disable_ips(const struct intel_crtc_state *crtc_state);
608 enum intel_display_power_domain intel_port_to_power_domain(enum port port);
609 enum intel_display_power_domain
610 intel_aux_power_domain(struct intel_digital_port *dig_port);
611 enum intel_display_power_domain
612 intel_legacy_aux_to_power_domain(enum aux_ch aux_ch);
613 void intel_crtc_arm_fifo_underrun(struct intel_crtc *crtc,
614 struct intel_crtc_state *crtc_state);
616 u16 skl_scaler_calc_phase(int sub, int scale, bool chroma_center);
617 void skl_scaler_disable(const struct intel_crtc_state *old_crtc_state);
618 u32 skl_scaler_get_filter_select(enum drm_scaling_filter filter, int set);
619 void skl_scaler_setup_filter(struct drm_i915_private *dev_priv, enum pipe pipe,
620 int id, int set, enum drm_scaling_filter filter);
621 void ilk_pfit_disable(const struct intel_crtc_state *old_crtc_state);
622 u32 glk_plane_color_ctl(const struct intel_crtc_state *crtc_state,
623 const struct intel_plane_state *plane_state);
624 u32 glk_plane_color_ctl_crtc(const struct intel_crtc_state *crtc_state);
625 u32 skl_plane_ctl(const struct intel_crtc_state *crtc_state,
626 const struct intel_plane_state *plane_state);
627 u32 skl_plane_ctl_crtc(const struct intel_crtc_state *crtc_state);
628 u32 skl_plane_stride(const struct intel_plane_state *plane_state,
630 int skl_check_plane_surface(struct intel_plane_state *plane_state);
631 int i9xx_check_plane_surface(struct intel_plane_state *plane_state);
632 int skl_format_to_fourcc(int format, bool rgb_order, bool alpha);
633 unsigned int i9xx_plane_max_stride(struct intel_plane *plane,
634 u32 pixel_format, u64 modifier,
635 unsigned int rotation);
636 int bdw_get_pipemisc_bpp(struct intel_crtc *crtc);
637 unsigned int intel_plane_fence_y_offset(const struct intel_plane_state *plane_state);
639 struct intel_display_error_state *
640 intel_display_capture_error_state(struct drm_i915_private *dev_priv);
641 void intel_display_print_error_state(struct drm_i915_error_state_buf *e,
642 struct intel_display_error_state *error);
645 intel_format_info_is_yuv_semiplanar(const struct drm_format_info *info,
649 void intel_modeset_init_hw(struct drm_i915_private *i915);
650 int intel_modeset_init_noirq(struct drm_i915_private *i915);
651 int intel_modeset_init_nogem(struct drm_i915_private *i915);
652 int intel_modeset_init(struct drm_i915_private *i915);
653 void intel_modeset_driver_remove(struct drm_i915_private *i915);
654 void intel_modeset_driver_remove_noirq(struct drm_i915_private *i915);
655 void intel_modeset_driver_remove_nogem(struct drm_i915_private *i915);
656 void intel_display_resume(struct drm_device *dev);
657 void intel_init_pch_refclk(struct drm_i915_private *dev_priv);
659 /* modesetting asserts */
660 void assert_panel_unlocked(struct drm_i915_private *dev_priv,
662 void assert_pll(struct drm_i915_private *dev_priv,
663 enum pipe pipe, bool state);
664 #define assert_pll_enabled(d, p) assert_pll(d, p, true)
665 #define assert_pll_disabled(d, p) assert_pll(d, p, false)
666 void assert_dsi_pll(struct drm_i915_private *dev_priv, bool state);
667 #define assert_dsi_pll_enabled(d) assert_dsi_pll(d, true)
668 #define assert_dsi_pll_disabled(d) assert_dsi_pll(d, false)
669 void assert_fdi_rx_pll(struct drm_i915_private *dev_priv,
670 enum pipe pipe, bool state);
671 #define assert_fdi_rx_pll_enabled(d, p) assert_fdi_rx_pll(d, p, true)
672 #define assert_fdi_rx_pll_disabled(d, p) assert_fdi_rx_pll(d, p, false)
673 void assert_pipe(struct drm_i915_private *dev_priv,
674 enum transcoder cpu_transcoder, bool state);
675 #define assert_pipe_enabled(d, t) assert_pipe(d, t, true)
676 #define assert_pipe_disabled(d, t) assert_pipe(d, t, false)
678 /* Use I915_STATE_WARN(x) and I915_STATE_WARN_ON() (rather than WARN() and
679 * WARN_ON()) for hw state sanity checks to check for unexpected conditions
680 * which may not necessarily be a user visible problem. This will either
681 * WARN() or DRM_ERROR() depending on the verbose_checks moduleparam, to
682 * enable distros and users to tailor their preferred amount of i915 abrt
685 #define I915_STATE_WARN(condition, format...) ({ \
686 int __ret_warn_on = !!(condition); \
687 if (unlikely(__ret_warn_on)) \
688 if (!WARN(i915_modparams.verbose_state_checks, format)) \
690 unlikely(__ret_warn_on); \
693 #define I915_STATE_WARN_ON(x) \
694 I915_STATE_WARN((x), "%s", "WARN_ON(" __stringify(x) ")")