xref: /OK3568_Linux_fs/kernel/drivers/mmc/host/tmio_mmc.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Driver for the MMC / SD / SDIO cell found in:
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * TC6393XB TC6391XB TC6387XB T7L66XB ASIC3
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  * Copyright (C) 2017 Renesas Electronics Corporation
8*4882a593Smuzhiyun  * Copyright (C) 2017 Horms Solutions, Simon Horman
9*4882a593Smuzhiyun  * Copyright (C) 2007 Ian Molton
10*4882a593Smuzhiyun  * Copyright (C) 2004 Ian Molton
11*4882a593Smuzhiyun  */
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun #include <linux/delay.h>
14*4882a593Smuzhiyun #include <linux/device.h>
15*4882a593Smuzhiyun #include <linux/mfd/core.h>
16*4882a593Smuzhiyun #include <linux/mfd/tmio.h>
17*4882a593Smuzhiyun #include <linux/mmc/host.h>
18*4882a593Smuzhiyun #include <linux/module.h>
19*4882a593Smuzhiyun #include <linux/pagemap.h>
20*4882a593Smuzhiyun #include <linux/scatterlist.h>
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun #include "tmio_mmc.h"
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun /* Registers specific to this variant */
25*4882a593Smuzhiyun #define CTL_SDIO_REGS		0x100
26*4882a593Smuzhiyun #define CTL_CLK_AND_WAIT_CTL	0x138
27*4882a593Smuzhiyun #define CTL_RESET_SDIO		0x1e0
28*4882a593Smuzhiyun 
tmio_mmc_clk_start(struct tmio_mmc_host * host)29*4882a593Smuzhiyun static void tmio_mmc_clk_start(struct tmio_mmc_host *host)
30*4882a593Smuzhiyun {
31*4882a593Smuzhiyun 	sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, CLK_CTL_SCLKEN |
32*4882a593Smuzhiyun 		sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun 	usleep_range(10000, 11000);
35*4882a593Smuzhiyun 	sd_ctrl_write16(host, CTL_CLK_AND_WAIT_CTL, 0x0100);
36*4882a593Smuzhiyun 	usleep_range(10000, 11000);
37*4882a593Smuzhiyun }
38*4882a593Smuzhiyun 
tmio_mmc_clk_stop(struct tmio_mmc_host * host)39*4882a593Smuzhiyun static void tmio_mmc_clk_stop(struct tmio_mmc_host *host)
40*4882a593Smuzhiyun {
41*4882a593Smuzhiyun 	sd_ctrl_write16(host, CTL_CLK_AND_WAIT_CTL, 0x0000);
42*4882a593Smuzhiyun 	usleep_range(10000, 11000);
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun 	sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, ~CLK_CTL_SCLKEN &
45*4882a593Smuzhiyun 		sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
46*4882a593Smuzhiyun 
47*4882a593Smuzhiyun 	usleep_range(10000, 11000);
48*4882a593Smuzhiyun }
49*4882a593Smuzhiyun 
tmio_mmc_set_clock(struct tmio_mmc_host * host,unsigned int new_clock)50*4882a593Smuzhiyun static void tmio_mmc_set_clock(struct tmio_mmc_host *host,
51*4882a593Smuzhiyun 			       unsigned int new_clock)
52*4882a593Smuzhiyun {
53*4882a593Smuzhiyun 	unsigned int divisor;
54*4882a593Smuzhiyun 	u32 clk = 0;
55*4882a593Smuzhiyun 	int clk_sel;
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun 	if (new_clock == 0) {
58*4882a593Smuzhiyun 		tmio_mmc_clk_stop(host);
59*4882a593Smuzhiyun 		return;
60*4882a593Smuzhiyun 	}
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun 	divisor = host->pdata->hclk / new_clock;
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun 	/* bit7 set: 1/512, ... bit0 set: 1/4, all bits clear: 1/2 */
65*4882a593Smuzhiyun 	clk_sel = (divisor <= 1);
66*4882a593Smuzhiyun 	clk = clk_sel ? 0 : (roundup_pow_of_two(divisor) >> 2);
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun 	host->pdata->set_clk_div(host->pdev, clk_sel);
69*4882a593Smuzhiyun 
70*4882a593Smuzhiyun 	sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, ~CLK_CTL_SCLKEN &
71*4882a593Smuzhiyun 			sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
72*4882a593Smuzhiyun 	sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, clk & CLK_CTL_DIV_MASK);
73*4882a593Smuzhiyun 	usleep_range(10000, 11000);
74*4882a593Smuzhiyun 
75*4882a593Smuzhiyun 	tmio_mmc_clk_start(host);
76*4882a593Smuzhiyun }
77*4882a593Smuzhiyun 
tmio_mmc_reset(struct tmio_mmc_host * host)78*4882a593Smuzhiyun static void tmio_mmc_reset(struct tmio_mmc_host *host)
79*4882a593Smuzhiyun {
80*4882a593Smuzhiyun 	sd_ctrl_write16(host, CTL_RESET_SDIO, 0x0000);
81*4882a593Smuzhiyun 	usleep_range(10000, 11000);
82*4882a593Smuzhiyun 	sd_ctrl_write16(host, CTL_RESET_SDIO, 0x0001);
83*4882a593Smuzhiyun 	usleep_range(10000, 11000);
84*4882a593Smuzhiyun }
85*4882a593Smuzhiyun 
86*4882a593Smuzhiyun #ifdef CONFIG_PM_SLEEP
tmio_mmc_suspend(struct device * dev)87*4882a593Smuzhiyun static int tmio_mmc_suspend(struct device *dev)
88*4882a593Smuzhiyun {
89*4882a593Smuzhiyun 	struct platform_device *pdev = to_platform_device(dev);
90*4882a593Smuzhiyun 	const struct mfd_cell *cell = mfd_get_cell(pdev);
91*4882a593Smuzhiyun 	int ret;
92*4882a593Smuzhiyun 
93*4882a593Smuzhiyun 	ret = pm_runtime_force_suspend(dev);
94*4882a593Smuzhiyun 
95*4882a593Smuzhiyun 	/* Tell MFD core it can disable us now.*/
96*4882a593Smuzhiyun 	if (!ret && cell->disable)
97*4882a593Smuzhiyun 		cell->disable(pdev);
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun 	return ret;
100*4882a593Smuzhiyun }
101*4882a593Smuzhiyun 
tmio_mmc_resume(struct device * dev)102*4882a593Smuzhiyun static int tmio_mmc_resume(struct device *dev)
103*4882a593Smuzhiyun {
104*4882a593Smuzhiyun 	struct platform_device *pdev = to_platform_device(dev);
105*4882a593Smuzhiyun 	const struct mfd_cell *cell = mfd_get_cell(pdev);
106*4882a593Smuzhiyun 	int ret = 0;
107*4882a593Smuzhiyun 
108*4882a593Smuzhiyun 	/* Tell the MFD core we are ready to be enabled */
109*4882a593Smuzhiyun 	if (cell->resume)
110*4882a593Smuzhiyun 		ret = cell->resume(pdev);
111*4882a593Smuzhiyun 
112*4882a593Smuzhiyun 	if (!ret)
113*4882a593Smuzhiyun 		ret = pm_runtime_force_resume(dev);
114*4882a593Smuzhiyun 
115*4882a593Smuzhiyun 	return ret;
116*4882a593Smuzhiyun }
117*4882a593Smuzhiyun #endif
118*4882a593Smuzhiyun 
tmio_mmc_probe(struct platform_device * pdev)119*4882a593Smuzhiyun static int tmio_mmc_probe(struct platform_device *pdev)
120*4882a593Smuzhiyun {
121*4882a593Smuzhiyun 	const struct mfd_cell *cell = mfd_get_cell(pdev);
122*4882a593Smuzhiyun 	struct tmio_mmc_data *pdata;
123*4882a593Smuzhiyun 	struct tmio_mmc_host *host;
124*4882a593Smuzhiyun 	struct resource *res;
125*4882a593Smuzhiyun 	int ret = -EINVAL, irq;
126*4882a593Smuzhiyun 
127*4882a593Smuzhiyun 	if (pdev->num_resources != 2)
128*4882a593Smuzhiyun 		goto out;
129*4882a593Smuzhiyun 
130*4882a593Smuzhiyun 	pdata = pdev->dev.platform_data;
131*4882a593Smuzhiyun 	if (!pdata || !pdata->hclk)
132*4882a593Smuzhiyun 		goto out;
133*4882a593Smuzhiyun 
134*4882a593Smuzhiyun 	irq = platform_get_irq(pdev, 0);
135*4882a593Smuzhiyun 	if (irq < 0) {
136*4882a593Smuzhiyun 		ret = irq;
137*4882a593Smuzhiyun 		goto out;
138*4882a593Smuzhiyun 	}
139*4882a593Smuzhiyun 
140*4882a593Smuzhiyun 	/* Tell the MFD core we are ready to be enabled */
141*4882a593Smuzhiyun 	if (cell->enable) {
142*4882a593Smuzhiyun 		ret = cell->enable(pdev);
143*4882a593Smuzhiyun 		if (ret)
144*4882a593Smuzhiyun 			goto out;
145*4882a593Smuzhiyun 	}
146*4882a593Smuzhiyun 
147*4882a593Smuzhiyun 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
148*4882a593Smuzhiyun 	if (!res) {
149*4882a593Smuzhiyun 		ret = -EINVAL;
150*4882a593Smuzhiyun 		goto cell_disable;
151*4882a593Smuzhiyun 	}
152*4882a593Smuzhiyun 
153*4882a593Smuzhiyun 	host = tmio_mmc_host_alloc(pdev, pdata);
154*4882a593Smuzhiyun 	if (IS_ERR(host)) {
155*4882a593Smuzhiyun 		ret = PTR_ERR(host);
156*4882a593Smuzhiyun 		goto cell_disable;
157*4882a593Smuzhiyun 	}
158*4882a593Smuzhiyun 
159*4882a593Smuzhiyun 	/* SD control register space size is 0x200, 0x400 for bus_shift=1 */
160*4882a593Smuzhiyun 	host->bus_shift = resource_size(res) >> 10;
161*4882a593Smuzhiyun 	host->set_clock = tmio_mmc_set_clock;
162*4882a593Smuzhiyun 	host->reset = tmio_mmc_reset;
163*4882a593Smuzhiyun 
164*4882a593Smuzhiyun 	host->mmc->f_max = pdata->hclk;
165*4882a593Smuzhiyun 	host->mmc->f_min = pdata->hclk / 512;
166*4882a593Smuzhiyun 
167*4882a593Smuzhiyun 	ret = tmio_mmc_host_probe(host);
168*4882a593Smuzhiyun 	if (ret)
169*4882a593Smuzhiyun 		goto host_free;
170*4882a593Smuzhiyun 
171*4882a593Smuzhiyun 	ret = devm_request_irq(&pdev->dev, irq, tmio_mmc_irq,
172*4882a593Smuzhiyun 			       IRQF_TRIGGER_FALLING,
173*4882a593Smuzhiyun 			       dev_name(&pdev->dev), host);
174*4882a593Smuzhiyun 	if (ret)
175*4882a593Smuzhiyun 		goto host_remove;
176*4882a593Smuzhiyun 
177*4882a593Smuzhiyun 	pr_info("%s at 0x%08lx irq %d\n", mmc_hostname(host->mmc),
178*4882a593Smuzhiyun 		(unsigned long)host->ctl, irq);
179*4882a593Smuzhiyun 
180*4882a593Smuzhiyun 	return 0;
181*4882a593Smuzhiyun 
182*4882a593Smuzhiyun host_remove:
183*4882a593Smuzhiyun 	tmio_mmc_host_remove(host);
184*4882a593Smuzhiyun host_free:
185*4882a593Smuzhiyun 	tmio_mmc_host_free(host);
186*4882a593Smuzhiyun cell_disable:
187*4882a593Smuzhiyun 	if (cell->disable)
188*4882a593Smuzhiyun 		cell->disable(pdev);
189*4882a593Smuzhiyun out:
190*4882a593Smuzhiyun 	return ret;
191*4882a593Smuzhiyun }
192*4882a593Smuzhiyun 
tmio_mmc_remove(struct platform_device * pdev)193*4882a593Smuzhiyun static int tmio_mmc_remove(struct platform_device *pdev)
194*4882a593Smuzhiyun {
195*4882a593Smuzhiyun 	const struct mfd_cell *cell = mfd_get_cell(pdev);
196*4882a593Smuzhiyun 	struct tmio_mmc_host *host = platform_get_drvdata(pdev);
197*4882a593Smuzhiyun 
198*4882a593Smuzhiyun 	tmio_mmc_host_remove(host);
199*4882a593Smuzhiyun 	if (cell->disable)
200*4882a593Smuzhiyun 		cell->disable(pdev);
201*4882a593Smuzhiyun 
202*4882a593Smuzhiyun 	return 0;
203*4882a593Smuzhiyun }
204*4882a593Smuzhiyun 
205*4882a593Smuzhiyun /* ------------------- device registration ----------------------- */
206*4882a593Smuzhiyun 
207*4882a593Smuzhiyun static const struct dev_pm_ops tmio_mmc_dev_pm_ops = {
208*4882a593Smuzhiyun 	SET_SYSTEM_SLEEP_PM_OPS(tmio_mmc_suspend, tmio_mmc_resume)
209*4882a593Smuzhiyun 	SET_RUNTIME_PM_OPS(tmio_mmc_host_runtime_suspend,
210*4882a593Smuzhiyun 			   tmio_mmc_host_runtime_resume, NULL)
211*4882a593Smuzhiyun };
212*4882a593Smuzhiyun 
213*4882a593Smuzhiyun static struct platform_driver tmio_mmc_driver = {
214*4882a593Smuzhiyun 	.driver = {
215*4882a593Smuzhiyun 		.name = "tmio-mmc",
216*4882a593Smuzhiyun 		.probe_type = PROBE_PREFER_ASYNCHRONOUS,
217*4882a593Smuzhiyun 		.pm = &tmio_mmc_dev_pm_ops,
218*4882a593Smuzhiyun 	},
219*4882a593Smuzhiyun 	.probe = tmio_mmc_probe,
220*4882a593Smuzhiyun 	.remove = tmio_mmc_remove,
221*4882a593Smuzhiyun };
222*4882a593Smuzhiyun 
223*4882a593Smuzhiyun module_platform_driver(tmio_mmc_driver);
224*4882a593Smuzhiyun 
225*4882a593Smuzhiyun MODULE_DESCRIPTION("Toshiba TMIO SD/MMC driver");
226*4882a593Smuzhiyun MODULE_AUTHOR("Ian Molton <spyro@f2s.com>");
227*4882a593Smuzhiyun MODULE_LICENSE("GPL v2");
228*4882a593Smuzhiyun MODULE_ALIAS("platform:tmio-mmc");
229