1b6147490SGuennadi Liakhovetski /* 2b6147490SGuennadi Liakhovetski * linux/drivers/mmc/host/tmio_mmc.h 3b6147490SGuennadi Liakhovetski * 4b6147490SGuennadi Liakhovetski * Copyright (C) 2007 Ian Molton 5b6147490SGuennadi Liakhovetski * Copyright (C) 2004 Ian Molton 6b6147490SGuennadi Liakhovetski * 7b6147490SGuennadi Liakhovetski * This program is free software; you can redistribute it and/or modify 8b6147490SGuennadi Liakhovetski * it under the terms of the GNU General Public License version 2 as 9b6147490SGuennadi Liakhovetski * published by the Free Software Foundation. 10b6147490SGuennadi Liakhovetski * 11b6147490SGuennadi Liakhovetski * Driver for the MMC / SD / SDIO cell found in: 12b6147490SGuennadi Liakhovetski * 13b6147490SGuennadi Liakhovetski * TC6393XB TC6391XB TC6387XB T7L66XB ASIC3 14b6147490SGuennadi Liakhovetski */ 15b6147490SGuennadi Liakhovetski 16b6147490SGuennadi Liakhovetski #ifndef TMIO_MMC_H 17b6147490SGuennadi Liakhovetski #define TMIO_MMC_H 18b6147490SGuennadi Liakhovetski 19b6147490SGuennadi Liakhovetski #include <linux/highmem.h> 20cba179aeSSimon Horman #include <linux/mmc/tmio.h> 21b9269fddSGuennadi Liakhovetski #include <linux/mutex.h> 22b6147490SGuennadi Liakhovetski #include <linux/pagemap.h> 236c0cbef6SRafael J. Wysocki #include <linux/scatterlist.h> 24e3de2be7SGuennadi Liakhovetski #include <linux/spinlock.h> 25b6147490SGuennadi Liakhovetski 26b6147490SGuennadi Liakhovetski /* Definitions for values the CTRL_SDIO_STATUS register can take. */ 27b6147490SGuennadi Liakhovetski #define TMIO_SDIO_STAT_IOIRQ 0x0001 28b6147490SGuennadi Liakhovetski #define TMIO_SDIO_STAT_EXPUB52 0x4000 29b6147490SGuennadi Liakhovetski #define TMIO_SDIO_STAT_EXWT 0x8000 30b6147490SGuennadi Liakhovetski #define TMIO_SDIO_MASK_ALL 0xc007 31b6147490SGuennadi Liakhovetski 32b6147490SGuennadi Liakhovetski /* Define some IRQ masks */ 33b6147490SGuennadi Liakhovetski /* This is the mask used at reset by the chip */ 34b6147490SGuennadi Liakhovetski #define TMIO_MASK_ALL 0x837f031d 35b6147490SGuennadi Liakhovetski #define TMIO_MASK_READOP (TMIO_STAT_RXRDY | TMIO_STAT_DATAEND) 36b6147490SGuennadi Liakhovetski #define TMIO_MASK_WRITEOP (TMIO_STAT_TXRQ | TMIO_STAT_DATAEND) 37b6147490SGuennadi Liakhovetski #define TMIO_MASK_CMD (TMIO_STAT_CMDRESPEND | TMIO_STAT_CMDTIMEOUT | \ 38b6147490SGuennadi Liakhovetski TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT) 39b6147490SGuennadi Liakhovetski #define TMIO_MASK_IRQ (TMIO_MASK_READOP | TMIO_MASK_WRITEOP | TMIO_MASK_CMD) 40b6147490SGuennadi Liakhovetski 41b6147490SGuennadi Liakhovetski struct tmio_mmc_data; 42b6147490SGuennadi Liakhovetski 43e83b7a8aSGuennadi Liakhovetski /* 44e83b7a8aSGuennadi Liakhovetski * We differentiate between the following 3 power states: 45e83b7a8aSGuennadi Liakhovetski * 1. card slot powered off, controller stopped. This is used, when either there 46e83b7a8aSGuennadi Liakhovetski * is no card in the slot, or the card really has to be powered down. 47e83b7a8aSGuennadi Liakhovetski * 2. card slot powered on, controller stopped. This is used, when a card is in 48e83b7a8aSGuennadi Liakhovetski * the slot, but no activity is currently taking place. This is a power- 49e83b7a8aSGuennadi Liakhovetski * saving mode with card-state preserved. This state can be entered, e.g. 50e83b7a8aSGuennadi Liakhovetski * when MMC clock-gating is used. 51e83b7a8aSGuennadi Liakhovetski * 3. card slot powered on, controller running. This is the actual active state. 52e83b7a8aSGuennadi Liakhovetski */ 53e83b7a8aSGuennadi Liakhovetski enum tmio_mmc_power { 54e83b7a8aSGuennadi Liakhovetski TMIO_MMC_OFF_STOP, /* card power off, controller stopped */ 55e83b7a8aSGuennadi Liakhovetski TMIO_MMC_ON_STOP, /* card power on, controller stopped */ 56e83b7a8aSGuennadi Liakhovetski TMIO_MMC_ON_RUN, /* card power on, controller running */ 57e83b7a8aSGuennadi Liakhovetski }; 58e83b7a8aSGuennadi Liakhovetski 59b6147490SGuennadi Liakhovetski struct tmio_mmc_host { 60b6147490SGuennadi Liakhovetski void __iomem *ctl; 61b6147490SGuennadi Liakhovetski struct mmc_command *cmd; 62b6147490SGuennadi Liakhovetski struct mmc_request *mrq; 63b6147490SGuennadi Liakhovetski struct mmc_data *data; 64b6147490SGuennadi Liakhovetski struct mmc_host *mmc; 65b6147490SGuennadi Liakhovetski 66e83b7a8aSGuennadi Liakhovetski /* Controller and card power state */ 67e83b7a8aSGuennadi Liakhovetski enum tmio_mmc_power power; 68c391e1b9SGuennadi Liakhovetski 69b6147490SGuennadi Liakhovetski /* Callbacks for clock / power control */ 70b6147490SGuennadi Liakhovetski void (*set_pwr)(struct platform_device *host, int state); 71b6147490SGuennadi Liakhovetski void (*set_clk_div)(struct platform_device *host, int state); 72b6147490SGuennadi Liakhovetski 73b6147490SGuennadi Liakhovetski /* pio related stuff */ 74b6147490SGuennadi Liakhovetski struct scatterlist *sg_ptr; 75b6147490SGuennadi Liakhovetski struct scatterlist *sg_orig; 76b6147490SGuennadi Liakhovetski unsigned int sg_len; 77b6147490SGuennadi Liakhovetski unsigned int sg_off; 78b6147490SGuennadi Liakhovetski 79b6147490SGuennadi Liakhovetski struct platform_device *pdev; 80b6147490SGuennadi Liakhovetski struct tmio_mmc_data *pdata; 81b6147490SGuennadi Liakhovetski 82b6147490SGuennadi Liakhovetski /* DMA support */ 83b6147490SGuennadi Liakhovetski bool force_pio; 84b6147490SGuennadi Liakhovetski struct dma_chan *chan_rx; 85b6147490SGuennadi Liakhovetski struct dma_chan *chan_tx; 86b6147490SGuennadi Liakhovetski struct tasklet_struct dma_complete; 87b6147490SGuennadi Liakhovetski struct tasklet_struct dma_issue; 88b6147490SGuennadi Liakhovetski struct scatterlist bounce_sg; 89b6147490SGuennadi Liakhovetski u8 *bounce_buf; 90b6147490SGuennadi Liakhovetski 91b6147490SGuennadi Liakhovetski /* Track lost interrupts */ 92b6147490SGuennadi Liakhovetski struct delayed_work delayed_reset_work; 93b9269fddSGuennadi Liakhovetski struct work_struct done; 94b9269fddSGuennadi Liakhovetski 9554680fe7SSimon Horman /* Cache IRQ mask */ 9654680fe7SSimon Horman u32 sdcard_irq_mask; 9754680fe7SSimon Horman u32 sdio_irq_mask; 9854680fe7SSimon Horman 99b9269fddSGuennadi Liakhovetski spinlock_t lock; /* protect host private data */ 100b6147490SGuennadi Liakhovetski unsigned long last_req_ts; 101b9269fddSGuennadi Liakhovetski struct mutex ios_lock; /* protect set_ios() context */ 1022b1ac5c2SGuennadi Liakhovetski bool native_hotplug; 103b22ffdcdSGuennadi Liakhovetski bool resuming; 1047501c431SUlf Hansson bool sdio_irq_enabled; 105b6147490SGuennadi Liakhovetski }; 106b6147490SGuennadi Liakhovetski 107b6147490SGuennadi Liakhovetski int tmio_mmc_host_probe(struct tmio_mmc_host **host, 108b6147490SGuennadi Liakhovetski struct platform_device *pdev, 109b6147490SGuennadi Liakhovetski struct tmio_mmc_data *pdata); 110b6147490SGuennadi Liakhovetski void tmio_mmc_host_remove(struct tmio_mmc_host *host); 111b6147490SGuennadi Liakhovetski void tmio_mmc_do_data_irq(struct tmio_mmc_host *host); 112b6147490SGuennadi Liakhovetski 113b6147490SGuennadi Liakhovetski void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host *host, u32 i); 114b6147490SGuennadi Liakhovetski void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host *host, u32 i); 1158e7bfdb3SMagnus Damm irqreturn_t tmio_mmc_irq(int irq, void *devid); 1167729c7a2SSimon Horman irqreturn_t tmio_mmc_sdcard_irq(int irq, void *devid); 1177729c7a2SSimon Horman irqreturn_t tmio_mmc_card_detect_irq(int irq, void *devid); 1187729c7a2SSimon Horman irqreturn_t tmio_mmc_sdio_irq(int irq, void *devid); 119b6147490SGuennadi Liakhovetski 120b6147490SGuennadi Liakhovetski static inline char *tmio_mmc_kmap_atomic(struct scatterlist *sg, 121b6147490SGuennadi Liakhovetski unsigned long *flags) 122b6147490SGuennadi Liakhovetski { 123b6147490SGuennadi Liakhovetski local_irq_save(*flags); 124482fce99SCong Wang return kmap_atomic(sg_page(sg)) + sg->offset; 125b6147490SGuennadi Liakhovetski } 126b6147490SGuennadi Liakhovetski 127b6147490SGuennadi Liakhovetski static inline void tmio_mmc_kunmap_atomic(struct scatterlist *sg, 128b6147490SGuennadi Liakhovetski unsigned long *flags, void *virt) 129b6147490SGuennadi Liakhovetski { 130482fce99SCong Wang kunmap_atomic(virt - sg->offset); 131b6147490SGuennadi Liakhovetski local_irq_restore(*flags); 132b6147490SGuennadi Liakhovetski } 133b6147490SGuennadi Liakhovetski 13442051e8aSGuennadi Liakhovetski #if defined(CONFIG_MMC_SDHI) || defined(CONFIG_MMC_SDHI_MODULE) 135b6147490SGuennadi Liakhovetski void tmio_mmc_start_dma(struct tmio_mmc_host *host, struct mmc_data *data); 136162f43e3SGuennadi Liakhovetski void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable); 137b6147490SGuennadi Liakhovetski void tmio_mmc_request_dma(struct tmio_mmc_host *host, struct tmio_mmc_data *pdata); 138b6147490SGuennadi Liakhovetski void tmio_mmc_release_dma(struct tmio_mmc_host *host); 139e3de2be7SGuennadi Liakhovetski void tmio_mmc_abort_dma(struct tmio_mmc_host *host); 140b6147490SGuennadi Liakhovetski #else 141b6147490SGuennadi Liakhovetski static inline void tmio_mmc_start_dma(struct tmio_mmc_host *host, 142b6147490SGuennadi Liakhovetski struct mmc_data *data) 143b6147490SGuennadi Liakhovetski { 144b6147490SGuennadi Liakhovetski } 145b6147490SGuennadi Liakhovetski 146162f43e3SGuennadi Liakhovetski static inline void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable) 147162f43e3SGuennadi Liakhovetski { 148162f43e3SGuennadi Liakhovetski } 149162f43e3SGuennadi Liakhovetski 150b6147490SGuennadi Liakhovetski static inline void tmio_mmc_request_dma(struct tmio_mmc_host *host, 151b6147490SGuennadi Liakhovetski struct tmio_mmc_data *pdata) 152b6147490SGuennadi Liakhovetski { 153b6147490SGuennadi Liakhovetski host->chan_tx = NULL; 154b6147490SGuennadi Liakhovetski host->chan_rx = NULL; 155b6147490SGuennadi Liakhovetski } 156b6147490SGuennadi Liakhovetski 157b6147490SGuennadi Liakhovetski static inline void tmio_mmc_release_dma(struct tmio_mmc_host *host) 158b6147490SGuennadi Liakhovetski { 159b6147490SGuennadi Liakhovetski } 160e3de2be7SGuennadi Liakhovetski 161e3de2be7SGuennadi Liakhovetski static inline void tmio_mmc_abort_dma(struct tmio_mmc_host *host) 162e3de2be7SGuennadi Liakhovetski { 163e3de2be7SGuennadi Liakhovetski } 164b6147490SGuennadi Liakhovetski #endif 165b6147490SGuennadi Liakhovetski 166710dec95SUlf Hansson #ifdef CONFIG_PM_SLEEP 167e6ee7182SGuennadi Liakhovetski int tmio_mmc_host_suspend(struct device *dev); 168e6ee7182SGuennadi Liakhovetski int tmio_mmc_host_resume(struct device *dev); 169e6ee7182SGuennadi Liakhovetski #endif 170e6ee7182SGuennadi Liakhovetski 171710dec95SUlf Hansson #ifdef CONFIG_PM_RUNTIME 1727311bef0SGuennadi Liakhovetski int tmio_mmc_host_runtime_suspend(struct device *dev); 1737311bef0SGuennadi Liakhovetski int tmio_mmc_host_runtime_resume(struct device *dev); 174710dec95SUlf Hansson #endif 1757311bef0SGuennadi Liakhovetski 176a11862d3SSimon Horman static inline u16 sd_ctrl_read16(struct tmio_mmc_host *host, int addr) 177a11862d3SSimon Horman { 1783b159a6eSKuninori Morimoto return readw(host->ctl + (addr << host->pdata->bus_shift)); 179a11862d3SSimon Horman } 180a11862d3SSimon Horman 181a11862d3SSimon Horman static inline void sd_ctrl_read16_rep(struct tmio_mmc_host *host, int addr, 182a11862d3SSimon Horman u16 *buf, int count) 183a11862d3SSimon Horman { 1843b159a6eSKuninori Morimoto readsw(host->ctl + (addr << host->pdata->bus_shift), buf, count); 185a11862d3SSimon Horman } 186a11862d3SSimon Horman 187a11862d3SSimon Horman static inline u32 sd_ctrl_read32(struct tmio_mmc_host *host, int addr) 188a11862d3SSimon Horman { 1893b159a6eSKuninori Morimoto return readw(host->ctl + (addr << host->pdata->bus_shift)) | 1903b159a6eSKuninori Morimoto readw(host->ctl + ((addr + 2) << host->pdata->bus_shift)) << 16; 191a11862d3SSimon Horman } 192a11862d3SSimon Horman 193a11862d3SSimon Horman static inline void sd_ctrl_write16(struct tmio_mmc_host *host, int addr, u16 val) 194a11862d3SSimon Horman { 195973ed3afSSimon Horman /* If there is a hook and it returns non-zero then there 196973ed3afSSimon Horman * is an error and the write should be skipped 197973ed3afSSimon Horman */ 198973ed3afSSimon Horman if (host->pdata->write16_hook && host->pdata->write16_hook(host, addr)) 199973ed3afSSimon Horman return; 2003b159a6eSKuninori Morimoto writew(val, host->ctl + (addr << host->pdata->bus_shift)); 201a11862d3SSimon Horman } 202a11862d3SSimon Horman 203a11862d3SSimon Horman static inline void sd_ctrl_write16_rep(struct tmio_mmc_host *host, int addr, 204a11862d3SSimon Horman u16 *buf, int count) 205a11862d3SSimon Horman { 2063b159a6eSKuninori Morimoto writesw(host->ctl + (addr << host->pdata->bus_shift), buf, count); 207a11862d3SSimon Horman } 208a11862d3SSimon Horman 209a11862d3SSimon Horman static inline void sd_ctrl_write32(struct tmio_mmc_host *host, int addr, u32 val) 210a11862d3SSimon Horman { 2113b159a6eSKuninori Morimoto writew(val, host->ctl + (addr << host->pdata->bus_shift)); 2123b159a6eSKuninori Morimoto writew(val >> 16, host->ctl + ((addr + 2) << host->pdata->bus_shift)); 213a11862d3SSimon Horman } 214a11862d3SSimon Horman 215a11862d3SSimon Horman 216b6147490SGuennadi Liakhovetski #endif 217