[mirror_ubuntu-bionic-kernel.git] / drivers / mmc / host / sdhci-of-at91.c

/*
 * Atmel SDMMC controller driver.
 *
 * Copyright (C) 2015 Atmel,
 *		 2015 Ludovic Desroches <ludovic.desroches@atmel.com>
 *
 * This software is licensed under the terms of the GNU General Public
 * License version 2, as published by the Free Software Foundation, and
 * may be copied, distributed, and modified under those terms.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */

#include <linux/clk.h>
#include <linux/delay.h>
#include <linux/err.h>
#include <linux/io.h>
#include <linux/kernel.h>
#include <linux/mmc/host.h>
#include <linux/mmc/slot-gpio.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/of_device.h>
#include <linux/pm.h>
#include <linux/pm_runtime.h>

#include "sdhci-pltfm.h"

#define SDMMC_MC1R	0x204
#define		SDMMC_MC1R_DDR		BIT(3)
#define		SDMMC_MC1R_FCD		BIT(7)
#define SDMMC_CACR	0x230
#define		SDMMC_CACR_CAPWREN	BIT(0)
#define		SDMMC_CACR_KEY		(0x46 << 8)

#define SDHCI_AT91_PRESET_COMMON_CONF	0x400 /* drv type B, programmable clock mode */

struct sdhci_at91_priv {
	struct clk *hclock;
	struct clk *gck;
	struct clk *mainck;
	bool restore_needed;
};

static void sdhci_at91_set_force_card_detect(struct sdhci_host *host)
{
	u8 mc1r;

	mc1r = readb(host->ioaddr + SDMMC_MC1R);
	mc1r |= SDMMC_MC1R_FCD;
	writeb(mc1r, host->ioaddr + SDMMC_MC1R);
}

static void sdhci_at91_set_clock(struct sdhci_host *host, unsigned int clock)
{
	u16 clk;
	unsigned long timeout;

	host->mmc->actual_clock = 0;

	/*
	 * There is no requirement to disable the internal clock before
	 * changing the SD clock configuration. Moreover, disabling the
	 * internal clock, changing the configuration and re-enabling the
	 * internal clock causes some bugs. It can prevent to get the internal
	 * clock stable flag ready and an unexpected switch to the base clock
	 * when using presets.
	 */
	clk = sdhci_readw(host, SDHCI_CLOCK_CONTROL);
	clk &= SDHCI_CLOCK_INT_EN;
	sdhci_writew(host, clk, SDHCI_CLOCK_CONTROL);

	if (clock == 0)
		return;

	clk = sdhci_calc_clk(host, clock, &host->mmc->actual_clock);

	clk |= SDHCI_CLOCK_INT_EN;
	sdhci_writew(host, clk, SDHCI_CLOCK_CONTROL);

	/* Wait max 20 ms */
	timeout = 20;
	while (!((clk = sdhci_readw(host, SDHCI_CLOCK_CONTROL))
		& SDHCI_CLOCK_INT_STABLE)) {
		if (timeout == 0) {
			pr_err("%s: Internal clock never stabilised.\n",
			       mmc_hostname(host->mmc));
			return;
		}
		timeout--;
		mdelay(1);
	}

	clk |= SDHCI_CLOCK_CARD_EN;
	sdhci_writew(host, clk, SDHCI_CLOCK_CONTROL);
}

/*
 * In this specific implementation of the SDHCI controller, the power register
 * needs to have a valid voltage set even when the power supply is managed by
 * an external regulator.
 */
static void sdhci_at91_set_power(struct sdhci_host *host, unsigned char mode,
		     unsigned short vdd)
{
	if (!IS_ERR(host->mmc->supply.vmmc)) {
		struct mmc_host *mmc = host->mmc;

		mmc_regulator_set_ocr(mmc, mmc->supply.vmmc, vdd);
	}
	sdhci_set_power_noreg(host, mode, vdd);
}

static void sdhci_at91_set_uhs_signaling(struct sdhci_host *host,
					 unsigned int timing)
{
	if (timing == MMC_TIMING_MMC_DDR52)
		sdhci_writeb(host, SDMMC_MC1R_DDR, SDMMC_MC1R);
	sdhci_set_uhs_signaling(host, timing);
}

static void sdhci_at91_reset(struct sdhci_host *host, u8 mask)
{
	sdhci_reset(host, mask);

	if (host->mmc->caps & MMC_CAP_NONREMOVABLE)
		sdhci_at91_set_force_card_detect(host);
}

static const struct sdhci_ops sdhci_at91_sama5d2_ops = {
	.set_clock		= sdhci_at91_set_clock,
	.set_bus_width		= sdhci_set_bus_width,
	.reset			= sdhci_at91_reset,
	.set_uhs_signaling	= sdhci_at91_set_uhs_signaling,
	.set_power		= sdhci_at91_set_power,
};

static const struct sdhci_pltfm_data soc_data_sama5d2 = {
	.ops = &sdhci_at91_sama5d2_ops,
};

static const struct of_device_id sdhci_at91_dt_match[] = {
	{ .compatible = "atmel,sama5d2-sdhci", .data = &soc_data_sama5d2 },
	{}
};
MODULE_DEVICE_TABLE(of, sdhci_at91_dt_match);

static int sdhci_at91_set_clks_presets(struct device *dev)
{
	struct sdhci_host *host = dev_get_drvdata(dev);
	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
	struct sdhci_at91_priv *priv = sdhci_pltfm_priv(pltfm_host);
	int ret;
	unsigned int			caps0, caps1;
	unsigned int			clk_base, clk_mul;
	unsigned int			gck_rate, real_gck_rate;
	unsigned int			preset_div;

	/*
	 * The mult clock is provided by as a generated clock by the PMC
	 * controller. In order to set the rate of gck, we have to get the
	 * base clock rate and the clock mult from capabilities.
	 */
	clk_prepare_enable(priv->hclock);
	caps0 = readl(host->ioaddr + SDHCI_CAPABILITIES);
	caps1 = readl(host->ioaddr + SDHCI_CAPABILITIES_1);
	clk_base = (caps0 & SDHCI_CLOCK_V3_BASE_MASK) >> SDHCI_CLOCK_BASE_SHIFT;
	clk_mul = (caps1 & SDHCI_CLOCK_MUL_MASK) >> SDHCI_CLOCK_MUL_SHIFT;
	gck_rate = clk_base * 1000000 * (clk_mul + 1);
	ret = clk_set_rate(priv->gck, gck_rate);
	if (ret < 0) {
		dev_err(dev, "failed to set gck");
		clk_disable_unprepare(priv->hclock);
		return ret;
	}
	/*
	 * We need to check if we have the requested rate for gck because in
	 * some cases this rate could be not supported. If it happens, the rate
	 * is the closest one gck can provide. We have to update the value
	 * of clk mul.
	 */
	real_gck_rate = clk_get_rate(priv->gck);
	if (real_gck_rate != gck_rate) {
		clk_mul = real_gck_rate / (clk_base * 1000000) - 1;
		caps1 &= (~SDHCI_CLOCK_MUL_MASK);
		caps1 |= ((clk_mul << SDHCI_CLOCK_MUL_SHIFT) &
			  SDHCI_CLOCK_MUL_MASK);
		/* Set capabilities in r/w mode. */
		writel(SDMMC_CACR_KEY | SDMMC_CACR_CAPWREN,
		       host->ioaddr + SDMMC_CACR);
		writel(caps1, host->ioaddr + SDHCI_CAPABILITIES_1);
		/* Set capabilities in ro mode. */
		writel(0, host->ioaddr + SDMMC_CACR);
		dev_info(dev, "update clk mul to %u as gck rate is %u Hz\n",
			 clk_mul, real_gck_rate);
	}

	/*
	 * We have to set preset values because it depends on the clk_mul
	 * value. Moreover, SDR104 is supported in a degraded mode since the
	 * maximum sd clock value is 120 MHz instead of 208 MHz. For that
	 * reason, we need to use presets to support SDR104.
	 */
	preset_div = DIV_ROUND_UP(real_gck_rate, 24000000) - 1;
	writew(SDHCI_AT91_PRESET_COMMON_CONF | preset_div,
	       host->ioaddr + SDHCI_PRESET_FOR_SDR12);
	preset_div = DIV_ROUND_UP(real_gck_rate, 50000000) - 1;
	writew(SDHCI_AT91_PRESET_COMMON_CONF | preset_div,
	       host->ioaddr + SDHCI_PRESET_FOR_SDR25);
	preset_div = DIV_ROUND_UP(real_gck_rate, 100000000) - 1;
	writew(SDHCI_AT91_PRESET_COMMON_CONF | preset_div,
	       host->ioaddr + SDHCI_PRESET_FOR_SDR50);
	preset_div = DIV_ROUND_UP(real_gck_rate, 120000000) - 1;
	writew(SDHCI_AT91_PRESET_COMMON_CONF | preset_div,
	       host->ioaddr + SDHCI_PRESET_FOR_SDR104);
	preset_div = DIV_ROUND_UP(real_gck_rate, 50000000) - 1;
	writew(SDHCI_AT91_PRESET_COMMON_CONF | preset_div,
	       host->ioaddr + SDHCI_PRESET_FOR_DDR50);

	clk_prepare_enable(priv->mainck);
	clk_prepare_enable(priv->gck);

	return 0;
}

#ifdef CONFIG_PM_SLEEP
static int sdhci_at91_suspend(struct device *dev)
{
	struct sdhci_host *host = dev_get_drvdata(dev);
	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
	struct sdhci_at91_priv *priv = sdhci_pltfm_priv(pltfm_host);
	int ret;

	ret = pm_runtime_force_suspend(dev);

	priv->restore_needed = true;

	return ret;
}
#endif /* CONFIG_PM_SLEEP */

#ifdef CONFIG_PM
static int sdhci_at91_runtime_suspend(struct device *dev)
{
	struct sdhci_host *host = dev_get_drvdata(dev);
	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
	struct sdhci_at91_priv *priv = sdhci_pltfm_priv(pltfm_host);
	int ret;

	ret = sdhci_runtime_suspend_host(host);

	if (host->tuning_mode != SDHCI_TUNING_MODE_3)
		mmc_retune_needed(host->mmc);

	clk_disable_unprepare(priv->gck);
	clk_disable_unprepare(priv->hclock);
	clk_disable_unprepare(priv->mainck);

	return ret;
}

static int sdhci_at91_runtime_resume(struct device *dev)
{
	struct sdhci_host *host = dev_get_drvdata(dev);
	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
	struct sdhci_at91_priv *priv = sdhci_pltfm_priv(pltfm_host);
	int ret;

	if (priv->restore_needed) {
		ret = sdhci_at91_set_clks_presets(dev);
		if (ret)
			return ret;

		priv->restore_needed = false;
		goto out;
	}

	ret = clk_prepare_enable(priv->mainck);
	if (ret) {
		dev_err(dev, "can't enable mainck\n");
		return ret;
	}

	ret = clk_prepare_enable(priv->hclock);
	if (ret) {
		dev_err(dev, "can't enable hclock\n");
		return ret;
	}

	ret = clk_prepare_enable(priv->gck);
	if (ret) {
		dev_err(dev, "can't enable gck\n");
		return ret;
	}

out:
	return sdhci_runtime_resume_host(host);
}
#endif /* CONFIG_PM */

static const struct dev_pm_ops sdhci_at91_dev_pm_ops = {
	SET_SYSTEM_SLEEP_PM_OPS(sdhci_at91_suspend, pm_runtime_force_resume)
	SET_RUNTIME_PM_OPS(sdhci_at91_runtime_suspend,
			   sdhci_at91_runtime_resume,
			   NULL)
};

static int sdhci_at91_probe(struct platform_device *pdev)
{
	const struct of_device_id	*match;
	const struct sdhci_pltfm_data	*soc_data;
	struct sdhci_host		*host;
	struct sdhci_pltfm_host		*pltfm_host;
	struct sdhci_at91_priv		*priv;
	int				ret;

	match = of_match_device(sdhci_at91_dt_match, &pdev->dev);
	if (!match)
		return -EINVAL;
	soc_data = match->data;

	host = sdhci_pltfm_init(pdev, soc_data, sizeof(*priv));
	if (IS_ERR(host))
		return PTR_ERR(host);

	pltfm_host = sdhci_priv(host);
	priv = sdhci_pltfm_priv(pltfm_host);

	priv->mainck = devm_clk_get(&pdev->dev, "baseclk");
	if (IS_ERR(priv->mainck)) {
		dev_err(&pdev->dev, "failed to get baseclk\n");
		return PTR_ERR(priv->mainck);
	}

	priv->hclock = devm_clk_get(&pdev->dev, "hclock");
	if (IS_ERR(priv->hclock)) {
		dev_err(&pdev->dev, "failed to get hclock\n");
		return PTR_ERR(priv->hclock);
	}

	priv->gck = devm_clk_get(&pdev->dev, "multclk");
	if (IS_ERR(priv->gck)) {
		dev_err(&pdev->dev, "failed to get multclk\n");
		return PTR_ERR(priv->gck);
	}

	ret = sdhci_at91_set_clks_presets(&pdev->dev);
	if (ret)
		goto sdhci_pltfm_free;

	priv->restore_needed = false;

	ret = mmc_of_parse(host->mmc);
	if (ret)
		goto clocks_disable_unprepare;

	sdhci_get_of_property(pdev);

	pm_runtime_get_noresume(&pdev->dev);
	pm_runtime_set_active(&pdev->dev);
	pm_runtime_enable(&pdev->dev);
	pm_runtime_set_autosuspend_delay(&pdev->dev, 50);
	pm_runtime_use_autosuspend(&pdev->dev);

	ret = sdhci_add_host(host);
	if (ret)
		goto pm_runtime_disable;

	/*
	 * When calling sdhci_runtime_suspend_host(), the sdhci layer makes
	 * the assumption that all the clocks of the controller are disabled.
	 * It means we can't get irq from it when it is runtime suspended.
	 * For that reason, it is not planned to wake-up on a card detect irq
	 * from the controller.
	 * If we want to use runtime PM and to be able to wake-up on card
	 * insertion, we have to use a GPIO for the card detection or we can
	 * use polling. Be aware that using polling will resume/suspend the
	 * controller between each attempt.
	 * Disable SDHCI_QUIRK_BROKEN_CARD_DETECTION to be sure nobody tries
	 * to enable polling via device tree with broken-cd property.
	 */
	if (mmc_card_is_removable(host->mmc) &&
	    mmc_gpio_get_cd(host->mmc) < 0) {
		host->mmc->caps |= MMC_CAP_NEEDS_POLL;
		host->quirks &= ~SDHCI_QUIRK_BROKEN_CARD_DETECTION;
	}

	/*
	 * If the device attached to the MMC bus is not removable, it is safer
	 * to set the Force Card Detect bit. People often don't connect the
	 * card detect signal and use this pin for another purpose. If the card
	 * detect pin is not muxed to SDHCI controller, a default value is
	 * used. This value can be different from a SoC revision to another
	 * one. Problems come when this default value is not card present. To
	 * avoid this case, if the device is non removable then the card
	 * detection procedure using the SDMCC_CD signal is bypassed.
	 * This bit is reset when a software reset for all command is performed
	 * so we need to implement our own reset function to set back this bit.
	 */
	if (host->mmc->caps & MMC_CAP_NONREMOVABLE)
		sdhci_at91_set_force_card_detect(host);

	pm_runtime_put_autosuspend(&pdev->dev);

	return 0;

pm_runtime_disable:
	pm_runtime_disable(&pdev->dev);
	pm_runtime_set_suspended(&pdev->dev);
	pm_runtime_put_noidle(&pdev->dev);
clocks_disable_unprepare:
	clk_disable_unprepare(priv->gck);
	clk_disable_unprepare(priv->mainck);
	clk_disable_unprepare(priv->hclock);
sdhci_pltfm_free:
	sdhci_pltfm_free(pdev);
	return ret;
}

static int sdhci_at91_remove(struct platform_device *pdev)
{
	struct sdhci_host	*host = platform_get_drvdata(pdev);
	struct sdhci_pltfm_host	*pltfm_host = sdhci_priv(host);
	struct sdhci_at91_priv	*priv = sdhci_pltfm_priv(pltfm_host);
	struct clk *gck = priv->gck;
	struct clk *hclock = priv->hclock;
	struct clk *mainck = priv->mainck;

	pm_runtime_get_sync(&pdev->dev);
	pm_runtime_disable(&pdev->dev);
	pm_runtime_put_noidle(&pdev->dev);

	sdhci_pltfm_unregister(pdev);

	clk_disable_unprepare(gck);
	clk_disable_unprepare(hclock);
	clk_disable_unprepare(mainck);

	return 0;
}

static struct platform_driver sdhci_at91_driver = {
	.driver		= {
		.name	= "sdhci-at91",
		.of_match_table = sdhci_at91_dt_match,
		.pm	= &sdhci_at91_dev_pm_ops,
	},
	.probe		= sdhci_at91_probe,
	.remove		= sdhci_at91_remove,
};

module_platform_driver(sdhci_at91_driver);

MODULE_DESCRIPTION("SDHCI driver for at91");
MODULE_AUTHOR("Ludovic Desroches <ludovic.desroches@atmel.com>");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
bb5f8ea4	1	/*
	2	* Atmel SDMMC controller driver.
	3	*
	4	* Copyright (C) 2015 Atmel,
	5	* 2015 Ludovic Desroches <ludovic.desroches@atmel.com>
	6	*
	7	* This software is licensed under the terms of the GNU General Public
	8	* License version 2, as published by the Free Software Foundation, and
	9	* may be copied, distributed, and modified under those terms.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*/
	16
	17	#include <linux/clk.h>
4e289a7d	18	#include <linux/delay.h>
bb5f8ea4	19	#include <linux/err.h>
bb5f8ea4	20	#include <linux/io.h>
4406433d	21	#include <linux/kernel.h>
bb5f8ea4	22	#include <linux/mmc/host.h>
64e5cd72	23	#include <linux/mmc/slot-gpio.h>
bb5f8ea4	24	#include <linux/module.h>
	25	#include <linux/of.h>
	26	#include <linux/of_device.h>
f5f17813	27	#include <linux/pm.h>
f5f17813	28	#include <linux/pm_runtime.h>
bb5f8ea4	29
	30	#include "sdhci-pltfm.h"
	31
d0918764 LD	32	#define SDMMC_MC1R 0x204
d0918764 LD	33	#define SDMMC_MC1R_DDR BIT(3)
7a1e3f14	34	#define SDMMC_MC1R_FCD BIT(7)
bb5f8ea4	35	#define SDMMC_CACR 0x230
	36	#define SDMMC_CACR_CAPWREN BIT(0)
	37	#define SDMMC_CACR_KEY (0x46 << 8)
	38
4406433d LD	39	#define SDHCI_AT91_PRESET_COMMON_CONF 0x400 /* drv type B, programmable clock mode */
4406433d LD	40
bb5f8ea4	41	struct sdhci_at91_priv {
	42	struct clk *hclock;
	43	struct clk *gck;
	44	struct clk *mainck;
e2b372eb	45	bool restore_needed;
bb5f8ea4	46	};
bb5f8ea4	47
7a1e3f14 LD	48	static void sdhci_at91_set_force_card_detect(struct sdhci_host *host)
	49	{
	50	u8 mc1r;
	51
	52	mc1r = readb(host->ioaddr + SDMMC_MC1R);
	53	mc1r \|= SDMMC_MC1R_FCD;
	54	writeb(mc1r, host->ioaddr + SDMMC_MC1R);
	55	}
	56
4e289a7d LD	57	static void sdhci_at91_set_clock(struct sdhci_host *host, unsigned int clock)
	58	{
	59	u16 clk;
	60	unsigned long timeout;
	61
	62	host->mmc->actual_clock = 0;
	63
	64	/*
	65	* There is no requirement to disable the internal clock before
	66	* changing the SD clock configuration. Moreover, disabling the
	67	* internal clock, changing the configuration and re-enabling the
	68	* internal clock causes some bugs. It can prevent to get the internal
	69	* clock stable flag ready and an unexpected switch to the base clock
	70	* when using presets.
	71	*/
	72	clk = sdhci_readw(host, SDHCI_CLOCK_CONTROL);
	73	clk &= SDHCI_CLOCK_INT_EN;
	74	sdhci_writew(host, clk, SDHCI_CLOCK_CONTROL);
	75
	76	if (clock == 0)
	77	return;
	78
	79	clk = sdhci_calc_clk(host, clock, &host->mmc->actual_clock);
	80
	81	clk \|= SDHCI_CLOCK_INT_EN;
	82	sdhci_writew(host, clk, SDHCI_CLOCK_CONTROL);
	83
	84	/* Wait max 20 ms */
	85	timeout = 20;
	86	while (!((clk = sdhci_readw(host, SDHCI_CLOCK_CONTROL))
	87	& SDHCI_CLOCK_INT_STABLE)) {
	88	if (timeout == 0) {
	89	pr_err("%s: Internal clock never stabilised.\n",
	90	mmc_hostname(host->mmc));
	91	return;
	92	}
	93	timeout--;
	94	mdelay(1);
	95	}
	96
	97	clk \|= SDHCI_CLOCK_CARD_EN;
	98	sdhci_writew(host, clk, SDHCI_CLOCK_CONTROL);
	99	}
	100
2ce0c7b6 RI	101	/*
	102	* In this specific implementation of the SDHCI controller, the power register
	103	* needs to have a valid voltage set even when the power supply is managed by
	104	* an external regulator.
	105	*/
	106	static void sdhci_at91_set_power(struct sdhci_host *host, unsigned char mode,
	107	unsigned short vdd)
	108	{
	109	if (!IS_ERR(host->mmc->supply.vmmc)) {
	110	struct mmc_host *mmc = host->mmc;
	111
2ce0c7b6	112	mmc_regulator_set_ocr(mmc, mmc->supply.vmmc, vdd);
2ce0c7b6 RI	113	}
	114	sdhci_set_power_noreg(host, mode, vdd);
	115	}
	116
519c51af CIK	117	static void sdhci_at91_set_uhs_signaling(struct sdhci_host *host,
519c51af CIK	118	unsigned int timing)
d0918764 LD	119	{
	120	if (timing == MMC_TIMING_MMC_DDR52)
	121	sdhci_writeb(host, SDMMC_MC1R_DDR, SDMMC_MC1R);
	122	sdhci_set_uhs_signaling(host, timing);
	123	}
	124
7a1e3f14 LD	125	static void sdhci_at91_reset(struct sdhci_host *host, u8 mask)
	126	{
	127	sdhci_reset(host, mask);
	128
	129	if (host->mmc->caps & MMC_CAP_NONREMOVABLE)
	130	sdhci_at91_set_force_card_detect(host);
	131	}
	132
bb5f8ea4	133	static const struct sdhci_ops sdhci_at91_sama5d2_ops = {
4e289a7d	134	.set_clock = sdhci_at91_set_clock,
bb5f8ea4	135	.set_bus_width = sdhci_set_bus_width,
7a1e3f14	136	.reset = sdhci_at91_reset,
d0918764	137	.set_uhs_signaling = sdhci_at91_set_uhs_signaling,
2ce0c7b6	138	.set_power = sdhci_at91_set_power,
bb5f8ea4	139	};
	140
	141	static const struct sdhci_pltfm_data soc_data_sama5d2 = {
	142	.ops = &sdhci_at91_sama5d2_ops,
	143	};
	144
	145	static const struct of_device_id sdhci_at91_dt_match[] = {
	146	{ .compatible = "atmel,sama5d2-sdhci", .data = &soc_data_sama5d2 },
	147	{}
	148	};
d9943c68	149	MODULE_DEVICE_TABLE(of, sdhci_at91_dt_match);
bb5f8ea4	150
c8a019e7 QS	151	static int sdhci_at91_set_clks_presets(struct device *dev)
	152	{
	153	struct sdhci_host *host = dev_get_drvdata(dev);
	154	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
	155	struct sdhci_at91_priv *priv = sdhci_pltfm_priv(pltfm_host);
	156	int ret;
	157	unsigned int caps0, caps1;
	158	unsigned int clk_base, clk_mul;
	159	unsigned int gck_rate, real_gck_rate;
	160	unsigned int preset_div;
	161
	162	/*
	163	* The mult clock is provided by as a generated clock by the PMC
	164	* controller. In order to set the rate of gck, we have to get the
	165	* base clock rate and the clock mult from capabilities.
	166	*/
	167	clk_prepare_enable(priv->hclock);
	168	caps0 = readl(host->ioaddr + SDHCI_CAPABILITIES);
	169	caps1 = readl(host->ioaddr + SDHCI_CAPABILITIES_1);
	170	clk_base = (caps0 & SDHCI_CLOCK_V3_BASE_MASK) >> SDHCI_CLOCK_BASE_SHIFT;
	171	clk_mul = (caps1 & SDHCI_CLOCK_MUL_MASK) >> SDHCI_CLOCK_MUL_SHIFT;
	172	gck_rate = clk_base * 1000000 * (clk_mul + 1);
	173	ret = clk_set_rate(priv->gck, gck_rate);
	174	if (ret < 0) {
	175	dev_err(dev, "failed to set gck");
	176	clk_disable_unprepare(priv->hclock);
	177	return ret;
	178	}
	179	/*
	180	* We need to check if we have the requested rate for gck because in
	181	* some cases this rate could be not supported. If it happens, the rate
	182	* is the closest one gck can provide. We have to update the value
	183	* of clk mul.
	184	*/
	185	real_gck_rate = clk_get_rate(priv->gck);
	186	if (real_gck_rate != gck_rate) {
	187	clk_mul = real_gck_rate / (clk_base * 1000000) - 1;
	188	caps1 &= (~SDHCI_CLOCK_MUL_MASK);
	189	caps1 \|= ((clk_mul << SDHCI_CLOCK_MUL_SHIFT) &
	190	SDHCI_CLOCK_MUL_MASK);
	191	/* Set capabilities in r/w mode. */
	192	writel(SDMMC_CACR_KEY \| SDMMC_CACR_CAPWREN,
	193	host->ioaddr + SDMMC_CACR);
	194	writel(caps1, host->ioaddr + SDHCI_CAPABILITIES_1);
	195	/* Set capabilities in ro mode. */
	196	writel(0, host->ioaddr + SDMMC_CACR);
	197	dev_info(dev, "update clk mul to %u as gck rate is %u Hz\n",
	198	clk_mul, real_gck_rate);
	199	}
	200
	201	/*
	202	* We have to set preset values because it depends on the clk_mul
	203	* value. Moreover, SDR104 is supported in a degraded mode since the
	204	* maximum sd clock value is 120 MHz instead of 208 MHz. For that
	205	* reason, we need to use presets to support SDR104.
	206	*/
	207	preset_div = DIV_ROUND_UP(real_gck_rate, 24000000) - 1;
	208	writew(SDHCI_AT91_PRESET_COMMON_CONF \| preset_div,
	209	host->ioaddr + SDHCI_PRESET_FOR_SDR12);
	210	preset_div = DIV_ROUND_UP(real_gck_rate, 50000000) - 1;
	211	writew(SDHCI_AT91_PRESET_COMMON_CONF \| preset_div,
	212	host->ioaddr + SDHCI_PRESET_FOR_SDR25);
	213	preset_div = DIV_ROUND_UP(real_gck_rate, 100000000) - 1;
	214	writew(SDHCI_AT91_PRESET_COMMON_CONF \| preset_div,
215	host->ioaddr + SDHCI_PRESET_FOR_SDR50);
216	preset_div = DIV_ROUND_UP(real_gck_rate, 120000000) - 1;
217	writew(SDHCI_AT91_PRESET_COMMON_CONF \| preset_div,
218	host->ioaddr + SDHCI_PRESET_FOR_SDR104);
219	preset_div = DIV_ROUND_UP(real_gck_rate, 50000000) - 1;
220	writew(SDHCI_AT91_PRESET_COMMON_CONF \| preset_div,
221	host->ioaddr + SDHCI_PRESET_FOR_DDR50);
222
223	clk_prepare_enable(priv->mainck);
224	clk_prepare_enable(priv->gck);
225
226	return 0;
227	}
228
e2b372eb QS	229	#ifdef CONFIG_PM_SLEEP
	230	static int sdhci_at91_suspend(struct device *dev)
	231	{
	232	struct sdhci_host *host = dev_get_drvdata(dev);
	233	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
	234	struct sdhci_at91_priv *priv = sdhci_pltfm_priv(pltfm_host);
	235	int ret;
	236
	237	ret = pm_runtime_force_suspend(dev);
	238
	239	priv->restore_needed = true;
	240
	241	return ret;
	242	}
	243	#endif /* CONFIG_PM_SLEEP */
	244
f5f17813	245	#ifdef CONFIG_PM
	246	static int sdhci_at91_runtime_suspend(struct device *dev)
	247	{
	248	struct sdhci_host *host = dev_get_drvdata(dev);
	249	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
10f1c135	250	struct sdhci_at91_priv *priv = sdhci_pltfm_priv(pltfm_host);
f5f17813	251	int ret;
	252
	253	ret = sdhci_runtime_suspend_host(host);
	254
d38dcad4 AH	255	if (host->tuning_mode != SDHCI_TUNING_MODE_3)
	256	mmc_retune_needed(host->mmc);
	257
f5f17813	258	clk_disable_unprepare(priv->gck);
	259	clk_disable_unprepare(priv->hclock);
	260	clk_disable_unprepare(priv->mainck);
	261
	262	return ret;
	263	}
	264
	265	static int sdhci_at91_runtime_resume(struct device *dev)
	266	{
	267	struct sdhci_host *host = dev_get_drvdata(dev);
	268	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
10f1c135	269	struct sdhci_at91_priv *priv = sdhci_pltfm_priv(pltfm_host);
f5f17813	270	int ret;
f5f17813	271
e2b372eb QS	272	if (priv->restore_needed) {
	273	ret = sdhci_at91_set_clks_presets(dev);
	274	if (ret)
	275	return ret;
	276
	277	priv->restore_needed = false;
	278	goto out;
	279	}
	280
f5f17813	281	ret = clk_prepare_enable(priv->mainck);
	282	if (ret) {
	283	dev_err(dev, "can't enable mainck\n");
	284	return ret;
	285	}
	286
	287	ret = clk_prepare_enable(priv->hclock);
	288	if (ret) {
	289	dev_err(dev, "can't enable hclock\n");
	290	return ret;
	291	}
	292
	293	ret = clk_prepare_enable(priv->gck);
	294	if (ret) {
	295	dev_err(dev, "can't enable gck\n");
	296	return ret;
	297	}
	298
e2b372eb	299	out:
f5f17813	300	return sdhci_runtime_resume_host(host);
	301	}
	302	#endif /* CONFIG_PM */
	303
	304	static const struct dev_pm_ops sdhci_at91_dev_pm_ops = {
e2b372eb	305	SET_SYSTEM_SLEEP_PM_OPS(sdhci_at91_suspend, pm_runtime_force_resume)
f5f17813	306	SET_RUNTIME_PM_OPS(sdhci_at91_runtime_suspend,
	307	sdhci_at91_runtime_resume,
	308	NULL)
	309	};
	310
bb5f8ea4	311	static int sdhci_at91_probe(struct platform_device *pdev)
	312	{
	313	const struct of_device_id *match;
	314	const struct sdhci_pltfm_data *soc_data;
	315	struct sdhci_host *host;
	316	struct sdhci_pltfm_host *pltfm_host;
	317	struct sdhci_at91_priv *priv;
bb5f8ea4	318	int ret;
	319
	320	match = of_match_device(sdhci_at91_dt_match, &pdev->dev);
	321	if (!match)
	322	return -EINVAL;
	323	soc_data = match->data;
	324
10f1c135 JZ	325	host = sdhci_pltfm_init(pdev, soc_data, sizeof(*priv));
	326	if (IS_ERR(host))
	327	return PTR_ERR(host);
	328
	329	pltfm_host = sdhci_priv(host);
	330	priv = sdhci_pltfm_priv(pltfm_host);
bb5f8ea4	331
	332	priv->mainck = devm_clk_get(&pdev->dev, "baseclk");
	333	if (IS_ERR(priv->mainck)) {
	334	dev_err(&pdev->dev, "failed to get baseclk\n");
	335	return PTR_ERR(priv->mainck);
	336	}
	337
	338	priv->hclock = devm_clk_get(&pdev->dev, "hclock");
	339	if (IS_ERR(priv->hclock)) {
	340	dev_err(&pdev->dev, "failed to get hclock\n");
	341	return PTR_ERR(priv->hclock);
	342	}
	343
	344	priv->gck = devm_clk_get(&pdev->dev, "multclk");
	345	if (IS_ERR(priv->gck)) {
	346	dev_err(&pdev->dev, "failed to get multclk\n");
	347	return PTR_ERR(priv->gck);
	348	}
	349
c8a019e7 QS	350	ret = sdhci_at91_set_clks_presets(&pdev->dev);
	351	if (ret)
	352	goto sdhci_pltfm_free;
bb5f8ea4	353
e2b372eb QS	354	priv->restore_needed = false;
e2b372eb QS	355
bb5f8ea4	356	ret = mmc_of_parse(host->mmc);
	357	if (ret)
	358	goto clocks_disable_unprepare;
	359
	360	sdhci_get_of_property(pdev);
	361
f5f17813	362	pm_runtime_get_noresume(&pdev->dev);
	363	pm_runtime_set_active(&pdev->dev);
	364	pm_runtime_enable(&pdev->dev);
	365	pm_runtime_set_autosuspend_delay(&pdev->dev, 50);
	366	pm_runtime_use_autosuspend(&pdev->dev);
	367
bb5f8ea4	368	ret = sdhci_add_host(host);
bb5f8ea4	369	if (ret)
f5f17813	370	goto pm_runtime_disable;
f5f17813	371
64e5cd72	372	/*
	373	* When calling sdhci_runtime_suspend_host(), the sdhci layer makes
	374	* the assumption that all the clocks of the controller are disabled.
	375	* It means we can't get irq from it when it is runtime suspended.
	376	* For that reason, it is not planned to wake-up on a card detect irq
	377	* from the controller.
	378	* If we want to use runtime PM and to be able to wake-up on card
	379	* insertion, we have to use a GPIO for the card detection or we can
	380	* use polling. Be aware that using polling will resume/suspend the
	381	* controller between each attempt.
	382	* Disable SDHCI_QUIRK_BROKEN_CARD_DETECTION to be sure nobody tries
	383	* to enable polling via device tree with broken-cd property.
	384	*/
860951c5	385	if (mmc_card_is_removable(host->mmc) &&
287980e4	386	mmc_gpio_get_cd(host->mmc) < 0) {
64e5cd72	387	host->mmc->caps \|= MMC_CAP_NEEDS_POLL;
	388	host->quirks &= ~SDHCI_QUIRK_BROKEN_CARD_DETECTION;
	389	}
	390
7a1e3f14 LD	391	/*
	392	* If the device attached to the MMC bus is not removable, it is safer
	393	* to set the Force Card Detect bit. People often don't connect the
	394	* card detect signal and use this pin for another purpose. If the card
	395	* detect pin is not muxed to SDHCI controller, a default value is
	396	* used. This value can be different from a SoC revision to another
	397	* one. Problems come when this default value is not card present. To
	398	* avoid this case, if the device is non removable then the card
	399	* detection procedure using the SDMCC_CD signal is bypassed.
	400	* This bit is reset when a software reset for all command is performed
	401	* so we need to implement our own reset function to set back this bit.
	402	*/
	403	if (host->mmc->caps & MMC_CAP_NONREMOVABLE)
	404	sdhci_at91_set_force_card_detect(host);
	405
f5f17813	406	pm_runtime_put_autosuspend(&pdev->dev);
bb5f8ea4	407
	408	return 0;
	409
f5f17813	410	pm_runtime_disable:
	411	pm_runtime_disable(&pdev->dev);
	412	pm_runtime_set_suspended(&pdev->dev);
2df9d58f	413	pm_runtime_put_noidle(&pdev->dev);
bb5f8ea4	414	clocks_disable_unprepare:
	415	clk_disable_unprepare(priv->gck);
	416	clk_disable_unprepare(priv->mainck);
bb5f8ea4	417	clk_disable_unprepare(priv->hclock);
c8a019e7	418	sdhci_pltfm_free:
bb5f8ea4	419	sdhci_pltfm_free(pdev);
	420	return ret;
	421	}
	422
	423	static int sdhci_at91_remove(struct platform_device *pdev)
	424	{
	425	struct sdhci_host *host = platform_get_drvdata(pdev);
	426	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
10f1c135 JZ	427	struct sdhci_at91_priv *priv = sdhci_pltfm_priv(pltfm_host);
	428	struct clk *gck = priv->gck;
	429	struct clk *hclock = priv->hclock;
	430	struct clk *mainck = priv->mainck;
bb5f8ea4	431
f5f17813	432	pm_runtime_get_sync(&pdev->dev);
	433	pm_runtime_disable(&pdev->dev);
	434	pm_runtime_put_noidle(&pdev->dev);
	435
bb5f8ea4	436	sdhci_pltfm_unregister(pdev);
bb5f8ea4	437
10f1c135 JZ	438	clk_disable_unprepare(gck);
	439	clk_disable_unprepare(hclock);
	440	clk_disable_unprepare(mainck);
bb5f8ea4	441
	442	return 0;
	443	}
	444
	445	static struct platform_driver sdhci_at91_driver = {
	446	.driver = {
	447	.name = "sdhci-at91",
bb5f8ea4	448	.of_match_table = sdhci_at91_dt_match,
f5f17813	449	.pm = &sdhci_at91_dev_pm_ops,
bb5f8ea4	450	},
	451	.probe = sdhci_at91_probe,
	452	.remove = sdhci_at91_remove,
	453	};
	454
	455	module_platform_driver(sdhci_at91_driver);
	456
	457	MODULE_DESCRIPTION("SDHCI driver for at91");
	458	MODULE_AUTHOR("Ludovic Desroches <ludovic.desroches@atmel.com>");
	459	MODULE_LICENSE("GPL v2");