Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * Exynos Specific Extensions for Synopsys DW Multimedia Card Interface driver
4 *
5 * Copyright (C) 2012, Samsung Electronics Co., Ltd.
6 */
7
8#include <linux/module.h>
9#include <linux/platform_device.h>
10#include <linux/clk.h>
11#include <linux/mmc/host.h>
12#include <linux/mmc/mmc.h>
13#include <linux/of.h>
14#include <linux/of_gpio.h>
15#include <linux/pm_runtime.h>
16#include <linux/slab.h>
17
18#include "dw_mmc.h"
19#include "dw_mmc-pltfm.h"
20#include "dw_mmc-exynos.h"
21
22/* Variations in Exynos specific dw-mshc controller */
23enum dw_mci_exynos_type {
24 DW_MCI_TYPE_EXYNOS4210,
25 DW_MCI_TYPE_EXYNOS4412,
26 DW_MCI_TYPE_EXYNOS5250,
27 DW_MCI_TYPE_EXYNOS5420,
28 DW_MCI_TYPE_EXYNOS5420_SMU,
29 DW_MCI_TYPE_EXYNOS7,
30 DW_MCI_TYPE_EXYNOS7_SMU,
31 DW_MCI_TYPE_ARTPEC8,
32};
33
34/* Exynos implementation specific driver private data */
35struct dw_mci_exynos_priv_data {
36 enum dw_mci_exynos_type ctrl_type;
37 u8 ciu_div;
38 u32 sdr_timing;
39 u32 ddr_timing;
40 u32 hs400_timing;
41 u32 tuned_sample;
42 u32 cur_speed;
43 u32 dqs_delay;
44 u32 saved_dqs_en;
45 u32 saved_strobe_ctrl;
46};
47
48static struct dw_mci_exynos_compatible {
49 char *compatible;
50 enum dw_mci_exynos_type ctrl_type;
51} exynos_compat[] = {
52 {
53 .compatible = "samsung,exynos4210-dw-mshc",
54 .ctrl_type = DW_MCI_TYPE_EXYNOS4210,
55 }, {
56 .compatible = "samsung,exynos4412-dw-mshc",
57 .ctrl_type = DW_MCI_TYPE_EXYNOS4412,
58 }, {
59 .compatible = "samsung,exynos5250-dw-mshc",
60 .ctrl_type = DW_MCI_TYPE_EXYNOS5250,
61 }, {
62 .compatible = "samsung,exynos5420-dw-mshc",
63 .ctrl_type = DW_MCI_TYPE_EXYNOS5420,
64 }, {
65 .compatible = "samsung,exynos5420-dw-mshc-smu",
66 .ctrl_type = DW_MCI_TYPE_EXYNOS5420_SMU,
67 }, {
68 .compatible = "samsung,exynos7-dw-mshc",
69 .ctrl_type = DW_MCI_TYPE_EXYNOS7,
70 }, {
71 .compatible = "samsung,exynos7-dw-mshc-smu",
72 .ctrl_type = DW_MCI_TYPE_EXYNOS7_SMU,
73 }, {
74 .compatible = "axis,artpec8-dw-mshc",
75 .ctrl_type = DW_MCI_TYPE_ARTPEC8,
76 },
77};
78
79static inline u8 dw_mci_exynos_get_ciu_div(struct dw_mci *host)
80{
81 struct dw_mci_exynos_priv_data *priv = host->priv;
82
83 if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS4412)
84 return EXYNOS4412_FIXED_CIU_CLK_DIV;
85 else if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS4210)
86 return EXYNOS4210_FIXED_CIU_CLK_DIV;
87 else if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS7 ||
88 priv->ctrl_type == DW_MCI_TYPE_EXYNOS7_SMU ||
89 priv->ctrl_type == DW_MCI_TYPE_ARTPEC8)
90 return SDMMC_CLKSEL_GET_DIV(mci_readl(host, CLKSEL64)) + 1;
91 else
92 return SDMMC_CLKSEL_GET_DIV(mci_readl(host, CLKSEL)) + 1;
93}
94
95static void dw_mci_exynos_config_smu(struct dw_mci *host)
96{
97 struct dw_mci_exynos_priv_data *priv = host->priv;
98
99 /*
100 * If Exynos is provided the Security management,
101 * set for non-ecryption mode at this time.
102 */
103 if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS5420_SMU ||
104 priv->ctrl_type == DW_MCI_TYPE_EXYNOS7_SMU) {
105 mci_writel(host, MPSBEGIN0, 0);
106 mci_writel(host, MPSEND0, SDMMC_ENDING_SEC_NR_MAX);
107 mci_writel(host, MPSCTRL0, SDMMC_MPSCTRL_SECURE_WRITE_BIT |
108 SDMMC_MPSCTRL_NON_SECURE_READ_BIT |
109 SDMMC_MPSCTRL_VALID |
110 SDMMC_MPSCTRL_NON_SECURE_WRITE_BIT);
111 }
112}
113
114static int dw_mci_exynos_priv_init(struct dw_mci *host)
115{
116 struct dw_mci_exynos_priv_data *priv = host->priv;
117
118 dw_mci_exynos_config_smu(host);
119
120 if (priv->ctrl_type >= DW_MCI_TYPE_EXYNOS5420) {
121 priv->saved_strobe_ctrl = mci_readl(host, HS400_DLINE_CTRL);
122 priv->saved_dqs_en = mci_readl(host, HS400_DQS_EN);
123 priv->saved_dqs_en |= AXI_NON_BLOCKING_WR;
124 mci_writel(host, HS400_DQS_EN, priv->saved_dqs_en);
125 if (!priv->dqs_delay)
126 priv->dqs_delay =
127 DQS_CTRL_GET_RD_DELAY(priv->saved_strobe_ctrl);
128 }
129
130 if (priv->ctrl_type == DW_MCI_TYPE_ARTPEC8) {
131 /* Quirk needed for the ARTPEC-8 SoC */
132 host->quirks |= DW_MMC_QUIRK_EXTENDED_TMOUT;
133 }
134
135 host->bus_hz /= (priv->ciu_div + 1);
136
137 return 0;
138}
139
140static void dw_mci_exynos_set_clksel_timing(struct dw_mci *host, u32 timing)
141{
142 struct dw_mci_exynos_priv_data *priv = host->priv;
143 u32 clksel;
144
145 if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS7 ||
146 priv->ctrl_type == DW_MCI_TYPE_EXYNOS7_SMU ||
147 priv->ctrl_type == DW_MCI_TYPE_ARTPEC8)
148 clksel = mci_readl(host, CLKSEL64);
149 else
150 clksel = mci_readl(host, CLKSEL);
151
152 clksel = (clksel & ~SDMMC_CLKSEL_TIMING_MASK) | timing;
153
154 if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS7 ||
155 priv->ctrl_type == DW_MCI_TYPE_EXYNOS7_SMU ||
156 priv->ctrl_type == DW_MCI_TYPE_ARTPEC8)
157 mci_writel(host, CLKSEL64, clksel);
158 else
159 mci_writel(host, CLKSEL, clksel);
160
161 /*
162 * Exynos4412 and Exynos5250 extends the use of CMD register with the
163 * use of bit 29 (which is reserved on standard MSHC controllers) for
164 * optionally bypassing the HOLD register for command and data. The
165 * HOLD register should be bypassed in case there is no phase shift
166 * applied on CMD/DATA that is sent to the card.
167 */
168 if (!SDMMC_CLKSEL_GET_DRV_WD3(clksel) && host->slot)
169 set_bit(DW_MMC_CARD_NO_USE_HOLD, &host->slot->flags);
170}
171
172#ifdef CONFIG_PM
173static int dw_mci_exynos_runtime_resume(struct device *dev)
174{
175 struct dw_mci *host = dev_get_drvdata(dev);
176 int ret;
177
178 ret = dw_mci_runtime_resume(dev);
179 if (ret)
180 return ret;
181
182 dw_mci_exynos_config_smu(host);
183
184 return ret;
185}
186#endif /* CONFIG_PM */
187
188#ifdef CONFIG_PM_SLEEP
189/**
190 * dw_mci_exynos_suspend_noirq - Exynos-specific suspend code
191 * @dev: Device to suspend (this device)
192 *
193 * This ensures that device will be in runtime active state in
194 * dw_mci_exynos_resume_noirq after calling pm_runtime_force_resume()
195 */
196static int dw_mci_exynos_suspend_noirq(struct device *dev)
197{
198 pm_runtime_get_noresume(dev);
199 return pm_runtime_force_suspend(dev);
200}
201
202/**
203 * dw_mci_exynos_resume_noirq - Exynos-specific resume code
204 * @dev: Device to resume (this device)
205 *
206 * On exynos5420 there is a silicon errata that will sometimes leave the
207 * WAKEUP_INT bit in the CLKSEL register asserted. This bit is 1 to indicate
208 * that it fired and we can clear it by writing a 1 back. Clear it to prevent
209 * interrupts from going off constantly.
210 *
211 * We run this code on all exynos variants because it doesn't hurt.
212 */
213static int dw_mci_exynos_resume_noirq(struct device *dev)
214{
215 struct dw_mci *host = dev_get_drvdata(dev);
216 struct dw_mci_exynos_priv_data *priv = host->priv;
217 u32 clksel;
218 int ret;
219
220 ret = pm_runtime_force_resume(dev);
221 if (ret)
222 return ret;
223
224 if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS7 ||
225 priv->ctrl_type == DW_MCI_TYPE_EXYNOS7_SMU ||
226 priv->ctrl_type == DW_MCI_TYPE_ARTPEC8)
227 clksel = mci_readl(host, CLKSEL64);
228 else
229 clksel = mci_readl(host, CLKSEL);
230
231 if (clksel & SDMMC_CLKSEL_WAKEUP_INT) {
232 if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS7 ||
233 priv->ctrl_type == DW_MCI_TYPE_EXYNOS7_SMU ||
234 priv->ctrl_type == DW_MCI_TYPE_ARTPEC8)
235 mci_writel(host, CLKSEL64, clksel);
236 else
237 mci_writel(host, CLKSEL, clksel);
238 }
239
240 pm_runtime_put(dev);
241
242 return 0;
243}
244#endif /* CONFIG_PM_SLEEP */
245
246static void dw_mci_exynos_config_hs400(struct dw_mci *host, u32 timing)
247{
248 struct dw_mci_exynos_priv_data *priv = host->priv;
249 u32 dqs, strobe;
250
251 /*
252 * Not supported to configure register
253 * related to HS400
254 */
255 if ((priv->ctrl_type < DW_MCI_TYPE_EXYNOS5420) ||
256 (priv->ctrl_type == DW_MCI_TYPE_ARTPEC8)) {
257 if (timing == MMC_TIMING_MMC_HS400)
258 dev_warn(host->dev,
259 "cannot configure HS400, unsupported chipset\n");
260 return;
261 }
262
263 dqs = priv->saved_dqs_en;
264 strobe = priv->saved_strobe_ctrl;
265
266 if (timing == MMC_TIMING_MMC_HS400) {
267 dqs |= DATA_STROBE_EN;
268 strobe = DQS_CTRL_RD_DELAY(strobe, priv->dqs_delay);
269 } else if (timing == MMC_TIMING_UHS_SDR104) {
270 dqs &= 0xffffff00;
271 } else {
272 dqs &= ~DATA_STROBE_EN;
273 }
274
275 mci_writel(host, HS400_DQS_EN, dqs);
276 mci_writel(host, HS400_DLINE_CTRL, strobe);
277}
278
279static void dw_mci_exynos_adjust_clock(struct dw_mci *host, unsigned int wanted)
280{
281 struct dw_mci_exynos_priv_data *priv = host->priv;
282 unsigned long actual;
283 u8 div;
284 int ret;
285 /*
286 * Don't care if wanted clock is zero or
287 * ciu clock is unavailable
288 */
289 if (!wanted || IS_ERR(host->ciu_clk))
290 return;
291
292 /* Guaranteed minimum frequency for cclkin */
293 if (wanted < EXYNOS_CCLKIN_MIN)
294 wanted = EXYNOS_CCLKIN_MIN;
295
296 if (wanted == priv->cur_speed)
297 return;
298
299 div = dw_mci_exynos_get_ciu_div(host);
300 ret = clk_set_rate(host->ciu_clk, wanted * div);
301 if (ret)
302 dev_warn(host->dev,
303 "failed to set clk-rate %u error: %d\n",
304 wanted * div, ret);
305 actual = clk_get_rate(host->ciu_clk);
306 host->bus_hz = actual / div;
307 priv->cur_speed = wanted;
308 host->current_speed = 0;
309}
310
311static void dw_mci_exynos_set_ios(struct dw_mci *host, struct mmc_ios *ios)
312{
313 struct dw_mci_exynos_priv_data *priv = host->priv;
314 unsigned int wanted = ios->clock;
315 u32 timing = ios->timing, clksel;
316
317 switch (timing) {
318 case MMC_TIMING_MMC_HS400:
319 /* Update tuned sample timing */
320 clksel = SDMMC_CLKSEL_UP_SAMPLE(
321 priv->hs400_timing, priv->tuned_sample);
322 wanted <<= 1;
323 break;
324 case MMC_TIMING_MMC_DDR52:
325 clksel = priv->ddr_timing;
326 /* Should be double rate for DDR mode */
327 if (ios->bus_width == MMC_BUS_WIDTH_8)
328 wanted <<= 1;
329 break;
330 case MMC_TIMING_UHS_SDR104:
331 case MMC_TIMING_UHS_SDR50:
332 clksel = (priv->sdr_timing & 0xfff8ffff) |
333 (priv->ciu_div << 16);
334 break;
335 case MMC_TIMING_UHS_DDR50:
336 clksel = (priv->ddr_timing & 0xfff8ffff) |
337 (priv->ciu_div << 16);
338 break;
339 default:
340 clksel = priv->sdr_timing;
341 }
342
343 /* Set clock timing for the requested speed mode*/
344 dw_mci_exynos_set_clksel_timing(host, clksel);
345
346 /* Configure setting for HS400 */
347 dw_mci_exynos_config_hs400(host, timing);
348
349 /* Configure clock rate */
350 dw_mci_exynos_adjust_clock(host, wanted);
351}
352
353static int dw_mci_exynos_parse_dt(struct dw_mci *host)
354{
355 struct dw_mci_exynos_priv_data *priv;
356 struct device_node *np = host->dev->of_node;
357 u32 timing[2];
358 u32 div = 0;
359 int idx;
360 int ret;
361
362 priv = devm_kzalloc(host->dev, sizeof(*priv), GFP_KERNEL);
363 if (!priv)
364 return -ENOMEM;
365
366 for (idx = 0; idx < ARRAY_SIZE(exynos_compat); idx++) {
367 if (of_device_is_compatible(np, exynos_compat[idx].compatible))
368 priv->ctrl_type = exynos_compat[idx].ctrl_type;
369 }
370
371 if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS4412)
372 priv->ciu_div = EXYNOS4412_FIXED_CIU_CLK_DIV - 1;
373 else if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS4210)
374 priv->ciu_div = EXYNOS4210_FIXED_CIU_CLK_DIV - 1;
375 else {
376 of_property_read_u32(np, "samsung,dw-mshc-ciu-div", &div);
377 priv->ciu_div = div;
378 }
379
380 ret = of_property_read_u32_array(np,
381 "samsung,dw-mshc-sdr-timing", timing, 2);
382 if (ret)
383 return ret;
384
385 priv->sdr_timing = SDMMC_CLKSEL_TIMING(timing[0], timing[1], div);
386
387 ret = of_property_read_u32_array(np,
388 "samsung,dw-mshc-ddr-timing", timing, 2);
389 if (ret)
390 return ret;
391
392 priv->ddr_timing = SDMMC_CLKSEL_TIMING(timing[0], timing[1], div);
393
394 ret = of_property_read_u32_array(np,
395 "samsung,dw-mshc-hs400-timing", timing, 2);
396 if (!ret && of_property_read_u32(np,
397 "samsung,read-strobe-delay", &priv->dqs_delay))
398 dev_dbg(host->dev,
399 "read-strobe-delay is not found, assuming usage of default value\n");
400
401 priv->hs400_timing = SDMMC_CLKSEL_TIMING(timing[0], timing[1],
402 HS400_FIXED_CIU_CLK_DIV);
403 host->priv = priv;
404 return 0;
405}
406
407static inline u8 dw_mci_exynos_get_clksmpl(struct dw_mci *host)
408{
409 struct dw_mci_exynos_priv_data *priv = host->priv;
410
411 if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS7 ||
412 priv->ctrl_type == DW_MCI_TYPE_EXYNOS7_SMU ||
413 priv->ctrl_type == DW_MCI_TYPE_ARTPEC8)
414 return SDMMC_CLKSEL_CCLK_SAMPLE(mci_readl(host, CLKSEL64));
415 else
416 return SDMMC_CLKSEL_CCLK_SAMPLE(mci_readl(host, CLKSEL));
417}
418
419static inline void dw_mci_exynos_set_clksmpl(struct dw_mci *host, u8 sample)
420{
421 u32 clksel;
422 struct dw_mci_exynos_priv_data *priv = host->priv;
423
424 if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS7 ||
425 priv->ctrl_type == DW_MCI_TYPE_EXYNOS7_SMU ||
426 priv->ctrl_type == DW_MCI_TYPE_ARTPEC8)
427 clksel = mci_readl(host, CLKSEL64);
428 else
429 clksel = mci_readl(host, CLKSEL);
430 clksel = SDMMC_CLKSEL_UP_SAMPLE(clksel, sample);
431 if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS7 ||
432 priv->ctrl_type == DW_MCI_TYPE_EXYNOS7_SMU ||
433 priv->ctrl_type == DW_MCI_TYPE_ARTPEC8)
434 mci_writel(host, CLKSEL64, clksel);
435 else
436 mci_writel(host, CLKSEL, clksel);
437}
438
439static inline u8 dw_mci_exynos_move_next_clksmpl(struct dw_mci *host)
440{
441 struct dw_mci_exynos_priv_data *priv = host->priv;
442 u32 clksel;
443 u8 sample;
444
445 if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS7 ||
446 priv->ctrl_type == DW_MCI_TYPE_EXYNOS7_SMU ||
447 priv->ctrl_type == DW_MCI_TYPE_ARTPEC8)
448 clksel = mci_readl(host, CLKSEL64);
449 else
450 clksel = mci_readl(host, CLKSEL);
451
452 sample = (clksel + 1) & 0x7;
453 clksel = SDMMC_CLKSEL_UP_SAMPLE(clksel, sample);
454
455 if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS7 ||
456 priv->ctrl_type == DW_MCI_TYPE_EXYNOS7_SMU ||
457 priv->ctrl_type == DW_MCI_TYPE_ARTPEC8)
458 mci_writel(host, CLKSEL64, clksel);
459 else
460 mci_writel(host, CLKSEL, clksel);
461
462 return sample;
463}
464
465static s8 dw_mci_exynos_get_best_clksmpl(u8 candidates)
466{
467 const u8 iter = 8;
468 u8 __c;
469 s8 i, loc = -1;
470
471 for (i = 0; i < iter; i++) {
472 __c = ror8(candidates, i);
473 if ((__c & 0xc7) == 0xc7) {
474 loc = i;
475 goto out;
476 }
477 }
478
479 for (i = 0; i < iter; i++) {
480 __c = ror8(candidates, i);
481 if ((__c & 0x83) == 0x83) {
482 loc = i;
483 goto out;
484 }
485 }
486
487 /*
488 * If there is no cadiates value, then it needs to return -EIO.
489 * If there are candidates values and don't find bset clk sample value,
490 * then use a first candidates clock sample value.
491 */
492 for (i = 0; i < iter; i++) {
493 __c = ror8(candidates, i);
494 if ((__c & 0x1) == 0x1) {
495 loc = i;
496 goto out;
497 }
498 }
499out:
500 return loc;
501}
502
503static int dw_mci_exynos_execute_tuning(struct dw_mci_slot *slot, u32 opcode)
504{
505 struct dw_mci *host = slot->host;
506 struct dw_mci_exynos_priv_data *priv = host->priv;
507 struct mmc_host *mmc = slot->mmc;
508 u8 start_smpl, smpl, candidates = 0;
509 s8 found;
510 int ret = 0;
511
512 start_smpl = dw_mci_exynos_get_clksmpl(host);
513
514 do {
515 mci_writel(host, TMOUT, ~0);
516 smpl = dw_mci_exynos_move_next_clksmpl(host);
517
518 if (!mmc_send_tuning(mmc, opcode, NULL))
519 candidates |= (1 << smpl);
520
521 } while (start_smpl != smpl);
522
523 found = dw_mci_exynos_get_best_clksmpl(candidates);
524 if (found >= 0) {
525 dw_mci_exynos_set_clksmpl(host, found);
526 priv->tuned_sample = found;
527 } else {
528 ret = -EIO;
529 dev_warn(&mmc->class_dev,
530 "There is no candidates value about clksmpl!\n");
531 }
532
533 return ret;
534}
535
536static int dw_mci_exynos_prepare_hs400_tuning(struct dw_mci *host,
537 struct mmc_ios *ios)
538{
539 struct dw_mci_exynos_priv_data *priv = host->priv;
540
541 dw_mci_exynos_set_clksel_timing(host, priv->hs400_timing);
542 dw_mci_exynos_adjust_clock(host, (ios->clock) << 1);
543
544 return 0;
545}
546
547static void dw_mci_exynos_set_data_timeout(struct dw_mci *host,
548 unsigned int timeout_ns)
549{
550 u32 clk_div, tmout;
551 u64 tmp;
552 unsigned int tmp2;
553
554 clk_div = (mci_readl(host, CLKDIV) & 0xFF) * 2;
555 if (clk_div == 0)
556 clk_div = 1;
557
558 tmp = DIV_ROUND_UP_ULL((u64)timeout_ns * host->bus_hz, NSEC_PER_SEC);
559 tmp = DIV_ROUND_UP_ULL(tmp, clk_div);
560
561 /* TMOUT[7:0] (RESPONSE_TIMEOUT) */
562 tmout = 0xFF; /* Set maximum */
563
564 /*
565 * Extended HW timer (max = 0x6FFFFF2):
566 * ((TMOUT[10:8] - 1) * 0xFFFFFF + TMOUT[31:11] * 8)
567 */
568 if (!tmp || tmp > 0x6FFFFF2)
569 tmout |= (0xFFFFFF << 8);
570 else {
571 /* TMOUT[10:8] */
572 tmp2 = (((unsigned int)tmp / 0xFFFFFF) + 1) & 0x7;
573 tmout |= tmp2 << 8;
574
575 /* TMOUT[31:11] */
576 tmp = tmp - ((tmp2 - 1) * 0xFFFFFF);
577 tmout |= (tmp & 0xFFFFF8) << 8;
578 }
579
580 mci_writel(host, TMOUT, tmout);
581 dev_dbg(host->dev, "timeout_ns: %u => TMOUT[31:8]: %#08x",
582 timeout_ns, tmout >> 8);
583}
584
585static u32 dw_mci_exynos_get_drto_clks(struct dw_mci *host)
586{
587 u32 drto_clks;
588
589 drto_clks = mci_readl(host, TMOUT) >> 8;
590
591 return (((drto_clks & 0x7) - 1) * 0xFFFFFF) + ((drto_clks & 0xFFFFF8));
592}
593
594/* Common capabilities of Exynos4/Exynos5 SoC */
595static unsigned long exynos_dwmmc_caps[4] = {
596 MMC_CAP_1_8V_DDR | MMC_CAP_8_BIT_DATA,
597 0,
598 0,
599 0,
600};
601
602static const struct dw_mci_drv_data exynos_drv_data = {
603 .caps = exynos_dwmmc_caps,
604 .num_caps = ARRAY_SIZE(exynos_dwmmc_caps),
605 .common_caps = MMC_CAP_CMD23,
606 .init = dw_mci_exynos_priv_init,
607 .set_ios = dw_mci_exynos_set_ios,
608 .parse_dt = dw_mci_exynos_parse_dt,
609 .execute_tuning = dw_mci_exynos_execute_tuning,
610 .prepare_hs400_tuning = dw_mci_exynos_prepare_hs400_tuning,
611};
612
613static const struct dw_mci_drv_data artpec_drv_data = {
614 .common_caps = MMC_CAP_CMD23,
615 .init = dw_mci_exynos_priv_init,
616 .set_ios = dw_mci_exynos_set_ios,
617 .parse_dt = dw_mci_exynos_parse_dt,
618 .execute_tuning = dw_mci_exynos_execute_tuning,
619 .set_data_timeout = dw_mci_exynos_set_data_timeout,
620 .get_drto_clks = dw_mci_exynos_get_drto_clks,
621};
622
623static const struct of_device_id dw_mci_exynos_match[] = {
624 { .compatible = "samsung,exynos4412-dw-mshc",
625 .data = &exynos_drv_data, },
626 { .compatible = "samsung,exynos5250-dw-mshc",
627 .data = &exynos_drv_data, },
628 { .compatible = "samsung,exynos5420-dw-mshc",
629 .data = &exynos_drv_data, },
630 { .compatible = "samsung,exynos5420-dw-mshc-smu",
631 .data = &exynos_drv_data, },
632 { .compatible = "samsung,exynos7-dw-mshc",
633 .data = &exynos_drv_data, },
634 { .compatible = "samsung,exynos7-dw-mshc-smu",
635 .data = &exynos_drv_data, },
636 { .compatible = "axis,artpec8-dw-mshc",
637 .data = &artpec_drv_data, },
638 {},
639};
640MODULE_DEVICE_TABLE(of, dw_mci_exynos_match);
641
642static int dw_mci_exynos_probe(struct platform_device *pdev)
643{
644 const struct dw_mci_drv_data *drv_data;
645 const struct of_device_id *match;
646 int ret;
647
648 match = of_match_node(dw_mci_exynos_match, pdev->dev.of_node);
649 drv_data = match->data;
650
651 pm_runtime_get_noresume(&pdev->dev);
652 pm_runtime_set_active(&pdev->dev);
653 pm_runtime_enable(&pdev->dev);
654
655 ret = dw_mci_pltfm_register(pdev, drv_data);
656 if (ret) {
657 pm_runtime_disable(&pdev->dev);
658 pm_runtime_set_suspended(&pdev->dev);
659 pm_runtime_put_noidle(&pdev->dev);
660
661 return ret;
662 }
663
664 return 0;
665}
666
667static int dw_mci_exynos_remove(struct platform_device *pdev)
668{
669 pm_runtime_disable(&pdev->dev);
670 pm_runtime_set_suspended(&pdev->dev);
671 pm_runtime_put_noidle(&pdev->dev);
672
673 dw_mci_pltfm_remove(pdev);
674
675 return 0;
676}
677
678static const struct dev_pm_ops dw_mci_exynos_pmops = {
679 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(dw_mci_exynos_suspend_noirq,
680 dw_mci_exynos_resume_noirq)
681 SET_RUNTIME_PM_OPS(dw_mci_runtime_suspend,
682 dw_mci_exynos_runtime_resume,
683 NULL)
684};
685
686static struct platform_driver dw_mci_exynos_pltfm_driver = {
687 .probe = dw_mci_exynos_probe,
688 .remove = dw_mci_exynos_remove,
689 .driver = {
690 .name = "dwmmc_exynos",
691 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
692 .of_match_table = dw_mci_exynos_match,
693 .pm = &dw_mci_exynos_pmops,
694 },
695};
696
697module_platform_driver(dw_mci_exynos_pltfm_driver);
698
699MODULE_DESCRIPTION("Samsung Specific DW-MSHC Driver Extension");
700MODULE_AUTHOR("Thomas Abraham <thomas.ab@samsung.com");
701MODULE_LICENSE("GPL v2");
702MODULE_ALIAS("platform:dwmmc_exynos");
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/mmc/mmc.h>
18#include <linux/of.h>
19#include <linux/of_gpio.h>
20#include <linux/slab.h>
21
22#include "dw_mmc.h"
23#include "dw_mmc-pltfm.h"
24
25#define NUM_PINS(x) (x + 2)
26
27#define SDMMC_CLKSEL 0x09C
28#define SDMMC_CLKSEL_CCLK_SAMPLE(x) (((x) & 7) << 0)
29#define SDMMC_CLKSEL_CCLK_DRIVE(x) (((x) & 7) << 16)
30#define SDMMC_CLKSEL_CCLK_DIVIDER(x) (((x) & 7) << 24)
31#define SDMMC_CLKSEL_GET_DRV_WD3(x) (((x) >> 16) & 0x7)
32#define SDMMC_CLKSEL_TIMING(x, y, z) (SDMMC_CLKSEL_CCLK_SAMPLE(x) | \
33 SDMMC_CLKSEL_CCLK_DRIVE(y) | \
34 SDMMC_CLKSEL_CCLK_DIVIDER(z))
35#define SDMMC_CLKSEL_WAKEUP_INT BIT(11)
36
37#define EXYNOS4210_FIXED_CIU_CLK_DIV 2
38#define EXYNOS4412_FIXED_CIU_CLK_DIV 4
39
40/* Block number in eMMC */
41#define DWMCI_BLOCK_NUM 0xFFFFFFFF
42
43#define SDMMC_EMMCP_BASE 0x1000
44#define SDMMC_MPSECURITY (SDMMC_EMMCP_BASE + 0x0010)
45#define SDMMC_MPSBEGIN0 (SDMMC_EMMCP_BASE + 0x0200)
46#define SDMMC_MPSEND0 (SDMMC_EMMCP_BASE + 0x0204)
47#define SDMMC_MPSCTRL0 (SDMMC_EMMCP_BASE + 0x020C)
48
49/* SMU control bits */
50#define DWMCI_MPSCTRL_SECURE_READ_BIT BIT(7)
51#define DWMCI_MPSCTRL_SECURE_WRITE_BIT BIT(6)
52#define DWMCI_MPSCTRL_NON_SECURE_READ_BIT BIT(5)
53#define DWMCI_MPSCTRL_NON_SECURE_WRITE_BIT BIT(4)
54#define DWMCI_MPSCTRL_USE_FUSE_KEY BIT(3)
55#define DWMCI_MPSCTRL_ECB_MODE BIT(2)
56#define DWMCI_MPSCTRL_ENCRYPTION BIT(1)
57#define DWMCI_MPSCTRL_VALID BIT(0)
58
59#define EXYNOS_CCLKIN_MIN 50000000 /* unit: HZ */
60
61/* Variations in Exynos specific dw-mshc controller */
62enum dw_mci_exynos_type {
63 DW_MCI_TYPE_EXYNOS4210,
64 DW_MCI_TYPE_EXYNOS4412,
65 DW_MCI_TYPE_EXYNOS5250,
66 DW_MCI_TYPE_EXYNOS5420,
67 DW_MCI_TYPE_EXYNOS5420_SMU,
68};
69
70/* Exynos implementation specific driver private data */
71struct dw_mci_exynos_priv_data {
72 enum dw_mci_exynos_type ctrl_type;
73 u8 ciu_div;
74 u32 sdr_timing;
75 u32 ddr_timing;
76 u32 cur_speed;
77};
78
79static struct dw_mci_exynos_compatible {
80 char *compatible;
81 enum dw_mci_exynos_type ctrl_type;
82} exynos_compat[] = {
83 {
84 .compatible = "samsung,exynos4210-dw-mshc",
85 .ctrl_type = DW_MCI_TYPE_EXYNOS4210,
86 }, {
87 .compatible = "samsung,exynos4412-dw-mshc",
88 .ctrl_type = DW_MCI_TYPE_EXYNOS4412,
89 }, {
90 .compatible = "samsung,exynos5250-dw-mshc",
91 .ctrl_type = DW_MCI_TYPE_EXYNOS5250,
92 }, {
93 .compatible = "samsung,exynos5420-dw-mshc",
94 .ctrl_type = DW_MCI_TYPE_EXYNOS5420,
95 }, {
96 .compatible = "samsung,exynos5420-dw-mshc-smu",
97 .ctrl_type = DW_MCI_TYPE_EXYNOS5420_SMU,
98 },
99};
100
101static int dw_mci_exynos_priv_init(struct dw_mci *host)
102{
103 struct dw_mci_exynos_priv_data *priv = host->priv;
104
105 if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS5420_SMU) {
106 mci_writel(host, MPSBEGIN0, 0);
107 mci_writel(host, MPSEND0, DWMCI_BLOCK_NUM);
108 mci_writel(host, MPSCTRL0, DWMCI_MPSCTRL_SECURE_WRITE_BIT |
109 DWMCI_MPSCTRL_NON_SECURE_READ_BIT |
110 DWMCI_MPSCTRL_VALID |
111 DWMCI_MPSCTRL_NON_SECURE_WRITE_BIT);
112 }
113
114 return 0;
115}
116
117static int dw_mci_exynos_setup_clock(struct dw_mci *host)
118{
119 struct dw_mci_exynos_priv_data *priv = host->priv;
120 unsigned long rate = clk_get_rate(host->ciu_clk);
121
122 host->bus_hz = rate / (priv->ciu_div + 1);
123 return 0;
124}
125
126#ifdef CONFIG_PM_SLEEP
127static int dw_mci_exynos_suspend(struct device *dev)
128{
129 struct dw_mci *host = dev_get_drvdata(dev);
130
131 return dw_mci_suspend(host);
132}
133
134static int dw_mci_exynos_resume(struct device *dev)
135{
136 struct dw_mci *host = dev_get_drvdata(dev);
137
138 dw_mci_exynos_priv_init(host);
139 return dw_mci_resume(host);
140}
141
142/**
143 * dw_mci_exynos_resume_noirq - Exynos-specific resume code
144 *
145 * On exynos5420 there is a silicon errata that will sometimes leave the
146 * WAKEUP_INT bit in the CLKSEL register asserted. This bit is 1 to indicate
147 * that it fired and we can clear it by writing a 1 back. Clear it to prevent
148 * interrupts from going off constantly.
149 *
150 * We run this code on all exynos variants because it doesn't hurt.
151 */
152
153static int dw_mci_exynos_resume_noirq(struct device *dev)
154{
155 struct dw_mci *host = dev_get_drvdata(dev);
156 u32 clksel;
157
158 clksel = mci_readl(host, CLKSEL);
159 if (clksel & SDMMC_CLKSEL_WAKEUP_INT)
160 mci_writel(host, CLKSEL, clksel);
161
162 return 0;
163}
164#else
165#define dw_mci_exynos_suspend NULL
166#define dw_mci_exynos_resume NULL
167#define dw_mci_exynos_resume_noirq NULL
168#endif /* CONFIG_PM_SLEEP */
169
170static void dw_mci_exynos_prepare_command(struct dw_mci *host, u32 *cmdr)
171{
172 /*
173 * Exynos4412 and Exynos5250 extends the use of CMD register with the
174 * use of bit 29 (which is reserved on standard MSHC controllers) for
175 * optionally bypassing the HOLD register for command and data. The
176 * HOLD register should be bypassed in case there is no phase shift
177 * applied on CMD/DATA that is sent to the card.
178 */
179 if (SDMMC_CLKSEL_GET_DRV_WD3(mci_readl(host, CLKSEL)))
180 *cmdr |= SDMMC_CMD_USE_HOLD_REG;
181}
182
183static void dw_mci_exynos_set_ios(struct dw_mci *host, struct mmc_ios *ios)
184{
185 struct dw_mci_exynos_priv_data *priv = host->priv;
186 unsigned int wanted = ios->clock;
187 unsigned long actual;
188 u8 div = priv->ciu_div + 1;
189
190 if (ios->timing == MMC_TIMING_UHS_DDR50) {
191 mci_writel(host, CLKSEL, priv->ddr_timing);
192 /* Should be double rate for DDR mode */
193 if (ios->bus_width == MMC_BUS_WIDTH_8)
194 wanted <<= 1;
195 } else {
196 mci_writel(host, CLKSEL, priv->sdr_timing);
197 }
198
199 /* Don't care if wanted clock is zero */
200 if (!wanted)
201 return;
202
203 /* Guaranteed minimum frequency for cclkin */
204 if (wanted < EXYNOS_CCLKIN_MIN)
205 wanted = EXYNOS_CCLKIN_MIN;
206
207 if (wanted != priv->cur_speed) {
208 int ret = clk_set_rate(host->ciu_clk, wanted * div);
209 if (ret)
210 dev_warn(host->dev,
211 "failed to set clk-rate %u error: %d\n",
212 wanted * div, ret);
213 actual = clk_get_rate(host->ciu_clk);
214 host->bus_hz = actual / div;
215 priv->cur_speed = wanted;
216 host->current_speed = 0;
217 }
218}
219
220static int dw_mci_exynos_parse_dt(struct dw_mci *host)
221{
222 struct dw_mci_exynos_priv_data *priv;
223 struct device_node *np = host->dev->of_node;
224 u32 timing[2];
225 u32 div = 0;
226 int idx;
227 int ret;
228
229 priv = devm_kzalloc(host->dev, sizeof(*priv), GFP_KERNEL);
230 if (!priv) {
231 dev_err(host->dev, "mem alloc failed for private data\n");
232 return -ENOMEM;
233 }
234
235 for (idx = 0; idx < ARRAY_SIZE(exynos_compat); idx++) {
236 if (of_device_is_compatible(np, exynos_compat[idx].compatible))
237 priv->ctrl_type = exynos_compat[idx].ctrl_type;
238 }
239
240 if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS4412)
241 priv->ciu_div = EXYNOS4412_FIXED_CIU_CLK_DIV - 1;
242 else if (priv->ctrl_type == DW_MCI_TYPE_EXYNOS4210)
243 priv->ciu_div = EXYNOS4210_FIXED_CIU_CLK_DIV - 1;
244 else {
245 of_property_read_u32(np, "samsung,dw-mshc-ciu-div", &div);
246 priv->ciu_div = div;
247 }
248
249 ret = of_property_read_u32_array(np,
250 "samsung,dw-mshc-sdr-timing", timing, 2);
251 if (ret)
252 return ret;
253
254 priv->sdr_timing = SDMMC_CLKSEL_TIMING(timing[0], timing[1], div);
255
256 ret = of_property_read_u32_array(np,
257 "samsung,dw-mshc-ddr-timing", timing, 2);
258 if (ret)
259 return ret;
260
261 priv->ddr_timing = SDMMC_CLKSEL_TIMING(timing[0], timing[1], div);
262 host->priv = priv;
263 return 0;
264}
265
266static inline u8 dw_mci_exynos_get_clksmpl(struct dw_mci *host)
267{
268 return SDMMC_CLKSEL_CCLK_SAMPLE(mci_readl(host, CLKSEL));
269}
270
271static inline void dw_mci_exynos_set_clksmpl(struct dw_mci *host, u8 sample)
272{
273 u32 clksel;
274 clksel = mci_readl(host, CLKSEL);
275 clksel = (clksel & ~0x7) | SDMMC_CLKSEL_CCLK_SAMPLE(sample);
276 mci_writel(host, CLKSEL, clksel);
277}
278
279static inline u8 dw_mci_exynos_move_next_clksmpl(struct dw_mci *host)
280{
281 u32 clksel;
282 u8 sample;
283
284 clksel = mci_readl(host, CLKSEL);
285 sample = (clksel + 1) & 0x7;
286 clksel = (clksel & ~0x7) | sample;
287 mci_writel(host, CLKSEL, clksel);
288 return sample;
289}
290
291static s8 dw_mci_exynos_get_best_clksmpl(u8 candiates)
292{
293 const u8 iter = 8;
294 u8 __c;
295 s8 i, loc = -1;
296
297 for (i = 0; i < iter; i++) {
298 __c = ror8(candiates, i);
299 if ((__c & 0xc7) == 0xc7) {
300 loc = i;
301 goto out;
302 }
303 }
304
305 for (i = 0; i < iter; i++) {
306 __c = ror8(candiates, i);
307 if ((__c & 0x83) == 0x83) {
308 loc = i;
309 goto out;
310 }
311 }
312
313out:
314 return loc;
315}
316
317static int dw_mci_exynos_execute_tuning(struct dw_mci_slot *slot, u32 opcode,
318 struct dw_mci_tuning_data *tuning_data)
319{
320 struct dw_mci *host = slot->host;
321 struct mmc_host *mmc = slot->mmc;
322 const u8 *blk_pattern = tuning_data->blk_pattern;
323 u8 *blk_test;
324 unsigned int blksz = tuning_data->blksz;
325 u8 start_smpl, smpl, candiates = 0;
326 s8 found = -1;
327 int ret = 0;
328
329 blk_test = kmalloc(blksz, GFP_KERNEL);
330 if (!blk_test)
331 return -ENOMEM;
332
333 start_smpl = dw_mci_exynos_get_clksmpl(host);
334
335 do {
336 struct mmc_request mrq = {NULL};
337 struct mmc_command cmd = {0};
338 struct mmc_command stop = {0};
339 struct mmc_data data = {0};
340 struct scatterlist sg;
341
342 cmd.opcode = opcode;
343 cmd.arg = 0;
344 cmd.flags = MMC_RSP_R1 | MMC_CMD_ADTC;
345
346 stop.opcode = MMC_STOP_TRANSMISSION;
347 stop.arg = 0;
348 stop.flags = MMC_RSP_R1B | MMC_CMD_AC;
349
350 data.blksz = blksz;
351 data.blocks = 1;
352 data.flags = MMC_DATA_READ;
353 data.sg = &sg;
354 data.sg_len = 1;
355
356 sg_init_one(&sg, blk_test, blksz);
357 mrq.cmd = &cmd;
358 mrq.stop = &stop;
359 mrq.data = &data;
360 host->mrq = &mrq;
361
362 mci_writel(host, TMOUT, ~0);
363 smpl = dw_mci_exynos_move_next_clksmpl(host);
364
365 mmc_wait_for_req(mmc, &mrq);
366
367 if (!cmd.error && !data.error) {
368 if (!memcmp(blk_pattern, blk_test, blksz))
369 candiates |= (1 << smpl);
370 } else {
371 dev_dbg(host->dev,
372 "Tuning error: cmd.error:%d, data.error:%d\n",
373 cmd.error, data.error);
374 }
375 } while (start_smpl != smpl);
376
377 found = dw_mci_exynos_get_best_clksmpl(candiates);
378 if (found >= 0)
379 dw_mci_exynos_set_clksmpl(host, found);
380 else
381 ret = -EIO;
382
383 kfree(blk_test);
384 return ret;
385}
386
387/* Common capabilities of Exynos4/Exynos5 SoC */
388static unsigned long exynos_dwmmc_caps[4] = {
389 MMC_CAP_UHS_DDR50 | MMC_CAP_1_8V_DDR |
390 MMC_CAP_8_BIT_DATA | MMC_CAP_CMD23,
391 MMC_CAP_CMD23,
392 MMC_CAP_CMD23,
393 MMC_CAP_CMD23,
394};
395
396static const struct dw_mci_drv_data exynos_drv_data = {
397 .caps = exynos_dwmmc_caps,
398 .init = dw_mci_exynos_priv_init,
399 .setup_clock = dw_mci_exynos_setup_clock,
400 .prepare_command = dw_mci_exynos_prepare_command,
401 .set_ios = dw_mci_exynos_set_ios,
402 .parse_dt = dw_mci_exynos_parse_dt,
403 .execute_tuning = dw_mci_exynos_execute_tuning,
404};
405
406static const struct of_device_id dw_mci_exynos_match[] = {
407 { .compatible = "samsung,exynos4412-dw-mshc",
408 .data = &exynos_drv_data, },
409 { .compatible = "samsung,exynos5250-dw-mshc",
410 .data = &exynos_drv_data, },
411 { .compatible = "samsung,exynos5420-dw-mshc",
412 .data = &exynos_drv_data, },
413 { .compatible = "samsung,exynos5420-dw-mshc-smu",
414 .data = &exynos_drv_data, },
415 {},
416};
417MODULE_DEVICE_TABLE(of, dw_mci_exynos_match);
418
419static int dw_mci_exynos_probe(struct platform_device *pdev)
420{
421 const struct dw_mci_drv_data *drv_data;
422 const struct of_device_id *match;
423
424 match = of_match_node(dw_mci_exynos_match, pdev->dev.of_node);
425 drv_data = match->data;
426 return dw_mci_pltfm_register(pdev, drv_data);
427}
428
429const struct dev_pm_ops dw_mci_exynos_pmops = {
430 SET_SYSTEM_SLEEP_PM_OPS(dw_mci_exynos_suspend, dw_mci_exynos_resume)
431 .resume_noirq = dw_mci_exynos_resume_noirq,
432 .thaw_noirq = dw_mci_exynos_resume_noirq,
433 .restore_noirq = dw_mci_exynos_resume_noirq,
434};
435
436static struct platform_driver dw_mci_exynos_pltfm_driver = {
437 .probe = dw_mci_exynos_probe,
438 .remove = __exit_p(dw_mci_pltfm_remove),
439 .driver = {
440 .name = "dwmmc_exynos",
441 .of_match_table = dw_mci_exynos_match,
442 .pm = &dw_mci_exynos_pmops,
443 },
444};
445
446module_platform_driver(dw_mci_exynos_pltfm_driver);
447
448MODULE_DESCRIPTION("Samsung Specific DW-MSHC Driver Extension");
449MODULE_AUTHOR("Thomas Abraham <thomas.ab@samsung.com");
450MODULE_LICENSE("GPL v2");
451MODULE_ALIAS("platform:dwmmc-exynos");