1 // SPDX-License-Identifier: GPL-2.0-only
3 * sdhci-brcmstb.c Support for SDHCI on Broadcom BRCMSTB SoC's
5 * Copyright (C) 2015 Broadcom Corporation
9 #include <linux/iopoll.h>
10 #include <linux/mmc/host.h>
11 #include <linux/module.h>
13 #include <linux/bitops.h>
14 #include <linux/delay.h>
16 #include "sdhci-cqhci.h"
17 #include "sdhci-pltfm.h"
20 #define SDHCI_VENDOR 0x78
21 #define SDHCI_VENDOR_ENHANCED_STRB 0x1
22 #define SDHCI_VENDOR_GATE_SDCLK_EN 0x2
24 #define BRCMSTB_MATCH_FLAGS_NO_64BIT BIT(0)
25 #define BRCMSTB_MATCH_FLAGS_BROKEN_TIMEOUT BIT(1)
26 #define BRCMSTB_MATCH_FLAGS_HAS_CLOCK_GATE BIT(2)
27 #define BRCMSTB_MATCH_FLAGS_USE_CARD_BUSY BIT(4)
29 #define BRCMSTB_PRIV_FLAGS_HAS_CQE BIT(0)
30 #define BRCMSTB_PRIV_FLAGS_GATE_CLOCK BIT(1)
32 #define SDHCI_ARASAN_CQE_BASE_ADDR 0x200
34 #define SDIO_CFG_CQ_CAPABILITY 0x4c
35 #define SDIO_CFG_CQ_CAPABILITY_FMUL GENMASK(13, 12)
37 #define SDIO_CFG_CTRL 0x0
38 #define SDIO_CFG_CTRL_SDCD_N_TEST_EN BIT(31)
39 #define SDIO_CFG_CTRL_SDCD_N_TEST_LEV BIT(30)
41 #define SDIO_CFG_MAX_50MHZ_MODE 0x1ac
42 #define SDIO_CFG_MAX_50MHZ_MODE_STRAP_OVERRIDE BIT(31)
43 #define SDIO_CFG_MAX_50MHZ_MODE_ENABLE BIT(0)
45 #define MMC_CAP_HSE_MASK (MMC_CAP2_HSX00_1_2V | MMC_CAP2_HSX00_1_8V)
46 /* Select all SD UHS type I SDR speed above 50MB/s */
47 #define MMC_CAP_UHS_I_SDR_MASK (MMC_CAP_UHS_SDR50 | MMC_CAP_UHS_SDR104)
49 struct sdhci_brcmstb_priv
{
50 void __iomem
*cfg_regs
;
56 struct brcmstb_match_priv
{
57 void (*cfginit
)(struct sdhci_host
*host
);
58 void (*hs400es
)(struct mmc_host
*mmc
, struct mmc_ios
*ios
);
59 struct sdhci_ops
*ops
;
60 const unsigned int flags
;
63 static inline void enable_clock_gating(struct sdhci_host
*host
)
65 struct sdhci_pltfm_host
*pltfm_host
= sdhci_priv(host
);
66 struct sdhci_brcmstb_priv
*priv
= sdhci_pltfm_priv(pltfm_host
);
69 if (!(priv
->flags
& BRCMSTB_PRIV_FLAGS_GATE_CLOCK
))
72 reg
= sdhci_readl(host
, SDHCI_VENDOR
);
73 reg
|= SDHCI_VENDOR_GATE_SDCLK_EN
;
74 sdhci_writel(host
, reg
, SDHCI_VENDOR
);
77 static void brcmstb_reset(struct sdhci_host
*host
, u8 mask
)
79 sdhci_and_cqhci_reset(host
, mask
);
81 /* Reset will clear this, so re-enable it */
82 enable_clock_gating(host
);
85 static void brcmstb_sdhci_reset_cmd_data(struct sdhci_host
*host
, u8 mask
)
87 u32 new_mask
= (mask
& (SDHCI_RESET_CMD
| SDHCI_RESET_DATA
)) << 24;
92 * SDHCI_CLOCK_CONTROL register CARD_EN and CLOCK_INT_EN bits shall
93 * be set along with SOFTWARE_RESET register RESET_CMD or RESET_DATA
94 * bits, hence access SDHCI_CLOCK_CONTROL register as 32-bit register
96 new_mask
|= SDHCI_CLOCK_CARD_EN
| SDHCI_CLOCK_INT_EN
;
97 reg
= sdhci_readl(host
, SDHCI_CLOCK_CONTROL
);
98 sdhci_writel(host
, reg
| new_mask
, SDHCI_CLOCK_CONTROL
);
100 reg
= sdhci_readb(host
, SDHCI_SOFTWARE_RESET
);
102 ret
= read_poll_timeout_atomic(sdhci_readb
, reg
, !(reg
& mask
),
104 host
, SDHCI_SOFTWARE_RESET
);
107 pr_err("%s: Reset 0x%x never completed.\n",
108 mmc_hostname(host
->mmc
), (int)mask
);
109 sdhci_err_stats_inc(host
, CTRL_TIMEOUT
);
110 sdhci_dumpregs(host
);
114 static void brcmstb_reset_74165b0(struct sdhci_host
*host
, u8 mask
)
116 /* take care of RESET_ALL as usual */
117 if (mask
& SDHCI_RESET_ALL
)
118 sdhci_and_cqhci_reset(host
, SDHCI_RESET_ALL
);
120 /* cmd and/or data treated differently on this core */
121 if (mask
& (SDHCI_RESET_CMD
| SDHCI_RESET_DATA
))
122 brcmstb_sdhci_reset_cmd_data(host
, mask
);
124 /* Reset will clear this, so re-enable it */
125 enable_clock_gating(host
);
128 static void sdhci_brcmstb_hs400es(struct mmc_host
*mmc
, struct mmc_ios
*ios
)
130 struct sdhci_host
*host
= mmc_priv(mmc
);
134 dev_dbg(mmc_dev(mmc
), "%s(): Setting HS400-Enhanced-Strobe mode\n",
136 reg
= readl(host
->ioaddr
+ SDHCI_VENDOR
);
137 if (ios
->enhanced_strobe
)
138 reg
|= SDHCI_VENDOR_ENHANCED_STRB
;
140 reg
&= ~SDHCI_VENDOR_ENHANCED_STRB
;
141 writel(reg
, host
->ioaddr
+ SDHCI_VENDOR
);
144 static void sdhci_brcmstb_set_clock(struct sdhci_host
*host
, unsigned int clock
)
148 host
->mmc
->actual_clock
= 0;
150 clk
= sdhci_calc_clk(host
, clock
, &host
->mmc
->actual_clock
);
151 sdhci_writew(host
, clk
, SDHCI_CLOCK_CONTROL
);
156 sdhci_enable_clk(host
, clk
);
159 static void sdhci_brcmstb_set_uhs_signaling(struct sdhci_host
*host
,
164 dev_dbg(mmc_dev(host
->mmc
), "%s: Setting UHS signaling for %d timing\n",
166 ctrl_2
= sdhci_readw(host
, SDHCI_HOST_CONTROL2
);
167 /* Select Bus Speed Mode for host */
168 ctrl_2
&= ~SDHCI_CTRL_UHS_MASK
;
169 if ((timing
== MMC_TIMING_MMC_HS200
) ||
170 (timing
== MMC_TIMING_UHS_SDR104
))
171 ctrl_2
|= SDHCI_CTRL_UHS_SDR104
;
172 else if (timing
== MMC_TIMING_UHS_SDR12
)
173 ctrl_2
|= SDHCI_CTRL_UHS_SDR12
;
174 else if (timing
== MMC_TIMING_SD_HS
||
175 timing
== MMC_TIMING_MMC_HS
||
176 timing
== MMC_TIMING_UHS_SDR25
)
177 ctrl_2
|= SDHCI_CTRL_UHS_SDR25
;
178 else if (timing
== MMC_TIMING_UHS_SDR50
)
179 ctrl_2
|= SDHCI_CTRL_UHS_SDR50
;
180 else if ((timing
== MMC_TIMING_UHS_DDR50
) ||
181 (timing
== MMC_TIMING_MMC_DDR52
))
182 ctrl_2
|= SDHCI_CTRL_UHS_DDR50
;
183 else if (timing
== MMC_TIMING_MMC_HS400
)
184 ctrl_2
|= SDHCI_CTRL_HS400
; /* Non-standard */
185 sdhci_writew(host
, ctrl_2
, SDHCI_HOST_CONTROL2
);
188 static void sdhci_brcmstb_cfginit_2712(struct sdhci_host
*host
)
190 struct sdhci_pltfm_host
*pltfm_host
= sdhci_priv(host
);
191 struct sdhci_brcmstb_priv
*brcmstb_priv
= sdhci_pltfm_priv(pltfm_host
);
195 * If we support a speed that requires tuning,
196 * then select the delay line PHY as the clock source.
198 if ((host
->mmc
->caps
& MMC_CAP_UHS_I_SDR_MASK
) || (host
->mmc
->caps2
& MMC_CAP_HSE_MASK
)) {
199 reg
= readl(brcmstb_priv
->cfg_regs
+ SDIO_CFG_MAX_50MHZ_MODE
);
200 reg
&= ~SDIO_CFG_MAX_50MHZ_MODE_ENABLE
;
201 reg
|= SDIO_CFG_MAX_50MHZ_MODE_STRAP_OVERRIDE
;
202 writel(reg
, brcmstb_priv
->cfg_regs
+ SDIO_CFG_MAX_50MHZ_MODE
);
205 if ((host
->mmc
->caps
& MMC_CAP_NONREMOVABLE
) ||
206 (host
->mmc
->caps
& MMC_CAP_NEEDS_POLL
)) {
208 reg
= readl(brcmstb_priv
->cfg_regs
+ SDIO_CFG_CTRL
);
209 reg
&= ~SDIO_CFG_CTRL_SDCD_N_TEST_LEV
;
210 reg
|= SDIO_CFG_CTRL_SDCD_N_TEST_EN
;
211 writel(reg
, brcmstb_priv
->cfg_regs
+ SDIO_CFG_CTRL
);
215 static void sdhci_brcmstb_dumpregs(struct mmc_host
*mmc
)
217 sdhci_dumpregs(mmc_priv(mmc
));
220 static void sdhci_brcmstb_cqe_enable(struct mmc_host
*mmc
)
222 struct sdhci_host
*host
= mmc_priv(mmc
);
225 reg
= sdhci_readl(host
, SDHCI_PRESENT_STATE
);
226 while (reg
& SDHCI_DATA_AVAILABLE
) {
227 sdhci_readl(host
, SDHCI_BUFFER
);
228 reg
= sdhci_readl(host
, SDHCI_PRESENT_STATE
);
231 sdhci_cqe_enable(mmc
);
234 static const struct cqhci_host_ops sdhci_brcmstb_cqhci_ops
= {
235 .enable
= sdhci_brcmstb_cqe_enable
,
236 .disable
= sdhci_cqe_disable
,
237 .dumpregs
= sdhci_brcmstb_dumpregs
,
240 static struct sdhci_ops sdhci_brcmstb_ops
= {
241 .set_clock
= sdhci_set_clock
,
242 .set_bus_width
= sdhci_set_bus_width
,
243 .reset
= sdhci_reset
,
244 .set_uhs_signaling
= sdhci_set_uhs_signaling
,
247 static struct sdhci_ops sdhci_brcmstb_ops_2712
= {
248 .set_clock
= sdhci_set_clock
,
249 .set_power
= sdhci_set_power_and_bus_voltage
,
250 .set_bus_width
= sdhci_set_bus_width
,
251 .reset
= sdhci_reset
,
252 .set_uhs_signaling
= sdhci_set_uhs_signaling
,
255 static struct sdhci_ops sdhci_brcmstb_ops_7216
= {
256 .set_clock
= sdhci_brcmstb_set_clock
,
257 .set_bus_width
= sdhci_set_bus_width
,
258 .reset
= brcmstb_reset
,
259 .set_uhs_signaling
= sdhci_brcmstb_set_uhs_signaling
,
262 static struct sdhci_ops sdhci_brcmstb_ops_74165b0
= {
263 .set_clock
= sdhci_brcmstb_set_clock
,
264 .set_bus_width
= sdhci_set_bus_width
,
265 .reset
= brcmstb_reset_74165b0
,
266 .set_uhs_signaling
= sdhci_brcmstb_set_uhs_signaling
,
269 static const struct brcmstb_match_priv match_priv_2712
= {
270 .cfginit
= sdhci_brcmstb_cfginit_2712
,
271 .ops
= &sdhci_brcmstb_ops_2712
,
274 static struct brcmstb_match_priv match_priv_7425
= {
275 .flags
= BRCMSTB_MATCH_FLAGS_NO_64BIT
|
276 BRCMSTB_MATCH_FLAGS_BROKEN_TIMEOUT
,
277 .ops
= &sdhci_brcmstb_ops
,
280 static struct brcmstb_match_priv match_priv_7445
= {
281 .flags
= BRCMSTB_MATCH_FLAGS_BROKEN_TIMEOUT
,
282 .ops
= &sdhci_brcmstb_ops
,
285 static const struct brcmstb_match_priv match_priv_7216
= {
286 .flags
= BRCMSTB_MATCH_FLAGS_HAS_CLOCK_GATE
,
287 .hs400es
= sdhci_brcmstb_hs400es
,
288 .ops
= &sdhci_brcmstb_ops_7216
,
291 static struct brcmstb_match_priv match_priv_74165b0
= {
292 .flags
= BRCMSTB_MATCH_FLAGS_HAS_CLOCK_GATE
,
293 .hs400es
= sdhci_brcmstb_hs400es
,
294 .ops
= &sdhci_brcmstb_ops_74165b0
,
297 static const struct of_device_id __maybe_unused sdhci_brcm_of_match
[] = {
298 { .compatible
= "brcm,bcm2712-sdhci", .data
= &match_priv_2712
},
299 { .compatible
= "brcm,bcm7425-sdhci", .data
= &match_priv_7425
},
300 { .compatible
= "brcm,bcm7445-sdhci", .data
= &match_priv_7445
},
301 { .compatible
= "brcm,bcm7216-sdhci", .data
= &match_priv_7216
},
302 { .compatible
= "brcm,bcm74165b0-sdhci", .data
= &match_priv_74165b0
},
306 static u32
sdhci_brcmstb_cqhci_irq(struct sdhci_host
*host
, u32 intmask
)
311 if (!sdhci_cqe_irq(host
, intmask
, &cmd_error
, &data_error
))
314 cqhci_irq(host
->mmc
, intmask
, cmd_error
, data_error
);
319 static int sdhci_brcmstb_add_host(struct sdhci_host
*host
,
320 struct sdhci_brcmstb_priv
*priv
)
322 struct cqhci_host
*cq_host
;
326 if ((priv
->flags
& BRCMSTB_PRIV_FLAGS_HAS_CQE
) == 0)
327 return sdhci_add_host(host
);
329 dev_dbg(mmc_dev(host
->mmc
), "CQE is enabled\n");
330 host
->mmc
->caps2
|= MMC_CAP2_CQE
| MMC_CAP2_CQE_DCMD
;
331 ret
= sdhci_setup_host(host
);
335 cq_host
= devm_kzalloc(mmc_dev(host
->mmc
),
336 sizeof(*cq_host
), GFP_KERNEL
);
342 cq_host
->mmio
= host
->ioaddr
+ SDHCI_ARASAN_CQE_BASE_ADDR
;
343 cq_host
->ops
= &sdhci_brcmstb_cqhci_ops
;
345 dma64
= host
->flags
& SDHCI_USE_64_BIT_DMA
;
347 dev_dbg(mmc_dev(host
->mmc
), "Using 64 bit DMA\n");
348 cq_host
->caps
|= CQHCI_TASK_DESC_SZ_128
;
351 ret
= cqhci_init(cq_host
, host
->mmc
, dma64
);
355 ret
= __sdhci_add_host(host
);
362 sdhci_cleanup_host(host
);
366 static int sdhci_brcmstb_probe(struct platform_device
*pdev
)
368 const struct brcmstb_match_priv
*match_priv
;
369 struct sdhci_pltfm_data brcmstb_pdata
;
370 struct sdhci_pltfm_host
*pltfm_host
;
371 const struct of_device_id
*match
;
372 struct sdhci_brcmstb_priv
*priv
;
373 u32 actual_clock_mhz
;
374 struct sdhci_host
*host
;
376 struct clk
*base_clk
= NULL
;
379 match
= of_match_node(sdhci_brcm_of_match
, pdev
->dev
.of_node
);
380 match_priv
= match
->data
;
382 dev_dbg(&pdev
->dev
, "Probe found match for %s\n", match
->compatible
);
384 clk
= devm_clk_get_optional_enabled(&pdev
->dev
, NULL
);
386 return dev_err_probe(&pdev
->dev
, PTR_ERR(clk
),
387 "Failed to get and enable clock from Device Tree\n");
389 memset(&brcmstb_pdata
, 0, sizeof(brcmstb_pdata
));
390 brcmstb_pdata
.ops
= match_priv
->ops
;
391 host
= sdhci_pltfm_init(pdev
, &brcmstb_pdata
,
392 sizeof(struct sdhci_brcmstb_priv
));
394 return PTR_ERR(host
);
396 pltfm_host
= sdhci_priv(host
);
397 priv
= sdhci_pltfm_priv(pltfm_host
);
398 if (device_property_read_bool(&pdev
->dev
, "supports-cqe")) {
399 priv
->flags
|= BRCMSTB_PRIV_FLAGS_HAS_CQE
;
400 match_priv
->ops
->irq
= sdhci_brcmstb_cqhci_irq
;
403 /* Map in the non-standard CFG registers */
404 priv
->cfg_regs
= devm_platform_get_and_ioremap_resource(pdev
, 1, NULL
);
405 if (IS_ERR(priv
->cfg_regs
)) {
406 res
= PTR_ERR(priv
->cfg_regs
);
410 sdhci_get_of_property(pdev
);
411 res
= mmc_of_parse(host
->mmc
);
416 * Automatic clock gating does not work for SD cards that may
417 * voltage switch so only enable it for non-removable devices.
419 if ((match_priv
->flags
& BRCMSTB_MATCH_FLAGS_HAS_CLOCK_GATE
) &&
420 (host
->mmc
->caps
& MMC_CAP_NONREMOVABLE
))
421 priv
->flags
|= BRCMSTB_PRIV_FLAGS_GATE_CLOCK
;
424 * If the chip has enhanced strobe and it's enabled, add
427 if (match_priv
->hs400es
&&
428 (host
->mmc
->caps2
& MMC_CAP2_HS400_ES
))
429 host
->mmc_host_ops
.hs400_enhanced_strobe
= match_priv
->hs400es
;
431 if (match_priv
->cfginit
)
432 match_priv
->cfginit(host
);
435 * Supply the existing CAPS, but clear the UHS modes. This
436 * will allow these modes to be specified by device tree
437 * properties through mmc_of_parse().
439 sdhci_read_caps(host
);
440 if (match_priv
->flags
& BRCMSTB_MATCH_FLAGS_NO_64BIT
)
441 host
->caps
&= ~SDHCI_CAN_64BIT
;
442 host
->caps1
&= ~(SDHCI_SUPPORT_SDR50
| SDHCI_SUPPORT_SDR104
|
443 SDHCI_SUPPORT_DDR50
);
445 if (match_priv
->flags
& BRCMSTB_MATCH_FLAGS_BROKEN_TIMEOUT
)
446 host
->quirks
|= SDHCI_QUIRK_BROKEN_TIMEOUT_VAL
;
448 if (!(match_priv
->flags
& BRCMSTB_MATCH_FLAGS_USE_CARD_BUSY
))
449 host
->mmc_host_ops
.card_busy
= NULL
;
451 /* Change the base clock frequency if the DT property exists */
452 if (device_property_read_u32(&pdev
->dev
, "clock-frequency",
453 &priv
->base_freq_hz
) != 0)
456 base_clk
= devm_clk_get_optional(&pdev
->dev
, "sdio_freq");
457 if (IS_ERR(base_clk
)) {
458 dev_warn(&pdev
->dev
, "Clock for \"sdio_freq\" not found\n");
462 res
= clk_prepare_enable(base_clk
);
466 /* set improved clock rate */
467 clk_set_rate(base_clk
, priv
->base_freq_hz
);
468 actual_clock_mhz
= clk_get_rate(base_clk
) / 1000000;
470 host
->caps
&= ~SDHCI_CLOCK_V3_BASE_MASK
;
471 host
->caps
|= (actual_clock_mhz
<< SDHCI_CLOCK_BASE_SHIFT
);
472 /* Disable presets because they are now incorrect */
473 host
->quirks2
|= SDHCI_QUIRK2_PRESET_VALUE_BROKEN
;
475 dev_dbg(&pdev
->dev
, "Base Clock Frequency changed to %dMHz\n",
477 priv
->base_clk
= base_clk
;
480 res
= sdhci_brcmstb_add_host(host
, priv
);
484 pltfm_host
->clk
= clk
;
488 sdhci_pltfm_free(pdev
);
489 clk_disable_unprepare(base_clk
);
493 static void sdhci_brcmstb_shutdown(struct platform_device
*pdev
)
495 sdhci_pltfm_suspend(&pdev
->dev
);
498 MODULE_DEVICE_TABLE(of
, sdhci_brcm_of_match
);
500 #ifdef CONFIG_PM_SLEEP
501 static int sdhci_brcmstb_suspend(struct device
*dev
)
503 struct sdhci_host
*host
= dev_get_drvdata(dev
);
504 struct sdhci_pltfm_host
*pltfm_host
= sdhci_priv(host
);
505 struct sdhci_brcmstb_priv
*priv
= sdhci_pltfm_priv(pltfm_host
);
507 clk_disable_unprepare(priv
->base_clk
);
508 return sdhci_pltfm_suspend(dev
);
511 static int sdhci_brcmstb_resume(struct device
*dev
)
513 struct sdhci_host
*host
= dev_get_drvdata(dev
);
514 struct sdhci_pltfm_host
*pltfm_host
= sdhci_priv(host
);
515 struct sdhci_brcmstb_priv
*priv
= sdhci_pltfm_priv(pltfm_host
);
518 ret
= sdhci_pltfm_resume(dev
);
519 if (!ret
&& priv
->base_freq_hz
) {
520 ret
= clk_prepare_enable(priv
->base_clk
);
522 * Note: using clk_get_rate() below as clk_get_rate()
523 * honors CLK_GET_RATE_NOCACHE attribute, but clk_set_rate()
524 * may do implicit get_rate() calls that do not honor
525 * CLK_GET_RATE_NOCACHE.
528 (clk_get_rate(priv
->base_clk
) != priv
->base_freq_hz
))
529 ret
= clk_set_rate(priv
->base_clk
, priv
->base_freq_hz
);
536 static const struct dev_pm_ops sdhci_brcmstb_pmops
= {
537 SET_SYSTEM_SLEEP_PM_OPS(sdhci_brcmstb_suspend
, sdhci_brcmstb_resume
)
540 static struct platform_driver sdhci_brcmstb_driver
= {
542 .name
= "sdhci-brcmstb",
543 .probe_type
= PROBE_PREFER_ASYNCHRONOUS
,
544 .pm
= &sdhci_brcmstb_pmops
,
545 .of_match_table
= of_match_ptr(sdhci_brcm_of_match
),
547 .probe
= sdhci_brcmstb_probe
,
548 .remove
= sdhci_pltfm_remove
,
549 .shutdown
= sdhci_brcmstb_shutdown
,
552 module_platform_driver(sdhci_brcmstb_driver
);
554 MODULE_DESCRIPTION("SDHCI driver for Broadcom BRCMSTB SoCs");
555 MODULE_AUTHOR("Broadcom");
556 MODULE_LICENSE("GPL v2");