projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge tag 'pinctrl-v4.9-1' of git://git.kernel.org/pub/scm/linux/kernel/git/linusw...
[linux-2.6-block.git] / drivers / mmc / host / tmio_mmc.h
CommitLineData
b6147490
GL		 1/*
2 * linux/drivers/mmc/host/tmio_mmc.h
3 *
ac86045e
WS		 4 * Copyright (C) 2016 Sang Engineering, Wolfram Sang
5 * Copyright (C) 2015-16 Renesas Electronics Corporation
b6147490
GL		 6 * Copyright (C) 2007 Ian Molton
7 * Copyright (C) 2004 Ian Molton
8 *
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.
12 *
13 * Driver for the MMC / SD / SDIO cell found in:
14 *
15 * TC6393XB TC6391XB TC6387XB T7L66XB ASIC3
16 */
17
18#ifndef TMIO_MMC_H
19#define TMIO_MMC_H
20
361936ef 21#include <linux/dmaengine.h>
b6147490 22#include <linux/highmem.h>
b9269fdd 23#include <linux/mutex.h>
b6147490 24#include <linux/pagemap.h>
6c0cbef6 25#include <linux/scatterlist.h>
e3de2be7 26#include <linux/spinlock.h>
b6147490 27
ac86045e
WS		 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
184adf20 33/* driver merges STATUS and following STATUS2 */
ac86045e 34#define CTL_STATUS 0x1c
184adf20 35/* driver merges IRQ_MASK and following IRQ_MASK2 */
ac86045e
WS		 36#define CTL_IRQ_MASK 0x20
37#define CTL_SD_CARD_CLK_CTL 0x24
38#define CTL_SD_XFER_LEN 0x26
39#define CTL_SD_MEM_CARD_OPT 0x28
40#define CTL_SD_ERROR_DETAIL_STATUS 0x2c
41#define CTL_SD_DATA_PORT 0x30
42#define CTL_TRANSACTION_CTL 0x34
43#define CTL_SDIO_STATUS 0x36
44#define CTL_SDIO_IRQ_MASK 0x38
45#define CTL_DMA_ENABLE 0xd8
46#define CTL_RESET_SD 0xe0
47#define CTL_VERSION 0xe2
48#define CTL_SDIO_REGS 0x100
49#define CTL_CLK_AND_WAIT_CTL 0x138
50#define CTL_RESET_SDIO 0x1e0
51
52/* Definitions for values the CTRL_STATUS register can take. */
2cafc5cb
WS		 53#define TMIO_STAT_CMDRESPEND BIT(0)
54#define TMIO_STAT_DATAEND BIT(2)
55#define TMIO_STAT_CARD_REMOVE BIT(3)
56#define TMIO_STAT_CARD_INSERT BIT(4)
57#define TMIO_STAT_SIGSTATE BIT(5)
58#define TMIO_STAT_WRPROTECT BIT(7)
59#define TMIO_STAT_CARD_REMOVE_A BIT(8)
60#define TMIO_STAT_CARD_INSERT_A BIT(9)
61#define TMIO_STAT_SIGSTATE_A BIT(10)
62
63/* These belong technically to CTRL_STATUS2, but the driver merges them */
64#define TMIO_STAT_CMD_IDX_ERR BIT(16)
65#define TMIO_STAT_CRCFAIL BIT(17)
66#define TMIO_STAT_STOPBIT_ERR BIT(18)
67#define TMIO_STAT_DATATIMEOUT BIT(19)
68#define TMIO_STAT_RXOVERFLOW BIT(20)
69#define TMIO_STAT_TXUNDERRUN BIT(21)
70#define TMIO_STAT_CMDTIMEOUT BIT(22)
83e95351 71#define TMIO_STAT_DAT0 BIT(23) /* only known on R-Car so far */
2cafc5cb
WS		 72#define TMIO_STAT_RXRDY BIT(24)
73#define TMIO_STAT_TXRQ BIT(25)
a21553c9
WS		 74#define TMIO_STAT_ILL_FUNC BIT(29) /* only when !TMIO_MMC_HAS_IDLE_WAIT */
75#define TMIO_STAT_SCLKDIVEN BIT(29) /* only when TMIO_MMC_HAS_IDLE_WAIT */
2cafc5cb
WS		 76#define TMIO_STAT_CMD_BUSY BIT(30)
77#define TMIO_STAT_ILL_ACCESS BIT(31)
ac86045e 78
ac86045e
WS		 79#define CLK_CTL_DIV_MASK 0xff
80#define CLK_CTL_SCLKEN BIT(8)
81
0bc0b6e8
WS		 82#define CARD_OPT_WIDTH8 BIT(13)
83#define CARD_OPT_WIDTH BIT(15)
84
ac86045e
WS		 85#define TMIO_BBS 512 /* Boot block size */
86
b6147490 87/* Definitions for values the CTRL_SDIO_STATUS register can take. */
cba179ae 88#define TMIO_SDIO_STAT_IOIRQ 0x0001
b6147490 89#define TMIO_SDIO_STAT_EXPUB52 0x4000
cba179ae
SH		 90#define TMIO_SDIO_STAT_EXWT 0x8000
91#define TMIO_SDIO_MASK_ALL 0xc007
b6147490
GL		 92
93/* Define some IRQ masks */
94/* This is the mask used at reset by the chip */
95#define TMIO_MASK_ALL 0x837f031d
96#define TMIO_MASK_READOP (TMIO_STAT_RXRDY | TMIO_STAT_DATAEND)
97#define TMIO_MASK_WRITEOP (TMIO_STAT_TXRQ | TMIO_STAT_DATAEND)
98#define TMIO_MASK_CMD (TMIO_STAT_CMDRESPEND | TMIO_STAT_CMDTIMEOUT | \
99 TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT)
100#define TMIO_MASK_IRQ (TMIO_MASK_READOP | TMIO_MASK_WRITEOP | TMIO_MASK_CMD)
101
102struct tmio_mmc_data;
5add2aca 103struct tmio_mmc_host;
b6147490 104
7ecc09ba 105struct tmio_mmc_dma {
361936ef 106 enum dma_slave_buswidth dma_buswidth;
7ecc09ba 107 bool (*filter)(struct dma_chan *chan, void *arg);
5add2aca 108 void (*enable)(struct tmio_mmc_host *host, bool enable);
7ecc09ba
KM		 109};
110
b6147490
GL		 111struct tmio_mmc_host {
112 void __iomem *ctl;
b6147490
GL		 113 struct mmc_command *cmd;
114 struct mmc_request *mrq;
115 struct mmc_data *data;
116 struct mmc_host *mmc;
b6147490
GL		 117
118 /* Callbacks for clock / power control */
119 void (*set_pwr)(struct platform_device *host, int state);
120 void (*set_clk_div)(struct platform_device *host, int state);
121
122 /* pio related stuff */
123 struct scatterlist *sg_ptr;
124 struct scatterlist *sg_orig;
125 unsigned int sg_len;
126 unsigned int sg_off;
7445bf9e 127 unsigned long bus_shift;
b6147490
GL		 128
129 struct platform_device *pdev;
130 struct tmio_mmc_data *pdata;
7ecc09ba 131 struct tmio_mmc_dma *dma;
b6147490
GL		 132
133 /* DMA support */
134 bool force_pio;
135 struct dma_chan *chan_rx;
136 struct dma_chan *chan_tx;
137 struct tasklet_struct dma_complete;
138 struct tasklet_struct dma_issue;
139 struct scatterlist bounce_sg;
140 u8 *bounce_buf;
141
142 /* Track lost interrupts */
143 struct delayed_work delayed_reset_work;
b9269fdd
GL		 144 struct work_struct done;
145
ae12d250 146 /* Cache */
54680fe7
SH		 147 u32 sdcard_irq_mask;
148 u32 sdio_irq_mask;
ae12d250 149 unsigned int clk_cache;
54680fe7 150
b9269fdd 151 spinlock_t lock; /* protect host private data */
b6147490 152 unsigned long last_req_ts;
b9269fdd 153 struct mutex ios_lock; /* protect set_ios() context */
2b1ac5c2 154 bool native_hotplug;
7501c431 155 bool sdio_irq_enabled;
dfe9a229
KM		 156
157 int (*write16_hook)(struct tmio_mmc_host *host, int addr);
0ea28210 158 int (*clk_enable)(struct tmio_mmc_host *host);
2fb55956
BH		 159 unsigned int (*clk_update)(struct tmio_mmc_host *host,
160 unsigned int new_clock);
0ea28210 161 void (*clk_disable)(struct tmio_mmc_host *host);
85c02ddd
KM		 162 int (*multi_io_quirk)(struct mmc_card *card,
163 unsigned int direction, int blk_size);
6a4679f3 164 int (*card_busy)(struct mmc_host *mmc);
452e5eef
WS		 165 int (*start_signal_voltage_switch)(struct mmc_host *mmc,
166 struct mmc_ios *ios);
b6147490
GL		 167};
168
94b110af
KM		 169struct tmio_mmc_host *tmio_mmc_host_alloc(struct platform_device *pdev);
170void tmio_mmc_host_free(struct tmio_mmc_host *host);
171int tmio_mmc_host_probe(struct tmio_mmc_host *host,
b6147490
GL		 172 struct tmio_mmc_data *pdata);
173void tmio_mmc_host_remove(struct tmio_mmc_host *host);
174void tmio_mmc_do_data_irq(struct tmio_mmc_host *host);
175
176void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
177void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
8e7bfdb3 178irqreturn_t tmio_mmc_irq(int irq, void *devid);
b6147490
GL		 179
180static inline char *tmio_mmc_kmap_atomic(struct scatterlist *sg,
181 unsigned long *flags)
182{
183 local_irq_save(*flags);
482fce99 184 return kmap_atomic(sg_page(sg)) + sg->offset;
b6147490
GL		 185}
186
187static inline void tmio_mmc_kunmap_atomic(struct scatterlist *sg,
188 unsigned long *flags, void *virt)
189{
482fce99 190 kunmap_atomic(virt - sg->offset);
b6147490
GL		 191 local_irq_restore(*flags);
192}
193
42051e8a 194#if defined(CONFIG_MMC_SDHI) || defined(CONFIG_MMC_SDHI_MODULE)
b6147490 195void tmio_mmc_start_dma(struct tmio_mmc_host *host, struct mmc_data *data);
162f43e3 196void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable);
b6147490
GL		 197void tmio_mmc_request_dma(struct tmio_mmc_host *host, struct tmio_mmc_data *pdata);
198void tmio_mmc_release_dma(struct tmio_mmc_host *host);
e3de2be7 199void tmio_mmc_abort_dma(struct tmio_mmc_host *host);
b6147490
GL		 200#else
201static inline void tmio_mmc_start_dma(struct tmio_mmc_host *host,
202 struct mmc_data *data)
203{
204}
205
162f43e3
GL		 206static inline void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable)
207{
208}
209
b6147490
GL		 210static inline void tmio_mmc_request_dma(struct tmio_mmc_host *host,
211 struct tmio_mmc_data *pdata)
212{
213 host->chan_tx = NULL;
214 host->chan_rx = NULL;
215}
216
217static inline void tmio_mmc_release_dma(struct tmio_mmc_host *host)
218{
219}
e3de2be7
GL		 220
221static inline void tmio_mmc_abort_dma(struct tmio_mmc_host *host)
222{
223}
b6147490
GL		 224#endif
225
9ade7dbf 226#ifdef CONFIG_PM
7311bef0
GL		 227int tmio_mmc_host_runtime_suspend(struct device *dev);
228int tmio_mmc_host_runtime_resume(struct device *dev);
710dec95 229#endif
7311bef0 230
a11862d3
SH		 231static inline u16 sd_ctrl_read16(struct tmio_mmc_host *host, int addr)
232{
7445bf9e 233 return readw(host->ctl + (addr << host->bus_shift));
a11862d3
SH		 234}
235
236static inline void sd_ctrl_read16_rep(struct tmio_mmc_host *host, int addr,
237 u16 *buf, int count)
238{
7445bf9e 239 readsw(host->ctl + (addr << host->bus_shift), buf, count);
a11862d3
SH		 240}
241
2c54506b 242static inline u32 sd_ctrl_read16_and_16_as_32(struct tmio_mmc_host *host, int addr)
a11862d3 243{
7445bf9e
KM		 244 return readw(host->ctl + (addr << host->bus_shift)) |
245 readw(host->ctl + ((addr + 2) << host->bus_shift)) << 16;
a11862d3
SH		 246}
247
248static inline void sd_ctrl_write16(struct tmio_mmc_host *host, int addr, u16 val)
249{
973ed3af
SH		 250 /* If there is a hook and it returns non-zero then there
251 * is an error and the write should be skipped
252 */
dfe9a229 253 if (host->write16_hook && host->write16_hook(host, addr))
973ed3af 254 return;
7445bf9e 255 writew(val, host->ctl + (addr << host->bus_shift));
a11862d3
SH		 256}
257
258static inline void sd_ctrl_write16_rep(struct tmio_mmc_host *host, int addr,
259 u16 *buf, int count)
260{
7445bf9e 261 writesw(host->ctl + (addr << host->bus_shift), buf, count);
a11862d3
SH		 262}
263
2c54506b 264static inline void sd_ctrl_write32_as_16_and_16(struct tmio_mmc_host *host, int addr, u32 val)
a11862d3 265{
7c42dbf3 266 writew(val & 0xffff, host->ctl + (addr << host->bus_shift));
7445bf9e 267 writew(val >> 16, host->ctl + ((addr + 2) << host->bus_shift));
a11862d3
SH		 268}
269
b6147490 270#endif
Linux 6.x block layer and io_uring tree(s)