/*
 * SH-Mobile High-Definition Multimedia Interface (HDMI) driver
 * for SLISHDMI13T and SLIPHDMIT IP cores
 *
 * Copyright (C) 2010, Guennadi Liakhovetski <g.liakhovetski@gmx.de>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#include <linux/clk.h>
#include <linux/console.h>
#include <linux/delay.h>
#include <linux/err.h>
#include <linux/init.h>
#include <linux/interrupt.h>
#include <linux/io.h>
#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/pm_runtime.h>
#include <linux/slab.h>
#include <linux/types.h>
#include <linux/workqueue.h>
#include <sound/soc.h>
#include <sound/soc-dapm.h>
#include <sound/initval.h>

#include <video/sh_mobile_hdmi.h>
#include <video/sh_mobile_lcdc.h>

#include "sh_mobile_lcdcfb.h"

#define HDMI_SYSTEM_CTRL                        0x00 /* System control */
#define HDMI_L_R_DATA_SWAP_CTRL_RPKT            0x01 /* L/R data swap control,
                                                        bits 19..16 of 20-bit N for Audio Clock Regeneration packet */
#define HDMI_20_BIT_N_FOR_AUDIO_RPKT_15_8       0x02 /* bits 15..8 of 20-bit N for Audio Clock Regeneration packet */
#define HDMI_20_BIT_N_FOR_AUDIO_RPKT_7_0        0x03 /* bits 7..0 of 20-bit N for Audio Clock Regeneration packet */
#define HDMI_SPDIF_AUDIO_SAMP_FREQ_CTS          0x04 /* SPDIF audio sampling frequency,
                                                        bits 19..16 of Internal CTS */
#define HDMI_INTERNAL_CTS_15_8                  0x05 /* bits 15..8 of Internal CTS */
#define HDMI_INTERNAL_CTS_7_0                   0x06 /* bits 7..0 of Internal CTS */
#define HDMI_EXTERNAL_CTS_19_16                 0x07 /* External CTS */
#define HDMI_EXTERNAL_CTS_15_8                  0x08 /* External CTS */
#define HDMI_EXTERNAL_CTS_7_0                   0x09 /* External CTS */
#define HDMI_AUDIO_SETTING_1                    0x0A /* Audio setting.1 */
#define HDMI_AUDIO_SETTING_2                    0x0B /* Audio setting.2 */
#define HDMI_I2S_AUDIO_SET                      0x0C /* I2S audio setting */
#define HDMI_DSD_AUDIO_SET                      0x0D /* DSD audio setting */
#define HDMI_DEBUG_MONITOR_1                    0x0E /* Debug monitor.1 */
#define HDMI_DEBUG_MONITOR_2                    0x0F /* Debug monitor.2 */
#define HDMI_I2S_INPUT_PIN_SWAP                 0x10 /* I2S input pin swap */
#define HDMI_AUDIO_STATUS_BITS_SETTING_1        0x11 /* Audio status bits setting.1 */
#define HDMI_AUDIO_STATUS_BITS_SETTING_2        0x12 /* Audio status bits setting.2 */
#define HDMI_CATEGORY_CODE                      0x13 /* Category code */
#define HDMI_SOURCE_NUM_AUDIO_WORD_LEN          0x14 /* Source number/Audio word length */
#define HDMI_AUDIO_VIDEO_SETTING_1              0x15 /* Audio/Video setting.1 */
#define HDMI_VIDEO_SETTING_1                    0x16 /* Video setting.1 */
#define HDMI_DEEP_COLOR_MODES                   0x17 /* Deep Color Modes */

/* 12 16- and 10-bit Color space conversion parameters: 0x18..0x2f */
#define HDMI_COLOR_SPACE_CONVERSION_PARAMETERS  0x18

#define HDMI_EXTERNAL_VIDEO_PARAM_SETTINGS      0x30 /* External video parameter settings */
#define HDMI_EXTERNAL_H_TOTAL_7_0               0x31 /* External horizontal total (LSB) */
#define HDMI_EXTERNAL_H_TOTAL_11_8              0x32 /* External horizontal total (MSB) */
#define HDMI_EXTERNAL_H_BLANK_7_0               0x33 /* External horizontal blank (LSB) */
#define HDMI_EXTERNAL_H_BLANK_9_8               0x34 /* External horizontal blank (MSB) */
#define HDMI_EXTERNAL_H_DELAY_7_0               0x35 /* External horizontal delay (LSB) */
#define HDMI_EXTERNAL_H_DELAY_9_8               0x36 /* External horizontal delay (MSB) */
#define HDMI_EXTERNAL_H_DURATION_7_0            0x37 /* External horizontal duration (LSB) */
#define HDMI_EXTERNAL_H_DURATION_9_8            0x38 /* External horizontal duration (MSB) */
#define HDMI_EXTERNAL_V_TOTAL_7_0               0x39 /* External vertical total (LSB) */
#define HDMI_EXTERNAL_V_TOTAL_9_8               0x3A /* External vertical total (MSB) */
#define HDMI_AUDIO_VIDEO_SETTING_2              0x3B /* Audio/Video setting.2 */
#define HDMI_EXTERNAL_V_BLANK                   0x3D /* External vertical blank */
#define HDMI_EXTERNAL_V_DELAY                   0x3E /* External vertical delay */
#define HDMI_EXTERNAL_V_DURATION                0x3F /* External vertical duration */
#define HDMI_CTRL_PKT_MANUAL_SEND_CONTROL       0x40 /* Control packet manual send control */
#define HDMI_CTRL_PKT_AUTO_SEND                 0x41 /* Control packet auto send with VSYNC control */
#define HDMI_AUTO_CHECKSUM_OPTION               0x42 /* Auto checksum option */
#define HDMI_VIDEO_SETTING_2                    0x45 /* Video setting.2 */
#define HDMI_OUTPUT_OPTION                      0x46 /* Output option */
#define HDMI_SLIPHDMIT_PARAM_OPTION             0x51 /* SLIPHDMIT parameter option */
#define HDMI_HSYNC_PMENT_AT_EMB_7_0             0x52 /* HSYNC placement at embedded sync (LSB) */
#define HDMI_HSYNC_PMENT_AT_EMB_15_8            0x53 /* HSYNC placement at embedded sync (MSB) */
#define HDMI_VSYNC_PMENT_AT_EMB_7_0             0x54 /* VSYNC placement at embedded sync (LSB) */
#define HDMI_VSYNC_PMENT_AT_EMB_14_8            0x55 /* VSYNC placement at embedded sync (MSB) */
#define HDMI_SLIPHDMIT_PARAM_SETTINGS_1         0x56 /* SLIPHDMIT parameter settings.1 */
#define HDMI_SLIPHDMIT_PARAM_SETTINGS_2         0x57 /* SLIPHDMIT parameter settings.2 */
#define HDMI_SLIPHDMIT_PARAM_SETTINGS_3         0x58 /* SLIPHDMIT parameter settings.3 */
#define HDMI_SLIPHDMIT_PARAM_SETTINGS_5         0x59 /* SLIPHDMIT parameter settings.5 */
#define HDMI_SLIPHDMIT_PARAM_SETTINGS_6         0x5A /* SLIPHDMIT parameter settings.6 */
#define HDMI_SLIPHDMIT_PARAM_SETTINGS_7         0x5B /* SLIPHDMIT parameter settings.7 */
#define HDMI_SLIPHDMIT_PARAM_SETTINGS_8         0x5C /* SLIPHDMIT parameter settings.8 */
#define HDMI_SLIPHDMIT_PARAM_SETTINGS_9         0x5D /* SLIPHDMIT parameter settings.9 */
#define HDMI_SLIPHDMIT_PARAM_SETTINGS_10        0x5E /* SLIPHDMIT parameter settings.10 */
#define HDMI_CTRL_PKT_BUF_INDEX                 0x5F /* Control packet buffer index */
#define HDMI_CTRL_PKT_BUF_ACCESS_HB0            0x60 /* Control packet data buffer access window - HB0 */
#define HDMI_CTRL_PKT_BUF_ACCESS_HB1            0x61 /* Control packet data buffer access window - HB1 */
#define HDMI_CTRL_PKT_BUF_ACCESS_HB2            0x62 /* Control packet data buffer access window - HB2 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB0            0x63 /* Control packet data buffer access window - PB0 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB1            0x64 /* Control packet data buffer access window - PB1 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB2            0x65 /* Control packet data buffer access window - PB2 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB3            0x66 /* Control packet data buffer access window - PB3 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB4            0x67 /* Control packet data buffer access window - PB4 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB5            0x68 /* Control packet data buffer access window - PB5 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB6            0x69 /* Control packet data buffer access window - PB6 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB7            0x6A /* Control packet data buffer access window - PB7 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB8            0x6B /* Control packet data buffer access window - PB8 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB9            0x6C /* Control packet data buffer access window - PB9 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB10           0x6D /* Control packet data buffer access window - PB10 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB11           0x6E /* Control packet data buffer access window - PB11 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB12           0x6F /* Control packet data buffer access window - PB12 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB13           0x70 /* Control packet data buffer access window - PB13 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB14           0x71 /* Control packet data buffer access window - PB14 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB15           0x72 /* Control packet data buffer access window - PB15 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB16           0x73 /* Control packet data buffer access window - PB16 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB17           0x74 /* Control packet data buffer access window - PB17 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB18           0x75 /* Control packet data buffer access window - PB18 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB19           0x76 /* Control packet data buffer access window - PB19 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB20           0x77 /* Control packet data buffer access window - PB20 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB21           0x78 /* Control packet data buffer access window - PB21 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB22           0x79 /* Control packet data buffer access window - PB22 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB23           0x7A /* Control packet data buffer access window - PB23 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB24           0x7B /* Control packet data buffer access window - PB24 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB25           0x7C /* Control packet data buffer access window - PB25 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB26           0x7D /* Control packet data buffer access window - PB26 */
#define HDMI_CTRL_PKT_BUF_ACCESS_PB27           0x7E /* Control packet data buffer access window - PB27 */
#define HDMI_EDID_KSV_FIFO_ACCESS_WINDOW        0x80 /* EDID/KSV FIFO access window */
#define HDMI_DDC_BUS_ACCESS_FREQ_CTRL_7_0       0x81 /* DDC bus access frequency control (LSB) */
#define HDMI_DDC_BUS_ACCESS_FREQ_CTRL_15_8      0x82 /* DDC bus access frequency control (MSB) */
#define HDMI_INTERRUPT_MASK_1                   0x92 /* Interrupt mask.1 */
#define HDMI_INTERRUPT_MASK_2                   0x93 /* Interrupt mask.2 */
#define HDMI_INTERRUPT_STATUS_1                 0x94 /* Interrupt status.1 */
#define HDMI_INTERRUPT_STATUS_2                 0x95 /* Interrupt status.2 */
#define HDMI_INTERRUPT_MASK_3                   0x96 /* Interrupt mask.3 */
#define HDMI_INTERRUPT_MASK_4                   0x97 /* Interrupt mask.4 */
#define HDMI_INTERRUPT_STATUS_3                 0x98 /* Interrupt status.3 */
#define HDMI_INTERRUPT_STATUS_4                 0x99 /* Interrupt status.4 */
#define HDMI_SOFTWARE_HDCP_CONTROL_1            0x9A /* Software HDCP control.1 */
#define HDMI_FRAME_COUNTER                      0x9C /* Frame counter */
#define HDMI_FRAME_COUNTER_FOR_RI_CHECK         0x9D /* Frame counter for Ri check */
#define HDMI_HDCP_CONTROL                       0xAF /* HDCP control */
#define HDMI_RI_FRAME_COUNT_REGISTER            0xB2 /* Ri frame count register */
#define HDMI_DDC_BUS_CONTROL                    0xB7 /* DDC bus control */
#define HDMI_HDCP_STATUS                        0xB8 /* HDCP status */
#define HDMI_SHA0                               0xB9 /* sha0 */
#define HDMI_SHA1                               0xBA /* sha1 */
#define HDMI_SHA2                               0xBB /* sha2 */
#define HDMI_SHA3                               0xBC /* sha3 */
#define HDMI_SHA4                               0xBD /* sha4 */
#define HDMI_BCAPS_READ                         0xBE /* BCAPS read / debug */
#define HDMI_AKSV_BKSV_7_0_MONITOR              0xBF /* AKSV/BKSV[7:0] monitor */
#define HDMI_AKSV_BKSV_15_8_MONITOR             0xC0 /* AKSV/BKSV[15:8] monitor */
#define HDMI_AKSV_BKSV_23_16_MONITOR            0xC1 /* AKSV/BKSV[23:16] monitor */
#define HDMI_AKSV_BKSV_31_24_MONITOR            0xC2 /* AKSV/BKSV[31:24] monitor */
#define HDMI_AKSV_BKSV_39_32_MONITOR            0xC3 /* AKSV/BKSV[39:32] monitor */
#define HDMI_EDID_SEGMENT_POINTER               0xC4 /* EDID segment pointer */
#define HDMI_EDID_WORD_ADDRESS                  0xC5 /* EDID word address */
#define HDMI_EDID_DATA_FIFO_ADDRESS             0xC6 /* EDID data FIFO address */
#define HDMI_NUM_OF_HDMI_DEVICES                0xC7 /* Number of HDMI devices */
#define HDMI_HDCP_ERROR_CODE                    0xC8 /* HDCP error code */
#define HDMI_100MS_TIMER_SET                    0xC9 /* 100ms timer setting */
#define HDMI_5SEC_TIMER_SET                     0xCA /* 5sec timer setting */
#define HDMI_RI_READ_COUNT                      0xCB /* Ri read count */
#define HDMI_AN_SEED                            0xCC /* An seed */
#define HDMI_MAX_NUM_OF_RCIVRS_ALLOWED          0xCD /* Maximum number of receivers allowed */
#define HDMI_HDCP_MEMORY_ACCESS_CONTROL_1       0xCE /* HDCP memory access control.1 */
#define HDMI_HDCP_MEMORY_ACCESS_CONTROL_2       0xCF /* HDCP memory access control.2 */
#define HDMI_HDCP_CONTROL_2                     0xD0 /* HDCP Control 2 */
#define HDMI_HDCP_KEY_MEMORY_CONTROL            0xD2 /* HDCP Key Memory Control */
#define HDMI_COLOR_SPACE_CONV_CONFIG_1          0xD3 /* Color space conversion configuration.1 */
#define HDMI_VIDEO_SETTING_3                    0xD4 /* Video setting.3 */
#define HDMI_RI_7_0                             0xD5 /* Ri[7:0] */
#define HDMI_RI_15_8                            0xD6 /* Ri[15:8] */
#define HDMI_PJ                                 0xD7 /* Pj */
#define HDMI_SHA_RD                             0xD8 /* sha_rd */
#define HDMI_RI_7_0_SAVED                       0xD9 /* Ri[7:0] saved */
#define HDMI_RI_15_8_SAVED                      0xDA /* Ri[15:8] saved */
#define HDMI_PJ_SAVED                           0xDB /* Pj saved */
#define HDMI_NUM_OF_DEVICES                     0xDC /* Number of devices */
#define HDMI_HOT_PLUG_MSENS_STATUS              0xDF /* Hot plug/MSENS status */
#define HDMI_BCAPS_WRITE                        0xE0 /* bcaps */
#define HDMI_BSTAT_7_0                          0xE1 /* bstat[7:0] */
#define HDMI_BSTAT_15_8                         0xE2 /* bstat[15:8] */
#define HDMI_BKSV_7_0                           0xE3 /* bksv[7:0] */
#define HDMI_BKSV_15_8                          0xE4 /* bksv[15:8] */
#define HDMI_BKSV_23_16                         0xE5 /* bksv[23:16] */
#define HDMI_BKSV_31_24                         0xE6 /* bksv[31:24] */
#define HDMI_BKSV_39_32                         0xE7 /* bksv[39:32] */
#define HDMI_AN_7_0                             0xE8 /* An[7:0] */
#define HDMI_AN_15_8                            0xE9 /* An [15:8] */
#define HDMI_AN_23_16                           0xEA /* An [23:16] */
#define HDMI_AN_31_24                           0xEB /* An [31:24] */
#define HDMI_AN_39_32                           0xEC /* An [39:32] */
#define HDMI_AN_47_40                           0xED /* An [47:40] */
#define HDMI_AN_55_48                           0xEE /* An [55:48] */
#define HDMI_AN_63_56                           0xEF /* An [63:56] */
#define HDMI_PRODUCT_ID                         0xF0 /* Product ID */
#define HDMI_REVISION_ID                        0xF1 /* Revision ID */
#define HDMI_TEST_MODE                          0xFE /* Test mode */

enum hotplug_state {
        HDMI_HOTPLUG_DISCONNECTED,
        HDMI_HOTPLUG_CONNECTED,
        HDMI_HOTPLUG_EDID_DONE,
};

struct sh_hdmi {
        void __iomem *base;
        enum hotplug_state hp_state;    /* hot-plug status */
        u8 preprogrammed_vic;           /* use a pre-programmed VIC or
                                           the external mode */
        u8 edid_block_addr;
        u8 edid_segment_nr;
        u8 edid_blocks;
        struct clk *hdmi_clk;
        struct device *dev;
        struct fb_info *info;
        struct mutex mutex;             /* Protect the info pointer */
        struct delayed_work edid_work;
        struct fb_var_screeninfo var;
        struct fb_monspecs monspec;
        struct notifier_block notifier;
};

static void hdmi_write(struct sh_hdmi *hdmi, u8 data, u8 reg)
{
        iowrite8(data, hdmi->base + reg);
}

static u8 hdmi_read(struct sh_hdmi *hdmi, u8 reg)
{
        return ioread8(hdmi->base + reg);
}

/*
 *      HDMI sound
 */
static unsigned int sh_hdmi_snd_read(struct snd_soc_codec *codec,
                                     unsigned int reg)
{
        struct sh_hdmi *hdmi = snd_soc_codec_get_drvdata(codec);

        return hdmi_read(hdmi, reg);
}

static int sh_hdmi_snd_write(struct snd_soc_codec *codec,
                             unsigned int reg,
                             unsigned int value)
{
        struct sh_hdmi *hdmi = snd_soc_codec_get_drvdata(codec);

        hdmi_write(hdmi, value, reg);
        return 0;
}

static struct snd_soc_dai_driver sh_hdmi_dai = {
        .name = "sh_mobile_hdmi-hifi",
        .playback = {
                .stream_name = "Playback",
                .channels_min = 2,
                .channels_max = 8,
                .rates = SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100  |
                         SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200  |
                         SNDRV_PCM_RATE_96000 | SNDRV_PCM_RATE_176400 |
                         SNDRV_PCM_RATE_192000,
                .formats = SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S24_LE,
        },
};

static int sh_hdmi_snd_probe(struct snd_soc_codec *codec)
{
        dev_info(codec->dev, "SH Mobile HDMI Audio Codec");

        return 0;
}

static struct snd_soc_codec_driver soc_codec_dev_sh_hdmi = {
        .probe          = sh_hdmi_snd_probe,
        .read           = sh_hdmi_snd_read,
        .write          = sh_hdmi_snd_write,
};

/*
 *      HDMI video
 */

/* External video parameter settings */
static void sh_hdmi_external_video_param(struct sh_hdmi *hdmi)
{
        struct fb_var_screeninfo *var = &hdmi->var;
        u16 htotal, hblank, hdelay, vtotal, vblank, vdelay, voffset;
        u8 sync = 0;

        htotal = var->xres + var->right_margin + var->left_margin + var->hsync_len;

        hdelay = var->hsync_len + var->left_margin;
        hblank = var->right_margin + hdelay;

        /*
         * Vertical timing looks a bit different in Figure 18,
         * but let's try the same first by setting offset = 0
         */
        vtotal = var->yres + var->upper_margin + var->lower_margin + var->vsync_len;

        vdelay = var->vsync_len + var->upper_margin;
        vblank = var->lower_margin + vdelay;
        voffset = min(var->upper_margin / 2, 6U);

        /*
         * [3]: VSYNC polarity: Positive
         * [2]: HSYNC polarity: Positive
         * [1]: Interlace/Progressive: Progressive
         * [0]: External video settings enable: used.
         */
        if (var->sync & FB_SYNC_HOR_HIGH_ACT)
                sync |= 4;
        if (var->sync & FB_SYNC_VERT_HIGH_ACT)
                sync |= 8;

        dev_dbg(hdmi->dev, "H: %u, %u, %u, %u; V: %u, %u, %u, %u; sync 0x%x\n",
                htotal, hblank, hdelay, var->hsync_len,
                vtotal, vblank, vdelay, var->vsync_len, sync);

        hdmi_write(hdmi, sync | (voffset << 4), HDMI_EXTERNAL_VIDEO_PARAM_SETTINGS);

        hdmi_write(hdmi, htotal, HDMI_EXTERNAL_H_TOTAL_7_0);
        hdmi_write(hdmi, htotal >> 8, HDMI_EXTERNAL_H_TOTAL_11_8);

        hdmi_write(hdmi, hblank, HDMI_EXTERNAL_H_BLANK_7_0);
        hdmi_write(hdmi, hblank >> 8, HDMI_EXTERNAL_H_BLANK_9_8);

        hdmi_write(hdmi, hdelay, HDMI_EXTERNAL_H_DELAY_7_0);
        hdmi_write(hdmi, hdelay >> 8, HDMI_EXTERNAL_H_DELAY_9_8);

        hdmi_write(hdmi, var->hsync_len, HDMI_EXTERNAL_H_DURATION_7_0);
        hdmi_write(hdmi, var->hsync_len >> 8, HDMI_EXTERNAL_H_DURATION_9_8);

        hdmi_write(hdmi, vtotal, HDMI_EXTERNAL_V_TOTAL_7_0);
        hdmi_write(hdmi, vtotal >> 8, HDMI_EXTERNAL_V_TOTAL_9_8);

        hdmi_write(hdmi, vblank, HDMI_EXTERNAL_V_BLANK);

        hdmi_write(hdmi, vdelay, HDMI_EXTERNAL_V_DELAY);

        hdmi_write(hdmi, var->vsync_len, HDMI_EXTERNAL_V_DURATION);

        /* Set bit 0 of HDMI_EXTERNAL_VIDEO_PARAM_SETTINGS here for external mode */
        if (!hdmi->preprogrammed_vic)
                hdmi_write(hdmi, sync | 1 | (voffset << 4),
                           HDMI_EXTERNAL_VIDEO_PARAM_SETTINGS);
}

/**
 * sh_hdmi_video_config()
 */
static void sh_hdmi_video_config(struct sh_hdmi *hdmi)
{
        /*
         * [7:4]: Audio sampling frequency: 48kHz
         * [3:1]: Input video format: RGB and YCbCr 4:4:4 (Y on Green)
         * [0]: Internal/External DE select: internal
         */
        hdmi_write(hdmi, 0x20, HDMI_AUDIO_VIDEO_SETTING_1);

        /*
         * [7:6]: Video output format: RGB 4:4:4
         * [5:4]: Input video data width: 8 bit
         * [3:1]: EAV/SAV location: channel 1
         * [0]: Video input color space: RGB
         */
        hdmi_write(hdmi, 0x34, HDMI_VIDEO_SETTING_1);

        /*
         * [7:6]: Together with bit [6] of HDMI_AUDIO_VIDEO_SETTING_2, which is
         * left at 0 by default, this configures 24bpp and sets the Color Depth
         * (CD) field in the General Control Packet
         */
        hdmi_write(hdmi, 0x20, HDMI_DEEP_COLOR_MODES);
}

/**
 * sh_hdmi_audio_config()
 */
static void sh_hdmi_audio_config(struct sh_hdmi *hdmi)
{
        u8 data;
        struct sh_mobile_hdmi_info *pdata = hdmi->dev->platform_data;

        /*
         * [7:4] L/R data swap control
         * [3:0] appropriate N[19:16]
         */
        hdmi_write(hdmi, 0x00, HDMI_L_R_DATA_SWAP_CTRL_RPKT);
        /* appropriate N[15:8] */
        hdmi_write(hdmi, 0x18, HDMI_20_BIT_N_FOR_AUDIO_RPKT_15_8);
        /* appropriate N[7:0] */
        hdmi_write(hdmi, 0x00, HDMI_20_BIT_N_FOR_AUDIO_RPKT_7_0);

        /* [7:4] 48 kHz SPDIF not used */
        hdmi_write(hdmi, 0x20, HDMI_SPDIF_AUDIO_SAMP_FREQ_CTS);

        /*
         * [6:5] set required down sampling rate if required
         * [4:3] set required audio source
         */
        switch (pdata->flags & HDMI_SND_SRC_MASK) {
        default:
                /* fall through */
        case HDMI_SND_SRC_I2S:
                data = 0x0 << 3;
                break;
        case HDMI_SND_SRC_SPDIF:
                data = 0x1 << 3;
                break;
        case HDMI_SND_SRC_DSD:
                data = 0x2 << 3;
                break;
        case HDMI_SND_SRC_HBR:
                data = 0x3 << 3;
                break;
        }
        hdmi_write(hdmi, data, HDMI_AUDIO_SETTING_1);

        /* [3:0] set sending channel number for channel status */
        hdmi_write(hdmi, 0x40, HDMI_AUDIO_SETTING_2);

        /*
         * [5:2] set valid I2S source input pin
         * [1:0] set input I2S source mode
         */
        hdmi_write(hdmi, 0x04, HDMI_I2S_AUDIO_SET);

        /* [7:4] set valid DSD source input pin */
        hdmi_write(hdmi, 0x00, HDMI_DSD_AUDIO_SET);

        /* [7:0] set appropriate I2S input pin swap settings if required */
        hdmi_write(hdmi, 0x00, HDMI_I2S_INPUT_PIN_SWAP);

        /*
         * [7] set validity bit for channel status
         * [3:0] set original sample frequency for channel status
         */
        hdmi_write(hdmi, 0x00, HDMI_AUDIO_STATUS_BITS_SETTING_1);

        /*
         * [7] set value for channel status
         * [6] set value for channel status
         * [5] set copyright bit for channel status
         * [4:2] set additional information for channel status
         * [1:0] set clock accuracy for channel status
         */
        hdmi_write(hdmi, 0x00, HDMI_AUDIO_STATUS_BITS_SETTING_2);

        /* [7:0] set category code for channel status */
        hdmi_write(hdmi, 0x00, HDMI_CATEGORY_CODE);

        /*
         * [7:4] set source number for channel status
         * [3:0] set word length for channel status
         */
        hdmi_write(hdmi, 0x00, HDMI_SOURCE_NUM_AUDIO_WORD_LEN);

        /* [7:4] set sample frequency for channel status */
        hdmi_write(hdmi, 0x20, HDMI_AUDIO_VIDEO_SETTING_1);
}

/**
 * sh_hdmi_phy_config() - configure the HDMI PHY for the used video mode
 */
static void sh_hdmi_phy_config(struct sh_hdmi *hdmi)
{
        if (hdmi->var.pixclock < 10000) {
                /* for 1080p8bit 148MHz */
                hdmi_write(hdmi, 0x1d, HDMI_SLIPHDMIT_PARAM_SETTINGS_1);
                hdmi_write(hdmi, 0x00, HDMI_SLIPHDMIT_PARAM_SETTINGS_2);
                hdmi_write(hdmi, 0x00, HDMI_SLIPHDMIT_PARAM_SETTINGS_3);
                hdmi_write(hdmi, 0x4c, HDMI_SLIPHDMIT_PARAM_SETTINGS_5);
                hdmi_write(hdmi, 0x1e, HDMI_SLIPHDMIT_PARAM_SETTINGS_6);
                hdmi_write(hdmi, 0x48, HDMI_SLIPHDMIT_PARAM_SETTINGS_7);
                hdmi_write(hdmi, 0x0e, HDMI_SLIPHDMIT_PARAM_SETTINGS_8);
                hdmi_write(hdmi, 0x25, HDMI_SLIPHDMIT_PARAM_SETTINGS_9);
                hdmi_write(hdmi, 0x04, HDMI_SLIPHDMIT_PARAM_SETTINGS_10);
        } else if (hdmi->var.pixclock < 30000) {
                /* 720p, 8bit, 74.25MHz. Might need to be adjusted for other formats */
                /*
                 * [1:0]        Speed_A
                 * [3:2]        Speed_B
                 * [4]          PLLA_Bypass
                 * [6]          DRV_TEST_EN
                 * [7]          DRV_TEST_IN
                 */
                hdmi_write(hdmi, 0x0f, HDMI_SLIPHDMIT_PARAM_SETTINGS_1);
                /* PLLB_CONFIG[17], PLLA_CONFIG[17] - not in PHY datasheet */
                hdmi_write(hdmi, 0x00, HDMI_SLIPHDMIT_PARAM_SETTINGS_2);
                /*
                 * [2:0]        BGR_I_OFFSET
                 * [6:4]        BGR_V_OFFSET
                 */
                hdmi_write(hdmi, 0x00, HDMI_SLIPHDMIT_PARAM_SETTINGS_3);
                /* PLLA_CONFIG[7:0]: VCO gain, VCO offset, LPF resistance[0] */
                hdmi_write(hdmi, 0x44, HDMI_SLIPHDMIT_PARAM_SETTINGS_5);
                /*
                 * PLLA_CONFIG[15:8]: regulator voltage[0], CP current,
                 * LPF capacitance, LPF resistance[1]
                 */
                hdmi_write(hdmi, 0x32, HDMI_SLIPHDMIT_PARAM_SETTINGS_6);
                /* PLLB_CONFIG[7:0]: LPF resistance[0], VCO offset, VCO gain */
                hdmi_write(hdmi, 0x4A, HDMI_SLIPHDMIT_PARAM_SETTINGS_7);
                /*
                 * PLLB_CONFIG[15:8]: regulator voltage[0], CP current,
                 * LPF capacitance, LPF resistance[1]
                 */
                hdmi_write(hdmi, 0x00, HDMI_SLIPHDMIT_PARAM_SETTINGS_8);
                /* DRV_CONFIG, PE_CONFIG */
                hdmi_write(hdmi, 0x25, HDMI_SLIPHDMIT_PARAM_SETTINGS_9);
                /*
                 * [2:0]        AMON_SEL (4 == LPF voltage)
                 * [4]          PLLA_CONFIG[16]
                 * [5]          PLLB_CONFIG[16]
                 */
                hdmi_write(hdmi, 0x04, HDMI_SLIPHDMIT_PARAM_SETTINGS_10);
        } else {
                /* for 480p8bit 27MHz */
                hdmi_write(hdmi, 0x19, HDMI_SLIPHDMIT_PARAM_SETTINGS_1);
                hdmi_write(hdmi, 0x00, HDMI_SLIPHDMIT_PARAM_SETTINGS_2);
                hdmi_write(hdmi, 0x00, HDMI_SLIPHDMIT_PARAM_SETTINGS_3);
                hdmi_write(hdmi, 0x44, HDMI_SLIPHDMIT_PARAM_SETTINGS_5);
                hdmi_write(hdmi, 0x32, HDMI_SLIPHDMIT_PARAM_SETTINGS_6);
                hdmi_write(hdmi, 0x48, HDMI_SLIPHDMIT_PARAM_SETTINGS_7);
                hdmi_write(hdmi, 0x0F, HDMI_SLIPHDMIT_PARAM_SETTINGS_8);
                hdmi_write(hdmi, 0x20, HDMI_SLIPHDMIT_PARAM_SETTINGS_9);
                hdmi_write(hdmi, 0x04, HDMI_SLIPHDMIT_PARAM_SETTINGS_10);
        }
}

/**
 * sh_hdmi_avi_infoframe_setup() - Auxiliary Video Information InfoFrame CONTROL PACKET
 */
static void sh_hdmi_avi_infoframe_setup(struct sh_hdmi *hdmi)
{
        u8 vic;

        /* AVI InfoFrame */
        hdmi_write(hdmi, 0x06, HDMI_CTRL_PKT_BUF_INDEX);

        /* Packet Type = 0x82 */
        hdmi_write(hdmi, 0x82, HDMI_CTRL_PKT_BUF_ACCESS_HB0);

        /* Version = 0x02 */
        hdmi_write(hdmi, 0x02, HDMI_CTRL_PKT_BUF_ACCESS_HB1);

        /* Length = 13 (0x0D) */
        hdmi_write(hdmi, 0x0D, HDMI_CTRL_PKT_BUF_ACCESS_HB2);

        /* N. A. Checksum */
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB0);

        /*
         * Y = RGB
         * A0 = No Data
         * B = Bar Data not valid
         * S = No Data
         */
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB1);

        /*
         * [7:6] C = Colorimetry: no data
         * [5:4] M = 2: 16:9, 1: 4:3 Picture Aspect Ratio
         * [3:0] R = 8: Active Frame Aspect Ratio: same as picture aspect ratio
         */
        hdmi_write(hdmi, 0x28, HDMI_CTRL_PKT_BUF_ACCESS_PB2);

        /*
         * ITC = No Data
         * EC = xvYCC601
         * Q = Default (depends on video format)
         * SC = No Known non_uniform Scaling
         */
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB3);

        /*
         * VIC should be ignored if external config is used, so, we could just use 0,
         * but play safe and use a valid value in any case just in case
         */
        if (hdmi->preprogrammed_vic)
                vic = hdmi->preprogrammed_vic;
        else
                vic = 4;
        hdmi_write(hdmi, vic, HDMI_CTRL_PKT_BUF_ACCESS_PB4);

        /* PR = No Repetition */
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB5);

        /* Line Number of End of Top Bar (lower 8 bits) */
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB6);

        /* Line Number of End of Top Bar (upper 8 bits) */
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB7);

        /* Line Number of Start of Bottom Bar (lower 8 bits) */
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB8);

        /* Line Number of Start of Bottom Bar (upper 8 bits) */
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB9);

        /* Pixel Number of End of Left Bar (lower 8 bits) */
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB10);

        /* Pixel Number of End of Left Bar (upper 8 bits) */
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB11);

        /* Pixel Number of Start of Right Bar (lower 8 bits) */
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB12);

        /* Pixel Number of Start of Right Bar (upper 8 bits) */
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB13);
}

/**
 * sh_hdmi_audio_infoframe_setup() - Audio InfoFrame of CONTROL PACKET
 */
static void sh_hdmi_audio_infoframe_setup(struct sh_hdmi *hdmi)
{
        /* Audio InfoFrame */
        hdmi_write(hdmi, 0x08, HDMI_CTRL_PKT_BUF_INDEX);

        /* Packet Type = 0x84 */
        hdmi_write(hdmi, 0x84, HDMI_CTRL_PKT_BUF_ACCESS_HB0);

        /* Version Number = 0x01 */
        hdmi_write(hdmi, 0x01, HDMI_CTRL_PKT_BUF_ACCESS_HB1);

        /* 0 Length = 10 (0x0A) */
        hdmi_write(hdmi, 0x0A, HDMI_CTRL_PKT_BUF_ACCESS_HB2);

        /* n. a. Checksum */
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB0);

        /* Audio Channel Count = Refer to Stream Header */
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB1);

        /* Refer to Stream Header */
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB2);

        /* Format depends on coding type (i.e. CT0...CT3) */
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB3);

        /* Speaker Channel Allocation = Front Right + Front Left */
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB4);

        /* Level Shift Value = 0 dB, Down - mix is permitted or no information */
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB5);

        /* Reserved (0) */
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB6);
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB7);
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB8);
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB9);
        hdmi_write(hdmi, 0x00, HDMI_CTRL_PKT_BUF_ACCESS_PB10);
}

/**
 * sh_hdmi_configure() - Initialise HDMI for output
 */
static void sh_hdmi_configure(struct sh_hdmi *hdmi)
{
        /* Configure video format */
        sh_hdmi_video_config(hdmi);

        /* Configure audio format */
        sh_hdmi_audio_config(hdmi);

        /* Configure PHY */
        sh_hdmi_phy_config(hdmi);

        /* Auxiliary Video Information (AVI) InfoFrame */
        sh_hdmi_avi_infoframe_setup(hdmi);

        /* Audio InfoFrame */
        sh_hdmi_audio_infoframe_setup(hdmi);

        /*
         * Control packet auto send with VSYNC control: auto send
         * General control, Gamut metadata, ISRC, and ACP packets
         */
        hdmi_write(hdmi, 0x8E, HDMI_CTRL_PKT_AUTO_SEND);

        /* FIXME */
        msleep(10);

        /* PS mode b->d, reset PLLA and PLLB */
        hdmi_write(hdmi, 0x4C, HDMI_SYSTEM_CTRL);

        udelay(10);

        hdmi_write(hdmi, 0x40, HDMI_SYSTEM_CTRL);
}

static unsigned long sh_hdmi_rate_error(struct sh_hdmi *hdmi,
                const struct fb_videomode *mode,
                unsigned long *hdmi_rate, unsigned long *parent_rate)
{
        unsigned long target = PICOS2KHZ(mode->pixclock) * 1000, rate_error;
        struct sh_mobile_hdmi_info *pdata = hdmi->dev->platform_data;

        *hdmi_rate = clk_round_rate(hdmi->hdmi_clk, target);
        if ((long)*hdmi_rate < 0)
                *hdmi_rate = clk_get_rate(hdmi->hdmi_clk);

        rate_error = (long)*hdmi_rate > 0 ? abs(*hdmi_rate - target) : ULONG_MAX;
        if (rate_error && pdata->clk_optimize_parent)
                rate_error = pdata->clk_optimize_parent(target, hdmi_rate, parent_rate);
        else if (clk_get_parent(hdmi->hdmi_clk))
                *parent_rate = clk_get_rate(clk_get_parent(hdmi->hdmi_clk));

        dev_dbg(hdmi->dev, "%u-%u-%u-%u x %u-%u-%u-%u\n",
                mode->left_margin, mode->xres,
                mode->right_margin, mode->hsync_len,
                mode->upper_margin, mode->yres,
                mode->lower_margin, mode->vsync_len);

        dev_dbg(hdmi->dev, "\t@%lu(+/-%lu)Hz, e=%lu / 1000, r=%uHz, p=%luHz\n", target,
                rate_error, rate_error ? 10000 / (10 * target / rate_error) : 0,
                mode->refresh, *parent_rate);

        return rate_error;
}

static int sh_hdmi_read_edid(struct sh_hdmi *hdmi, unsigned long *hdmi_rate,
                             unsigned long *parent_rate)
{
        struct fb_var_screeninfo tmpvar;
        struct fb_var_screeninfo *var = &tmpvar;
        const struct fb_videomode *mode, *found = NULL;
        struct fb_info *info = hdmi->info;
        struct fb_modelist *modelist = NULL;
        unsigned int f_width = 0, f_height = 0, f_refresh = 0;
        unsigned long found_rate_error = ULONG_MAX; /* silly compiler... */
        bool scanning = false, preferred_bad = false;
        u8 edid[128];
        char *forced;
        int i;

        /* Read EDID */
        dev_dbg(hdmi->dev, "Read back EDID code:");
        for (i = 0; i < 128; i++) {
                edid[i] = hdmi_read(hdmi, HDMI_EDID_KSV_FIFO_ACCESS_WINDOW);
#ifdef DEBUG
                if ((i % 16) == 0) {
                        printk(KERN_CONT "\n");
                        printk(KERN_DEBUG "%02X | %02X", i, edid[i]);
                } else {
                        printk(KERN_CONT " %02X", edid[i]);
                }
#endif
        }
#ifdef DEBUG
        printk(KERN_CONT "\n");
#endif

        if (!hdmi->edid_blocks) {
                fb_edid_to_monspecs(edid, &hdmi->monspec);
                hdmi->edid_blocks = edid[126] + 1;

                dev_dbg(hdmi->dev, "%d main modes, %d extension blocks\n",
                        hdmi->monspec.modedb_len, hdmi->edid_blocks - 1);
        } else {
                dev_dbg(hdmi->dev, "Extension %u detected, DTD start %u\n",
                        edid[0], edid[2]);
                fb_edid_add_monspecs(edid, &hdmi->monspec);
        }

        if (hdmi->edid_blocks > hdmi->edid_segment_nr * 2 +
            (hdmi->edid_block_addr >> 7) + 1) {
                /* More blocks to read */
                if (hdmi->edid_block_addr) {
                        hdmi->edid_block_addr = 0;
                        hdmi->edid_segment_nr++;
                } else {
                        hdmi->edid_block_addr = 0x80;
                }
                /* Set EDID word address  */
                hdmi_write(hdmi, hdmi->edid_block_addr, HDMI_EDID_WORD_ADDRESS);
                /* Enable EDID interrupt */
                hdmi_write(hdmi, 0xC6, HDMI_INTERRUPT_MASK_1);
                /* Set EDID segment pointer - starts reading EDID */
                hdmi_write(hdmi, hdmi->edid_segment_nr, HDMI_EDID_SEGMENT_POINTER);
                return -EAGAIN;
        }

        /* All E-EDID blocks ready */
        dev_dbg(hdmi->dev, "%d main and extended modes\n", hdmi->monspec.modedb_len);

        fb_get_options("sh_mobile_lcdc", &forced);
        if (forced && *forced) {
                /* Only primitive parsing so far */
                i = sscanf(forced, "%ux%u@%u",
                           &f_width, &f_height, &f_refresh);
                if (i < 2) {
                        f_width = 0;
                        f_height = 0;
                } else {
                        /* The user wants us to use the EDID data */
                        scanning = true;
                }
                dev_dbg(hdmi->dev, "Forced mode %ux%u@%uHz\n",
                        f_width, f_height, f_refresh);
        }

        /* Walk monitor modes to find the best or the exact match */
        for (i = 0, mode = hdmi->monspec.modedb;
             i < hdmi->monspec.modedb_len && scanning;
             i++, mode++) {
                unsigned long rate_error;

                if (!f_width && !f_height) {
                        /*
                         * A parameter string "video=sh_mobile_lcdc:0x0" means
                         * use the preferred EDID mode. If it is rejected by
                         * .fb_check_var(), keep looking, until an acceptable
                         * one is found.
                         */
                        if ((mode->flag & FB_MODE_IS_FIRST) || preferred_bad)
                                scanning = false;
                        else
                                continue;
                } else if (f_width != mode->xres || f_height != mode->yres) {
                        /* No interest in unmatching modes */
                        continue;
                }

                rate_error = sh_hdmi_rate_error(hdmi, mode, hdmi_rate, parent_rate);

                if (scanning) {
                        if (f_refresh == mode->refresh || (!f_refresh && !rate_error))
                                /*
                                 * Exact match if either the refresh rate
                                 * matches or it hasn't been specified and we've
                                 * found a mode, for which we can configure the
                                 * clock precisely
                                 */
                                scanning = false;
                        else if (found && found_rate_error <= rate_error)
                                /*
                                 * We otherwise search for the closest matching
                                 * clock rate - either if no refresh rate has
                                 * been specified or we cannot find an exactly
                                 * matching one
                                 */
                                continue;
                }

                /* Check if supported: sufficient fb memory, supported clock-rate */
                fb_videomode_to_var(var, mode);

                var->bits_per_pixel = info->var.bits_per_pixel;

                if (info && info->fbops->fb_check_var &&
                    info->fbops->fb_check_var(var, info)) {
                        scanning = true;
                        preferred_bad = true;
                        continue;
                }

                found = mode;
                found_rate_error = rate_error;
        }

        hdmi->var.width = hdmi->monspec.max_x * 10;
        hdmi->var.height = hdmi->monspec.max_y * 10;

        /*
         * TODO 1: if no ->info is present, postpone running the config until
         * after ->info first gets registered.
         * TODO 2: consider registering the HDMI platform device from the LCDC
         * driver, and passing ->info with HDMI platform data.
         */
        if (info && !found) {
                modelist = info->modelist.next &&
                        !list_empty(&info->modelist) ?
                        list_entry(info->modelist.next,
                                   struct fb_modelist, list) :
                        NULL;

                if (modelist) {
                        found = &modelist->mode;
                        found_rate_error = sh_hdmi_rate_error(hdmi, found, hdmi_rate, parent_rate);
                }
        }

        /* No cookie today */
        if (!found)
                return -ENXIO;

        if (found->xres == 640 && found->yres == 480 && found->refresh == 60)
                hdmi->preprogrammed_vic = 1;
        else if (found->xres == 720 && found->yres == 480 && found->refresh == 60)
                hdmi->preprogrammed_vic = 2;
        else if (found->xres == 720 && found->yres == 576 && found->refresh == 50)
                hdmi->preprogrammed_vic = 17;
        else if (found->xres == 1280 && found->yres == 720 && found->refresh == 60)
                hdmi->preprogrammed_vic = 4;
        else if (found->xres == 1920 && found->yres == 1080 && found->refresh == 24)
                hdmi->preprogrammed_vic = 32;
        else if (found->xres == 1920 && found->yres == 1080 && found->refresh == 50)
                hdmi->preprogrammed_vic = 31;
        else if (found->xres == 1920 && found->yres == 1080 && found->refresh == 60)
                hdmi->preprogrammed_vic = 16;
        else
                hdmi->preprogrammed_vic = 0;

        dev_dbg(hdmi->dev, "Using %s %s mode %ux%u@%uHz (%luHz), clock error %luHz\n",
                modelist ? "default" : "EDID", hdmi->preprogrammed_vic ? "VIC" : "external",
                found->xres, found->yres, found->refresh,
                PICOS2KHZ(found->pixclock) * 1000, found_rate_error);

        fb_videomode_to_var(&hdmi->var, found);
        sh_hdmi_external_video_param(hdmi);

        return 0;
}

static irqreturn_t sh_hdmi_hotplug(int irq, void *dev_id)
{
        struct sh_hdmi *hdmi = dev_id;
        u8 status1, status2, mask1, mask2;

        /* mode_b and PLLA and PLLB reset */
        hdmi_write(hdmi, 0x2C, HDMI_SYSTEM_CTRL);

        /* How long shall reset be held? */
        udelay(10);

        /* mode_b and PLLA and PLLB reset release */
        hdmi_write(hdmi, 0x20, HDMI_SYSTEM_CTRL);

        status1 = hdmi_read(hdmi, HDMI_INTERRUPT_STATUS_1);
        status2 = hdmi_read(hdmi, HDMI_INTERRUPT_STATUS_2);

        mask1 = hdmi_read(hdmi, HDMI_INTERRUPT_MASK_1);
        mask2 = hdmi_read(hdmi, HDMI_INTERRUPT_MASK_2);

        /* Correct would be to ack only set bits, but the datasheet requires 0xff */
        hdmi_write(hdmi, 0xFF, HDMI_INTERRUPT_STATUS_1);
        hdmi_write(hdmi, 0xFF, HDMI_INTERRUPT_STATUS_2);

        if (printk_ratelimit())
                dev_dbg(hdmi->dev, "IRQ #%d: Status #1: 0x%x & 0x%x, #2: 0x%x & 0x%x\n",
                        irq, status1, mask1, status2, mask2);

        if (!((status1 & mask1) | (status2 & mask2))) {
                return IRQ_NONE;
        } else if (status1 & 0xc0) {
                u8 msens;

                /* Datasheet specifies 10ms... */
                udelay(500);

                msens = hdmi_read(hdmi, HDMI_HOT_PLUG_MSENS_STATUS);
                dev_dbg(hdmi->dev, "MSENS 0x%x\n", msens);
                /* Check, if hot plug & MSENS pin status are both high */
                if ((msens & 0xC0) == 0xC0) {
                        /* Display plug in */
                        hdmi->edid_segment_nr = 0;
                        hdmi->edid_block_addr = 0;
                        hdmi->edid_blocks = 0;
                        hdmi->hp_state = HDMI_HOTPLUG_CONNECTED;

                        /* Set EDID word address  */
                        hdmi_write(hdmi, 0x00, HDMI_EDID_WORD_ADDRESS);
                        /* Enable EDID interrupt */
                        hdmi_write(hdmi, 0xC6, HDMI_INTERRUPT_MASK_1);
                        /* Set EDID segment pointer - starts reading EDID */
                        hdmi_write(hdmi, 0x00, HDMI_EDID_SEGMENT_POINTER);
                } else if (!(status1 & 0x80)) {
                        /* Display unplug, beware multiple interrupts */
                        if (hdmi->hp_state != HDMI_HOTPLUG_DISCONNECTED) {
                                hdmi->hp_state = HDMI_HOTPLUG_DISCONNECTED;
                                schedule_delayed_work(&hdmi->edid_work, 0);
                        }
                        /* display_off will switch back to mode_a */
                }
        } else if (status1 & 2) {
                /* EDID error interrupt: retry */
                /* Set EDID word address  */
                hdmi_write(hdmi, hdmi->edid_block_addr, HDMI_EDID_WORD_ADDRESS);
                /* Set EDID segment pointer */
                hdmi_write(hdmi, hdmi->edid_segment_nr, HDMI_EDID_SEGMENT_POINTER);
        } else if (status1 & 4) {
                /* Disable EDID interrupt */
                hdmi_write(hdmi, 0xC0, HDMI_INTERRUPT_MASK_1);
                schedule_delayed_work(&hdmi->edid_work, msecs_to_jiffies(10));
        }

        return IRQ_HANDLED;
}

/* locking:     called with info->lock held, or before register_framebuffer() */
static void sh_hdmi_display_on(void *arg, struct fb_info *info)
{
        /*
         * info is guaranteed to be valid, when we are called, because our
         * FB_EVENT_FB_UNBIND notify is also called with info->lock held
         */
        struct sh_hdmi *hdmi = arg;
        struct sh_mobile_hdmi_info *pdata = hdmi->dev->platform_data;
        struct sh_mobile_lcdc_chan *ch = info->par;

        dev_dbg(hdmi->dev, "%s(%p): state %x\n", __func__,
                pdata->lcd_dev, info->state);

        /* No need to lock */
        hdmi->info = info;

        /*
         * hp_state can be set to
         * HDMI_HOTPLUG_DISCONNECTED:   on monitor unplug
         * HDMI_HOTPLUG_CONNECTED:      on monitor plug-in
         * HDMI_HOTPLUG_EDID_DONE:      on EDID read completion
         */
        switch (hdmi->hp_state) {
        case HDMI_HOTPLUG_EDID_DONE:
                /* PS mode d->e. All functions are active */
                hdmi_write(hdmi, 0x80, HDMI_SYSTEM_CTRL);
                dev_dbg(hdmi->dev, "HDMI running\n");
                break;
        case HDMI_HOTPLUG_DISCONNECTED:
                info->state = FBINFO_STATE_SUSPENDED;
        default:
                hdmi->var = ch->display_var;
        }
}

/* locking: called with info->lock held */
static void sh_hdmi_display_off(void *arg)
{
        struct sh_hdmi *hdmi = arg;
        struct sh_mobile_hdmi_info *pdata = hdmi->dev->platform_data;

        dev_dbg(hdmi->dev, "%s(%p)\n", __func__, pdata->lcd_dev);
        /* PS mode e->a */
        hdmi_write(hdmi, 0x10, HDMI_SYSTEM_CTRL);
}

static bool sh_hdmi_must_reconfigure(struct sh_hdmi *hdmi)
{
        struct fb_info *info = hdmi->info;
        struct sh_mobile_lcdc_chan *ch = info->par;
        struct fb_var_screeninfo *new_var = &hdmi->var, *old_var = &ch->display_var;
        struct fb_videomode mode1, mode2;

        fb_var_to_videomode(&mode1, old_var);
        fb_var_to_videomode(&mode2, new_var);

        dev_dbg(info->dev, "Old %ux%u, new %ux%u\n",
                mode1.xres, mode1.yres, mode2.xres, mode2.yres);

        if (fb_mode_is_equal(&mode1, &mode2)) {
                /* It can be a different monitor with an equal video-mode */
                old_var->width = new_var->width;
                old_var->height = new_var->height;
                return false;
        }

        dev_dbg(info->dev, "Switching %u -> %u lines\n",
                mode1.yres, mode2.yres);
        *old_var = *new_var;

        return true;
}

/**
 * sh_hdmi_clk_configure() - set HDMI clock frequency and enable the clock
 * @hdmi:               driver context
 * @hdmi_rate:          HDMI clock frequency in Hz
 * @parent_rate:        if != 0 - set parent clock rate for optimal precision
 * return:              configured positive rate if successful
 *                      0 if couldn't set the rate, but managed to enable the
 *                      clock, negative error, if couldn't enable the clock
 */
static long sh_hdmi_clk_configure(struct sh_hdmi *hdmi, unsigned long hdmi_rate,
                                  unsigned long parent_rate)
{
        int ret;

        if (parent_rate && clk_get_parent(hdmi->hdmi_clk)) {
                ret = clk_set_rate(clk_get_parent(hdmi->hdmi_clk), parent_rate);
                if (ret < 0) {
                        dev_warn(hdmi->dev, "Cannot set parent rate %ld: %d\n", parent_rate, ret);
                        hdmi_rate = clk_round_rate(hdmi->hdmi_clk, hdmi_rate);
                } else {
                        dev_dbg(hdmi->dev, "HDMI set parent frequency %lu\n", parent_rate);
                }
        }

        ret = clk_set_rate(hdmi->hdmi_clk, hdmi_rate);
        if (ret < 0) {
                dev_warn(hdmi->dev, "Cannot set rate %ld: %d\n", hdmi_rate, ret);
                hdmi_rate = 0;
        } else {
                dev_dbg(hdmi->dev, "HDMI set frequency %lu\n", hdmi_rate);
        }

        return hdmi_rate;
}

/* Hotplug interrupt occurred, read EDID */
static void sh_hdmi_edid_work_fn(struct work_struct *work)
{
        struct sh_hdmi *hdmi = container_of(work, struct sh_hdmi, edid_work.work);
        struct sh_mobile_hdmi_info *pdata = hdmi->dev->platform_data;
        struct sh_mobile_lcdc_chan *ch;
        int ret;

        dev_dbg(hdmi->dev, "%s(%p): begin, hotplug status %d\n", __func__,
                pdata->lcd_dev, hdmi->hp_state);

        if (!pdata->lcd_dev)
                return;

        mutex_lock(&hdmi->mutex);

        if (hdmi->hp_state == HDMI_HOTPLUG_CONNECTED) {
                struct fb_info *info = hdmi->info;
                unsigned long parent_rate = 0, hdmi_rate;

                /* A device has been plugged in */
                pm_runtime_get_sync(hdmi->dev);

                ret = sh_hdmi_read_edid(hdmi, &hdmi_rate, &parent_rate);
                if (ret < 0)
                        goto out;

                hdmi->hp_state = HDMI_HOTPLUG_EDID_DONE;

                /* Reconfigure the clock */
                ret = sh_hdmi_clk_configure(hdmi, hdmi_rate, parent_rate);
                if (ret < 0)
                        goto out;

                msleep(10);
                sh_hdmi_configure(hdmi);
                /* Switched to another (d) power-save mode */
                msleep(10);

                if (!info)
                        goto out;

                ch = info->par;

                console_lock();

                /* HDMI plug in */
                if (!sh_hdmi_must_reconfigure(hdmi) &&
                    info->state == FBINFO_STATE_RUNNING) {
                        /*
                         * First activation with the default monitor - just turn
                         * on, if we run a resume here, the logo disappears
                         */
                        if (lock_fb_info(info)) {
                                info->var.width = hdmi->var.width;
                                info->var.height = hdmi->var.height;
                                sh_hdmi_display_on(hdmi, info);
                                unlock_fb_info(info);
                        }
                } else {
                        /* New monitor or have to wake up */
                        fb_set_suspend(info, 0);
                }

                console_unlock();
        } else {
                ret = 0;
                if (!hdmi->info)
                        goto out;

                hdmi->monspec.modedb_len = 0;
                fb_destroy_modedb(hdmi->monspec.modedb);
                hdmi->monspec.modedb = NULL;

                console_lock();

                /* HDMI disconnect */
                fb_set_suspend(hdmi->info, 1);

                console_unlock();
                pm_runtime_put(hdmi->dev);
        }

out:
        if (ret < 0 && ret != -EAGAIN)
                hdmi->hp_state = HDMI_HOTPLUG_DISCONNECTED;
        mutex_unlock(&hdmi->mutex);

        dev_dbg(hdmi->dev, "%s(%p): end\n", __func__, pdata->lcd_dev);
}

static int sh_hdmi_notify(struct notifier_block *nb,
                          unsigned long action, void *data)
{
        struct fb_event *event = data;
        struct fb_info *info = event->info;
        struct sh_mobile_lcdc_chan *ch = info->par;
        struct sh_mobile_lcdc_board_cfg *board_cfg = &ch->cfg.board_cfg;
        struct sh_hdmi *hdmi = board_cfg->board_data;

        if (!hdmi || nb != &hdmi->notifier || hdmi->info != info)
                return NOTIFY_DONE;

        switch(action) {
        case FB_EVENT_FB_REGISTERED:
                /* Unneeded, activation taken care by sh_hdmi_display_on() */
                break;
        case FB_EVENT_FB_UNREGISTERED:
                /*
                 * We are called from unregister_framebuffer() with the
                 * info->lock held. This is bad for us, because we can race with
                 * the scheduled work, which has to call fb_set_suspend(), which
                 * takes info->lock internally, so, sh_hdmi_edid_work_fn()
                 * cannot take and hold info->lock for the whole function
                 * duration. Using an additional lock creates a classical AB-BA
                 * lock up. Therefore, we have to release the info->lock
                 * temporarily, synchronise with the work queue and re-acquire
                 * the info->lock.
                 */
                unlock_fb_info(info);
                mutex_lock(&hdmi->mutex);
                hdmi->info = NULL;
                mutex_unlock(&hdmi->mutex);
                lock_fb_info(info);
                return NOTIFY_OK;
        }
        return NOTIFY_DONE;
}

static int __init sh_hdmi_probe(struct platform_device *pdev)
{
        struct sh_mobile_hdmi_info *pdata = pdev->dev.platform_data;
        struct resource *res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
        struct sh_mobile_lcdc_board_cfg *board_cfg;
        int irq = platform_get_irq(pdev, 0), ret;
        struct sh_hdmi *hdmi;
        long rate;

        if (!res || !pdata || irq < 0)
                return -ENODEV;

        hdmi = kzalloc(sizeof(*hdmi), GFP_KERNEL);
        if (!hdmi) {
                dev_err(&pdev->dev, "Cannot allocate device data\n");
                return -ENOMEM;
        }

        mutex_init(&hdmi->mutex);

        hdmi->dev = &pdev->dev;

        hdmi->hdmi_clk = clk_get(&pdev->dev, "ick");
        if (IS_ERR(hdmi->hdmi_clk)) {
                ret = PTR_ERR(hdmi->hdmi_clk);
                dev_err(&pdev->dev, "Unable to get clock: %d\n", ret);
                goto egetclk;
        }

        /* An arbitrary relaxed pixclock just to get things started: from standard 480p */
        rate = clk_round_rate(hdmi->hdmi_clk, PICOS2KHZ(37037));
        if (rate > 0)
                rate = sh_hdmi_clk_configure(hdmi, rate, 0);

        if (rate < 0) {
                ret = rate;
                goto erate;
        }

        ret = clk_enable(hdmi->hdmi_clk);
        if (ret < 0) {
                dev_err(hdmi->dev, "Cannot enable clock: %d\n", ret);
                goto erate;
        }

        dev_dbg(&pdev->dev, "Enabled HDMI clock at %luHz\n", rate);

        if (!request_mem_region(res->start, resource_size(res), dev_name(&pdev->dev))) {
                dev_err(&pdev->dev, "HDMI register region already claimed\n");
                ret = -EBUSY;
                goto ereqreg;
        }

        hdmi->base = ioremap(res->start, resource_size(res));
        if (!hdmi->base) {
                dev_err(&pdev->dev, "HDMI register region already claimed\n");
                ret = -ENOMEM;
                goto emap;
        }

        platform_set_drvdata(pdev, hdmi);

        /* Set up LCDC callbacks */
        board_cfg = &pdata->lcd_chan->board_cfg;
        board_cfg->owner = THIS_MODULE;
        board_cfg->board_data = hdmi;
        board_cfg->display_on = sh_hdmi_display_on;
        board_cfg->display_off = sh_hdmi_display_off;

        INIT_DELAYED_WORK(&hdmi->edid_work, sh_hdmi_edid_work_fn);

        pm_runtime_enable(&pdev->dev);
        pm_runtime_resume(&pdev->dev);

        /* Product and revision IDs are 0 in sh-mobile version */
        dev_info(&pdev->dev, "Detected HDMI controller 0x%x:0x%x\n",
                 hdmi_read(hdmi, HDMI_PRODUCT_ID), hdmi_read(hdmi, HDMI_REVISION_ID));

        ret = request_irq(irq, sh_hdmi_hotplug, 0,
                          dev_name(&pdev->dev), hdmi);
        if (ret < 0) {
                dev_err(&pdev->dev, "Unable to request irq: %d\n", ret);
                goto ereqirq;
        }

        ret = snd_soc_register_codec(&pdev->dev,
                        &soc_codec_dev_sh_hdmi, &sh_hdmi_dai, 1);
        if (ret < 0) {
                dev_err(&pdev->dev, "codec registration failed\n");
                goto ecodec;
        }

        hdmi->notifier.notifier_call = sh_hdmi_notify;
        fb_register_client(&hdmi->notifier);

        return 0;

ecodec:
        free_irq(irq, hdmi);
ereqirq:
        pm_runtime_disable(&pdev->dev);
        iounmap(hdmi->base);
emap:
        release_mem_region(res->start, resource_size(res));
ereqreg:
        clk_disable(hdmi->hdmi_clk);
erate:
        clk_put(hdmi->hdmi_clk);
egetclk:
        mutex_destroy(&hdmi->mutex);
        kfree(hdmi);

        return ret;
}

static int __exit sh_hdmi_remove(struct platform_device *pdev)
{
        struct sh_mobile_hdmi_info *pdata = pdev->dev.platform_data;
        struct sh_hdmi *hdmi = platform_get_drvdata(pdev);
        struct resource *res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
        struct sh_mobile_lcdc_board_cfg *board_cfg = &pdata->lcd_chan->board_cfg;
        int irq = platform_get_irq(pdev, 0);

        snd_soc_unregister_codec(&pdev->dev);

        fb_unregister_client(&hdmi->notifier);

        board_cfg->display_on = NULL;
        board_cfg->display_off = NULL;
        board_cfg->board_data = NULL;
        board_cfg->owner = NULL;

        /* No new work will be scheduled, wait for running ISR */
        free_irq(irq, hdmi);
        /* Wait for already scheduled work */
        cancel_delayed_work_sync(&hdmi->edid_work);
        pm_runtime_disable(&pdev->dev);
        clk_disable(hdmi->hdmi_clk);
        clk_put(hdmi->hdmi_clk);
        iounmap(hdmi->base);
        release_mem_region(res->start, resource_size(res));
        mutex_destroy(&hdmi->mutex);
        kfree(hdmi);

        return 0;
}

static struct platform_driver sh_hdmi_driver = {
        .remove         = __exit_p(sh_hdmi_remove),
        .driver = {
                .name   = "sh-mobile-hdmi",
        },
};

static int __init sh_hdmi_init(void)
{
        return platform_driver_probe(&sh_hdmi_driver, sh_hdmi_probe);
}
module_init(sh_hdmi_init);

static void __exit sh_hdmi_exit(void)
{
        platform_driver_unregister(&sh_hdmi_driver);
}
module_exit(sh_hdmi_exit);

MODULE_AUTHOR("Guennadi Liakhovetski <g.liakhovetski@gmx.de>");
MODULE_DESCRIPTION("SuperH / ARM-shmobile HDMI driver");
MODULE_LICENSE("GPL v2");