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>
30 #include "i915_reg_defs.h"
32 enum drm_scaling_filter;
36 struct drm_display_mode;
39 struct drm_format_info;
40 struct drm_framebuffer;
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_address_space;
49 struct intel_atomic_state;
51 struct intel_crtc_state;
52 struct intel_digital_port;
55 struct intel_initial_plane_config;
56 struct intel_load_detect_pipe;
58 struct intel_plane_state;
59 struct intel_power_domain_mask;
60 struct intel_remapped_info;
61 struct intel_rotation_info;
83 * Keep the pipe enum values fixed: the code assumes that PIPE_A=0, the
84 * rest have consecutive values and match the enum values of transcoders
85 * with a 1:1 transcoder -> pipe mapping.
96 I915_MAX_PIPES = _PIPE_EDP
99 #define pipe_name(p) ((p) + 'A')
102 INVALID_TRANSCODER = -1,
104 * The following transcoders have a 1:1 transcoder -> pipe mapping,
105 * keep their values fixed: the code assumes that TRANSCODER_A=0, the
106 * rest have consecutive values and match the enum values of the pipes
109 TRANSCODER_A = PIPE_A,
110 TRANSCODER_B = PIPE_B,
111 TRANSCODER_C = PIPE_C,
112 TRANSCODER_D = PIPE_D,
115 * The following transcoders can map to any pipe, their enum value
116 * doesn't need to stay fixed.
121 TRANSCODER_DSI_A = TRANSCODER_DSI_0, /* legacy DSI */
122 TRANSCODER_DSI_C = TRANSCODER_DSI_1, /* legacy DSI */
127 static inline const char *transcoder_name(enum transcoder transcoder)
129 switch (transcoder) {
140 case TRANSCODER_DSI_A:
142 case TRANSCODER_DSI_C:
149 static inline bool transcoder_is_dsi(enum transcoder transcoder)
151 return transcoder == TRANSCODER_DSI_A || transcoder == TRANSCODER_DSI_C;
155 * Global legacy plane identifier. Valid only for primary/sprite
156 * planes on pre-g4x, and only for primary planes on g4x-bdw.
164 #define plane_name(p) ((p) + 'A')
165 #define sprite_name(p, s) ((p) * RUNTIME_INFO(dev_priv)->num_sprites[(p)] + (s) + 'A')
168 * Per-pipe plane identifier.
169 * I915_MAX_PLANES in the enum below is the maximum (across all platforms)
170 * number of planes per CRTC. Not all platforms really have this many planes,
171 * which means some arrays of size I915_MAX_PLANES may have unused entries
172 * between the topmost sprite plane and the cursor plane.
174 * This is expected to be passed to various register macros
175 * (eg. PLANE_CTL(), PS_PLANE_SEL(), etc.) so adjust with care.
190 #define for_each_plane_id_on_crtc(__crtc, __p) \
191 for ((__p) = PLANE_PRIMARY; (__p) < I915_MAX_PLANES; (__p)++) \
192 for_each_if((__crtc)->plane_ids_mask & BIT(__p))
194 #define for_each_dbuf_slice(__dev_priv, __slice) \
195 for ((__slice) = DBUF_S1; (__slice) < I915_MAX_DBUF_SLICES; (__slice)++) \
196 for_each_if(INTEL_INFO(__dev_priv)->display.dbuf.slice_mask & BIT(__slice))
198 #define for_each_dbuf_slice_in_mask(__dev_priv, __slice, __mask) \
199 for_each_dbuf_slice((__dev_priv), (__slice)) \
200 for_each_if((__mask) & BIT(__slice))
223 /* XE_LPD repositions D/E offsets and bitfields */
224 PORT_D_XELPD = PORT_TC5,
230 #define port_name(p) ((p) + 'A')
233 * Ports identifier referenced from other drivers.
234 * Expected to remain stable over time
236 static inline const char *port_identifier(enum port port)
276 TC_PORT_DISCONNECTED,
305 AUX_CH_USBC1 = AUX_CH_D,
312 /* XE_LPD repositions D/E offsets and bitfields */
313 AUX_CH_D_XELPD = AUX_CH_USBC5,
317 #define aux_ch_name(a) ((a) + 'A')
319 /* Used by dp and fdi links */
320 struct intel_link_m_n {
344 #define phy_name(a) ((a) + 'A')
354 HPD_TV = HPD_NONE, /* TV is known to be unreliable */
373 #define for_each_hpd_pin(__pin) \
374 for ((__pin) = (HPD_NONE + 1); (__pin) < HPD_NUM_PINS; (__pin)++)
376 #define for_each_pipe(__dev_priv, __p) \
377 for ((__p) = 0; (__p) < I915_MAX_PIPES; (__p)++) \
378 for_each_if(RUNTIME_INFO(__dev_priv)->pipe_mask & BIT(__p))
380 #define for_each_pipe_masked(__dev_priv, __p, __mask) \
381 for_each_pipe(__dev_priv, __p) \
382 for_each_if((__mask) & BIT(__p))
384 #define for_each_cpu_transcoder(__dev_priv, __t) \
385 for ((__t) = 0; (__t) < I915_MAX_TRANSCODERS; (__t)++) \
386 for_each_if (RUNTIME_INFO(__dev_priv)->cpu_transcoder_mask & BIT(__t))
388 #define for_each_cpu_transcoder_masked(__dev_priv, __t, __mask) \
389 for_each_cpu_transcoder(__dev_priv, __t) \
390 for_each_if ((__mask) & BIT(__t))
392 #define for_each_sprite(__dev_priv, __p, __s) \
394 (__s) < RUNTIME_INFO(__dev_priv)->num_sprites[(__p)]; \
397 #define for_each_port(__port) \
398 for ((__port) = PORT_A; (__port) < I915_MAX_PORTS; (__port)++)
400 #define for_each_port_masked(__port, __ports_mask) \
401 for_each_port(__port) \
402 for_each_if((__ports_mask) & BIT(__port))
404 #define for_each_phy_masked(__phy, __phys_mask) \
405 for ((__phy) = PHY_A; (__phy) < I915_MAX_PHYS; (__phy)++) \
406 for_each_if((__phys_mask) & BIT(__phy))
408 #define for_each_crtc(dev, crtc) \
409 list_for_each_entry(crtc, &(dev)->mode_config.crtc_list, head)
411 #define for_each_intel_plane(dev, intel_plane) \
412 list_for_each_entry(intel_plane, \
413 &(dev)->mode_config.plane_list, \
416 #define for_each_intel_plane_mask(dev, intel_plane, plane_mask) \
417 list_for_each_entry(intel_plane, \
418 &(dev)->mode_config.plane_list, \
420 for_each_if((plane_mask) & \
421 drm_plane_mask(&intel_plane->base))
423 #define for_each_intel_plane_on_crtc(dev, intel_crtc, intel_plane) \
424 list_for_each_entry(intel_plane, \
425 &(dev)->mode_config.plane_list, \
427 for_each_if((intel_plane)->pipe == (intel_crtc)->pipe)
429 #define for_each_intel_crtc(dev, intel_crtc) \
430 list_for_each_entry(intel_crtc, \
431 &(dev)->mode_config.crtc_list, \
434 #define for_each_intel_crtc_in_pipe_mask(dev, intel_crtc, pipe_mask) \
435 list_for_each_entry(intel_crtc, \
436 &(dev)->mode_config.crtc_list, \
438 for_each_if((pipe_mask) & BIT(intel_crtc->pipe))
440 #define for_each_intel_encoder(dev, intel_encoder) \
441 list_for_each_entry(intel_encoder, \
442 &(dev)->mode_config.encoder_list, \
445 #define for_each_intel_encoder_mask(dev, intel_encoder, encoder_mask) \
446 list_for_each_entry(intel_encoder, \
447 &(dev)->mode_config.encoder_list, \
449 for_each_if((encoder_mask) & \
450 drm_encoder_mask(&intel_encoder->base))
452 #define for_each_intel_encoder_mask_with_psr(dev, intel_encoder, encoder_mask) \
453 list_for_each_entry((intel_encoder), &(dev)->mode_config.encoder_list, base.head) \
454 for_each_if(((encoder_mask) & drm_encoder_mask(&(intel_encoder)->base)) && \
455 intel_encoder_can_psr(intel_encoder))
457 #define for_each_intel_dp(dev, intel_encoder) \
458 for_each_intel_encoder(dev, intel_encoder) \
459 for_each_if(intel_encoder_is_dp(intel_encoder))
461 #define for_each_intel_encoder_with_psr(dev, intel_encoder) \
462 for_each_intel_encoder((dev), (intel_encoder)) \
463 for_each_if(intel_encoder_can_psr(intel_encoder))
465 #define for_each_intel_connector_iter(intel_connector, iter) \
466 while ((intel_connector = to_intel_connector(drm_connector_list_iter_next(iter))))
468 #define for_each_encoder_on_crtc(dev, __crtc, intel_encoder) \
469 list_for_each_entry((intel_encoder), &(dev)->mode_config.encoder_list, base.head) \
470 for_each_if((intel_encoder)->base.crtc == (__crtc))
472 #define for_each_connector_on_encoder(dev, __encoder, intel_connector) \
473 list_for_each_entry((intel_connector), &(dev)->mode_config.connector_list, base.head) \
474 for_each_if((intel_connector)->base.encoder == (__encoder))
476 #define for_each_old_intel_plane_in_state(__state, plane, old_plane_state, __i) \
478 (__i) < (__state)->base.dev->mode_config.num_total_plane && \
479 ((plane) = to_intel_plane((__state)->base.planes[__i].ptr), \
480 (old_plane_state) = to_intel_plane_state((__state)->base.planes[__i].old_state), 1); \
484 #define for_each_new_intel_plane_in_state(__state, plane, new_plane_state, __i) \
486 (__i) < (__state)->base.dev->mode_config.num_total_plane && \
487 ((plane) = to_intel_plane((__state)->base.planes[__i].ptr), \
488 (new_plane_state) = to_intel_plane_state((__state)->base.planes[__i].new_state), 1); \
492 #define for_each_new_intel_crtc_in_state(__state, crtc, new_crtc_state, __i) \
494 (__i) < (__state)->base.dev->mode_config.num_crtc && \
495 ((crtc) = to_intel_crtc((__state)->base.crtcs[__i].ptr), \
496 (new_crtc_state) = to_intel_crtc_state((__state)->base.crtcs[__i].new_state), 1); \
500 #define for_each_oldnew_intel_plane_in_state(__state, plane, old_plane_state, new_plane_state, __i) \
502 (__i) < (__state)->base.dev->mode_config.num_total_plane && \
503 ((plane) = to_intel_plane((__state)->base.planes[__i].ptr), \
504 (old_plane_state) = to_intel_plane_state((__state)->base.planes[__i].old_state), \
505 (new_plane_state) = to_intel_plane_state((__state)->base.planes[__i].new_state), 1); \
509 #define for_each_oldnew_intel_crtc_in_state(__state, crtc, old_crtc_state, new_crtc_state, __i) \
511 (__i) < (__state)->base.dev->mode_config.num_crtc && \
512 ((crtc) = to_intel_crtc((__state)->base.crtcs[__i].ptr), \
513 (old_crtc_state) = to_intel_crtc_state((__state)->base.crtcs[__i].old_state), \
514 (new_crtc_state) = to_intel_crtc_state((__state)->base.crtcs[__i].new_state), 1); \
518 #define for_each_oldnew_intel_crtc_in_state_reverse(__state, crtc, old_crtc_state, new_crtc_state, __i) \
519 for ((__i) = (__state)->base.dev->mode_config.num_crtc - 1; \
521 ((crtc) = to_intel_crtc((__state)->base.crtcs[__i].ptr), \
522 (old_crtc_state) = to_intel_crtc_state((__state)->base.crtcs[__i].old_state), \
523 (new_crtc_state) = to_intel_crtc_state((__state)->base.crtcs[__i].new_state), 1); \
527 #define intel_atomic_crtc_state_for_each_plane_state( \
528 plane, plane_state, \
530 for_each_intel_plane_mask(((crtc_state)->uapi.state->dev), (plane), \
531 ((crtc_state)->uapi.plane_mask)) \
532 for_each_if ((plane_state = \
533 to_intel_plane_state(__drm_atomic_get_current_plane_state((crtc_state)->uapi.state, &plane->base))))
535 #define for_each_new_intel_connector_in_state(__state, connector, new_connector_state, __i) \
537 (__i) < (__state)->base.num_connector; \
539 for_each_if ((__state)->base.connectors[__i].ptr && \
540 ((connector) = to_intel_connector((__state)->base.connectors[__i].ptr), \
541 (new_connector_state) = to_intel_digital_connector_state((__state)->base.connectors[__i].new_state), 1))
543 int intel_atomic_add_affected_planes(struct intel_atomic_state *state,
544 struct intel_crtc *crtc);
545 u8 intel_calc_active_pipes(struct intel_atomic_state *state,
547 void intel_link_compute_m_n(u16 bpp, int nlanes,
548 int pixel_clock, int link_clock,
549 struct intel_link_m_n *m_n,
551 u32 intel_plane_fb_max_stride(struct drm_i915_private *dev_priv,
552 u32 pixel_format, u64 modifier);
554 intel_mode_valid_max_plane_size(struct drm_i915_private *dev_priv,
555 const struct drm_display_mode *mode,
557 enum phy intel_port_to_phy(struct drm_i915_private *i915, enum port port);
558 bool is_trans_port_sync_mode(const struct intel_crtc_state *state);
559 bool intel_crtc_is_bigjoiner_slave(const struct intel_crtc_state *crtc_state);
560 bool intel_crtc_is_bigjoiner_master(const struct intel_crtc_state *crtc_state);
561 u8 intel_crtc_bigjoiner_slave_pipes(const struct intel_crtc_state *crtc_state);
562 struct intel_crtc *intel_master_crtc(const struct intel_crtc_state *crtc_state);
563 bool intel_crtc_get_pipe_config(struct intel_crtc_state *crtc_state);
564 bool intel_pipe_config_compare(const struct intel_crtc_state *current_config,
565 const struct intel_crtc_state *pipe_config,
567 void intel_crtc_update_active_timings(const struct intel_crtc_state *crtc_state);
569 void intel_plane_destroy(struct drm_plane *plane);
570 void i9xx_set_pipeconf(const struct intel_crtc_state *crtc_state);
571 void ilk_set_pipeconf(const struct intel_crtc_state *crtc_state);
572 void intel_enable_transcoder(const struct intel_crtc_state *new_crtc_state);
573 void intel_disable_transcoder(const struct intel_crtc_state *old_crtc_state);
574 void i830_enable_pipe(struct drm_i915_private *dev_priv, enum pipe pipe);
575 void i830_disable_pipe(struct drm_i915_private *dev_priv, enum pipe pipe);
576 int vlv_get_hpll_vco(struct drm_i915_private *dev_priv);
577 int vlv_get_cck_clock(struct drm_i915_private *dev_priv,
578 const char *name, u32 reg, int ref_freq);
579 int vlv_get_cck_clock_hpll(struct drm_i915_private *dev_priv,
580 const char *name, u32 reg);
581 void intel_init_display_hooks(struct drm_i915_private *dev_priv);
582 unsigned int intel_fb_xy_to_linear(int x, int y,
583 const struct intel_plane_state *state,
585 void intel_add_fb_offsets(int *x, int *y,
586 const struct intel_plane_state *state, int plane);
587 unsigned int intel_rotation_info_size(const struct intel_rotation_info *rot_info);
588 unsigned int intel_remapped_info_size(const struct intel_remapped_info *rem_info);
589 bool intel_has_pending_fb_unpin(struct drm_i915_private *dev_priv);
590 int intel_display_suspend(struct drm_device *dev);
591 void intel_encoder_destroy(struct drm_encoder *encoder);
592 struct drm_display_mode *
593 intel_encoder_current_mode(struct intel_encoder *encoder);
594 void intel_encoder_get_config(struct intel_encoder *encoder,
595 struct intel_crtc_state *crtc_state);
596 bool intel_phy_is_combo(struct drm_i915_private *dev_priv, enum phy phy);
597 bool intel_phy_is_tc(struct drm_i915_private *dev_priv, enum phy phy);
598 bool intel_phy_is_snps(struct drm_i915_private *dev_priv, enum phy phy);
599 enum tc_port intel_port_to_tc(struct drm_i915_private *dev_priv,
601 int intel_get_pipe_from_crtc_id_ioctl(struct drm_device *dev, void *data,
602 struct drm_file *file_priv);
604 int ilk_get_lanes_required(int target_clock, int link_bw, int bpp);
605 void vlv_wait_port_ready(struct drm_i915_private *dev_priv,
606 struct intel_digital_port *dig_port,
607 unsigned int expected_mask);
608 int intel_get_load_detect_pipe(struct drm_connector *connector,
609 struct intel_load_detect_pipe *old,
610 struct drm_modeset_acquire_ctx *ctx);
611 void intel_release_load_detect_pipe(struct drm_connector *connector,
612 struct intel_load_detect_pipe *old,
613 struct drm_modeset_acquire_ctx *ctx);
614 struct drm_framebuffer *
615 intel_framebuffer_create(struct drm_i915_gem_object *obj,
616 struct drm_mode_fb_cmd2 *mode_cmd);
618 bool intel_fuzzy_clock_check(int clock1, int clock2);
620 void intel_display_prepare_reset(struct drm_i915_private *dev_priv);
621 void intel_display_finish_reset(struct drm_i915_private *dev_priv);
622 void intel_zero_m_n(struct intel_link_m_n *m_n);
623 void intel_set_m_n(struct drm_i915_private *i915,
624 const struct intel_link_m_n *m_n,
625 i915_reg_t data_m_reg, i915_reg_t data_n_reg,
626 i915_reg_t link_m_reg, i915_reg_t link_n_reg);
627 void intel_get_m_n(struct drm_i915_private *i915,
628 struct intel_link_m_n *m_n,
629 i915_reg_t data_m_reg, i915_reg_t data_n_reg,
630 i915_reg_t link_m_reg, i915_reg_t link_n_reg);
631 bool intel_cpu_transcoder_has_m2_n2(struct drm_i915_private *dev_priv,
632 enum transcoder transcoder);
633 void intel_cpu_transcoder_set_m1_n1(struct intel_crtc *crtc,
634 enum transcoder cpu_transcoder,
635 const struct intel_link_m_n *m_n);
636 void intel_cpu_transcoder_set_m2_n2(struct intel_crtc *crtc,
637 enum transcoder cpu_transcoder,
638 const struct intel_link_m_n *m_n);
639 void intel_cpu_transcoder_get_m1_n1(struct intel_crtc *crtc,
640 enum transcoder cpu_transcoder,
641 struct intel_link_m_n *m_n);
642 void intel_cpu_transcoder_get_m2_n2(struct intel_crtc *crtc,
643 enum transcoder cpu_transcoder,
644 struct intel_link_m_n *m_n);
645 void i9xx_crtc_clock_get(struct intel_crtc *crtc,
646 struct intel_crtc_state *pipe_config);
647 int intel_dotclock_calculate(int link_freq, const struct intel_link_m_n *m_n);
648 int intel_crtc_dotclock(const struct intel_crtc_state *pipe_config);
649 enum intel_display_power_domain intel_port_to_power_domain(struct intel_digital_port *dig_port);
650 enum intel_display_power_domain
651 intel_aux_power_domain(struct intel_digital_port *dig_port);
652 void intel_crtc_arm_fifo_underrun(struct intel_crtc *crtc,
653 struct intel_crtc_state *crtc_state);
654 void ilk_pfit_disable(const struct intel_crtc_state *old_crtc_state);
656 int bdw_get_pipemisc_bpp(struct intel_crtc *crtc);
657 unsigned int intel_plane_fence_y_offset(const struct intel_plane_state *plane_state);
659 bool intel_plane_uses_fence(const struct intel_plane_state *plane_state);
661 struct intel_encoder *
662 intel_get_crtc_new_encoder(const struct intel_atomic_state *state,
663 const struct intel_crtc_state *crtc_state);
664 void intel_plane_disable_noatomic(struct intel_crtc *crtc,
665 struct intel_plane *plane);
666 void intel_set_plane_visible(struct intel_crtc_state *crtc_state,
667 struct intel_plane_state *plane_state,
669 void intel_plane_fixup_bitmasks(struct intel_crtc_state *crtc_state);
671 void intel_display_driver_register(struct drm_i915_private *i915);
672 void intel_display_driver_unregister(struct drm_i915_private *i915);
674 void intel_update_watermarks(struct drm_i915_private *i915);
677 bool intel_modeset_probe_defer(struct pci_dev *pdev);
678 void intel_modeset_init_hw(struct drm_i915_private *i915);
679 int intel_modeset_init_noirq(struct drm_i915_private *i915);
680 int intel_modeset_init_nogem(struct drm_i915_private *i915);
681 int intel_modeset_init(struct drm_i915_private *i915);
682 void intel_modeset_driver_remove(struct drm_i915_private *i915);
683 void intel_modeset_driver_remove_noirq(struct drm_i915_private *i915);
684 void intel_modeset_driver_remove_nogem(struct drm_i915_private *i915);
685 void intel_display_resume(struct drm_device *dev);
686 int intel_modeset_all_pipes(struct intel_atomic_state *state);
687 void intel_modeset_get_crtc_power_domains(struct intel_crtc_state *crtc_state,
688 struct intel_power_domain_mask *old_domains);
689 void intel_modeset_put_crtc_power_domains(struct intel_crtc *crtc,
690 struct intel_power_domain_mask *domains);
692 /* modesetting asserts */
693 void assert_transcoder(struct drm_i915_private *dev_priv,
694 enum transcoder cpu_transcoder, bool state);
695 #define assert_transcoder_enabled(d, t) assert_transcoder(d, t, true)
696 #define assert_transcoder_disabled(d, t) assert_transcoder(d, t, false)
698 /* Use I915_STATE_WARN(x) and I915_STATE_WARN_ON() (rather than WARN() and
699 * WARN_ON()) for hw state sanity checks to check for unexpected conditions
700 * which may not necessarily be a user visible problem. This will either
701 * WARN() or DRM_ERROR() depending on the verbose_checks moduleparam, to
702 * enable distros and users to tailor their preferred amount of i915 abrt
705 #define I915_STATE_WARN(condition, format...) ({ \
706 int __ret_warn_on = !!(condition); \
707 if (unlikely(__ret_warn_on)) \
708 if (!WARN(i915_modparams.verbose_state_checks, format)) \
710 unlikely(__ret_warn_on); \
713 #define I915_STATE_WARN_ON(x) \
714 I915_STATE_WARN((x), "%s", "WARN_ON(" __stringify(x) ")")
716 bool intel_scanout_needs_vtd_wa(struct drm_i915_private *i915);