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 84ac86045eSWolfram Sang #define CLK_CTL_DIV_MASK 0xff 85ac86045eSWolfram Sang #define CLK_CTL_SCLKEN BIT(8) 86ac86045eSWolfram Sang 870bc0b6e8SWolfram Sang #define CARD_OPT_WIDTH8 BIT(13) 880bc0b6e8SWolfram Sang #define CARD_OPT_WIDTH BIT(15) 890bc0b6e8SWolfram Sang 90ac86045eSWolfram Sang #define TMIO_BBS 512 /* Boot block size */ 91ac86045eSWolfram 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 100b6147490SGuennadi Liakhovetski /* Define some IRQ masks */ 101b6147490SGuennadi Liakhovetski /* This is the mask used at reset by the chip */ 102b6147490SGuennadi Liakhovetski #define TMIO_MASK_ALL 0x837f031d 103b6147490SGuennadi Liakhovetski #define TMIO_MASK_READOP (TMIO_STAT_RXRDY | TMIO_STAT_DATAEND) 104b6147490SGuennadi Liakhovetski #define TMIO_MASK_WRITEOP (TMIO_STAT_TXRQ | TMIO_STAT_DATAEND) 105b6147490SGuennadi Liakhovetski #define TMIO_MASK_CMD (TMIO_STAT_CMDRESPEND | TMIO_STAT_CMDTIMEOUT | \ 106b6147490SGuennadi Liakhovetski TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT) 107b6147490SGuennadi Liakhovetski #define TMIO_MASK_IRQ (TMIO_MASK_READOP | TMIO_MASK_WRITEOP | TMIO_MASK_CMD) 108b6147490SGuennadi Liakhovetski 109b6147490SGuennadi Liakhovetski struct tmio_mmc_data; 1105add2acaSKuninori Morimoto struct tmio_mmc_host; 111b6147490SGuennadi Liakhovetski 1127ecc09baSKuninori Morimoto struct tmio_mmc_dma { 113361936efSKuninori Morimoto enum dma_slave_buswidth dma_buswidth; 1147ecc09baSKuninori Morimoto bool (*filter)(struct dma_chan *chan, void *arg); 1155add2acaSKuninori Morimoto void (*enable)(struct tmio_mmc_host *host, bool enable); 1167ecc09baSKuninori Morimoto }; 1177ecc09baSKuninori Morimoto 118631fa73cSSimon Horman struct tmio_mmc_dma_ops { 119631fa73cSSimon Horman void (*start)(struct tmio_mmc_host *host, struct mmc_data *data); 120631fa73cSSimon Horman void (*enable)(struct tmio_mmc_host *host, bool enable); 121631fa73cSSimon Horman void (*request)(struct tmio_mmc_host *host, 122631fa73cSSimon Horman struct tmio_mmc_data *pdata); 123631fa73cSSimon Horman void (*release)(struct tmio_mmc_host *host); 124631fa73cSSimon Horman void (*abort)(struct tmio_mmc_host *host); 125631fa73cSSimon Horman }; 126631fa73cSSimon Horman 127b6147490SGuennadi Liakhovetski struct tmio_mmc_host { 128b6147490SGuennadi Liakhovetski void __iomem *ctl; 129b6147490SGuennadi Liakhovetski struct mmc_command *cmd; 130b6147490SGuennadi Liakhovetski struct mmc_request *mrq; 131b6147490SGuennadi Liakhovetski struct mmc_data *data; 132b6147490SGuennadi Liakhovetski struct mmc_host *mmc; 133b6147490SGuennadi Liakhovetski 134b6147490SGuennadi Liakhovetski /* Callbacks for clock / power control */ 135b6147490SGuennadi Liakhovetski void (*set_pwr)(struct platform_device *host, int state); 136b6147490SGuennadi Liakhovetski void (*set_clk_div)(struct platform_device *host, int state); 137b6147490SGuennadi Liakhovetski 138b6147490SGuennadi Liakhovetski /* pio related stuff */ 139b6147490SGuennadi Liakhovetski struct scatterlist *sg_ptr; 140b6147490SGuennadi Liakhovetski struct scatterlist *sg_orig; 141b6147490SGuennadi Liakhovetski unsigned int sg_len; 142b6147490SGuennadi Liakhovetski unsigned int sg_off; 1437445bf9eSKuninori Morimoto unsigned long bus_shift; 144b6147490SGuennadi Liakhovetski 145b6147490SGuennadi Liakhovetski struct platform_device *pdev; 146b6147490SGuennadi Liakhovetski struct tmio_mmc_data *pdata; 1477ecc09baSKuninori Morimoto struct tmio_mmc_dma *dma; 148b6147490SGuennadi Liakhovetski 149b6147490SGuennadi Liakhovetski /* DMA support */ 150b6147490SGuennadi Liakhovetski bool force_pio; 151b6147490SGuennadi Liakhovetski struct dma_chan *chan_rx; 152b6147490SGuennadi Liakhovetski struct dma_chan *chan_tx; 15352ad9a8eSWolfram Sang struct completion dma_dataend; 154b6147490SGuennadi Liakhovetski struct tasklet_struct dma_issue; 155b6147490SGuennadi Liakhovetski struct scatterlist bounce_sg; 156b6147490SGuennadi Liakhovetski u8 *bounce_buf; 157b6147490SGuennadi Liakhovetski 158b6147490SGuennadi Liakhovetski /* Track lost interrupts */ 159b6147490SGuennadi Liakhovetski struct delayed_work delayed_reset_work; 160b9269fddSGuennadi Liakhovetski struct work_struct done; 161b9269fddSGuennadi Liakhovetski 162ae12d250SUlf Hansson /* Cache */ 16354680fe7SSimon Horman u32 sdcard_irq_mask; 16454680fe7SSimon Horman u32 sdio_irq_mask; 165ae12d250SUlf Hansson unsigned int clk_cache; 16654680fe7SSimon Horman 167b9269fddSGuennadi Liakhovetski spinlock_t lock; /* protect host private data */ 168b6147490SGuennadi Liakhovetski unsigned long last_req_ts; 169b9269fddSGuennadi Liakhovetski struct mutex ios_lock; /* protect set_ios() context */ 1702b1ac5c2SGuennadi Liakhovetski bool native_hotplug; 1717501c431SUlf Hansson bool sdio_irq_enabled; 1724f119977SAi Kyuse u32 scc_tappos; 173dfe9a229SKuninori Morimoto 1742f87365fSSimon Horman /* Mandatory callback */ 1750ea28210SBen Hutchings int (*clk_enable)(struct tmio_mmc_host *host); 1762f87365fSSimon Horman 1772f87365fSSimon Horman /* Optional callbacks */ 1782fb55956SBen Hutchings unsigned int (*clk_update)(struct tmio_mmc_host *host, 1792fb55956SBen Hutchings unsigned int new_clock); 1800ea28210SBen Hutchings void (*clk_disable)(struct tmio_mmc_host *host); 18185c02dddSKuninori Morimoto int (*multi_io_quirk)(struct mmc_card *card, 18285c02dddSKuninori Morimoto unsigned int direction, int blk_size); 1836a4679f3SWolfram Sang int (*card_busy)(struct mmc_host *mmc); 184452e5eefSWolfram Sang int (*start_signal_voltage_switch)(struct mmc_host *mmc, 185452e5eefSWolfram Sang struct mmc_ios *ios); 1862f87365fSSimon Horman int (*write16_hook)(struct tmio_mmc_host *host, int addr); 187e8f36b5dSAi Kyuse void (*hw_reset)(struct tmio_mmc_host *host); 1884f119977SAi Kyuse void (*prepare_tuning)(struct tmio_mmc_host *host, unsigned long tap); 1894f119977SAi Kyuse bool (*check_scc_error)(struct tmio_mmc_host *host); 1904f119977SAi Kyuse 1914f119977SAi Kyuse /* 1924f119977SAi Kyuse * Mandatory callback for tuning to occur which is optional for SDR50 1934f119977SAi Kyuse * and mandatory for SDR104. 1944f119977SAi Kyuse */ 1954f119977SAi Kyuse unsigned int (*init_tuning)(struct tmio_mmc_host *host); 1964f119977SAi Kyuse int (*select_tuning)(struct tmio_mmc_host *host); 1974f119977SAi Kyuse 1984f119977SAi Kyuse /* Tuning values: 1 for success, 0 for failure */ 1994f119977SAi Kyuse DECLARE_BITMAP(taps, BITS_PER_BYTE * sizeof(long)); 2004f119977SAi Kyuse unsigned int tap_num; 201631fa73cSSimon Horman 202631fa73cSSimon Horman const struct tmio_mmc_dma_ops *dma_ops; 203b6147490SGuennadi Liakhovetski }; 204b6147490SGuennadi Liakhovetski 20594b110afSKuninori Morimoto struct tmio_mmc_host *tmio_mmc_host_alloc(struct platform_device *pdev); 20694b110afSKuninori Morimoto void tmio_mmc_host_free(struct tmio_mmc_host *host); 20794b110afSKuninori Morimoto int tmio_mmc_host_probe(struct tmio_mmc_host *host, 208631fa73cSSimon Horman struct tmio_mmc_data *pdata, 209631fa73cSSimon Horman const struct tmio_mmc_dma_ops *dma_ops); 210b6147490SGuennadi Liakhovetski void tmio_mmc_host_remove(struct tmio_mmc_host *host); 211b6147490SGuennadi Liakhovetski void tmio_mmc_do_data_irq(struct tmio_mmc_host *host); 212b6147490SGuennadi Liakhovetski 213b6147490SGuennadi Liakhovetski void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host *host, u32 i); 214b6147490SGuennadi Liakhovetski void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host *host, u32 i); 2158e7bfdb3SMagnus Damm irqreturn_t tmio_mmc_irq(int irq, void *devid); 216b6147490SGuennadi Liakhovetski 217b6147490SGuennadi Liakhovetski static inline char *tmio_mmc_kmap_atomic(struct scatterlist *sg, 218b6147490SGuennadi Liakhovetski unsigned long *flags) 219b6147490SGuennadi Liakhovetski { 220b6147490SGuennadi Liakhovetski local_irq_save(*flags); 221482fce99SCong Wang return kmap_atomic(sg_page(sg)) + sg->offset; 222b6147490SGuennadi Liakhovetski } 223b6147490SGuennadi Liakhovetski 224b6147490SGuennadi Liakhovetski static inline void tmio_mmc_kunmap_atomic(struct scatterlist *sg, 225b6147490SGuennadi Liakhovetski unsigned long *flags, void *virt) 226b6147490SGuennadi Liakhovetski { 227482fce99SCong Wang kunmap_atomic(virt - sg->offset); 228b6147490SGuennadi Liakhovetski local_irq_restore(*flags); 229b6147490SGuennadi Liakhovetski } 230b6147490SGuennadi Liakhovetski 2319ade7dbfSUlf Hansson #ifdef CONFIG_PM 2327311bef0SGuennadi Liakhovetski int tmio_mmc_host_runtime_suspend(struct device *dev); 2337311bef0SGuennadi Liakhovetski int tmio_mmc_host_runtime_resume(struct device *dev); 234710dec95SUlf Hansson #endif 2357311bef0SGuennadi Liakhovetski 236a11862d3SSimon Horman static inline u16 sd_ctrl_read16(struct tmio_mmc_host *host, int addr) 237a11862d3SSimon Horman { 2387445bf9eSKuninori Morimoto return readw(host->ctl + (addr << host->bus_shift)); 239a11862d3SSimon Horman } 240a11862d3SSimon Horman 241a11862d3SSimon Horman static inline void sd_ctrl_read16_rep(struct tmio_mmc_host *host, int addr, 242a11862d3SSimon Horman u16 *buf, int count) 243a11862d3SSimon Horman { 2447445bf9eSKuninori Morimoto readsw(host->ctl + (addr << host->bus_shift), buf, count); 245a11862d3SSimon Horman } 246a11862d3SSimon Horman 247f2218db8SSimon Horman static inline u32 sd_ctrl_read16_and_16_as_32(struct tmio_mmc_host *host, 248f2218db8SSimon Horman int addr) 249a11862d3SSimon Horman { 2507445bf9eSKuninori Morimoto return readw(host->ctl + (addr << host->bus_shift)) | 2517445bf9eSKuninori Morimoto readw(host->ctl + ((addr + 2) << host->bus_shift)) << 16; 252a11862d3SSimon Horman } 253a11862d3SSimon Horman 2548185e51fSChris Brandt static inline void sd_ctrl_read32_rep(struct tmio_mmc_host *host, int addr, 2558185e51fSChris Brandt u32 *buf, int count) 2568185e51fSChris Brandt { 2578185e51fSChris Brandt readsl(host->ctl + (addr << host->bus_shift), buf, count); 2588185e51fSChris Brandt } 2598185e51fSChris Brandt 260f2218db8SSimon Horman static inline void sd_ctrl_write16(struct tmio_mmc_host *host, int addr, 261f2218db8SSimon Horman u16 val) 262a11862d3SSimon Horman { 263973ed3afSSimon Horman /* If there is a hook and it returns non-zero then there 264973ed3afSSimon Horman * is an error and the write should be skipped 265973ed3afSSimon Horman */ 266dfe9a229SKuninori Morimoto if (host->write16_hook && host->write16_hook(host, addr)) 267973ed3afSSimon Horman return; 2687445bf9eSKuninori Morimoto writew(val, host->ctl + (addr << host->bus_shift)); 269a11862d3SSimon Horman } 270a11862d3SSimon Horman 271a11862d3SSimon Horman static inline void sd_ctrl_write16_rep(struct tmio_mmc_host *host, int addr, 272a11862d3SSimon Horman u16 *buf, int count) 273a11862d3SSimon Horman { 2747445bf9eSKuninori Morimoto writesw(host->ctl + (addr << host->bus_shift), buf, count); 275a11862d3SSimon Horman } 276a11862d3SSimon Horman 277f2218db8SSimon Horman static inline void sd_ctrl_write32_as_16_and_16(struct tmio_mmc_host *host, 278f2218db8SSimon Horman int addr, u32 val) 279a11862d3SSimon Horman { 2807c42dbf3SWolfram Sang writew(val & 0xffff, host->ctl + (addr << host->bus_shift)); 2817445bf9eSKuninori Morimoto writew(val >> 16, host->ctl + ((addr + 2) << host->bus_shift)); 282a11862d3SSimon Horman } 283a11862d3SSimon Horman 2848185e51fSChris Brandt static inline void sd_ctrl_write32_rep(struct tmio_mmc_host *host, int addr, 2858185e51fSChris Brandt const u32 *buf, int count) 2868185e51fSChris Brandt { 2878185e51fSChris Brandt writesl(host->ctl + (addr << host->bus_shift), buf, count); 2888185e51fSChris Brandt } 2898185e51fSChris Brandt 290b6147490SGuennadi Liakhovetski #endif 291