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. */ 52ac86045eSWolfram Sang #define TMIO_STAT_CMDRESPEND 0x00000001 53ac86045eSWolfram Sang #define TMIO_STAT_DATAEND 0x00000004 54ac86045eSWolfram Sang #define TMIO_STAT_CARD_REMOVE 0x00000008 55ac86045eSWolfram Sang #define TMIO_STAT_CARD_INSERT 0x00000010 56ac86045eSWolfram Sang #define TMIO_STAT_SIGSTATE 0x00000020 57ac86045eSWolfram Sang #define TMIO_STAT_WRPROTECT 0x00000080 58ac86045eSWolfram Sang #define TMIO_STAT_CARD_REMOVE_A 0x00000100 59ac86045eSWolfram Sang #define TMIO_STAT_CARD_INSERT_A 0x00000200 60ac86045eSWolfram Sang #define TMIO_STAT_SIGSTATE_A 0x00000400 61ac86045eSWolfram Sang #define TMIO_STAT_CMD_IDX_ERR 0x00010000 62ac86045eSWolfram Sang #define TMIO_STAT_CRCFAIL 0x00020000 63ac86045eSWolfram Sang #define TMIO_STAT_STOPBIT_ERR 0x00040000 64ac86045eSWolfram Sang #define TMIO_STAT_DATATIMEOUT 0x00080000 65ac86045eSWolfram Sang #define TMIO_STAT_RXOVERFLOW 0x00100000 66ac86045eSWolfram Sang #define TMIO_STAT_TXUNDERRUN 0x00200000 67ac86045eSWolfram Sang #define TMIO_STAT_CMDTIMEOUT 0x00400000 68ac86045eSWolfram Sang #define TMIO_STAT_RXRDY 0x01000000 69ac86045eSWolfram Sang #define TMIO_STAT_TXRQ 0x02000000 70ac86045eSWolfram Sang #define TMIO_STAT_ILL_FUNC 0x20000000 71ac86045eSWolfram Sang #define TMIO_STAT_CMD_BUSY 0x40000000 72ac86045eSWolfram Sang #define TMIO_STAT_ILL_ACCESS 0x80000000 73ac86045eSWolfram Sang 74ac86045eSWolfram Sang #define TMIO_STATUS2_DAT0 BIT(7) 75ac86045eSWolfram Sang 76ac86045eSWolfram Sang #define CLK_CTL_DIV_MASK 0xff 77ac86045eSWolfram Sang #define CLK_CTL_SCLKEN BIT(8) 78ac86045eSWolfram Sang 79ac86045eSWolfram Sang #define TMIO_BBS 512 /* Boot block size */ 80ac86045eSWolfram Sang 81b6147490SGuennadi Liakhovetski /* Definitions for values the CTRL_SDIO_STATUS register can take. */ 82b6147490SGuennadi Liakhovetski #define TMIO_SDIO_STAT_IOIRQ 0x0001 83b6147490SGuennadi Liakhovetski #define TMIO_SDIO_STAT_EXPUB52 0x4000 84b6147490SGuennadi Liakhovetski #define TMIO_SDIO_STAT_EXWT 0x8000 85b6147490SGuennadi Liakhovetski #define TMIO_SDIO_MASK_ALL 0xc007 86b6147490SGuennadi Liakhovetski 87b6147490SGuennadi Liakhovetski /* Define some IRQ masks */ 88b6147490SGuennadi Liakhovetski /* This is the mask used at reset by the chip */ 89b6147490SGuennadi Liakhovetski #define TMIO_MASK_ALL 0x837f031d 90b6147490SGuennadi Liakhovetski #define TMIO_MASK_READOP (TMIO_STAT_RXRDY | TMIO_STAT_DATAEND) 91b6147490SGuennadi Liakhovetski #define TMIO_MASK_WRITEOP (TMIO_STAT_TXRQ | TMIO_STAT_DATAEND) 92b6147490SGuennadi Liakhovetski #define TMIO_MASK_CMD (TMIO_STAT_CMDRESPEND | TMIO_STAT_CMDTIMEOUT | \ 93b6147490SGuennadi Liakhovetski TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT) 94b6147490SGuennadi Liakhovetski #define TMIO_MASK_IRQ (TMIO_MASK_READOP | TMIO_MASK_WRITEOP | TMIO_MASK_CMD) 95b6147490SGuennadi Liakhovetski 96b6147490SGuennadi Liakhovetski struct tmio_mmc_data; 975add2acaSKuninori Morimoto struct tmio_mmc_host; 98b6147490SGuennadi Liakhovetski 997ecc09baSKuninori Morimoto struct tmio_mmc_dma { 100361936efSKuninori Morimoto enum dma_slave_buswidth dma_buswidth; 1017ecc09baSKuninori Morimoto bool (*filter)(struct dma_chan *chan, void *arg); 1025add2acaSKuninori Morimoto void (*enable)(struct tmio_mmc_host *host, bool enable); 1037ecc09baSKuninori Morimoto }; 1047ecc09baSKuninori Morimoto 105b6147490SGuennadi Liakhovetski struct tmio_mmc_host { 106b6147490SGuennadi Liakhovetski void __iomem *ctl; 107b6147490SGuennadi Liakhovetski struct mmc_command *cmd; 108b6147490SGuennadi Liakhovetski struct mmc_request *mrq; 109b6147490SGuennadi Liakhovetski struct mmc_data *data; 110b6147490SGuennadi Liakhovetski struct mmc_host *mmc; 111b6147490SGuennadi Liakhovetski 112b6147490SGuennadi Liakhovetski /* Callbacks for clock / power control */ 113b6147490SGuennadi Liakhovetski void (*set_pwr)(struct platform_device *host, int state); 114b6147490SGuennadi Liakhovetski void (*set_clk_div)(struct platform_device *host, int state); 115b6147490SGuennadi Liakhovetski 116b6147490SGuennadi Liakhovetski /* pio related stuff */ 117b6147490SGuennadi Liakhovetski struct scatterlist *sg_ptr; 118b6147490SGuennadi Liakhovetski struct scatterlist *sg_orig; 119b6147490SGuennadi Liakhovetski unsigned int sg_len; 120b6147490SGuennadi Liakhovetski unsigned int sg_off; 1217445bf9eSKuninori Morimoto unsigned long bus_shift; 122b6147490SGuennadi Liakhovetski 123b6147490SGuennadi Liakhovetski struct platform_device *pdev; 124b6147490SGuennadi Liakhovetski struct tmio_mmc_data *pdata; 1257ecc09baSKuninori Morimoto struct tmio_mmc_dma *dma; 126b6147490SGuennadi Liakhovetski 127b6147490SGuennadi Liakhovetski /* DMA support */ 128b6147490SGuennadi Liakhovetski bool force_pio; 129b6147490SGuennadi Liakhovetski struct dma_chan *chan_rx; 130b6147490SGuennadi Liakhovetski struct dma_chan *chan_tx; 131b6147490SGuennadi Liakhovetski struct tasklet_struct dma_complete; 132b6147490SGuennadi Liakhovetski struct tasklet_struct dma_issue; 133b6147490SGuennadi Liakhovetski struct scatterlist bounce_sg; 134b6147490SGuennadi Liakhovetski u8 *bounce_buf; 135b6147490SGuennadi Liakhovetski 136b6147490SGuennadi Liakhovetski /* Track lost interrupts */ 137b6147490SGuennadi Liakhovetski struct delayed_work delayed_reset_work; 138b9269fddSGuennadi Liakhovetski struct work_struct done; 139b9269fddSGuennadi Liakhovetski 140ae12d250SUlf Hansson /* Cache */ 14154680fe7SSimon Horman u32 sdcard_irq_mask; 14254680fe7SSimon Horman u32 sdio_irq_mask; 143ae12d250SUlf Hansson unsigned int clk_cache; 14454680fe7SSimon Horman 145b9269fddSGuennadi Liakhovetski spinlock_t lock; /* protect host private data */ 146b6147490SGuennadi Liakhovetski unsigned long last_req_ts; 147b9269fddSGuennadi Liakhovetski struct mutex ios_lock; /* protect set_ios() context */ 1482b1ac5c2SGuennadi Liakhovetski bool native_hotplug; 1497501c431SUlf Hansson bool sdio_irq_enabled; 150dfe9a229SKuninori Morimoto 151dfe9a229SKuninori Morimoto int (*write16_hook)(struct tmio_mmc_host *host, int addr); 1520ea28210SBen Hutchings int (*clk_enable)(struct tmio_mmc_host *host); 1532fb55956SBen Hutchings unsigned int (*clk_update)(struct tmio_mmc_host *host, 1542fb55956SBen Hutchings unsigned int new_clock); 1550ea28210SBen Hutchings void (*clk_disable)(struct tmio_mmc_host *host); 15685c02dddSKuninori Morimoto int (*multi_io_quirk)(struct mmc_card *card, 15785c02dddSKuninori Morimoto unsigned int direction, int blk_size); 158452e5eefSWolfram Sang int (*start_signal_voltage_switch)(struct mmc_host *mmc, 159452e5eefSWolfram Sang struct mmc_ios *ios); 160b6147490SGuennadi Liakhovetski }; 161b6147490SGuennadi Liakhovetski 16294b110afSKuninori Morimoto struct tmio_mmc_host *tmio_mmc_host_alloc(struct platform_device *pdev); 16394b110afSKuninori Morimoto void tmio_mmc_host_free(struct tmio_mmc_host *host); 16494b110afSKuninori Morimoto int tmio_mmc_host_probe(struct tmio_mmc_host *host, 165b6147490SGuennadi Liakhovetski struct tmio_mmc_data *pdata); 166b6147490SGuennadi Liakhovetski void tmio_mmc_host_remove(struct tmio_mmc_host *host); 167b6147490SGuennadi Liakhovetski void tmio_mmc_do_data_irq(struct tmio_mmc_host *host); 168b6147490SGuennadi Liakhovetski 169b6147490SGuennadi Liakhovetski void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host *host, u32 i); 170b6147490SGuennadi Liakhovetski void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host *host, u32 i); 1718e7bfdb3SMagnus Damm irqreturn_t tmio_mmc_irq(int irq, void *devid); 172b6147490SGuennadi Liakhovetski 173b6147490SGuennadi Liakhovetski static inline char *tmio_mmc_kmap_atomic(struct scatterlist *sg, 174b6147490SGuennadi Liakhovetski unsigned long *flags) 175b6147490SGuennadi Liakhovetski { 176b6147490SGuennadi Liakhovetski local_irq_save(*flags); 177482fce99SCong Wang return kmap_atomic(sg_page(sg)) + sg->offset; 178b6147490SGuennadi Liakhovetski } 179b6147490SGuennadi Liakhovetski 180b6147490SGuennadi Liakhovetski static inline void tmio_mmc_kunmap_atomic(struct scatterlist *sg, 181b6147490SGuennadi Liakhovetski unsigned long *flags, void *virt) 182b6147490SGuennadi Liakhovetski { 183482fce99SCong Wang kunmap_atomic(virt - sg->offset); 184b6147490SGuennadi Liakhovetski local_irq_restore(*flags); 185b6147490SGuennadi Liakhovetski } 186b6147490SGuennadi Liakhovetski 18742051e8aSGuennadi Liakhovetski #if defined(CONFIG_MMC_SDHI) || defined(CONFIG_MMC_SDHI_MODULE) 188b6147490SGuennadi Liakhovetski void tmio_mmc_start_dma(struct tmio_mmc_host *host, struct mmc_data *data); 189162f43e3SGuennadi Liakhovetski void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable); 190b6147490SGuennadi Liakhovetski void tmio_mmc_request_dma(struct tmio_mmc_host *host, struct tmio_mmc_data *pdata); 191b6147490SGuennadi Liakhovetski void tmio_mmc_release_dma(struct tmio_mmc_host *host); 192e3de2be7SGuennadi Liakhovetski void tmio_mmc_abort_dma(struct tmio_mmc_host *host); 193b6147490SGuennadi Liakhovetski #else 194b6147490SGuennadi Liakhovetski static inline void tmio_mmc_start_dma(struct tmio_mmc_host *host, 195b6147490SGuennadi Liakhovetski struct mmc_data *data) 196b6147490SGuennadi Liakhovetski { 197b6147490SGuennadi Liakhovetski } 198b6147490SGuennadi Liakhovetski 199162f43e3SGuennadi Liakhovetski static inline void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable) 200162f43e3SGuennadi Liakhovetski { 201162f43e3SGuennadi Liakhovetski } 202162f43e3SGuennadi Liakhovetski 203b6147490SGuennadi Liakhovetski static inline void tmio_mmc_request_dma(struct tmio_mmc_host *host, 204b6147490SGuennadi Liakhovetski struct tmio_mmc_data *pdata) 205b6147490SGuennadi Liakhovetski { 206b6147490SGuennadi Liakhovetski host->chan_tx = NULL; 207b6147490SGuennadi Liakhovetski host->chan_rx = NULL; 208b6147490SGuennadi Liakhovetski } 209b6147490SGuennadi Liakhovetski 210b6147490SGuennadi Liakhovetski static inline void tmio_mmc_release_dma(struct tmio_mmc_host *host) 211b6147490SGuennadi Liakhovetski { 212b6147490SGuennadi Liakhovetski } 213e3de2be7SGuennadi Liakhovetski 214e3de2be7SGuennadi Liakhovetski static inline void tmio_mmc_abort_dma(struct tmio_mmc_host *host) 215e3de2be7SGuennadi Liakhovetski { 216e3de2be7SGuennadi Liakhovetski } 217b6147490SGuennadi Liakhovetski #endif 218b6147490SGuennadi Liakhovetski 2199ade7dbfSUlf Hansson #ifdef CONFIG_PM 2207311bef0SGuennadi Liakhovetski int tmio_mmc_host_runtime_suspend(struct device *dev); 2217311bef0SGuennadi Liakhovetski int tmio_mmc_host_runtime_resume(struct device *dev); 222710dec95SUlf Hansson #endif 2237311bef0SGuennadi Liakhovetski 224a11862d3SSimon Horman static inline u16 sd_ctrl_read16(struct tmio_mmc_host *host, int addr) 225a11862d3SSimon Horman { 2267445bf9eSKuninori Morimoto return readw(host->ctl + (addr << host->bus_shift)); 227a11862d3SSimon Horman } 228a11862d3SSimon Horman 229a11862d3SSimon Horman static inline void sd_ctrl_read16_rep(struct tmio_mmc_host *host, int addr, 230a11862d3SSimon Horman u16 *buf, int count) 231a11862d3SSimon Horman { 2327445bf9eSKuninori Morimoto readsw(host->ctl + (addr << host->bus_shift), buf, count); 233a11862d3SSimon Horman } 234a11862d3SSimon Horman 235a11862d3SSimon Horman static inline u32 sd_ctrl_read32(struct tmio_mmc_host *host, int addr) 236a11862d3SSimon Horman { 2377445bf9eSKuninori Morimoto return readw(host->ctl + (addr << host->bus_shift)) | 2387445bf9eSKuninori Morimoto readw(host->ctl + ((addr + 2) << host->bus_shift)) << 16; 239a11862d3SSimon Horman } 240a11862d3SSimon Horman 241a11862d3SSimon Horman static inline void sd_ctrl_write16(struct tmio_mmc_host *host, int addr, u16 val) 242a11862d3SSimon Horman { 243973ed3afSSimon Horman /* If there is a hook and it returns non-zero then there 244973ed3afSSimon Horman * is an error and the write should be skipped 245973ed3afSSimon Horman */ 246dfe9a229SKuninori Morimoto if (host->write16_hook && host->write16_hook(host, addr)) 247973ed3afSSimon Horman return; 2487445bf9eSKuninori Morimoto writew(val, host->ctl + (addr << host->bus_shift)); 249a11862d3SSimon Horman } 250a11862d3SSimon Horman 251a11862d3SSimon Horman static inline void sd_ctrl_write16_rep(struct tmio_mmc_host *host, int addr, 252a11862d3SSimon Horman u16 *buf, int count) 253a11862d3SSimon Horman { 2547445bf9eSKuninori Morimoto writesw(host->ctl + (addr << host->bus_shift), buf, count); 255a11862d3SSimon Horman } 256a11862d3SSimon Horman 257a11862d3SSimon Horman static inline void sd_ctrl_write32(struct tmio_mmc_host *host, int addr, u32 val) 258a11862d3SSimon Horman { 2597445bf9eSKuninori Morimoto writew(val, host->ctl + (addr << host->bus_shift)); 2607445bf9eSKuninori Morimoto writew(val >> 16, host->ctl + ((addr + 2) << host->bus_shift)); 261a11862d3SSimon Horman } 262a11862d3SSimon Horman 263a11862d3SSimon Horman 264b6147490SGuennadi Liakhovetski #endif 265