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