2 * Exynos Specific Extensions for Synopsys DW Multimedia Card Interface driver
4 * Copyright (C) 2012, Samsung Electronics Co., Ltd.
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.
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/mmc.h>
18 #include <linux/of_gpio.h>
19 #include <linux/pm_runtime.h>
20 #include <linux/slab.h>
23 #include "dw_mmc-pltfm.h"
24 #include "dw_mmc-exynos.h"
26 /* Variations in Exynos specific dw-mshc controller */
27 enum dw_mci_exynos_type
{
28 DW_MCI_TYPE_EXYNOS4210
,
29 DW_MCI_TYPE_EXYNOS4412
,
30 DW_MCI_TYPE_EXYNOS5250
,
31 DW_MCI_TYPE_EXYNOS5420
,
32 DW_MCI_TYPE_EXYNOS5420_SMU
,
34 DW_MCI_TYPE_EXYNOS7_SMU
,
37 /* Exynos implementation specific driver private data */
38 struct dw_mci_exynos_priv_data
{
39 enum dw_mci_exynos_type ctrl_type
;
48 u32 saved_strobe_ctrl
;
51 static struct dw_mci_exynos_compatible
{
53 enum dw_mci_exynos_type ctrl_type
;
56 .compatible
= "samsung,exynos4210-dw-mshc",
57 .ctrl_type
= DW_MCI_TYPE_EXYNOS4210
,
59 .compatible
= "samsung,exynos4412-dw-mshc",
60 .ctrl_type
= DW_MCI_TYPE_EXYNOS4412
,
62 .compatible
= "samsung,exynos5250-dw-mshc",
63 .ctrl_type
= DW_MCI_TYPE_EXYNOS5250
,
65 .compatible
= "samsung,exynos5420-dw-mshc",
66 .ctrl_type
= DW_MCI_TYPE_EXYNOS5420
,
68 .compatible
= "samsung,exynos5420-dw-mshc-smu",
69 .ctrl_type
= DW_MCI_TYPE_EXYNOS5420_SMU
,
71 .compatible
= "samsung,exynos7-dw-mshc",
72 .ctrl_type
= DW_MCI_TYPE_EXYNOS7
,
74 .compatible
= "samsung,exynos7-dw-mshc-smu",
75 .ctrl_type
= DW_MCI_TYPE_EXYNOS7_SMU
,
79 static inline u8
dw_mci_exynos_get_ciu_div(struct dw_mci
*host
)
81 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
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 return SDMMC_CLKSEL_GET_DIV(mci_readl(host
, CLKSEL64
)) + 1;
91 return SDMMC_CLKSEL_GET_DIV(mci_readl(host
, CLKSEL
)) + 1;
94 static void dw_mci_exynos_config_smu(struct dw_mci
*host
)
96 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
99 * If Exynos is provided the Security management,
100 * set for non-ecryption mode at this time.
102 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS5420_SMU
||
103 priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7_SMU
) {
104 mci_writel(host
, MPSBEGIN0
, 0);
105 mci_writel(host
, MPSEND0
, SDMMC_ENDING_SEC_NR_MAX
);
106 mci_writel(host
, MPSCTRL0
, SDMMC_MPSCTRL_SECURE_WRITE_BIT
|
107 SDMMC_MPSCTRL_NON_SECURE_READ_BIT
|
108 SDMMC_MPSCTRL_VALID
|
109 SDMMC_MPSCTRL_NON_SECURE_WRITE_BIT
);
113 static int dw_mci_exynos_priv_init(struct dw_mci
*host
)
115 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
117 dw_mci_exynos_config_smu(host
);
119 if (priv
->ctrl_type
>= DW_MCI_TYPE_EXYNOS5420
) {
120 priv
->saved_strobe_ctrl
= mci_readl(host
, HS400_DLINE_CTRL
);
121 priv
->saved_dqs_en
= mci_readl(host
, HS400_DQS_EN
);
122 priv
->saved_dqs_en
|= AXI_NON_BLOCKING_WR
;
123 mci_writel(host
, HS400_DQS_EN
, priv
->saved_dqs_en
);
124 if (!priv
->dqs_delay
)
126 DQS_CTRL_GET_RD_DELAY(priv
->saved_strobe_ctrl
);
129 host
->bus_hz
/= (priv
->ciu_div
+ 1);
134 static void dw_mci_exynos_set_clksel_timing(struct dw_mci
*host
, u32 timing
)
136 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
139 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7
||
140 priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7_SMU
)
141 clksel
= mci_readl(host
, CLKSEL64
);
143 clksel
= mci_readl(host
, CLKSEL
);
145 clksel
= (clksel
& ~SDMMC_CLKSEL_TIMING_MASK
) | timing
;
147 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7
||
148 priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7_SMU
)
149 mci_writel(host
, CLKSEL64
, clksel
);
151 mci_writel(host
, CLKSEL
, clksel
);
154 * Exynos4412 and Exynos5250 extends the use of CMD register with the
155 * use of bit 29 (which is reserved on standard MSHC controllers) for
156 * optionally bypassing the HOLD register for command and data. The
157 * HOLD register should be bypassed in case there is no phase shift
158 * applied on CMD/DATA that is sent to the card.
160 if (!SDMMC_CLKSEL_GET_DRV_WD3(clksel
) && host
->slot
)
161 set_bit(DW_MMC_CARD_NO_USE_HOLD
, &host
->slot
->flags
);
165 static int dw_mci_exynos_runtime_resume(struct device
*dev
)
167 struct dw_mci
*host
= dev_get_drvdata(dev
);
170 ret
= dw_mci_runtime_resume(dev
);
174 dw_mci_exynos_config_smu(host
);
178 #endif /* CONFIG_PM */
180 #ifdef CONFIG_PM_SLEEP
182 * dw_mci_exynos_suspend_noirq - Exynos-specific suspend code
184 * This ensures that device will be in runtime active state in
185 * dw_mci_exynos_resume_noirq after calling pm_runtime_force_resume()
187 static int dw_mci_exynos_suspend_noirq(struct device
*dev
)
189 pm_runtime_get_noresume(dev
);
190 return pm_runtime_force_suspend(dev
);
194 * dw_mci_exynos_resume_noirq - Exynos-specific resume code
196 * On exynos5420 there is a silicon errata that will sometimes leave the
197 * WAKEUP_INT bit in the CLKSEL register asserted. This bit is 1 to indicate
198 * that it fired and we can clear it by writing a 1 back. Clear it to prevent
199 * interrupts from going off constantly.
201 * We run this code on all exynos variants because it doesn't hurt.
203 static int dw_mci_exynos_resume_noirq(struct device
*dev
)
205 struct dw_mci
*host
= dev_get_drvdata(dev
);
206 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
210 ret
= pm_runtime_force_resume(dev
);
214 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7
||
215 priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7_SMU
)
216 clksel
= mci_readl(host
, CLKSEL64
);
218 clksel
= mci_readl(host
, CLKSEL
);
220 if (clksel
& SDMMC_CLKSEL_WAKEUP_INT
) {
221 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7
||
222 priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7_SMU
)
223 mci_writel(host
, CLKSEL64
, clksel
);
225 mci_writel(host
, CLKSEL
, clksel
);
232 #endif /* CONFIG_PM_SLEEP */
234 static void dw_mci_exynos_config_hs400(struct dw_mci
*host
, u32 timing
)
236 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
240 * Not supported to configure register
243 if (priv
->ctrl_type
< DW_MCI_TYPE_EXYNOS5420
) {
244 if (timing
== MMC_TIMING_MMC_HS400
)
246 "cannot configure HS400, unsupported chipset\n");
250 dqs
= priv
->saved_dqs_en
;
251 strobe
= priv
->saved_strobe_ctrl
;
253 if (timing
== MMC_TIMING_MMC_HS400
) {
254 dqs
|= DATA_STROBE_EN
;
255 strobe
= DQS_CTRL_RD_DELAY(strobe
, priv
->dqs_delay
);
257 dqs
&= ~DATA_STROBE_EN
;
260 mci_writel(host
, HS400_DQS_EN
, dqs
);
261 mci_writel(host
, HS400_DLINE_CTRL
, strobe
);
264 static void dw_mci_exynos_adjust_clock(struct dw_mci
*host
, unsigned int wanted
)
266 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
267 unsigned long actual
;
271 * Don't care if wanted clock is zero or
272 * ciu clock is unavailable
274 if (!wanted
|| IS_ERR(host
->ciu_clk
))
277 /* Guaranteed minimum frequency for cclkin */
278 if (wanted
< EXYNOS_CCLKIN_MIN
)
279 wanted
= EXYNOS_CCLKIN_MIN
;
281 if (wanted
== priv
->cur_speed
)
284 div
= dw_mci_exynos_get_ciu_div(host
);
285 ret
= clk_set_rate(host
->ciu_clk
, wanted
* div
);
288 "failed to set clk-rate %u error: %d\n",
290 actual
= clk_get_rate(host
->ciu_clk
);
291 host
->bus_hz
= actual
/ div
;
292 priv
->cur_speed
= wanted
;
293 host
->current_speed
= 0;
296 static void dw_mci_exynos_set_ios(struct dw_mci
*host
, struct mmc_ios
*ios
)
298 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
299 unsigned int wanted
= ios
->clock
;
300 u32 timing
= ios
->timing
, clksel
;
303 case MMC_TIMING_MMC_HS400
:
304 /* Update tuned sample timing */
305 clksel
= SDMMC_CLKSEL_UP_SAMPLE(
306 priv
->hs400_timing
, priv
->tuned_sample
);
309 case MMC_TIMING_MMC_DDR52
:
310 clksel
= priv
->ddr_timing
;
311 /* Should be double rate for DDR mode */
312 if (ios
->bus_width
== MMC_BUS_WIDTH_8
)
316 clksel
= priv
->sdr_timing
;
319 /* Set clock timing for the requested speed mode*/
320 dw_mci_exynos_set_clksel_timing(host
, clksel
);
322 /* Configure setting for HS400 */
323 dw_mci_exynos_config_hs400(host
, timing
);
325 /* Configure clock rate */
326 dw_mci_exynos_adjust_clock(host
, wanted
);
329 static int dw_mci_exynos_parse_dt(struct dw_mci
*host
)
331 struct dw_mci_exynos_priv_data
*priv
;
332 struct device_node
*np
= host
->dev
->of_node
;
338 priv
= devm_kzalloc(host
->dev
, sizeof(*priv
), GFP_KERNEL
);
342 for (idx
= 0; idx
< ARRAY_SIZE(exynos_compat
); idx
++) {
343 if (of_device_is_compatible(np
, exynos_compat
[idx
].compatible
))
344 priv
->ctrl_type
= exynos_compat
[idx
].ctrl_type
;
347 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS4412
)
348 priv
->ciu_div
= EXYNOS4412_FIXED_CIU_CLK_DIV
- 1;
349 else if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS4210
)
350 priv
->ciu_div
= EXYNOS4210_FIXED_CIU_CLK_DIV
- 1;
352 of_property_read_u32(np
, "samsung,dw-mshc-ciu-div", &div
);
356 ret
= of_property_read_u32_array(np
,
357 "samsung,dw-mshc-sdr-timing", timing
, 2);
361 priv
->sdr_timing
= SDMMC_CLKSEL_TIMING(timing
[0], timing
[1], div
);
363 ret
= of_property_read_u32_array(np
,
364 "samsung,dw-mshc-ddr-timing", timing
, 2);
368 priv
->ddr_timing
= SDMMC_CLKSEL_TIMING(timing
[0], timing
[1], div
);
370 ret
= of_property_read_u32_array(np
,
371 "samsung,dw-mshc-hs400-timing", timing
, 2);
372 if (!ret
&& of_property_read_u32(np
,
373 "samsung,read-strobe-delay", &priv
->dqs_delay
))
375 "read-strobe-delay is not found, assuming usage of default value\n");
377 priv
->hs400_timing
= SDMMC_CLKSEL_TIMING(timing
[0], timing
[1],
378 HS400_FIXED_CIU_CLK_DIV
);
383 static inline u8
dw_mci_exynos_get_clksmpl(struct dw_mci
*host
)
385 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
387 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7
||
388 priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7_SMU
)
389 return SDMMC_CLKSEL_CCLK_SAMPLE(mci_readl(host
, CLKSEL64
));
391 return SDMMC_CLKSEL_CCLK_SAMPLE(mci_readl(host
, CLKSEL
));
394 static inline void dw_mci_exynos_set_clksmpl(struct dw_mci
*host
, u8 sample
)
397 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
399 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7
||
400 priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7_SMU
)
401 clksel
= mci_readl(host
, CLKSEL64
);
403 clksel
= mci_readl(host
, CLKSEL
);
404 clksel
= SDMMC_CLKSEL_UP_SAMPLE(clksel
, sample
);
405 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7
||
406 priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7_SMU
)
407 mci_writel(host
, CLKSEL64
, clksel
);
409 mci_writel(host
, CLKSEL
, clksel
);
412 static inline u8
dw_mci_exynos_move_next_clksmpl(struct dw_mci
*host
)
414 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
418 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7
||
419 priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7_SMU
)
420 clksel
= mci_readl(host
, CLKSEL64
);
422 clksel
= mci_readl(host
, CLKSEL
);
424 sample
= (clksel
+ 1) & 0x7;
425 clksel
= SDMMC_CLKSEL_UP_SAMPLE(clksel
, sample
);
427 if (priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7
||
428 priv
->ctrl_type
== DW_MCI_TYPE_EXYNOS7_SMU
)
429 mci_writel(host
, CLKSEL64
, clksel
);
431 mci_writel(host
, CLKSEL
, clksel
);
436 static s8
dw_mci_exynos_get_best_clksmpl(u8 candiates
)
442 for (i
= 0; i
< iter
; i
++) {
443 __c
= ror8(candiates
, i
);
444 if ((__c
& 0xc7) == 0xc7) {
450 for (i
= 0; i
< iter
; i
++) {
451 __c
= ror8(candiates
, i
);
452 if ((__c
& 0x83) == 0x83) {
462 static int dw_mci_exynos_execute_tuning(struct dw_mci_slot
*slot
, u32 opcode
)
464 struct dw_mci
*host
= slot
->host
;
465 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
466 struct mmc_host
*mmc
= slot
->mmc
;
467 u8 start_smpl
, smpl
, candiates
= 0;
471 start_smpl
= dw_mci_exynos_get_clksmpl(host
);
474 mci_writel(host
, TMOUT
, ~0);
475 smpl
= dw_mci_exynos_move_next_clksmpl(host
);
477 if (!mmc_send_tuning(mmc
, opcode
, NULL
))
478 candiates
|= (1 << smpl
);
480 } while (start_smpl
!= smpl
);
482 found
= dw_mci_exynos_get_best_clksmpl(candiates
);
484 dw_mci_exynos_set_clksmpl(host
, found
);
485 priv
->tuned_sample
= found
;
493 static int dw_mci_exynos_prepare_hs400_tuning(struct dw_mci
*host
,
496 struct dw_mci_exynos_priv_data
*priv
= host
->priv
;
498 dw_mci_exynos_set_clksel_timing(host
, priv
->hs400_timing
);
499 dw_mci_exynos_adjust_clock(host
, (ios
->clock
) << 1);
504 /* Common capabilities of Exynos4/Exynos5 SoC */
505 static unsigned long exynos_dwmmc_caps
[4] = {
506 MMC_CAP_1_8V_DDR
| MMC_CAP_8_BIT_DATA
| MMC_CAP_CMD23
,
512 static const struct dw_mci_drv_data exynos_drv_data
= {
513 .caps
= exynos_dwmmc_caps
,
514 .num_caps
= ARRAY_SIZE(exynos_dwmmc_caps
),
515 .init
= dw_mci_exynos_priv_init
,
516 .set_ios
= dw_mci_exynos_set_ios
,
517 .parse_dt
= dw_mci_exynos_parse_dt
,
518 .execute_tuning
= dw_mci_exynos_execute_tuning
,
519 .prepare_hs400_tuning
= dw_mci_exynos_prepare_hs400_tuning
,
522 static const struct of_device_id dw_mci_exynos_match
[] = {
523 { .compatible
= "samsung,exynos4412-dw-mshc",
524 .data
= &exynos_drv_data
, },
525 { .compatible
= "samsung,exynos5250-dw-mshc",
526 .data
= &exynos_drv_data
, },
527 { .compatible
= "samsung,exynos5420-dw-mshc",
528 .data
= &exynos_drv_data
, },
529 { .compatible
= "samsung,exynos5420-dw-mshc-smu",
530 .data
= &exynos_drv_data
, },
531 { .compatible
= "samsung,exynos7-dw-mshc",
532 .data
= &exynos_drv_data
, },
533 { .compatible
= "samsung,exynos7-dw-mshc-smu",
534 .data
= &exynos_drv_data
, },
537 MODULE_DEVICE_TABLE(of
, dw_mci_exynos_match
);
539 static int dw_mci_exynos_probe(struct platform_device
*pdev
)
541 const struct dw_mci_drv_data
*drv_data
;
542 const struct of_device_id
*match
;
545 match
= of_match_node(dw_mci_exynos_match
, pdev
->dev
.of_node
);
546 drv_data
= match
->data
;
548 pm_runtime_get_noresume(&pdev
->dev
);
549 pm_runtime_set_active(&pdev
->dev
);
550 pm_runtime_enable(&pdev
->dev
);
552 ret
= dw_mci_pltfm_register(pdev
, drv_data
);
554 pm_runtime_disable(&pdev
->dev
);
555 pm_runtime_set_suspended(&pdev
->dev
);
556 pm_runtime_put_noidle(&pdev
->dev
);
564 static int dw_mci_exynos_remove(struct platform_device
*pdev
)
566 pm_runtime_disable(&pdev
->dev
);
567 pm_runtime_set_suspended(&pdev
->dev
);
568 pm_runtime_put_noidle(&pdev
->dev
);
570 return dw_mci_pltfm_remove(pdev
);
573 static const struct dev_pm_ops dw_mci_exynos_pmops
= {
574 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(dw_mci_exynos_suspend_noirq
,
575 dw_mci_exynos_resume_noirq
)
576 SET_RUNTIME_PM_OPS(dw_mci_runtime_suspend
,
577 dw_mci_exynos_runtime_resume
,
581 static struct platform_driver dw_mci_exynos_pltfm_driver
= {
582 .probe
= dw_mci_exynos_probe
,
583 .remove
= dw_mci_exynos_remove
,
585 .name
= "dwmmc_exynos",
586 .of_match_table
= dw_mci_exynos_match
,
587 .pm
= &dw_mci_exynos_pmops
,
591 module_platform_driver(dw_mci_exynos_pltfm_driver
);
593 MODULE_DESCRIPTION("Samsung Specific DW-MSHC Driver Extension");
594 MODULE_AUTHOR("Thomas Abraham <thomas.ab@samsung.com");
595 MODULE_LICENSE("GPL v2");
596 MODULE_ALIAS("platform:dwmmc_exynos");