]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - drivers/mmc/host/tmio_mmc.h
mmc: tmio: give read32/write32 functions more descriptive names
[mirror_ubuntu-hirsute-kernel.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
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
50
51/* Definitions for values the CTRL_STATUS register can take. */
52#define TMIO_STAT_CMDRESPEND 0x00000001
53#define TMIO_STAT_DATAEND 0x00000004
54#define TMIO_STAT_CARD_REMOVE 0x00000008
55#define TMIO_STAT_CARD_INSERT 0x00000010
56#define TMIO_STAT_SIGSTATE 0x00000020
57#define TMIO_STAT_WRPROTECT 0x00000080
58#define TMIO_STAT_CARD_REMOVE_A 0x00000100
59#define TMIO_STAT_CARD_INSERT_A 0x00000200
60#define TMIO_STAT_SIGSTATE_A 0x00000400
61#define TMIO_STAT_CMD_IDX_ERR 0x00010000
62#define TMIO_STAT_CRCFAIL 0x00020000
63#define TMIO_STAT_STOPBIT_ERR 0x00040000
64#define TMIO_STAT_DATATIMEOUT 0x00080000
65#define TMIO_STAT_RXOVERFLOW 0x00100000
66#define TMIO_STAT_TXUNDERRUN 0x00200000
67#define TMIO_STAT_CMDTIMEOUT 0x00400000
68#define TMIO_STAT_RXRDY 0x01000000
69#define TMIO_STAT_TXRQ 0x02000000
70#define TMIO_STAT_ILL_FUNC 0x20000000
71#define TMIO_STAT_CMD_BUSY 0x40000000
72#define TMIO_STAT_ILL_ACCESS 0x80000000
73
74#define TMIO_STATUS2_DAT0 BIT(7)
75
76#define CLK_CTL_DIV_MASK 0xff
77#define CLK_CTL_SCLKEN BIT(8)
78
79#define TMIO_BBS 512 /* Boot block size */
80
b6147490 81/* Definitions for values the CTRL_SDIO_STATUS register can take. */
cba179ae 82#define TMIO_SDIO_STAT_IOIRQ 0x0001
b6147490 83#define TMIO_SDIO_STAT_EXPUB52 0x4000
cba179ae
SH
84#define TMIO_SDIO_STAT_EXWT 0x8000
85#define TMIO_SDIO_MASK_ALL 0xc007
b6147490
GL
86
87/* Define some IRQ masks */
88/* This is the mask used at reset by the chip */
89#define TMIO_MASK_ALL 0x837f031d
90#define TMIO_MASK_READOP (TMIO_STAT_RXRDY | TMIO_STAT_DATAEND)
91#define TMIO_MASK_WRITEOP (TMIO_STAT_TXRQ | TMIO_STAT_DATAEND)
92#define TMIO_MASK_CMD (TMIO_STAT_CMDRESPEND | TMIO_STAT_CMDTIMEOUT | \
93 TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT)
94#define TMIO_MASK_IRQ (TMIO_MASK_READOP | TMIO_MASK_WRITEOP | TMIO_MASK_CMD)
95
96struct tmio_mmc_data;
5add2aca 97struct tmio_mmc_host;
b6147490 98
7ecc09ba 99struct tmio_mmc_dma {
361936ef 100 enum dma_slave_buswidth dma_buswidth;
7ecc09ba 101 bool (*filter)(struct dma_chan *chan, void *arg);
5add2aca 102 void (*enable)(struct tmio_mmc_host *host, bool enable);
7ecc09ba
KM
103};
104
b6147490
GL
105struct tmio_mmc_host {
106 void __iomem *ctl;
b6147490
GL
107 struct mmc_command *cmd;
108 struct mmc_request *mrq;
109 struct mmc_data *data;
110 struct mmc_host *mmc;
b6147490
GL
111
112 /* Callbacks for clock / power control */
113 void (*set_pwr)(struct platform_device *host, int state);
114 void (*set_clk_div)(struct platform_device *host, int state);
115
116 /* pio related stuff */
117 struct scatterlist *sg_ptr;
118 struct scatterlist *sg_orig;
119 unsigned int sg_len;
120 unsigned int sg_off;
7445bf9e 121 unsigned long bus_shift;
b6147490
GL
122
123 struct platform_device *pdev;
124 struct tmio_mmc_data *pdata;
7ecc09ba 125 struct tmio_mmc_dma *dma;
b6147490
GL
126
127 /* DMA support */
128 bool force_pio;
129 struct dma_chan *chan_rx;
130 struct dma_chan *chan_tx;
131 struct tasklet_struct dma_complete;
132 struct tasklet_struct dma_issue;
133 struct scatterlist bounce_sg;
134 u8 *bounce_buf;
135
136 /* Track lost interrupts */
137 struct delayed_work delayed_reset_work;
b9269fdd
GL
138 struct work_struct done;
139
ae12d250 140 /* Cache */
54680fe7
SH
141 u32 sdcard_irq_mask;
142 u32 sdio_irq_mask;
ae12d250 143 unsigned int clk_cache;
54680fe7 144
b9269fdd 145 spinlock_t lock; /* protect host private data */
b6147490 146 unsigned long last_req_ts;
b9269fdd 147 struct mutex ios_lock; /* protect set_ios() context */
2b1ac5c2 148 bool native_hotplug;
7501c431 149 bool sdio_irq_enabled;
dfe9a229
KM
150
151 int (*write16_hook)(struct tmio_mmc_host *host, int addr);
0ea28210 152 int (*clk_enable)(struct tmio_mmc_host *host);
2fb55956
BH
153 unsigned int (*clk_update)(struct tmio_mmc_host *host,
154 unsigned int new_clock);
0ea28210 155 void (*clk_disable)(struct tmio_mmc_host *host);
85c02ddd
KM
156 int (*multi_io_quirk)(struct mmc_card *card,
157 unsigned int direction, int blk_size);
452e5eef
WS
158 int (*start_signal_voltage_switch)(struct mmc_host *mmc,
159 struct mmc_ios *ios);
b6147490
GL
160};
161
94b110af
KM
162struct tmio_mmc_host *tmio_mmc_host_alloc(struct platform_device *pdev);
163void tmio_mmc_host_free(struct tmio_mmc_host *host);
164int tmio_mmc_host_probe(struct tmio_mmc_host *host,
b6147490
GL
165 struct tmio_mmc_data *pdata);
166void tmio_mmc_host_remove(struct tmio_mmc_host *host);
167void tmio_mmc_do_data_irq(struct tmio_mmc_host *host);
168
169void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
170void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
8e7bfdb3 171irqreturn_t tmio_mmc_irq(int irq, void *devid);
b6147490
GL
172
173static inline char *tmio_mmc_kmap_atomic(struct scatterlist *sg,
174 unsigned long *flags)
175{
176 local_irq_save(*flags);
482fce99 177 return kmap_atomic(sg_page(sg)) + sg->offset;
b6147490
GL
178}
179
180static inline void tmio_mmc_kunmap_atomic(struct scatterlist *sg,
181 unsigned long *flags, void *virt)
182{
482fce99 183 kunmap_atomic(virt - sg->offset);
b6147490
GL
184 local_irq_restore(*flags);
185}
186
42051e8a 187#if defined(CONFIG_MMC_SDHI) || defined(CONFIG_MMC_SDHI_MODULE)
b6147490 188void tmio_mmc_start_dma(struct tmio_mmc_host *host, struct mmc_data *data);
162f43e3 189void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable);
b6147490
GL
190void tmio_mmc_request_dma(struct tmio_mmc_host *host, struct tmio_mmc_data *pdata);
191void tmio_mmc_release_dma(struct tmio_mmc_host *host);
e3de2be7 192void tmio_mmc_abort_dma(struct tmio_mmc_host *host);
b6147490
GL
193#else
194static inline void tmio_mmc_start_dma(struct tmio_mmc_host *host,
195 struct mmc_data *data)
196{
197}
198
162f43e3
GL
199static inline void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable)
200{
201}
202
b6147490
GL
203static inline void tmio_mmc_request_dma(struct tmio_mmc_host *host,
204 struct tmio_mmc_data *pdata)
205{
206 host->chan_tx = NULL;
207 host->chan_rx = NULL;
208}
209
210static inline void tmio_mmc_release_dma(struct tmio_mmc_host *host)
211{
212}
e3de2be7
GL
213
214static inline void tmio_mmc_abort_dma(struct tmio_mmc_host *host)
215{
216}
b6147490
GL
217#endif
218
9ade7dbf 219#ifdef CONFIG_PM
7311bef0
GL
220int tmio_mmc_host_runtime_suspend(struct device *dev);
221int tmio_mmc_host_runtime_resume(struct device *dev);
710dec95 222#endif
7311bef0 223
a11862d3
SH
224static inline u16 sd_ctrl_read16(struct tmio_mmc_host *host, int addr)
225{
7445bf9e 226 return readw(host->ctl + (addr << host->bus_shift));
a11862d3
SH
227}
228
229static inline void sd_ctrl_read16_rep(struct tmio_mmc_host *host, int addr,
230 u16 *buf, int count)
231{
7445bf9e 232 readsw(host->ctl + (addr << host->bus_shift), buf, count);
a11862d3
SH
233}
234
2c54506b 235static inline u32 sd_ctrl_read16_and_16_as_32(struct tmio_mmc_host *host, int addr)
a11862d3 236{
7445bf9e
KM
237 return readw(host->ctl + (addr << host->bus_shift)) |
238 readw(host->ctl + ((addr + 2) << host->bus_shift)) << 16;
a11862d3
SH
239}
240
241static inline void sd_ctrl_write16(struct tmio_mmc_host *host, int addr, u16 val)
242{
973ed3af
SH
243 /* If there is a hook and it returns non-zero then there
244 * is an error and the write should be skipped
245 */
dfe9a229 246 if (host->write16_hook && host->write16_hook(host, addr))
973ed3af 247 return;
7445bf9e 248 writew(val, host->ctl + (addr << host->bus_shift));
a11862d3
SH
249}
250
251static inline void sd_ctrl_write16_rep(struct tmio_mmc_host *host, int addr,
252 u16 *buf, int count)
253{
7445bf9e 254 writesw(host->ctl + (addr << host->bus_shift), buf, count);
a11862d3
SH
255}
256
2c54506b 257static inline void sd_ctrl_write32_as_16_and_16(struct tmio_mmc_host *host, int addr, u32 val)
a11862d3 258{
7445bf9e
KM
259 writew(val, host->ctl + (addr << host->bus_shift));
260 writew(val >> 16, host->ctl + ((addr + 2) << host->bus_shift));
a11862d3
SH
261}
262
b6147490 263#endif