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 * 787317c4dSSimon Horman * Copyright (C) 2015-17 Renesas Electronics Corporation 887317c4dSSimon Horman * Copyright (C) 2016-17 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 45db924bbaSMasaharu Hayakawa #define CTL_SDIF_MODE 0xe6 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) 73a21553c9SWolfram Sang #define TMIO_STAT_ILL_FUNC BIT(29) /* only when !TMIO_MMC_HAS_IDLE_WAIT */ 74a21553c9SWolfram Sang #define TMIO_STAT_SCLKDIVEN BIT(29) /* only when TMIO_MMC_HAS_IDLE_WAIT */ 752cafc5cbSWolfram Sang #define TMIO_STAT_CMD_BUSY BIT(30) 762cafc5cbSWolfram Sang #define TMIO_STAT_ILL_ACCESS BIT(31) 77ac86045eSWolfram Sang 78c78e1694SWolfram Sang /* Definitions for values the CTL_SD_CARD_CLK_CTL register can take */ 79ac86045eSWolfram Sang #define CLK_CTL_DIV_MASK 0xff 80ac86045eSWolfram Sang #define CLK_CTL_SCLKEN BIT(8) 81ac86045eSWolfram Sang 82c78e1694SWolfram Sang /* Definitions for values the CTL_SD_MEM_CARD_OPT register can take */ 830bc0b6e8SWolfram Sang #define CARD_OPT_WIDTH8 BIT(13) 840bc0b6e8SWolfram Sang #define CARD_OPT_WIDTH BIT(15) 850bc0b6e8SWolfram Sang 86d8acd16cSWolfram Sang /* Definitions for values the CTL_SDIO_STATUS register can take */ 87b6147490SGuennadi Liakhovetski #define TMIO_SDIO_STAT_IOIRQ 0x0001 88b6147490SGuennadi Liakhovetski #define TMIO_SDIO_STAT_EXPUB52 0x4000 89b6147490SGuennadi Liakhovetski #define TMIO_SDIO_STAT_EXWT 0x8000 90b6147490SGuennadi Liakhovetski #define TMIO_SDIO_MASK_ALL 0xc007 91b6147490SGuennadi Liakhovetski 92ee289815SWolfram Sang #define TMIO_SDIO_SETBITS_MASK 0x0006 93ee289815SWolfram Sang 945af02d32SWolfram Sang /* Definitions for values the CTL_DMA_ENABLE register can take */ 955af02d32SWolfram Sang #define DMA_ENABLE_DMASDRW BIT(1) 965af02d32SWolfram Sang 97b6147490SGuennadi Liakhovetski /* Define some IRQ masks */ 98b6147490SGuennadi Liakhovetski /* This is the mask used at reset by the chip */ 99202367cbSNiklas Söderlund #define TMIO_MASK_INIT_RCAR2 0x8b7f031d /* Initial value for R-Car Gen2+ */ 100b6147490SGuennadi Liakhovetski #define TMIO_MASK_ALL 0x837f031d 101b6147490SGuennadi Liakhovetski #define TMIO_MASK_READOP (TMIO_STAT_RXRDY | TMIO_STAT_DATAEND) 102b6147490SGuennadi Liakhovetski #define TMIO_MASK_WRITEOP (TMIO_STAT_TXRQ | TMIO_STAT_DATAEND) 103b6147490SGuennadi Liakhovetski #define TMIO_MASK_CMD (TMIO_STAT_CMDRESPEND | TMIO_STAT_CMDTIMEOUT | \ 104b6147490SGuennadi Liakhovetski TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT) 105b6147490SGuennadi Liakhovetski #define TMIO_MASK_IRQ (TMIO_MASK_READOP | TMIO_MASK_WRITEOP | TMIO_MASK_CMD) 106b6147490SGuennadi Liakhovetski 107b6147490SGuennadi Liakhovetski struct tmio_mmc_data; 1085add2acaSKuninori Morimoto struct tmio_mmc_host; 109b6147490SGuennadi Liakhovetski 110631fa73cSSimon Horman struct tmio_mmc_dma_ops { 111631fa73cSSimon Horman void (*start)(struct tmio_mmc_host *host, struct mmc_data *data); 112631fa73cSSimon Horman void (*enable)(struct tmio_mmc_host *host, bool enable); 113631fa73cSSimon Horman void (*request)(struct tmio_mmc_host *host, 114631fa73cSSimon Horman struct tmio_mmc_data *pdata); 115631fa73cSSimon Horman void (*release)(struct tmio_mmc_host *host); 116631fa73cSSimon Horman void (*abort)(struct tmio_mmc_host *host); 11792d0f925SSimon Horman void (*dataend)(struct tmio_mmc_host *host); 118631fa73cSSimon Horman }; 119631fa73cSSimon Horman 120b6147490SGuennadi Liakhovetski struct tmio_mmc_host { 121b6147490SGuennadi Liakhovetski void __iomem *ctl; 122b6147490SGuennadi Liakhovetski struct mmc_command *cmd; 123b6147490SGuennadi Liakhovetski struct mmc_request *mrq; 124b6147490SGuennadi Liakhovetski struct mmc_data *data; 125b6147490SGuennadi Liakhovetski struct mmc_host *mmc; 126c055fc75SMasahiro Yamada struct mmc_host_ops ops; 127b6147490SGuennadi Liakhovetski 128b6147490SGuennadi Liakhovetski /* Callbacks for clock / power control */ 129b6147490SGuennadi Liakhovetski void (*set_pwr)(struct platform_device *host, int state); 130b6147490SGuennadi Liakhovetski 131b6147490SGuennadi Liakhovetski /* pio related stuff */ 132b6147490SGuennadi Liakhovetski struct scatterlist *sg_ptr; 133b6147490SGuennadi Liakhovetski struct scatterlist *sg_orig; 134b6147490SGuennadi Liakhovetski unsigned int sg_len; 135b6147490SGuennadi Liakhovetski unsigned int sg_off; 136c4ba0e4aSMasahiro Yamada unsigned int bus_shift; 137b6147490SGuennadi Liakhovetski 138b6147490SGuennadi Liakhovetski struct platform_device *pdev; 139b6147490SGuennadi Liakhovetski struct tmio_mmc_data *pdata; 140b6147490SGuennadi Liakhovetski 141b6147490SGuennadi Liakhovetski /* DMA support */ 142d3dd5db0SMasahiro Yamada bool dma_on; 143b6147490SGuennadi Liakhovetski struct dma_chan *chan_rx; 144b6147490SGuennadi Liakhovetski struct dma_chan *chan_tx; 145b6147490SGuennadi Liakhovetski struct tasklet_struct dma_issue; 146b6147490SGuennadi Liakhovetski struct scatterlist bounce_sg; 147b6147490SGuennadi Liakhovetski u8 *bounce_buf; 148b6147490SGuennadi Liakhovetski 149b6147490SGuennadi Liakhovetski /* Track lost interrupts */ 150b6147490SGuennadi Liakhovetski struct delayed_work delayed_reset_work; 151b9269fddSGuennadi Liakhovetski struct work_struct done; 152b9269fddSGuennadi Liakhovetski 153ae12d250SUlf Hansson /* Cache */ 15454680fe7SSimon Horman u32 sdcard_irq_mask; 15554680fe7SSimon Horman u32 sdio_irq_mask; 156ae12d250SUlf Hansson unsigned int clk_cache; 15754680fe7SSimon Horman 158b9269fddSGuennadi Liakhovetski spinlock_t lock; /* protect host private data */ 159b6147490SGuennadi Liakhovetski unsigned long last_req_ts; 160b9269fddSGuennadi Liakhovetski struct mutex ios_lock; /* protect set_ios() context */ 1612b1ac5c2SGuennadi Liakhovetski bool native_hotplug; 1627501c431SUlf Hansson bool sdio_irq_enabled; 163dfe9a229SKuninori Morimoto 1642f87365fSSimon Horman /* Mandatory callback */ 1650ea28210SBen Hutchings int (*clk_enable)(struct tmio_mmc_host *host); 1660196c8dbSMasahiro Yamada void (*set_clock)(struct tmio_mmc_host *host, unsigned int clock); 1672f87365fSSimon Horman 1682f87365fSSimon Horman /* Optional callbacks */ 1690ea28210SBen Hutchings void (*clk_disable)(struct tmio_mmc_host *host); 17085c02dddSKuninori Morimoto int (*multi_io_quirk)(struct mmc_card *card, 17185c02dddSKuninori Morimoto unsigned int direction, int blk_size); 1722f87365fSSimon Horman int (*write16_hook)(struct tmio_mmc_host *host, int addr); 173acb9fce7SMasahiro Yamada void (*reset)(struct tmio_mmc_host *host); 174e8f36b5dSAi Kyuse void (*hw_reset)(struct tmio_mmc_host *host); 1754f119977SAi Kyuse void (*prepare_tuning)(struct tmio_mmc_host *host, unsigned long tap); 1764f119977SAi Kyuse bool (*check_scc_error)(struct tmio_mmc_host *host); 1774f119977SAi Kyuse 1784f119977SAi Kyuse /* 1794f119977SAi Kyuse * Mandatory callback for tuning to occur which is optional for SDR50 1804f119977SAi Kyuse * and mandatory for SDR104. 1814f119977SAi Kyuse */ 1824f119977SAi Kyuse unsigned int (*init_tuning)(struct tmio_mmc_host *host); 1834f119977SAi Kyuse int (*select_tuning)(struct tmio_mmc_host *host); 1844f119977SAi Kyuse 1854f119977SAi Kyuse /* Tuning values: 1 for success, 0 for failure */ 1864f119977SAi Kyuse DECLARE_BITMAP(taps, BITS_PER_BYTE * sizeof(long)); 1874f119977SAi Kyuse unsigned int tap_num; 188db924bbaSMasaharu Hayakawa unsigned long tap_set; 189db924bbaSMasaharu Hayakawa 190db924bbaSMasaharu Hayakawa void (*prepare_hs400_tuning)(struct tmio_mmc_host *host); 191db924bbaSMasaharu Hayakawa void (*hs400_downgrade)(struct tmio_mmc_host *host); 192db924bbaSMasaharu Hayakawa void (*hs400_complete)(struct tmio_mmc_host *host); 193631fa73cSSimon Horman 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 208b6147490SGuennadi Liakhovetski static inline char *tmio_mmc_kmap_atomic(struct scatterlist *sg, 209b6147490SGuennadi Liakhovetski unsigned long *flags) 210b6147490SGuennadi Liakhovetski { 211b6147490SGuennadi Liakhovetski local_irq_save(*flags); 212482fce99SCong Wang return kmap_atomic(sg_page(sg)) + sg->offset; 213b6147490SGuennadi Liakhovetski } 214b6147490SGuennadi Liakhovetski 215b6147490SGuennadi Liakhovetski static inline void tmio_mmc_kunmap_atomic(struct scatterlist *sg, 216b6147490SGuennadi Liakhovetski unsigned long *flags, void *virt) 217b6147490SGuennadi Liakhovetski { 218482fce99SCong Wang kunmap_atomic(virt - sg->offset); 219b6147490SGuennadi Liakhovetski local_irq_restore(*flags); 220b6147490SGuennadi Liakhovetski } 221b6147490SGuennadi Liakhovetski 2229ade7dbfSUlf Hansson #ifdef CONFIG_PM 2237311bef0SGuennadi Liakhovetski int tmio_mmc_host_runtime_suspend(struct device *dev); 2247311bef0SGuennadi Liakhovetski int tmio_mmc_host_runtime_resume(struct device *dev); 225710dec95SUlf Hansson #endif 2267311bef0SGuennadi Liakhovetski 227a11862d3SSimon Horman static inline u16 sd_ctrl_read16(struct tmio_mmc_host *host, int addr) 228a11862d3SSimon Horman { 229d63da8c6SWolfram Sang return ioread16(host->ctl + (addr << host->bus_shift)); 230a11862d3SSimon Horman } 231a11862d3SSimon Horman 232a11862d3SSimon Horman static inline void sd_ctrl_read16_rep(struct tmio_mmc_host *host, int addr, 233a11862d3SSimon Horman u16 *buf, int count) 234a11862d3SSimon Horman { 2350c36fc0dSWolfram Sang ioread16_rep(host->ctl + (addr << host->bus_shift), buf, count); 236a11862d3SSimon Horman } 237a11862d3SSimon Horman 238f2218db8SSimon Horman static inline u32 sd_ctrl_read16_and_16_as_32(struct tmio_mmc_host *host, 239f2218db8SSimon Horman int addr) 240a11862d3SSimon Horman { 241d63da8c6SWolfram Sang return ioread16(host->ctl + (addr << host->bus_shift)) | 242d63da8c6SWolfram Sang ioread16(host->ctl + ((addr + 2) << host->bus_shift)) << 16; 243a11862d3SSimon Horman } 244a11862d3SSimon Horman 2458185e51fSChris Brandt static inline void sd_ctrl_read32_rep(struct tmio_mmc_host *host, int addr, 2468185e51fSChris Brandt u32 *buf, int count) 2478185e51fSChris Brandt { 2480c36fc0dSWolfram Sang ioread32_rep(host->ctl + (addr << host->bus_shift), buf, count); 2498185e51fSChris Brandt } 2508185e51fSChris Brandt 251f2218db8SSimon Horman static inline void sd_ctrl_write16(struct tmio_mmc_host *host, int addr, 252f2218db8SSimon Horman u16 val) 253a11862d3SSimon Horman { 254973ed3afSSimon Horman /* If there is a hook and it returns non-zero then there 255973ed3afSSimon Horman * is an error and the write should be skipped 256973ed3afSSimon Horman */ 257dfe9a229SKuninori Morimoto if (host->write16_hook && host->write16_hook(host, addr)) 258973ed3afSSimon Horman return; 259d63da8c6SWolfram Sang iowrite16(val, host->ctl + (addr << host->bus_shift)); 260a11862d3SSimon Horman } 261a11862d3SSimon Horman 262a11862d3SSimon Horman static inline void sd_ctrl_write16_rep(struct tmio_mmc_host *host, int addr, 263a11862d3SSimon Horman u16 *buf, int count) 264a11862d3SSimon Horman { 2650c36fc0dSWolfram Sang iowrite16_rep(host->ctl + (addr << host->bus_shift), buf, count); 266a11862d3SSimon Horman } 267a11862d3SSimon Horman 268f2218db8SSimon Horman static inline void sd_ctrl_write32_as_16_and_16(struct tmio_mmc_host *host, 269f2218db8SSimon Horman int addr, u32 val) 270a11862d3SSimon Horman { 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 2758185e51fSChris Brandt static inline void sd_ctrl_write32_rep(struct tmio_mmc_host *host, int addr, 2768185e51fSChris Brandt const u32 *buf, int count) 2778185e51fSChris Brandt { 2780c36fc0dSWolfram Sang iowrite32_rep(host->ctl + (addr << host->bus_shift), buf, count); 2798185e51fSChris Brandt } 2808185e51fSChris Brandt 281b6147490SGuennadi Liakhovetski #endif 282