1b6147490SGuennadi Liakhovetski /* 2b21f13d8SSimon Horman * Driver for the MMC / SD / SDIO cell found in: 3b21f13d8SSimon Horman * 4b21f13d8SSimon Horman * TC6393XB TC6391XB TC6387XB T7L66XB ASIC3 5b6147490SGuennadi Liakhovetski * 687317c4dSSimon Horman * Copyright (C) 2015-17 Renesas Electronics Corporation 787317c4dSSimon Horman * Copyright (C) 2016-17 Sang Engineering, Wolfram Sang 887317c4dSSimon Horman * Copyright (C) 2016-17 Horms Solutions, Simon Horman 9b6147490SGuennadi Liakhovetski * Copyright (C) 2007 Ian Molton 10b6147490SGuennadi Liakhovetski * Copyright (C) 2004 Ian Molton 11b6147490SGuennadi Liakhovetski * 12b6147490SGuennadi Liakhovetski * This program is free software; you can redistribute it and/or modify 13b6147490SGuennadi Liakhovetski * it under the terms of the GNU General Public License version 2 as 14b6147490SGuennadi Liakhovetski * published by the Free Software Foundation. 15b6147490SGuennadi Liakhovetski * 16b6147490SGuennadi Liakhovetski */ 17b6147490SGuennadi Liakhovetski 18b6147490SGuennadi Liakhovetski #ifndef TMIO_MMC_H 19b6147490SGuennadi Liakhovetski #define TMIO_MMC_H 20b6147490SGuennadi Liakhovetski 21361936efSKuninori Morimoto #include <linux/dmaengine.h> 22b6147490SGuennadi Liakhovetski #include <linux/highmem.h> 23b9269fddSGuennadi Liakhovetski #include <linux/mutex.h> 24b6147490SGuennadi Liakhovetski #include <linux/pagemap.h> 256c0cbef6SRafael J. Wysocki #include <linux/scatterlist.h> 26e3de2be7SGuennadi Liakhovetski #include <linux/spinlock.h> 27b8789ec4SUlf Hansson #include <linux/interrupt.h> 28b6147490SGuennadi Liakhovetski 29ac86045eSWolfram Sang #define CTL_SD_CMD 0x00 30ac86045eSWolfram Sang #define CTL_ARG_REG 0x04 31ac86045eSWolfram Sang #define CTL_STOP_INTERNAL_ACTION 0x08 32ac86045eSWolfram Sang #define CTL_XFER_BLK_COUNT 0xa 33ac86045eSWolfram Sang #define CTL_RESPONSE 0x0c 34184adf20SWolfram Sang /* driver merges STATUS and following STATUS2 */ 35ac86045eSWolfram Sang #define CTL_STATUS 0x1c 36184adf20SWolfram Sang /* driver merges IRQ_MASK and following IRQ_MASK2 */ 37ac86045eSWolfram Sang #define CTL_IRQ_MASK 0x20 38ac86045eSWolfram Sang #define CTL_SD_CARD_CLK_CTL 0x24 39ac86045eSWolfram Sang #define CTL_SD_XFER_LEN 0x26 40ac86045eSWolfram Sang #define CTL_SD_MEM_CARD_OPT 0x28 41ac86045eSWolfram Sang #define CTL_SD_ERROR_DETAIL_STATUS 0x2c 42ac86045eSWolfram Sang #define CTL_SD_DATA_PORT 0x30 43ac86045eSWolfram Sang #define CTL_TRANSACTION_CTL 0x34 44ac86045eSWolfram Sang #define CTL_SDIO_STATUS 0x36 45ac86045eSWolfram Sang #define CTL_SDIO_IRQ_MASK 0x38 46ac86045eSWolfram Sang #define CTL_DMA_ENABLE 0xd8 47ac86045eSWolfram Sang #define CTL_RESET_SD 0xe0 48ac86045eSWolfram Sang #define CTL_VERSION 0xe2 49ac86045eSWolfram Sang #define CTL_SDIO_REGS 0x100 50ac86045eSWolfram Sang #define CTL_CLK_AND_WAIT_CTL 0x138 51ac86045eSWolfram Sang #define CTL_RESET_SDIO 0x1e0 52ac86045eSWolfram Sang 539afcbf4aSWolfram Sang /* Definitions for values the CTL_STOP_INTERNAL_ACTION register can take */ 549afcbf4aSWolfram Sang #define TMIO_STOP_STP BIT(0) 559afcbf4aSWolfram Sang #define TMIO_STOP_SEC BIT(8) 569afcbf4aSWolfram Sang 57d8acd16cSWolfram Sang /* Definitions for values the CTL_STATUS register can take */ 582cafc5cbSWolfram Sang #define TMIO_STAT_CMDRESPEND BIT(0) 592cafc5cbSWolfram Sang #define TMIO_STAT_DATAEND BIT(2) 602cafc5cbSWolfram Sang #define TMIO_STAT_CARD_REMOVE BIT(3) 612cafc5cbSWolfram Sang #define TMIO_STAT_CARD_INSERT BIT(4) 622cafc5cbSWolfram Sang #define TMIO_STAT_SIGSTATE BIT(5) 632cafc5cbSWolfram Sang #define TMIO_STAT_WRPROTECT BIT(7) 642cafc5cbSWolfram Sang #define TMIO_STAT_CARD_REMOVE_A BIT(8) 652cafc5cbSWolfram Sang #define TMIO_STAT_CARD_INSERT_A BIT(9) 662cafc5cbSWolfram Sang #define TMIO_STAT_SIGSTATE_A BIT(10) 672cafc5cbSWolfram Sang 68d8acd16cSWolfram Sang /* These belong technically to CTL_STATUS2, but the driver merges them */ 692cafc5cbSWolfram Sang #define TMIO_STAT_CMD_IDX_ERR BIT(16) 702cafc5cbSWolfram Sang #define TMIO_STAT_CRCFAIL BIT(17) 712cafc5cbSWolfram Sang #define TMIO_STAT_STOPBIT_ERR BIT(18) 722cafc5cbSWolfram Sang #define TMIO_STAT_DATATIMEOUT BIT(19) 732cafc5cbSWolfram Sang #define TMIO_STAT_RXOVERFLOW BIT(20) 742cafc5cbSWolfram Sang #define TMIO_STAT_TXUNDERRUN BIT(21) 752cafc5cbSWolfram Sang #define TMIO_STAT_CMDTIMEOUT BIT(22) 7683e95351SWolfram Sang #define TMIO_STAT_DAT0 BIT(23) /* only known on R-Car so far */ 772cafc5cbSWolfram Sang #define TMIO_STAT_RXRDY BIT(24) 782cafc5cbSWolfram Sang #define TMIO_STAT_TXRQ BIT(25) 79a21553c9SWolfram Sang #define TMIO_STAT_ILL_FUNC BIT(29) /* only when !TMIO_MMC_HAS_IDLE_WAIT */ 80a21553c9SWolfram Sang #define TMIO_STAT_SCLKDIVEN BIT(29) /* only when TMIO_MMC_HAS_IDLE_WAIT */ 812cafc5cbSWolfram Sang #define TMIO_STAT_CMD_BUSY BIT(30) 822cafc5cbSWolfram Sang #define TMIO_STAT_ILL_ACCESS BIT(31) 83ac86045eSWolfram Sang 84c78e1694SWolfram Sang /* Definitions for values the CTL_SD_CARD_CLK_CTL register can take */ 85ac86045eSWolfram Sang #define CLK_CTL_DIV_MASK 0xff 86ac86045eSWolfram Sang #define CLK_CTL_SCLKEN BIT(8) 87ac86045eSWolfram Sang 88c78e1694SWolfram Sang /* Definitions for values the CTL_SD_MEM_CARD_OPT register can take */ 890bc0b6e8SWolfram Sang #define CARD_OPT_WIDTH8 BIT(13) 900bc0b6e8SWolfram Sang #define CARD_OPT_WIDTH BIT(15) 910bc0b6e8SWolfram Sang 92d8acd16cSWolfram Sang /* Definitions for values the CTL_SDIO_STATUS register can take */ 93b6147490SGuennadi Liakhovetski #define TMIO_SDIO_STAT_IOIRQ 0x0001 94b6147490SGuennadi Liakhovetski #define TMIO_SDIO_STAT_EXPUB52 0x4000 95b6147490SGuennadi Liakhovetski #define TMIO_SDIO_STAT_EXWT 0x8000 96b6147490SGuennadi Liakhovetski #define TMIO_SDIO_MASK_ALL 0xc007 97b6147490SGuennadi Liakhovetski 98ee289815SWolfram Sang #define TMIO_SDIO_SETBITS_MASK 0x0006 99ee289815SWolfram Sang 1005af02d32SWolfram Sang /* Definitions for values the CTL_DMA_ENABLE register can take */ 1015af02d32SWolfram Sang #define DMA_ENABLE_DMASDRW BIT(1) 1025af02d32SWolfram Sang 103b6147490SGuennadi Liakhovetski /* Define some IRQ masks */ 104b6147490SGuennadi Liakhovetski /* This is the mask used at reset by the chip */ 105b6147490SGuennadi Liakhovetski #define TMIO_MASK_ALL 0x837f031d 106b6147490SGuennadi Liakhovetski #define TMIO_MASK_READOP (TMIO_STAT_RXRDY | TMIO_STAT_DATAEND) 107b6147490SGuennadi Liakhovetski #define TMIO_MASK_WRITEOP (TMIO_STAT_TXRQ | TMIO_STAT_DATAEND) 108b6147490SGuennadi Liakhovetski #define TMIO_MASK_CMD (TMIO_STAT_CMDRESPEND | TMIO_STAT_CMDTIMEOUT | \ 109b6147490SGuennadi Liakhovetski TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT) 110b6147490SGuennadi Liakhovetski #define TMIO_MASK_IRQ (TMIO_MASK_READOP | TMIO_MASK_WRITEOP | TMIO_MASK_CMD) 111b6147490SGuennadi Liakhovetski 112b6147490SGuennadi Liakhovetski struct tmio_mmc_data; 1135add2acaSKuninori Morimoto struct tmio_mmc_host; 114b6147490SGuennadi Liakhovetski 1157ecc09baSKuninori Morimoto struct tmio_mmc_dma { 116361936efSKuninori Morimoto enum dma_slave_buswidth dma_buswidth; 1177ecc09baSKuninori Morimoto bool (*filter)(struct dma_chan *chan, void *arg); 1185add2acaSKuninori Morimoto void (*enable)(struct tmio_mmc_host *host, bool enable); 1197ecc09baSKuninori Morimoto }; 1207ecc09baSKuninori Morimoto 121631fa73cSSimon Horman struct tmio_mmc_dma_ops { 122631fa73cSSimon Horman void (*start)(struct tmio_mmc_host *host, struct mmc_data *data); 123631fa73cSSimon Horman void (*enable)(struct tmio_mmc_host *host, bool enable); 124631fa73cSSimon Horman void (*request)(struct tmio_mmc_host *host, 125631fa73cSSimon Horman struct tmio_mmc_data *pdata); 126631fa73cSSimon Horman void (*release)(struct tmio_mmc_host *host); 127631fa73cSSimon Horman void (*abort)(struct tmio_mmc_host *host); 12892d0f925SSimon Horman void (*dataend)(struct tmio_mmc_host *host); 129631fa73cSSimon Horman }; 130631fa73cSSimon Horman 131b6147490SGuennadi Liakhovetski struct tmio_mmc_host { 132b6147490SGuennadi Liakhovetski void __iomem *ctl; 133b6147490SGuennadi Liakhovetski struct mmc_command *cmd; 134b6147490SGuennadi Liakhovetski struct mmc_request *mrq; 135b6147490SGuennadi Liakhovetski struct mmc_data *data; 136b6147490SGuennadi Liakhovetski struct mmc_host *mmc; 137c055fc75SMasahiro Yamada struct mmc_host_ops ops; 138b6147490SGuennadi Liakhovetski 139b6147490SGuennadi Liakhovetski /* Callbacks for clock / power control */ 140b6147490SGuennadi Liakhovetski void (*set_pwr)(struct platform_device *host, int state); 141b6147490SGuennadi Liakhovetski void (*set_clk_div)(struct platform_device *host, int state); 142b6147490SGuennadi Liakhovetski 143b6147490SGuennadi Liakhovetski /* pio related stuff */ 144b6147490SGuennadi Liakhovetski struct scatterlist *sg_ptr; 145b6147490SGuennadi Liakhovetski struct scatterlist *sg_orig; 146b6147490SGuennadi Liakhovetski unsigned int sg_len; 147b6147490SGuennadi Liakhovetski unsigned int sg_off; 1487445bf9eSKuninori Morimoto unsigned long bus_shift; 149b6147490SGuennadi Liakhovetski 150b6147490SGuennadi Liakhovetski struct platform_device *pdev; 151b6147490SGuennadi Liakhovetski struct tmio_mmc_data *pdata; 1527ecc09baSKuninori Morimoto struct tmio_mmc_dma *dma; 153b6147490SGuennadi Liakhovetski 154b6147490SGuennadi Liakhovetski /* DMA support */ 155b6147490SGuennadi Liakhovetski bool force_pio; 156b6147490SGuennadi Liakhovetski struct dma_chan *chan_rx; 157b6147490SGuennadi Liakhovetski struct dma_chan *chan_tx; 15852ad9a8eSWolfram Sang struct completion dma_dataend; 1592a68ea78SSimon Horman struct tasklet_struct dma_complete; 160b6147490SGuennadi Liakhovetski struct tasklet_struct dma_issue; 161b6147490SGuennadi Liakhovetski struct scatterlist bounce_sg; 162b6147490SGuennadi Liakhovetski u8 *bounce_buf; 163b6147490SGuennadi Liakhovetski 164b6147490SGuennadi Liakhovetski /* Track lost interrupts */ 165b6147490SGuennadi Liakhovetski struct delayed_work delayed_reset_work; 166b9269fddSGuennadi Liakhovetski struct work_struct done; 167b9269fddSGuennadi Liakhovetski 168ae12d250SUlf Hansson /* Cache */ 16954680fe7SSimon Horman u32 sdcard_irq_mask; 17054680fe7SSimon Horman u32 sdio_irq_mask; 171ae12d250SUlf Hansson unsigned int clk_cache; 17254680fe7SSimon Horman 173b9269fddSGuennadi Liakhovetski spinlock_t lock; /* protect host private data */ 174b6147490SGuennadi Liakhovetski unsigned long last_req_ts; 175b9269fddSGuennadi Liakhovetski struct mutex ios_lock; /* protect set_ios() context */ 1762b1ac5c2SGuennadi Liakhovetski bool native_hotplug; 1777501c431SUlf Hansson bool sdio_irq_enabled; 1784f119977SAi Kyuse u32 scc_tappos; 179dfe9a229SKuninori Morimoto 1802f87365fSSimon Horman /* Mandatory callback */ 1810ea28210SBen Hutchings int (*clk_enable)(struct tmio_mmc_host *host); 1822f87365fSSimon Horman 1832f87365fSSimon Horman /* Optional callbacks */ 1842fb55956SBen Hutchings unsigned int (*clk_update)(struct tmio_mmc_host *host, 1852fb55956SBen Hutchings unsigned int new_clock); 1860ea28210SBen Hutchings void (*clk_disable)(struct tmio_mmc_host *host); 18785c02dddSKuninori Morimoto int (*multi_io_quirk)(struct mmc_card *card, 18885c02dddSKuninori Morimoto unsigned int direction, int blk_size); 1896a4679f3SWolfram Sang int (*card_busy)(struct mmc_host *mmc); 190452e5eefSWolfram Sang int (*start_signal_voltage_switch)(struct mmc_host *mmc, 191452e5eefSWolfram Sang struct mmc_ios *ios); 1922f87365fSSimon Horman int (*write16_hook)(struct tmio_mmc_host *host, int addr); 193e8f36b5dSAi Kyuse void (*hw_reset)(struct tmio_mmc_host *host); 1944f119977SAi Kyuse void (*prepare_tuning)(struct tmio_mmc_host *host, unsigned long tap); 1954f119977SAi Kyuse bool (*check_scc_error)(struct tmio_mmc_host *host); 1964f119977SAi Kyuse 1974f119977SAi Kyuse /* 1984f119977SAi Kyuse * Mandatory callback for tuning to occur which is optional for SDR50 1994f119977SAi Kyuse * and mandatory for SDR104. 2004f119977SAi Kyuse */ 2014f119977SAi Kyuse unsigned int (*init_tuning)(struct tmio_mmc_host *host); 2024f119977SAi Kyuse int (*select_tuning)(struct tmio_mmc_host *host); 2034f119977SAi Kyuse 2044f119977SAi Kyuse /* Tuning values: 1 for success, 0 for failure */ 2054f119977SAi Kyuse DECLARE_BITMAP(taps, BITS_PER_BYTE * sizeof(long)); 2064f119977SAi Kyuse unsigned int tap_num; 207631fa73cSSimon Horman 208631fa73cSSimon Horman const struct tmio_mmc_dma_ops *dma_ops; 209b6147490SGuennadi Liakhovetski }; 210b6147490SGuennadi Liakhovetski 21194b110afSKuninori Morimoto struct tmio_mmc_host *tmio_mmc_host_alloc(struct platform_device *pdev); 21294b110afSKuninori Morimoto void tmio_mmc_host_free(struct tmio_mmc_host *host); 21394b110afSKuninori Morimoto int tmio_mmc_host_probe(struct tmio_mmc_host *host, 214631fa73cSSimon Horman struct tmio_mmc_data *pdata, 215631fa73cSSimon Horman const struct tmio_mmc_dma_ops *dma_ops); 216b6147490SGuennadi Liakhovetski void tmio_mmc_host_remove(struct tmio_mmc_host *host); 217b6147490SGuennadi Liakhovetski void tmio_mmc_do_data_irq(struct tmio_mmc_host *host); 218b6147490SGuennadi Liakhovetski 219b6147490SGuennadi Liakhovetski void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host *host, u32 i); 220b6147490SGuennadi Liakhovetski void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host *host, u32 i); 2218e7bfdb3SMagnus Damm irqreturn_t tmio_mmc_irq(int irq, void *devid); 222b6147490SGuennadi Liakhovetski 223b6147490SGuennadi Liakhovetski static inline char *tmio_mmc_kmap_atomic(struct scatterlist *sg, 224b6147490SGuennadi Liakhovetski unsigned long *flags) 225b6147490SGuennadi Liakhovetski { 226b6147490SGuennadi Liakhovetski local_irq_save(*flags); 227482fce99SCong Wang return kmap_atomic(sg_page(sg)) + sg->offset; 228b6147490SGuennadi Liakhovetski } 229b6147490SGuennadi Liakhovetski 230b6147490SGuennadi Liakhovetski static inline void tmio_mmc_kunmap_atomic(struct scatterlist *sg, 231b6147490SGuennadi Liakhovetski unsigned long *flags, void *virt) 232b6147490SGuennadi Liakhovetski { 233482fce99SCong Wang kunmap_atomic(virt - sg->offset); 234b6147490SGuennadi Liakhovetski local_irq_restore(*flags); 235b6147490SGuennadi Liakhovetski } 236b6147490SGuennadi Liakhovetski 2379ade7dbfSUlf Hansson #ifdef CONFIG_PM 2387311bef0SGuennadi Liakhovetski int tmio_mmc_host_runtime_suspend(struct device *dev); 2397311bef0SGuennadi Liakhovetski int tmio_mmc_host_runtime_resume(struct device *dev); 240710dec95SUlf Hansson #endif 2417311bef0SGuennadi Liakhovetski 242a11862d3SSimon Horman static inline u16 sd_ctrl_read16(struct tmio_mmc_host *host, int addr) 243a11862d3SSimon Horman { 2447445bf9eSKuninori Morimoto return readw(host->ctl + (addr << host->bus_shift)); 245a11862d3SSimon Horman } 246a11862d3SSimon Horman 247a11862d3SSimon Horman static inline void sd_ctrl_read16_rep(struct tmio_mmc_host *host, int addr, 248a11862d3SSimon Horman u16 *buf, int count) 249a11862d3SSimon Horman { 2500c36fc0dSWolfram Sang ioread16_rep(host->ctl + (addr << host->bus_shift), buf, count); 251a11862d3SSimon Horman } 252a11862d3SSimon Horman 253f2218db8SSimon Horman static inline u32 sd_ctrl_read16_and_16_as_32(struct tmio_mmc_host *host, 254f2218db8SSimon Horman int addr) 255a11862d3SSimon Horman { 2567445bf9eSKuninori Morimoto return readw(host->ctl + (addr << host->bus_shift)) | 2577445bf9eSKuninori Morimoto readw(host->ctl + ((addr + 2) << host->bus_shift)) << 16; 258a11862d3SSimon Horman } 259a11862d3SSimon Horman 2608185e51fSChris Brandt static inline void sd_ctrl_read32_rep(struct tmio_mmc_host *host, int addr, 2618185e51fSChris Brandt u32 *buf, int count) 2628185e51fSChris Brandt { 2630c36fc0dSWolfram Sang ioread32_rep(host->ctl + (addr << host->bus_shift), buf, count); 2648185e51fSChris Brandt } 2658185e51fSChris Brandt 266f2218db8SSimon Horman static inline void sd_ctrl_write16(struct tmio_mmc_host *host, int addr, 267f2218db8SSimon Horman u16 val) 268a11862d3SSimon Horman { 269973ed3afSSimon Horman /* If there is a hook and it returns non-zero then there 270973ed3afSSimon Horman * is an error and the write should be skipped 271973ed3afSSimon Horman */ 272dfe9a229SKuninori Morimoto if (host->write16_hook && host->write16_hook(host, addr)) 273973ed3afSSimon Horman return; 2747445bf9eSKuninori Morimoto writew(val, host->ctl + (addr << host->bus_shift)); 275a11862d3SSimon Horman } 276a11862d3SSimon Horman 277a11862d3SSimon Horman static inline void sd_ctrl_write16_rep(struct tmio_mmc_host *host, int addr, 278a11862d3SSimon Horman u16 *buf, int count) 279a11862d3SSimon Horman { 2800c36fc0dSWolfram Sang iowrite16_rep(host->ctl + (addr << host->bus_shift), buf, count); 281a11862d3SSimon Horman } 282a11862d3SSimon Horman 283f2218db8SSimon Horman static inline void sd_ctrl_write32_as_16_and_16(struct tmio_mmc_host *host, 284f2218db8SSimon Horman int addr, u32 val) 285a11862d3SSimon Horman { 2867c42dbf3SWolfram Sang writew(val & 0xffff, host->ctl + (addr << host->bus_shift)); 2877445bf9eSKuninori Morimoto writew(val >> 16, host->ctl + ((addr + 2) << host->bus_shift)); 288a11862d3SSimon Horman } 289a11862d3SSimon Horman 2908185e51fSChris Brandt static inline void sd_ctrl_write32_rep(struct tmio_mmc_host *host, int addr, 2918185e51fSChris Brandt const u32 *buf, int count) 2928185e51fSChris Brandt { 2930c36fc0dSWolfram Sang iowrite32_rep(host->ctl + (addr << host->bus_shift), buf, count); 2948185e51fSChris Brandt } 2958185e51fSChris Brandt 296b6147490SGuennadi Liakhovetski #endif 297