1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Exynos Specific Extensions for Synopsys DW Multimedia Card Interface driver
5 * Copyright (C) 2012, Samsung Electronics Co., Ltd.
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>
14 #include <linux/of_gpio.h>
15 #include <linux/pm_runtime.h>
16 #include <linux/slab.h>
19 #include "dw_mmc-pltfm.h"
20 #include "dw_mmc-exynos.h"
22 /* Variations in Exynos specific dw-mshc controller */
23 enum 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
,
30 DW_MCI_TYPE_EXYNOS7_SMU
,
33 /* Exynos implementation specific driver private data */
34 struct dw_mci_exynos_priv_data
{
35 enum dw_mci_exynos_type ctrl_type
;
44 u32 saved_strobe_ctrl
;
47 static struct dw_mci_exynos_compatible
{
49 enum dw_mci_exynos_type ctrl_type
;
52 .compatible
= "samsung,exynos4210-dw-mshc",
53 .ctrl_type
= DW_MCI_TYPE_EXYNOS4210
,
55 .compatible
= "samsung,exynos4412-dw-mshc",
56 .ctrl_type
= DW_MCI_TYPE_EXYNOS4412
,
58 .compatible
= "samsung,exynos5250-dw-mshc",
59 .ctrl_type
= DW_MCI_TYPE_EXYNOS5250
,
61 .compatible
= "samsung,exynos5420-dw-mshc",
62 .ctrl_type
= DW_MCI_TYPE_EXYNOS5420
,
64 .compatible
= "samsung,exynos5420-dw-mshc-smu",
65 .ctrl_type
= DW_MCI_TYPE_EXYNOS5420_SMU
,
67 .compatible
= "samsung,exynos7-dw-mshc",
68 .ctrl_type
= DW_MCI_TYPE_EXYNOS7
,
70 .compatible
= "samsung,exynos7-dw-mshc-smu",
71 .ctrl_type
= DW_MCI_TYPE_EXYNOS7_SMU
,
75 static inline u8
dw_mci_exynos_get_ciu_div(struct dw_mci
*host
)
77 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
79 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS4412
)
80 return EXYNOS4412_FIXED_CIU_CLK_DIV
;
81 else if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS4210
)
82 return EXYNOS4210_FIXED_CIU_CLK_DIV
;
83 else if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7
||
84 priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7_SMU
)
85 return SDMMC_CLKSEL_GET_DIV(mci_readl(host
, CLKSEL64
)) + 1;
87 return SDMMC_CLKSEL_GET_DIV(mci_readl(host
, CLKSEL
)) + 1;
90 static void dw_mci_exynos_config_smu(struct dw_mci
*host
)
92 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
95 * If Exynos is provided the Security management,
96 * set for non-ecryption mode at this time.
98 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS5420_SMU
||
99 priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7_SMU
) {
100 mci_writel(host
, MPSBEGIN0
, 0);
101 mci_writel(host
, MPSEND0
, SDMMC_ENDING_SEC_NR_MAX
);
102 mci_writel(host
, MPSCTRL0
, SDMMC_MPSCTRL_SECURE_WRITE_BIT
|
103 SDMMC_MPSCTRL_NON_SECURE_READ_BIT
|
104 SDMMC_MPSCTRL_VALID
|
105 SDMMC_MPSCTRL_NON_SECURE_WRITE_BIT
);
109 static int dw_mci_exynos_priv_init(struct dw_mci
*host
)
111 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
113 dw_mci_exynos_config_smu(host
);
115 if (priv
->ctrl_type
>= DW_MCI_TYPE_EXYNOS5420
) {
116 priv
->saved_strobe_ctrl
= mci_readl(host
, HS400_DLINE_CTRL
);
117 priv
->saved_dqs_en
= mci_readl(host
, HS400_DQS_EN
);
118 priv
->saved_dqs_en
|= AXI_NON_BLOCKING_WR
;
119 mci_writel(host
, HS400_DQS_EN
, priv
->saved_dqs_en
);
120 if (!priv
->dqs_delay
)
122 DQS_CTRL_GET_RD_DELAY(priv
->saved_strobe_ctrl
);
125 host
->bus_hz
/= (priv
->ciu_div
+ 1);
130 static void dw_mci_exynos_set_clksel_timing(struct dw_mci
*host
, u32 timing
)
132 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
135 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7
||
136 priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7_SMU
)
137 clksel
= mci_readl(host
, CLKSEL64
);
139 clksel
= mci_readl(host
, CLKSEL
);
141 clksel
= (clksel
& ~SDMMC_CLKSEL_TIMING_MASK
) | timing
;
143 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7
||
144 priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7_SMU
)
145 mci_writel(host
, CLKSEL64
, clksel
);
147 mci_writel(host
, CLKSEL
, clksel
);
150 * Exynos4412 and Exynos5250 extends the use of CMD register with the
151 * use of bit 29 (which is reserved on standard MSHC controllers) for
152 * optionally bypassing the HOLD register for command and data. The
153 * HOLD register should be bypassed in case there is no phase shift
154 * applied on CMD/DATA that is sent to the card.
156 if (!SDMMC_CLKSEL_GET_DRV_WD3(clksel
) && host
->slot
)
157 set_bit(DW_MMC_CARD_NO_USE_HOLD
, &host
->slot
->flags
);
161 static int dw_mci_exynos_runtime_resume(struct device
*dev
)
163 struct dw_mci
*host
= dev_get_drvdata(dev
);
166 ret
= dw_mci_runtime_resume(dev
);
170 dw_mci_exynos_config_smu(host
);
174 #endif /* CONFIG_PM */
176 #ifdef CONFIG_PM_SLEEP
178 * dw_mci_exynos_suspend_noirq - Exynos-specific suspend code
180 * This ensures that device will be in runtime active state in
181 * dw_mci_exynos_resume_noirq after calling pm_runtime_force_resume()
183 static int dw_mci_exynos_suspend_noirq(struct device
*dev
)
185 pm_runtime_get_noresume(dev
);
186 return pm_runtime_force_suspend(dev
);
190 * dw_mci_exynos_resume_noirq - Exynos-specific resume code
192 * On exynos5420 there is a silicon errata that will sometimes leave the
193 * WAKEUP_INT bit in the CLKSEL register asserted. This bit is 1 to indicate
194 * that it fired and we can clear it by writing a 1 back. Clear it to prevent
195 * interrupts from going off constantly.
197 * We run this code on all exynos variants because it doesn't hurt.
199 static int dw_mci_exynos_resume_noirq(struct device
*dev
)
201 struct dw_mci
*host
= dev_get_drvdata(dev
);
202 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
206 ret
= pm_runtime_force_resume(dev
);
210 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7
||
211 priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7_SMU
)
212 clksel
= mci_readl(host
, CLKSEL64
);
214 clksel
= mci_readl(host
, CLKSEL
);
216 if (clksel
& SDMMC_CLKSEL_WAKEUP_INT
) {
217 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7
||
218 priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7_SMU
)
219 mci_writel(host
, CLKSEL64
, clksel
);
221 mci_writel(host
, CLKSEL
, clksel
);
228 #endif /* CONFIG_PM_SLEEP */
230 static void dw_mci_exynos_config_hs400(struct dw_mci
*host
, u32 timing
)
232 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
236 * Not supported to configure register
239 if (priv
->ctrl_type
< DW_MCI_TYPE_EXYNOS5420
) {
240 if (timing
== MMC_TIMING_MMC_HS400
)
242 "cannot configure HS400, unsupported chipset\n");
246 dqs
= priv
->saved_dqs_en
;
247 strobe
= priv
->saved_strobe_ctrl
;
249 if (timing
== MMC_TIMING_MMC_HS400
) {
250 dqs
|= DATA_STROBE_EN
;
251 strobe
= DQS_CTRL_RD_DELAY(strobe
, priv
->dqs_delay
);
252 } else if (timing
== MMC_TIMING_UHS_SDR104
) {
255 dqs
&= ~DATA_STROBE_EN
;
258 mci_writel(host
, HS400_DQS_EN
, dqs
);
259 mci_writel(host
, HS400_DLINE_CTRL
, strobe
);
262 static void dw_mci_exynos_adjust_clock(struct dw_mci
*host
, unsigned int wanted
)
264 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
265 unsigned long actual
;
269 * Don't care if wanted clock is zero or
270 * ciu clock is unavailable
272 if (!wanted
|| IS_ERR(host
->ciu_clk
))
275 /* Guaranteed minimum frequency for cclkin */
276 if (wanted
< EXYNOS_CCLKIN_MIN
)
277 wanted
= EXYNOS_CCLKIN_MIN
;
279 if (wanted
== priv
->cur_speed
)
282 div
= dw_mci_exynos_get_ciu_div(host
);
283 ret
= clk_set_rate(host
->ciu_clk
, wanted
* div
);
286 "failed to set clk-rate %u error: %d\n",
288 actual
= clk_get_rate(host
->ciu_clk
);
289 host
->bus_hz
= actual
/ div
;
290 priv
->cur_speed
= wanted
;
291 host
->current_speed
= 0;
294 static void dw_mci_exynos_set_ios(struct dw_mci
*host
, struct mmc_ios
*ios
)
296 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
297 unsigned int wanted
= ios
->clock
;
298 u32 timing
= ios
->timing
, clksel
;
301 case MMC_TIMING_MMC_HS400
:
302 /* Update tuned sample timing */
303 clksel
= SDMMC_CLKSEL_UP_SAMPLE(
304 priv
->hs400_timing
, priv
->tuned_sample
);
307 case MMC_TIMING_MMC_DDR52
:
308 clksel
= priv
->ddr_timing
;
309 /* Should be double rate for DDR mode */
310 if (ios
->bus_width
== MMC_BUS_WIDTH_8
)
313 case MMC_TIMING_UHS_SDR104
:
314 case MMC_TIMING_UHS_SDR50
:
315 clksel
= (priv
->sdr_timing
& 0xfff8ffff) |
316 (priv
->ciu_div
<< 16);
318 case MMC_TIMING_UHS_DDR50
:
319 clksel
= (priv
->ddr_timing
& 0xfff8ffff) |
320 (priv
->ciu_div
<< 16);
323 clksel
= priv
->sdr_timing
;
326 /* Set clock timing for the requested speed mode*/
327 dw_mci_exynos_set_clksel_timing(host
, clksel
);
329 /* Configure setting for HS400 */
330 dw_mci_exynos_config_hs400(host
, timing
);
332 /* Configure clock rate */
333 dw_mci_exynos_adjust_clock(host
, wanted
);
336 static int dw_mci_exynos_parse_dt(struct dw_mci
*host
)
338 struct dw_mci_exynos_priv_data
*priv
;
339 struct device_node
*np
= host
->dev
->of_node
;
345 priv
= devm_kzalloc(host
->dev
, sizeof(*priv
), GFP_KERNEL
);
349 for (idx
= 0; idx
< ARRAY_SIZE(exynos_compat
); idx
++) {
350 if (of_device_is_compatible(np
, exynos_compat
[idx
].compatible
))
351 priv
->ctrl_type
= exynos_compat
[idx
].ctrl_type
;
354 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS4412
)
355 priv
->ciu_div
= EXYNOS4412_FIXED_CIU_CLK_DIV
- 1;
356 else if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS4210
)
357 priv
->ciu_div
= EXYNOS4210_FIXED_CIU_CLK_DIV
- 1;
359 of_property_read_u32(np
, "samsung,dw-mshc-ciu-div", &div
);
363 ret
= of_property_read_u32_array(np
,
364 "samsung,dw-mshc-sdr-timing", timing
, 2);
368 priv
->sdr_timing
= SDMMC_CLKSEL_TIMING(timing
[0], timing
[1], div
);
370 ret
= of_property_read_u32_array(np
,
371 "samsung,dw-mshc-ddr-timing", timing
, 2);
375 priv
->ddr_timing
= SDMMC_CLKSEL_TIMING(timing
[0], timing
[1], div
);
377 ret
= of_property_read_u32_array(np
,
378 "samsung,dw-mshc-hs400-timing", timing
, 2);
379 if (!ret
&& of_property_read_u32(np
,
380 "samsung,read-strobe-delay", &priv
->dqs_delay
))
382 "read-strobe-delay is not found, assuming usage of default value\n");
384 priv
->hs400_timing
= SDMMC_CLKSEL_TIMING(timing
[0], timing
[1],
385 HS400_FIXED_CIU_CLK_DIV
);
390 static inline u8
dw_mci_exynos_get_clksmpl(struct dw_mci
*host
)
392 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
394 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7
||
395 priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7_SMU
)
396 return SDMMC_CLKSEL_CCLK_SAMPLE(mci_readl(host
, CLKSEL64
));
398 return SDMMC_CLKSEL_CCLK_SAMPLE(mci_readl(host
, CLKSEL
));
401 static inline void dw_mci_exynos_set_clksmpl(struct dw_mci
*host
, u8 sample
)
404 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
406 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7
||
407 priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7_SMU
)
408 clksel
= mci_readl(host
, CLKSEL64
);
410 clksel
= mci_readl(host
, CLKSEL
);
411 clksel
= SDMMC_CLKSEL_UP_SAMPLE(clksel
, sample
);
412 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7
||
413 priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7_SMU
)
414 mci_writel(host
, CLKSEL64
, clksel
);
416 mci_writel(host
, CLKSEL
, clksel
);
419 static inline u8
dw_mci_exynos_move_next_clksmpl(struct dw_mci
*host
)
421 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
425 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7
||
426 priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7_SMU
)
427 clksel
= mci_readl(host
, CLKSEL64
);
429 clksel
= mci_readl(host
, CLKSEL
);
431 sample
= (clksel
+ 1) & 0x7;
432 clksel
= SDMMC_CLKSEL_UP_SAMPLE(clksel
, sample
);
434 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7
||
435 priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7_SMU
)
436 mci_writel(host
, CLKSEL64
, clksel
);
438 mci_writel(host
, CLKSEL
, clksel
);
443 static s8
dw_mci_exynos_get_best_clksmpl(u8 candiates
)
449 for (i
= 0; i
< iter
; i
++) {
450 __c
= ror8(candiates
, i
);
451 if ((__c
& 0xc7) == 0xc7) {
457 for (i
= 0; i
< iter
; i
++) {
458 __c
= ror8(candiates
, i
);
459 if ((__c
& 0x83) == 0x83) {
469 static int dw_mci_exynos_execute_tuning(struct dw_mci_slot
*slot
, u32 opcode
)
471 struct dw_mci
*host
= slot
->host
;
472 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
473 struct mmc_host
*mmc
= slot
->mmc
;
474 u8 start_smpl
, smpl
, candiates
= 0;
478 start_smpl
= dw_mci_exynos_get_clksmpl(host
);
481 mci_writel(host
, TMOUT
, ~0);
482 smpl
= dw_mci_exynos_move_next_clksmpl(host
);
484 if (!mmc_send_tuning(mmc
, opcode
, NULL
))
485 candiates
|= (1 << smpl
);
487 } while (start_smpl
!= smpl
);
489 found
= dw_mci_exynos_get_best_clksmpl(candiates
);
491 dw_mci_exynos_set_clksmpl(host
, found
);
492 priv
->tuned_sample
= found
;
500 static int dw_mci_exynos_prepare_hs400_tuning(struct dw_mci
*host
,
503 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
505 dw_mci_exynos_set_clksel_timing(host
, priv
->hs400_timing
);
506 dw_mci_exynos_adjust_clock(host
, (ios
->clock
) << 1);
511 /* Common capabilities of Exynos4/Exynos5 SoC */
512 static unsigned long exynos_dwmmc_caps
[4] = {
513 MMC_CAP_1_8V_DDR
| MMC_CAP_8_BIT_DATA
| MMC_CAP_CMD23
,
519 static const struct dw_mci_drv_data exynos_drv_data
= {
520 .caps
= exynos_dwmmc_caps
,
521 .num_caps
= ARRAY_SIZE(exynos_dwmmc_caps
),
522 .init
= dw_mci_exynos_priv_init
,
523 .set_ios
= dw_mci_exynos_set_ios
,
524 .parse_dt
= dw_mci_exynos_parse_dt
,
525 .execute_tuning
= dw_mci_exynos_execute_tuning
,
526 .prepare_hs400_tuning
= dw_mci_exynos_prepare_hs400_tuning
,
529 static const struct of_device_id dw_mci_exynos_match
[] = {
530 { .compatible
= "samsung,exynos4412-dw-mshc",
531 .data
= &exynos_drv_data
, },
532 { .compatible
= "samsung,exynos5250-dw-mshc",
533 .data
= &exynos_drv_data
, },
534 { .compatible
= "samsung,exynos5420-dw-mshc",
535 .data
= &exynos_drv_data
, },
536 { .compatible
= "samsung,exynos5420-dw-mshc-smu",
537 .data
= &exynos_drv_data
, },
538 { .compatible
= "samsung,exynos7-dw-mshc",
539 .data
= &exynos_drv_data
, },
540 { .compatible
= "samsung,exynos7-dw-mshc-smu",
541 .data
= &exynos_drv_data
, },
544 MODULE_DEVICE_TABLE(of
, dw_mci_exynos_match
);
546 static int dw_mci_exynos_probe(struct platform_device
*pdev
)
548 const struct dw_mci_drv_data
*drv_data
;
549 const struct of_device_id
*match
;
552 match
= of_match_node(dw_mci_exynos_match
, pdev
->dev
.of_node
);
553 drv_data
= match
->data
;
555 pm_runtime_get_noresume(&pdev
->dev
);
556 pm_runtime_set_active(&pdev
->dev
);
557 pm_runtime_enable(&pdev
->dev
);
559 ret
= dw_mci_pltfm_register(pdev
, drv_data
);
561 pm_runtime_disable(&pdev
->dev
);
562 pm_runtime_set_suspended(&pdev
->dev
);
563 pm_runtime_put_noidle(&pdev
->dev
);
571 static int dw_mci_exynos_remove(struct platform_device
*pdev
)
573 pm_runtime_disable(&pdev
->dev
);
574 pm_runtime_set_suspended(&pdev
->dev
);
575 pm_runtime_put_noidle(&pdev
->dev
);
577 return dw_mci_pltfm_remove(pdev
);
580 static const struct dev_pm_ops dw_mci_exynos_pmops
= {
581 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(dw_mci_exynos_suspend_noirq
,
582 dw_mci_exynos_resume_noirq
)
583 SET_RUNTIME_PM_OPS(dw_mci_runtime_suspend
,
584 dw_mci_exynos_runtime_resume
,
588 static struct platform_driver dw_mci_exynos_pltfm_driver
= {
589 .probe
= dw_mci_exynos_probe
,
590 .remove
= dw_mci_exynos_remove
,
592 .name
= "dwmmc_exynos",
593 .of_match_table
= dw_mci_exynos_match
,
594 .pm
= &dw_mci_exynos_pmops
,
598 module_platform_driver(dw_mci_exynos_pltfm_driver
);
600 MODULE_DESCRIPTION("Samsung Specific DW-MSHC Driver Extension");
601 MODULE_AUTHOR("Thomas Abraham <thomas.ab@samsung.com");
602 MODULE_LICENSE("GPL v2");
603 MODULE_ALIAS("platform:dwmmc_exynos");