[mirror_ubuntu-artful-kernel.git] / drivers / mmc / host / dw_mmc-exynos.c

/*
 * Exynos Specific Extensions for Synopsys DW Multimedia Card Interface driver
 *
 * Copyright (C) 2012, Samsung Electronics Co., Ltd.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 */

#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/clk.h>
#include <linux/mmc/host.h>
#include <linux/mmc/dw_mmc.h>
#include <linux/of.h>
#include <linux/of_gpio.h>

#include "dw_mmc.h"
#include "dw_mmc-pltfm.h"

#define NUM_PINS(x)			(x + 2)

#define SDMMC_CLKSEL			0x09C
#define SDMMC_CLKSEL_CCLK_SAMPLE(x)	(((x) & 7) << 0)
#define SDMMC_CLKSEL_CCLK_DRIVE(x)	(((x) & 7) << 16)
#define SDMMC_CLKSEL_CCLK_DIVIDER(x)	(((x) & 7) << 24)
#define SDMMC_CLKSEL_GET_DRV_WD3(x)	(((x) >> 16) & 0x7)
#define SDMMC_CLKSEL_TIMING(x, y, z)	(SDMMC_CLKSEL_CCLK_SAMPLE(x) |	\
					SDMMC_CLKSEL_CCLK_DRIVE(y) |	\
					SDMMC_CLKSEL_CCLK_DIVIDER(z))

#define EXYNOS4210_FIXED_CIU_CLK_DIV	2
#define EXYNOS4412_FIXED_CIU_CLK_DIV	4

/* Variations in Exynos specific dw-mshc controller */
enum dw_mci_exynos_type {
	DW_MCI_TYPE_EXYNOS4210,
	DW_MCI_TYPE_EXYNOS4412,
	DW_MCI_TYPE_EXYNOS5250,
	DW_MCI_TYPE_EXYNOS5420,
};

/* Exynos implementation specific driver private data */
struct dw_mci_exynos_priv_data {
	enum dw_mci_exynos_type		ctrl_type;
	u8				ciu_div;
	u32				sdr_timing;
	u32				ddr_timing;
};

static struct dw_mci_exynos_compatible {
	char				*compatible;
	enum dw_mci_exynos_type		ctrl_type;
} exynos_compat[] = {
	{
		.compatible	= "samsung,exynos4210-dw-mshc",
		.ctrl_type	= DW_MCI_TYPE_EXYNOS4210,
	}, {
		.compatible	= "samsung,exynos4412-dw-mshc",
		.ctrl_type	= DW_MCI_TYPE_EXYNOS4412,
	}, {
		.compatible	= "samsung,exynos5250-dw-mshc",
		.ctrl_type	= DW_MCI_TYPE_EXYNOS5250,
	}, {
		.compatible	= "samsung,exynos5420-dw-mshc",
		.ctrl_type	= DW_MCI_TYPE_EXYNOS5420,
	},
};

static int dw_mci_exynos_priv_init(struct dw_mci *host)
{
	struct dw_mci_exynos_priv_data *priv;
	int idx;

	priv = devm_kzalloc(host->dev, sizeof(*priv), GFP_KERNEL);
	if (!priv) {
		dev_err(host->dev, "mem alloc failed for private data\n");
		return -ENOMEM;
	}

	for (idx = 0; idx < ARRAY_SIZE(exynos_compat); idx++) {
		if (of_device_is_compatible(host->dev->of_node,
					exynos_compat[idx].compatible))
			priv->ctrl_type = exynos_compat[idx].ctrl_type;
	}

	host->priv = priv;
	return 0;
}

static int dw_mci_exynos_setup_clock(struct dw_mci *host)
{
	struct dw_mci_exynos_priv_data *priv = host->priv;

	if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS5250 ||
		priv->ctrl_type == DW_MCI_TYPE_EXYNOS5420)
		host->bus_hz /= (priv->ciu_div + 1);
	else if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS4412)
		host->bus_hz /= EXYNOS4412_FIXED_CIU_CLK_DIV;
	else if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS4210)
		host->bus_hz /= EXYNOS4210_FIXED_CIU_CLK_DIV;

	return 0;
}

static void dw_mci_exynos_prepare_command(struct dw_mci *host, u32 *cmdr)
{
	/*
	 * Exynos4412 and Exynos5250 extends the use of CMD register with the
	 * use of bit 29 (which is reserved on standard MSHC controllers) for
	 * optionally bypassing the HOLD register for command and data. The
	 * HOLD register should be bypassed in case there is no phase shift
	 * applied on CMD/DATA that is sent to the card.
	 */
	if (SDMMC_CLKSEL_GET_DRV_WD3(mci_readl(host, CLKSEL)))
		*cmdr |= SDMMC_CMD_USE_HOLD_REG;
}

static void dw_mci_exynos_set_ios(struct dw_mci *host, struct mmc_ios *ios)
{
	struct dw_mci_exynos_priv_data *priv = host->priv;

	if (ios->timing == MMC_TIMING_UHS_DDR50)
		mci_writel(host, CLKSEL, priv->ddr_timing);
	else
		mci_writel(host, CLKSEL, priv->sdr_timing);
}

static int dw_mci_exynos_parse_dt(struct dw_mci *host)
{
	struct dw_mci_exynos_priv_data *priv = host->priv;
	struct device_node *np = host->dev->of_node;
	u32 timing[2];
	u32 div = 0;
	int ret;

	of_property_read_u32(np, "samsung,dw-mshc-ciu-div", &div);
	priv->ciu_div = div;

	ret = of_property_read_u32_array(np,
			"samsung,dw-mshc-sdr-timing", timing, 2);
	if (ret)
		return ret;

	priv->sdr_timing = SDMMC_CLKSEL_TIMING(timing[0], timing[1], div);

	ret = of_property_read_u32_array(np,
			"samsung,dw-mshc-ddr-timing", timing, 2);
	if (ret)
		return ret;

	priv->ddr_timing = SDMMC_CLKSEL_TIMING(timing[0], timing[1], div);
	return 0;
}

/* Common capabilities of Exynos4/Exynos5 SoC */
static unsigned long exynos_dwmmc_caps[4] = {
	MMC_CAP_UHS_DDR50 | MMC_CAP_1_8V_DDR |
		MMC_CAP_8_BIT_DATA | MMC_CAP_CMD23,
	MMC_CAP_CMD23,
	MMC_CAP_CMD23,
	MMC_CAP_CMD23,
};

static const struct dw_mci_drv_data exynos_drv_data = {
	.caps			= exynos_dwmmc_caps,
	.init			= dw_mci_exynos_priv_init,
	.setup_clock		= dw_mci_exynos_setup_clock,
	.prepare_command	= dw_mci_exynos_prepare_command,
	.set_ios		= dw_mci_exynos_set_ios,
	.parse_dt		= dw_mci_exynos_parse_dt,
};

static const struct of_device_id dw_mci_exynos_match[] = {
	{ .compatible = "samsung,exynos4412-dw-mshc",
			.data = &exynos_drv_data, },
	{ .compatible = "samsung,exynos5250-dw-mshc",
			.data = &exynos_drv_data, },
	{ .compatible = "samsung,exynos5420-dw-mshc",
			.data = &exynos_drv_data, },
	{},
};
MODULE_DEVICE_TABLE(of, dw_mci_exynos_match);

static int dw_mci_exynos_probe(struct platform_device *pdev)
{
	const struct dw_mci_drv_data *drv_data;
	const struct of_device_id *match;

	match = of_match_node(dw_mci_exynos_match, pdev->dev.of_node);
	drv_data = match->data;
	return dw_mci_pltfm_register(pdev, drv_data);
}

static struct platform_driver dw_mci_exynos_pltfm_driver = {
	.probe		= dw_mci_exynos_probe,
	.remove		= __exit_p(dw_mci_pltfm_remove),
	.driver		= {
		.name		= "dwmmc_exynos",
		.of_match_table	= dw_mci_exynos_match,
		.pm		= &dw_mci_pltfm_pmops,
	},
};

module_platform_driver(dw_mci_exynos_pltfm_driver);

MODULE_DESCRIPTION("Samsung Specific DW-MSHC Driver Extension");
MODULE_AUTHOR("Thomas Abraham <thomas.ab@samsung.com");
MODULE_LICENSE("GPL v2");
MODULE_ALIAS("platform:dwmmc-exynos");
Commit	Line	Data
c3665006 TA	1	/*
	2	* Exynos Specific Extensions for Synopsys DW Multimedia Card Interface driver
	3	*
	4	* Copyright (C) 2012, Samsung Electronics Co., Ltd.
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*/
	11
	12	#include <linux/module.h>
	13	#include <linux/platform_device.h>
	14	#include <linux/clk.h>
	15	#include <linux/mmc/host.h>
	16	#include <linux/mmc/dw_mmc.h>
	17	#include <linux/of.h>
	18	#include <linux/of_gpio.h>
	19
	20	#include "dw_mmc.h"
	21	#include "dw_mmc-pltfm.h"
	22
	23	#define NUM_PINS(x) (x + 2)
	24
	25	#define SDMMC_CLKSEL 0x09C
	26	#define SDMMC_CLKSEL_CCLK_SAMPLE(x) (((x) & 7) << 0)
	27	#define SDMMC_CLKSEL_CCLK_DRIVE(x) (((x) & 7) << 16)
	28	#define SDMMC_CLKSEL_CCLK_DIVIDER(x) (((x) & 7) << 24)
	29	#define SDMMC_CLKSEL_GET_DRV_WD3(x) (((x) >> 16) & 0x7)
	30	#define SDMMC_CLKSEL_TIMING(x, y, z) (SDMMC_CLKSEL_CCLK_SAMPLE(x) \| \
	31	SDMMC_CLKSEL_CCLK_DRIVE(y) \| \
	32	SDMMC_CLKSEL_CCLK_DIVIDER(z))
	33
c3665006 TA	34	#define EXYNOS4210_FIXED_CIU_CLK_DIV 2
	35	#define EXYNOS4412_FIXED_CIU_CLK_DIV 4
	36
	37	/* Variations in Exynos specific dw-mshc controller */
	38	enum dw_mci_exynos_type {
	39	DW_MCI_TYPE_EXYNOS4210,
	40	DW_MCI_TYPE_EXYNOS4412,
	41	DW_MCI_TYPE_EXYNOS5250,
00fd041b	42	DW_MCI_TYPE_EXYNOS5420,
c3665006 TA	43	};
	44
	45	/* Exynos implementation specific driver private data */
	46	struct dw_mci_exynos_priv_data {
	47	enum dw_mci_exynos_type ctrl_type;
	48	u8 ciu_div;
	49	u32 sdr_timing;
	50	u32 ddr_timing;
	51	};
	52
	53	static struct dw_mci_exynos_compatible {
	54	char *compatible;
	55	enum dw_mci_exynos_type ctrl_type;
	56	} exynos_compat[] = {
	57	{
	58	.compatible = "samsung,exynos4210-dw-mshc",
	59	.ctrl_type = DW_MCI_TYPE_EXYNOS4210,
	60	}, {
	61	.compatible = "samsung,exynos4412-dw-mshc",
	62	.ctrl_type = DW_MCI_TYPE_EXYNOS4412,
	63	}, {
	64	.compatible = "samsung,exynos5250-dw-mshc",
	65	.ctrl_type = DW_MCI_TYPE_EXYNOS5250,
00fd041b YK	66	}, {
	67	.compatible = "samsung,exynos5420-dw-mshc",
	68	.ctrl_type = DW_MCI_TYPE_EXYNOS5420,
c3665006 TA	69	},
	70	};
	71
	72	static int dw_mci_exynos_priv_init(struct dw_mci *host)
	73	{
	74	struct dw_mci_exynos_priv_data *priv;
	75	int idx;
	76
	77	priv = devm_kzalloc(host->dev, sizeof(*priv), GFP_KERNEL);
	78	if (!priv) {
	79	dev_err(host->dev, "mem alloc failed for private data\n");
	80	return -ENOMEM;
	81	}
	82
	83	for (idx = 0; idx < ARRAY_SIZE(exynos_compat); idx++) {
	84	if (of_device_is_compatible(host->dev->of_node,
	85	exynos_compat[idx].compatible))
	86	priv->ctrl_type = exynos_compat[idx].ctrl_type;
	87	}
	88
	89	host->priv = priv;
	90	return 0;
	91	}
	92
	93	static int dw_mci_exynos_setup_clock(struct dw_mci *host)
	94	{
	95	struct dw_mci_exynos_priv_data *priv = host->priv;
	96
00fd041b YK	97	if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS5250 \|\|
00fd041b YK	98	priv->ctrl_type == DW_MCI_TYPE_EXYNOS5420)
c3665006 TA	99	host->bus_hz /= (priv->ciu_div + 1);
	100	else if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS4412)
	101	host->bus_hz /= EXYNOS4412_FIXED_CIU_CLK_DIV;
	102	else if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS4210)
	103	host->bus_hz /= EXYNOS4210_FIXED_CIU_CLK_DIV;
	104
	105	return 0;
	106	}
	107
	108	static void dw_mci_exynos_prepare_command(struct dw_mci host, u32 cmdr)
	109	{
	110	/*
	111	* Exynos4412 and Exynos5250 extends the use of CMD register with the
	112	* use of bit 29 (which is reserved on standard MSHC controllers) for
	113	* optionally bypassing the HOLD register for command and data. The
	114	* HOLD register should be bypassed in case there is no phase shift
	115	* applied on CMD/DATA that is sent to the card.
	116	*/
	117	if (SDMMC_CLKSEL_GET_DRV_WD3(mci_readl(host, CLKSEL)))
	118	*cmdr \|= SDMMC_CMD_USE_HOLD_REG;
	119	}
	120
	121	static void dw_mci_exynos_set_ios(struct dw_mci host, struct mmc_ios ios)
	122	{
	123	struct dw_mci_exynos_priv_data *priv = host->priv;
	124
	125	if (ios->timing == MMC_TIMING_UHS_DDR50)
	126	mci_writel(host, CLKSEL, priv->ddr_timing);
	127	else
	128	mci_writel(host, CLKSEL, priv->sdr_timing);
	129	}
	130
	131	static int dw_mci_exynos_parse_dt(struct dw_mci *host)
	132	{
	133	struct dw_mci_exynos_priv_data *priv = host->priv;
	134	struct device_node *np = host->dev->of_node;
	135	u32 timing[2];
	136	u32 div = 0;
	137	int ret;
	138
	139	of_property_read_u32(np, "samsung,dw-mshc-ciu-div", &div);
	140	priv->ciu_div = div;
	141
	142	ret = of_property_read_u32_array(np,
	143	"samsung,dw-mshc-sdr-timing", timing, 2);
	144	if (ret)
	145	return ret;
	146
	147	priv->sdr_timing = SDMMC_CLKSEL_TIMING(timing[0], timing[1], div);
	148
	149	ret = of_property_read_u32_array(np,
	150	"samsung,dw-mshc-ddr-timing", timing, 2);
	151	if (ret)
	152	return ret;
	153
	154	priv->ddr_timing = SDMMC_CLKSEL_TIMING(timing[0], timing[1], div);
	155	return 0;
	156	}
	157
0f6e73d0 DK	158	/* Common capabilities of Exynos4/Exynos5 SoC */
0f6e73d0 DK	159	static unsigned long exynos_dwmmc_caps[4] = {
c3665006 TA	160	MMC_CAP_UHS_DDR50 \| MMC_CAP_1_8V_DDR \|
	161	MMC_CAP_8_BIT_DATA \| MMC_CAP_CMD23,
	162	MMC_CAP_CMD23,
	163	MMC_CAP_CMD23,
	164	MMC_CAP_CMD23,
	165	};
	166
0f6e73d0 DK	167	static const struct dw_mci_drv_data exynos_drv_data = {
0f6e73d0 DK	168	.caps = exynos_dwmmc_caps,
c3665006 TA	169	.init = dw_mci_exynos_priv_init,
	170	.setup_clock = dw_mci_exynos_setup_clock,
	171	.prepare_command = dw_mci_exynos_prepare_command,
	172	.set_ios = dw_mci_exynos_set_ios,
	173	.parse_dt = dw_mci_exynos_parse_dt,
c3665006 TA	174	};
	175
	176	static const struct of_device_id dw_mci_exynos_match[] = {
0f6e73d0 DK	177	{ .compatible = "samsung,exynos4412-dw-mshc",
0f6e73d0 DK	178	.data = &exynos_drv_data, },
c3665006	179	{ .compatible = "samsung,exynos5250-dw-mshc",
0f6e73d0	180	.data = &exynos_drv_data, },
00fd041b YK	181	{ .compatible = "samsung,exynos5420-dw-mshc",
00fd041b YK	182	.data = &exynos_drv_data, },
c3665006 TA	183	{},
c3665006 TA	184	};
517cb9f1	185	MODULE_DEVICE_TABLE(of, dw_mci_exynos_match);
c3665006	186
9665f7f2	187	static int dw_mci_exynos_probe(struct platform_device *pdev)
c3665006	188	{
8e2b36ea	189	const struct dw_mci_drv_data *drv_data;
c3665006 TA	190	const struct of_device_id *match;
	191
	192	match = of_match_node(dw_mci_exynos_match, pdev->dev.of_node);
	193	drv_data = match->data;
	194	return dw_mci_pltfm_register(pdev, drv_data);
	195	}
	196
	197	static struct platform_driver dw_mci_exynos_pltfm_driver = {
	198	.probe = dw_mci_exynos_probe,
	199	.remove = __exit_p(dw_mci_pltfm_remove),
	200	.driver = {
	201	.name = "dwmmc_exynos",
20183d50	202	.of_match_table = dw_mci_exynos_match,
c3665006 TA	203	.pm = &dw_mci_pltfm_pmops,
	204	},
	205	};
	206
	207	module_platform_driver(dw_mci_exynos_pltfm_driver);
	208
	209	MODULE_DESCRIPTION("Samsung Specific DW-MSHC Driver Extension");
	210	MODULE_AUTHOR("Thomas Abraham <thomas.ab@samsung.com");
	211	MODULE_LICENSE("GPL v2");
	212	MODULE_ALIAS("platform:dwmmc-exynos");