/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * Copyright (C) 2016 Texas Instruments, Inc.
 */

#ifndef __OMAPFB_DSS_H
#define __OMAPFB_DSS_H

#include <linux/list.h>
#include <linux/kobject.h>
#include <linux/device.h>
#include <linux/interrupt.h>
#include <linux/platform_data/omapdss.h>

#include <video/videomode.h>

#define DISPC_IRQ_FRAMEDONE             (1 << 0)
#define DISPC_IRQ_VSYNC                 (1 << 1)
#define DISPC_IRQ_EVSYNC_EVEN           (1 << 2)
#define DISPC_IRQ_EVSYNC_ODD            (1 << 3)
#define DISPC_IRQ_ACBIAS_COUNT_STAT     (1 << 4)
#define DISPC_IRQ_PROG_LINE_NUM         (1 << 5)
#define DISPC_IRQ_GFX_FIFO_UNDERFLOW    (1 << 6)
#define DISPC_IRQ_GFX_END_WIN           (1 << 7)
#define DISPC_IRQ_PAL_GAMMA_MASK        (1 << 8)
#define DISPC_IRQ_OCP_ERR               (1 << 9)
#define DISPC_IRQ_VID1_FIFO_UNDERFLOW   (1 << 10)
#define DISPC_IRQ_VID1_END_WIN          (1 << 11)
#define DISPC_IRQ_VID2_FIFO_UNDERFLOW   (1 << 12)
#define DISPC_IRQ_VID2_END_WIN          (1 << 13)
#define DISPC_IRQ_SYNC_LOST             (1 << 14)
#define DISPC_IRQ_SYNC_LOST_DIGIT       (1 << 15)
#define DISPC_IRQ_WAKEUP                (1 << 16)
#define DISPC_IRQ_SYNC_LOST2            (1 << 17)
#define DISPC_IRQ_VSYNC2                (1 << 18)
#define DISPC_IRQ_VID3_END_WIN          (1 << 19)
#define DISPC_IRQ_VID3_FIFO_UNDERFLOW   (1 << 20)
#define DISPC_IRQ_ACBIAS_COUNT_STAT2    (1 << 21)
#define DISPC_IRQ_FRAMEDONE2            (1 << 22)
#define DISPC_IRQ_FRAMEDONEWB           (1 << 23)
#define DISPC_IRQ_FRAMEDONETV           (1 << 24)
#define DISPC_IRQ_WBBUFFEROVERFLOW      (1 << 25)
#define DISPC_IRQ_WBUNCOMPLETEERROR     (1 << 26)
#define DISPC_IRQ_SYNC_LOST3            (1 << 27)
#define DISPC_IRQ_VSYNC3                (1 << 28)
#define DISPC_IRQ_ACBIAS_COUNT_STAT3    (1 << 29)
#define DISPC_IRQ_FRAMEDONE3            (1 << 30)

struct omap_dss_device;
struct omap_overlay_manager;
struct dss_lcd_mgr_config;
struct snd_aes_iec958;
struct snd_cea_861_aud_if;
struct hdmi_avi_infoframe;

enum omap_display_type {
        OMAP_DISPLAY_TYPE_NONE          = 0,
        OMAP_DISPLAY_TYPE_DPI           = 1 << 0,
        OMAP_DISPLAY_TYPE_DBI           = 1 << 1,
        OMAP_DISPLAY_TYPE_SDI           = 1 << 2,
        OMAP_DISPLAY_TYPE_DSI           = 1 << 3,
        OMAP_DISPLAY_TYPE_VENC          = 1 << 4,
        OMAP_DISPLAY_TYPE_HDMI          = 1 << 5,
        OMAP_DISPLAY_TYPE_DVI           = 1 << 6,
};

enum omap_plane {
        OMAP_DSS_GFX    = 0,
        OMAP_DSS_VIDEO1 = 1,
        OMAP_DSS_VIDEO2 = 2,
        OMAP_DSS_VIDEO3 = 3,
        OMAP_DSS_WB     = 4,
};

enum omap_channel {
        OMAP_DSS_CHANNEL_LCD    = 0,
        OMAP_DSS_CHANNEL_DIGIT  = 1,
        OMAP_DSS_CHANNEL_LCD2   = 2,
        OMAP_DSS_CHANNEL_LCD3   = 3,
        OMAP_DSS_CHANNEL_WB     = 4,
};

enum omap_color_mode {
        OMAP_DSS_COLOR_CLUT1    = 1 << 0,  /* BITMAP 1 */
        OMAP_DSS_COLOR_CLUT2    = 1 << 1,  /* BITMAP 2 */
        OMAP_DSS_COLOR_CLUT4    = 1 << 2,  /* BITMAP 4 */
        OMAP_DSS_COLOR_CLUT8    = 1 << 3,  /* BITMAP 8 */
        OMAP_DSS_COLOR_RGB12U   = 1 << 4,  /* RGB12, 16-bit container */
        OMAP_DSS_COLOR_ARGB16   = 1 << 5,  /* ARGB16 */
        OMAP_DSS_COLOR_RGB16    = 1 << 6,  /* RGB16 */
        OMAP_DSS_COLOR_RGB24U   = 1 << 7,  /* RGB24, 32-bit container */
        OMAP_DSS_COLOR_RGB24P   = 1 << 8,  /* RGB24, 24-bit container */
        OMAP_DSS_COLOR_YUV2     = 1 << 9,  /* YUV2 4:2:2 co-sited */
        OMAP_DSS_COLOR_UYVY     = 1 << 10, /* UYVY 4:2:2 co-sited */
        OMAP_DSS_COLOR_ARGB32   = 1 << 11, /* ARGB32 */
        OMAP_DSS_COLOR_RGBA32   = 1 << 12, /* RGBA32 */
        OMAP_DSS_COLOR_RGBX32   = 1 << 13, /* RGBx32 */
        OMAP_DSS_COLOR_NV12             = 1 << 14, /* NV12 format: YUV 4:2:0 */
        OMAP_DSS_COLOR_RGBA16           = 1 << 15, /* RGBA16 - 4444 */
        OMAP_DSS_COLOR_RGBX16           = 1 << 16, /* RGBx16 - 4444 */
        OMAP_DSS_COLOR_ARGB16_1555      = 1 << 17, /* ARGB16 - 1555 */
        OMAP_DSS_COLOR_XRGB16_1555      = 1 << 18, /* xRGB16 - 1555 */
};

enum omap_dss_load_mode {
        OMAP_DSS_LOAD_CLUT_AND_FRAME    = 0,
        OMAP_DSS_LOAD_CLUT_ONLY         = 1,
        OMAP_DSS_LOAD_FRAME_ONLY        = 2,
        OMAP_DSS_LOAD_CLUT_ONCE_FRAME   = 3,
};

enum omap_dss_trans_key_type {
        OMAP_DSS_COLOR_KEY_GFX_DST = 0,
        OMAP_DSS_COLOR_KEY_VID_SRC = 1,
};

enum omap_dss_signal_level {
        OMAPDSS_SIG_ACTIVE_LOW,
        OMAPDSS_SIG_ACTIVE_HIGH,
};

enum omap_dss_signal_edge {
        OMAPDSS_DRIVE_SIG_FALLING_EDGE,
        OMAPDSS_DRIVE_SIG_RISING_EDGE,
};

enum omap_dss_venc_type {
        OMAP_DSS_VENC_TYPE_COMPOSITE,
        OMAP_DSS_VENC_TYPE_SVIDEO,
};

enum omap_dss_dsi_pixel_format {
        OMAP_DSS_DSI_FMT_RGB888,
        OMAP_DSS_DSI_FMT_RGB666,
        OMAP_DSS_DSI_FMT_RGB666_PACKED,
        OMAP_DSS_DSI_FMT_RGB565,
};

enum omap_dss_dsi_mode {
        OMAP_DSS_DSI_CMD_MODE = 0,
        OMAP_DSS_DSI_VIDEO_MODE,
};

enum omap_display_caps {
        OMAP_DSS_DISPLAY_CAP_MANUAL_UPDATE      = 1 << 0,
        OMAP_DSS_DISPLAY_CAP_TEAR_ELIM          = 1 << 1,
};

enum omap_dss_display_state {
        OMAP_DSS_DISPLAY_DISABLED = 0,
        OMAP_DSS_DISPLAY_ACTIVE,
};

enum omap_dss_rotation_type {
        OMAP_DSS_ROT_DMA        = 1 << 0,
        OMAP_DSS_ROT_VRFB       = 1 << 1,
        OMAP_DSS_ROT_TILER      = 1 << 2,
};

/* clockwise rotation angle */
enum omap_dss_rotation_angle {
        OMAP_DSS_ROT_0   = 0,
        OMAP_DSS_ROT_90  = 1,
        OMAP_DSS_ROT_180 = 2,
        OMAP_DSS_ROT_270 = 3,
};

enum omap_overlay_caps {
        OMAP_DSS_OVL_CAP_SCALE = 1 << 0,
        OMAP_DSS_OVL_CAP_GLOBAL_ALPHA = 1 << 1,
        OMAP_DSS_OVL_CAP_PRE_MULT_ALPHA = 1 << 2,
        OMAP_DSS_OVL_CAP_ZORDER = 1 << 3,
        OMAP_DSS_OVL_CAP_POS = 1 << 4,
        OMAP_DSS_OVL_CAP_REPLICATION = 1 << 5,
};

enum omap_dss_output_id {
        OMAP_DSS_OUTPUT_DPI     = 1 << 0,
        OMAP_DSS_OUTPUT_DBI     = 1 << 1,
        OMAP_DSS_OUTPUT_SDI     = 1 << 2,
        OMAP_DSS_OUTPUT_DSI1    = 1 << 3,
        OMAP_DSS_OUTPUT_DSI2    = 1 << 4,
        OMAP_DSS_OUTPUT_VENC    = 1 << 5,
        OMAP_DSS_OUTPUT_HDMI    = 1 << 6,
};

/* DSI */

enum omap_dss_dsi_trans_mode {
        /* Sync Pulses: both sync start and end packets sent */
        OMAP_DSS_DSI_PULSE_MODE,
        /* Sync Events: only sync start packets sent */
        OMAP_DSS_DSI_EVENT_MODE,
        /* Burst: only sync start packets sent, pixels are time compressed */
        OMAP_DSS_DSI_BURST_MODE,
};

struct omap_dss_dsi_videomode_timings {
        unsigned long hsclk;

        unsigned ndl;
        unsigned bitspp;

        /* pixels */
        u16 hact;
        /* lines */
        u16 vact;

        /* DSI video mode blanking data */
        /* Unit: byte clock cycles */
        u16 hss;
        u16 hsa;
        u16 hse;
        u16 hfp;
        u16 hbp;
        /* Unit: line clocks */
        u16 vsa;
        u16 vfp;
        u16 vbp;

        /* DSI blanking modes */
        int blanking_mode;
        int hsa_blanking_mode;
        int hbp_blanking_mode;
        int hfp_blanking_mode;

        enum omap_dss_dsi_trans_mode trans_mode;

        bool ddr_clk_always_on;
        int window_sync;
};

struct omap_dss_dsi_config {
        enum omap_dss_dsi_mode mode;
        enum omap_dss_dsi_pixel_format pixel_format;
        const struct omap_video_timings *timings;

        unsigned long hs_clk_min, hs_clk_max;
        unsigned long lp_clk_min, lp_clk_max;

        bool ddr_clk_always_on;
        enum omap_dss_dsi_trans_mode trans_mode;
};

struct omap_video_timings {
        /* Unit: pixels */
        u16 x_res;
        /* Unit: pixels */
        u16 y_res;
        /* Unit: Hz */
        u32 pixelclock;
        /* Unit: pixel clocks */
        u16 hsw;        /* Horizontal synchronization pulse width */
        /* Unit: pixel clocks */
        u16 hfp;        /* Horizontal front porch */
        /* Unit: pixel clocks */
        u16 hbp;        /* Horizontal back porch */
        /* Unit: line clocks */
        u16 vsw;        /* Vertical synchronization pulse width */
        /* Unit: line clocks */
        u16 vfp;        /* Vertical front porch */
        /* Unit: line clocks */
        u16 vbp;        /* Vertical back porch */

        /* Vsync logic level */
        enum omap_dss_signal_level vsync_level;
        /* Hsync logic level */
        enum omap_dss_signal_level hsync_level;
        /* Interlaced or Progressive timings */
        bool interlace;
        /* Pixel clock edge to drive LCD data */
        enum omap_dss_signal_edge data_pclk_edge;
        /* Data enable logic level */
        enum omap_dss_signal_level de_level;
        /* Pixel clock edges to drive HSYNC and VSYNC signals */
        enum omap_dss_signal_edge sync_pclk_edge;

        bool double_pixel;
};

/* Hardcoded timings for tv modes. Venc only uses these to
 * identify the mode, and does not actually use the configs
 * itself. However, the configs should be something that
 * a normal monitor can also show */
extern const struct omap_video_timings omap_dss_pal_timings;
extern const struct omap_video_timings omap_dss_ntsc_timings;

struct omap_dss_cpr_coefs {
        s16 rr, rg, rb;
        s16 gr, gg, gb;
        s16 br, bg, bb;
};

struct omap_overlay_info {
        dma_addr_t paddr;
        dma_addr_t p_uv_addr;  /* for NV12 format */
        u16 screen_width;
        u16 width;
        u16 height;
        enum omap_color_mode color_mode;
        u8 rotation;
        enum omap_dss_rotation_type rotation_type;
        bool mirror;

        u16 pos_x;
        u16 pos_y;
        u16 out_width;  /* if 0, out_width == width */
        u16 out_height; /* if 0, out_height == height */
        u8 global_alpha;
        u8 pre_mult_alpha;
        u8 zorder;
};

struct omap_overlay {
        struct kobject kobj;
        struct list_head list;

        /* static fields */
        const char *name;
        enum omap_plane id;
        enum omap_color_mode supported_modes;
        enum omap_overlay_caps caps;

        /* dynamic fields */
        struct omap_overlay_manager *manager;

        /*
         * The following functions do not block:
         *
         * is_enabled
         * set_overlay_info
         * get_overlay_info
         *
         * The rest of the functions may block and cannot be called from
         * interrupt context
         */

        int (*enable)(struct omap_overlay *ovl);
        int (*disable)(struct omap_overlay *ovl);
        bool (*is_enabled)(struct omap_overlay *ovl);

        int (*set_manager)(struct omap_overlay *ovl,
                struct omap_overlay_manager *mgr);
        int (*unset_manager)(struct omap_overlay *ovl);

        int (*set_overlay_info)(struct omap_overlay *ovl,
                        struct omap_overlay_info *info);
        void (*get_overlay_info)(struct omap_overlay *ovl,
                        struct omap_overlay_info *info);

        int (*wait_for_go)(struct omap_overlay *ovl);

        struct omap_dss_device *(*get_device)(struct omap_overlay *ovl);
};

struct omap_overlay_manager_info {
        u32 default_color;

        enum omap_dss_trans_key_type trans_key_type;
        u32 trans_key;
        bool trans_enabled;

        bool partial_alpha_enabled;

        bool cpr_enable;
        struct omap_dss_cpr_coefs cpr_coefs;
};

struct omap_overlay_manager {
        struct kobject kobj;

        /* static fields */
        const char *name;
        enum omap_channel id;
        struct list_head overlays;
        enum omap_display_type supported_displays;
        enum omap_dss_output_id supported_outputs;

        /* dynamic fields */
        struct omap_dss_device *output;

        /*
         * The following functions do not block:
         *
         * set_manager_info
         * get_manager_info
         * apply
         *
         * The rest of the functions may block and cannot be called from
         * interrupt context
         */

        int (*set_output)(struct omap_overlay_manager *mgr,
                struct omap_dss_device *output);
        int (*unset_output)(struct omap_overlay_manager *mgr);

        int (*set_manager_info)(struct omap_overlay_manager *mgr,
                        struct omap_overlay_manager_info *info);
        void (*get_manager_info)(struct omap_overlay_manager *mgr,
                        struct omap_overlay_manager_info *info);

        int (*apply)(struct omap_overlay_manager *mgr);
        int (*wait_for_go)(struct omap_overlay_manager *mgr);
        int (*wait_for_vsync)(struct omap_overlay_manager *mgr);

        struct omap_dss_device *(*get_device)(struct omap_overlay_manager *mgr);
};

/* 22 pins means 1 clk lane and 10 data lanes */
#define OMAP_DSS_MAX_DSI_PINS 22

struct omap_dsi_pin_config {
        int num_pins;
        /*
         * pin numbers in the following order:
         * clk+, clk-
         * data1+, data1-
         * data2+, data2-
         * ...
         */
        int pins[OMAP_DSS_MAX_DSI_PINS];
};

struct omap_dss_writeback_info {
        u32 paddr;
        u32 p_uv_addr;
        u16 buf_width;
        u16 width;
        u16 height;
        enum omap_color_mode color_mode;
        u8 rotation;
        enum omap_dss_rotation_type rotation_type;
        bool mirror;
        u8 pre_mult_alpha;
};

struct omapdss_dpi_ops {
        int (*connect)(struct omap_dss_device *dssdev,
                        struct omap_dss_device *dst);
        void (*disconnect)(struct omap_dss_device *dssdev,
                        struct omap_dss_device *dst);

        int (*enable)(struct omap_dss_device *dssdev);
        void (*disable)(struct omap_dss_device *dssdev);

        int (*check_timings)(struct omap_dss_device *dssdev,
                        struct omap_video_timings *timings);
        void (*set_timings)(struct omap_dss_device *dssdev,
                        struct omap_video_timings *timings);
        void (*get_timings)(struct omap_dss_device *dssdev,
                        struct omap_video_timings *timings);

        void (*set_data_lines)(struct omap_dss_device *dssdev, int data_lines);
};

struct omapdss_sdi_ops {
        int (*connect)(struct omap_dss_device *dssdev,
                        struct omap_dss_device *dst);
        void (*disconnect)(struct omap_dss_device *dssdev,
                        struct omap_dss_device *dst);

        int (*enable)(struct omap_dss_device *dssdev);
        void (*disable)(struct omap_dss_device *dssdev);

        int (*check_timings)(struct omap_dss_device *dssdev,
                        struct omap_video_timings *timings);
        void (*set_timings)(struct omap_dss_device *dssdev,
                        struct omap_video_timings *timings);
        void (*get_timings)(struct omap_dss_device *dssdev,
                        struct omap_video_timings *timings);

        void (*set_datapairs)(struct omap_dss_device *dssdev, int datapairs);
};

struct omapdss_dvi_ops {
        int (*connect)(struct omap_dss_device *dssdev,
                        struct omap_dss_device *dst);
        void (*disconnect)(struct omap_dss_device *dssdev,
                        struct omap_dss_device *dst);

        int (*enable)(struct omap_dss_device *dssdev);
        void (*disable)(struct omap_dss_device *dssdev);

        int (*check_timings)(struct omap_dss_device *dssdev,
                        struct omap_video_timings *timings);
        void (*set_timings)(struct omap_dss_device *dssdev,
                        struct omap_video_timings *timings);
        void (*get_timings)(struct omap_dss_device *dssdev,
                        struct omap_video_timings *timings);
};

struct omapdss_atv_ops {
        int (*connect)(struct omap_dss_device *dssdev,
                        struct omap_dss_device *dst);
        void (*disconnect)(struct omap_dss_device *dssdev,
                        struct omap_dss_device *dst);

        int (*enable)(struct omap_dss_device *dssdev);
        void (*disable)(struct omap_dss_device *dssdev);

        int (*check_timings)(struct omap_dss_device *dssdev,
                        struct omap_video_timings *timings);
        void (*set_timings)(struct omap_dss_device *dssdev,
                        struct omap_video_timings *timings);
        void (*get_timings)(struct omap_dss_device *dssdev,
                        struct omap_video_timings *timings);

        void (*set_type)(struct omap_dss_device *dssdev,
                enum omap_dss_venc_type type);
        void (*invert_vid_out_polarity)(struct omap_dss_device *dssdev,
                bool invert_polarity);

        int (*set_wss)(struct omap_dss_device *dssdev, u32 wss);
        u32 (*get_wss)(struct omap_dss_device *dssdev);
};

struct omapdss_hdmi_ops {
        int (*connect)(struct omap_dss_device *dssdev,
                        struct omap_dss_device *dst);
        void (*disconnect)(struct omap_dss_device *dssdev,
                        struct omap_dss_device *dst);

        int (*enable)(struct omap_dss_device *dssdev);
        void (*disable)(struct omap_dss_device *dssdev);

        int (*check_timings)(struct omap_dss_device *dssdev,
                        struct omap_video_timings *timings);
        void (*set_timings)(struct omap_dss_device *dssdev,
                        struct omap_video_timings *timings);
        void (*get_timings)(struct omap_dss_device *dssdev,
                        struct omap_video_timings *timings);

        int (*read_edid)(struct omap_dss_device *dssdev, u8 *buf, int len);
        bool (*detect)(struct omap_dss_device *dssdev);

        int (*set_hdmi_mode)(struct omap_dss_device *dssdev, bool hdmi_mode);
        int (*set_infoframe)(struct omap_dss_device *dssdev,
                const struct hdmi_avi_infoframe *avi);
};

struct omapdss_dsi_ops {
        int (*connect)(struct omap_dss_device *dssdev,
                        struct omap_dss_device *dst);
        void (*disconnect)(struct omap_dss_device *dssdev,
                        struct omap_dss_device *dst);

        int (*enable)(struct omap_dss_device *dssdev);
        void (*disable)(struct omap_dss_device *dssdev, bool disconnect_lanes,
                        bool enter_ulps);

        /* bus configuration */
        int (*set_config)(struct omap_dss_device *dssdev,
                        const struct omap_dss_dsi_config *cfg);
        int (*configure_pins)(struct omap_dss_device *dssdev,
                        const struct omap_dsi_pin_config *pin_cfg);

        void (*enable_hs)(struct omap_dss_device *dssdev, int channel,
                        bool enable);
        int (*enable_te)(struct omap_dss_device *dssdev, bool enable);

        int (*update)(struct omap_dss_device *dssdev, int channel,
                        void (*callback)(int, void *), void *data);

        void (*bus_lock)(struct omap_dss_device *dssdev);
        void (*bus_unlock)(struct omap_dss_device *dssdev);

        int (*enable_video_output)(struct omap_dss_device *dssdev, int channel);
        void (*disable_video_output)(struct omap_dss_device *dssdev,
                        int channel);

        int (*request_vc)(struct omap_dss_device *dssdev, int *channel);
        int (*set_vc_id)(struct omap_dss_device *dssdev, int channel,
                        int vc_id);
        void (*release_vc)(struct omap_dss_device *dssdev, int channel);

        /* data transfer */
        int (*dcs_write)(struct omap_dss_device *dssdev, int channel,
                        u8 *data, int len);
        int (*dcs_write_nosync)(struct omap_dss_device *dssdev, int channel,
                        u8 *data, int len);
        int (*dcs_read)(struct omap_dss_device *dssdev, int channel, u8 dcs_cmd,
                        u8 *data, int len);

        int (*gen_write)(struct omap_dss_device *dssdev, int channel,
                        u8 *data, int len);
        int (*gen_write_nosync)(struct omap_dss_device *dssdev, int channel,
                        u8 *data, int len);
        int (*gen_read)(struct omap_dss_device *dssdev, int channel,
                        u8 *reqdata, int reqlen,
                        u8 *data, int len);

        int (*bta_sync)(struct omap_dss_device *dssdev, int channel);

        int (*set_max_rx_packet_size)(struct omap_dss_device *dssdev,
                        int channel, u16 plen);
};

struct omap_dss_device {
        struct kobject kobj;
        struct device *dev;

        struct module *owner;

        struct list_head panel_list;

        /* alias in the form of "display%d" */
        char alias[16];

        enum omap_display_type type;
        enum omap_display_type output_type;

        union {
                struct {
                        u8 data_lines;
                } dpi;

                struct {
                        u8 datapairs;
                } sdi;

                struct {
                        int module;
                } dsi;

                struct {
                        enum omap_dss_venc_type type;
                        bool invert_polarity;
                } venc;
        } phy;

        struct {
                struct omap_video_timings timings;

                enum omap_dss_dsi_pixel_format dsi_pix_fmt;
                enum omap_dss_dsi_mode dsi_mode;
        } panel;

        struct {
                u8 pixel_size;
        } ctrl;

        const char *name;

        /* used to match device to driver */
        const char *driver_name;

        void *data;

        struct omap_dss_driver *driver;

        union {
                const struct omapdss_dpi_ops *dpi;
                const struct omapdss_sdi_ops *sdi;
                const struct omapdss_dvi_ops *dvi;
                const struct omapdss_hdmi_ops *hdmi;
                const struct omapdss_atv_ops *atv;
                const struct omapdss_dsi_ops *dsi;
        } ops;

        /* helper variable for driver suspend/resume */
        bool activate_after_resume;

        enum omap_display_caps caps;

        struct omap_dss_device *src;

        enum omap_dss_display_state state;

        /* OMAP DSS output specific fields */

        struct list_head list;

        /* DISPC channel for this output */
        enum omap_channel dispc_channel;
        bool dispc_channel_connected;

        /* output instance */
        enum omap_dss_output_id id;

        /* the port number in the DT node */
        int port_num;

        /* dynamic fields */
        struct omap_overlay_manager *manager;

        struct omap_dss_device *dst;
};

struct omap_dss_driver {
        int (*probe)(struct omap_dss_device *);
        void (*remove)(struct omap_dss_device *);

        int (*connect)(struct omap_dss_device *dssdev);
        void (*disconnect)(struct omap_dss_device *dssdev);

        int (*enable)(struct omap_dss_device *display);
        void (*disable)(struct omap_dss_device *display);
        int (*run_test)(struct omap_dss_device *display, int test);

        int (*update)(struct omap_dss_device *dssdev,
                               u16 x, u16 y, u16 w, u16 h);
        int (*sync)(struct omap_dss_device *dssdev);

        int (*enable_te)(struct omap_dss_device *dssdev, bool enable);
        int (*get_te)(struct omap_dss_device *dssdev);

        u8 (*get_rotate)(struct omap_dss_device *dssdev);
        int (*set_rotate)(struct omap_dss_device *dssdev, u8 rotate);

        bool (*get_mirror)(struct omap_dss_device *dssdev);
        int (*set_mirror)(struct omap_dss_device *dssdev, bool enable);

        int (*memory_read)(struct omap_dss_device *dssdev,
                        void *buf, size_t size,
                        u16 x, u16 y, u16 w, u16 h);

        void (*get_resolution)(struct omap_dss_device *dssdev,
                        u16 *xres, u16 *yres);
        void (*get_dimensions)(struct omap_dss_device *dssdev,
                        u32 *width, u32 *height);
        int (*get_recommended_bpp)(struct omap_dss_device *dssdev);

        int (*check_timings)(struct omap_dss_device *dssdev,
                        struct omap_video_timings *timings);
        void (*set_timings)(struct omap_dss_device *dssdev,
                        struct omap_video_timings *timings);
        void (*get_timings)(struct omap_dss_device *dssdev,
                        struct omap_video_timings *timings);

        int (*set_wss)(struct omap_dss_device *dssdev, u32 wss);
        u32 (*get_wss)(struct omap_dss_device *dssdev);

        int (*read_edid)(struct omap_dss_device *dssdev, u8 *buf, int len);
        bool (*detect)(struct omap_dss_device *dssdev);

        int (*set_hdmi_mode)(struct omap_dss_device *dssdev, bool hdmi_mode);
        int (*set_hdmi_infoframe)(struct omap_dss_device *dssdev,
                const struct hdmi_avi_infoframe *avi);
};

#define for_each_dss_dev(d) while ((d = omap_dss_get_next_device(d)) != NULL)

typedef void (*omap_dispc_isr_t) (void *arg, u32 mask);

#if IS_ENABLED(CONFIG_FB_OMAP2)

enum omapdss_version omapdss_get_version(void);
bool omapdss_is_initialized(void);

int omap_dss_register_driver(struct omap_dss_driver *);
void omap_dss_unregister_driver(struct omap_dss_driver *);

int omapdss_register_display(struct omap_dss_device *dssdev);
void omapdss_unregister_display(struct omap_dss_device *dssdev);

struct omap_dss_device *omap_dss_get_device(struct omap_dss_device *dssdev);
void omap_dss_put_device(struct omap_dss_device *dssdev);
struct omap_dss_device *omap_dss_get_next_device(struct omap_dss_device *from);
struct omap_dss_device *omap_dss_find_device(void *data,
                int (*match)(struct omap_dss_device *dssdev, void *data));
const char *omapdss_get_default_display_name(void);

void videomode_to_omap_video_timings(const struct videomode *vm,
                struct omap_video_timings *ovt);
void omap_video_timings_to_videomode(const struct omap_video_timings *ovt,
                struct videomode *vm);

int dss_feat_get_num_mgrs(void);
int dss_feat_get_num_ovls(void);
enum omap_color_mode dss_feat_get_supported_color_modes(enum omap_plane plane);



int omap_dss_get_num_overlay_managers(void);
struct omap_overlay_manager *omap_dss_get_overlay_manager(int num);

int omap_dss_get_num_overlays(void);
struct omap_overlay *omap_dss_get_overlay(int num);

int omapdss_register_output(struct omap_dss_device *output);
void omapdss_unregister_output(struct omap_dss_device *output);
struct omap_dss_device *omap_dss_get_output(enum omap_dss_output_id id);
struct omap_dss_device *omap_dss_find_output(const char *name);
struct omap_dss_device *omap_dss_find_output_by_port_node(struct device_node *port);
int omapdss_output_set_device(struct omap_dss_device *out,
                struct omap_dss_device *dssdev);
int omapdss_output_unset_device(struct omap_dss_device *out);

struct omap_dss_device *omapdss_find_output_from_display(struct omap_dss_device *dssdev);
struct omap_overlay_manager *omapdss_find_mgr_from_display(struct omap_dss_device *dssdev);

void omapdss_default_get_resolution(struct omap_dss_device *dssdev,
                u16 *xres, u16 *yres);
int omapdss_default_get_recommended_bpp(struct omap_dss_device *dssdev);
void omapdss_default_get_timings(struct omap_dss_device *dssdev,
                struct omap_video_timings *timings);

int omap_dispc_register_isr(omap_dispc_isr_t isr, void *arg, u32 mask);
int omap_dispc_unregister_isr(omap_dispc_isr_t isr, void *arg, u32 mask);

int omapdss_compat_init(void);
void omapdss_compat_uninit(void);

static inline bool omapdss_device_is_connected(struct omap_dss_device *dssdev)
{
        return dssdev->src;
}

static inline bool omapdss_device_is_enabled(struct omap_dss_device *dssdev)
{
        return dssdev->state == OMAP_DSS_DISPLAY_ACTIVE;
}

struct device_node *
omapdss_of_get_next_port(const struct device_node *parent,
                         struct device_node *prev);

struct device_node *
omapdss_of_get_next_endpoint(const struct device_node *parent,
                             struct device_node *prev);

struct device_node *
omapdss_of_get_first_endpoint(const struct device_node *parent);

struct omap_dss_device *
omapdss_of_find_source_for_first_ep(struct device_node *node);
#else

static inline enum omapdss_version omapdss_get_version(void)
{ return OMAPDSS_VER_UNKNOWN; };

static inline bool omapdss_is_initialized(void)
{ return false; };

static inline int omap_dispc_register_isr(omap_dispc_isr_t isr,
                                          void *arg, u32 mask)
{ return 0; };

static inline int omap_dispc_unregister_isr(omap_dispc_isr_t isr,
                                            void *arg, u32 mask)
{ return 0; };

static inline struct omap_dss_device
*omap_dss_get_device(struct omap_dss_device *dssdev)
{ return NULL; };

static inline struct omap_dss_device
*omap_dss_get_next_device(struct omap_dss_device *from)
{return NULL; };

static inline void omap_dss_put_device(struct omap_dss_device *dssdev) {};

static inline int omapdss_compat_init(void)
{ return 0; };

static inline void omapdss_compat_uninit(void) {};

static inline int omap_dss_get_num_overlay_managers(void)
{ return 0; };

static inline struct omap_overlay_manager *omap_dss_get_overlay_manager(int num)
{ return NULL; };

static inline int omap_dss_get_num_overlays(void)
{ return 0; };

static inline struct omap_overlay *omap_dss_get_overlay(int num)
{ return NULL; };


#endif /* FB_OMAP2 */


#endif /* __OMAPFB_DSS_H */