/*
 * Copyright 2015 Advanced Micro Devices, Inc.
 *
 * 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 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 COPYRIGHT HOLDER(S) OR AUTHOR(S) 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.
 *
 * Authors: AMD
 *
 */

#ifndef __AMDGPU_DM_H__
#define __AMDGPU_DM_H__

#include <drm/drm_atomic.h>
#include <drm/drm_connector.h>
#include <drm/drm_crtc.h>
#include <drm/drm_dp_mst_helper.h>
#include <drm/drm_plane.h>

/*
 * This file contains the definition for amdgpu_display_manager
 * and its API for amdgpu driver's use.
 * This component provides all the display related functionality
 * and this is the only component that calls DAL API.
 * The API contained here intended for amdgpu driver use.
 * The API that is called directly from KMS framework is located
 * in amdgpu_dm_kms.h file
 */

#define AMDGPU_DM_MAX_DISPLAY_INDEX 31

#define AMDGPU_DM_MAX_CRTC 6

/*
#include "include/amdgpu_dal_power_if.h"
#include "amdgpu_dm_irq.h"
*/

#include "irq_types.h"
#include "signal_types.h"
#include "amdgpu_dm_crc.h"

/* Forward declarations */
struct amdgpu_device;
struct drm_device;
struct dc;
struct amdgpu_bo;
struct dmub_srv;
struct dc_plane_state;

struct common_irq_params {
        struct amdgpu_device *adev;
        enum dc_irq_source irq_src;
};

/**
 * struct dm_compressor_info - Buffer info used by frame buffer compression
 * @cpu_addr: MMIO cpu addr
 * @bo_ptr: Pointer to the buffer object
 * @gpu_addr: MMIO gpu addr
 */
struct dm_compressor_info {
        void *cpu_addr;
        struct amdgpu_bo *bo_ptr;
        uint64_t gpu_addr;
};

/**
 * struct vblank_workqueue - Works to be executed in a separate thread during vblank
 * @mall_work: work for mall stutter
 * @dm: amdgpu display manager device
 * @otg_inst: otg instance of which vblank is being set
 * @enable: true if enable vblank
 */
struct vblank_workqueue {
        struct work_struct mall_work;
        struct amdgpu_display_manager *dm;
        int otg_inst;
        bool enable;
};

/**
 * struct amdgpu_dm_backlight_caps - Information about backlight
 *
 * Describe the backlight support for ACPI or eDP AUX.
 */
struct amdgpu_dm_backlight_caps {
        /**
         * @ext_caps: Keep the data struct with all the information about the
         * display support for HDR.
         */
        union dpcd_sink_ext_caps *ext_caps;
        /**
         * @aux_min_input_signal: Min brightness value supported by the display
         */
        u32 aux_min_input_signal;
        /**
         * @aux_max_input_signal: Max brightness value supported by the display
         * in nits.
         */
        u32 aux_max_input_signal;
        /**
         * @min_input_signal: minimum possible input in range 0-255.
         */
        int min_input_signal;
        /**
         * @max_input_signal: maximum possible input in range 0-255.
         */
        int max_input_signal;
        /**
         * @caps_valid: true if these values are from the ACPI interface.
         */
        bool caps_valid;
        /**
         * @aux_support: Describes if the display supports AUX backlight.
         */
        bool aux_support;
};

/**
 * struct amdgpu_display_manager - Central amdgpu display manager device
 *
 * @dc: Display Core control structure
 * @adev: AMDGPU base driver structure
 * @ddev: DRM base driver structure
 * @display_indexes_num: Max number of display streams supported
 * @irq_handler_list_table_lock: Synchronizes access to IRQ tables
 * @backlight_dev: Backlight control device
 * @backlight_link: Link on which to control backlight
 * @backlight_caps: Capabilities of the backlight device
 * @freesync_module: Module handling freesync calculations
 * @hdcp_workqueue: AMDGPU content protection queue
 * @fw_dmcu: Reference to DMCU firmware
 * @dmcu_fw_version: Version of the DMCU firmware
 * @soc_bounding_box: SOC bounding box values provided by gpu_info FW
 * @cached_state: Caches device atomic state for suspend/resume
 * @cached_dc_state: Cached state of content streams
 * @compressor: Frame buffer compression buffer. See &struct dm_compressor_info
 * @force_timing_sync: set via debugfs. When set, indicates that all connected
 *                     displays will be forced to synchronize.
 */
struct amdgpu_display_manager {

        struct dc *dc;

        /**
         * @dmub_srv:
         *
         * DMUB service, used for controlling the DMUB on hardware
         * that supports it. The pointer to the dmub_srv will be
         * NULL on hardware that does not support it.
         */
        struct dmub_srv *dmub_srv;

        /**
         * @dmub_fb_info:
         *
         * Framebuffer regions for the DMUB.
         */
        struct dmub_srv_fb_info *dmub_fb_info;

        /**
         * @dmub_fw:
         *
         * DMUB firmware, required on hardware that has DMUB support.
         */
        const struct firmware *dmub_fw;

        /**
         * @dmub_bo:
         *
         * Buffer object for the DMUB.
         */
        struct amdgpu_bo *dmub_bo;

        /**
         * @dmub_bo_gpu_addr:
         *
         * GPU virtual address for the DMUB buffer object.
         */
        u64 dmub_bo_gpu_addr;

        /**
         * @dmub_bo_cpu_addr:
         *
         * CPU address for the DMUB buffer object.
         */
        void *dmub_bo_cpu_addr;

        /**
         * @dmcub_fw_version:
         *
         * DMCUB firmware version.
         */
        uint32_t dmcub_fw_version;

        /**
         * @cgs_device:
         *
         * The Common Graphics Services device. It provides an interface for
         * accessing registers.
         */
        struct cgs_device *cgs_device;

        struct amdgpu_device *adev;
        struct drm_device *ddev;
        u16 display_indexes_num;

        /**
         * @atomic_obj:
         *
         * In combination with &dm_atomic_state it helps manage
         * global atomic state that doesn't map cleanly into existing
         * drm resources, like &dc_context.
         */
        struct drm_private_obj atomic_obj;

        /**
         * @dc_lock:
         *
         * Guards access to DC functions that can issue register write
         * sequences.
         */
        struct mutex dc_lock;

        /**
         * @audio_lock:
         *
         * Guards access to audio instance changes.
         */
        struct mutex audio_lock;

        /**
         * @vblank_work_lock:
         *
         * Guards access to deferred vblank work state.
         */
#if defined(CONFIG_DRM_AMD_DC_DCN)
        spinlock_t vblank_lock;
#endif

        /**
         * @audio_component:
         *
         * Used to notify ELD changes to sound driver.
         */
        struct drm_audio_component *audio_component;

        /**
         * @audio_registered:
         *
         * True if the audio component has been registered
         * successfully, false otherwise.
         */
        bool audio_registered;

        /**
         * @irq_handler_list_low_tab:
         *
         * Low priority IRQ handler table.
         *
         * It is a n*m table consisting of n IRQ sources, and m handlers per IRQ
         * source. Low priority IRQ handlers are deferred to a workqueue to be
         * processed. Hence, they can sleep.
         *
         * Note that handlers are called in the same order as they were
         * registered (FIFO).
         */
        struct list_head irq_handler_list_low_tab[DAL_IRQ_SOURCES_NUMBER];

        /**
         * @irq_handler_list_high_tab:
         *
         * High priority IRQ handler table.
         *
         * It is a n*m table, same as &irq_handler_list_low_tab. However,
         * handlers in this table are not deferred and are called immediately.
         */
        struct list_head irq_handler_list_high_tab[DAL_IRQ_SOURCES_NUMBER];

        /**
         * @pflip_params:
         *
         * Page flip IRQ parameters, passed to registered handlers when
         * triggered.
         */
        struct common_irq_params
        pflip_params[DC_IRQ_SOURCE_PFLIP_LAST - DC_IRQ_SOURCE_PFLIP_FIRST + 1];

        /**
         * @vblank_params:
         *
         * Vertical blanking IRQ parameters, passed to registered handlers when
         * triggered.
         */
        struct common_irq_params
        vblank_params[DC_IRQ_SOURCE_VBLANK6 - DC_IRQ_SOURCE_VBLANK1 + 1];

        /**
         * @vupdate_params:
         *
         * Vertical update IRQ parameters, passed to registered handlers when
         * triggered.
         */
        struct common_irq_params
        vupdate_params[DC_IRQ_SOURCE_VUPDATE6 - DC_IRQ_SOURCE_VUPDATE1 + 1];

        spinlock_t irq_handler_list_table_lock;

        struct backlight_device *backlight_dev;

        const struct dc_link *backlight_link;
        struct amdgpu_dm_backlight_caps backlight_caps;

        struct mod_freesync *freesync_module;
#ifdef CONFIG_DRM_AMD_DC_HDCP
        struct hdcp_workqueue *hdcp_workqueue;
#endif

#if defined(CONFIG_DRM_AMD_DC_DCN)
        struct vblank_workqueue *vblank_workqueue;
#endif

        struct drm_atomic_state *cached_state;
        struct dc_state *cached_dc_state;

        struct dm_compressor_info compressor;

        const struct firmware *fw_dmcu;
        uint32_t dmcu_fw_version;
        /**
         * @soc_bounding_box:
         *
         * gpu_info FW provided soc bounding box struct or 0 if not
         * available in FW
         */
        const struct gpu_info_soc_bounding_box_v1_0 *soc_bounding_box;

        /**
         * @active_vblank_irq_count:
         *
         * number of currently active vblank irqs
         */
        uint32_t active_vblank_irq_count;

        /**
         * @mst_encoders:
         *
         * fake encoders used for DP MST.
         */
        struct amdgpu_encoder mst_encoders[AMDGPU_DM_MAX_CRTC];
        bool force_timing_sync;
};

enum dsc_clock_force_state {
        DSC_CLK_FORCE_DEFAULT = 0,
        DSC_CLK_FORCE_ENABLE,
        DSC_CLK_FORCE_DISABLE,
};

struct dsc_preferred_settings {
        enum dsc_clock_force_state dsc_force_enable;
        uint32_t dsc_num_slices_v;
        uint32_t dsc_num_slices_h;
        uint32_t dsc_bits_per_pixel;
};

struct amdgpu_dm_connector {

        struct drm_connector base;
        uint32_t connector_id;

        /* we need to mind the EDID between detect
           and get modes due to analog/digital/tvencoder */
        struct edid *edid;

        /* shared with amdgpu */
        struct amdgpu_hpd hpd;

        /* number of modes generated from EDID at 'dc_sink' */
        int num_modes;

        /* The 'old' sink - before an HPD.
         * The 'current' sink is in dc_link->sink. */
        struct dc_sink *dc_sink;
        struct dc_link *dc_link;
        struct dc_sink *dc_em_sink;

        /* DM only */
        struct drm_dp_mst_topology_mgr mst_mgr;
        struct amdgpu_dm_dp_aux dm_dp_aux;
        struct drm_dp_mst_port *port;
        struct amdgpu_dm_connector *mst_port;
        struct drm_dp_aux *dsc_aux;

        /* TODO see if we can merge with ddc_bus or make a dm_connector */
        struct amdgpu_i2c_adapter *i2c;

        /* Monitor range limits */
        int min_vfreq ;
        int max_vfreq ;
        int pixel_clock_mhz;

        /* Audio instance - protected by audio_lock. */
        int audio_inst;

        struct mutex hpd_lock;

        bool fake_enable;
#ifdef CONFIG_DEBUG_FS
        uint32_t debugfs_dpcd_address;
        uint32_t debugfs_dpcd_size;
#endif
        bool force_yuv420_output;
        struct dsc_preferred_settings dsc_settings;
};

#define to_amdgpu_dm_connector(x) container_of(x, struct amdgpu_dm_connector, base)

extern const struct amdgpu_ip_block_version dm_ip_block;

struct dm_plane_state {
        struct drm_plane_state base;
        struct dc_plane_state *dc_state;
};

struct dm_crtc_state {
        struct drm_crtc_state base;
        struct dc_stream_state *stream;

        bool cm_has_degamma;
        bool cm_is_degamma_srgb;

        int update_type;
        int active_planes;

        int crc_skip_count;
        enum amdgpu_dm_pipe_crc_source crc_src;

        bool freesync_timing_changed;
        bool freesync_vrr_info_changed;

        bool dsc_force_changed;
        bool vrr_supported;
        struct mod_freesync_config freesync_config;
        struct dc_info_packet vrr_infopacket;

        int abm_level;
};

#define to_dm_crtc_state(x) container_of(x, struct dm_crtc_state, base)

struct dm_atomic_state {
        struct drm_private_state base;

        struct dc_state *context;
};

#define to_dm_atomic_state(x) container_of(x, struct dm_atomic_state, base)

struct dm_connector_state {
        struct drm_connector_state base;

        enum amdgpu_rmx_type scaling;
        uint8_t underscan_vborder;
        uint8_t underscan_hborder;
        bool underscan_enable;
        bool freesync_capable;
#ifdef CONFIG_DRM_AMD_DC_HDCP
        bool update_hdcp;
#endif
        uint8_t abm_level;
        int vcpi_slots;
        uint64_t pbn;
};

#define to_dm_connector_state(x)\
        container_of((x), struct dm_connector_state, base)

void amdgpu_dm_connector_funcs_reset(struct drm_connector *connector);
struct drm_connector_state *
amdgpu_dm_connector_atomic_duplicate_state(struct drm_connector *connector);
int amdgpu_dm_connector_atomic_set_property(struct drm_connector *connector,
                                            struct drm_connector_state *state,
                                            struct drm_property *property,
                                            uint64_t val);

int amdgpu_dm_connector_atomic_get_property(struct drm_connector *connector,
                                            const struct drm_connector_state *state,
                                            struct drm_property *property,
                                            uint64_t *val);

int amdgpu_dm_get_encoder_crtc_mask(struct amdgpu_device *adev);

void amdgpu_dm_connector_init_helper(struct amdgpu_display_manager *dm,
                                     struct amdgpu_dm_connector *aconnector,
                                     int connector_type,
                                     struct dc_link *link,
                                     int link_index);

enum drm_mode_status amdgpu_dm_connector_mode_valid(struct drm_connector *connector,
                                   struct drm_display_mode *mode);

void dm_restore_drm_connector_state(struct drm_device *dev,
                                    struct drm_connector *connector);

void amdgpu_dm_update_freesync_caps(struct drm_connector *connector,
                                        struct edid *edid);

void amdgpu_dm_trigger_timing_sync(struct drm_device *dev);

#define MAX_COLOR_LUT_ENTRIES 4096
/* Legacy gamm LUT users such as X doesn't like large LUT sizes */
#define MAX_COLOR_LEGACY_LUT_ENTRIES 256

void amdgpu_dm_init_color_mod(void);
int amdgpu_dm_update_crtc_color_mgmt(struct dm_crtc_state *crtc);
int amdgpu_dm_update_plane_color_mgmt(struct dm_crtc_state *crtc,
                                      struct dc_plane_state *dc_plane_state);

void amdgpu_dm_update_connector_after_detect(
                struct amdgpu_dm_connector *aconnector);

extern const struct drm_encoder_helper_funcs amdgpu_dm_encoder_helper_funcs;

#endif /* __AMDGPU_DM_H__ */