Blame view

drivers/mmc/host/sdhci-of-arasan.c 21.5 KB
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
  /*
   * 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.
   */
c390f2110   Douglas Anderson   mmc: sdhci-of-ara...
21
  #include <linux/clk-provider.h>
3ea4666e8   Douglas Anderson   mmc: sdhci-of-ara...
22
  #include <linux/mfd/syscon.h>
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
23
  #include <linux/module.h>
308f3f8d8   Suman Tripathi   mmc: sdhci-of-ara...
24
  #include <linux/of_device.h>
91aa36610   Shawn Lin   mmc: sdhci-of-ara...
25
  #include <linux/phy/phy.h>
3ea4666e8   Douglas Anderson   mmc: sdhci-of-ara...
26
  #include <linux/regmap.h>
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
27
  #include "sdhci-pltfm.h"
3794c5426   Zach Brown   mmc: sdhci-of-ara...
28
  #include <linux/of.h>
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
29
30
  
  #define SDHCI_ARASAN_CLK_CTRL_OFFSET	0x2c
a05c84651   Shawn Lin   mmc: sdhci-of-ara...
31
  #define SDHCI_ARASAN_VENDOR_REGISTER	0x78
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
32

a05c84651   Shawn Lin   mmc: sdhci-of-ara...
33
  #define VENDOR_ENHANCED_STROBE		BIT(0)
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
34
35
36
  #define CLK_CTRL_TIMEOUT_SHIFT		16
  #define CLK_CTRL_TIMEOUT_MASK		(0xf << CLK_CTRL_TIMEOUT_SHIFT)
  #define CLK_CTRL_TIMEOUT_MIN_EXP	13
b2db9c674   Douglas Anderson   mmc: sdhci-of-ara...
37
  #define PHY_CLK_TOO_SLOW_HZ		400000
3ea4666e8   Douglas Anderson   mmc: sdhci-of-ara...
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
  /*
   * On some SoCs the syscon area has a feature where the upper 16-bits of
   * each 32-bit register act as a write mask for the lower 16-bits.  This allows
   * atomic updates of the register without locking.  This macro is used on SoCs
   * that have that feature.
   */
  #define HIWORD_UPDATE(val, mask, shift) \
  		((val) << (shift) | (mask) << ((shift) + 16))
  
  /**
   * struct sdhci_arasan_soc_ctl_field - Field used in sdhci_arasan_soc_ctl_map
   *
   * @reg:	Offset within the syscon of the register containing this field
   * @width:	Number of bits for this field
   * @shift:	Bit offset within @reg of this field (or -1 if not avail)
   */
  struct sdhci_arasan_soc_ctl_field {
  	u32 reg;
  	u16 width;
  	s16 shift;
  };
  
  /**
   * struct sdhci_arasan_soc_ctl_map - Map in syscon to corecfg registers
   *
   * It's up to the licensee of the Arsan IP block to make these available
   * somewhere if needed.  Presumably these will be scattered somewhere that's
   * accessible via the syscon API.
   *
   * @baseclkfreq:	Where to find corecfg_baseclkfreq
b2ca77c98   Shawn Lin   mmc: sdhci-of-ara...
68
   * @clockmultiplier:	Where to find corecfg_clockmultiplier
3ea4666e8   Douglas Anderson   mmc: sdhci-of-ara...
69
70
71
72
   * @hiword_update:	If true, use HIWORD_UPDATE to access the syscon
   */
  struct sdhci_arasan_soc_ctl_map {
  	struct sdhci_arasan_soc_ctl_field	baseclkfreq;
b2ca77c98   Shawn Lin   mmc: sdhci-of-ara...
73
  	struct sdhci_arasan_soc_ctl_field	clockmultiplier;
3ea4666e8   Douglas Anderson   mmc: sdhci-of-ara...
74
75
  	bool					hiword_update;
  };
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
76
77
  /**
   * struct sdhci_arasan_data
c390f2110   Douglas Anderson   mmc: sdhci-of-ara...
78
   * @host:		Pointer to the main SDHCI host structure.
3ea4666e8   Douglas Anderson   mmc: sdhci-of-ara...
79
80
   * @clk_ahb:		Pointer to the AHB clock
   * @phy:		Pointer to the generic phy
b2db9c674   Douglas Anderson   mmc: sdhci-of-ara...
81
   * @is_phy_on:		True if the PHY is on; false if not.
c390f2110   Douglas Anderson   mmc: sdhci-of-ara...
82
83
   * @sdcardclk_hw:	Struct for the clock we might provide to a PHY.
   * @sdcardclk:		Pointer to normal 'struct clock' for sdcardclk_hw.
3ea4666e8   Douglas Anderson   mmc: sdhci-of-ara...
84
85
   * @soc_ctl_base:	Pointer to regmap for syscon for soc_ctl registers.
   * @soc_ctl_map:	Map to get offsets into soc_ctl registers.
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
86
87
   */
  struct sdhci_arasan_data {
c390f2110   Douglas Anderson   mmc: sdhci-of-ara...
88
  	struct sdhci_host *host;
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
89
  	struct clk	*clk_ahb;
91aa36610   Shawn Lin   mmc: sdhci-of-ara...
90
  	struct phy	*phy;
b2db9c674   Douglas Anderson   mmc: sdhci-of-ara...
91
  	bool		is_phy_on;
3ea4666e8   Douglas Anderson   mmc: sdhci-of-ara...
92

c390f2110   Douglas Anderson   mmc: sdhci-of-ara...
93
94
  	struct clk_hw	sdcardclk_hw;
  	struct clk      *sdcardclk;
3ea4666e8   Douglas Anderson   mmc: sdhci-of-ara...
95
96
  	struct regmap	*soc_ctl_base;
  	const struct sdhci_arasan_soc_ctl_map *soc_ctl_map;
3794c5426   Zach Brown   mmc: sdhci-of-ara...
97
98
99
100
  	unsigned int	quirks; /* Arasan deviations from spec */
  
  /* Controller does not have CD wired and will not function normally without */
  #define SDHCI_ARASAN_QUIRK_FORCE_CDTEST	BIT(0)
3ea4666e8   Douglas Anderson   mmc: sdhci-of-ara...
101
102
103
104
  };
  
  static const struct sdhci_arasan_soc_ctl_map rk3399_soc_ctl_map = {
  	.baseclkfreq = { .reg = 0xf000, .width = 8, .shift = 8 },
b2ca77c98   Shawn Lin   mmc: sdhci-of-ara...
105
  	.clockmultiplier = { .reg = 0xf02c, .width = 8, .shift = 0},
3ea4666e8   Douglas Anderson   mmc: sdhci-of-ara...
106
  	.hiword_update = true,
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
107
  };
3ea4666e8   Douglas Anderson   mmc: sdhci-of-ara...
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
  /**
   * sdhci_arasan_syscon_write - Write to a field in soc_ctl registers
   *
   * This function allows writing to fields in sdhci_arasan_soc_ctl_map.
   * Note that if a field is specified as not available (shift < 0) then
   * this function will silently return an error code.  It will be noisy
   * and print errors for any other (unexpected) errors.
   *
   * @host:	The sdhci_host
   * @fld:	The field to write to
   * @val:	The value to write
   */
  static int sdhci_arasan_syscon_write(struct sdhci_host *host,
  				   const struct sdhci_arasan_soc_ctl_field *fld,
  				   u32 val)
  {
  	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
  	struct sdhci_arasan_data *sdhci_arasan = sdhci_pltfm_priv(pltfm_host);
  	struct regmap *soc_ctl_base = sdhci_arasan->soc_ctl_base;
  	u32 reg = fld->reg;
  	u16 width = fld->width;
  	s16 shift = fld->shift;
  	int ret;
  
  	/*
  	 * Silently return errors for shift < 0 so caller doesn't have
  	 * to check for fields which are optional.  For fields that
  	 * are required then caller needs to do something special
  	 * anyway.
  	 */
  	if (shift < 0)
  		return -EINVAL;
  
  	if (sdhci_arasan->soc_ctl_map->hiword_update)
  		ret = regmap_write(soc_ctl_base, reg,
  				   HIWORD_UPDATE(val, GENMASK(width, 0),
  						 shift));
  	else
  		ret = regmap_update_bits(soc_ctl_base, reg,
  					 GENMASK(shift + width, shift),
  					 val << shift);
  
  	/* Yell about (unexpected) regmap errors */
  	if (ret)
  		pr_warn("%s: Regmap write fail: %d
  ",
  			 mmc_hostname(host->mmc), ret);
  
  	return ret;
  }
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
158
159
160
161
162
163
164
165
166
167
168
169
170
171
  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;
  }
802ac39a5   Shawn Lin   mmc: sdhci-of-ara...
172
173
174
175
  static void sdhci_arasan_set_clock(struct sdhci_host *host, unsigned int clock)
  {
  	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
  	struct sdhci_arasan_data *sdhci_arasan = sdhci_pltfm_priv(pltfm_host);
6fc09244d   Douglas Anderson   mmc: sdhci-of-ara...
176
  	bool ctrl_phy = false;
802ac39a5   Shawn Lin   mmc: sdhci-of-ara...
177

b2db9c674   Douglas Anderson   mmc: sdhci-of-ara...
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
  	if (!IS_ERR(sdhci_arasan->phy)) {
  		if (!sdhci_arasan->is_phy_on && clock <= PHY_CLK_TOO_SLOW_HZ) {
  			/*
  			 * If PHY off, set clock to max speed and power PHY on.
  			 *
  			 * Although PHY docs apparently suggest power cycling
  			 * when changing the clock the PHY doesn't like to be
  			 * powered on while at low speeds like those used in ID
  			 * mode.  Even worse is powering the PHY on while the
  			 * clock is off.
  			 *
  			 * To workaround the PHY limitations, the best we can
  			 * do is to power it on at a faster speed and then slam
  			 * through low speeds without power cycling.
  			 */
  			sdhci_set_clock(host, host->max_clk);
  			spin_unlock_irq(&host->lock);
  			phy_power_on(sdhci_arasan->phy);
  			spin_lock_irq(&host->lock);
  			sdhci_arasan->is_phy_on = true;
  
  			/*
  			 * We'll now fall through to the below case with
  			 * ctrl_phy = false (so we won't turn off/on).  The
  			 * sdhci_set_clock() will set the real clock.
  			 */
  		} else if (clock > PHY_CLK_TOO_SLOW_HZ) {
  			/*
  			 * At higher clock speeds the PHY is fine being power
  			 * cycled and docs say you _should_ power cycle when
  			 * changing clock speeds.
  			 */
  			ctrl_phy = true;
  		}
  	}
802ac39a5   Shawn Lin   mmc: sdhci-of-ara...
213

b2db9c674   Douglas Anderson   mmc: sdhci-of-ara...
214
  	if (ctrl_phy && sdhci_arasan->is_phy_on) {
802ac39a5   Shawn Lin   mmc: sdhci-of-ara...
215
216
217
  		spin_unlock_irq(&host->lock);
  		phy_power_off(sdhci_arasan->phy);
  		spin_lock_irq(&host->lock);
b2db9c674   Douglas Anderson   mmc: sdhci-of-ara...
218
  		sdhci_arasan->is_phy_on = false;
802ac39a5   Shawn Lin   mmc: sdhci-of-ara...
219
220
221
  	}
  
  	sdhci_set_clock(host, clock);
6fc09244d   Douglas Anderson   mmc: sdhci-of-ara...
222
  	if (ctrl_phy) {
802ac39a5   Shawn Lin   mmc: sdhci-of-ara...
223
224
225
  		spin_unlock_irq(&host->lock);
  		phy_power_on(sdhci_arasan->phy);
  		spin_lock_irq(&host->lock);
b2db9c674   Douglas Anderson   mmc: sdhci-of-ara...
226
  		sdhci_arasan->is_phy_on = true;
802ac39a5   Shawn Lin   mmc: sdhci-of-ara...
227
228
  	}
  }
a05c84651   Shawn Lin   mmc: sdhci-of-ara...
229
230
231
232
233
234
235
236
237
238
239
240
241
242
  static void sdhci_arasan_hs400_enhanced_strobe(struct mmc_host *mmc,
  					struct mmc_ios *ios)
  {
  	u32 vendor;
  	struct sdhci_host *host = mmc_priv(mmc);
  
  	vendor = readl(host->ioaddr + SDHCI_ARASAN_VENDOR_REGISTER);
  	if (ios->enhanced_strobe)
  		vendor |= VENDOR_ENHANCED_STROBE;
  	else
  		vendor &= ~VENDOR_ENHANCED_STROBE;
  
  	writel(vendor, host->ioaddr + SDHCI_ARASAN_VENDOR_REGISTER);
  }
13d62fd26   Wei Yongjun   mmc: sdhci-of-ara...
243
  static void sdhci_arasan_reset(struct sdhci_host *host, u8 mask)
3794c5426   Zach Brown   mmc: sdhci-of-ara...
244
245
246
247
248
249
250
251
252
253
254
255
256
  {
  	u8 ctrl;
  	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
  	struct sdhci_arasan_data *sdhci_arasan = sdhci_pltfm_priv(pltfm_host);
  
  	sdhci_reset(host, mask);
  
  	if (sdhci_arasan->quirks & SDHCI_ARASAN_QUIRK_FORCE_CDTEST) {
  		ctrl = sdhci_readb(host, SDHCI_HOST_CONTROL);
  		ctrl |= SDHCI_CTRL_CDTEST_INS | SDHCI_CTRL_CDTEST_EN;
  		sdhci_writeb(host, ctrl, SDHCI_HOST_CONTROL);
  	}
  }
8a3bee9b1   Shawn Lin   mmc: sdhci-of-ara...
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
  static int sdhci_arasan_voltage_switch(struct mmc_host *mmc,
  				       struct mmc_ios *ios)
  {
  	switch (ios->signal_voltage) {
  	case MMC_SIGNAL_VOLTAGE_180:
  		/*
  		 * Plese don't switch to 1V8 as arasan,5.1 doesn't
  		 * actually refer to this setting to indicate the
  		 * signal voltage and the state machine will be broken
  		 * actually if we force to enable 1V8. That's something
  		 * like broken quirk but we could work around here.
  		 */
  		return 0;
  	case MMC_SIGNAL_VOLTAGE_330:
  	case MMC_SIGNAL_VOLTAGE_120:
  		/* We don't support 3V3 and 1V2 */
  		break;
  	}
  
  	return -EINVAL;
  }
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
278
  static struct sdhci_ops sdhci_arasan_ops = {
802ac39a5   Shawn Lin   mmc: sdhci-of-ara...
279
  	.set_clock = sdhci_arasan_set_clock,
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
280
281
  	.get_max_clock = sdhci_pltfm_clk_get_max_clock,
  	.get_timeout_clock = sdhci_arasan_get_timeout_clock,
2317f56c0   Russell King   mmc: sdhci: conve...
282
  	.set_bus_width = sdhci_set_bus_width,
3794c5426   Zach Brown   mmc: sdhci-of-ara...
283
  	.reset = sdhci_arasan_reset,
96d7b78cf   Russell King   mmc: sdhci: conve...
284
  	.set_uhs_signaling = sdhci_set_uhs_signaling,
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
285
286
287
288
  };
  
  static struct sdhci_pltfm_data sdhci_arasan_pdata = {
  	.ops = &sdhci_arasan_ops,
2d532d458   Suneel Garapati   mmc: sdhci-of-ara...
289
290
291
  	.quirks = SDHCI_QUIRK_CAP_CLOCK_BASE_BROKEN,
  	.quirks2 = SDHCI_QUIRK2_PRESET_VALUE_BROKEN |
  			SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN,
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
  };
  
  #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);
89211418c   Jisheng Zhang   mmc: sdhci-of-ara...
307
  	struct sdhci_arasan_data *sdhci_arasan = sdhci_pltfm_priv(pltfm_host);
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
308
309
310
311
312
  	int ret;
  
  	ret = sdhci_suspend_host(host);
  	if (ret)
  		return ret;
b2db9c674   Douglas Anderson   mmc: sdhci-of-ara...
313
  	if (!IS_ERR(sdhci_arasan->phy) && sdhci_arasan->is_phy_on) {
91aa36610   Shawn Lin   mmc: sdhci-of-ara...
314
315
316
317
318
319
320
  		ret = phy_power_off(sdhci_arasan->phy);
  		if (ret) {
  			dev_err(dev, "Cannot power off phy.
  ");
  			sdhci_resume_host(host);
  			return ret;
  		}
b2db9c674   Douglas Anderson   mmc: sdhci-of-ara...
321
  		sdhci_arasan->is_phy_on = false;
91aa36610   Shawn Lin   mmc: sdhci-of-ara...
322
  	}
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
  	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);
89211418c   Jisheng Zhang   mmc: sdhci-of-ara...
341
  	struct sdhci_arasan_data *sdhci_arasan = sdhci_pltfm_priv(pltfm_host);
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
342
343
344
345
346
347
348
349
350
351
352
353
354
  	int ret;
  
  	ret = clk_enable(sdhci_arasan->clk_ahb);
  	if (ret) {
  		dev_err(dev, "Cannot enable AHB clock.
  ");
  		return ret;
  	}
  
  	ret = clk_enable(pltfm_host->clk);
  	if (ret) {
  		dev_err(dev, "Cannot enable SD clock.
  ");
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
355
356
  		return ret;
  	}
b2db9c674   Douglas Anderson   mmc: sdhci-of-ara...
357
  	if (!IS_ERR(sdhci_arasan->phy) && host->mmc->actual_clock) {
91aa36610   Shawn Lin   mmc: sdhci-of-ara...
358
359
360
361
362
363
  		ret = phy_power_on(sdhci_arasan->phy);
  		if (ret) {
  			dev_err(dev, "Cannot power on phy.
  ");
  			return ret;
  		}
b2db9c674   Douglas Anderson   mmc: sdhci-of-ara...
364
  		sdhci_arasan->is_phy_on = true;
91aa36610   Shawn Lin   mmc: sdhci-of-ara...
365
  	}
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
366
367
368
369
370
371
  	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);
3ea4666e8   Douglas Anderson   mmc: sdhci-of-ara...
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
  static const struct of_device_id sdhci_arasan_of_match[] = {
  	/* SoC-specific compatible strings w/ soc_ctl_map */
  	{
  		.compatible = "rockchip,rk3399-sdhci-5.1",
  		.data = &rk3399_soc_ctl_map,
  	},
  
  	/* Generic compatible below here */
  	{ .compatible = "arasan,sdhci-8.9a" },
  	{ .compatible = "arasan,sdhci-5.1" },
  	{ .compatible = "arasan,sdhci-4.9a" },
  
  	{ /* sentinel */ }
  };
  MODULE_DEVICE_TABLE(of, sdhci_arasan_of_match);
  
  /**
c390f2110   Douglas Anderson   mmc: sdhci-of-ara...
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
   * sdhci_arasan_sdcardclk_recalc_rate - Return the card clock rate
   *
   * Return the current actual rate of the SD card clock.  This can be used
   * to communicate with out PHY.
   *
   * @hw:			Pointer to the hardware clock structure.
   * @parent_rate		The parent rate (should be rate of clk_xin).
   * Returns the card clock rate.
   */
  static unsigned long sdhci_arasan_sdcardclk_recalc_rate(struct clk_hw *hw,
  						      unsigned long parent_rate)
  
  {
  	struct sdhci_arasan_data *sdhci_arasan =
  		container_of(hw, struct sdhci_arasan_data, sdcardclk_hw);
  	struct sdhci_host *host = sdhci_arasan->host;
  
  	return host->mmc->actual_clock;
  }
  
  static const struct clk_ops arasan_sdcardclk_ops = {
  	.recalc_rate = sdhci_arasan_sdcardclk_recalc_rate,
  };
  
  /**
b2ca77c98   Shawn Lin   mmc: sdhci-of-ara...
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
   * sdhci_arasan_update_clockmultiplier - Set corecfg_clockmultiplier
   *
   * The corecfg_clockmultiplier is supposed to contain clock multiplier
   * value of programmable clock generator.
   *
   * NOTES:
   * - Many existing devices don't seem to do this and work fine.  To keep
   *   compatibility for old hardware where the device tree doesn't provide a
   *   register map, this function is a noop if a soc_ctl_map hasn't been provided
   *   for this platform.
   * - The value of corecfg_clockmultiplier should sync with that of corresponding
   *   value reading from sdhci_capability_register. So this function is called
   *   once at probe time and never called again.
   *
   * @host:		The sdhci_host
   */
  static void sdhci_arasan_update_clockmultiplier(struct sdhci_host *host,
  						u32 value)
  {
  	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
  	struct sdhci_arasan_data *sdhci_arasan = sdhci_pltfm_priv(pltfm_host);
  	const struct sdhci_arasan_soc_ctl_map *soc_ctl_map =
  		sdhci_arasan->soc_ctl_map;
  
  	/* Having a map is optional */
  	if (!soc_ctl_map)
  		return;
  
  	/* If we have a map, we expect to have a syscon */
  	if (!sdhci_arasan->soc_ctl_base) {
  		pr_warn("%s: Have regmap, but no soc-ctl-syscon
  ",
  			mmc_hostname(host->mmc));
  		return;
  	}
  
  	sdhci_arasan_syscon_write(host, &soc_ctl_map->clockmultiplier, value);
  }
  
  /**
3ea4666e8   Douglas Anderson   mmc: sdhci-of-ara...
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
   * sdhci_arasan_update_baseclkfreq - Set corecfg_baseclkfreq
   *
   * The corecfg_baseclkfreq is supposed to contain the MHz of clk_xin.  This
   * function can be used to make that happen.
   *
   * NOTES:
   * - Many existing devices don't seem to do this and work fine.  To keep
   *   compatibility for old hardware where the device tree doesn't provide a
   *   register map, this function is a noop if a soc_ctl_map hasn't been provided
   *   for this platform.
   * - It's assumed that clk_xin is not dynamic and that we use the SDHCI divider
   *   to achieve lower clock rates.  That means that this function is called once
   *   at probe time and never called again.
   *
   * @host:		The sdhci_host
   */
  static void sdhci_arasan_update_baseclkfreq(struct sdhci_host *host)
  {
  	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
  	struct sdhci_arasan_data *sdhci_arasan = sdhci_pltfm_priv(pltfm_host);
  	const struct sdhci_arasan_soc_ctl_map *soc_ctl_map =
  		sdhci_arasan->soc_ctl_map;
  	u32 mhz = DIV_ROUND_CLOSEST(clk_get_rate(pltfm_host->clk), 1000000);
  
  	/* Having a map is optional */
  	if (!soc_ctl_map)
  		return;
  
  	/* If we have a map, we expect to have a syscon */
  	if (!sdhci_arasan->soc_ctl_base) {
  		pr_warn("%s: Have regmap, but no soc-ctl-syscon
  ",
  			mmc_hostname(host->mmc));
  		return;
  	}
  
  	sdhci_arasan_syscon_write(host, &soc_ctl_map->baseclkfreq, mhz);
  }
c390f2110   Douglas Anderson   mmc: sdhci-of-ara...
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
  /**
   * sdhci_arasan_register_sdclk - Register the sdclk for a PHY to use
   *
   * Some PHY devices need to know what the actual card clock is.  In order for
   * them to find out, we'll provide a clock through the common clock framework
   * for them to query.
   *
   * Note: without seriously re-architecting SDHCI's clock code and testing on
   * all platforms, there's no way to create a totally beautiful clock here
   * with all clock ops implemented.  Instead, we'll just create a clock that can
   * be queried and set the CLK_GET_RATE_NOCACHE attribute to tell common clock
   * framework that we're doing things behind its back.  This should be sufficient
   * to create nice clean device tree bindings and later (if needed) we can try
   * re-architecting SDHCI if we see some benefit to it.
   *
   * @sdhci_arasan:	Our private data structure.
   * @clk_xin:		Pointer to the functional clock
   * @dev:		Pointer to our struct device.
   * Returns 0 on success and error value on error
   */
  static int sdhci_arasan_register_sdclk(struct sdhci_arasan_data *sdhci_arasan,
  				       struct clk *clk_xin,
  				       struct device *dev)
  {
  	struct device_node *np = dev->of_node;
  	struct clk_init_data sdcardclk_init;
  	const char *parent_clk_name;
  	int ret;
  
  	/* Providing a clock to the PHY is optional; no error if missing */
  	if (!of_find_property(np, "#clock-cells", NULL))
  		return 0;
  
  	ret = of_property_read_string_index(np, "clock-output-names", 0,
  					    &sdcardclk_init.name);
  	if (ret) {
  		dev_err(dev, "DT has #clock-cells but no clock-output-names
  ");
  		return ret;
  	}
  
  	parent_clk_name = __clk_get_name(clk_xin);
  	sdcardclk_init.parent_names = &parent_clk_name;
  	sdcardclk_init.num_parents = 1;
  	sdcardclk_init.flags = CLK_GET_RATE_NOCACHE;
  	sdcardclk_init.ops = &arasan_sdcardclk_ops;
  
  	sdhci_arasan->sdcardclk_hw.init = &sdcardclk_init;
  	sdhci_arasan->sdcardclk =
  		devm_clk_register(dev, &sdhci_arasan->sdcardclk_hw);
  	sdhci_arasan->sdcardclk_hw.init = NULL;
  
  	ret = of_clk_add_provider(np, of_clk_src_simple_get,
  				  sdhci_arasan->sdcardclk);
  	if (ret)
  		dev_err(dev, "Failed to add clock provider
  ");
  
  	return ret;
  }
  
  /**
   * sdhci_arasan_unregister_sdclk - Undoes sdhci_arasan_register_sdclk()
   *
   * Should be called any time we're exiting and sdhci_arasan_register_sdclk()
   * returned success.
   *
   * @dev:		Pointer to our struct device.
   */
  static void sdhci_arasan_unregister_sdclk(struct device *dev)
  {
  	struct device_node *np = dev->of_node;
  
  	if (!of_find_property(np, "#clock-cells", NULL))
  		return;
  
  	of_clk_del_provider(dev->of_node);
  }
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
570
571
572
  static int sdhci_arasan_probe(struct platform_device *pdev)
  {
  	int ret;
3ea4666e8   Douglas Anderson   mmc: sdhci-of-ara...
573
574
  	const struct of_device_id *match;
  	struct device_node *node;
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
575
576
577
578
  	struct clk *clk_xin;
  	struct sdhci_host *host;
  	struct sdhci_pltfm_host *pltfm_host;
  	struct sdhci_arasan_data *sdhci_arasan;
3794c5426   Zach Brown   mmc: sdhci-of-ara...
579
  	struct device_node *np = pdev->dev.of_node;
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
580

89211418c   Jisheng Zhang   mmc: sdhci-of-ara...
581
582
583
584
585
586
587
  	host = sdhci_pltfm_init(pdev, &sdhci_arasan_pdata,
  				sizeof(*sdhci_arasan));
  	if (IS_ERR(host))
  		return PTR_ERR(host);
  
  	pltfm_host = sdhci_priv(host);
  	sdhci_arasan = sdhci_pltfm_priv(pltfm_host);
c390f2110   Douglas Anderson   mmc: sdhci-of-ara...
588
  	sdhci_arasan->host = host;
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
589

3ea4666e8   Douglas Anderson   mmc: sdhci-of-ara...
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
  	match = of_match_node(sdhci_arasan_of_match, pdev->dev.of_node);
  	sdhci_arasan->soc_ctl_map = match->data;
  
  	node = of_parse_phandle(pdev->dev.of_node, "arasan,soc-ctl-syscon", 0);
  	if (node) {
  		sdhci_arasan->soc_ctl_base = syscon_node_to_regmap(node);
  		of_node_put(node);
  
  		if (IS_ERR(sdhci_arasan->soc_ctl_base)) {
  			ret = PTR_ERR(sdhci_arasan->soc_ctl_base);
  			if (ret != -EPROBE_DEFER)
  				dev_err(&pdev->dev, "Can't get syscon: %d
  ",
  					ret);
  			goto err_pltfm_free;
  		}
  	}
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
607
608
609
610
  	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.
  ");
278d09624   Shawn Lin   mmc: sdhci-of-ara...
611
612
  		ret = PTR_ERR(sdhci_arasan->clk_ahb);
  		goto err_pltfm_free;
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
613
614
615
616
617
618
  	}
  
  	clk_xin = devm_clk_get(&pdev->dev, "clk_xin");
  	if (IS_ERR(clk_xin)) {
  		dev_err(&pdev->dev, "clk_xin clock not found.
  ");
278d09624   Shawn Lin   mmc: sdhci-of-ara...
619
620
  		ret = PTR_ERR(clk_xin);
  		goto err_pltfm_free;
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
621
622
623
624
625
626
  	}
  
  	ret = clk_prepare_enable(sdhci_arasan->clk_ahb);
  	if (ret) {
  		dev_err(&pdev->dev, "Unable to enable AHB clock.
  ");
278d09624   Shawn Lin   mmc: sdhci-of-ara...
627
  		goto err_pltfm_free;
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
628
629
630
631
632
633
634
635
  	}
  
  	ret = clk_prepare_enable(clk_xin);
  	if (ret) {
  		dev_err(&pdev->dev, "Unable to enable SD clock.
  ");
  		goto clk_dis_ahb;
  	}
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
636
  	sdhci_get_of_property(pdev);
3794c5426   Zach Brown   mmc: sdhci-of-ara...
637
638
639
  
  	if (of_property_read_bool(np, "xlnx,fails-without-test-cd"))
  		sdhci_arasan->quirks |= SDHCI_ARASAN_QUIRK_FORCE_CDTEST;
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
640
  	pltfm_host->clk = clk_xin;
b2ca77c98   Shawn Lin   mmc: sdhci-of-ara...
641
642
643
  	if (of_device_is_compatible(pdev->dev.of_node,
  				    "rockchip,rk3399-sdhci-5.1"))
  		sdhci_arasan_update_clockmultiplier(host, 0x0);
3ea4666e8   Douglas Anderson   mmc: sdhci-of-ara...
644
  	sdhci_arasan_update_baseclkfreq(host);
c390f2110   Douglas Anderson   mmc: sdhci-of-ara...
645
646
647
  	ret = sdhci_arasan_register_sdclk(sdhci_arasan, clk_xin, &pdev->dev);
  	if (ret)
  		goto clk_disable_all;
16b23787f   Michal Simek   mmc: sdhci-of-ara...
648
649
650
651
  	ret = mmc_of_parse(host->mmc);
  	if (ret) {
  		dev_err(&pdev->dev, "parsing dt failed (%u)
  ", ret);
c390f2110   Douglas Anderson   mmc: sdhci-of-ara...
652
  		goto unreg_clk;
16b23787f   Michal Simek   mmc: sdhci-of-ara...
653
  	}
91aa36610   Shawn Lin   mmc: sdhci-of-ara...
654
655
656
657
658
659
660
661
662
  	sdhci_arasan->phy = ERR_PTR(-ENODEV);
  	if (of_device_is_compatible(pdev->dev.of_node,
  				    "arasan,sdhci-5.1")) {
  		sdhci_arasan->phy = devm_phy_get(&pdev->dev,
  						 "phy_arasan");
  		if (IS_ERR(sdhci_arasan->phy)) {
  			ret = PTR_ERR(sdhci_arasan->phy);
  			dev_err(&pdev->dev, "No phy for arasan,sdhci-5.1.
  ");
c390f2110   Douglas Anderson   mmc: sdhci-of-ara...
663
  			goto unreg_clk;
91aa36610   Shawn Lin   mmc: sdhci-of-ara...
664
665
666
667
668
669
  		}
  
  		ret = phy_init(sdhci_arasan->phy);
  		if (ret < 0) {
  			dev_err(&pdev->dev, "phy_init err.
  ");
c390f2110   Douglas Anderson   mmc: sdhci-of-ara...
670
  			goto unreg_clk;
91aa36610   Shawn Lin   mmc: sdhci-of-ara...
671
  		}
a05c84651   Shawn Lin   mmc: sdhci-of-ara...
672
673
  		host->mmc_host_ops.hs400_enhanced_strobe =
  					sdhci_arasan_hs400_enhanced_strobe;
8a3bee9b1   Shawn Lin   mmc: sdhci-of-ara...
674
675
  		host->mmc_host_ops.start_signal_voltage_switch =
  					sdhci_arasan_voltage_switch;
91aa36610   Shawn Lin   mmc: sdhci-of-ara...
676
  	}
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
677
  	ret = sdhci_add_host(host);
b1df9de75   Mike Looijmans   mmc: sdhci-of-ara...
678
  	if (ret)
91aa36610   Shawn Lin   mmc: sdhci-of-ara...
679
  		goto err_add_host;
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
680
681
  
  	return 0;
91aa36610   Shawn Lin   mmc: sdhci-of-ara...
682
683
  err_add_host:
  	if (!IS_ERR(sdhci_arasan->phy))
91aa36610   Shawn Lin   mmc: sdhci-of-ara...
684
  		phy_exit(sdhci_arasan->phy);
c390f2110   Douglas Anderson   mmc: sdhci-of-ara...
685
686
  unreg_clk:
  	sdhci_arasan_unregister_sdclk(&pdev->dev);
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
687
688
689
690
  clk_disable_all:
  	clk_disable_unprepare(clk_xin);
  clk_dis_ahb:
  	clk_disable_unprepare(sdhci_arasan->clk_ahb);
278d09624   Shawn Lin   mmc: sdhci-of-ara...
691
692
  err_pltfm_free:
  	sdhci_pltfm_free(pdev);
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
693
694
695
696
697
  	return ret;
  }
  
  static int sdhci_arasan_remove(struct platform_device *pdev)
  {
0c7fe32e8   Jisheng Zhang   mmc: sdhci-of-ara...
698
  	int ret;
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
699
700
  	struct sdhci_host *host = platform_get_drvdata(pdev);
  	struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
89211418c   Jisheng Zhang   mmc: sdhci-of-ara...
701
702
  	struct sdhci_arasan_data *sdhci_arasan = sdhci_pltfm_priv(pltfm_host);
  	struct clk *clk_ahb = sdhci_arasan->clk_ahb;
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
703

91aa36610   Shawn Lin   mmc: sdhci-of-ara...
704
  	if (!IS_ERR(sdhci_arasan->phy)) {
b2db9c674   Douglas Anderson   mmc: sdhci-of-ara...
705
706
  		if (sdhci_arasan->is_phy_on)
  			phy_power_off(sdhci_arasan->phy);
91aa36610   Shawn Lin   mmc: sdhci-of-ara...
707
708
  		phy_exit(sdhci_arasan->phy);
  	}
c390f2110   Douglas Anderson   mmc: sdhci-of-ara...
709
  	sdhci_arasan_unregister_sdclk(&pdev->dev);
0c7fe32e8   Jisheng Zhang   mmc: sdhci-of-ara...
710
  	ret = sdhci_pltfm_unregister(pdev);
89211418c   Jisheng Zhang   mmc: sdhci-of-ara...
711
  	clk_disable_unprepare(clk_ahb);
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
712

0c7fe32e8   Jisheng Zhang   mmc: sdhci-of-ara...
713
  	return ret;
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
714
  }
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
715
716
717
  static struct platform_driver sdhci_arasan_driver = {
  	.driver = {
  		.name = "sdhci-arasan",
e3ec3a3d1   Soren Brinkmann   mmc: arasan: Add ...
718
719
720
721
722
723
724
725
726
727
728
729
  		.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");