drivers/gpu/drm/sti/sti_tvout.c - kernel/msm-4.19 - Gitiles

 /*
  * Copyright (C) STMicroelectronics SA 2014
  * Authors: Benjamin Gaignard <benjamin.gaignard@st.com>
  *          Vincent Abriou <vincent.abriou@st.com>
  *          for STMicroelectronics.
  * License terms:  GNU General Public License (GPL), version 2
  */

 #include <linux/clk.h>
 #include <linux/component.h>
 #include <linux/module.h>
 #include <linux/of_platform.h>
 #include <linux/platform_device.h>
 #include <linux/reset.h>

 #include <drm/drmP.h>
 #include <drm/drm_crtc_helper.h>

 /* glue registers */
 #define TVO_CSC_MAIN_M0                  0x000
 #define TVO_CSC_MAIN_M1                  0x004
 #define TVO_CSC_MAIN_M2                  0x008
 #define TVO_CSC_MAIN_M3                  0x00c
 #define TVO_CSC_MAIN_M4                  0x010
 #define TVO_CSC_MAIN_M5                  0x014
 #define TVO_CSC_MAIN_M6                  0x018
 #define TVO_CSC_MAIN_M7                  0x01c
 #define TVO_MAIN_IN_VID_FORMAT           0x030
 #define TVO_CSC_AUX_M0                   0x100
 #define TVO_CSC_AUX_M1                   0x104
 #define TVO_CSC_AUX_M2                   0x108
 #define TVO_CSC_AUX_M3                   0x10c
 #define TVO_CSC_AUX_M4                   0x110
 #define TVO_CSC_AUX_M5                   0x114
 #define TVO_CSC_AUX_M6                   0x118
 #define TVO_CSC_AUX_M7                   0x11c
 #define TVO_AUX_IN_VID_FORMAT            0x130
 #define TVO_VIP_HDF                      0x400
 #define TVO_HD_SYNC_SEL                  0x418
 #define TVO_HD_DAC_CFG_OFF               0x420
 #define TVO_VIP_HDMI                     0x500
 #define TVO_HDMI_FORCE_COLOR_0           0x504
 #define TVO_HDMI_FORCE_COLOR_1           0x508
 #define TVO_HDMI_CLIP_VALUE_B_CB         0x50c
 #define TVO_HDMI_CLIP_VALUE_Y_G          0x510
 #define TVO_HDMI_CLIP_VALUE_R_CR         0x514
 #define TVO_HDMI_SYNC_SEL                0x518
 #define TVO_HDMI_DFV_OBS                 0x540

 #define TVO_IN_FMT_SIGNED                BIT(0)
 #define TVO_SYNC_EXT                     BIT(4)

 #define TVO_VIP_REORDER_R_SHIFT          24
 #define TVO_VIP_REORDER_G_SHIFT          20
 #define TVO_VIP_REORDER_B_SHIFT          16
 #define TVO_VIP_REORDER_MASK             0x3
 #define TVO_VIP_REORDER_Y_G_SEL          0
 #define TVO_VIP_REORDER_CB_B_SEL         1
 #define TVO_VIP_REORDER_CR_R_SEL         2

 #define TVO_VIP_CLIP_SHIFT               8
 #define TVO_VIP_CLIP_MASK                0x7
 #define TVO_VIP_CLIP_DISABLED            0
 #define TVO_VIP_CLIP_EAV_SAV             1
 #define TVO_VIP_CLIP_LIMITED_RANGE_RGB_Y 2
 #define TVO_VIP_CLIP_LIMITED_RANGE_CB_CR 3
 #define TVO_VIP_CLIP_PROG_RANGE          4

 #define TVO_VIP_RND_SHIFT                4
 #define TVO_VIP_RND_MASK                 0x3
 #define TVO_VIP_RND_8BIT_ROUNDED         0
 #define TVO_VIP_RND_10BIT_ROUNDED        1
 #define TVO_VIP_RND_12BIT_ROUNDED        2

 #define TVO_VIP_SEL_INPUT_MASK           0xf
 #define TVO_VIP_SEL_INPUT_MAIN           0x0
 #define TVO_VIP_SEL_INPUT_AUX            0x8
 #define TVO_VIP_SEL_INPUT_FORCE_COLOR    0xf
 #define TVO_VIP_SEL_INPUT_BYPASS_MASK    0x1
 #define TVO_VIP_SEL_INPUT_BYPASSED       1

 #define TVO_SYNC_MAIN_VTG_SET_REF        0x00
 #define TVO_SYNC_MAIN_VTG_SET_1          0x01
 #define TVO_SYNC_MAIN_VTG_SET_2          0x02
 #define TVO_SYNC_MAIN_VTG_SET_3          0x03
 #define TVO_SYNC_MAIN_VTG_SET_4          0x04
 #define TVO_SYNC_MAIN_VTG_SET_5          0x05
 #define TVO_SYNC_MAIN_VTG_SET_6          0x06
 #define TVO_SYNC_AUX_VTG_SET_REF         0x10
 #define TVO_SYNC_AUX_VTG_SET_1           0x11
 #define TVO_SYNC_AUX_VTG_SET_2           0x12
 #define TVO_SYNC_AUX_VTG_SET_3           0x13
 #define TVO_SYNC_AUX_VTG_SET_4           0x14
 #define TVO_SYNC_AUX_VTG_SET_5           0x15
 #define TVO_SYNC_AUX_VTG_SET_6           0x16

 #define TVO_SYNC_HD_DCS_SHIFT            8

 #define ENCODER_MAIN_CRTC_MASK           BIT(0)

 /* enum listing the supported output data format */
 enum sti_tvout_video_out_type {
 	STI_TVOUT_VIDEO_OUT_RGB,
 	STI_TVOUT_VIDEO_OUT_YUV,
 };

 struct sti_tvout {
 	struct device *dev;
 	struct drm_device *drm_dev;
 	void __iomem *regs;
 	struct reset_control *reset;
 	struct drm_encoder *hdmi;
 	struct drm_encoder *hda;
 };

 struct sti_tvout_encoder {
 	struct drm_encoder encoder;
 	struct sti_tvout *tvout;
 };

 #define to_sti_tvout_encoder(x) \
 	container_of(x, struct sti_tvout_encoder, encoder)

 #define to_sti_tvout(x) to_sti_tvout_encoder(x)->tvout

 /* preformatter conversion matrix */
 static const u32 rgb_to_ycbcr_601[8] = {
 	0xF927082E, 0x04C9FEAB, 0x01D30964, 0xFA95FD3D,
 	0x0000082E, 0x00002000, 0x00002000, 0x00000000
 };

 /* 709 RGB to YCbCr */
 static const u32 rgb_to_ycbcr_709[8] = {
 	0xF891082F, 0x0367FF40, 0x01280B71, 0xF9B1FE20,
 	0x0000082F, 0x00002000, 0x00002000, 0x00000000
 };

 static u32 tvout_read(struct sti_tvout *tvout, int offset)
 {
 	return readl(tvout->regs + offset);
 }

 static void tvout_write(struct sti_tvout *tvout, u32 val, int offset)
 {
 	writel(val, tvout->regs + offset);
 }

 /**
  * Set the clipping mode of a VIP
  *
  * @tvout: tvout structure
  * @cr_r:
  * @y_g:
  * @cb_b:
  */
 static void tvout_vip_set_color_order(struct sti_tvout *tvout,
 				      u32 cr_r, u32 y_g, u32 cb_b)
 {
 	u32 val = tvout_read(tvout, TVO_VIP_HDMI);

 	val &= ~(TVO_VIP_REORDER_MASK << TVO_VIP_REORDER_R_SHIFT);
 	val &= ~(TVO_VIP_REORDER_MASK << TVO_VIP_REORDER_G_SHIFT);
 	val &= ~(TVO_VIP_REORDER_MASK << TVO_VIP_REORDER_B_SHIFT);
 	val |= cr_r << TVO_VIP_REORDER_R_SHIFT;
 	val |= y_g << TVO_VIP_REORDER_G_SHIFT;
 	val |= cb_b << TVO_VIP_REORDER_B_SHIFT;

 	tvout_write(tvout, val, TVO_VIP_HDMI);
 }

 /**
  * Set the clipping mode of a VIP
  *
  * @tvout: tvout structure
  * @range: clipping range
  */
 static void tvout_vip_set_clip_mode(struct sti_tvout *tvout, u32 range)
 {
 	u32 val = tvout_read(tvout, TVO_VIP_HDMI);

 	val &= ~(TVO_VIP_CLIP_MASK << TVO_VIP_CLIP_SHIFT);
 	val |= range << TVO_VIP_CLIP_SHIFT;
 	tvout_write(tvout, val, TVO_VIP_HDMI);
 }

 /**
  * Set the rounded value of a VIP
  *
  * @tvout: tvout structure
  * @rnd: rounded val per component
  */
 static void tvout_vip_set_rnd(struct sti_tvout *tvout, u32 rnd)
 {
 	u32 val = tvout_read(tvout, TVO_VIP_HDMI);

 	val &= ~(TVO_VIP_RND_MASK << TVO_VIP_RND_SHIFT);
 	val |= rnd << TVO_VIP_RND_SHIFT;
 	tvout_write(tvout, val, TVO_VIP_HDMI);
 }

 /**
  * Select the VIP input
  *
  * @tvout: tvout structure
  * @sel_input: selected_input (main/aux + conv)
  */
 static void tvout_vip_set_sel_input(struct sti_tvout *tvout,
 				    bool main_path,
 				    bool sel_input_logic_inverted,
 				    enum sti_tvout_video_out_type video_out)
 {
 	u32 sel_input;
 	u32 val = tvout_read(tvout, TVO_VIP_HDMI);

 	if (main_path)
 		sel_input = TVO_VIP_SEL_INPUT_MAIN;
 	else
 		sel_input = TVO_VIP_SEL_INPUT_AUX;

 	switch (video_out) {
 	case STI_TVOUT_VIDEO_OUT_RGB:
 		sel_input |= TVO_VIP_SEL_INPUT_BYPASSED;
 		break;
 	case STI_TVOUT_VIDEO_OUT_YUV:
 		sel_input &= ~TVO_VIP_SEL_INPUT_BYPASSED;
 		break;
 	}

 	/* on stih407 chip the sel_input bypass mode logic is inverted */
 	if (sel_input_logic_inverted)
 		sel_input = sel_input ^ TVO_VIP_SEL_INPUT_BYPASS_MASK;

 	val &= ~TVO_VIP_SEL_INPUT_MASK;
 	val |= sel_input;
 	tvout_write(tvout, val, TVO_VIP_HDMI);
 }

 /**
  * Select the input video signed or unsigned
  *
  * @tvout: tvout structure
  * @in_vid_signed: used video input format
  */
 static void tvout_vip_set_in_vid_fmt(struct sti_tvout *tvout, u32 in_vid_fmt)
 {
 	u32 val = tvout_read(tvout, TVO_VIP_HDMI);

 	val &= ~TVO_IN_FMT_SIGNED;
 	val |= in_vid_fmt;
 	tvout_write(tvout, val, TVO_MAIN_IN_VID_FORMAT);
 }

 /**
  * Start VIP block for HDMI output
  *
  * @tvout: pointer on tvout structure
  * @main_path: true if main path has to be used in the vip configuration
  *	  else aux path is used.
  */
 static void tvout_hdmi_start(struct sti_tvout *tvout, bool main_path)
 {
 	struct device_node *node = tvout->dev->of_node;
 	bool sel_input_logic_inverted = false;

 	dev_dbg(tvout->dev, "%s\n", __func__);

 	if (main_path) {
 		DRM_DEBUG_DRIVER("main vip for hdmi\n");
 		/* select the input sync for hdmi = VTG set 1 */
 		tvout_write(tvout, TVO_SYNC_MAIN_VTG_SET_1, TVO_HDMI_SYNC_SEL);
 	} else {
 		DRM_DEBUG_DRIVER("aux vip for hdmi\n");
 		/* select the input sync for hdmi = VTG set 1 */
 		tvout_write(tvout, TVO_SYNC_AUX_VTG_SET_1, TVO_HDMI_SYNC_SEL);
 	}

 	/* set color channel order */
 	tvout_vip_set_color_order(tvout,
 				  TVO_VIP_REORDER_CR_R_SEL,
 				  TVO_VIP_REORDER_Y_G_SEL,
 				  TVO_VIP_REORDER_CB_B_SEL);

 	/* set clipping mode (Limited range RGB/Y) */
 	tvout_vip_set_clip_mode(tvout, TVO_VIP_CLIP_LIMITED_RANGE_RGB_Y);

 	/* set round mode (rounded to 8-bit per component) */
 	tvout_vip_set_rnd(tvout, TVO_VIP_RND_8BIT_ROUNDED);

 	if (of_device_is_compatible(node, "st,stih407-tvout")) {
 		/* set input video format */
 		tvout_vip_set_in_vid_fmt(tvout->regs + TVO_MAIN_IN_VID_FORMAT,
 					 TVO_IN_FMT_SIGNED);
 		sel_input_logic_inverted = true;
 	}

 	/* input selection */
 	tvout_vip_set_sel_input(tvout, main_path,
 			sel_input_logic_inverted, STI_TVOUT_VIDEO_OUT_RGB);
 }

 /**
  * Start HDF VIP and HD DAC
  *
  * @tvout: pointer on tvout structure
  * @main_path: true if main path has to be used in the vip configuration
  *	  else aux path is used.
  */
 static void tvout_hda_start(struct sti_tvout *tvout, bool main_path)
 {
 	struct device_node *node = tvout->dev->of_node;
 	bool sel_input_logic_inverted = false;

 	dev_dbg(tvout->dev, "%s\n", __func__);

 	if (!main_path) {
 		DRM_ERROR("HD Analog on aux not implemented\n");
 		return;
 	}

 	DRM_DEBUG_DRIVER("main vip for HDF\n");

 	/* set color channel order */
 	tvout_vip_set_color_order(tvout->regs + TVO_VIP_HDF,
 				  TVO_VIP_REORDER_CR_R_SEL,
 				  TVO_VIP_REORDER_Y_G_SEL,
 				  TVO_VIP_REORDER_CB_B_SEL);

 	/* set clipping mode (Limited range RGB/Y) */
 	tvout_vip_set_clip_mode(tvout->regs + TVO_VIP_HDF,
 				TVO_VIP_CLIP_LIMITED_RANGE_CB_CR);

 	/* set round mode (rounded to 10-bit per component) */
 	tvout_vip_set_rnd(tvout->regs + TVO_VIP_HDF, TVO_VIP_RND_10BIT_ROUNDED);

 	if (of_device_is_compatible(node, "st,stih407-tvout")) {
 		/* set input video format */
 		tvout_vip_set_in_vid_fmt(tvout, TVO_IN_FMT_SIGNED);
 		sel_input_logic_inverted = true;
 	}

 	/* Input selection */
 	tvout_vip_set_sel_input(tvout->regs + TVO_VIP_HDF,
 				main_path,
 				sel_input_logic_inverted,
 				STI_TVOUT_VIDEO_OUT_YUV);

 	/* select the input sync for HD analog = VTG set 3
 	 * and HD DCS = VTG set 2 */
 	tvout_write(tvout,
 		(TVO_SYNC_MAIN_VTG_SET_2 << TVO_SYNC_HD_DCS_SHIFT)
 		| TVO_SYNC_MAIN_VTG_SET_3,
 		TVO_HD_SYNC_SEL);

 	/* power up HD DAC */
 	tvout_write(tvout, 0, TVO_HD_DAC_CFG_OFF);
 }

 static void sti_tvout_encoder_dpms(struct drm_encoder *encoder, int mode)
 {
 }

 static bool sti_tvout_encoder_mode_fixup(struct drm_encoder *encoder,
 				       const struct drm_display_mode *mode,
 				       struct drm_display_mode *adjusted_mode)
 {
 	return true;
 }

 static void sti_tvout_encoder_mode_set(struct drm_encoder *encoder,
 				       struct drm_display_mode *mode,
 				       struct drm_display_mode *adjusted_mode)
 {
 }

 static void sti_tvout_encoder_prepare(struct drm_encoder *encoder)
 {
 }

 static void sti_tvout_encoder_destroy(struct drm_encoder *encoder)
 {
 	struct sti_tvout_encoder *sti_encoder = to_sti_tvout_encoder(encoder);

 	drm_encoder_cleanup(encoder);
 	kfree(sti_encoder);
 }

 static const struct drm_encoder_funcs sti_tvout_encoder_funcs = {
 	.destroy = sti_tvout_encoder_destroy,
 };

 static void sti_hda_encoder_commit(struct drm_encoder *encoder)
 {
 	struct sti_tvout *tvout = to_sti_tvout(encoder);

 	tvout_hda_start(tvout, true);
 }

 static void sti_hda_encoder_disable(struct drm_encoder *encoder)
 {
 	struct sti_tvout *tvout = to_sti_tvout(encoder);

 	/* reset VIP register */
 	tvout_write(tvout, 0x0, TVO_VIP_HDF);

 	/* power down HD DAC */
 	tvout_write(tvout, 1, TVO_HD_DAC_CFG_OFF);
 }

 static const struct drm_encoder_helper_funcs sti_hda_encoder_helper_funcs = {
 	.dpms = sti_tvout_encoder_dpms,
 	.mode_fixup = sti_tvout_encoder_mode_fixup,
 	.mode_set = sti_tvout_encoder_mode_set,
 	.prepare = sti_tvout_encoder_prepare,
 	.commit = sti_hda_encoder_commit,
 	.disable = sti_hda_encoder_disable,
 };

 static struct drm_encoder *sti_tvout_create_hda_encoder(struct drm_device *dev,
 		struct sti_tvout *tvout)
 {
 	struct sti_tvout_encoder *encoder;
 	struct drm_encoder *drm_encoder;

 	encoder = devm_kzalloc(tvout->dev, sizeof(*encoder), GFP_KERNEL);
 	if (!encoder)
 		return NULL;

 	encoder->tvout = tvout;

 	drm_encoder = (struct drm_encoder *) encoder;

 	drm_encoder->possible_crtcs = ENCODER_MAIN_CRTC_MASK;
 	drm_encoder->possible_clones = 1 << 0;

 	drm_encoder_init(dev, drm_encoder,
 			&sti_tvout_encoder_funcs, DRM_MODE_ENCODER_DAC);

 	drm_encoder_helper_add(drm_encoder, &sti_hda_encoder_helper_funcs);

 	return drm_encoder;
 }

 static void sti_hdmi_encoder_commit(struct drm_encoder *encoder)
 {
 	struct sti_tvout *tvout = to_sti_tvout(encoder);

 	tvout_hdmi_start(tvout, true);
 }

 static void sti_hdmi_encoder_disable(struct drm_encoder *encoder)
 {
 	struct sti_tvout *tvout = to_sti_tvout(encoder);

 	/* reset VIP register */
 	tvout_write(tvout, 0x0, TVO_VIP_HDMI);
 }

 static const struct drm_encoder_helper_funcs sti_hdmi_encoder_helper_funcs = {
 	.dpms = sti_tvout_encoder_dpms,
 	.mode_fixup = sti_tvout_encoder_mode_fixup,
 	.mode_set = sti_tvout_encoder_mode_set,
 	.prepare = sti_tvout_encoder_prepare,
 	.commit = sti_hdmi_encoder_commit,
 	.disable = sti_hdmi_encoder_disable,
 };

 static struct drm_encoder *sti_tvout_create_hdmi_encoder(struct drm_device *dev,
 		struct sti_tvout *tvout)
 {
 	struct sti_tvout_encoder *encoder;
 	struct drm_encoder *drm_encoder;

 	encoder = devm_kzalloc(tvout->dev, sizeof(*encoder), GFP_KERNEL);
 	if (!encoder)
 		return NULL;

 	encoder->tvout = tvout;

 	drm_encoder = (struct drm_encoder *) encoder;

 	drm_encoder->possible_crtcs = ENCODER_MAIN_CRTC_MASK;
 	drm_encoder->possible_clones = 1 << 1;

 	drm_encoder_init(dev, drm_encoder,
 			&sti_tvout_encoder_funcs, DRM_MODE_ENCODER_TMDS);

 	drm_encoder_helper_add(drm_encoder, &sti_hdmi_encoder_helper_funcs);

 	return drm_encoder;
 }

 static void sti_tvout_create_encoders(struct drm_device *dev,
 		struct sti_tvout *tvout)
 {
 	tvout->hdmi = sti_tvout_create_hdmi_encoder(dev, tvout);
 	tvout->hda = sti_tvout_create_hda_encoder(dev, tvout);
 }

 static void sti_tvout_destroy_encoders(struct sti_tvout *tvout)
 {
 	if (tvout->hdmi)
 		drm_encoder_cleanup(tvout->hdmi);
 	tvout->hdmi = NULL;

 	if (tvout->hda)
 		drm_encoder_cleanup(tvout->hda);
 	tvout->hda = NULL;
 }

 static int sti_tvout_bind(struct device *dev, struct device *master, void *data)
 {
 	struct sti_tvout *tvout = dev_get_drvdata(dev);
 	struct drm_device *drm_dev = data;
 	unsigned int i;
 	int ret;

 	tvout->drm_dev = drm_dev;

 	/* set preformatter matrix */
 	for (i = 0; i < 8; i++) {
 		tvout_write(tvout, rgb_to_ycbcr_601[i],
 			TVO_CSC_MAIN_M0 + (i * 4));
 		tvout_write(tvout, rgb_to_ycbcr_601[i],
 			TVO_CSC_AUX_M0 + (i * 4));
 	}

 	sti_tvout_create_encoders(drm_dev, tvout);

 	ret = component_bind_all(dev, drm_dev);
 	if (ret)
 		sti_tvout_destroy_encoders(tvout);

 	return ret;
 }

 static void sti_tvout_unbind(struct device *dev, struct device *master,
 	void *data)
 {
 	/* do nothing */
 }

 static const struct component_ops sti_tvout_ops = {
 	.bind	= sti_tvout_bind,
 	.unbind	= sti_tvout_unbind,
 };

 static int compare_of(struct device *dev, void *data)
 {
 	return dev->of_node == data;
 }

 static int sti_tvout_master_bind(struct device *dev)
 {
 	return 0;
 }

 static void sti_tvout_master_unbind(struct device *dev)
 {
 	/* do nothing */
 }

 static const struct component_master_ops sti_tvout_master_ops = {
 	.bind = sti_tvout_master_bind,
 	.unbind = sti_tvout_master_unbind,
 };

 static int sti_tvout_probe(struct platform_device *pdev)
 {
 	struct device *dev = &pdev->dev;
 	struct device_node *node = dev->of_node;
 	struct sti_tvout *tvout;
 	struct resource *res;
 	struct device_node *child_np;
 	struct component_match *match = NULL;

 	DRM_INFO("%s\n", __func__);

 	if (!node)
 		return -ENODEV;

 	tvout = devm_kzalloc(dev, sizeof(*tvout), GFP_KERNEL);
 	if (!tvout)
 		return -ENOMEM;

 	tvout->dev = dev;

 	/* get Memory ressources */
 	res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "tvout-reg");
 	if (!res) {
 		DRM_ERROR("Invalid glue resource\n");
 		return -ENOMEM;
 	}
 	tvout->regs = devm_ioremap_nocache(dev, res->start, resource_size(res));
 	if (!tvout->regs)
 		return -ENOMEM;

 	/* get reset resources */
 	tvout->reset = devm_reset_control_get(dev, "tvout");
 	/* take tvout out of reset */
 	if (!IS_ERR(tvout->reset))
 		reset_control_deassert(tvout->reset);

 	platform_set_drvdata(pdev, tvout);

 	of_platform_populate(node, NULL, NULL, dev);

 	child_np = of_get_next_available_child(node, NULL);

 	while (child_np) {
 		component_match_add(dev, &match, compare_of, child_np);
 		of_node_put(child_np);
 		child_np = of_get_next_available_child(node, child_np);
 	}

 	component_master_add_with_match(dev, &sti_tvout_master_ops, match);

 	return component_add(dev, &sti_tvout_ops);
 }

 static int sti_tvout_remove(struct platform_device *pdev)
 {
 	component_master_del(&pdev->dev, &sti_tvout_master_ops);
 	component_del(&pdev->dev, &sti_tvout_ops);
 	return 0;
 }

 static const struct of_device_id tvout_of_match[] = {
 	{ .compatible = "st,stih416-tvout", },
 	{ .compatible = "st,stih407-tvout", },
 	{ /* end node */ }
 };
 MODULE_DEVICE_TABLE(of, tvout_of_match);

 struct platform_driver sti_tvout_driver = {
 	.driver = {
 		.name = "sti-tvout",
 		.owner = THIS_MODULE,
 		.of_match_table = tvout_of_match,
 	},
 	.probe = sti_tvout_probe,
 	.remove = sti_tvout_remove,
 };

 module_platform_driver(sti_tvout_driver);

 MODULE_AUTHOR("Benjamin Gaignard <benjamin.gaignard@st.com>");
 MODULE_DESCRIPTION("STMicroelectronics SoC DRM driver");
 MODULE_LICENSE("GPL");
	/*
	* Copyright (C) STMicroelectronics SA 2014
	* Authors: Benjamin Gaignard <benjamin.gaignard@st.com>
	* Vincent Abriou <vincent.abriou@st.com>
	* for STMicroelectronics.
	* License terms: GNU General Public License (GPL), version 2
	*/

	#include <linux/clk.h>
	#include <linux/component.h>
	#include <linux/module.h>
	#include <linux/of_platform.h>
	#include <linux/platform_device.h>
	#include <linux/reset.h>

	#include <drm/drmP.h>
	#include <drm/drm_crtc_helper.h>

	/* glue registers */
	#define TVO_CSC_MAIN_M0 0x000
	#define TVO_CSC_MAIN_M1 0x004
	#define TVO_CSC_MAIN_M2 0x008
	#define TVO_CSC_MAIN_M3 0x00c
	#define TVO_CSC_MAIN_M4 0x010
	#define TVO_CSC_MAIN_M5 0x014
	#define TVO_CSC_MAIN_M6 0x018
	#define TVO_CSC_MAIN_M7 0x01c
	#define TVO_MAIN_IN_VID_FORMAT 0x030
	#define TVO_CSC_AUX_M0 0x100
	#define TVO_CSC_AUX_M1 0x104
	#define TVO_CSC_AUX_M2 0x108
	#define TVO_CSC_AUX_M3 0x10c
	#define TVO_CSC_AUX_M4 0x110
	#define TVO_CSC_AUX_M5 0x114
	#define TVO_CSC_AUX_M6 0x118
	#define TVO_CSC_AUX_M7 0x11c
	#define TVO_AUX_IN_VID_FORMAT 0x130
	#define TVO_VIP_HDF 0x400
	#define TVO_HD_SYNC_SEL 0x418
	#define TVO_HD_DAC_CFG_OFF 0x420
	#define TVO_VIP_HDMI 0x500
	#define TVO_HDMI_FORCE_COLOR_0 0x504
	#define TVO_HDMI_FORCE_COLOR_1 0x508
	#define TVO_HDMI_CLIP_VALUE_B_CB 0x50c
	#define TVO_HDMI_CLIP_VALUE_Y_G 0x510
	#define TVO_HDMI_CLIP_VALUE_R_CR 0x514
	#define TVO_HDMI_SYNC_SEL 0x518
	#define TVO_HDMI_DFV_OBS 0x540

	#define TVO_IN_FMT_SIGNED BIT(0)
	#define TVO_SYNC_EXT BIT(4)

	#define TVO_VIP_REORDER_R_SHIFT 24
	#define TVO_VIP_REORDER_G_SHIFT 20
	#define TVO_VIP_REORDER_B_SHIFT 16
	#define TVO_VIP_REORDER_MASK 0x3
	#define TVO_VIP_REORDER_Y_G_SEL 0
	#define TVO_VIP_REORDER_CB_B_SEL 1
	#define TVO_VIP_REORDER_CR_R_SEL 2

	#define TVO_VIP_CLIP_SHIFT 8
	#define TVO_VIP_CLIP_MASK 0x7
	#define TVO_VIP_CLIP_DISABLED 0
	#define TVO_VIP_CLIP_EAV_SAV 1
	#define TVO_VIP_CLIP_LIMITED_RANGE_RGB_Y 2
	#define TVO_VIP_CLIP_LIMITED_RANGE_CB_CR 3
	#define TVO_VIP_CLIP_PROG_RANGE 4

	#define TVO_VIP_RND_SHIFT 4
	#define TVO_VIP_RND_MASK 0x3
	#define TVO_VIP_RND_8BIT_ROUNDED 0
	#define TVO_VIP_RND_10BIT_ROUNDED 1
	#define TVO_VIP_RND_12BIT_ROUNDED 2

	#define TVO_VIP_SEL_INPUT_MASK 0xf
	#define TVO_VIP_SEL_INPUT_MAIN 0x0
	#define TVO_VIP_SEL_INPUT_AUX 0x8
	#define TVO_VIP_SEL_INPUT_FORCE_COLOR 0xf
	#define TVO_VIP_SEL_INPUT_BYPASS_MASK 0x1
	#define TVO_VIP_SEL_INPUT_BYPASSED 1

	#define TVO_SYNC_MAIN_VTG_SET_REF 0x00
	#define TVO_SYNC_MAIN_VTG_SET_1 0x01
	#define TVO_SYNC_MAIN_VTG_SET_2 0x02
	#define TVO_SYNC_MAIN_VTG_SET_3 0x03
	#define TVO_SYNC_MAIN_VTG_SET_4 0x04
	#define TVO_SYNC_MAIN_VTG_SET_5 0x05
	#define TVO_SYNC_MAIN_VTG_SET_6 0x06
	#define TVO_SYNC_AUX_VTG_SET_REF 0x10
	#define TVO_SYNC_AUX_VTG_SET_1 0x11
	#define TVO_SYNC_AUX_VTG_SET_2 0x12
	#define TVO_SYNC_AUX_VTG_SET_3 0x13
	#define TVO_SYNC_AUX_VTG_SET_4 0x14
	#define TVO_SYNC_AUX_VTG_SET_5 0x15
	#define TVO_SYNC_AUX_VTG_SET_6 0x16

	#define TVO_SYNC_HD_DCS_SHIFT 8

	#define ENCODER_MAIN_CRTC_MASK BIT(0)

	/* enum listing the supported output data format */
	enum sti_tvout_video_out_type {
	STI_TVOUT_VIDEO_OUT_RGB,
	STI_TVOUT_VIDEO_OUT_YUV,
	};

	struct sti_tvout {
	struct device *dev;
	struct drm_device *drm_dev;
	void __iomem *regs;
	struct reset_control *reset;
	struct drm_encoder *hdmi;
	struct drm_encoder *hda;
	};

	struct sti_tvout_encoder {
	struct drm_encoder encoder;
	struct sti_tvout *tvout;
	};

	#define to_sti_tvout_encoder(x) \
	container_of(x, struct sti_tvout_encoder, encoder)

	#define to_sti_tvout(x) to_sti_tvout_encoder(x)->tvout

	/* preformatter conversion matrix */
	static const u32 rgb_to_ycbcr_601[8] = {
	0xF927082E, 0x04C9FEAB, 0x01D30964, 0xFA95FD3D,
	0x0000082E, 0x00002000, 0x00002000, 0x00000000
	};

	/* 709 RGB to YCbCr */
	static const u32 rgb_to_ycbcr_709[8] = {
	0xF891082F, 0x0367FF40, 0x01280B71, 0xF9B1FE20,
	0x0000082F, 0x00002000, 0x00002000, 0x00000000
	};

	static u32 tvout_read(struct sti_tvout *tvout, int offset)
	{
	return readl(tvout->regs + offset);
	}

	static void tvout_write(struct sti_tvout *tvout, u32 val, int offset)
	{
	writel(val, tvout->regs + offset);
	}

	/**
	* Set the clipping mode of a VIP
	*
	* @tvout: tvout structure
	* @cr_r:
	* @y_g:
	* @cb_b:
	*/
	static void tvout_vip_set_color_order(struct sti_tvout *tvout,
	u32 cr_r, u32 y_g, u32 cb_b)
	{
	u32 val = tvout_read(tvout, TVO_VIP_HDMI);

	val &= ~(TVO_VIP_REORDER_MASK << TVO_VIP_REORDER_R_SHIFT);
	val &= ~(TVO_VIP_REORDER_MASK << TVO_VIP_REORDER_G_SHIFT);
	val &= ~(TVO_VIP_REORDER_MASK << TVO_VIP_REORDER_B_SHIFT);
	val \|= cr_r << TVO_VIP_REORDER_R_SHIFT;
	val \|= y_g << TVO_VIP_REORDER_G_SHIFT;
	val \|= cb_b << TVO_VIP_REORDER_B_SHIFT;

	tvout_write(tvout, val, TVO_VIP_HDMI);
	}

	/**
	* Set the clipping mode of a VIP
	*
	* @tvout: tvout structure
	* @range: clipping range
	*/
	static void tvout_vip_set_clip_mode(struct sti_tvout *tvout, u32 range)
	{
	u32 val = tvout_read(tvout, TVO_VIP_HDMI);

	val &= ~(TVO_VIP_CLIP_MASK << TVO_VIP_CLIP_SHIFT);
	val \|= range << TVO_VIP_CLIP_SHIFT;
	tvout_write(tvout, val, TVO_VIP_HDMI);
	}

	/**
	* Set the rounded value of a VIP
	*
	* @tvout: tvout structure
	* @rnd: rounded val per component
	*/
	static void tvout_vip_set_rnd(struct sti_tvout *tvout, u32 rnd)
	{
	u32 val = tvout_read(tvout, TVO_VIP_HDMI);

	val &= ~(TVO_VIP_RND_MASK << TVO_VIP_RND_SHIFT);
	val \|= rnd << TVO_VIP_RND_SHIFT;
	tvout_write(tvout, val, TVO_VIP_HDMI);
	}

	/**
	* Select the VIP input
	*
	* @tvout: tvout structure
	* @sel_input: selected_input (main/aux + conv)
	*/
	static void tvout_vip_set_sel_input(struct sti_tvout *tvout,
	bool main_path,
	bool sel_input_logic_inverted,
	enum sti_tvout_video_out_type video_out)
	{
	u32 sel_input;
	u32 val = tvout_read(tvout, TVO_VIP_HDMI);

	if (main_path)
	sel_input = TVO_VIP_SEL_INPUT_MAIN;
	else
	sel_input = TVO_VIP_SEL_INPUT_AUX;

	switch (video_out) {
	case STI_TVOUT_VIDEO_OUT_RGB:
	sel_input \|= TVO_VIP_SEL_INPUT_BYPASSED;
	break;
	case STI_TVOUT_VIDEO_OUT_YUV:
	sel_input &= ~TVO_VIP_SEL_INPUT_BYPASSED;
	break;
	}

	/* on stih407 chip the sel_input bypass mode logic is inverted */
	if (sel_input_logic_inverted)
	sel_input = sel_input ^ TVO_VIP_SEL_INPUT_BYPASS_MASK;

	val &= ~TVO_VIP_SEL_INPUT_MASK;
	val \|= sel_input;
	tvout_write(tvout, val, TVO_VIP_HDMI);
	}

	/**
	* Select the input video signed or unsigned
	*
	* @tvout: tvout structure
	* @in_vid_signed: used video input format
	*/
	static void tvout_vip_set_in_vid_fmt(struct sti_tvout *tvout, u32 in_vid_fmt)
	{
	u32 val = tvout_read(tvout, TVO_VIP_HDMI);

	val &= ~TVO_IN_FMT_SIGNED;
	val \|= in_vid_fmt;
	tvout_write(tvout, val, TVO_MAIN_IN_VID_FORMAT);
	}

	/**
	* Start VIP block for HDMI output
	*
	* @tvout: pointer on tvout structure
	* @main_path: true if main path has to be used in the vip configuration
	* else aux path is used.
	*/
	static void tvout_hdmi_start(struct sti_tvout *tvout, bool main_path)
	{
	struct device_node *node = tvout->dev->of_node;
	bool sel_input_logic_inverted = false;

	dev_dbg(tvout->dev, "%s\n", __func__);

	if (main_path) {
	DRM_DEBUG_DRIVER("main vip for hdmi\n");
	/* select the input sync for hdmi = VTG set 1 */
	tvout_write(tvout, TVO_SYNC_MAIN_VTG_SET_1, TVO_HDMI_SYNC_SEL);
	} else {
	DRM_DEBUG_DRIVER("aux vip for hdmi\n");
	/* select the input sync for hdmi = VTG set 1 */
	tvout_write(tvout, TVO_SYNC_AUX_VTG_SET_1, TVO_HDMI_SYNC_SEL);
	}

	/* set color channel order */
	tvout_vip_set_color_order(tvout,
	TVO_VIP_REORDER_CR_R_SEL,
	TVO_VIP_REORDER_Y_G_SEL,
	TVO_VIP_REORDER_CB_B_SEL);

	/* set clipping mode (Limited range RGB/Y) */
	tvout_vip_set_clip_mode(tvout, TVO_VIP_CLIP_LIMITED_RANGE_RGB_Y);

	/* set round mode (rounded to 8-bit per component) */
	tvout_vip_set_rnd(tvout, TVO_VIP_RND_8BIT_ROUNDED);

	if (of_device_is_compatible(node, "st,stih407-tvout")) {
	/* set input video format */
	tvout_vip_set_in_vid_fmt(tvout->regs + TVO_MAIN_IN_VID_FORMAT,
	TVO_IN_FMT_SIGNED);
	sel_input_logic_inverted = true;
	}

	/* input selection */
	tvout_vip_set_sel_input(tvout, main_path,
	sel_input_logic_inverted, STI_TVOUT_VIDEO_OUT_RGB);
	}

	/**
	* Start HDF VIP and HD DAC
	*
	* @tvout: pointer on tvout structure
	* @main_path: true if main path has to be used in the vip configuration
	* else aux path is used.
	*/
	static void tvout_hda_start(struct sti_tvout *tvout, bool main_path)
	{
	struct device_node *node = tvout->dev->of_node;
	bool sel_input_logic_inverted = false;

	dev_dbg(tvout->dev, "%s\n", __func__);

	if (!main_path) {
	DRM_ERROR("HD Analog on aux not implemented\n");
	return;
	}

	DRM_DEBUG_DRIVER("main vip for HDF\n");

	/* set color channel order */
	tvout_vip_set_color_order(tvout->regs + TVO_VIP_HDF,
	TVO_VIP_REORDER_CR_R_SEL,
	TVO_VIP_REORDER_Y_G_SEL,
	TVO_VIP_REORDER_CB_B_SEL);

	/* set clipping mode (Limited range RGB/Y) */
	tvout_vip_set_clip_mode(tvout->regs + TVO_VIP_HDF,
	TVO_VIP_CLIP_LIMITED_RANGE_CB_CR);

	/* set round mode (rounded to 10-bit per component) */
	tvout_vip_set_rnd(tvout->regs + TVO_VIP_HDF, TVO_VIP_RND_10BIT_ROUNDED);

	if (of_device_is_compatible(node, "st,stih407-tvout")) {
	/* set input video format */
	tvout_vip_set_in_vid_fmt(tvout, TVO_IN_FMT_SIGNED);
	sel_input_logic_inverted = true;
	}

	/* Input selection */
	tvout_vip_set_sel_input(tvout->regs + TVO_VIP_HDF,
	main_path,
	sel_input_logic_inverted,
	STI_TVOUT_VIDEO_OUT_YUV);

	/* select the input sync for HD analog = VTG set 3
	* and HD DCS = VTG set 2 */
	tvout_write(tvout,
	(TVO_SYNC_MAIN_VTG_SET_2 << TVO_SYNC_HD_DCS_SHIFT)
	\| TVO_SYNC_MAIN_VTG_SET_3,
	TVO_HD_SYNC_SEL);

	/* power up HD DAC */
	tvout_write(tvout, 0, TVO_HD_DAC_CFG_OFF);
	}

	static void sti_tvout_encoder_dpms(struct drm_encoder *encoder, int mode)
	{
	}

	static bool sti_tvout_encoder_mode_fixup(struct drm_encoder *encoder,
	const struct drm_display_mode *mode,
	struct drm_display_mode *adjusted_mode)
	{
	return true;
	}

	static void sti_tvout_encoder_mode_set(struct drm_encoder *encoder,
	struct drm_display_mode *mode,
	struct drm_display_mode *adjusted_mode)
	{
	}

	static void sti_tvout_encoder_prepare(struct drm_encoder *encoder)
	{
	}

	static void sti_tvout_encoder_destroy(struct drm_encoder *encoder)
	{
	struct sti_tvout_encoder *sti_encoder = to_sti_tvout_encoder(encoder);

	drm_encoder_cleanup(encoder);
	kfree(sti_encoder);
	}

	static const struct drm_encoder_funcs sti_tvout_encoder_funcs = {
	.destroy = sti_tvout_encoder_destroy,
	};

	static void sti_hda_encoder_commit(struct drm_encoder *encoder)
	{
	struct sti_tvout *tvout = to_sti_tvout(encoder);

	tvout_hda_start(tvout, true);
	}

	static void sti_hda_encoder_disable(struct drm_encoder *encoder)
	{
	struct sti_tvout *tvout = to_sti_tvout(encoder);

	/* reset VIP register */
	tvout_write(tvout, 0x0, TVO_VIP_HDF);

	/* power down HD DAC */
	tvout_write(tvout, 1, TVO_HD_DAC_CFG_OFF);
	}

	static const struct drm_encoder_helper_funcs sti_hda_encoder_helper_funcs = {
	.dpms = sti_tvout_encoder_dpms,
	.mode_fixup = sti_tvout_encoder_mode_fixup,
	.mode_set = sti_tvout_encoder_mode_set,
	.prepare = sti_tvout_encoder_prepare,
	.commit = sti_hda_encoder_commit,
	.disable = sti_hda_encoder_disable,
	};

	static struct drm_encoder sti_tvout_create_hda_encoder(struct drm_device dev,
	struct sti_tvout *tvout)
	{
	struct sti_tvout_encoder *encoder;
	struct drm_encoder *drm_encoder;

	encoder = devm_kzalloc(tvout->dev, sizeof(*encoder), GFP_KERNEL);
	if (!encoder)
	return NULL;

	encoder->tvout = tvout;

	drm_encoder = (struct drm_encoder *) encoder;

	drm_encoder->possible_crtcs = ENCODER_MAIN_CRTC_MASK;
	drm_encoder->possible_clones = 1 << 0;

	drm_encoder_init(dev, drm_encoder,
	&sti_tvout_encoder_funcs, DRM_MODE_ENCODER_DAC);

	drm_encoder_helper_add(drm_encoder, &sti_hda_encoder_helper_funcs);

	return drm_encoder;
	}

	static void sti_hdmi_encoder_commit(struct drm_encoder *encoder)
	{
	struct sti_tvout *tvout = to_sti_tvout(encoder);

	tvout_hdmi_start(tvout, true);
	}

	static void sti_hdmi_encoder_disable(struct drm_encoder *encoder)
	{
	struct sti_tvout *tvout = to_sti_tvout(encoder);

	/* reset VIP register */
	tvout_write(tvout, 0x0, TVO_VIP_HDMI);
	}

	static const struct drm_encoder_helper_funcs sti_hdmi_encoder_helper_funcs = {
	.dpms = sti_tvout_encoder_dpms,
	.mode_fixup = sti_tvout_encoder_mode_fixup,
	.mode_set = sti_tvout_encoder_mode_set,
	.prepare = sti_tvout_encoder_prepare,
	.commit = sti_hdmi_encoder_commit,
	.disable = sti_hdmi_encoder_disable,
	};

	static struct drm_encoder sti_tvout_create_hdmi_encoder(struct drm_device dev,
	struct sti_tvout *tvout)
	{
	struct sti_tvout_encoder *encoder;
	struct drm_encoder *drm_encoder;

	encoder = devm_kzalloc(tvout->dev, sizeof(*encoder), GFP_KERNEL);
	if (!encoder)
	return NULL;

	encoder->tvout = tvout;

	drm_encoder = (struct drm_encoder *) encoder;

	drm_encoder->possible_crtcs = ENCODER_MAIN_CRTC_MASK;
	drm_encoder->possible_clones = 1 << 1;

	drm_encoder_init(dev, drm_encoder,
	&sti_tvout_encoder_funcs, DRM_MODE_ENCODER_TMDS);

	drm_encoder_helper_add(drm_encoder, &sti_hdmi_encoder_helper_funcs);

	return drm_encoder;
	}

	static void sti_tvout_create_encoders(struct drm_device *dev,
	struct sti_tvout *tvout)
	{
	tvout->hdmi = sti_tvout_create_hdmi_encoder(dev, tvout);
	tvout->hda = sti_tvout_create_hda_encoder(dev, tvout);
	}

	static void sti_tvout_destroy_encoders(struct sti_tvout *tvout)
	{
	if (tvout->hdmi)
	drm_encoder_cleanup(tvout->hdmi);
	tvout->hdmi = NULL;

	if (tvout->hda)
	drm_encoder_cleanup(tvout->hda);
	tvout->hda = NULL;
	}

	static int sti_tvout_bind(struct device dev, struct device master, void *data)
	{
	struct sti_tvout *tvout = dev_get_drvdata(dev);
	struct drm_device *drm_dev = data;
	unsigned int i;
	int ret;

	tvout->drm_dev = drm_dev;

	/* set preformatter matrix */
	for (i = 0; i < 8; i++) {
	tvout_write(tvout, rgb_to_ycbcr_601[i],
	TVO_CSC_MAIN_M0 + (i * 4));
	tvout_write(tvout, rgb_to_ycbcr_601[i],
	TVO_CSC_AUX_M0 + (i * 4));
	}

	sti_tvout_create_encoders(drm_dev, tvout);

	ret = component_bind_all(dev, drm_dev);
	if (ret)
	sti_tvout_destroy_encoders(tvout);

	return ret;
	}

	static void sti_tvout_unbind(struct device dev, struct device master,
	void *data)
	{
	/* do nothing */
	}

	static const struct component_ops sti_tvout_ops = {
	.bind = sti_tvout_bind,
	.unbind = sti_tvout_unbind,
	};

	static int compare_of(struct device dev, void data)
	{
	return dev->of_node == data;
	}

	static int sti_tvout_master_bind(struct device *dev)
	{
	return 0;
	}

	static void sti_tvout_master_unbind(struct device *dev)
	{
	/* do nothing */
	}

	static const struct component_master_ops sti_tvout_master_ops = {
	.bind = sti_tvout_master_bind,
	.unbind = sti_tvout_master_unbind,
	};

	static int sti_tvout_probe(struct platform_device *pdev)
	{
	struct device *dev = &pdev->dev;
	struct device_node *node = dev->of_node;
	struct sti_tvout *tvout;
	struct resource *res;
	struct device_node *child_np;
	struct component_match *match = NULL;

	DRM_INFO("%s\n", __func__);

	if (!node)
	return -ENODEV;

	tvout = devm_kzalloc(dev, sizeof(*tvout), GFP_KERNEL);
	if (!tvout)
	return -ENOMEM;

	tvout->dev = dev;

	/* get Memory ressources */
	res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "tvout-reg");
	if (!res) {
	DRM_ERROR("Invalid glue resource\n");
	return -ENOMEM;
	}
	tvout->regs = devm_ioremap_nocache(dev, res->start, resource_size(res));
	if (!tvout->regs)
	return -ENOMEM;

	/* get reset resources */
	tvout->reset = devm_reset_control_get(dev, "tvout");
	/* take tvout out of reset */
	if (!IS_ERR(tvout->reset))
	reset_control_deassert(tvout->reset);

	platform_set_drvdata(pdev, tvout);

	of_platform_populate(node, NULL, NULL, dev);

	child_np = of_get_next_available_child(node, NULL);

	while (child_np) {
	component_match_add(dev, &match, compare_of, child_np);
	of_node_put(child_np);
	child_np = of_get_next_available_child(node, child_np);
	}

	component_master_add_with_match(dev, &sti_tvout_master_ops, match);

	return component_add(dev, &sti_tvout_ops);
	}

	static int sti_tvout_remove(struct platform_device *pdev)
	{
	component_master_del(&pdev->dev, &sti_tvout_master_ops);
	component_del(&pdev->dev, &sti_tvout_ops);
	return 0;
	}

	static const struct of_device_id tvout_of_match[] = {
	{ .compatible = "st,stih416-tvout", },
	{ .compatible = "st,stih407-tvout", },
	{ /* end node */ }
	};
	MODULE_DEVICE_TABLE(of, tvout_of_match);

	struct platform_driver sti_tvout_driver = {
	.driver = {
	.name = "sti-tvout",
	.owner = THIS_MODULE,
	.of_match_table = tvout_of_match,
	},
	.probe = sti_tvout_probe,
	.remove = sti_tvout_remove,
	};

	module_platform_driver(sti_tvout_driver);

	MODULE_AUTHOR("Benjamin Gaignard <benjamin.gaignard@st.com>");
	MODULE_DESCRIPTION("STMicroelectronics SoC DRM driver");
	MODULE_LICENSE("GPL");