/*
 * Copyright (c) 2006 Dave Airlie <airlied@linux.ie>
 * Copyright (c) 2007-2008 Intel Corporation
 *   Jesse Barnes <jesse.barnes@intel.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

#ifndef __INTEL_DISPLAY_TYPES_H__
#define __INTEL_DISPLAY_TYPES_H__

#include <linux/pm_qos.h>
#include <linux/pwm.h>

#include <drm/display/drm_dp_dual_mode_helper.h>
#include <drm/display/drm_dp_mst_helper.h>
#include <drm/display/drm_dp_tunnel.h>
#include <drm/display/drm_dsc.h>
#include <drm/drm_atomic.h>
#include <drm/drm_colorop.h>
#include <drm/drm_crtc.h>
#include <drm/drm_encoder.h>
#include <drm/drm_framebuffer.h>
#include <drm/drm_panel.h>
#include <drm/drm_rect.h>
#include <drm/drm_vblank_work.h>
#include <drm/intel/i915_hdcp_interface.h>
#include <uapi/drm/i915_drm.h>

#include "i915_gtt_view_types.h"
#include "intel_bios.h"
#include "intel_display.h"
#include "intel_display_conversion.h"
#include "intel_display_limits.h"
#include "intel_display_power.h"
#include "intel_dpll_mgr.h"
#include "intel_dsi_vbt_defs.h"
#include "intel_wm_types.h"

struct cec_notifier;
struct drm_printer;
struct intel_connector;
struct intel_ddi_buf_trans;
struct intel_fbc;
struct intel_global_objs_state;
struct intel_hdcp_shim;
struct intel_panic;
struct intel_tc_port;

/*
 * Display related stuff
 */

/* these are outputs from the chip - integrated only
   external chips are via DVO or SDVO output */
enum intel_output_type {
        INTEL_OUTPUT_UNUSED = 0,
        INTEL_OUTPUT_ANALOG = 1,
        INTEL_OUTPUT_DVO = 2,
        INTEL_OUTPUT_SDVO = 3,
        INTEL_OUTPUT_LVDS = 4,
        INTEL_OUTPUT_TVOUT = 5,
        INTEL_OUTPUT_HDMI = 6,
        INTEL_OUTPUT_DP = 7,
        INTEL_OUTPUT_EDP = 8,
        INTEL_OUTPUT_DSI = 9,
        INTEL_OUTPUT_DDI = 10,
        INTEL_OUTPUT_DP_MST = 11,
};

enum hdmi_force_audio {
        HDMI_AUDIO_OFF_DVI = -2,        /* no aux data for HDMI-DVI converter */
        HDMI_AUDIO_OFF,                 /* force turn off HDMI audio */
        HDMI_AUDIO_AUTO,                /* trust EDID */
        HDMI_AUDIO_ON,                  /* force turn on HDMI audio */
};

/* "Broadcast RGB" property */
enum intel_broadcast_rgb {
        INTEL_BROADCAST_RGB_AUTO,
        INTEL_BROADCAST_RGB_FULL,
        INTEL_BROADCAST_RGB_LIMITED,
};

struct intel_fb_view {
        /*
         * The remap information used in the remapped and rotated views to
         * create the DMA scatter-gather list for each FB color plane. This sg
         * list is created along with the view type (gtt.type) specific
         * i915_vma object and contains the list of FB object pages (reordered
         * in the rotated view) that are visible in the view.
         * In the normal view the FB object's backing store sg list is used
         * directly and hence the remap information here is not used.
         */
        struct i915_gtt_view gtt;

        /*
         * The GTT view (gtt.type) specific information for each FB color
         * plane. In the normal GTT view all formats (up to 4 color planes),
         * in the rotated and remapped GTT view all no-CCS formats (up to 2
         * color planes) are supported.
         *
         * The view information shared by all FB color planes in the FB,
         * like dst x/y and src/dst width, is stored separately in
         * intel_plane_state.
         */
        struct i915_color_plane_view {
                u32 offset;
                unsigned int x, y;
                /*
                 * Plane stride in:
                 *   bytes for 0/180 degree rotation
                 *   pixels for 90/270 degree rotation
                 */
                unsigned int mapping_stride;
                unsigned int scanout_stride;
        } color_plane[4];
};

struct intel_framebuffer {
        struct drm_framebuffer base;
        struct intel_frontbuffer *frontbuffer;

        /* Params to remap the FB pages and program the plane registers in each view. */
        struct intel_fb_view normal_view;
        union {
                struct intel_fb_view rotated_view;
                struct intel_fb_view remapped_view;
        };

        struct i915_address_space *dpt_vm;

        unsigned int min_alignment;
        unsigned int vtd_guard;

        unsigned int (*panic_tiling)(unsigned int x, unsigned int y, unsigned int width);
        struct intel_panic *panic;
};

enum intel_hotplug_state {
        INTEL_HOTPLUG_UNCHANGED,
        INTEL_HOTPLUG_CHANGED,
        INTEL_HOTPLUG_RETRY,
};

struct intel_encoder {
        struct drm_encoder base;

        enum intel_output_type type;
        enum port port;
        u16 cloneable;
        u8 pipe_mask;

        /* Check and recover a bad link state. */
        struct delayed_work link_check_work;
        void (*link_check)(struct intel_encoder *encoder);

        enum intel_hotplug_state (*hotplug)(struct intel_encoder *encoder,
                                            struct intel_connector *connector);
        enum intel_output_type (*compute_output_type)(struct intel_encoder *,
                                                      struct intel_crtc_state *,
                                                      struct drm_connector_state *);
        int (*compute_config)(struct intel_encoder *,
                              struct intel_crtc_state *,
                              struct drm_connector_state *);
        int (*compute_config_late)(struct intel_encoder *,
                                   struct intel_crtc_state *,
                                   struct drm_connector_state *);
        void (*pre_pll_enable)(struct intel_atomic_state *,
                               struct intel_encoder *,
                               const struct intel_crtc_state *,
                               const struct drm_connector_state *);
        void (*pre_enable)(struct intel_atomic_state *,
                           struct intel_encoder *,
                           const struct intel_crtc_state *,
                           const struct drm_connector_state *);
        void (*enable)(struct intel_atomic_state *,
                       struct intel_encoder *,
                       const struct intel_crtc_state *,
                       const struct drm_connector_state *);
        void (*disable)(struct intel_atomic_state *,
                        struct intel_encoder *,
                        const struct intel_crtc_state *,
                        const struct drm_connector_state *);
        void (*post_disable)(struct intel_atomic_state *,
                             struct intel_encoder *,
                             const struct intel_crtc_state *,
                             const struct drm_connector_state *);
        void (*post_pll_disable)(struct intel_atomic_state *,
                                 struct intel_encoder *,
                                 const struct intel_crtc_state *,
                                 const struct drm_connector_state *);
        void (*update_pipe)(struct intel_atomic_state *,
                            struct intel_encoder *,
                            const struct intel_crtc_state *,
                            const struct drm_connector_state *);
        void (*audio_enable)(struct intel_encoder *encoder,
                             const struct intel_crtc_state *crtc_state,
                             const struct drm_connector_state *conn_state);
        void (*audio_disable)(struct intel_encoder *encoder,
                              const struct intel_crtc_state *old_crtc_state,
                              const struct drm_connector_state *old_conn_state);
        /* Read out the current hw state of this connector, returning true if
         * the encoder is active. If the encoder is enabled it also set the pipe
         * it is connected to in the pipe parameter. */
        bool (*get_hw_state)(struct intel_encoder *, enum pipe *pipe);
        /* Reconstructs the equivalent mode flags for the current hardware
         * state. This must be called _after_ display->get_pipe_config has
         * pre-filled the pipe config. Note that intel_encoder->base.crtc must
         * be set correctly before calling this function. */
        void (*get_config)(struct intel_encoder *,
                           struct intel_crtc_state *pipe_config);

        /*
         * Optional hook called during init/resume to sync any state
         * stored in the encoder (eg. DP link parameters) wrt. the HW state.
         */
        void (*sync_state)(struct intel_encoder *encoder,
                           const struct intel_crtc_state *crtc_state);

        /*
         * Optional hook, returning true if this encoder allows a fastset
         * during the initial commit, false otherwise.
         */
        bool (*initial_fastset_check)(struct intel_encoder *encoder,
                                      struct intel_crtc_state *crtc_state);

        /*
         * Acquires the power domains needed for an active encoder during
         * hardware state readout.
         */
        void (*get_power_domains)(struct intel_encoder *encoder,
                                  struct intel_crtc_state *crtc_state);
        /*
         * Called during system suspend after all pending requests for the
         * encoder are flushed (for example for DP AUX transactions) and
         * device interrupts are disabled.
         * All modeset locks are held while the hook is called.
         */
        void (*suspend)(struct intel_encoder *);
        /*
         * Called without the modeset locks held after the suspend() hook for
         * all encoders have been called.
         */
        void (*suspend_complete)(struct intel_encoder *encoder);
        /*
         * Called during system reboot/shutdown after all the
         * encoders have been disabled and suspended.
         * All modeset locks are held while the hook is called.
         */
        void (*shutdown)(struct intel_encoder *encoder);
        /*
         * Called without the modeset locks held after the shutdown() hook for
         * all encoders have been called.
         */
        void (*shutdown_complete)(struct intel_encoder *encoder);
        /*
         * Enable/disable the clock to the port.
         */
        void (*enable_clock)(struct intel_encoder *encoder,
                             const struct intel_crtc_state *crtc_state);
        void (*disable_clock)(struct intel_encoder *encoder);
        /*
         * Returns whether the port clock is enabled or not.
         */
        bool (*is_clock_enabled)(struct intel_encoder *encoder);
        /*
         * Returns the PLL type the port uses.
         */
        enum icl_port_dpll_id (*port_pll_type)(struct intel_encoder *encoder,
                                               const struct intel_crtc_state *crtc_state);
        const struct intel_ddi_buf_trans *(*get_buf_trans)(struct intel_encoder *encoder,
                                                           const struct intel_crtc_state *crtc_state,
                                                           int *n_entries);
        void (*set_signal_levels)(struct intel_encoder *encoder,
                                  const struct intel_crtc_state *crtc_state);

        enum hpd_pin hpd_pin;
        enum intel_display_power_domain power_domain;

        /* VBT information for this encoder (may be NULL for older platforms) */
        const struct intel_bios_encoder_data *devdata;
};

struct intel_panel_bl_funcs {
        /* Connector and platform specific backlight functions */
        int (*setup)(struct intel_connector *connector, enum pipe pipe);
        u32 (*get)(struct intel_connector *connector, enum pipe pipe);
        void (*set)(const struct drm_connector_state *conn_state, u32 level);
        void (*disable)(const struct drm_connector_state *conn_state, u32 level);
        void (*enable)(const struct intel_crtc_state *crtc_state,
                       const struct drm_connector_state *conn_state, u32 level);
        u32 (*hz_to_pwm)(struct intel_connector *connector, u32 hz);
};

/* in 100us units */
struct intel_pps_delays {
        u16 power_up;      /* eDP: T1+T3,   LVDS: T1+T2 */
        u16 backlight_on;  /* eDP: T8,      LVDS: T5 */
        u16 backlight_off; /* eDP: T9,      LVDS: T6/TX */
        u16 power_down;    /* eDP: T10,     LVDS: T3 */
        u16 power_cycle;   /* eDP: T11+T12, LVDS: T7+T4 */
};

enum drrs_type {
        DRRS_TYPE_NONE,
        DRRS_TYPE_STATIC,
        DRRS_TYPE_SEAMLESS,
};

struct intel_vbt_panel_data {
        struct drm_display_mode *lfp_vbt_mode; /* if any */
        struct drm_display_mode *sdvo_lvds_vbt_mode; /* if any */

        /* Feature bits */
        int panel_type;
        unsigned int lvds_dither:1;
        unsigned int bios_lvds_val; /* initial [PCH_]LVDS reg val in VBIOS */

        bool vrr;

        u8 seamless_drrs_min_refresh_rate;
        enum drrs_type drrs_type;

        struct {
                int max_link_rate;
                int rate;
                int lanes;
                int preemphasis;
                int vswing;
                int bpp;
                struct intel_pps_delays pps;
                u8 drrs_msa_timing_delay;
                bool low_vswing;
                bool hobl;
                bool dsc_disable;
        } edp;

        struct {
                bool enable;
                bool full_link;
                bool require_aux_wakeup;
                int idle_frames;
                int tp1_wakeup_time_us;
                int tp2_tp3_wakeup_time_us;
                int psr2_tp2_tp3_wakeup_time_us;
        } psr;

        struct {
                u16 pwm_freq_hz;
                u16 brightness_precision_bits;
                u16 hdr_dpcd_refresh_timeout;
                bool present;
                bool active_low_pwm;
                u8 min_brightness;      /* min_brightness/255 of max */
                s8 controller;          /* brightness controller number */
                enum intel_backlight_type type;
        } backlight;

        /* MIPI DSI */
        struct {
                u16 panel_id;
                struct mipi_config *config;
                struct mipi_pps_data *pps;
                u16 bl_ports;
                u16 cabc_ports;
                u8 seq_version;
                u32 size;
                u8 *data;
                const u8 *sequence[MIPI_SEQ_MAX];
                u8 *deassert_seq; /* Used by fixup_mipi_sequences() */
                enum drm_panel_orientation orientation;
        } dsi;
};

struct intel_panel {
        /* Simple drm_panel */
        struct drm_panel *base;

        /* Fixed EDID for eDP and LVDS. May hold ERR_PTR for invalid EDID. */
        const struct drm_edid *fixed_edid;

        struct list_head fixed_modes;

        /* backlight */
        struct {
                bool present;
                u32 level;
                u32 min;
                u32 max;
                bool enabled;
                bool combination_mode;  /* gen 2/4 only */
                bool active_low_pwm;
                bool alternate_pwm_increment;   /* lpt+ */

                /* PWM chip */
                u32 pwm_level_min;
                u32 pwm_level_max;
                bool pwm_enabled;
                bool util_pin_active_low;       /* bxt+ */
                u8 controller;          /* bxt+ only */
                struct pwm_device *pwm;
                struct pwm_state pwm_state;

                /* DPCD backlight */
                union {
                        struct {
                                struct drm_edp_backlight_info info;
                                bool luminance_control_support;
                        } vesa;
                        struct {
                                bool sdr_uses_aux;
                                bool supports_2084_decode;
                                bool supports_2020_gamut;
                                bool supports_segmented_backlight;
                                bool supports_sdp_colorimetry;
                                bool supports_tone_mapping;
                        } intel_cap;
                } edp;

                struct backlight_device *device;

                const struct intel_panel_bl_funcs *funcs;
                const struct intel_panel_bl_funcs *pwm_funcs;
                void (*power)(struct intel_connector *, bool enable);
        } backlight;

        struct intel_vbt_panel_data vbt;
};

struct intel_digital_port;

struct intel_hdcp {
        const struct intel_hdcp_shim *shim;
        /* Mutex for hdcp state of the connector */
        struct mutex mutex;
        u64 value;
        struct delayed_work check_work;
        struct work_struct prop_work;

        /* HDCP1.4 Encryption status */
        bool hdcp_encrypted;

        /* HDCP2.2 related definitions */
        /* Flag indicates whether this connector supports HDCP2.2 or not. */
        bool hdcp2_supported;

        /* HDCP2.2 Encryption status */
        bool hdcp2_encrypted;

        /*
         * Content Stream Type defined by content owner. TYPE0(0x0) content can
         * flow in the link protected by HDCP2.2 or HDCP1.4, where as TYPE1(0x1)
         * content can flow only through a link protected by HDCP2.2.
         */
        u8 content_type;

        bool is_paired;
        bool is_repeater;

        /*
         * Count of ReceiverID_List received. Initialized to 0 at AKE_INIT.
         * Incremented after processing the RepeaterAuth_Send_ReceiverID_List.
         * When it rolls over re-auth has to be triggered.
         */
        u32 seq_num_v;

        /*
         * Count of RepeaterAuth_Stream_Manage msg propagated.
         * Initialized to 0 on AKE_INIT. Incremented after every successful
         * transmission of RepeaterAuth_Stream_Manage message. When it rolls
         * over re-Auth has to be triggered.
         */
        u32 seq_num_m;

        /*
         * Work queue to signal the CP_IRQ. Used for the waiters to read the
         * available information from HDCP DP sink.
         */
        wait_queue_head_t cp_irq_queue;
        atomic_t cp_irq_count;
        int cp_irq_count_cached;

        /*
         * HDCP register access for gen12+ need the transcoder associated.
         * Transcoder attached to the connector could be changed at modeset.
         * Hence caching the transcoder here.
         */
        enum transcoder cpu_transcoder;
        /* Only used for DP MST stream encryption */
        enum transcoder stream_transcoder;
        /* Used to force HDCP 1.4 bypassing HDCP 2.x */
        bool force_hdcp14;
};

enum intel_panel_replay_dsc_support {
        INTEL_DP_PANEL_REPLAY_DSC_NOT_SUPPORTED,
        INTEL_DP_PANEL_REPLAY_DSC_FULL_FRAME_ONLY,
        INTEL_DP_PANEL_REPLAY_DSC_SELECTIVE_UPDATE,
};

struct intel_connector {
        struct drm_connector base;
        /*
         * The fixed encoder this connector is connected to.
         */
        struct intel_encoder *encoder;

        /* ACPI device id for ACPI and driver cooperation */
        u32 acpi_device_id;

        /* Reads out the current hw, returning true if the connector is enabled
         * and active (i.e. dpms ON state). */
        bool (*get_hw_state)(struct intel_connector *);

        /*
         * Optional hook called during init/resume to sync any state
         * stored in the connector (eg. DSC state) wrt. the HW state.
         */
        void (*sync_state)(struct intel_connector *connector,
                           const struct intel_crtc_state *crtc_state);

        /* Panel info for eDP and LVDS */
        struct intel_panel panel;

        /* Cached EDID for detect. */
        const struct drm_edid *detect_edid;

        /* Number of times hotplug detection was tried after an HPD interrupt */
        int hotplug_retries;

        /* since POLL and HPD connectors may use the same HPD line keep the native
           state of connector->polled in case hotplug storm detection changes it */
        u8 polled;

        int force_joined_pipes;

        struct {
                struct drm_dp_aux *dsc_decompression_aux;
                u8 dsc_dpcd[DP_DSC_RECEIVER_CAP_SIZE];
                u8 fec_capability;

                u8 dsc_hblank_expansion_quirk:1;
                u8 dsc_throughput_quirk:1;
                u8 dsc_decompression_enabled:1;

                struct {
                        struct {
                                int rgb_yuv444;
                                int yuv422_420;
                        } overall_throughput;
                        int max_line_width;
                } dsc_branch_caps;

                struct {
                        u8 dpcd[DP_PANEL_REPLAY_CAP_SIZE];
#define INTEL_PR_DPCD_INDEX(pr_dpcd_register)   ((pr_dpcd_register) - DP_PANEL_REPLAY_CAP_SUPPORT)

                        bool support;
                        bool su_support;
                        enum intel_panel_replay_dsc_support dsc_support;

                        u16 su_w_granularity;
                        u16 su_y_granularity;
                } panel_replay_caps;

                struct {
                        u8 dpcd[EDP_PSR_RECEIVER_CAP_SIZE];

                        bool support;
                        bool su_support;

                        u16 su_w_granularity;
                        u16 su_y_granularity;

                        u8 sync_latency;
                } psr_caps;
        } dp;

        struct {
                struct drm_dp_mst_port *port;
                struct intel_dp *dp;
        } mst;

        struct {
                int force_bpp_x16;
        } link;

        /* Work struct to schedule a uevent on link train failure */
        struct work_struct modeset_retry_work;

        struct intel_hdcp hdcp;
};

struct intel_digital_connector_state {
        struct drm_connector_state base;

        enum hdmi_force_audio force_audio;
        int broadcast_rgb;
};

#define to_intel_digital_connector_state(conn_state) \
        container_of_const((conn_state), struct intel_digital_connector_state, base)

struct dpll {
        /* given values */
        int n;
        int m1, m2;
        int p1, p2;
        /* derived values */
        int     dot;
        int     vco;
        int     m;
        int     p;
};

struct intel_atomic_state {
        struct drm_atomic_state base;

        struct ref_tracker *wakeref;

        struct intel_global_objs_state *global_objs;
        int num_global_objs;

        /* Internal commit, as opposed to userspace/client initiated one */
        bool internal;

        bool dpll_set, modeset;

        struct intel_dpll_state dpll_state[I915_NUM_PLLS];

        struct intel_dp_tunnel_inherited_state *inherited_dp_tunnels;

        /*
         * Current watermarks can't be trusted during hardware readout, so
         * don't bother calculating intermediate watermarks.
         */
        bool skip_intermediate_wm;

        bool rps_interactive;

        struct work_struct cleanup_work;
};

struct intel_plane_state {
        struct drm_plane_state uapi;

        /*
         * actual hardware state, the state we program to the hardware.
         * The following members are used to verify the hardware state:
         * During initial hw readout, they need to be copied from uapi.
         */
        struct {
                struct drm_crtc *crtc;
                struct drm_framebuffer *fb;

                u16 alpha;
                u16 pixel_blend_mode;
                unsigned int rotation;
                enum drm_color_encoding color_encoding;
                enum drm_color_range color_range;
                enum drm_scaling_filter scaling_filter;
                struct drm_property_blob *ctm, *degamma_lut, *gamma_lut, *lut_3d;
        } hw;

        struct i915_vma *ggtt_vma;
        struct i915_vma *dpt_vma;
        unsigned long flags;
#define PLANE_HAS_FENCE BIT(0)

        struct intel_fb_view view;

        /* for legacy cursor fb unpin */
        struct drm_vblank_work unpin_work;

        /* Plane pxp decryption state */
        bool decrypt;

        /* Plane state to display black pixels when pxp is borked */
        bool force_black;

        /* Acting as Y plane for another UV plane? */
        bool is_y_plane;

        /* plane control register */
        u32 ctl;

        /* plane color control register */
        u32 color_ctl;

        /* chroma upsampler control register */
        u32 cus_ctl;

        /* surface address register */
        u32 surf;

        /*
         * scaler_id
         *    = -1 : not using a scaler
         *    >=  0 : using a scalers
         *
         * plane requiring a scaler:
         *   - During check_plane, its bit is set in
         *     crtc_state->scaler_state.scaler_users by calling helper function
         *     update_scaler_plane.
         *   - scaler_id indicates the scaler it got assigned.
         *
         * plane doesn't require a scaler:
         *   - this can happen when scaling is no more required or plane simply
         *     got disabled.
         *   - During check_plane, corresponding bit is reset in
         *     crtc_state->scaler_state.scaler_users by calling helper function
         *     update_scaler_plane.
         */
        int scaler_id;

        /*
         * planar_linked_plane:
         *
         * ICL planar formats require 2 planes that are updated as pairs.
         * This member is used to make sure the other plane is also updated
         * when required, and for update_slave() to find the correct
         * plane_state to pass as argument.
         */
        struct intel_plane *planar_linked_plane;

        struct drm_intel_sprite_colorkey ckey;

        struct drm_rect psr2_sel_fetch_area;

        /* Clear Color Value */
        u64 ccval;

        const char *no_fbc_reason;

        struct drm_rect damage;
};

struct intel_initial_plane_config {
        struct intel_framebuffer *fb;
        struct intel_memory_region *mem;
        resource_size_t phys_base;
        struct i915_vma *vma;
        int size;
        u32 base;
        u8 rotation;
};

struct intel_scaler {
        u32 mode;
        bool in_use;
        int hscale;
        int vscale;
};

struct intel_crtc_scaler_state {
#define SKL_NUM_SCALERS 2
        struct intel_scaler scalers[SKL_NUM_SCALERS];

        /*
         * scaler_users: keeps track of users requesting scalers on this crtc.
         *
         *     If a bit is set, a user is using a scaler.
         *     Here user can be a plane or crtc as defined below:
         *       bits 0-30 - plane (bit position is index from drm_plane_index)
         *       bit 31    - crtc
         *
         * Instead of creating a new index to cover planes and crtc, using
         * existing drm_plane_index for planes which is well less than 31
         * planes and bit 31 for crtc. This should be fine to cover all
         * our platforms.
         *
         * intel_atomic_setup_scalers will setup available scalers to users
         * requesting scalers. It will gracefully fail if request exceeds
         * availability.
         */
#define SKL_CRTC_INDEX 31
        unsigned scaler_users;

        /* scaler used by crtc for panel fitting purpose */
        int scaler_id;
};

/* {crtc,crtc_state}->mode_flags */
/* Flag to get scanline using frame time stamps */
#define I915_MODE_FLAG_GET_SCANLINE_FROM_TIMESTAMP (1<<1)
/* Flag to use the scanline counter instead of the pixel counter */
#define I915_MODE_FLAG_USE_SCANLINE_COUNTER (1<<2)
/*
 * TE0 or TE1 flag is set if the crtc has a DSI encoder which
 * is operating in command mode.
 * Flag to use TE from DSI0 instead of VBI in command mode
 */
#define I915_MODE_FLAG_DSI_USE_TE0 (1<<3)
/* Flag to use TE from DSI1 instead of VBI in command mode */
#define I915_MODE_FLAG_DSI_USE_TE1 (1<<4)
/* Flag to indicate mipi dsi periodic command mode where we do not get TE */
#define I915_MODE_FLAG_DSI_PERIODIC_CMD_MODE (1<<5)
/* Do tricks to make vblank timestamps sane with VRR? */
#define I915_MODE_FLAG_VRR (1<<6)

struct intel_wm_level {
        bool enable;
        u32 pri_val;
        u32 spr_val;
        u32 cur_val;
        u32 fbc_val;
};

struct intel_pipe_wm {
        struct intel_wm_level wm[5];
        bool fbc_wm_enabled;
        bool pipe_enabled;
        bool sprites_enabled;
        bool sprites_scaled;
};

struct skl_wm_level {
        u16 min_ddb_alloc;
        u16 blocks;
        u8 lines;
        bool enable;
        bool ignore_lines;
        bool auto_min_alloc_wm_enable;
        bool can_sagv;
};

struct skl_plane_wm {
        struct skl_wm_level wm[8];
        struct skl_wm_level uv_wm[8];
        struct skl_wm_level trans_wm;
        struct {
                struct skl_wm_level wm0;
                struct skl_wm_level trans_wm;
        } sagv;
        bool is_planar;
};

struct skl_pipe_wm {
        struct skl_plane_wm planes[I915_MAX_PLANES];
        bool use_sagv_wm;
};

enum vlv_wm_level {
        VLV_WM_LEVEL_PM2,
        VLV_WM_LEVEL_PM5,
        VLV_WM_LEVEL_DDR_DVFS,
        NUM_VLV_WM_LEVELS,
};

struct vlv_wm_state {
        struct g4x_pipe_wm wm[NUM_VLV_WM_LEVELS];
        struct g4x_sr_wm sr[NUM_VLV_WM_LEVELS];
        u8 num_levels;
        bool cxsr;
};

struct vlv_fifo_state {
        u16 plane[I915_MAX_PLANES];
};

enum g4x_wm_level {
        G4X_WM_LEVEL_NORMAL,
        G4X_WM_LEVEL_SR,
        G4X_WM_LEVEL_HPLL,
        NUM_G4X_WM_LEVELS,
};

struct g4x_wm_state {
        struct g4x_pipe_wm wm;
        struct g4x_sr_wm sr;
        struct g4x_sr_wm hpll;
        bool cxsr;
        bool hpll_en;
        bool fbc_en;
};

struct intel_crtc_wm_state {
        union {
                /*
                 * raw:
                 * The "raw" watermark values produced by the formula
                 * given the plane's current state. They do not consider
                 * how much FIFO is actually allocated for each plane.
                 *
                 * optimal:
                 * The "optimal" watermark values given the current
                 * state of the planes and the amount of FIFO
                 * allocated to each, ignoring any previous state
                 * of the planes.
                 *
                 * intermediate:
                 * The "intermediate" watermark values when transitioning
                 * between the old and new "optimal" values. Used when
                 * the watermark registers are single buffered and hence
                 * their state changes asynchronously with regards to the
                 * actual plane registers. These are essentially the
                 * worst case combination of the old and new "optimal"
                 * watermarks, which are therefore safe to use when the
                 * plane is in either its old or new state.
                 */
                struct {
                        struct intel_pipe_wm intermediate;
                        struct intel_pipe_wm optimal;
                } ilk;

                struct {
                        struct skl_pipe_wm raw;
                        /* gen9+ only needs 1-step wm programming */
                        struct skl_pipe_wm optimal;
                        struct skl_ddb_entry ddb;
                        /*
                         * pre-icl: for packed/planar CbCr
                         * icl+: for everything
                         */
                        struct skl_ddb_entry plane_ddb[I915_MAX_PLANES];
                        /* pre-icl: for planar Y */
                        struct skl_ddb_entry plane_ddb_y[I915_MAX_PLANES];

                        /*
                         * xe3: Minimum amount of display blocks and minimum
                         * sagv allocation required for async flip
                         */
                        u16 plane_min_ddb[I915_MAX_PLANES];
                        u16 plane_interim_ddb[I915_MAX_PLANES];
                } skl;

                struct {
                        struct g4x_pipe_wm raw[NUM_VLV_WM_LEVELS]; /* not inverted */
                        struct vlv_wm_state intermediate; /* inverted */
                        struct vlv_wm_state optimal; /* inverted */
                        struct vlv_fifo_state fifo_state;
                } vlv;

                struct {
                        struct g4x_pipe_wm raw[NUM_G4X_WM_LEVELS];
                        struct g4x_wm_state intermediate;
                        struct g4x_wm_state optimal;
                } g4x;
        };

        /*
         * Platforms with two-step watermark programming will need to
         * update watermark programming post-vblank to switch from the
         * safe intermediate watermarks to the optimal final
         * watermarks.
         */
        bool need_postvbl_update;
};

enum intel_output_format {
        INTEL_OUTPUT_FORMAT_RGB,
        INTEL_OUTPUT_FORMAT_YCBCR420,
        INTEL_OUTPUT_FORMAT_YCBCR444,
};

/* Used by dp and fdi links */
struct intel_link_m_n {
        u32 tu;
        u32 data_m;
        u32 data_n;
        u32 link_m;
        u32 link_n;
};

struct intel_csc_matrix {
        u16 coeff[9];
        u16 preoff[3];
        u16 postoff[3];
};

struct scaler_filter_coeff {
        u16 sign;
        u16 exp;
        u16 mantissa;
};

struct intel_casf {
        #define SCALER_FILTER_NUM_TAPS 7
        struct scaler_filter_coeff coeff[SCALER_FILTER_NUM_TAPS];
        u8 strength;
        u8 win_size;
        bool casf_enable;
};

struct intel_crtc_state {
        /*
         * uapi (drm) state. This is the software state shown to userspace.
         * In particular, the following members are used for bookkeeping:
         * - crtc
         * - state
         * - *_changed
         * - event
         * - commit
         * - mode_blob
         */
        struct drm_crtc_state uapi;

        /*
         * actual hardware state, the state we program to the hardware.
         * The following members are used to verify the hardware state:
         * - enable
         * - active
         * - mode / pipe_mode / adjusted_mode
         * - color property blobs.
         *
         * During initial hw readout, they need to be copied to uapi.
         *
         * Joiner will allow a transcoder mode that spans 2 pipes;
         * Use the pipe_mode for calculations like watermarks, pipe
         * scaler, and bandwidth.
         *
         * Use adjusted_mode for things that need to know the full
         * mode on the transcoder, which spans all pipes.
         */
        struct {
                bool active, enable;
                /* logical state of LUTs */
                struct drm_property_blob *degamma_lut, *gamma_lut, *ctm;
                struct drm_display_mode mode, pipe_mode, adjusted_mode;
                enum drm_scaling_filter scaling_filter;
                struct intel_casf casf_params;
        } hw;

        /* actual state of LUTs */
        struct drm_property_blob *pre_csc_lut, *post_csc_lut;

        struct intel_csc_matrix csc, output_csc;

        /**
         * quirks - bitfield with hw state readout quirks
         *
         * For various reasons the hw state readout code might not be able to
         * completely faithfully read out the current state. These cases are
         * tracked with quirk flags so that fastboot and state checker can act
         * accordingly.
         */
#define PIPE_CONFIG_QUIRK_MODE_SYNC_FLAGS       (1<<0) /* unreliable sync mode.flags */
        unsigned long quirks;

        unsigned fb_bits; /* framebuffers to flip */
        bool update_pipe; /* can a fast modeset be performed? */
        bool update_m_n; /* update M/N seamlessly during fastset? */
        bool update_lrr; /* update TRANS_VTOTAL/etc. during fastset? */
        bool disable_cxsr;
        bool update_wm_pre, update_wm_post; /* watermarks are updated */
        bool fifo_changed; /* FIFO split is changed */
        bool preload_luts;
        bool inherited; /* state inherited from BIOS? */

        /* Ask the hardware to actually async flip? */
        bool do_async_flip;

        /* Pipe source size (ie. panel fitter input size)
         * All planes will be positioned inside this space,
         * and get clipped at the edges. */
        struct drm_rect pipe_src;

        /*
         * Pipe pixel rate, adjusted for
         * panel fitter/pipe scaler downscaling.
         */
        unsigned int pixel_rate;

        /* Whether to set up the PCH/FDI. Note that we never allow sharing
         * between pch encoders and cpu encoders. */
        bool has_pch_encoder;

        /* Are we sending infoframes on the attached port */
        bool has_infoframe;

        /* CPU Transcoder for the pipe. Currently this can only differ from the
         * pipe on Haswell and later (where we have a special eDP transcoder)
         * and Broxton (where we have special DSI transcoders). */
        enum transcoder cpu_transcoder;

        /*
         * Use reduced/limited/broadcast rbg range, compressing from the full
         * range fed into the crtcs.
         */
        bool limited_color_range;

        /* Bitmask of encoder types (enum intel_output_type)
         * driven by the pipe.
         */
        unsigned int output_types;

        /* Whether we should send NULL infoframes. Required for audio. */
        bool has_hdmi_sink;

        /* Audio enabled on this pipe. Only valid if either has_hdmi_sink or
         * has_dp_encoder is set. */
        bool has_audio;

        /*
         * Enable dithering, used when the selected pipe bpp doesn't match the
         * plane bpp.
         */
        bool dither;

        /*
         * Dither gets enabled for 18bpp which causes CRC mismatch errors for
         * compliance video pattern tests.
         * Disable dither only if it is a compliance test request for
         * 18bpp.
         */
        bool dither_force_disable;

        /* Controls for the clock computation, to override various stages. */
        bool clock_set;

        /* SDVO TV has a bunch of special case. To make multifunction encoders
         * work correctly, we need to track this at runtime.*/
        bool sdvo_tv_clock;

        /*
         * crtc bandwidth limit, don't increase pipe bpp or clock if not really
         * required. This is set in the 2nd loop of calling encoder's
         * ->compute_config if the first pick doesn't work out.
         */
        bool bw_constrained;

        /* Settings for the intel dpll used on pretty much everything but
         * haswell. */
        struct dpll dpll;

        /* Selected dpll or NULL. */
        struct intel_dpll *intel_dpll;

        /* Actual register state of the dpll, for shared dpll cross-checking. */
        struct intel_dpll_hw_state dpll_hw_state;

        /*
         * ICL reserved DPLLs for the CRTC/port. The active PLL is selected by
         * setting shared_dpll and dpll_hw_state to one of these reserved ones.
         */
        struct icl_port_dpll {
                struct intel_dpll *pll;
                struct intel_dpll_hw_state hw_state;
        } icl_port_dplls[ICL_PORT_DPLL_COUNT];

        /* DSI PLL registers */
        struct {
                u32 ctrl, div;
        } dsi_pll;

        int max_link_bpp_x16;   /* in 1/16 bpp units */
        int pipe_bpp;           /* in 1 bpp units */
        int min_hblank;
        struct intel_link_m_n dp_m_n;

        /* m2_n2 for eDP downclock */
        struct intel_link_m_n dp_m2_n2;
        bool has_drrs;

        /* PSR is supported but might not be enabled due the lack of enabled planes */
        bool has_psr;
        bool has_sel_update;
        bool enable_psr2_sel_fetch;
        bool enable_psr2_su_region_et;
        bool req_psr2_sdp_prior_scanline;
        bool has_panel_replay;
        bool link_off_after_as_sdp_when_pr_active;
        bool disable_as_sdp_when_pr_active;
        bool wm_level_disabled;
        bool pkg_c_latency_used;
        /* Only used for state verification. */
        enum intel_panel_replay_dsc_support panel_replay_dsc_support;
        u32 dc3co_exitline;
        u16 su_y_granularity;
        u8 active_non_psr_pipes;
        u8 entry_setup_frames;
        const char *no_psr_reason;

        /*
         * Frequency the dpll for the port should run at. Differs from the
         * adjusted dotclock e.g. for DP or 10/12bpc hdmi mode. This is also
         * already multiplied by pixel_multiplier.
         */
        int port_clock;

        /* Used by SDVO (and if we ever fix it, HDMI). */
        unsigned pixel_multiplier;

        /* I915_MODE_FLAG_* */
        u8 mode_flags;

        u8 lane_count;

        /*
         * Used by platforms having DP/HDMI PHY with programmable lane
         * latency optimization.
         */
        u8 lane_lat_optim_mask;

        /* minimum acceptable voltage level */
        u8 min_voltage_level;

        /* Panel fitter controls for gen2-gen4 + VLV */
        struct {
                u32 control;
                u32 pgm_ratios;
                u32 lvds_border_bits;
        } gmch_pfit;

        /* Panel fitter placement and size for Ironlake+ */
        struct {
                struct drm_rect dst;
                bool enabled;
                bool force_thru;
        } pch_pfit;

        /* FDI configuration, only valid if has_pch_encoder is set. */
        int fdi_lanes;
        struct intel_link_m_n fdi_m_n;

        bool ips_enabled;

        bool crc_enabled;

        bool double_wide;

        struct intel_crtc_scaler_state scaler_state;

        /* w/a for waiting 2 vblanks during crtc enable */
        enum pipe hsw_workaround_pipe;

        struct intel_crtc_wm_state wm;

        int min_cdclk;

        int plane_min_cdclk[I915_MAX_PLANES];

        /* for packed/planar CbCr */
        u32 data_rate[I915_MAX_PLANES];
        /* for planar Y */
        u32 data_rate_y[I915_MAX_PLANES];

        /* FIXME unify with data_rate[]? */
        u64 rel_data_rate[I915_MAX_PLANES];
        u64 rel_data_rate_y[I915_MAX_PLANES];

        /* Gamma mode programmed on the pipe */
        u32 gamma_mode;

        union {
                /* CSC mode programmed on the pipe */
                u32 csc_mode;

                /* CHV CGM mode */
                u32 cgm_mode;
        };

        /* bitmask of logically enabled planes (enum plane_id) */
        u8 enabled_planes;

        /* bitmask of actually visible planes (enum plane_id) */
        u8 active_planes;
        u8 scaled_planes;
        u8 nv12_planes;
        u8 c8_planes;

        /* bitmask of planes that will be updated during the commit */
        u8 update_planes;

        /* bitmask of planes with async flip active */
        u8 async_flip_planes;

        u8 framestart_delay; /* 1-4 */
        u8 msa_timing_delay; /* 0-3 */

        struct {
                u32 enable;
                u32 gcp;
                union hdmi_infoframe avi;
                union hdmi_infoframe spd;
                union hdmi_infoframe hdmi;
                union hdmi_infoframe drm;
                struct drm_dp_vsc_sdp vsc;
                struct drm_dp_as_sdp as_sdp;
        } infoframes;

        u8 eld[MAX_ELD_BYTES];

        /* HDMI scrambling status */
        bool hdmi_scrambling;

        /* HDMI High TMDS char rate ratio */
        bool hdmi_high_tmds_clock_ratio;

        /*
         * Output format RGB/YCBCR etc., that is coming out
         * at the end of the pipe.
         */
        enum intel_output_format output_format;

        /*
         * Sink output format RGB/YCBCR etc., that is going
         * into the sink.
         */
        enum intel_output_format sink_format;

        /* enable pipe gamma? */
        bool gamma_enable;

        /* enable pipe csc? */
        bool csc_enable;

        /* enable vlv/chv wgc csc? */
        bool wgc_enable;

        /* joiner pipe bitmask */
        u8 joiner_pipes;

        /* Display Stream compression state */
        struct {
                /* Only used for state computation, not read out from the HW. */
                bool compression_enabled_on_link;
                bool compression_enable;
                int num_streams;
                /* Compressed Bpp in U6.4 format (first 4 bits for fractional part) */
                u16 compressed_bpp_x16;
                u8 slice_count;
                struct drm_dsc_config config;
        } dsc;

        /* DP tunnel used for BW allocation. */
        struct drm_dp_tunnel_ref dp_tunnel_ref;

        /* HSW+ linetime watermarks */
        u16 linetime;
        u16 ips_linetime;

        bool enhanced_framing;

        /*
         * Forward Error Correction.
         *
         * Note: This will be false for 128b/132b, which will always have FEC
         * enabled automatically.
         */
        bool fec_enable;

        bool sdp_split_enable;

        /* Pointer to master transcoder in case of tiled displays */
        enum transcoder master_transcoder;

        /* Bitmask to indicate slaves attached */
        u8 sync_mode_slaves_mask;

        /* Only valid on TGL+ */
        enum transcoder mst_master_transcoder;

        /* For DSB based pipe updates */
        struct intel_dsb *dsb_color, *dsb_commit;
        bool use_dsb;
        bool use_flipq;

        u32 psr2_man_track_ctl;

        u32 pipe_srcsz_early_tpt;

        struct drm_rect psr2_su_area;

        /* Variable Refresh Rate state */
        struct {
                bool enable, in_range;
                u8 pipeline_full;
                u16 flipline, vmin, vmax, guardband;
                u32 vsync_end, vsync_start;
                struct {
                        bool enable;
                        u16 vmin, vmax;
                        u16 guardband, slope;
                        u16 max_increase, max_decrease;
                        u16 vblank_target;
                } dc_balance;
        } vrr;

        /* Content Match Refresh Rate state */
        struct {
                bool enable;
                u64 cmrr_n, cmrr_m;
        } cmrr;

        /* Stream Splitter for eDP MSO */
        struct {
                bool enable;
                u8 link_count;
                u8 pixel_overlap;
        } splitter;

        /* for loading single buffered registers during vblank */
        struct drm_vblank_work vblank_work;

        /* LOBF flag */
        bool has_lobf;

        /* W2 window or 'set context latency' lines */
        u16 set_context_latency;

        struct {
                u8 io_wake_lines;
                u8 fast_wake_lines;

                /* LNL and beyond */
                u8 check_entry_lines;
                u8 aux_less_wake_lines;
                u8 silence_period_sym_clocks;
                u8 lfps_half_cycle_num_of_syms;
        } alpm_state;

        /* to track changes in plane color blocks */
        bool plane_color_changed;
};

enum intel_pipe_crc_source {
        INTEL_PIPE_CRC_SOURCE_NONE,
        INTEL_PIPE_CRC_SOURCE_PLANE1,
        INTEL_PIPE_CRC_SOURCE_PLANE2,
        INTEL_PIPE_CRC_SOURCE_PLANE3,
        INTEL_PIPE_CRC_SOURCE_PLANE4,
        INTEL_PIPE_CRC_SOURCE_PLANE5,
        INTEL_PIPE_CRC_SOURCE_PLANE6,
        INTEL_PIPE_CRC_SOURCE_PLANE7,
        INTEL_PIPE_CRC_SOURCE_PIPE,
        /* TV/DP on pre-gen5/vlv can't use the pipe source. */
        INTEL_PIPE_CRC_SOURCE_TV,
        INTEL_PIPE_CRC_SOURCE_DP_B,
        INTEL_PIPE_CRC_SOURCE_DP_C,
        INTEL_PIPE_CRC_SOURCE_DP_D,
        INTEL_PIPE_CRC_SOURCE_AUTO,
        INTEL_PIPE_CRC_SOURCE_MAX,
};

enum drrs_refresh_rate {
        DRRS_REFRESH_RATE_HIGH,
        DRRS_REFRESH_RATE_LOW,
};

#define INTEL_PIPE_CRC_ENTRIES_NR       128
struct intel_pipe_crc {
        spinlock_t lock;
        int skipped;
        enum intel_pipe_crc_source source;
};

enum intel_flipq_id {
        INTEL_FLIPQ_PLANE_1,
        INTEL_FLIPQ_PLANE_2,
        INTEL_FLIPQ_PLANE_3,
        INTEL_FLIPQ_GENERAL,
        INTEL_FLIPQ_FAST,
        MAX_INTEL_FLIPQ,
};

struct intel_flipq {
        u32 start_mmioaddr;
        enum intel_flipq_id flipq_id;
        u8 tail;
};

struct intel_crtc {
        struct drm_crtc base;
        enum pipe pipe;
        /*
         * Whether the crtc and the connected output pipeline is active. Implies
         * that crtc->enabled is set, i.e. the current mode configuration has
         * some outputs connected to this crtc.
         */
        bool active;
        u8 plane_ids_mask;

        /* I915_MODE_FLAG_* */
        u8 mode_flags;

        u16 vmax_vblank_start;

        struct intel_display_power_domain_set enabled_power_domains;
        struct intel_display_power_domain_set hw_readout_power_domains;
        struct intel_overlay *overlay;

        struct intel_crtc_state *config;

        /* armed event for async flip */
        struct drm_pending_vblank_event *flip_done_event;
        /* armed event for DSB based updates */
        struct drm_pending_vblank_event *dsb_event;
        /* armed event for flip queue based updates */
        struct drm_pending_vblank_event *flipq_event;

        /* Access to these should be protected by display->irq.lock. */
        bool cpu_fifo_underrun_disabled;
        bool pch_fifo_underrun_disabled;

        struct intel_flipq flipq[MAX_INTEL_FLIPQ];

        /* per-pipe watermark state */
        struct {
                /* watermarks currently being used  */
                union {
                        struct intel_pipe_wm ilk;
                        struct vlv_wm_state vlv;
                        struct g4x_wm_state g4x;
                } active;
        } wm;

        struct {
                struct mutex mutex;
                struct delayed_work work;
                enum drrs_refresh_rate refresh_rate;
                unsigned int frontbuffer_bits;
                unsigned int busy_frontbuffer_bits;
                enum transcoder cpu_transcoder;
                struct intel_link_m_n m_n, m2_n2;
        } drrs;

        struct {
                u64 flip_count;
        } dc_balance;

        int scanline_offset;

        struct {
                unsigned start_vbl_count;
                ktime_t start_vbl_time;
                int min_vbl, max_vbl;
                int scanline_start;
#ifdef CONFIG_DRM_I915_DEBUG_VBLANK_EVADE
                struct {
                        u64 min;
                        u64 max;
                        u64 sum;
                        unsigned int over;
                        unsigned int times[17]; /* [1us, 16ms] */
                } vbl;
#endif
        } debug;

        /* scalers available on this crtc */
        int num_scalers;

        /* for loading single buffered registers during vblank */
        struct pm_qos_request vblank_pm_qos;

#ifdef CONFIG_DEBUG_FS
        struct intel_pipe_crc pipe_crc;
#endif

        bool vblank_psr_notify;
};

struct intel_plane_error {
        u32 ctl, surf, surflive;
};

struct intel_plane {
        struct drm_plane base;
        enum i9xx_plane_id i9xx_plane;
        enum plane_id id;
        enum pipe pipe;
        bool need_async_flip_toggle_wa;
        u8 vtd_guard;
        u32 frontbuffer_bit;

        struct {
                u32 base, cntl, size;
        } cursor;

        struct intel_fbc *fbc;

        /*
         * NOTE: Do not place new plane state fields here (e.g., when adding
         * new plane properties).  New runtime state should now be placed in
         * the intel_plane_state structure and accessed via plane_state.
         */

        int (*min_width)(const struct drm_framebuffer *fb,
                         int color_plane,
                         unsigned int rotation);
        int (*max_width)(const struct drm_framebuffer *fb,
                         int color_plane,
                         unsigned int rotation);
        int (*max_height)(const struct drm_framebuffer *fb,
                          int color_plane,
                          unsigned int rotation);
        unsigned int (*min_alignment)(struct intel_plane *plane,
                                      const struct drm_framebuffer *fb,
                                      int color_plane);
        unsigned int (*max_stride)(struct intel_plane *plane,
                                   const struct drm_format_info *info,
                                   u64 modifier, unsigned int rotation);
        bool (*can_async_flip)(u64 modifier);
        /* Write all non-self arming plane registers */
        void (*update_noarm)(struct intel_dsb *dsb,
                             struct intel_plane *plane,
                             const struct intel_crtc_state *crtc_state,
                             const struct intel_plane_state *plane_state);
        /* Write all self-arming plane registers */
        void (*update_arm)(struct intel_dsb *dsb,
                           struct intel_plane *plane,
                           const struct intel_crtc_state *crtc_state,
                           const struct intel_plane_state *plane_state);
        /* Disable the plane, must arm */
        void (*disable_arm)(struct intel_dsb *dsb,
                            struct intel_plane *plane,
                            const struct intel_crtc_state *crtc_state);
        void (*capture_error)(struct intel_crtc *crtc,
                              struct intel_plane *plane,
                              struct intel_plane_error *error);
        bool (*get_hw_state)(struct intel_plane *plane, enum pipe *pipe);
        int (*check_plane)(struct intel_crtc_state *crtc_state,
                           struct intel_plane_state *plane_state);
        u32 (*surf_offset)(const struct intel_plane_state *plane_state);
        int (*min_cdclk)(const struct intel_crtc_state *crtc_state,
                         const struct intel_plane_state *plane_state);
        void (*async_flip)(struct intel_dsb *dsb,
                           struct intel_plane *plane,
                           const struct intel_crtc_state *crtc_state,
                           const struct intel_plane_state *plane_state,
                           bool async_flip);
        void (*enable_flip_done)(struct intel_plane *plane);
        void (*disable_flip_done)(struct intel_plane *plane);
        /* For drm_panic */
        void (*disable_tiling)(struct intel_plane *plane);
};

#define to_intel_atomic_state(x) container_of(x, struct intel_atomic_state, base)
#define to_intel_crtc(x) container_of(x, struct intel_crtc, base)
#define to_intel_connector(x) container_of(x, struct intel_connector, base)
#define to_intel_encoder(x) container_of(x, struct intel_encoder, base)
#define to_intel_plane(x) container_of(x, struct intel_plane, base)

#define to_intel_crtc_state(crtc_state) \
        container_of_const((crtc_state), struct intel_crtc_state, uapi)
#define to_intel_plane_state(plane_state) \
        container_of_const((plane_state), struct intel_plane_state, uapi)
#define to_intel_framebuffer(fb) \
        container_of_const((fb), struct intel_framebuffer, base)

struct intel_hdmi {
        i915_reg_t hdmi_reg;
        struct {
                enum drm_dp_dual_mode_type type;
                int max_tmds_clock;
        } dp_dual_mode;
        struct intel_connector *attached_connector;
        struct cec_notifier *cec_notifier;
};

struct intel_dp_mst_encoder;

struct intel_dp_compliance_data {
        unsigned long edid;
        u8 video_pattern;
        u16 hdisplay, vdisplay;
        u8 bpc;
        struct drm_dp_phy_test_params phytest;
};

struct intel_dp_compliance {
        unsigned long test_type;
        struct intel_dp_compliance_data test_data;
        bool test_active;
        int test_link_rate;
        u8 test_lane_count;
};

struct intel_dp_pcon_frl {
        bool is_trained;
        int trained_rate_gbps;
};

struct intel_pps {
        int panel_power_up_delay;
        int panel_power_down_delay;
        int panel_power_cycle_delay;
        int backlight_on_delay;
        int backlight_off_delay;
        struct delayed_work panel_vdd_work;
        bool want_panel_vdd;
        bool initializing;
        unsigned long last_power_on;
        unsigned long last_backlight_off;
        ktime_t panel_power_off_time;
        struct ref_tracker *vdd_wakeref;

        union {
                /*
                 * Pipe whose power sequencer is currently locked into
                 * this port. Only relevant on VLV/CHV.
                 */
                enum pipe vlv_pps_pipe;

                /*
                 * Power sequencer index. Only relevant on BXT+.
                 */
                int pps_idx;
        };

        /*
         * Pipe currently driving the port. Used for preventing
         * the use of the PPS for any pipe currentrly driving
         * external DP as that will mess things up on VLV.
         */
        enum pipe vlv_active_pipe;
        /*
         * Set if the sequencer may be reset due to a power transition,
         * requiring a reinitialization. Only relevant on BXT+.
         */
        bool bxt_pps_reset;
        struct intel_pps_delays pps_delays;
        struct intel_pps_delays bios_pps_delays;
};

struct intel_psr {
        /* Mutex for PSR state of the transcoder */
        struct mutex lock;

#define I915_PSR_DEBUG_MODE_MASK                0x0f
#define I915_PSR_DEBUG_DEFAULT                  0x00
#define I915_PSR_DEBUG_DISABLE                  0x01
#define I915_PSR_DEBUG_ENABLE                   0x02
#define I915_PSR_DEBUG_FORCE_PSR1               0x03
#define I915_PSR_DEBUG_ENABLE_SEL_FETCH         0x4
#define I915_PSR_DEBUG_IRQ                      0x10
#define I915_PSR_DEBUG_SU_REGION_ET_DISABLE     0x20
#define I915_PSR_DEBUG_PANEL_REPLAY_DISABLE     0x40

        u32 debug;
        bool sink_support;
        bool source_support;
        bool enabled;
        int pause_counter;
        enum pipe pipe;
        enum transcoder transcoder;
        bool active;
        struct work_struct work;
        unsigned int busy_frontbuffer_bits;
        bool link_standby;
        bool sel_update_enabled;
        bool psr2_sel_fetch_enabled;
        bool psr2_sel_fetch_cff_enabled;
        bool su_region_et_enabled;
        bool req_psr2_sdp_prior_scanline;
        ktime_t last_entry_attempt;
        ktime_t last_exit;
        bool sink_not_reliable;
        bool irq_aux_error;
        u16 su_w_granularity;
        u16 su_y_granularity;
        bool source_panel_replay_support;
        bool sink_panel_replay_support;
        bool panel_replay_enabled;
        u32 dc3co_exitline;
        u32 dc3co_exit_delay;
        struct delayed_work dc3co_work;
        u8 entry_setup_frames;

        u8 io_wake_lines;
        u8 fast_wake_lines;

        bool link_ok;
        bool pkg_c_latency_used;

        u8 active_non_psr_pipes;

        const char *no_psr_reason;
};

struct intel_dp {
        i915_reg_t output_reg;
        u32 DP;
        int link_rate;
        u8 lane_count;
        u8 sink_count;
        bool needs_modeset_retry;
        bool use_max_params;
        u8 dpcd[DP_RECEIVER_CAP_SIZE];

        u8 downstream_ports[DP_MAX_DOWNSTREAM_PORTS];
        u8 edp_dpcd[EDP_DISPLAY_CTL_CAP_SIZE];
        u8 lttpr_common_caps[DP_LTTPR_COMMON_CAP_SIZE];
        u8 lttpr_phy_caps[DP_MAX_LTTPR_COUNT][DP_LTTPR_PHY_CAP_SIZE];
        u8 pcon_dsc_dpcd[DP_PCON_DSC_ENCODER_CAP_SIZE];
        /* source rates */
        int num_source_rates;
        const int *source_rates;
        /* sink rates as reported by DP_MAX_LINK_RATE/DP_SUPPORTED_LINK_RATES */
        int num_sink_rates;
        int sink_rates[DP_MAX_SUPPORTED_RATES];
        bool use_rate_select;
        /* Max sink lane count as reported by DP_MAX_LANE_COUNT */
        int max_sink_lane_count;
        /* intersection of source and sink rates */
        int num_common_rates;
        int common_rates[DP_MAX_SUPPORTED_RATES];
        struct {
                /* TODO: move the rest of link specific fields to here */
                bool active;
                /* common rate,lane_count configs in bw order */
                int num_configs;
#define INTEL_DP_MAX_LANE_COUNT                 4
#define INTEL_DP_MAX_SUPPORTED_LANE_CONFIGS     (ilog2(INTEL_DP_MAX_LANE_COUNT) + 1)
#define INTEL_DP_LANE_COUNT_EXP_BITS            order_base_2(INTEL_DP_MAX_SUPPORTED_LANE_CONFIGS)
#define INTEL_DP_LINK_RATE_IDX_BITS             (BITS_PER_TYPE(u8) - INTEL_DP_LANE_COUNT_EXP_BITS)
#define INTEL_DP_MAX_LINK_CONFIGS               (DP_MAX_SUPPORTED_RATES * \
                                                 INTEL_DP_MAX_SUPPORTED_LANE_CONFIGS)
                struct intel_dp_link_config {
                        u8 link_rate_idx:INTEL_DP_LINK_RATE_IDX_BITS;
                        u8 lane_count_exp:INTEL_DP_LANE_COUNT_EXP_BITS;
                } configs[INTEL_DP_MAX_LINK_CONFIGS];
                /* Max lane count for the current link */
                int max_lane_count;
                /* Max rate for the current link */
                int max_rate;
                /*
                 * Link parameters for which the MST topology was probed.
                 * Tracking these ensures that the MST path resources are
                 * re-enumerated whenever the link is retrained with new link
                 * parameters, as required by the DP standard.
                 */
                int mst_probed_lane_count;
                int mst_probed_rate;
                int force_lane_count;
                int force_rate;
                bool retrain_disabled;
                /* Sequential link training failures after a passing LT */
                int seq_train_failures;
                int force_train_failure;
                bool force_retrain;
        } link;
        bool reset_link_params;
        int mso_link_count;
        int mso_pixel_overlap;
        /* sink or branch descriptor */
        struct drm_dp_desc desc;
        struct drm_dp_aux aux;
        u32 aux_busy_last_status;
        u8 train_set[4];

        struct intel_pps pps;

        bool is_mst;
        enum drm_dp_mst_mode mst_detect;

        /* connector directly attached - won't be use for modeset in mst world */
        struct intel_connector *attached_connector;
        bool as_sdp_supported;

        struct drm_dp_tunnel *tunnel;
        bool tunnel_suspended:1;

        struct {
                struct intel_dp_mst_encoder *stream_encoders[I915_MAX_PIPES];
                struct drm_dp_mst_topology_mgr mgr;
                int active_streams;
        } mst;

        u32 (*get_aux_clock_divider)(struct intel_dp *dp, int index);
        /*
         * This function returns the value we have to program the AUX_CTL
         * register with to kick off an AUX transaction.
         */
        u32 (*get_aux_send_ctl)(struct intel_dp *dp, int send_bytes,
                                u32 aux_clock_divider);

        i915_reg_t (*aux_ch_ctl_reg)(struct intel_dp *dp);
        i915_reg_t (*aux_ch_data_reg)(struct intel_dp *dp, int index);

        /* This is called before a link training is starterd */
        void (*prepare_link_retrain)(struct intel_dp *intel_dp,
                                     const struct intel_crtc_state *crtc_state);
        void (*set_link_train)(struct intel_dp *intel_dp,
                               const struct intel_crtc_state *crtc_state,
                               u8 dp_train_pat);
        void (*set_idle_link_train)(struct intel_dp *intel_dp,
                                    const struct intel_crtc_state *crtc_state);

        u8 (*preemph_max)(struct intel_dp *intel_dp);
        u8 (*voltage_max)(struct intel_dp *intel_dp,
                          const struct intel_crtc_state *crtc_state);

        /* Displayport compliance testing */
        struct intel_dp_compliance compliance;

        /* Downstream facing port caps */
        struct {
                int min_tmds_clock, max_tmds_clock;
                int max_dotclock;
                int pcon_max_frl_bw;
                u8 max_bpc;
                bool ycbcr_444_to_420;
                bool ycbcr420_passthrough;
                bool rgb_to_ycbcr;
        } dfp;

        /* To control wakeup latency, e.g. for irq-driven dp aux transfers. */
        struct pm_qos_request pm_qos;

        /* Display stream compression testing */
        bool force_dsc_en;
        int force_dsc_output_format;
        bool force_dsc_fractional_bpp_en;
        int force_dsc_bpc;

        bool hobl_failed;
        bool hobl_active;

        struct intel_dp_pcon_frl frl;

        struct intel_psr psr;

        /* When we last wrote the OUI for eDP */
        unsigned long last_oui_write;
        bool oui_valid;

        bool colorimetry_support;

        struct {
                enum transcoder transcoder;
                struct mutex lock;

                bool lobf_disable_debug;
                bool sink_alpm_error;
        } alpm;

        u8 alpm_dpcd;

        struct {
                unsigned long mask;
        } quirks;
};

enum lspcon_vendor {
        LSPCON_VENDOR_MCA,
        LSPCON_VENDOR_PARADE
};

struct intel_lspcon {
        bool active;
        bool hdr_supported;
        enum drm_lspcon_mode mode;
        enum lspcon_vendor vendor;
};

struct intel_digital_port {
        struct intel_encoder base;
        struct intel_dp dp;
        struct intel_hdmi hdmi;
        struct intel_lspcon lspcon;
        enum irqreturn (*hpd_pulse)(struct intel_digital_port *, bool);

        bool lane_reversal;
        bool ddi_a_4_lanes;
        bool release_cl2_override;
        bool dedicated_external;
        u8 max_lanes;
        /* Used for DP and ICL+ TypeC/DP and TypeC/HDMI ports. */
        enum aux_ch aux_ch;
        enum intel_display_power_domain ddi_io_power_domain;
        struct ref_tracker *ddi_io_wakeref;
        struct ref_tracker *aux_wakeref;

        struct intel_tc_port *tc;

        struct {
                /* protects num_streams reference count, port_data and auth_status */
                struct mutex mutex;
                /* the number of pipes using HDCP signalling out of this port */
                unsigned int num_streams;
                /* port HDCP auth status */
                bool auth_status;
                /* HDCP port data need to pass to security f/w */
                struct hdcp_port_data port_data;
                /* Whether the MST topology supports HDCP Type 1 Content */
                bool mst_type1_capable;
        } hdcp;

        void (*write_infoframe)(struct intel_encoder *encoder,
                                const struct intel_crtc_state *crtc_state,
                                unsigned int type,
                                const void *frame, ssize_t len);
        void (*read_infoframe)(struct intel_encoder *encoder,
                               const struct intel_crtc_state *crtc_state,
                               unsigned int type,
                               void *frame, ssize_t len);
        void (*set_infoframes)(struct intel_encoder *encoder,
                               bool enable,
                               const struct intel_crtc_state *crtc_state,
                               const struct drm_connector_state *conn_state);
        u32 (*infoframes_enabled)(struct intel_encoder *encoder,
                                  const struct intel_crtc_state *pipe_config);
        bool (*connected)(struct intel_encoder *encoder);

        void (*lock)(struct intel_digital_port *dig_port);
        void (*unlock)(struct intel_digital_port *dig_port);
};

struct intel_dp_mst_encoder {
        struct intel_encoder base;
        enum pipe pipe;
        struct intel_digital_port *primary;
        struct intel_connector *connector;
};

struct intel_colorop {
        struct drm_colorop base;
        enum intel_color_block id;
};

static inline struct intel_encoder *
intel_attached_encoder(struct intel_connector *connector)
{
        return connector->encoder;
}

static inline bool intel_encoder_is_dig_port(struct intel_encoder *encoder)
{
        switch (encoder->type) {
        case INTEL_OUTPUT_DDI:
        case INTEL_OUTPUT_DP:
        case INTEL_OUTPUT_EDP:
        case INTEL_OUTPUT_HDMI:
                return true;
        default:
                return false;
        }
}

static inline bool intel_encoder_is_mst(struct intel_encoder *encoder)
{
        return encoder->type == INTEL_OUTPUT_DP_MST;
}

static inline struct intel_dp_mst_encoder *
enc_to_mst(struct intel_encoder *encoder)
{
        return container_of(&encoder->base, struct intel_dp_mst_encoder,
                            base.base);
}

static inline struct intel_digital_port *
enc_to_dig_port(struct intel_encoder *encoder)
{
        struct intel_encoder *intel_encoder = encoder;

        if (intel_encoder_is_dig_port(intel_encoder))
                return container_of(&encoder->base, struct intel_digital_port,
                                    base.base);
        else if (intel_encoder_is_mst(intel_encoder))
                return enc_to_mst(encoder)->primary;
        else
                return NULL;
}

static inline struct intel_digital_port *
intel_attached_dig_port(struct intel_connector *connector)
{
        return enc_to_dig_port(intel_attached_encoder(connector));
}

static inline struct intel_hdmi *
enc_to_intel_hdmi(struct intel_encoder *encoder)
{
        return &enc_to_dig_port(encoder)->hdmi;
}

static inline struct intel_hdmi *
intel_attached_hdmi(struct intel_connector *connector)
{
        return enc_to_intel_hdmi(intel_attached_encoder(connector));
}

static inline struct intel_dp *enc_to_intel_dp(struct intel_encoder *encoder)
{
        return &enc_to_dig_port(encoder)->dp;
}

static inline struct intel_dp *intel_attached_dp(struct intel_connector *connector)
{
        if (connector->mst.dp)
                return connector->mst.dp;
        else
                return enc_to_intel_dp(intel_attached_encoder(connector));
}

static inline bool intel_encoder_is_dp(struct intel_encoder *encoder)
{
        switch (encoder->type) {
        case INTEL_OUTPUT_DP:
        case INTEL_OUTPUT_EDP:
                return true;
        case INTEL_OUTPUT_DDI:
                /* Skip pure HDMI/DVI DDI encoders */
                return i915_mmio_reg_valid(enc_to_intel_dp(encoder)->output_reg);
        default:
                return false;
        }
}

static inline bool intel_encoder_is_hdmi(struct intel_encoder *encoder)
{
        switch (encoder->type) {
        case INTEL_OUTPUT_HDMI:
                return true;
        case INTEL_OUTPUT_DDI:
                /* See if the HDMI encoder is valid. */
                return i915_mmio_reg_valid(enc_to_intel_hdmi(encoder)->hdmi_reg);
        default:
                return false;
        }
}

static inline struct intel_digital_port *
dp_to_dig_port(struct intel_dp *intel_dp)
{
        return container_of(intel_dp, struct intel_digital_port, dp);
}

static inline struct intel_digital_port *
hdmi_to_dig_port(struct intel_hdmi *intel_hdmi)
{
        return container_of(intel_hdmi, struct intel_digital_port, hdmi);
}

static inline struct intel_plane_state *
intel_atomic_get_plane_state(struct intel_atomic_state *state,
                                 struct intel_plane *plane)
{
        struct drm_plane_state *ret =
                drm_atomic_get_plane_state(&state->base, &plane->base);

        if (IS_ERR(ret))
                return ERR_CAST(ret);

        return to_intel_plane_state(ret);
}

static inline struct intel_plane_state *
intel_atomic_get_old_plane_state(struct intel_atomic_state *state,
                                 struct intel_plane *plane)
{
        return to_intel_plane_state(drm_atomic_get_old_plane_state(&state->base,
                                                                   &plane->base));
}

static inline struct intel_plane_state *
intel_atomic_get_new_plane_state(struct intel_atomic_state *state,
                                 struct intel_plane *plane)
{
        return to_intel_plane_state(drm_atomic_get_new_plane_state(&state->base,
                                                                   &plane->base));
}

static inline struct intel_crtc_state *
intel_atomic_get_old_crtc_state(struct intel_atomic_state *state,
                                struct intel_crtc *crtc)
{
        return to_intel_crtc_state(drm_atomic_get_old_crtc_state(&state->base,
                                                                 &crtc->base));
}

static inline struct intel_crtc_state *
intel_atomic_get_new_crtc_state(struct intel_atomic_state *state,
                                struct intel_crtc *crtc)
{
        return to_intel_crtc_state(drm_atomic_get_new_crtc_state(&state->base,
                                                                 &crtc->base));
}

static inline struct intel_digital_connector_state *
intel_atomic_get_new_connector_state(struct intel_atomic_state *state,
                                     struct intel_connector *connector)
{
        return to_intel_digital_connector_state(
                        drm_atomic_get_new_connector_state(&state->base,
                        &connector->base));
}

static inline struct intel_digital_connector_state *
intel_atomic_get_old_connector_state(struct intel_atomic_state *state,
                                     struct intel_connector *connector)
{
        return to_intel_digital_connector_state(
                        drm_atomic_get_old_connector_state(&state->base,
                        &connector->base));
}

/* intel_display.c */
static inline bool
intel_crtc_has_type(const struct intel_crtc_state *crtc_state,
                    enum intel_output_type type)
{
        return crtc_state->output_types & BIT(type);
}

static inline bool
intel_crtc_has_dp_encoder(const struct intel_crtc_state *crtc_state)
{
        return crtc_state->output_types &
                (BIT(INTEL_OUTPUT_DP) |
                 BIT(INTEL_OUTPUT_DP_MST) |
                 BIT(INTEL_OUTPUT_EDP));
}

static inline bool
intel_crtc_needs_modeset(const struct intel_crtc_state *crtc_state)
{
        return drm_atomic_crtc_needs_modeset(&crtc_state->uapi);
}

static inline bool
intel_crtc_needs_fastset(const struct intel_crtc_state *crtc_state)
{
        return crtc_state->update_pipe;
}

static inline bool
intel_crtc_needs_color_update(const struct intel_crtc_state *crtc_state)
{
        return crtc_state->uapi.color_mgmt_changed ||
                intel_crtc_needs_fastset(crtc_state) ||
                intel_crtc_needs_modeset(crtc_state);
}

static inline struct intel_frontbuffer *
to_intel_frontbuffer(struct drm_framebuffer *fb)
{
        return fb ? to_intel_framebuffer(fb)->frontbuffer : NULL;
}

/*
 * Conversion functions/macros from various pointer types to struct
 * intel_display pointer.
 */
#define __drm_device_to_intel_display(p) \
        ((p) ? __drm_to_display(p) : NULL)
#define __device_to_intel_display(p)                            \
        __drm_device_to_intel_display(dev_get_drvdata(p))
#define __pci_dev_to_intel_display(p)                           \
        __drm_device_to_intel_display(pci_get_drvdata(p))
#define __intel_atomic_state_to_intel_display(p)        \
        __drm_device_to_intel_display((p)->base.dev)
#define __intel_connector_to_intel_display(p)           \
        __drm_device_to_intel_display((p)->base.dev)
#define __intel_crtc_to_intel_display(p)                \
        __drm_device_to_intel_display((p)->base.dev)
#define __intel_crtc_state_to_intel_display(p)                  \
        __drm_device_to_intel_display((p)->uapi.crtc->dev)
#define __intel_digital_port_to_intel_display(p)                \
        __drm_device_to_intel_display((p)->base.base.dev)
#define __intel_dp_to_intel_display(p)  \
        __drm_device_to_intel_display(dp_to_dig_port(p)->base.base.dev)
#define __intel_encoder_to_intel_display(p)             \
        __drm_device_to_intel_display((p)->base.dev)
#define __intel_hdmi_to_intel_display(p)        \
        __drm_device_to_intel_display(hdmi_to_dig_port(p)->base.base.dev)
#define __intel_plane_to_intel_display(p)               \
        __drm_device_to_intel_display((p)->base.dev)
#define __intel_plane_state_to_intel_display(p)                 \
        __drm_device_to_intel_display((p)->uapi.plane->dev)

/* Helper for generic association. Map types to conversion functions/macros. */
#define __assoc(type, p) \
        struct type: __##type##_to_intel_display((struct type *)(p))

/* Convert various pointer types to struct intel_display pointer. */
#define to_intel_display(p)                             \
        _Generic(*p,                                    \
                 __assoc(drm_device, p),                \
                 __assoc(device, p),                    \
                 __assoc(pci_dev, p),                   \
                 __assoc(intel_atomic_state, p),        \
                 __assoc(intel_connector, p),           \
                 __assoc(intel_crtc, p),                \
                 __assoc(intel_crtc_state, p),          \
                 __assoc(intel_digital_port, p),        \
                 __assoc(intel_dp, p),                  \
                 __assoc(intel_encoder, p),             \
                 __assoc(intel_hdmi, p),                \
                 __assoc(intel_plane, p),               \
                 __assoc(intel_plane_state, p))

#endif /*  __INTEL_DISPLAY_TYPES_H__ */