Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 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 | |
Kuninori Morimoto | 361936e | 2015-01-13 04:59:14 +0000 | [diff] [blame] | 19 | #include <linux/dmaengine.h> |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 20 | #include <linux/highmem.h> |
Simon Horman | cba179a | 2011-03-24 09:48:36 +0100 | [diff] [blame] | 21 | #include <linux/mmc/tmio.h> |
Guennadi Liakhovetski | b9269fd | 2011-07-14 12:12:38 +0200 | [diff] [blame] | 22 | #include <linux/mutex.h> |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 23 | #include <linux/pagemap.h> |
Rafael J. Wysocki | 6c0cbef | 2011-07-26 20:50:23 +0200 | [diff] [blame] | 24 | #include <linux/scatterlist.h> |
Guennadi Liakhovetski | e3de2be | 2012-01-06 13:06:51 +0100 | [diff] [blame] | 25 | #include <linux/spinlock.h> |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 26 | |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 27 | /* Definitions for values the CTRL_SDIO_STATUS register can take. */ |
Simon Horman | cba179a | 2011-03-24 09:48:36 +0100 | [diff] [blame] | 28 | #define TMIO_SDIO_STAT_IOIRQ 0x0001 |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 29 | #define TMIO_SDIO_STAT_EXPUB52 0x4000 |
Simon Horman | cba179a | 2011-03-24 09:48:36 +0100 | [diff] [blame] | 30 | #define TMIO_SDIO_STAT_EXWT 0x8000 |
| 31 | #define TMIO_SDIO_MASK_ALL 0xc007 |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 32 | |
| 33 | /* Define some IRQ masks */ |
| 34 | /* This is the mask used at reset by the chip */ |
| 35 | #define TMIO_MASK_ALL 0x837f031d |
| 36 | #define TMIO_MASK_READOP (TMIO_STAT_RXRDY | TMIO_STAT_DATAEND) |
| 37 | #define TMIO_MASK_WRITEOP (TMIO_STAT_TXRQ | TMIO_STAT_DATAEND) |
| 38 | #define TMIO_MASK_CMD (TMIO_STAT_CMDRESPEND | TMIO_STAT_CMDTIMEOUT | \ |
| 39 | TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT) |
| 40 | #define TMIO_MASK_IRQ (TMIO_MASK_READOP | TMIO_MASK_WRITEOP | TMIO_MASK_CMD) |
| 41 | |
| 42 | struct tmio_mmc_data; |
Kuninori Morimoto | 5add2ac | 2015-01-13 04:59:05 +0000 | [diff] [blame] | 43 | struct tmio_mmc_host; |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 44 | |
Kuninori Morimoto | 7ecc09b | 2015-01-13 04:57:33 +0000 | [diff] [blame] | 45 | struct tmio_mmc_dma { |
Kuninori Morimoto | 361936e | 2015-01-13 04:59:14 +0000 | [diff] [blame] | 46 | enum dma_slave_buswidth dma_buswidth; |
Kuninori Morimoto | 7ecc09b | 2015-01-13 04:57:33 +0000 | [diff] [blame] | 47 | bool (*filter)(struct dma_chan *chan, void *arg); |
Kuninori Morimoto | 5add2ac | 2015-01-13 04:59:05 +0000 | [diff] [blame] | 48 | void (*enable)(struct tmio_mmc_host *host, bool enable); |
Kuninori Morimoto | 7ecc09b | 2015-01-13 04:57:33 +0000 | [diff] [blame] | 49 | }; |
| 50 | |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 51 | struct tmio_mmc_host { |
| 52 | void __iomem *ctl; |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 53 | struct mmc_command *cmd; |
| 54 | struct mmc_request *mrq; |
| 55 | struct mmc_data *data; |
| 56 | struct mmc_host *mmc; |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 57 | |
| 58 | /* Callbacks for clock / power control */ |
| 59 | void (*set_pwr)(struct platform_device *host, int state); |
| 60 | void (*set_clk_div)(struct platform_device *host, int state); |
| 61 | |
| 62 | /* pio related stuff */ |
| 63 | struct scatterlist *sg_ptr; |
| 64 | struct scatterlist *sg_orig; |
| 65 | unsigned int sg_len; |
| 66 | unsigned int sg_off; |
Kuninori Morimoto | 7445bf9 | 2015-01-13 04:58:20 +0000 | [diff] [blame] | 67 | unsigned long bus_shift; |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 68 | |
| 69 | struct platform_device *pdev; |
| 70 | struct tmio_mmc_data *pdata; |
Kuninori Morimoto | 7ecc09b | 2015-01-13 04:57:33 +0000 | [diff] [blame] | 71 | struct tmio_mmc_dma *dma; |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 72 | |
| 73 | /* DMA support */ |
| 74 | bool force_pio; |
| 75 | struct dma_chan *chan_rx; |
| 76 | struct dma_chan *chan_tx; |
| 77 | struct tasklet_struct dma_complete; |
| 78 | struct tasklet_struct dma_issue; |
| 79 | struct scatterlist bounce_sg; |
| 80 | u8 *bounce_buf; |
| 81 | |
| 82 | /* Track lost interrupts */ |
| 83 | struct delayed_work delayed_reset_work; |
Guennadi Liakhovetski | b9269fd | 2011-07-14 12:12:38 +0200 | [diff] [blame] | 84 | struct work_struct done; |
| 85 | |
Ulf Hansson | ae12d25 | 2013-10-30 00:16:17 +0100 | [diff] [blame] | 86 | /* Cache */ |
Simon Horman | 54680fe | 2011-08-25 10:27:25 +0900 | [diff] [blame] | 87 | u32 sdcard_irq_mask; |
| 88 | u32 sdio_irq_mask; |
Ulf Hansson | ae12d25 | 2013-10-30 00:16:17 +0100 | [diff] [blame] | 89 | unsigned int clk_cache; |
Simon Horman | 54680fe | 2011-08-25 10:27:25 +0900 | [diff] [blame] | 90 | |
Guennadi Liakhovetski | b9269fd | 2011-07-14 12:12:38 +0200 | [diff] [blame] | 91 | spinlock_t lock; /* protect host private data */ |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 92 | unsigned long last_req_ts; |
Guennadi Liakhovetski | b9269fd | 2011-07-14 12:12:38 +0200 | [diff] [blame] | 93 | struct mutex ios_lock; /* protect set_ios() context */ |
Guennadi Liakhovetski | 2b1ac5c | 2012-02-09 22:57:08 +0100 | [diff] [blame] | 94 | bool native_hotplug; |
Ulf Hansson | 7501c43 | 2013-10-24 15:58:45 +0200 | [diff] [blame] | 95 | bool sdio_irq_enabled; |
Kuninori Morimoto | dfe9a22 | 2015-01-13 04:57:42 +0000 | [diff] [blame] | 96 | |
| 97 | int (*write16_hook)(struct tmio_mmc_host *host, int addr); |
Ben Hutchings | 0ea2821 | 2016-04-01 17:44:31 +0200 | [diff] [blame] | 98 | int (*clk_enable)(struct tmio_mmc_host *host); |
Ben Hutchings | 2fb5595 | 2016-04-01 17:44:32 +0200 | [diff] [blame] | 99 | unsigned int (*clk_update)(struct tmio_mmc_host *host, |
| 100 | unsigned int new_clock); |
Ben Hutchings | 0ea2821 | 2016-04-01 17:44:31 +0200 | [diff] [blame] | 101 | void (*clk_disable)(struct tmio_mmc_host *host); |
Kuninori Morimoto | 85c02dd | 2015-01-13 04:58:10 +0000 | [diff] [blame] | 102 | int (*multi_io_quirk)(struct mmc_card *card, |
| 103 | unsigned int direction, int blk_size); |
Wolfram Sang | 452e5ee | 2016-04-01 17:44:33 +0200 | [diff] [blame] | 104 | int (*start_signal_voltage_switch)(struct mmc_host *mmc, |
| 105 | struct mmc_ios *ios); |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 106 | }; |
| 107 | |
Kuninori Morimoto | 94b110a | 2015-01-13 04:57:22 +0000 | [diff] [blame] | 108 | struct tmio_mmc_host *tmio_mmc_host_alloc(struct platform_device *pdev); |
| 109 | void tmio_mmc_host_free(struct tmio_mmc_host *host); |
| 110 | int tmio_mmc_host_probe(struct tmio_mmc_host *host, |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 111 | struct tmio_mmc_data *pdata); |
| 112 | void tmio_mmc_host_remove(struct tmio_mmc_host *host); |
| 113 | void tmio_mmc_do_data_irq(struct tmio_mmc_host *host); |
| 114 | |
| 115 | void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host *host, u32 i); |
| 116 | void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host *host, u32 i); |
Magnus Damm | 8e7bfdb | 2011-05-06 11:02:33 +0000 | [diff] [blame] | 117 | irqreturn_t tmio_mmc_irq(int irq, void *devid); |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 118 | |
| 119 | static inline char *tmio_mmc_kmap_atomic(struct scatterlist *sg, |
| 120 | unsigned long *flags) |
| 121 | { |
| 122 | local_irq_save(*flags); |
Cong Wang | 482fce9 | 2011-11-27 13:27:00 +0800 | [diff] [blame] | 123 | return kmap_atomic(sg_page(sg)) + sg->offset; |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 124 | } |
| 125 | |
| 126 | static inline void tmio_mmc_kunmap_atomic(struct scatterlist *sg, |
| 127 | unsigned long *flags, void *virt) |
| 128 | { |
Cong Wang | 482fce9 | 2011-11-27 13:27:00 +0800 | [diff] [blame] | 129 | kunmap_atomic(virt - sg->offset); |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 130 | local_irq_restore(*flags); |
| 131 | } |
| 132 | |
Guennadi Liakhovetski | 42051e8 | 2011-03-14 09:52:33 +0100 | [diff] [blame] | 133 | #if defined(CONFIG_MMC_SDHI) || defined(CONFIG_MMC_SDHI_MODULE) |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 134 | void tmio_mmc_start_dma(struct tmio_mmc_host *host, struct mmc_data *data); |
Guennadi Liakhovetski | 162f43e | 2011-07-14 18:39:10 +0200 | [diff] [blame] | 135 | void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable); |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 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); |
Guennadi Liakhovetski | e3de2be | 2012-01-06 13:06:51 +0100 | [diff] [blame] | 138 | void tmio_mmc_abort_dma(struct tmio_mmc_host *host); |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 139 | #else |
| 140 | static inline void tmio_mmc_start_dma(struct tmio_mmc_host *host, |
| 141 | struct mmc_data *data) |
| 142 | { |
| 143 | } |
| 144 | |
Guennadi Liakhovetski | 162f43e | 2011-07-14 18:39:10 +0200 | [diff] [blame] | 145 | static inline void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable) |
| 146 | { |
| 147 | } |
| 148 | |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 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 | } |
Guennadi Liakhovetski | e3de2be | 2012-01-06 13:06:51 +0100 | [diff] [blame] | 159 | |
| 160 | static inline void tmio_mmc_abort_dma(struct tmio_mmc_host *host) |
| 161 | { |
| 162 | } |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 163 | #endif |
| 164 | |
Ulf Hansson | 9ade7db | 2014-08-25 12:03:20 +0200 | [diff] [blame] | 165 | #ifdef CONFIG_PM |
Guennadi Liakhovetski | 7311bef | 2011-05-11 16:51:11 +0000 | [diff] [blame] | 166 | int tmio_mmc_host_runtime_suspend(struct device *dev); |
| 167 | int tmio_mmc_host_runtime_resume(struct device *dev); |
Ulf Hansson | 710dec9 | 2013-10-23 14:55:07 +0200 | [diff] [blame] | 168 | #endif |
Guennadi Liakhovetski | 7311bef | 2011-05-11 16:51:11 +0000 | [diff] [blame] | 169 | |
Simon Horman | a11862d | 2011-06-21 08:00:09 +0900 | [diff] [blame] | 170 | static inline u16 sd_ctrl_read16(struct tmio_mmc_host *host, int addr) |
| 171 | { |
Kuninori Morimoto | 7445bf9 | 2015-01-13 04:58:20 +0000 | [diff] [blame] | 172 | return readw(host->ctl + (addr << host->bus_shift)); |
Simon Horman | a11862d | 2011-06-21 08:00:09 +0900 | [diff] [blame] | 173 | } |
| 174 | |
| 175 | static inline void sd_ctrl_read16_rep(struct tmio_mmc_host *host, int addr, |
| 176 | u16 *buf, int count) |
| 177 | { |
Kuninori Morimoto | 7445bf9 | 2015-01-13 04:58:20 +0000 | [diff] [blame] | 178 | readsw(host->ctl + (addr << host->bus_shift), buf, count); |
Simon Horman | a11862d | 2011-06-21 08:00:09 +0900 | [diff] [blame] | 179 | } |
| 180 | |
| 181 | static inline u32 sd_ctrl_read32(struct tmio_mmc_host *host, int addr) |
| 182 | { |
Kuninori Morimoto | 7445bf9 | 2015-01-13 04:58:20 +0000 | [diff] [blame] | 183 | return readw(host->ctl + (addr << host->bus_shift)) | |
| 184 | readw(host->ctl + ((addr + 2) << host->bus_shift)) << 16; |
Simon Horman | a11862d | 2011-06-21 08:00:09 +0900 | [diff] [blame] | 185 | } |
| 186 | |
| 187 | static inline void sd_ctrl_write16(struct tmio_mmc_host *host, int addr, u16 val) |
| 188 | { |
Simon Horman | 973ed3a | 2011-06-21 08:00:10 +0900 | [diff] [blame] | 189 | /* If there is a hook and it returns non-zero then there |
| 190 | * is an error and the write should be skipped |
| 191 | */ |
Kuninori Morimoto | dfe9a22 | 2015-01-13 04:57:42 +0000 | [diff] [blame] | 192 | if (host->write16_hook && host->write16_hook(host, addr)) |
Simon Horman | 973ed3a | 2011-06-21 08:00:10 +0900 | [diff] [blame] | 193 | return; |
Kuninori Morimoto | 7445bf9 | 2015-01-13 04:58:20 +0000 | [diff] [blame] | 194 | writew(val, host->ctl + (addr << host->bus_shift)); |
Simon Horman | a11862d | 2011-06-21 08:00:09 +0900 | [diff] [blame] | 195 | } |
| 196 | |
| 197 | static inline void sd_ctrl_write16_rep(struct tmio_mmc_host *host, int addr, |
| 198 | u16 *buf, int count) |
| 199 | { |
Kuninori Morimoto | 7445bf9 | 2015-01-13 04:58:20 +0000 | [diff] [blame] | 200 | writesw(host->ctl + (addr << host->bus_shift), buf, count); |
Simon Horman | a11862d | 2011-06-21 08:00:09 +0900 | [diff] [blame] | 201 | } |
| 202 | |
| 203 | static inline void sd_ctrl_write32(struct tmio_mmc_host *host, int addr, u32 val) |
| 204 | { |
Kuninori Morimoto | 7445bf9 | 2015-01-13 04:58:20 +0000 | [diff] [blame] | 205 | writew(val, host->ctl + (addr << host->bus_shift)); |
| 206 | writew(val >> 16, host->ctl + ((addr + 2) << host->bus_shift)); |
Simon Horman | a11862d | 2011-06-21 08:00:09 +0900 | [diff] [blame] | 207 | } |
| 208 | |
| 209 | |
Guennadi Liakhovetski | b614749 | 2011-03-23 12:42:44 +0100 | [diff] [blame] | 210 | #endif |