12a68ea78SSimon Horman /* 22a68ea78SSimon Horman * DMA support for Internal DMAC with SDHI SD/SDIO controller 32a68ea78SSimon Horman * 42a68ea78SSimon Horman * Copyright (C) 2016-17 Renesas Electronics Corporation 52a68ea78SSimon Horman * Copyright (C) 2016-17 Horms Solutions, Simon Horman 62a68ea78SSimon Horman * 72a68ea78SSimon Horman * This program is free software; you can redistribute it and/or modify 82a68ea78SSimon Horman * it under the terms of the GNU General Public License version 2 as 92a68ea78SSimon Horman * published by the Free Software Foundation. 102a68ea78SSimon Horman */ 112a68ea78SSimon Horman 120cbc94daSWolfram Sang #include <linux/bitops.h> 132a68ea78SSimon Horman #include <linux/device.h> 142a68ea78SSimon Horman #include <linux/dma-mapping.h> 152a68ea78SSimon Horman #include <linux/io-64-nonatomic-hi-lo.h> 162a68ea78SSimon Horman #include <linux/mfd/tmio.h> 172a68ea78SSimon Horman #include <linux/mmc/host.h> 182a68ea78SSimon Horman #include <linux/mod_devicetable.h> 192a68ea78SSimon Horman #include <linux/module.h> 202a68ea78SSimon Horman #include <linux/pagemap.h> 212a68ea78SSimon Horman #include <linux/scatterlist.h> 22cd09780fSSimon Horman #include <linux/sys_soc.h> 232a68ea78SSimon Horman 242a68ea78SSimon Horman #include "renesas_sdhi.h" 252a68ea78SSimon Horman #include "tmio_mmc.h" 262a68ea78SSimon Horman 272a68ea78SSimon Horman #define DM_CM_DTRAN_MODE 0x820 282a68ea78SSimon Horman #define DM_CM_DTRAN_CTRL 0x828 292a68ea78SSimon Horman #define DM_CM_RST 0x830 302a68ea78SSimon Horman #define DM_CM_INFO1 0x840 312a68ea78SSimon Horman #define DM_CM_INFO1_MASK 0x848 322a68ea78SSimon Horman #define DM_CM_INFO2 0x850 332a68ea78SSimon Horman #define DM_CM_INFO2_MASK 0x858 342a68ea78SSimon Horman #define DM_DTRAN_ADDR 0x880 352a68ea78SSimon Horman 362a68ea78SSimon Horman /* DM_CM_DTRAN_MODE */ 372a68ea78SSimon Horman #define DTRAN_MODE_CH_NUM_CH0 0 /* "downstream" = for write commands */ 382a68ea78SSimon Horman #define DTRAN_MODE_CH_NUM_CH1 BIT(16) /* "uptream" = for read commands */ 392a68ea78SSimon Horman #define DTRAN_MODE_BUS_WID_TH (BIT(5) | BIT(4)) 402a68ea78SSimon Horman #define DTRAN_MODE_ADDR_MODE BIT(0) /* 1 = Increment address */ 412a68ea78SSimon Horman 422a68ea78SSimon Horman /* DM_CM_DTRAN_CTRL */ 432a68ea78SSimon Horman #define DTRAN_CTRL_DM_START BIT(0) 442a68ea78SSimon Horman 452a68ea78SSimon Horman /* DM_CM_RST */ 462a68ea78SSimon Horman #define RST_DTRANRST1 BIT(9) 472a68ea78SSimon Horman #define RST_DTRANRST0 BIT(8) 482a68ea78SSimon Horman #define RST_RESERVED_BITS GENMASK_ULL(32, 0) 492a68ea78SSimon Horman 502a68ea78SSimon Horman /* DM_CM_INFO1 and DM_CM_INFO1_MASK */ 512a68ea78SSimon Horman #define INFO1_CLEAR 0 522a68ea78SSimon Horman #define INFO1_DTRANEND1 BIT(17) 532a68ea78SSimon Horman #define INFO1_DTRANEND0 BIT(16) 542a68ea78SSimon Horman 552a68ea78SSimon Horman /* DM_CM_INFO2 and DM_CM_INFO2_MASK */ 562a68ea78SSimon Horman #define INFO2_DTRANERR1 BIT(17) 572a68ea78SSimon Horman #define INFO2_DTRANERR0 BIT(16) 582a68ea78SSimon Horman 592a68ea78SSimon Horman /* 602a68ea78SSimon Horman * Specification of this driver: 612a68ea78SSimon Horman * - host->chan_{rx,tx} will be used as a flag of enabling/disabling the dma 622a68ea78SSimon Horman * - Since this SDHI DMAC register set has 16 but 32-bit width, we 632a68ea78SSimon Horman * need a custom accessor. 642a68ea78SSimon Horman */ 652a68ea78SSimon Horman 660cbc94daSWolfram Sang static unsigned long global_flags; 670cbc94daSWolfram Sang /* 680cbc94daSWolfram Sang * Workaround for avoiding to use RX DMAC by multiple channels. 690cbc94daSWolfram Sang * On R-Car H3 ES1.* and M3-W ES1.0, when multiple SDHI channels use 700cbc94daSWolfram Sang * RX DMAC simultaneously, sometimes hundreds of bytes data are not 710cbc94daSWolfram Sang * stored into the system memory even if the DMAC interrupt happened. 720cbc94daSWolfram Sang * So, this driver then uses one RX DMAC channel only. 730cbc94daSWolfram Sang */ 740cbc94daSWolfram Sang #define SDHI_INTERNAL_DMAC_ONE_RX_ONLY 0 750cbc94daSWolfram Sang #define SDHI_INTERNAL_DMAC_RX_IN_USE 1 760cbc94daSWolfram Sang 772a68ea78SSimon Horman /* Definitions for sampling clocks */ 782a68ea78SSimon Horman static struct renesas_sdhi_scc rcar_gen3_scc_taps[] = { 792a68ea78SSimon Horman { 802a68ea78SSimon Horman .clk_rate = 0, 812a68ea78SSimon Horman .tap = 0x00000300, 822a68ea78SSimon Horman }, 832a68ea78SSimon Horman }; 842a68ea78SSimon Horman 852a68ea78SSimon Horman static const struct renesas_sdhi_of_data of_rcar_gen3_compatible = { 862ad1db05SMasahiro Yamada .tmio_flags = TMIO_MMC_HAS_IDLE_WAIT | TMIO_MMC_CLK_ACTUAL | 872ad1db05SMasahiro Yamada TMIO_MMC_HAVE_CBSY | TMIO_MMC_MIN_RCAR2, 882a68ea78SSimon Horman .capabilities = MMC_CAP_SD_HIGHSPEED | MMC_CAP_SDIO_IRQ | 892a68ea78SSimon Horman MMC_CAP_CMD23, 90ef5332c1SWolfram Sang .capabilities2 = MMC_CAP2_NO_WRITE_PROTECT, 912a68ea78SSimon Horman .bus_shift = 2, 922a68ea78SSimon Horman .scc_offset = 0x1000, 932a68ea78SSimon Horman .taps = rcar_gen3_scc_taps, 942a68ea78SSimon Horman .taps_num = ARRAY_SIZE(rcar_gen3_scc_taps), 95ebca50dfSWolfram Sang /* DMAC can handle 0xffffffff blk count but only 1 segment */ 962a68ea78SSimon Horman .max_blk_count = 0xffffffff, 972a68ea78SSimon Horman .max_segs = 1, 982a68ea78SSimon Horman }; 992a68ea78SSimon Horman 1002a68ea78SSimon Horman static const struct of_device_id renesas_sdhi_internal_dmac_of_match[] = { 1012a68ea78SSimon Horman { .compatible = "renesas,sdhi-r8a7795", .data = &of_rcar_gen3_compatible, }, 1022a68ea78SSimon Horman { .compatible = "renesas,sdhi-r8a7796", .data = &of_rcar_gen3_compatible, }, 103d6dc425aSSimon Horman { .compatible = "renesas,rcar-gen3-sdhi", .data = &of_rcar_gen3_compatible, }, 1042a68ea78SSimon Horman {}, 1052a68ea78SSimon Horman }; 1062a68ea78SSimon Horman MODULE_DEVICE_TABLE(of, renesas_sdhi_internal_dmac_of_match); 1072a68ea78SSimon Horman 1082a68ea78SSimon Horman static void 1092a68ea78SSimon Horman renesas_sdhi_internal_dmac_dm_write(struct tmio_mmc_host *host, 1102a68ea78SSimon Horman int addr, u64 val) 1112a68ea78SSimon Horman { 1122a68ea78SSimon Horman writeq(val, host->ctl + addr); 1132a68ea78SSimon Horman } 1142a68ea78SSimon Horman 1152a68ea78SSimon Horman static void 1162a68ea78SSimon Horman renesas_sdhi_internal_dmac_enable_dma(struct tmio_mmc_host *host, bool enable) 1172a68ea78SSimon Horman { 118058db286SMasahiro Yamada struct renesas_sdhi *priv = host_to_priv(host); 119058db286SMasahiro Yamada 1202a68ea78SSimon Horman if (!host->chan_tx || !host->chan_rx) 1212a68ea78SSimon Horman return; 1222a68ea78SSimon Horman 1232a68ea78SSimon Horman if (!enable) 1242a68ea78SSimon Horman renesas_sdhi_internal_dmac_dm_write(host, DM_CM_INFO1, 1252a68ea78SSimon Horman INFO1_CLEAR); 1262a68ea78SSimon Horman 127058db286SMasahiro Yamada if (priv->dma_priv.enable) 128058db286SMasahiro Yamada priv->dma_priv.enable(host, enable); 1292a68ea78SSimon Horman } 1302a68ea78SSimon Horman 1312a68ea78SSimon Horman static void 1322a68ea78SSimon Horman renesas_sdhi_internal_dmac_abort_dma(struct tmio_mmc_host *host) { 1332a68ea78SSimon Horman u64 val = RST_DTRANRST1 | RST_DTRANRST0; 1342a68ea78SSimon Horman 1352a68ea78SSimon Horman renesas_sdhi_internal_dmac_enable_dma(host, false); 1362a68ea78SSimon Horman 1372a68ea78SSimon Horman renesas_sdhi_internal_dmac_dm_write(host, DM_CM_RST, 1382a68ea78SSimon Horman RST_RESERVED_BITS & ~val); 1392a68ea78SSimon Horman renesas_sdhi_internal_dmac_dm_write(host, DM_CM_RST, 1402a68ea78SSimon Horman RST_RESERVED_BITS | val); 1412a68ea78SSimon Horman 1420cbc94daSWolfram Sang if (host->data && host->data->flags & MMC_DATA_READ) 1430cbc94daSWolfram Sang clear_bit(SDHI_INTERNAL_DMAC_RX_IN_USE, &global_flags); 1440cbc94daSWolfram Sang 1452a68ea78SSimon Horman renesas_sdhi_internal_dmac_enable_dma(host, true); 1462a68ea78SSimon Horman } 1472a68ea78SSimon Horman 1482a68ea78SSimon Horman static void 1492a68ea78SSimon Horman renesas_sdhi_internal_dmac_dataend_dma(struct tmio_mmc_host *host) { 15090d95106SMasahiro Yamada struct renesas_sdhi *priv = host_to_priv(host); 15190d95106SMasahiro Yamada 15290d95106SMasahiro Yamada tasklet_schedule(&priv->dma_priv.dma_complete); 1532a68ea78SSimon Horman } 1542a68ea78SSimon Horman 1552a68ea78SSimon Horman static void 1562a68ea78SSimon Horman renesas_sdhi_internal_dmac_start_dma(struct tmio_mmc_host *host, 1572a68ea78SSimon Horman struct mmc_data *data) 1582a68ea78SSimon Horman { 1592a68ea78SSimon Horman struct scatterlist *sg = host->sg_ptr; 1602a68ea78SSimon Horman u32 dtran_mode = DTRAN_MODE_BUS_WID_TH | DTRAN_MODE_ADDR_MODE; 1612a68ea78SSimon Horman 162ae275b9dSMasaharu Hayakawa if (!dma_map_sg(&host->pdev->dev, sg, host->sg_len, 163ae275b9dSMasaharu Hayakawa mmc_get_dma_dir(data))) 16448e1dc10SYoshihiro Shimoda goto force_pio; 1652a68ea78SSimon Horman 166ae275b9dSMasaharu Hayakawa /* This DMAC cannot handle if buffer is not 8-bytes alignment */ 167fe6e0494SYoshihiro Shimoda if (!IS_ALIGNED(sg_dma_address(sg), 8)) 168fe6e0494SYoshihiro Shimoda goto force_pio_with_unmap; 169ae275b9dSMasaharu Hayakawa 1702a68ea78SSimon Horman if (data->flags & MMC_DATA_READ) { 1712a68ea78SSimon Horman dtran_mode |= DTRAN_MODE_CH_NUM_CH1; 1720cbc94daSWolfram Sang if (test_bit(SDHI_INTERNAL_DMAC_ONE_RX_ONLY, &global_flags) && 1730cbc94daSWolfram Sang test_and_set_bit(SDHI_INTERNAL_DMAC_RX_IN_USE, &global_flags)) 174fe6e0494SYoshihiro Shimoda goto force_pio_with_unmap; 1752a68ea78SSimon Horman } else { 1762a68ea78SSimon Horman dtran_mode |= DTRAN_MODE_CH_NUM_CH0; 1772a68ea78SSimon Horman } 1782a68ea78SSimon Horman 1792a68ea78SSimon Horman renesas_sdhi_internal_dmac_enable_dma(host, true); 1802a68ea78SSimon Horman 1812a68ea78SSimon Horman /* set dma parameters */ 1822a68ea78SSimon Horman renesas_sdhi_internal_dmac_dm_write(host, DM_CM_DTRAN_MODE, 1832a68ea78SSimon Horman dtran_mode); 1842a68ea78SSimon Horman renesas_sdhi_internal_dmac_dm_write(host, DM_DTRAN_ADDR, 185a028b435SNiklas Söderlund sg_dma_address(sg)); 18648e1dc10SYoshihiro Shimoda 18748e1dc10SYoshihiro Shimoda return; 18848e1dc10SYoshihiro Shimoda 189fe6e0494SYoshihiro Shimoda force_pio_with_unmap: 190fe6e0494SYoshihiro Shimoda dma_unmap_sg(&host->pdev->dev, sg, host->sg_len, mmc_get_dma_dir(data)); 191fe6e0494SYoshihiro Shimoda 19248e1dc10SYoshihiro Shimoda force_pio: 19348e1dc10SYoshihiro Shimoda host->force_pio = true; 19448e1dc10SYoshihiro Shimoda renesas_sdhi_internal_dmac_enable_dma(host, false); 1952a68ea78SSimon Horman } 1962a68ea78SSimon Horman 1972a68ea78SSimon Horman static void renesas_sdhi_internal_dmac_issue_tasklet_fn(unsigned long arg) 1982a68ea78SSimon Horman { 1992a68ea78SSimon Horman struct tmio_mmc_host *host = (struct tmio_mmc_host *)arg; 2002a68ea78SSimon Horman 2012a68ea78SSimon Horman tmio_mmc_enable_mmc_irqs(host, TMIO_STAT_DATAEND); 2022a68ea78SSimon Horman 2032a68ea78SSimon Horman /* start the DMAC */ 2042a68ea78SSimon Horman renesas_sdhi_internal_dmac_dm_write(host, DM_CM_DTRAN_CTRL, 2052a68ea78SSimon Horman DTRAN_CTRL_DM_START); 2062a68ea78SSimon Horman } 2072a68ea78SSimon Horman 2082a68ea78SSimon Horman static void renesas_sdhi_internal_dmac_complete_tasklet_fn(unsigned long arg) 2092a68ea78SSimon Horman { 2102a68ea78SSimon Horman struct tmio_mmc_host *host = (struct tmio_mmc_host *)arg; 2112a68ea78SSimon Horman enum dma_data_direction dir; 2122a68ea78SSimon Horman 2132a68ea78SSimon Horman spin_lock_irq(&host->lock); 2142a68ea78SSimon Horman 2152a68ea78SSimon Horman if (!host->data) 2162a68ea78SSimon Horman goto out; 2172a68ea78SSimon Horman 2182a68ea78SSimon Horman if (host->data->flags & MMC_DATA_READ) 2192a68ea78SSimon Horman dir = DMA_FROM_DEVICE; 2202a68ea78SSimon Horman else 2212a68ea78SSimon Horman dir = DMA_TO_DEVICE; 2222a68ea78SSimon Horman 2232a68ea78SSimon Horman renesas_sdhi_internal_dmac_enable_dma(host, false); 2242a68ea78SSimon Horman dma_unmap_sg(&host->pdev->dev, host->sg_ptr, host->sg_len, dir); 2252a68ea78SSimon Horman 2260cbc94daSWolfram Sang if (dir == DMA_FROM_DEVICE) 2270cbc94daSWolfram Sang clear_bit(SDHI_INTERNAL_DMAC_RX_IN_USE, &global_flags); 2280cbc94daSWolfram Sang 2292a68ea78SSimon Horman tmio_mmc_do_data_irq(host); 2302a68ea78SSimon Horman out: 2312a68ea78SSimon Horman spin_unlock_irq(&host->lock); 2322a68ea78SSimon Horman } 2332a68ea78SSimon Horman 2342a68ea78SSimon Horman static void 2352a68ea78SSimon Horman renesas_sdhi_internal_dmac_request_dma(struct tmio_mmc_host *host, 2362a68ea78SSimon Horman struct tmio_mmc_data *pdata) 2372a68ea78SSimon Horman { 23890d95106SMasahiro Yamada struct renesas_sdhi *priv = host_to_priv(host); 23990d95106SMasahiro Yamada 2402a68ea78SSimon Horman /* Each value is set to non-zero to assume "enabling" each DMA */ 2412a68ea78SSimon Horman host->chan_rx = host->chan_tx = (void *)0xdeadbeaf; 2422a68ea78SSimon Horman 24390d95106SMasahiro Yamada tasklet_init(&priv->dma_priv.dma_complete, 2442a68ea78SSimon Horman renesas_sdhi_internal_dmac_complete_tasklet_fn, 2452a68ea78SSimon Horman (unsigned long)host); 2462a68ea78SSimon Horman tasklet_init(&host->dma_issue, 2472a68ea78SSimon Horman renesas_sdhi_internal_dmac_issue_tasklet_fn, 2482a68ea78SSimon Horman (unsigned long)host); 2492a68ea78SSimon Horman } 2502a68ea78SSimon Horman 2512a68ea78SSimon Horman static void 2522a68ea78SSimon Horman renesas_sdhi_internal_dmac_release_dma(struct tmio_mmc_host *host) 2532a68ea78SSimon Horman { 2542a68ea78SSimon Horman /* Each value is set to zero to assume "disabling" each DMA */ 2552a68ea78SSimon Horman host->chan_rx = host->chan_tx = NULL; 2562a68ea78SSimon Horman } 2572a68ea78SSimon Horman 25810154068SJulia Lawall static const struct tmio_mmc_dma_ops renesas_sdhi_internal_dmac_dma_ops = { 2592a68ea78SSimon Horman .start = renesas_sdhi_internal_dmac_start_dma, 2602a68ea78SSimon Horman .enable = renesas_sdhi_internal_dmac_enable_dma, 2612a68ea78SSimon Horman .request = renesas_sdhi_internal_dmac_request_dma, 2622a68ea78SSimon Horman .release = renesas_sdhi_internal_dmac_release_dma, 2632a68ea78SSimon Horman .abort = renesas_sdhi_internal_dmac_abort_dma, 2642a68ea78SSimon Horman .dataend = renesas_sdhi_internal_dmac_dataend_dma, 2652a68ea78SSimon Horman }; 2662a68ea78SSimon Horman 267cd09780fSSimon Horman /* 268cd09780fSSimon Horman * Whitelist of specific R-Car Gen3 SoC ES versions to use this DMAC 269cd09780fSSimon Horman * implementation as others may use a different implementation. 270cd09780fSSimon Horman */ 271cd09780fSSimon Horman static const struct soc_device_attribute gen3_soc_whitelist[] = { 2721abf9e52SWolfram Sang /* specific ones */ 2730cbc94daSWolfram Sang { .soc_id = "r8a7795", .revision = "ES1.*", 2740cbc94daSWolfram Sang .data = (void *)BIT(SDHI_INTERNAL_DMAC_ONE_RX_ONLY) }, 2750cbc94daSWolfram Sang { .soc_id = "r8a7796", .revision = "ES1.0", 2760cbc94daSWolfram Sang .data = (void *)BIT(SDHI_INTERNAL_DMAC_ONE_RX_ONLY) }, 2771abf9e52SWolfram Sang /* generic ones */ 2781abf9e52SWolfram Sang { .soc_id = "r8a7795" }, 2791abf9e52SWolfram Sang { .soc_id = "r8a7796" }, 280caeffcf1SMasaharu Hayakawa { .soc_id = "r8a77965" }, 281e419768fSSergei Shtylyov { .soc_id = "r8a77980" }, 2821abf9e52SWolfram Sang { .soc_id = "r8a77995" }, 283cd09780fSSimon Horman { /* sentinel */ } 284cd09780fSSimon Horman }; 285cd09780fSSimon Horman 2862a68ea78SSimon Horman static int renesas_sdhi_internal_dmac_probe(struct platform_device *pdev) 2872a68ea78SSimon Horman { 2880cbc94daSWolfram Sang const struct soc_device_attribute *soc = soc_device_match(gen3_soc_whitelist); 2890cbc94daSWolfram Sang 2900cbc94daSWolfram Sang if (!soc) 291cd09780fSSimon Horman return -ENODEV; 292cd09780fSSimon Horman 2930cbc94daSWolfram Sang global_flags |= (unsigned long)soc->data; 2940cbc94daSWolfram Sang 2952a68ea78SSimon Horman return renesas_sdhi_probe(pdev, &renesas_sdhi_internal_dmac_dma_ops); 2962a68ea78SSimon Horman } 2972a68ea78SSimon Horman 2982a68ea78SSimon Horman static const struct dev_pm_ops renesas_sdhi_internal_dmac_dev_pm_ops = { 2992a68ea78SSimon Horman SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend, 3002a68ea78SSimon Horman pm_runtime_force_resume) 3012a68ea78SSimon Horman SET_RUNTIME_PM_OPS(tmio_mmc_host_runtime_suspend, 3022a68ea78SSimon Horman tmio_mmc_host_runtime_resume, 3032a68ea78SSimon Horman NULL) 3042a68ea78SSimon Horman }; 3052a68ea78SSimon Horman 3062a68ea78SSimon Horman static struct platform_driver renesas_internal_dmac_sdhi_driver = { 3072a68ea78SSimon Horman .driver = { 3082a68ea78SSimon Horman .name = "renesas_sdhi_internal_dmac", 3092a68ea78SSimon Horman .pm = &renesas_sdhi_internal_dmac_dev_pm_ops, 3102a68ea78SSimon Horman .of_match_table = renesas_sdhi_internal_dmac_of_match, 3112a68ea78SSimon Horman }, 3122a68ea78SSimon Horman .probe = renesas_sdhi_internal_dmac_probe, 3132a68ea78SSimon Horman .remove = renesas_sdhi_remove, 3142a68ea78SSimon Horman }; 3152a68ea78SSimon Horman 3162a68ea78SSimon Horman module_platform_driver(renesas_internal_dmac_sdhi_driver); 3172a68ea78SSimon Horman 3182a68ea78SSimon Horman MODULE_DESCRIPTION("Renesas SDHI driver for internal DMAC"); 3192a68ea78SSimon Horman MODULE_AUTHOR("Yoshihiro Shimoda"); 3202a68ea78SSimon Horman MODULE_LICENSE("GPL v2"); 321