2 * linux/drivers/mmc/host/tmio_mmc.h
4 * Copyright (C) 2016 Sang Engineering, Wolfram Sang
5 * Copyright (C) 2015-16 Renesas Electronics Corporation
6 * Copyright (C) 2007 Ian Molton
7 * Copyright (C) 2004 Ian Molton
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
13 * Driver for the MMC / SD / SDIO cell found in:
15 * TC6393XB TC6391XB TC6387XB T7L66XB ASIC3
21 #include <linux/dmaengine.h>
22 #include <linux/highmem.h>
23 #include <linux/mutex.h>
24 #include <linux/pagemap.h>
25 #include <linux/scatterlist.h>
26 #include <linux/spinlock.h>
28 #define CTL_SD_CMD 0x00
29 #define CTL_ARG_REG 0x04
30 #define CTL_STOP_INTERNAL_ACTION 0x08
31 #define CTL_XFER_BLK_COUNT 0xa
32 #define CTL_RESPONSE 0x0c
33 #define CTL_STATUS 0x1c
34 #define CTL_STATUS2 0x1e
35 #define CTL_IRQ_MASK 0x20
36 #define CTL_SD_CARD_CLK_CTL 0x24
37 #define CTL_SD_XFER_LEN 0x26
38 #define CTL_SD_MEM_CARD_OPT 0x28
39 #define CTL_SD_ERROR_DETAIL_STATUS 0x2c
40 #define CTL_SD_DATA_PORT 0x30
41 #define CTL_TRANSACTION_CTL 0x34
42 #define CTL_SDIO_STATUS 0x36
43 #define CTL_SDIO_IRQ_MASK 0x38
44 #define CTL_DMA_ENABLE 0xd8
45 #define CTL_RESET_SD 0xe0
46 #define CTL_VERSION 0xe2
47 #define CTL_SDIO_REGS 0x100
48 #define CTL_CLK_AND_WAIT_CTL 0x138
49 #define CTL_RESET_SDIO 0x1e0
51 /* Definitions for values the CTRL_STATUS register can take. */
52 #define TMIO_STAT_CMDRESPEND BIT(0)
53 #define TMIO_STAT_DATAEND BIT(2)
54 #define TMIO_STAT_CARD_REMOVE BIT(3)
55 #define TMIO_STAT_CARD_INSERT BIT(4)
56 #define TMIO_STAT_SIGSTATE BIT(5)
57 #define TMIO_STAT_WRPROTECT BIT(7)
58 #define TMIO_STAT_CARD_REMOVE_A BIT(8)
59 #define TMIO_STAT_CARD_INSERT_A BIT(9)
60 #define TMIO_STAT_SIGSTATE_A BIT(10)
62 /* These belong technically to CTRL_STATUS2, but the driver merges them */
63 #define TMIO_STAT_CMD_IDX_ERR BIT(16)
64 #define TMIO_STAT_CRCFAIL BIT(17)
65 #define TMIO_STAT_STOPBIT_ERR BIT(18)
66 #define TMIO_STAT_DATATIMEOUT BIT(19)
67 #define TMIO_STAT_RXOVERFLOW BIT(20)
68 #define TMIO_STAT_TXUNDERRUN BIT(21)
69 #define TMIO_STAT_CMDTIMEOUT BIT(22)
70 #define TMIO_STAT_DAT0 BIT(23) /* only known on R-Car so far */
71 #define TMIO_STAT_RXRDY BIT(24)
72 #define TMIO_STAT_TXRQ BIT(25)
73 #define TMIO_STAT_ILL_FUNC BIT(29) /* only when !TMIO_MMC_HAS_IDLE_WAIT */
74 #define TMIO_STAT_SCLKDIVEN BIT(29) /* only when TMIO_MMC_HAS_IDLE_WAIT */
75 #define TMIO_STAT_CMD_BUSY BIT(30)
76 #define TMIO_STAT_ILL_ACCESS BIT(31)
78 #define CLK_CTL_DIV_MASK 0xff
79 #define CLK_CTL_SCLKEN BIT(8)
81 #define TMIO_BBS 512 /* Boot block size */
83 /* Definitions for values the CTRL_SDIO_STATUS register can take. */
84 #define TMIO_SDIO_STAT_IOIRQ 0x0001
85 #define TMIO_SDIO_STAT_EXPUB52 0x4000
86 #define TMIO_SDIO_STAT_EXWT 0x8000
87 #define TMIO_SDIO_MASK_ALL 0xc007
89 /* Define some IRQ masks */
90 /* This is the mask used at reset by the chip */
91 #define TMIO_MASK_ALL 0x837f031d
92 #define TMIO_MASK_READOP (TMIO_STAT_RXRDY | TMIO_STAT_DATAEND)
93 #define TMIO_MASK_WRITEOP (TMIO_STAT_TXRQ | TMIO_STAT_DATAEND)
94 #define TMIO_MASK_CMD (TMIO_STAT_CMDRESPEND | TMIO_STAT_CMDTIMEOUT | \
95 TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT)
96 #define TMIO_MASK_IRQ (TMIO_MASK_READOP | TMIO_MASK_WRITEOP | TMIO_MASK_CMD)
101 struct tmio_mmc_dma {
102 enum dma_slave_buswidth dma_buswidth;
103 bool (*filter)(struct dma_chan *chan, void *arg);
104 void (*enable)(struct tmio_mmc_host *host, bool enable);
107 struct tmio_mmc_host {
109 struct mmc_command *cmd;
110 struct mmc_request *mrq;
111 struct mmc_data *data;
112 struct mmc_host *mmc;
114 /* Callbacks for clock / power control */
115 void (*set_pwr)(struct platform_device *host, int state);
116 void (*set_clk_div)(struct platform_device *host, int state);
118 /* pio related stuff */
119 struct scatterlist *sg_ptr;
120 struct scatterlist *sg_orig;
123 unsigned long bus_shift;
125 struct platform_device *pdev;
126 struct tmio_mmc_data *pdata;
127 struct tmio_mmc_dma *dma;
131 struct dma_chan *chan_rx;
132 struct dma_chan *chan_tx;
133 struct tasklet_struct dma_complete;
134 struct tasklet_struct dma_issue;
135 struct scatterlist bounce_sg;
138 /* Track lost interrupts */
139 struct delayed_work delayed_reset_work;
140 struct work_struct done;
145 unsigned int clk_cache;
147 spinlock_t lock; /* protect host private data */
148 unsigned long last_req_ts;
149 struct mutex ios_lock; /* protect set_ios() context */
151 bool sdio_irq_enabled;
153 int (*write16_hook)(struct tmio_mmc_host *host, int addr);
154 int (*clk_enable)(struct tmio_mmc_host *host);
155 unsigned int (*clk_update)(struct tmio_mmc_host *host,
156 unsigned int new_clock);
157 void (*clk_disable)(struct tmio_mmc_host *host);
158 int (*multi_io_quirk)(struct mmc_card *card,
159 unsigned int direction, int blk_size);
160 int (*start_signal_voltage_switch)(struct mmc_host *mmc,
161 struct mmc_ios *ios);
164 struct tmio_mmc_host *tmio_mmc_host_alloc(struct platform_device *pdev);
165 void tmio_mmc_host_free(struct tmio_mmc_host *host);
166 int tmio_mmc_host_probe(struct tmio_mmc_host *host,
167 struct tmio_mmc_data *pdata);
168 void tmio_mmc_host_remove(struct tmio_mmc_host *host);
169 void tmio_mmc_do_data_irq(struct tmio_mmc_host *host);
171 void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
172 void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
173 irqreturn_t tmio_mmc_irq(int irq, void *devid);
175 static inline char *tmio_mmc_kmap_atomic(struct scatterlist *sg,
176 unsigned long *flags)
178 local_irq_save(*flags);
179 return kmap_atomic(sg_page(sg)) + sg->offset;
182 static inline void tmio_mmc_kunmap_atomic(struct scatterlist *sg,
183 unsigned long *flags, void *virt)
185 kunmap_atomic(virt - sg->offset);
186 local_irq_restore(*flags);
189 #if defined(CONFIG_MMC_SDHI) || defined(CONFIG_MMC_SDHI_MODULE)
190 void tmio_mmc_start_dma(struct tmio_mmc_host *host, struct mmc_data *data);
191 void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable);
192 void tmio_mmc_request_dma(struct tmio_mmc_host *host, struct tmio_mmc_data *pdata);
193 void tmio_mmc_release_dma(struct tmio_mmc_host *host);
194 void tmio_mmc_abort_dma(struct tmio_mmc_host *host);
196 static inline void tmio_mmc_start_dma(struct tmio_mmc_host *host,
197 struct mmc_data *data)
201 static inline void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable)
205 static inline void tmio_mmc_request_dma(struct tmio_mmc_host *host,
206 struct tmio_mmc_data *pdata)
208 host->chan_tx = NULL;
209 host->chan_rx = NULL;
212 static inline void tmio_mmc_release_dma(struct tmio_mmc_host *host)
216 static inline void tmio_mmc_abort_dma(struct tmio_mmc_host *host)
222 int tmio_mmc_host_runtime_suspend(struct device *dev);
223 int tmio_mmc_host_runtime_resume(struct device *dev);
226 static inline u16 sd_ctrl_read16(struct tmio_mmc_host *host, int addr)
228 return readw(host->ctl + (addr << host->bus_shift));
231 static inline void sd_ctrl_read16_rep(struct tmio_mmc_host *host, int addr,
234 readsw(host->ctl + (addr << host->bus_shift), buf, count);
237 static inline u32 sd_ctrl_read16_and_16_as_32(struct tmio_mmc_host *host, int addr)
239 return readw(host->ctl + (addr << host->bus_shift)) |
240 readw(host->ctl + ((addr + 2) << host->bus_shift)) << 16;
243 static inline void sd_ctrl_write16(struct tmio_mmc_host *host, int addr, u16 val)
245 /* If there is a hook and it returns non-zero then there
246 * is an error and the write should be skipped
248 if (host->write16_hook && host->write16_hook(host, addr))
250 writew(val, host->ctl + (addr << host->bus_shift));
253 static inline void sd_ctrl_write16_rep(struct tmio_mmc_host *host, int addr,
256 writesw(host->ctl + (addr << host->bus_shift), buf, count);
259 static inline void sd_ctrl_write32_as_16_and_16(struct tmio_mmc_host *host, int addr, u32 val)
261 writew(val, host->ctl + (addr << host->bus_shift));
262 writew(val >> 16, host->ctl + ((addr + 2) << host->bus_shift));