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

/*
 * Arasan Secure Digital Host Controller Interface.
 * Copyright (C) 2011 - 2012 Michal Simek <monstr@monstr.eu>
 * Copyright (c) 2012 Wind River Systems, Inc.
 * Copyright (C) 2013 Pengutronix e.K.
 * Copyright (C) 2013 Xilinx Inc.
 *
 * Based on sdhci-of-esdhc.c
 *
 * Copyright (c) 2007 Freescale Semiconductor, Inc.
 * Copyright (c) 2009 MontaVista Software, Inc.
 *
 * Authors: Xiaobo Xie <X.Xie@freescale.com>
 *	    Anton Vorontsov <avorontsov@ru.mvista.com>
 *
 * 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/of_device.h>
#include "sdhci-pltfm.h"

#define SDHCI_ARASAN_CLK_CTRL_OFFSET	0x2c

#define CLK_CTRL_TIMEOUT_SHIFT		16
#define CLK_CTRL_TIMEOUT_MASK		(0xf << CLK_CTRL_TIMEOUT_SHIFT)
#define CLK_CTRL_TIMEOUT_MIN_EXP	13

/**
 * struct sdhci_arasan_data
 * @clk_ahb:	Pointer to the AHB clock
 */
struct sdhci_arasan_data {
	struct clk	*clk_ahb;
};

static unsigned int sdhci_arasan_get_timeout_clock(struct sdhci_host *host)
{
	u32 div;
	unsigned long freq;
	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);

	div = readl(host->ioaddr + SDHCI_ARASAN_CLK_CTRL_OFFSET);
	div = (div & CLK_CTRL_TIMEOUT_MASK) >> CLK_CTRL_TIMEOUT_SHIFT;

	freq = clk_get_rate(pltfm_host->clk);
	freq /= 1 << (CLK_CTRL_TIMEOUT_MIN_EXP + div);

	return freq;
}

static struct sdhci_ops sdhci_arasan_ops = {
	.set_clock = sdhci_set_clock,
	.get_max_clock = sdhci_pltfm_clk_get_max_clock,
	.get_timeout_clock = sdhci_arasan_get_timeout_clock,
	.set_bus_width = sdhci_set_bus_width,
	.reset = sdhci_reset,
	.set_uhs_signaling = sdhci_set_uhs_signaling,
};

static struct sdhci_pltfm_data sdhci_arasan_pdata = {
	.ops = &sdhci_arasan_ops,
	.quirks = SDHCI_QUIRK_CAP_CLOCK_BASE_BROKEN,
	.quirks2 = SDHCI_QUIRK2_PRESET_VALUE_BROKEN |
			SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN,
};

#ifdef CONFIG_PM_SLEEP
/**
 * sdhci_arasan_suspend - Suspend method for the driver
 * @dev:	Address of the device structure
 * Returns 0 on success and error value on error
 *
 * Put the device in a low power state.
 */
static int sdhci_arasan_suspend(struct device *dev)
{
	struct platform_device *pdev = to_platform_device(dev);
	struct sdhci_host *host = platform_get_drvdata(pdev);
	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
	struct sdhci_arasan_data *sdhci_arasan = pltfm_host->priv;
	int ret;

	ret = sdhci_suspend_host(host);
	if (ret)
		return ret;

	clk_disable(pltfm_host->clk);
	clk_disable(sdhci_arasan->clk_ahb);

	return 0;
}

/**
 * sdhci_arasan_resume - Resume method for the driver
 * @dev:	Address of the device structure
 * Returns 0 on success and error value on error
 *
 * Resume operation after suspend
 */
static int sdhci_arasan_resume(struct device *dev)
{
	struct platform_device *pdev = to_platform_device(dev);
	struct sdhci_host *host = platform_get_drvdata(pdev);
	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
	struct sdhci_arasan_data *sdhci_arasan = pltfm_host->priv;
	int ret;

	ret = clk_enable(sdhci_arasan->clk_ahb);
	if (ret) {
		dev_err(dev, "Cannot enable AHB clock.\n");
		return ret;
	}

	ret = clk_enable(pltfm_host->clk);
	if (ret) {
		dev_err(dev, "Cannot enable SD clock.\n");
		clk_disable(sdhci_arasan->clk_ahb);
		return ret;
	}

	return sdhci_resume_host(host);
}
#endif /* ! CONFIG_PM_SLEEP */

static SIMPLE_DEV_PM_OPS(sdhci_arasan_dev_pm_ops, sdhci_arasan_suspend,
			 sdhci_arasan_resume);

static int sdhci_arasan_probe(struct platform_device *pdev)
{
	int ret;
	struct clk *clk_xin;
	struct sdhci_host *host;
	struct sdhci_pltfm_host *pltfm_host;
	struct sdhci_arasan_data *sdhci_arasan;

	sdhci_arasan = devm_kzalloc(&pdev->dev, sizeof(*sdhci_arasan),
			GFP_KERNEL);
	if (!sdhci_arasan)
		return -ENOMEM;

	sdhci_arasan->clk_ahb = devm_clk_get(&pdev->dev, "clk_ahb");
	if (IS_ERR(sdhci_arasan->clk_ahb)) {
		dev_err(&pdev->dev, "clk_ahb clock not found.\n");
		return PTR_ERR(sdhci_arasan->clk_ahb);
	}

	clk_xin = devm_clk_get(&pdev->dev, "clk_xin");
	if (IS_ERR(clk_xin)) {
		dev_err(&pdev->dev, "clk_xin clock not found.\n");
		return PTR_ERR(clk_xin);
	}

	ret = clk_prepare_enable(sdhci_arasan->clk_ahb);
	if (ret) {
		dev_err(&pdev->dev, "Unable to enable AHB clock.\n");
		return ret;
	}

	ret = clk_prepare_enable(clk_xin);
	if (ret) {
		dev_err(&pdev->dev, "Unable to enable SD clock.\n");
		goto clk_dis_ahb;
	}

	host = sdhci_pltfm_init(pdev, &sdhci_arasan_pdata, 0);
	if (IS_ERR(host)) {
		ret = PTR_ERR(host);
		goto clk_disable_all;
	}

	sdhci_get_of_property(pdev);
	pltfm_host = sdhci_priv(host);
	pltfm_host->priv = sdhci_arasan;
	pltfm_host->clk = clk_xin;

	ret = mmc_of_parse(host->mmc);
	if (ret) {
		dev_err(&pdev->dev, "parsing dt failed (%u)\n", ret);
		goto clk_disable_all;
	}

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

	return 0;

err_pltfm_free:
	sdhci_pltfm_free(pdev);
clk_disable_all:
	clk_disable_unprepare(clk_xin);
clk_dis_ahb:
	clk_disable_unprepare(sdhci_arasan->clk_ahb);

	return ret;
}

static int sdhci_arasan_remove(struct platform_device *pdev)
{
	int ret;
	struct sdhci_host *host = platform_get_drvdata(pdev);
	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
	struct sdhci_arasan_data *sdhci_arasan = pltfm_host->priv;

	ret = sdhci_pltfm_unregister(pdev);

	clk_disable_unprepare(sdhci_arasan->clk_ahb);

	return ret;
}

static const struct of_device_id sdhci_arasan_of_match[] = {
	{ .compatible = "arasan,sdhci-8.9a" },
	{ .compatible = "arasan,sdhci-5.1" },
	{ .compatible = "arasan,sdhci-4.9a" },
	{ }
};
MODULE_DEVICE_TABLE(of, sdhci_arasan_of_match);

static struct platform_driver sdhci_arasan_driver = {
	.driver = {
		.name = "sdhci-arasan",
		.of_match_table = sdhci_arasan_of_match,
		.pm = &sdhci_arasan_dev_pm_ops,
	},
	.probe = sdhci_arasan_probe,
	.remove = sdhci_arasan_remove,
};

module_platform_driver(sdhci_arasan_driver);

MODULE_DESCRIPTION("Driver for the Arasan SDHCI Controller");
MODULE_AUTHOR("Soeren Brinkmann <soren.brinkmann@xilinx.com>");
MODULE_LICENSE("GPL");
Commit	Line	Data
e3ec3a3d SB	1	/*
	2	* Arasan Secure Digital Host Controller Interface.
	3	* Copyright (C) 2011 - 2012 Michal Simek <monstr@monstr.eu>
	4	* Copyright (c) 2012 Wind River Systems, Inc.
	5	* Copyright (C) 2013 Pengutronix e.K.
	6	* Copyright (C) 2013 Xilinx Inc.
	7	*
	8	* Based on sdhci-of-esdhc.c
	9	*
	10	* Copyright (c) 2007 Freescale Semiconductor, Inc.
	11	* Copyright (c) 2009 MontaVista Software, Inc.
	12	*
	13	* Authors: Xiaobo Xie <X.Xie@freescale.com>
	14	* Anton Vorontsov <avorontsov@ru.mvista.com>
	15	*
	16	* This program is free software; you can redistribute it and/or modify
	17	* it under the terms of the GNU General Public License as published by
	18	* the Free Software Foundation; either version 2 of the License, or (at
	19	* your option) any later version.
	20	*/
	21
	22	#include <linux/module.h>
308f3f8d	23	#include <linux/of_device.h>
e3ec3a3d SB	24	#include "sdhci-pltfm.h"
	25
	26	#define SDHCI_ARASAN_CLK_CTRL_OFFSET 0x2c
	27
	28	#define CLK_CTRL_TIMEOUT_SHIFT 16
	29	#define CLK_CTRL_TIMEOUT_MASK (0xf << CLK_CTRL_TIMEOUT_SHIFT)
	30	#define CLK_CTRL_TIMEOUT_MIN_EXP 13
	31
	32	/**
	33	* struct sdhci_arasan_data
	34	* @clk_ahb: Pointer to the AHB clock
	35	*/
	36	struct sdhci_arasan_data {
	37	struct clk *clk_ahb;
	38	};
	39
	40	static unsigned int sdhci_arasan_get_timeout_clock(struct sdhci_host *host)
	41	{
	42	u32 div;
	43	unsigned long freq;
	44	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
	45
	46	div = readl(host->ioaddr + SDHCI_ARASAN_CLK_CTRL_OFFSET);
	47	div = (div & CLK_CTRL_TIMEOUT_MASK) >> CLK_CTRL_TIMEOUT_SHIFT;
	48
	49	freq = clk_get_rate(pltfm_host->clk);
	50	freq /= 1 << (CLK_CTRL_TIMEOUT_MIN_EXP + div);
	51
	52	return freq;
	53	}
	54
	55	static struct sdhci_ops sdhci_arasan_ops = {
1771059c	56	.set_clock = sdhci_set_clock,
e3ec3a3d SB	57	.get_max_clock = sdhci_pltfm_clk_get_max_clock,
e3ec3a3d SB	58	.get_timeout_clock = sdhci_arasan_get_timeout_clock,
2317f56c	59	.set_bus_width = sdhci_set_bus_width,
03231f9b	60	.reset = sdhci_reset,
96d7b78c	61	.set_uhs_signaling = sdhci_set_uhs_signaling,
e3ec3a3d SB	62	};
	63
	64	static struct sdhci_pltfm_data sdhci_arasan_pdata = {
	65	.ops = &sdhci_arasan_ops,
2d532d45 SG	66	.quirks = SDHCI_QUIRK_CAP_CLOCK_BASE_BROKEN,
	67	.quirks2 = SDHCI_QUIRK2_PRESET_VALUE_BROKEN \|
	68	SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN,
e3ec3a3d SB	69	};
	70
	71	#ifdef CONFIG_PM_SLEEP
	72	/**
	73	* sdhci_arasan_suspend - Suspend method for the driver
	74	* @dev: Address of the device structure
	75	* Returns 0 on success and error value on error
	76	*
	77	* Put the device in a low power state.
	78	*/
	79	static int sdhci_arasan_suspend(struct device *dev)
	80	{
	81	struct platform_device *pdev = to_platform_device(dev);
	82	struct sdhci_host *host = platform_get_drvdata(pdev);
	83	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
	84	struct sdhci_arasan_data *sdhci_arasan = pltfm_host->priv;
	85	int ret;
	86
	87	ret = sdhci_suspend_host(host);
	88	if (ret)
	89	return ret;
	90
	91	clk_disable(pltfm_host->clk);
	92	clk_disable(sdhci_arasan->clk_ahb);
	93
	94	return 0;
	95	}
	96
	97	/**
	98	* sdhci_arasan_resume - Resume method for the driver
	99	* @dev: Address of the device structure
	100	* Returns 0 on success and error value on error
	101	*
	102	* Resume operation after suspend
	103	*/
	104	static int sdhci_arasan_resume(struct device *dev)
	105	{
	106	struct platform_device *pdev = to_platform_device(dev);
	107	struct sdhci_host *host = platform_get_drvdata(pdev);
	108	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
	109	struct sdhci_arasan_data *sdhci_arasan = pltfm_host->priv;
	110	int ret;
	111
	112	ret = clk_enable(sdhci_arasan->clk_ahb);
	113	if (ret) {
	114	dev_err(dev, "Cannot enable AHB clock.\n");
	115	return ret;
	116	}
	117
	118	ret = clk_enable(pltfm_host->clk);
	119	if (ret) {
	120	dev_err(dev, "Cannot enable SD clock.\n");
	121	clk_disable(sdhci_arasan->clk_ahb);
	122	return ret;
	123	}
	124
	125	return sdhci_resume_host(host);
	126	}
	127	#endif /* ! CONFIG_PM_SLEEP */
	128
	129	static SIMPLE_DEV_PM_OPS(sdhci_arasan_dev_pm_ops, sdhci_arasan_suspend,
	130	sdhci_arasan_resume);
	131
	132	static int sdhci_arasan_probe(struct platform_device *pdev)
133	{
134	int ret;
135	struct clk *clk_xin;
136	struct sdhci_host *host;
137	struct sdhci_pltfm_host *pltfm_host;
138	struct sdhci_arasan_data *sdhci_arasan;
139
140	sdhci_arasan = devm_kzalloc(&pdev->dev, sizeof(*sdhci_arasan),
141	GFP_KERNEL);
142	if (!sdhci_arasan)
143	return -ENOMEM;
144
145	sdhci_arasan->clk_ahb = devm_clk_get(&pdev->dev, "clk_ahb");
146	if (IS_ERR(sdhci_arasan->clk_ahb)) {
147	dev_err(&pdev->dev, "clk_ahb clock not found.\n");
148	return PTR_ERR(sdhci_arasan->clk_ahb);
149	}
150
151	clk_xin = devm_clk_get(&pdev->dev, "clk_xin");
152	if (IS_ERR(clk_xin)) {
153	dev_err(&pdev->dev, "clk_xin clock not found.\n");
154	return PTR_ERR(clk_xin);
155	}
156
157	ret = clk_prepare_enable(sdhci_arasan->clk_ahb);
158	if (ret) {
159	dev_err(&pdev->dev, "Unable to enable AHB clock.\n");
160	return ret;
161	}
162
163	ret = clk_prepare_enable(clk_xin);
164	if (ret) {
165	dev_err(&pdev->dev, "Unable to enable SD clock.\n");
166	goto clk_dis_ahb;
167	}
168
169	host = sdhci_pltfm_init(pdev, &sdhci_arasan_pdata, 0);
170	if (IS_ERR(host)) {
171	ret = PTR_ERR(host);
e3ec3a3d SB	172	goto clk_disable_all;
	173	}
	174
	175	sdhci_get_of_property(pdev);
	176	pltfm_host = sdhci_priv(host);
	177	pltfm_host->priv = sdhci_arasan;
	178	pltfm_host->clk = clk_xin;
	179
16b23787 MS	180	ret = mmc_of_parse(host->mmc);
	181	if (ret) {
	182	dev_err(&pdev->dev, "parsing dt failed (%u)\n", ret);
	183	goto clk_disable_all;
	184	}
	185
e3ec3a3d	186	ret = sdhci_add_host(host);
b1df9de7	187	if (ret)
e3ec3a3d	188	goto err_pltfm_free;
e3ec3a3d SB	189
	190	return 0;
	191
	192	err_pltfm_free:
	193	sdhci_pltfm_free(pdev);
	194	clk_disable_all:
	195	clk_disable_unprepare(clk_xin);
	196	clk_dis_ahb:
	197	clk_disable_unprepare(sdhci_arasan->clk_ahb);
	198
	199	return ret;
	200	}
	201
	202	static int sdhci_arasan_remove(struct platform_device *pdev)
	203	{
0c7fe32e	204	int ret;
e3ec3a3d SB	205	struct sdhci_host *host = platform_get_drvdata(pdev);
	206	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
	207	struct sdhci_arasan_data *sdhci_arasan = pltfm_host->priv;
	208
0c7fe32e JZ	209	ret = sdhci_pltfm_unregister(pdev);
0c7fe32e JZ	210
e3ec3a3d SB	211	clk_disable_unprepare(sdhci_arasan->clk_ahb);
e3ec3a3d SB	212
0c7fe32e	213	return ret;
e3ec3a3d SB	214	}
	215
	216	static const struct of_device_id sdhci_arasan_of_match[] = {
	217	{ .compatible = "arasan,sdhci-8.9a" },
da795ec2	218	{ .compatible = "arasan,sdhci-5.1" },
308f3f8d	219	{ .compatible = "arasan,sdhci-4.9a" },
e3ec3a3d SB	220	{ }
	221	};
	222	MODULE_DEVICE_TABLE(of, sdhci_arasan_of_match);
	223
	224	static struct platform_driver sdhci_arasan_driver = {
	225	.driver = {
	226	.name = "sdhci-arasan",
e3ec3a3d SB	227	.of_match_table = sdhci_arasan_of_match,
	228	.pm = &sdhci_arasan_dev_pm_ops,
	229	},
	230	.probe = sdhci_arasan_probe,
	231	.remove = sdhci_arasan_remove,
	232	};
	233
	234	module_platform_driver(sdhci_arasan_driver);
	235
	236	MODULE_DESCRIPTION("Driver for the Arasan SDHCI Controller");
	237	MODULE_AUTHOR("Soeren Brinkmann <soren.brinkmann@xilinx.com>");
	238	MODULE_LICENSE("GPL");