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 33ac86045eSWolfram Sang #define CTL_STATUS 0x1c 34ac86045eSWolfram Sang #define CTL_STATUS2 0x1e 35ac86045eSWolfram Sang #define CTL_IRQ_MASK 0x20 36ac86045eSWolfram Sang #define CTL_SD_CARD_CLK_CTL 0x24 37ac86045eSWolfram Sang #define CTL_SD_XFER_LEN 0x26 38ac86045eSWolfram Sang #define CTL_SD_MEM_CARD_OPT 0x28 39ac86045eSWolfram Sang #define CTL_SD_ERROR_DETAIL_STATUS 0x2c 40ac86045eSWolfram Sang #define CTL_SD_DATA_PORT 0x30 41ac86045eSWolfram Sang #define CTL_TRANSACTION_CTL 0x34 42ac86045eSWolfram Sang #define CTL_SDIO_STATUS 0x36 43ac86045eSWolfram Sang #define CTL_SDIO_IRQ_MASK 0x38 44ac86045eSWolfram Sang #define CTL_DMA_ENABLE 0xd8 45ac86045eSWolfram Sang #define CTL_RESET_SD 0xe0 46ac86045eSWolfram Sang #define CTL_VERSION 0xe2 47ac86045eSWolfram Sang #define CTL_SDIO_REGS 0x100 48ac86045eSWolfram Sang #define CTL_CLK_AND_WAIT_CTL 0x138 49ac86045eSWolfram Sang #define CTL_RESET_SDIO 0x1e0 50ac86045eSWolfram Sang 51ac86045eSWolfram Sang /* Definitions for values the CTRL_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 622cafc5cbSWolfram Sang /* These belong technically to CTRL_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) 702cafc5cbSWolfram Sang #define TMIO_STAT_RXRDY BIT(24) 712cafc5cbSWolfram Sang #define TMIO_STAT_TXRQ BIT(25) 722cafc5cbSWolfram Sang #define TMIO_STAT_ILL_FUNC BIT(29) 732cafc5cbSWolfram Sang #define TMIO_STAT_CMD_BUSY BIT(30) 742cafc5cbSWolfram Sang #define TMIO_STAT_ILL_ACCESS BIT(31) 75ac86045eSWolfram Sang 76ac86045eSWolfram Sang #define TMIO_STATUS2_DAT0 BIT(7) 77ac86045eSWolfram Sang 78ac86045eSWolfram Sang #define CLK_CTL_DIV_MASK 0xff 79ac86045eSWolfram Sang #define CLK_CTL_SCLKEN BIT(8) 80ac86045eSWolfram Sang 81ac86045eSWolfram Sang #define TMIO_BBS 512 /* Boot block size */ 82ac86045eSWolfram Sang 83b6147490SGuennadi Liakhovetski /* Definitions for values the CTRL_SDIO_STATUS register can take. */ 84b6147490SGuennadi Liakhovetski #define TMIO_SDIO_STAT_IOIRQ 0x0001 85b6147490SGuennadi Liakhovetski #define TMIO_SDIO_STAT_EXPUB52 0x4000 86b6147490SGuennadi Liakhovetski #define TMIO_SDIO_STAT_EXWT 0x8000 87b6147490SGuennadi Liakhovetski #define TMIO_SDIO_MASK_ALL 0xc007 88b6147490SGuennadi Liakhovetski 89b6147490SGuennadi Liakhovetski /* Define some IRQ masks */ 90b6147490SGuennadi Liakhovetski /* This is the mask used at reset by the chip */ 91b6147490SGuennadi Liakhovetski #define TMIO_MASK_ALL 0x837f031d 92b6147490SGuennadi Liakhovetski #define TMIO_MASK_READOP (TMIO_STAT_RXRDY | TMIO_STAT_DATAEND) 93b6147490SGuennadi Liakhovetski #define TMIO_MASK_WRITEOP (TMIO_STAT_TXRQ | TMIO_STAT_DATAEND) 94b6147490SGuennadi Liakhovetski #define TMIO_MASK_CMD (TMIO_STAT_CMDRESPEND | TMIO_STAT_CMDTIMEOUT | \ 95b6147490SGuennadi Liakhovetski TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT) 96b6147490SGuennadi Liakhovetski #define TMIO_MASK_IRQ (TMIO_MASK_READOP | TMIO_MASK_WRITEOP | TMIO_MASK_CMD) 97b6147490SGuennadi Liakhovetski 98b6147490SGuennadi Liakhovetski struct tmio_mmc_data; 995add2acaSKuninori Morimoto struct tmio_mmc_host; 100b6147490SGuennadi Liakhovetski 1017ecc09baSKuninori Morimoto struct tmio_mmc_dma { 102361936efSKuninori Morimoto enum dma_slave_buswidth dma_buswidth; 1037ecc09baSKuninori Morimoto bool (*filter)(struct dma_chan *chan, void *arg); 1045add2acaSKuninori Morimoto void (*enable)(struct tmio_mmc_host *host, bool enable); 1057ecc09baSKuninori Morimoto }; 1067ecc09baSKuninori Morimoto 107b6147490SGuennadi Liakhovetski struct tmio_mmc_host { 108b6147490SGuennadi Liakhovetski void __iomem *ctl; 109b6147490SGuennadi Liakhovetski struct mmc_command *cmd; 110b6147490SGuennadi Liakhovetski struct mmc_request *mrq; 111b6147490SGuennadi Liakhovetski struct mmc_data *data; 112b6147490SGuennadi Liakhovetski struct mmc_host *mmc; 113b6147490SGuennadi Liakhovetski 114b6147490SGuennadi Liakhovetski /* Callbacks for clock / power control */ 115b6147490SGuennadi Liakhovetski void (*set_pwr)(struct platform_device *host, int state); 116b6147490SGuennadi Liakhovetski void (*set_clk_div)(struct platform_device *host, int state); 117b6147490SGuennadi Liakhovetski 118b6147490SGuennadi Liakhovetski /* pio related stuff */ 119b6147490SGuennadi Liakhovetski struct scatterlist *sg_ptr; 120b6147490SGuennadi Liakhovetski struct scatterlist *sg_orig; 121b6147490SGuennadi Liakhovetski unsigned int sg_len; 122b6147490SGuennadi Liakhovetski unsigned int sg_off; 1237445bf9eSKuninori Morimoto unsigned long bus_shift; 124b6147490SGuennadi Liakhovetski 125b6147490SGuennadi Liakhovetski struct platform_device *pdev; 126b6147490SGuennadi Liakhovetski struct tmio_mmc_data *pdata; 1277ecc09baSKuninori Morimoto struct tmio_mmc_dma *dma; 128b6147490SGuennadi Liakhovetski 129b6147490SGuennadi Liakhovetski /* DMA support */ 130b6147490SGuennadi Liakhovetski bool force_pio; 131b6147490SGuennadi Liakhovetski struct dma_chan *chan_rx; 132b6147490SGuennadi Liakhovetski struct dma_chan *chan_tx; 133b6147490SGuennadi Liakhovetski struct tasklet_struct dma_complete; 134b6147490SGuennadi Liakhovetski struct tasklet_struct dma_issue; 135b6147490SGuennadi Liakhovetski struct scatterlist bounce_sg; 136b6147490SGuennadi Liakhovetski u8 *bounce_buf; 137b6147490SGuennadi Liakhovetski 138b6147490SGuennadi Liakhovetski /* Track lost interrupts */ 139b6147490SGuennadi Liakhovetski struct delayed_work delayed_reset_work; 140b9269fddSGuennadi Liakhovetski struct work_struct done; 141b9269fddSGuennadi Liakhovetski 142ae12d250SUlf Hansson /* Cache */ 14354680fe7SSimon Horman u32 sdcard_irq_mask; 14454680fe7SSimon Horman u32 sdio_irq_mask; 145ae12d250SUlf Hansson unsigned int clk_cache; 14654680fe7SSimon Horman 147b9269fddSGuennadi Liakhovetski spinlock_t lock; /* protect host private data */ 148b6147490SGuennadi Liakhovetski unsigned long last_req_ts; 149b9269fddSGuennadi Liakhovetski struct mutex ios_lock; /* protect set_ios() context */ 1502b1ac5c2SGuennadi Liakhovetski bool native_hotplug; 1517501c431SUlf Hansson bool sdio_irq_enabled; 152dfe9a229SKuninori Morimoto 153dfe9a229SKuninori Morimoto int (*write16_hook)(struct tmio_mmc_host *host, int addr); 1540ea28210SBen Hutchings int (*clk_enable)(struct tmio_mmc_host *host); 1552fb55956SBen Hutchings unsigned int (*clk_update)(struct tmio_mmc_host *host, 1562fb55956SBen Hutchings unsigned int new_clock); 1570ea28210SBen Hutchings void (*clk_disable)(struct tmio_mmc_host *host); 15885c02dddSKuninori Morimoto int (*multi_io_quirk)(struct mmc_card *card, 15985c02dddSKuninori Morimoto unsigned int direction, int blk_size); 160452e5eefSWolfram Sang int (*start_signal_voltage_switch)(struct mmc_host *mmc, 161452e5eefSWolfram Sang struct mmc_ios *ios); 162b6147490SGuennadi Liakhovetski }; 163b6147490SGuennadi Liakhovetski 16494b110afSKuninori Morimoto struct tmio_mmc_host *tmio_mmc_host_alloc(struct platform_device *pdev); 16594b110afSKuninori Morimoto void tmio_mmc_host_free(struct tmio_mmc_host *host); 16694b110afSKuninori Morimoto int tmio_mmc_host_probe(struct tmio_mmc_host *host, 167b6147490SGuennadi Liakhovetski struct tmio_mmc_data *pdata); 168b6147490SGuennadi Liakhovetski void tmio_mmc_host_remove(struct tmio_mmc_host *host); 169b6147490SGuennadi Liakhovetski void tmio_mmc_do_data_irq(struct tmio_mmc_host *host); 170b6147490SGuennadi Liakhovetski 171b6147490SGuennadi Liakhovetski void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host *host, u32 i); 172b6147490SGuennadi Liakhovetski void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host *host, u32 i); 1738e7bfdb3SMagnus Damm irqreturn_t tmio_mmc_irq(int irq, void *devid); 174b6147490SGuennadi Liakhovetski 175b6147490SGuennadi Liakhovetski static inline char *tmio_mmc_kmap_atomic(struct scatterlist *sg, 176b6147490SGuennadi Liakhovetski unsigned long *flags) 177b6147490SGuennadi Liakhovetski { 178b6147490SGuennadi Liakhovetski local_irq_save(*flags); 179482fce99SCong Wang return kmap_atomic(sg_page(sg)) + sg->offset; 180b6147490SGuennadi Liakhovetski } 181b6147490SGuennadi Liakhovetski 182b6147490SGuennadi Liakhovetski static inline void tmio_mmc_kunmap_atomic(struct scatterlist *sg, 183b6147490SGuennadi Liakhovetski unsigned long *flags, void *virt) 184b6147490SGuennadi Liakhovetski { 185482fce99SCong Wang kunmap_atomic(virt - sg->offset); 186b6147490SGuennadi Liakhovetski local_irq_restore(*flags); 187b6147490SGuennadi Liakhovetski } 188b6147490SGuennadi Liakhovetski 18942051e8aSGuennadi Liakhovetski #if defined(CONFIG_MMC_SDHI) || defined(CONFIG_MMC_SDHI_MODULE) 190b6147490SGuennadi Liakhovetski void tmio_mmc_start_dma(struct tmio_mmc_host *host, struct mmc_data *data); 191162f43e3SGuennadi Liakhovetski void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable); 192b6147490SGuennadi Liakhovetski void tmio_mmc_request_dma(struct tmio_mmc_host *host, struct tmio_mmc_data *pdata); 193b6147490SGuennadi Liakhovetski void tmio_mmc_release_dma(struct tmio_mmc_host *host); 194e3de2be7SGuennadi Liakhovetski void tmio_mmc_abort_dma(struct tmio_mmc_host *host); 195b6147490SGuennadi Liakhovetski #else 196b6147490SGuennadi Liakhovetski static inline void tmio_mmc_start_dma(struct tmio_mmc_host *host, 197b6147490SGuennadi Liakhovetski struct mmc_data *data) 198b6147490SGuennadi Liakhovetski { 199b6147490SGuennadi Liakhovetski } 200b6147490SGuennadi Liakhovetski 201162f43e3SGuennadi Liakhovetski static inline void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable) 202162f43e3SGuennadi Liakhovetski { 203162f43e3SGuennadi Liakhovetski } 204162f43e3SGuennadi Liakhovetski 205b6147490SGuennadi Liakhovetski static inline void tmio_mmc_request_dma(struct tmio_mmc_host *host, 206b6147490SGuennadi Liakhovetski struct tmio_mmc_data *pdata) 207b6147490SGuennadi Liakhovetski { 208b6147490SGuennadi Liakhovetski host->chan_tx = NULL; 209b6147490SGuennadi Liakhovetski host->chan_rx = NULL; 210b6147490SGuennadi Liakhovetski } 211b6147490SGuennadi Liakhovetski 212b6147490SGuennadi Liakhovetski static inline void tmio_mmc_release_dma(struct tmio_mmc_host *host) 213b6147490SGuennadi Liakhovetski { 214b6147490SGuennadi Liakhovetski } 215e3de2be7SGuennadi Liakhovetski 216e3de2be7SGuennadi Liakhovetski static inline void tmio_mmc_abort_dma(struct tmio_mmc_host *host) 217e3de2be7SGuennadi Liakhovetski { 218e3de2be7SGuennadi Liakhovetski } 219b6147490SGuennadi Liakhovetski #endif 220b6147490SGuennadi Liakhovetski 2219ade7dbfSUlf Hansson #ifdef CONFIG_PM 2227311bef0SGuennadi Liakhovetski int tmio_mmc_host_runtime_suspend(struct device *dev); 2237311bef0SGuennadi Liakhovetski int tmio_mmc_host_runtime_resume(struct device *dev); 224710dec95SUlf Hansson #endif 2257311bef0SGuennadi Liakhovetski 226a11862d3SSimon Horman static inline u16 sd_ctrl_read16(struct tmio_mmc_host *host, int addr) 227a11862d3SSimon Horman { 2287445bf9eSKuninori Morimoto return readw(host->ctl + (addr << host->bus_shift)); 229a11862d3SSimon Horman } 230a11862d3SSimon Horman 231a11862d3SSimon Horman static inline void sd_ctrl_read16_rep(struct tmio_mmc_host *host, int addr, 232a11862d3SSimon Horman u16 *buf, int count) 233a11862d3SSimon Horman { 2347445bf9eSKuninori Morimoto readsw(host->ctl + (addr << host->bus_shift), buf, count); 235a11862d3SSimon Horman } 236a11862d3SSimon Horman 2372c54506bSWolfram Sang static inline u32 sd_ctrl_read16_and_16_as_32(struct tmio_mmc_host *host, int addr) 238a11862d3SSimon Horman { 2397445bf9eSKuninori Morimoto return readw(host->ctl + (addr << host->bus_shift)) | 2407445bf9eSKuninori Morimoto readw(host->ctl + ((addr + 2) << host->bus_shift)) << 16; 241a11862d3SSimon Horman } 242a11862d3SSimon Horman 243a11862d3SSimon Horman static inline void sd_ctrl_write16(struct tmio_mmc_host *host, int addr, u16 val) 244a11862d3SSimon Horman { 245973ed3afSSimon Horman /* If there is a hook and it returns non-zero then there 246973ed3afSSimon Horman * is an error and the write should be skipped 247973ed3afSSimon Horman */ 248dfe9a229SKuninori Morimoto if (host->write16_hook && host->write16_hook(host, addr)) 249973ed3afSSimon Horman return; 2507445bf9eSKuninori Morimoto writew(val, host->ctl + (addr << host->bus_shift)); 251a11862d3SSimon Horman } 252a11862d3SSimon Horman 253a11862d3SSimon Horman static inline void sd_ctrl_write16_rep(struct tmio_mmc_host *host, int addr, 254a11862d3SSimon Horman u16 *buf, int count) 255a11862d3SSimon Horman { 2567445bf9eSKuninori Morimoto writesw(host->ctl + (addr << host->bus_shift), buf, count); 257a11862d3SSimon Horman } 258a11862d3SSimon Horman 2592c54506bSWolfram Sang static inline void sd_ctrl_write32_as_16_and_16(struct tmio_mmc_host *host, int addr, u32 val) 260a11862d3SSimon Horman { 2617445bf9eSKuninori Morimoto writew(val, host->ctl + (addr << host->bus_shift)); 2627445bf9eSKuninori Morimoto writew(val >> 16, host->ctl + ((addr + 2) << host->bus_shift)); 263a11862d3SSimon Horman } 264a11862d3SSimon Horman 265b6147490SGuennadi Liakhovetski #endif 266