1f707079dSWolfram Sang /* SPDX-License-Identifier: GPL-2.0 */ 2b6147490SGuennadi Liakhovetski /* 3b21f13d8SSimon Horman * Driver for the MMC / SD / SDIO cell found in: 4b21f13d8SSimon Horman * 5b21f13d8SSimon Horman * TC6393XB TC6391XB TC6387XB T7L66XB ASIC3 6b6147490SGuennadi Liakhovetski * 7f49bdcdeSWolfram Sang * Copyright (C) 2015-19 Renesas Electronics Corporation 8f49bdcdeSWolfram Sang * Copyright (C) 2016-19 Sang Engineering, Wolfram Sang 987317c4dSSimon Horman * Copyright (C) 2016-17 Horms Solutions, Simon Horman 10b6147490SGuennadi Liakhovetski * Copyright (C) 2007 Ian Molton 11b6147490SGuennadi Liakhovetski * Copyright (C) 2004 Ian Molton 12b6147490SGuennadi Liakhovetski */ 13b6147490SGuennadi Liakhovetski 14b6147490SGuennadi Liakhovetski #ifndef TMIO_MMC_H 15b6147490SGuennadi Liakhovetski #define TMIO_MMC_H 16b6147490SGuennadi Liakhovetski 17361936efSKuninori Morimoto #include <linux/dmaengine.h> 18b6147490SGuennadi Liakhovetski #include <linux/highmem.h> 19b9269fddSGuennadi Liakhovetski #include <linux/mutex.h> 20b6147490SGuennadi Liakhovetski #include <linux/pagemap.h> 216c0cbef6SRafael J. Wysocki #include <linux/scatterlist.h> 22e3de2be7SGuennadi Liakhovetski #include <linux/spinlock.h> 23b8789ec4SUlf Hansson #include <linux/interrupt.h> 24b6147490SGuennadi Liakhovetski 25ac86045eSWolfram Sang #define CTL_SD_CMD 0x00 26ac86045eSWolfram Sang #define CTL_ARG_REG 0x04 27ac86045eSWolfram Sang #define CTL_STOP_INTERNAL_ACTION 0x08 28ac86045eSWolfram Sang #define CTL_XFER_BLK_COUNT 0xa 29ac86045eSWolfram Sang #define CTL_RESPONSE 0x0c 30184adf20SWolfram Sang /* driver merges STATUS and following STATUS2 */ 31ac86045eSWolfram Sang #define CTL_STATUS 0x1c 32184adf20SWolfram Sang /* driver merges IRQ_MASK and following IRQ_MASK2 */ 33ac86045eSWolfram Sang #define CTL_IRQ_MASK 0x20 34ac86045eSWolfram Sang #define CTL_SD_CARD_CLK_CTL 0x24 35ac86045eSWolfram Sang #define CTL_SD_XFER_LEN 0x26 36ac86045eSWolfram Sang #define CTL_SD_MEM_CARD_OPT 0x28 37ac86045eSWolfram Sang #define CTL_SD_ERROR_DETAIL_STATUS 0x2c 38ac86045eSWolfram Sang #define CTL_SD_DATA_PORT 0x30 39ac86045eSWolfram Sang #define CTL_TRANSACTION_CTL 0x34 40ac86045eSWolfram Sang #define CTL_SDIO_STATUS 0x36 41ac86045eSWolfram Sang #define CTL_SDIO_IRQ_MASK 0x38 42ac86045eSWolfram Sang #define CTL_DMA_ENABLE 0xd8 43ac86045eSWolfram Sang #define CTL_RESET_SD 0xe0 44ac86045eSWolfram Sang #define CTL_VERSION 0xe2 452e586f8aSWolfram Sang #define CTL_SDIF_MODE 0xe6 /* only known on R-Car 2+ */ 46ac86045eSWolfram Sang 479afcbf4aSWolfram Sang /* Definitions for values the CTL_STOP_INTERNAL_ACTION register can take */ 489afcbf4aSWolfram Sang #define TMIO_STOP_STP BIT(0) 499afcbf4aSWolfram Sang #define TMIO_STOP_SEC BIT(8) 509afcbf4aSWolfram Sang 51d8acd16cSWolfram Sang /* Definitions for values the CTL_STATUS register can take */ 522cafc5cbSWolfram Sang #define TMIO_STAT_CMDRESPEND BIT(0) 532cafc5cbSWolfram Sang #define TMIO_STAT_DATAEND BIT(2) 542cafc5cbSWolfram Sang #define TMIO_STAT_CARD_REMOVE BIT(3) 552cafc5cbSWolfram Sang #define TMIO_STAT_CARD_INSERT BIT(4) 562cafc5cbSWolfram Sang #define TMIO_STAT_SIGSTATE BIT(5) 572cafc5cbSWolfram Sang #define TMIO_STAT_WRPROTECT BIT(7) 582cafc5cbSWolfram Sang #define TMIO_STAT_CARD_REMOVE_A BIT(8) 592cafc5cbSWolfram Sang #define TMIO_STAT_CARD_INSERT_A BIT(9) 602cafc5cbSWolfram Sang #define TMIO_STAT_SIGSTATE_A BIT(10) 612cafc5cbSWolfram Sang 62d8acd16cSWolfram Sang /* These belong technically to CTL_STATUS2, but the driver merges them */ 632cafc5cbSWolfram Sang #define TMIO_STAT_CMD_IDX_ERR BIT(16) 642cafc5cbSWolfram Sang #define TMIO_STAT_CRCFAIL BIT(17) 652cafc5cbSWolfram Sang #define TMIO_STAT_STOPBIT_ERR BIT(18) 662cafc5cbSWolfram Sang #define TMIO_STAT_DATATIMEOUT BIT(19) 672cafc5cbSWolfram Sang #define TMIO_STAT_RXOVERFLOW BIT(20) 682cafc5cbSWolfram Sang #define TMIO_STAT_TXUNDERRUN BIT(21) 692cafc5cbSWolfram Sang #define TMIO_STAT_CMDTIMEOUT BIT(22) 7083e95351SWolfram Sang #define TMIO_STAT_DAT0 BIT(23) /* only known on R-Car so far */ 712cafc5cbSWolfram Sang #define TMIO_STAT_RXRDY BIT(24) 722cafc5cbSWolfram Sang #define TMIO_STAT_TXRQ BIT(25) 731970701fSWolfram Sang #define TMIO_STAT_ALWAYS_SET_27 BIT(27) /* only known on R-Car 2+ so far */ 74a21553c9SWolfram Sang #define TMIO_STAT_ILL_FUNC BIT(29) /* only when !TMIO_MMC_HAS_IDLE_WAIT */ 75a21553c9SWolfram Sang #define TMIO_STAT_SCLKDIVEN BIT(29) /* only when TMIO_MMC_HAS_IDLE_WAIT */ 762cafc5cbSWolfram Sang #define TMIO_STAT_CMD_BUSY BIT(30) 772cafc5cbSWolfram Sang #define TMIO_STAT_ILL_ACCESS BIT(31) 78ac86045eSWolfram Sang 79c78e1694SWolfram Sang /* Definitions for values the CTL_SD_CARD_CLK_CTL register can take */ 80ac86045eSWolfram Sang #define CLK_CTL_DIV_MASK 0xff 81ac86045eSWolfram Sang #define CLK_CTL_SCLKEN BIT(8) 82ac86045eSWolfram Sang 83c78e1694SWolfram Sang /* Definitions for values the CTL_SD_MEM_CARD_OPT register can take */ 8430ae3e13SWolfram Sang #define CARD_OPT_TOP_MASK 0xf0 8530ae3e13SWolfram Sang #define CARD_OPT_TOP_SHIFT 4 86b191deceSWolfram Sang #define CARD_OPT_EXTOP BIT(9) /* first appeared on R-Car Gen3 SDHI */ 870bc0b6e8SWolfram Sang #define CARD_OPT_WIDTH8 BIT(13) 88b191deceSWolfram Sang #define CARD_OPT_ALWAYS1 BIT(14) 890bc0b6e8SWolfram Sang #define CARD_OPT_WIDTH BIT(15) 900bc0b6e8SWolfram Sang 91d8acd16cSWolfram Sang /* Definitions for values the CTL_SDIO_STATUS register can take */ 92b6147490SGuennadi Liakhovetski #define TMIO_SDIO_STAT_IOIRQ 0x0001 93b6147490SGuennadi Liakhovetski #define TMIO_SDIO_STAT_EXPUB52 0x4000 94b6147490SGuennadi Liakhovetski #define TMIO_SDIO_STAT_EXWT 0x8000 95b6147490SGuennadi Liakhovetski #define TMIO_SDIO_MASK_ALL 0xc007 96b6147490SGuennadi Liakhovetski 97ee289815SWolfram Sang #define TMIO_SDIO_SETBITS_MASK 0x0006 98ee289815SWolfram Sang 995af02d32SWolfram Sang /* Definitions for values the CTL_DMA_ENABLE register can take */ 1005af02d32SWolfram Sang #define DMA_ENABLE_DMASDRW BIT(1) 1015af02d32SWolfram Sang 1022e586f8aSWolfram Sang /* Definitions for values the CTL_SDIF_MODE register can take */ 1032e586f8aSWolfram Sang #define SDIF_MODE_HS400 BIT(0) /* only known on R-Car 2+ */ 1042e586f8aSWolfram Sang 105b6147490SGuennadi Liakhovetski /* Define some IRQ masks */ 106b6147490SGuennadi Liakhovetski /* This is the mask used at reset by the chip */ 107b6147490SGuennadi Liakhovetski #define TMIO_MASK_ALL 0x837f031d 1089f12cac1SWolfram Sang #define TMIO_MASK_ALL_RCAR2 0x8b7f031d 109b6147490SGuennadi Liakhovetski #define TMIO_MASK_READOP (TMIO_STAT_RXRDY | TMIO_STAT_DATAEND) 110b6147490SGuennadi Liakhovetski #define TMIO_MASK_WRITEOP (TMIO_STAT_TXRQ | TMIO_STAT_DATAEND) 111b6147490SGuennadi Liakhovetski #define TMIO_MASK_CMD (TMIO_STAT_CMDRESPEND | TMIO_STAT_CMDTIMEOUT | \ 112b6147490SGuennadi Liakhovetski TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT) 113b6147490SGuennadi Liakhovetski #define TMIO_MASK_IRQ (TMIO_MASK_READOP | TMIO_MASK_WRITEOP | TMIO_MASK_CMD) 114b6147490SGuennadi Liakhovetski 115609e5fbaSWolfram Sang #define TMIO_MAX_BLK_SIZE 512 116609e5fbaSWolfram Sang 117b6147490SGuennadi Liakhovetski struct tmio_mmc_data; 1185add2acaSKuninori Morimoto struct tmio_mmc_host; 119b6147490SGuennadi Liakhovetski 120631fa73cSSimon Horman struct tmio_mmc_dma_ops { 121631fa73cSSimon Horman void (*start)(struct tmio_mmc_host *host, struct mmc_data *data); 122631fa73cSSimon Horman void (*enable)(struct tmio_mmc_host *host, bool enable); 123631fa73cSSimon Horman void (*request)(struct tmio_mmc_host *host, 124631fa73cSSimon Horman struct tmio_mmc_data *pdata); 125631fa73cSSimon Horman void (*release)(struct tmio_mmc_host *host); 126631fa73cSSimon Horman void (*abort)(struct tmio_mmc_host *host); 12792d0f925SSimon Horman void (*dataend)(struct tmio_mmc_host *host); 1286dca9a9cSYoshihiro Shimoda 1296dca9a9cSYoshihiro Shimoda /* optional */ 1306dca9a9cSYoshihiro Shimoda void (*end)(struct tmio_mmc_host *host); /* held host->lock */ 131*af728d7aSWolfram Sang bool (*dma_irq)(struct tmio_mmc_host *host); 132631fa73cSSimon Horman }; 133631fa73cSSimon Horman 134b6147490SGuennadi Liakhovetski struct tmio_mmc_host { 135b6147490SGuennadi Liakhovetski void __iomem *ctl; 136b6147490SGuennadi Liakhovetski struct mmc_command *cmd; 137b6147490SGuennadi Liakhovetski struct mmc_request *mrq; 138b6147490SGuennadi Liakhovetski struct mmc_data *data; 139b6147490SGuennadi Liakhovetski struct mmc_host *mmc; 140c055fc75SMasahiro Yamada struct mmc_host_ops ops; 141b6147490SGuennadi Liakhovetski 142b6147490SGuennadi Liakhovetski /* Callbacks for clock / power control */ 143b6147490SGuennadi Liakhovetski void (*set_pwr)(struct platform_device *host, int state); 144b6147490SGuennadi Liakhovetski 145b6147490SGuennadi Liakhovetski /* pio related stuff */ 146b6147490SGuennadi Liakhovetski struct scatterlist *sg_ptr; 147b6147490SGuennadi Liakhovetski struct scatterlist *sg_orig; 148b6147490SGuennadi Liakhovetski unsigned int sg_len; 149b6147490SGuennadi Liakhovetski unsigned int sg_off; 150c4ba0e4aSMasahiro Yamada unsigned int bus_shift; 151b6147490SGuennadi Liakhovetski 152b6147490SGuennadi Liakhovetski struct platform_device *pdev; 153b6147490SGuennadi Liakhovetski struct tmio_mmc_data *pdata; 154b6147490SGuennadi Liakhovetski 155b6147490SGuennadi Liakhovetski /* DMA support */ 156d3dd5db0SMasahiro Yamada bool dma_on; 157b6147490SGuennadi Liakhovetski struct dma_chan *chan_rx; 158b6147490SGuennadi Liakhovetski struct dma_chan *chan_tx; 159b6147490SGuennadi Liakhovetski struct tasklet_struct dma_issue; 160b6147490SGuennadi Liakhovetski struct scatterlist bounce_sg; 161b6147490SGuennadi Liakhovetski u8 *bounce_buf; 162b6147490SGuennadi Liakhovetski 163b6147490SGuennadi Liakhovetski /* Track lost interrupts */ 164b6147490SGuennadi Liakhovetski struct delayed_work delayed_reset_work; 165b9269fddSGuennadi Liakhovetski struct work_struct done; 166b9269fddSGuennadi Liakhovetski 167ae12d250SUlf Hansson /* Cache */ 16854680fe7SSimon Horman u32 sdcard_irq_mask; 16954680fe7SSimon Horman u32 sdio_irq_mask; 170ae12d250SUlf Hansson unsigned int clk_cache; 1711970701fSWolfram Sang u32 sdcard_irq_setbit_mask; 1720d856c4cSWolfram Sang u32 sdcard_irq_mask_all; 17354680fe7SSimon Horman 174b9269fddSGuennadi Liakhovetski spinlock_t lock; /* protect host private data */ 175b6147490SGuennadi Liakhovetski unsigned long last_req_ts; 176b9269fddSGuennadi Liakhovetski struct mutex ios_lock; /* protect set_ios() context */ 1772b1ac5c2SGuennadi Liakhovetski bool native_hotplug; 1787501c431SUlf Hansson bool sdio_irq_enabled; 179dfe9a229SKuninori Morimoto 1802f87365fSSimon Horman /* Mandatory callback */ 1810ea28210SBen Hutchings int (*clk_enable)(struct tmio_mmc_host *host); 1820196c8dbSMasahiro Yamada void (*set_clock)(struct tmio_mmc_host *host, unsigned int clock); 1832f87365fSSimon Horman 1842f87365fSSimon Horman /* Optional callbacks */ 1850ea28210SBen Hutchings void (*clk_disable)(struct tmio_mmc_host *host); 18685c02dddSKuninori Morimoto int (*multi_io_quirk)(struct mmc_card *card, 18785c02dddSKuninori Morimoto unsigned int direction, int blk_size); 1882f87365fSSimon Horman int (*write16_hook)(struct tmio_mmc_host *host, int addr); 1892e586f8aSWolfram Sang void (*reset)(struct tmio_mmc_host *host, bool preserve); 190ed2fab9aSYoshihiro Shimoda bool (*check_retune)(struct tmio_mmc_host *host, struct mmc_request *mrq); 191354f47b6SWolfram Sang void (*fixup_request)(struct tmio_mmc_host *host, struct mmc_request *mrq); 19258959f89SWolfram Sang unsigned int (*get_timeout_cycles)(struct tmio_mmc_host *host); 1934f119977SAi Kyuse 194631fa73cSSimon Horman const struct tmio_mmc_dma_ops *dma_ops; 195b6147490SGuennadi Liakhovetski }; 196b6147490SGuennadi Liakhovetski 197b21fc294SMasahiro Yamada struct tmio_mmc_host *tmio_mmc_host_alloc(struct platform_device *pdev, 198b21fc294SMasahiro Yamada struct tmio_mmc_data *pdata); 19994b110afSKuninori Morimoto void tmio_mmc_host_free(struct tmio_mmc_host *host); 200bc45719cSMasahiro Yamada int tmio_mmc_host_probe(struct tmio_mmc_host *host); 201b6147490SGuennadi Liakhovetski void tmio_mmc_host_remove(struct tmio_mmc_host *host); 202b6147490SGuennadi Liakhovetski void tmio_mmc_do_data_irq(struct tmio_mmc_host *host); 203b6147490SGuennadi Liakhovetski 204b6147490SGuennadi Liakhovetski void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host *host, u32 i); 205b6147490SGuennadi Liakhovetski void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host *host, u32 i); 2068e7bfdb3SMagnus Damm irqreturn_t tmio_mmc_irq(int irq, void *devid); 207b6147490SGuennadi Liakhovetski 20814c9825fSAdrian Hunter static inline char *tmio_mmc_kmap_atomic(struct scatterlist *sg) 209b6147490SGuennadi Liakhovetski { 2108e8d695fSAdrian Hunter return kmap_local_page(sg_page(sg)) + sg->offset; 211b6147490SGuennadi Liakhovetski } 212b6147490SGuennadi Liakhovetski 213b6147490SGuennadi Liakhovetski static inline void tmio_mmc_kunmap_atomic(struct scatterlist *sg, 21414c9825fSAdrian Hunter void *virt) 215b6147490SGuennadi Liakhovetski { 2168e8d695fSAdrian Hunter kunmap_local(virt - sg->offset); 217b6147490SGuennadi Liakhovetski } 218b6147490SGuennadi Liakhovetski 2199ade7dbfSUlf Hansson #ifdef CONFIG_PM 2207311bef0SGuennadi Liakhovetski int tmio_mmc_host_runtime_suspend(struct device *dev); 2217311bef0SGuennadi Liakhovetski int tmio_mmc_host_runtime_resume(struct device *dev); 222710dec95SUlf Hansson #endif 2237311bef0SGuennadi Liakhovetski 224a11862d3SSimon Horman static inline u16 sd_ctrl_read16(struct tmio_mmc_host *host, int addr) 225a11862d3SSimon Horman { 226d63da8c6SWolfram Sang return ioread16(host->ctl + (addr << host->bus_shift)); 227a11862d3SSimon Horman } 228a11862d3SSimon Horman 229a11862d3SSimon Horman static inline void sd_ctrl_read16_rep(struct tmio_mmc_host *host, int addr, 230a11862d3SSimon Horman u16 *buf, int count) 231a11862d3SSimon Horman { 2320c36fc0dSWolfram Sang ioread16_rep(host->ctl + (addr << host->bus_shift), buf, count); 233a11862d3SSimon Horman } 234a11862d3SSimon Horman 235f2218db8SSimon Horman static inline u32 sd_ctrl_read16_and_16_as_32(struct tmio_mmc_host *host, 236f2218db8SSimon Horman int addr) 237a11862d3SSimon Horman { 238d63da8c6SWolfram Sang return ioread16(host->ctl + (addr << host->bus_shift)) | 239d63da8c6SWolfram Sang ioread16(host->ctl + ((addr + 2) << host->bus_shift)) << 16; 240a11862d3SSimon Horman } 241a11862d3SSimon Horman 2428185e51fSChris Brandt static inline void sd_ctrl_read32_rep(struct tmio_mmc_host *host, int addr, 2438185e51fSChris Brandt u32 *buf, int count) 2448185e51fSChris Brandt { 2450c36fc0dSWolfram Sang ioread32_rep(host->ctl + (addr << host->bus_shift), buf, count); 2468185e51fSChris Brandt } 2478185e51fSChris Brandt 248f2218db8SSimon Horman static inline void sd_ctrl_write16(struct tmio_mmc_host *host, int addr, 249f2218db8SSimon Horman u16 val) 250a11862d3SSimon Horman { 251973ed3afSSimon Horman /* If there is a hook and it returns non-zero then there 252973ed3afSSimon Horman * is an error and the write should be skipped 253973ed3afSSimon Horman */ 254dfe9a229SKuninori Morimoto if (host->write16_hook && host->write16_hook(host, addr)) 255973ed3afSSimon Horman return; 256d63da8c6SWolfram Sang iowrite16(val, host->ctl + (addr << host->bus_shift)); 257a11862d3SSimon Horman } 258a11862d3SSimon Horman 259a11862d3SSimon Horman static inline void sd_ctrl_write16_rep(struct tmio_mmc_host *host, int addr, 260a11862d3SSimon Horman u16 *buf, int count) 261a11862d3SSimon Horman { 2620c36fc0dSWolfram Sang iowrite16_rep(host->ctl + (addr << host->bus_shift), buf, count); 263a11862d3SSimon Horman } 264a11862d3SSimon Horman 265f2218db8SSimon Horman static inline void sd_ctrl_write32_as_16_and_16(struct tmio_mmc_host *host, 266f2218db8SSimon Horman int addr, u32 val) 267a11862d3SSimon Horman { 2681970701fSWolfram Sang if (addr == CTL_IRQ_MASK || addr == CTL_STATUS) 2691970701fSWolfram Sang val |= host->sdcard_irq_setbit_mask; 2701970701fSWolfram Sang 271d63da8c6SWolfram Sang iowrite16(val & 0xffff, host->ctl + (addr << host->bus_shift)); 272d63da8c6SWolfram Sang iowrite16(val >> 16, host->ctl + ((addr + 2) << host->bus_shift)); 273a11862d3SSimon Horman } 274a11862d3SSimon Horman 2755603731aSTakeshi Saito static inline void sd_ctrl_write32(struct tmio_mmc_host *host, int addr, u32 val) 2765603731aSTakeshi Saito { 2775603731aSTakeshi Saito iowrite32(val, host->ctl + (addr << host->bus_shift)); 2785603731aSTakeshi Saito } 2795603731aSTakeshi Saito 2808185e51fSChris Brandt static inline void sd_ctrl_write32_rep(struct tmio_mmc_host *host, int addr, 2818185e51fSChris Brandt const u32 *buf, int count) 2828185e51fSChris Brandt { 2830c36fc0dSWolfram Sang iowrite32_rep(host->ctl + (addr << host->bus_shift), buf, count); 2848185e51fSChris Brandt } 2858185e51fSChris Brandt 286b6147490SGuennadi Liakhovetski #endif 287