1b6147490SGuennadi Liakhovetski /* 2b6147490SGuennadi Liakhovetski * linux/drivers/mmc/host/tmio_mmc.h 3b6147490SGuennadi Liakhovetski * 4ac86045eSWolfram Sang * Copyright (C) 2016 Sang Engineering, Wolfram Sang 5ac86045eSWolfram Sang * Copyright (C) 2015-16 Renesas Electronics Corporation 6b6147490SGuennadi Liakhovetski * Copyright (C) 2007 Ian Molton 7b6147490SGuennadi Liakhovetski * Copyright (C) 2004 Ian Molton 8b6147490SGuennadi Liakhovetski * 9b6147490SGuennadi Liakhovetski * This program is free software; you can redistribute it and/or modify 10b6147490SGuennadi Liakhovetski * it under the terms of the GNU General Public License version 2 as 11b6147490SGuennadi Liakhovetski * published by the Free Software Foundation. 12b6147490SGuennadi Liakhovetski * 13b6147490SGuennadi Liakhovetski * Driver for the MMC / SD / SDIO cell found in: 14b6147490SGuennadi Liakhovetski * 15b6147490SGuennadi Liakhovetski * TC6393XB TC6391XB TC6387XB T7L66XB ASIC3 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> 27b6147490SGuennadi Liakhovetski 28ac86045eSWolfram Sang #define CTL_SD_CMD 0x00 29ac86045eSWolfram Sang #define CTL_ARG_REG 0x04 30ac86045eSWolfram Sang #define CTL_STOP_INTERNAL_ACTION 0x08 31ac86045eSWolfram Sang #define CTL_XFER_BLK_COUNT 0xa 32ac86045eSWolfram Sang #define CTL_RESPONSE 0x0c 33184adf20SWolfram Sang /* driver merges STATUS and following STATUS2 */ 34ac86045eSWolfram Sang #define CTL_STATUS 0x1c 35184adf20SWolfram Sang /* driver merges IRQ_MASK and following IRQ_MASK2 */ 36ac86045eSWolfram Sang #define CTL_IRQ_MASK 0x20 37ac86045eSWolfram Sang #define CTL_SD_CARD_CLK_CTL 0x24 38ac86045eSWolfram Sang #define CTL_SD_XFER_LEN 0x26 39ac86045eSWolfram Sang #define CTL_SD_MEM_CARD_OPT 0x28 40ac86045eSWolfram Sang #define CTL_SD_ERROR_DETAIL_STATUS 0x2c 41ac86045eSWolfram Sang #define CTL_SD_DATA_PORT 0x30 42ac86045eSWolfram Sang #define CTL_TRANSACTION_CTL 0x34 43ac86045eSWolfram Sang #define CTL_SDIO_STATUS 0x36 44ac86045eSWolfram Sang #define CTL_SDIO_IRQ_MASK 0x38 45ac86045eSWolfram Sang #define CTL_DMA_ENABLE 0xd8 46ac86045eSWolfram Sang #define CTL_RESET_SD 0xe0 47ac86045eSWolfram Sang #define CTL_VERSION 0xe2 48ac86045eSWolfram Sang #define CTL_SDIO_REGS 0x100 49ac86045eSWolfram Sang #define CTL_CLK_AND_WAIT_CTL 0x138 50ac86045eSWolfram Sang #define CTL_RESET_SDIO 0x1e0 51ac86045eSWolfram Sang 52ac86045eSWolfram Sang /* Definitions for values the CTRL_STATUS register can take. */ 532cafc5cbSWolfram Sang #define TMIO_STAT_CMDRESPEND BIT(0) 542cafc5cbSWolfram Sang #define TMIO_STAT_DATAEND BIT(2) 552cafc5cbSWolfram Sang #define TMIO_STAT_CARD_REMOVE BIT(3) 562cafc5cbSWolfram Sang #define TMIO_STAT_CARD_INSERT BIT(4) 572cafc5cbSWolfram Sang #define TMIO_STAT_SIGSTATE BIT(5) 582cafc5cbSWolfram Sang #define TMIO_STAT_WRPROTECT BIT(7) 592cafc5cbSWolfram Sang #define TMIO_STAT_CARD_REMOVE_A BIT(8) 602cafc5cbSWolfram Sang #define TMIO_STAT_CARD_INSERT_A BIT(9) 612cafc5cbSWolfram Sang #define TMIO_STAT_SIGSTATE_A BIT(10) 622cafc5cbSWolfram Sang 632cafc5cbSWolfram Sang /* These belong technically to CTRL_STATUS2, but the driver merges them */ 642cafc5cbSWolfram Sang #define TMIO_STAT_CMD_IDX_ERR BIT(16) 652cafc5cbSWolfram Sang #define TMIO_STAT_CRCFAIL BIT(17) 662cafc5cbSWolfram Sang #define TMIO_STAT_STOPBIT_ERR BIT(18) 672cafc5cbSWolfram Sang #define TMIO_STAT_DATATIMEOUT BIT(19) 682cafc5cbSWolfram Sang #define TMIO_STAT_RXOVERFLOW BIT(20) 692cafc5cbSWolfram Sang #define TMIO_STAT_TXUNDERRUN BIT(21) 702cafc5cbSWolfram Sang #define TMIO_STAT_CMDTIMEOUT BIT(22) 7183e95351SWolfram Sang #define TMIO_STAT_DAT0 BIT(23) /* only known on R-Car so far */ 722cafc5cbSWolfram Sang #define TMIO_STAT_RXRDY BIT(24) 732cafc5cbSWolfram Sang #define TMIO_STAT_TXRQ BIT(25) 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 79ac86045eSWolfram Sang #define CLK_CTL_DIV_MASK 0xff 80ac86045eSWolfram Sang #define CLK_CTL_SCLKEN BIT(8) 81ac86045eSWolfram Sang 820bc0b6e8SWolfram Sang #define CARD_OPT_WIDTH8 BIT(13) 830bc0b6e8SWolfram Sang #define CARD_OPT_WIDTH BIT(15) 840bc0b6e8SWolfram Sang 85ac86045eSWolfram Sang #define TMIO_BBS 512 /* Boot block size */ 86ac86045eSWolfram Sang 87b6147490SGuennadi Liakhovetski /* Definitions for values the CTRL_SDIO_STATUS register can take. */ 88b6147490SGuennadi Liakhovetski #define TMIO_SDIO_STAT_IOIRQ 0x0001 89b6147490SGuennadi Liakhovetski #define TMIO_SDIO_STAT_EXPUB52 0x4000 90b6147490SGuennadi Liakhovetski #define TMIO_SDIO_STAT_EXWT 0x8000 91b6147490SGuennadi Liakhovetski #define TMIO_SDIO_MASK_ALL 0xc007 92b6147490SGuennadi Liakhovetski 93b6147490SGuennadi Liakhovetski /* Define some IRQ masks */ 94b6147490SGuennadi Liakhovetski /* This is the mask used at reset by the chip */ 95b6147490SGuennadi Liakhovetski #define TMIO_MASK_ALL 0x837f031d 96b6147490SGuennadi Liakhovetski #define TMIO_MASK_READOP (TMIO_STAT_RXRDY | TMIO_STAT_DATAEND) 97b6147490SGuennadi Liakhovetski #define TMIO_MASK_WRITEOP (TMIO_STAT_TXRQ | TMIO_STAT_DATAEND) 98b6147490SGuennadi Liakhovetski #define TMIO_MASK_CMD (TMIO_STAT_CMDRESPEND | TMIO_STAT_CMDTIMEOUT | \ 99b6147490SGuennadi Liakhovetski TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT) 100b6147490SGuennadi Liakhovetski #define TMIO_MASK_IRQ (TMIO_MASK_READOP | TMIO_MASK_WRITEOP | TMIO_MASK_CMD) 101b6147490SGuennadi Liakhovetski 102b6147490SGuennadi Liakhovetski struct tmio_mmc_data; 1035add2acaSKuninori Morimoto struct tmio_mmc_host; 104b6147490SGuennadi Liakhovetski 1057ecc09baSKuninori Morimoto struct tmio_mmc_dma { 106361936efSKuninori Morimoto enum dma_slave_buswidth dma_buswidth; 1077ecc09baSKuninori Morimoto bool (*filter)(struct dma_chan *chan, void *arg); 1085add2acaSKuninori Morimoto void (*enable)(struct tmio_mmc_host *host, bool enable); 1097ecc09baSKuninori Morimoto }; 1107ecc09baSKuninori Morimoto 111b6147490SGuennadi Liakhovetski struct tmio_mmc_host { 112b6147490SGuennadi Liakhovetski void __iomem *ctl; 113b6147490SGuennadi Liakhovetski struct mmc_command *cmd; 114b6147490SGuennadi Liakhovetski struct mmc_request *mrq; 115b6147490SGuennadi Liakhovetski struct mmc_data *data; 116b6147490SGuennadi Liakhovetski struct mmc_host *mmc; 117b6147490SGuennadi Liakhovetski 118b6147490SGuennadi Liakhovetski /* Callbacks for clock / power control */ 119b6147490SGuennadi Liakhovetski void (*set_pwr)(struct platform_device *host, int state); 120b6147490SGuennadi Liakhovetski void (*set_clk_div)(struct platform_device *host, int state); 121b6147490SGuennadi Liakhovetski 122b6147490SGuennadi Liakhovetski /* pio related stuff */ 123b6147490SGuennadi Liakhovetski struct scatterlist *sg_ptr; 124b6147490SGuennadi Liakhovetski struct scatterlist *sg_orig; 125b6147490SGuennadi Liakhovetski unsigned int sg_len; 126b6147490SGuennadi Liakhovetski unsigned int sg_off; 1277445bf9eSKuninori Morimoto unsigned long bus_shift; 128b6147490SGuennadi Liakhovetski 129b6147490SGuennadi Liakhovetski struct platform_device *pdev; 130b6147490SGuennadi Liakhovetski struct tmio_mmc_data *pdata; 1317ecc09baSKuninori Morimoto struct tmio_mmc_dma *dma; 132b6147490SGuennadi Liakhovetski 133b6147490SGuennadi Liakhovetski /* DMA support */ 134b6147490SGuennadi Liakhovetski bool force_pio; 135b6147490SGuennadi Liakhovetski struct dma_chan *chan_rx; 136b6147490SGuennadi Liakhovetski struct dma_chan *chan_tx; 137b6147490SGuennadi Liakhovetski struct tasklet_struct dma_complete; 138b6147490SGuennadi Liakhovetski struct tasklet_struct dma_issue; 139b6147490SGuennadi Liakhovetski struct scatterlist bounce_sg; 140b6147490SGuennadi Liakhovetski u8 *bounce_buf; 141b6147490SGuennadi Liakhovetski 142b6147490SGuennadi Liakhovetski /* Track lost interrupts */ 143b6147490SGuennadi Liakhovetski struct delayed_work delayed_reset_work; 144b9269fddSGuennadi Liakhovetski struct work_struct done; 145b9269fddSGuennadi Liakhovetski 146ae12d250SUlf Hansson /* Cache */ 14754680fe7SSimon Horman u32 sdcard_irq_mask; 14854680fe7SSimon Horman u32 sdio_irq_mask; 149ae12d250SUlf Hansson unsigned int clk_cache; 15054680fe7SSimon Horman 151b9269fddSGuennadi Liakhovetski spinlock_t lock; /* protect host private data */ 152b6147490SGuennadi Liakhovetski unsigned long last_req_ts; 153b9269fddSGuennadi Liakhovetski struct mutex ios_lock; /* protect set_ios() context */ 1542b1ac5c2SGuennadi Liakhovetski bool native_hotplug; 1557501c431SUlf Hansson bool sdio_irq_enabled; 1564f119977SAi Kyuse u32 scc_tappos; 157dfe9a229SKuninori Morimoto 1582f87365fSSimon Horman /* Mandatory callback */ 1590ea28210SBen Hutchings int (*clk_enable)(struct tmio_mmc_host *host); 1602f87365fSSimon Horman 1612f87365fSSimon Horman /* Optional callbacks */ 1622fb55956SBen Hutchings unsigned int (*clk_update)(struct tmio_mmc_host *host, 1632fb55956SBen Hutchings unsigned int new_clock); 1640ea28210SBen Hutchings void (*clk_disable)(struct tmio_mmc_host *host); 16585c02dddSKuninori Morimoto int (*multi_io_quirk)(struct mmc_card *card, 16685c02dddSKuninori Morimoto unsigned int direction, int blk_size); 1676a4679f3SWolfram Sang int (*card_busy)(struct mmc_host *mmc); 168452e5eefSWolfram Sang int (*start_signal_voltage_switch)(struct mmc_host *mmc, 169452e5eefSWolfram Sang struct mmc_ios *ios); 1702f87365fSSimon Horman int (*write16_hook)(struct tmio_mmc_host *host, int addr); 171e8f36b5dSAi Kyuse void (*hw_reset)(struct tmio_mmc_host *host); 1724f119977SAi Kyuse void (*prepare_tuning)(struct tmio_mmc_host *host, unsigned long tap); 1734f119977SAi Kyuse bool (*check_scc_error)(struct tmio_mmc_host *host); 1744f119977SAi Kyuse 1754f119977SAi Kyuse /* 1764f119977SAi Kyuse * Mandatory callback for tuning to occur which is optional for SDR50 1774f119977SAi Kyuse * and mandatory for SDR104. 1784f119977SAi Kyuse */ 1794f119977SAi Kyuse unsigned int (*init_tuning)(struct tmio_mmc_host *host); 1804f119977SAi Kyuse int (*select_tuning)(struct tmio_mmc_host *host); 1814f119977SAi Kyuse 1824f119977SAi Kyuse /* Tuning values: 1 for success, 0 for failure */ 1834f119977SAi Kyuse DECLARE_BITMAP(taps, BITS_PER_BYTE * sizeof(long)); 1844f119977SAi Kyuse unsigned int tap_num; 185b6147490SGuennadi Liakhovetski }; 186b6147490SGuennadi Liakhovetski 18794b110afSKuninori Morimoto struct tmio_mmc_host *tmio_mmc_host_alloc(struct platform_device *pdev); 18894b110afSKuninori Morimoto void tmio_mmc_host_free(struct tmio_mmc_host *host); 18994b110afSKuninori Morimoto int tmio_mmc_host_probe(struct tmio_mmc_host *host, 190b6147490SGuennadi Liakhovetski struct tmio_mmc_data *pdata); 191b6147490SGuennadi Liakhovetski void tmio_mmc_host_remove(struct tmio_mmc_host *host); 192b6147490SGuennadi Liakhovetski void tmio_mmc_do_data_irq(struct tmio_mmc_host *host); 193b6147490SGuennadi Liakhovetski 194b6147490SGuennadi Liakhovetski void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host *host, u32 i); 195b6147490SGuennadi Liakhovetski void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host *host, u32 i); 1968e7bfdb3SMagnus Damm irqreturn_t tmio_mmc_irq(int irq, void *devid); 197b6147490SGuennadi Liakhovetski 198b6147490SGuennadi Liakhovetski static inline char *tmio_mmc_kmap_atomic(struct scatterlist *sg, 199b6147490SGuennadi Liakhovetski unsigned long *flags) 200b6147490SGuennadi Liakhovetski { 201b6147490SGuennadi Liakhovetski local_irq_save(*flags); 202482fce99SCong Wang return kmap_atomic(sg_page(sg)) + sg->offset; 203b6147490SGuennadi Liakhovetski } 204b6147490SGuennadi Liakhovetski 205b6147490SGuennadi Liakhovetski static inline void tmio_mmc_kunmap_atomic(struct scatterlist *sg, 206b6147490SGuennadi Liakhovetski unsigned long *flags, void *virt) 207b6147490SGuennadi Liakhovetski { 208482fce99SCong Wang kunmap_atomic(virt - sg->offset); 209b6147490SGuennadi Liakhovetski local_irq_restore(*flags); 210b6147490SGuennadi Liakhovetski } 211b6147490SGuennadi Liakhovetski 21242051e8aSGuennadi Liakhovetski #if defined(CONFIG_MMC_SDHI) || defined(CONFIG_MMC_SDHI_MODULE) 213b6147490SGuennadi Liakhovetski void tmio_mmc_start_dma(struct tmio_mmc_host *host, struct mmc_data *data); 214162f43e3SGuennadi Liakhovetski void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable); 215b6147490SGuennadi Liakhovetski void tmio_mmc_request_dma(struct tmio_mmc_host *host, struct tmio_mmc_data *pdata); 216b6147490SGuennadi Liakhovetski void tmio_mmc_release_dma(struct tmio_mmc_host *host); 217e3de2be7SGuennadi Liakhovetski void tmio_mmc_abort_dma(struct tmio_mmc_host *host); 218b6147490SGuennadi Liakhovetski #else 219b6147490SGuennadi Liakhovetski static inline void tmio_mmc_start_dma(struct tmio_mmc_host *host, 220b6147490SGuennadi Liakhovetski struct mmc_data *data) 221b6147490SGuennadi Liakhovetski { 222b6147490SGuennadi Liakhovetski } 223b6147490SGuennadi Liakhovetski 224162f43e3SGuennadi Liakhovetski static inline void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable) 225162f43e3SGuennadi Liakhovetski { 226162f43e3SGuennadi Liakhovetski } 227162f43e3SGuennadi Liakhovetski 228b6147490SGuennadi Liakhovetski static inline void tmio_mmc_request_dma(struct tmio_mmc_host *host, 229b6147490SGuennadi Liakhovetski struct tmio_mmc_data *pdata) 230b6147490SGuennadi Liakhovetski { 231b6147490SGuennadi Liakhovetski host->chan_tx = NULL; 232b6147490SGuennadi Liakhovetski host->chan_rx = NULL; 233b6147490SGuennadi Liakhovetski } 234b6147490SGuennadi Liakhovetski 235b6147490SGuennadi Liakhovetski static inline void tmio_mmc_release_dma(struct tmio_mmc_host *host) 236b6147490SGuennadi Liakhovetski { 237b6147490SGuennadi Liakhovetski } 238e3de2be7SGuennadi Liakhovetski 239e3de2be7SGuennadi Liakhovetski static inline void tmio_mmc_abort_dma(struct tmio_mmc_host *host) 240e3de2be7SGuennadi Liakhovetski { 241e3de2be7SGuennadi Liakhovetski } 242b6147490SGuennadi Liakhovetski #endif 243b6147490SGuennadi Liakhovetski 2449ade7dbfSUlf Hansson #ifdef CONFIG_PM 2457311bef0SGuennadi Liakhovetski int tmio_mmc_host_runtime_suspend(struct device *dev); 2467311bef0SGuennadi Liakhovetski int tmio_mmc_host_runtime_resume(struct device *dev); 247710dec95SUlf Hansson #endif 2487311bef0SGuennadi Liakhovetski 249a11862d3SSimon Horman static inline u16 sd_ctrl_read16(struct tmio_mmc_host *host, int addr) 250a11862d3SSimon Horman { 2517445bf9eSKuninori Morimoto return readw(host->ctl + (addr << host->bus_shift)); 252a11862d3SSimon Horman } 253a11862d3SSimon Horman 254a11862d3SSimon Horman static inline void sd_ctrl_read16_rep(struct tmio_mmc_host *host, int addr, 255a11862d3SSimon Horman u16 *buf, int count) 256a11862d3SSimon Horman { 2577445bf9eSKuninori Morimoto readsw(host->ctl + (addr << host->bus_shift), buf, count); 258a11862d3SSimon Horman } 259a11862d3SSimon Horman 2602c54506bSWolfram Sang static inline u32 sd_ctrl_read16_and_16_as_32(struct tmio_mmc_host *host, int addr) 261a11862d3SSimon Horman { 2627445bf9eSKuninori Morimoto return readw(host->ctl + (addr << host->bus_shift)) | 2637445bf9eSKuninori Morimoto readw(host->ctl + ((addr + 2) << host->bus_shift)) << 16; 264a11862d3SSimon Horman } 265a11862d3SSimon Horman 2668185e51fSChris Brandt static inline void sd_ctrl_read32_rep(struct tmio_mmc_host *host, int addr, 2678185e51fSChris Brandt u32 *buf, int count) 2688185e51fSChris Brandt { 2698185e51fSChris Brandt readsl(host->ctl + (addr << host->bus_shift), buf, count); 2708185e51fSChris Brandt } 2718185e51fSChris Brandt 272a11862d3SSimon Horman static inline void sd_ctrl_write16(struct tmio_mmc_host *host, int addr, u16 val) 273a11862d3SSimon Horman { 274973ed3afSSimon Horman /* If there is a hook and it returns non-zero then there 275973ed3afSSimon Horman * is an error and the write should be skipped 276973ed3afSSimon Horman */ 277dfe9a229SKuninori Morimoto if (host->write16_hook && host->write16_hook(host, addr)) 278973ed3afSSimon Horman return; 2797445bf9eSKuninori Morimoto writew(val, host->ctl + (addr << host->bus_shift)); 280a11862d3SSimon Horman } 281a11862d3SSimon Horman 282a11862d3SSimon Horman static inline void sd_ctrl_write16_rep(struct tmio_mmc_host *host, int addr, 283a11862d3SSimon Horman u16 *buf, int count) 284a11862d3SSimon Horman { 2857445bf9eSKuninori Morimoto writesw(host->ctl + (addr << host->bus_shift), buf, count); 286a11862d3SSimon Horman } 287a11862d3SSimon Horman 2882c54506bSWolfram Sang static inline void sd_ctrl_write32_as_16_and_16(struct tmio_mmc_host *host, int addr, u32 val) 289a11862d3SSimon Horman { 2907c42dbf3SWolfram Sang writew(val & 0xffff, host->ctl + (addr << host->bus_shift)); 2917445bf9eSKuninori Morimoto writew(val >> 16, host->ctl + ((addr + 2) << host->bus_shift)); 292a11862d3SSimon Horman } 293a11862d3SSimon Horman 2948185e51fSChris Brandt static inline void sd_ctrl_write32_rep(struct tmio_mmc_host *host, int addr, 2958185e51fSChris Brandt const u32 *buf, int count) 2968185e51fSChris Brandt { 2978185e51fSChris Brandt writesl(host->ctl + (addr << host->bus_shift), buf, count); 2988185e51fSChris Brandt } 2998185e51fSChris Brandt 300b6147490SGuennadi Liakhovetski #endif 301