mmc: sdhci: Define ADMA constants
[linux-2.6-block.git] / drivers / mmc / host / sdhci.h
CommitLineData
d129bceb 1/*
70f10482 2 * linux/drivers/mmc/host/sdhci.h - Secure Digital Host Controller Interface driver
d129bceb 3 *
1978fda8
GC
4 * Header file for Host Controller registers and I/O accessors.
5 *
b69c9058 6 * Copyright (C) 2005-2008 Pierre Ossman, All Rights Reserved.
d129bceb
PO
7 *
8 * This program is free software; you can redistribute it and/or modify
643f720c
PO
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or (at
11 * your option) any later version.
d129bceb 12 */
1978fda8
GC
13#ifndef __SDHCI_HW_H
14#define __SDHCI_HW_H
d129bceb 15
0c7ad106 16#include <linux/scatterlist.h>
4e4141a5
AV
17#include <linux/compiler.h>
18#include <linux/types.h>
19#include <linux/io.h>
0c7ad106 20
1978fda8
GC
21#include <linux/mmc/sdhci.h>
22
d129bceb
PO
23/*
24 * Controller registers
25 */
26
27#define SDHCI_DMA_ADDRESS 0x00
8edf6371 28#define SDHCI_ARGUMENT2 SDHCI_DMA_ADDRESS
d129bceb
PO
29
30#define SDHCI_BLOCK_SIZE 0x04
bab76961 31#define SDHCI_MAKE_BLKSZ(dma, blksz) (((dma & 0x7) << 12) | (blksz & 0xFFF))
d129bceb
PO
32
33#define SDHCI_BLOCK_COUNT 0x06
34
35#define SDHCI_ARGUMENT 0x08
36
37#define SDHCI_TRANSFER_MODE 0x0C
38#define SDHCI_TRNS_DMA 0x01
39#define SDHCI_TRNS_BLK_CNT_EN 0x02
e89d456f 40#define SDHCI_TRNS_AUTO_CMD12 0x04
8edf6371 41#define SDHCI_TRNS_AUTO_CMD23 0x08
d129bceb
PO
42#define SDHCI_TRNS_READ 0x10
43#define SDHCI_TRNS_MULTI 0x20
44
45#define SDHCI_COMMAND 0x0E
46#define SDHCI_CMD_RESP_MASK 0x03
47#define SDHCI_CMD_CRC 0x08
48#define SDHCI_CMD_INDEX 0x10
49#define SDHCI_CMD_DATA 0x20
574e3f56 50#define SDHCI_CMD_ABORTCMD 0xC0
d129bceb
PO
51
52#define SDHCI_CMD_RESP_NONE 0x00
53#define SDHCI_CMD_RESP_LONG 0x01
54#define SDHCI_CMD_RESP_SHORT 0x02
55#define SDHCI_CMD_RESP_SHORT_BUSY 0x03
56
57#define SDHCI_MAKE_CMD(c, f) (((c & 0xff) << 8) | (f & 0xff))
22113efd 58#define SDHCI_GET_CMD(c) ((c>>8) & 0x3f)
d129bceb
PO
59
60#define SDHCI_RESPONSE 0x10
61
62#define SDHCI_BUFFER 0x20
63
64#define SDHCI_PRESENT_STATE 0x24
65#define SDHCI_CMD_INHIBIT 0x00000001
66#define SDHCI_DATA_INHIBIT 0x00000002
67#define SDHCI_DOING_WRITE 0x00000100
68#define SDHCI_DOING_READ 0x00000200
69#define SDHCI_SPACE_AVAILABLE 0x00000400
70#define SDHCI_DATA_AVAILABLE 0x00000800
71#define SDHCI_CARD_PRESENT 0x00010000
72#define SDHCI_WRITE_PROTECT 0x00080000
f2119df6
AN
73#define SDHCI_DATA_LVL_MASK 0x00F00000
74#define SDHCI_DATA_LVL_SHIFT 20
7756a96d 75#define SDHCI_DATA_0_LVL_MASK 0x00100000
d129bceb 76
d6d50a15 77#define SDHCI_HOST_CONTROL 0x28
d129bceb
PO
78#define SDHCI_CTRL_LED 0x01
79#define SDHCI_CTRL_4BITBUS 0x02
077df884 80#define SDHCI_CTRL_HISPD 0x04
2134a922
PO
81#define SDHCI_CTRL_DMA_MASK 0x18
82#define SDHCI_CTRL_SDMA 0x00
83#define SDHCI_CTRL_ADMA1 0x08
84#define SDHCI_CTRL_ADMA32 0x10
85#define SDHCI_CTRL_ADMA64 0x18
15ec4461 86#define SDHCI_CTRL_8BITBUS 0x20
d129bceb
PO
87
88#define SDHCI_POWER_CONTROL 0x29
146ad66e
PO
89#define SDHCI_POWER_ON 0x01
90#define SDHCI_POWER_180 0x0A
91#define SDHCI_POWER_300 0x0C
92#define SDHCI_POWER_330 0x0E
d129bceb
PO
93
94#define SDHCI_BLOCK_GAP_CONTROL 0x2A
95
2df3b71b 96#define SDHCI_WAKE_UP_CONTROL 0x2B
5f619704
DD
97#define SDHCI_WAKE_ON_INT 0x01
98#define SDHCI_WAKE_ON_INSERT 0x02
99#define SDHCI_WAKE_ON_REMOVE 0x04
d129bceb
PO
100
101#define SDHCI_CLOCK_CONTROL 0x2C
102#define SDHCI_DIVIDER_SHIFT 8
85105c53
ZG
103#define SDHCI_DIVIDER_HI_SHIFT 6
104#define SDHCI_DIV_MASK 0xFF
105#define SDHCI_DIV_MASK_LEN 8
106#define SDHCI_DIV_HI_MASK 0x300
c3ed3877 107#define SDHCI_PROG_CLOCK_MODE 0x0020
d129bceb
PO
108#define SDHCI_CLOCK_CARD_EN 0x0004
109#define SDHCI_CLOCK_INT_STABLE 0x0002
110#define SDHCI_CLOCK_INT_EN 0x0001
111
112#define SDHCI_TIMEOUT_CONTROL 0x2E
113
114#define SDHCI_SOFTWARE_RESET 0x2F
115#define SDHCI_RESET_ALL 0x01
116#define SDHCI_RESET_CMD 0x02
117#define SDHCI_RESET_DATA 0x04
118
119#define SDHCI_INT_STATUS 0x30
120#define SDHCI_INT_ENABLE 0x34
121#define SDHCI_SIGNAL_ENABLE 0x38
122#define SDHCI_INT_RESPONSE 0x00000001
123#define SDHCI_INT_DATA_END 0x00000002
a4071fbb 124#define SDHCI_INT_BLK_GAP 0x00000004
d129bceb 125#define SDHCI_INT_DMA_END 0x00000008
a406f5a3
PO
126#define SDHCI_INT_SPACE_AVAIL 0x00000010
127#define SDHCI_INT_DATA_AVAIL 0x00000020
d129bceb
PO
128#define SDHCI_INT_CARD_INSERT 0x00000040
129#define SDHCI_INT_CARD_REMOVE 0x00000080
130#define SDHCI_INT_CARD_INT 0x00000100
964f9ce2 131#define SDHCI_INT_ERROR 0x00008000
d129bceb
PO
132#define SDHCI_INT_TIMEOUT 0x00010000
133#define SDHCI_INT_CRC 0x00020000
134#define SDHCI_INT_END_BIT 0x00040000
135#define SDHCI_INT_INDEX 0x00080000
136#define SDHCI_INT_DATA_TIMEOUT 0x00100000
137#define SDHCI_INT_DATA_CRC 0x00200000
138#define SDHCI_INT_DATA_END_BIT 0x00400000
139#define SDHCI_INT_BUS_POWER 0x00800000
140#define SDHCI_INT_ACMD12ERR 0x01000000
2134a922 141#define SDHCI_INT_ADMA_ERROR 0x02000000
d129bceb
PO
142
143#define SDHCI_INT_NORMAL_MASK 0x00007FFF
144#define SDHCI_INT_ERROR_MASK 0xFFFF8000
145
146#define SDHCI_INT_CMD_MASK (SDHCI_INT_RESPONSE | SDHCI_INT_TIMEOUT | \
147 SDHCI_INT_CRC | SDHCI_INT_END_BIT | SDHCI_INT_INDEX)
148#define SDHCI_INT_DATA_MASK (SDHCI_INT_DATA_END | SDHCI_INT_DMA_END | \
a406f5a3 149 SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL | \
d129bceb 150 SDHCI_INT_DATA_TIMEOUT | SDHCI_INT_DATA_CRC | \
a4071fbb
HZ
151 SDHCI_INT_DATA_END_BIT | SDHCI_INT_ADMA_ERROR | \
152 SDHCI_INT_BLK_GAP)
7260cf5e 153#define SDHCI_INT_ALL_MASK ((unsigned int)-1)
d129bceb
PO
154
155#define SDHCI_ACMD12_ERR 0x3C
156
f2119df6 157#define SDHCI_HOST_CONTROL2 0x3E
49c468fc
AN
158#define SDHCI_CTRL_UHS_MASK 0x0007
159#define SDHCI_CTRL_UHS_SDR12 0x0000
160#define SDHCI_CTRL_UHS_SDR25 0x0001
161#define SDHCI_CTRL_UHS_SDR50 0x0002
162#define SDHCI_CTRL_UHS_SDR104 0x0003
163#define SDHCI_CTRL_UHS_DDR50 0x0004
069c9f14 164#define SDHCI_CTRL_HS_SDR200 0x0005 /* reserved value in SDIO spec */
f2119df6 165#define SDHCI_CTRL_VDD_180 0x0008
d6d50a15
AN
166#define SDHCI_CTRL_DRV_TYPE_MASK 0x0030
167#define SDHCI_CTRL_DRV_TYPE_B 0x0000
168#define SDHCI_CTRL_DRV_TYPE_A 0x0010
169#define SDHCI_CTRL_DRV_TYPE_C 0x0020
170#define SDHCI_CTRL_DRV_TYPE_D 0x0030
b513ea25
AN
171#define SDHCI_CTRL_EXEC_TUNING 0x0040
172#define SDHCI_CTRL_TUNED_CLK 0x0080
d6d50a15 173#define SDHCI_CTRL_PRESET_VAL_ENABLE 0x8000
d129bceb
PO
174
175#define SDHCI_CAPABILITIES 0x40
1c8cde92
PO
176#define SDHCI_TIMEOUT_CLK_MASK 0x0000003F
177#define SDHCI_TIMEOUT_CLK_SHIFT 0
178#define SDHCI_TIMEOUT_CLK_UNIT 0x00000080
d129bceb 179#define SDHCI_CLOCK_BASE_MASK 0x00003F00
c4687d5f 180#define SDHCI_CLOCK_V3_BASE_MASK 0x0000FF00
d129bceb 181#define SDHCI_CLOCK_BASE_SHIFT 8
1d676e02
PO
182#define SDHCI_MAX_BLOCK_MASK 0x00030000
183#define SDHCI_MAX_BLOCK_SHIFT 16
15ec4461 184#define SDHCI_CAN_DO_8BIT 0x00040000
2134a922
PO
185#define SDHCI_CAN_DO_ADMA2 0x00080000
186#define SDHCI_CAN_DO_ADMA1 0x00100000
077df884 187#define SDHCI_CAN_DO_HISPD 0x00200000
a13abc7b 188#define SDHCI_CAN_DO_SDMA 0x00400000
146ad66e
PO
189#define SDHCI_CAN_VDD_330 0x01000000
190#define SDHCI_CAN_VDD_300 0x02000000
191#define SDHCI_CAN_VDD_180 0x04000000
2134a922 192#define SDHCI_CAN_64BIT 0x10000000
d129bceb 193
f2119df6
AN
194#define SDHCI_SUPPORT_SDR50 0x00000001
195#define SDHCI_SUPPORT_SDR104 0x00000002
196#define SDHCI_SUPPORT_DDR50 0x00000004
d6d50a15
AN
197#define SDHCI_DRIVER_TYPE_A 0x00000010
198#define SDHCI_DRIVER_TYPE_C 0x00000020
199#define SDHCI_DRIVER_TYPE_D 0x00000040
cf2b5eea
AN
200#define SDHCI_RETUNING_TIMER_COUNT_MASK 0x00000F00
201#define SDHCI_RETUNING_TIMER_COUNT_SHIFT 8
202#define SDHCI_USE_SDR50_TUNING 0x00002000
203#define SDHCI_RETUNING_MODE_MASK 0x0000C000
204#define SDHCI_RETUNING_MODE_SHIFT 14
c3ed3877
AN
205#define SDHCI_CLOCK_MUL_MASK 0x00FF0000
206#define SDHCI_CLOCK_MUL_SHIFT 16
f2119df6 207
e8120ad1 208#define SDHCI_CAPABILITIES_1 0x44
d129bceb 209
f2119df6 210#define SDHCI_MAX_CURRENT 0x48
bad37e1a 211#define SDHCI_MAX_CURRENT_LIMIT 0xFF
f2119df6
AN
212#define SDHCI_MAX_CURRENT_330_MASK 0x0000FF
213#define SDHCI_MAX_CURRENT_330_SHIFT 0
214#define SDHCI_MAX_CURRENT_300_MASK 0x00FF00
215#define SDHCI_MAX_CURRENT_300_SHIFT 8
216#define SDHCI_MAX_CURRENT_180_MASK 0xFF0000
217#define SDHCI_MAX_CURRENT_180_SHIFT 16
218#define SDHCI_MAX_CURRENT_MULTIPLIER 4
d129bceb
PO
219
220/* 4C-4F reserved for more max current */
221
2134a922
PO
222#define SDHCI_SET_ACMD12_ERROR 0x50
223#define SDHCI_SET_INT_ERROR 0x52
224
225#define SDHCI_ADMA_ERROR 0x54
226
227/* 55-57 reserved */
228
229#define SDHCI_ADMA_ADDRESS 0x58
230
231/* 60-FB reserved */
d129bceb 232
52983382
KL
233#define SDHCI_PRESET_FOR_SDR12 0x66
234#define SDHCI_PRESET_FOR_SDR25 0x68
235#define SDHCI_PRESET_FOR_SDR50 0x6A
236#define SDHCI_PRESET_FOR_SDR104 0x6C
237#define SDHCI_PRESET_FOR_DDR50 0x6E
238#define SDHCI_PRESET_DRV_MASK 0xC000
239#define SDHCI_PRESET_DRV_SHIFT 14
240#define SDHCI_PRESET_CLKGEN_SEL_MASK 0x400
241#define SDHCI_PRESET_CLKGEN_SEL_SHIFT 10
242#define SDHCI_PRESET_SDCLK_FREQ_MASK 0x3FF
243#define SDHCI_PRESET_SDCLK_FREQ_SHIFT 0
244
d129bceb
PO
245#define SDHCI_SLOT_INT_STATUS 0xFC
246
247#define SDHCI_HOST_VERSION 0xFE
4a965505
PO
248#define SDHCI_VENDOR_VER_MASK 0xFF00
249#define SDHCI_VENDOR_VER_SHIFT 8
250#define SDHCI_SPEC_VER_MASK 0x00FF
251#define SDHCI_SPEC_VER_SHIFT 0
2134a922
PO
252#define SDHCI_SPEC_100 0
253#define SDHCI_SPEC_200 1
85105c53 254#define SDHCI_SPEC_300 2
d129bceb 255
0397526d
ZG
256/*
257 * End of controller registers.
258 */
259
260#define SDHCI_MAX_DIV_SPEC_200 256
261#define SDHCI_MAX_DIV_SPEC_300 2046
262
f6a03cbf
MV
263/*
264 * Host SDMA buffer boundary. Valid values from 4K to 512K in powers of 2.
265 */
266#define SDHCI_DEFAULT_BOUNDARY_SIZE (512 * 1024)
267#define SDHCI_DEFAULT_BOUNDARY_ARG (ilog2(SDHCI_DEFAULT_BOUNDARY_SIZE) - 12)
268
739d46dc
AH
269/* ADMA2 32-bit DMA descriptor size */
270#define SDHCI_ADMA2_32_DESC_SZ 8
271
272/* ADMA2 32-bit DMA alignment */
273#define SDHCI_ADMA2_32_ALIGN 4
274
275#define ADMA2_TRAN_VALID 0x21
276#define ADMA2_NOP_END_VALID 0x3
277#define ADMA2_END 0x2
278
4fb213f8
AH
279/*
280 * Maximum segments assuming a 512KiB maximum requisition size and a minimum
281 * 4KiB page size.
282 */
283#define SDHCI_MAX_SEGS 128
284
b8c86fc5 285struct sdhci_ops {
4e4141a5 286#ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS
dc297c92
MF
287 u32 (*read_l)(struct sdhci_host *host, int reg);
288 u16 (*read_w)(struct sdhci_host *host, int reg);
289 u8 (*read_b)(struct sdhci_host *host, int reg);
290 void (*write_l)(struct sdhci_host *host, u32 val, int reg);
291 void (*write_w)(struct sdhci_host *host, u16 val, int reg);
292 void (*write_b)(struct sdhci_host *host, u8 val, int reg);
4e4141a5
AV
293#endif
294
8114634c
AV
295 void (*set_clock)(struct sdhci_host *host, unsigned int clock);
296
b8c86fc5 297 int (*enable_dma)(struct sdhci_host *host);
4240ff0a 298 unsigned int (*get_max_clock)(struct sdhci_host *host);
a9e58f25 299 unsigned int (*get_min_clock)(struct sdhci_host *host);
4240ff0a 300 unsigned int (*get_timeout_clock)(struct sdhci_host *host);
a6ff5aeb 301 unsigned int (*get_max_timeout_count)(struct sdhci_host *host);
b45e668a
AD
302 void (*set_timeout)(struct sdhci_host *host,
303 struct mmc_command *cmd);
2317f56c 304 void (*set_bus_width)(struct sdhci_host *host, int width);
643a81ff
PR
305 void (*platform_send_init_74_clocks)(struct sdhci_host *host,
306 u8 power_mode);
2dfb579c 307 unsigned int (*get_ro)(struct sdhci_host *host);
03231f9b 308 void (*reset)(struct sdhci_host *host, u8 mask);
45251812 309 int (*platform_execute_tuning)(struct sdhci_host *host, u32 opcode);
13e64501 310 void (*set_uhs_signaling)(struct sdhci_host *host, unsigned int uhs);
20758b66 311 void (*hw_reset)(struct sdhci_host *host);
a4071fbb 312 void (*adma_workaround)(struct sdhci_host *host, u32 intmask);
63ef5d8c 313 void (*platform_init)(struct sdhci_host *host);
722e1280 314 void (*card_event)(struct sdhci_host *host);
d129bceb 315};
b8c86fc5 316
4e4141a5
AV
317#ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS
318
319static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg)
320{
dc297c92
MF
321 if (unlikely(host->ops->write_l))
322 host->ops->write_l(host, val, reg);
4e4141a5
AV
323 else
324 writel(val, host->ioaddr + reg);
325}
326
327static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg)
328{
dc297c92
MF
329 if (unlikely(host->ops->write_w))
330 host->ops->write_w(host, val, reg);
4e4141a5
AV
331 else
332 writew(val, host->ioaddr + reg);
333}
334
335static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg)
336{
dc297c92
MF
337 if (unlikely(host->ops->write_b))
338 host->ops->write_b(host, val, reg);
4e4141a5
AV
339 else
340 writeb(val, host->ioaddr + reg);
341}
342
343static inline u32 sdhci_readl(struct sdhci_host *host, int reg)
344{
dc297c92
MF
345 if (unlikely(host->ops->read_l))
346 return host->ops->read_l(host, reg);
4e4141a5
AV
347 else
348 return readl(host->ioaddr + reg);
349}
350
351static inline u16 sdhci_readw(struct sdhci_host *host, int reg)
352{
dc297c92
MF
353 if (unlikely(host->ops->read_w))
354 return host->ops->read_w(host, reg);
4e4141a5
AV
355 else
356 return readw(host->ioaddr + reg);
357}
358
359static inline u8 sdhci_readb(struct sdhci_host *host, int reg)
360{
dc297c92
MF
361 if (unlikely(host->ops->read_b))
362 return host->ops->read_b(host, reg);
4e4141a5
AV
363 else
364 return readb(host->ioaddr + reg);
365}
366
367#else
368
369static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg)
370{
371 writel(val, host->ioaddr + reg);
372}
373
374static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg)
375{
376 writew(val, host->ioaddr + reg);
377}
378
379static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg)
380{
381 writeb(val, host->ioaddr + reg);
382}
383
384static inline u32 sdhci_readl(struct sdhci_host *host, int reg)
385{
386 return readl(host->ioaddr + reg);
387}
388
389static inline u16 sdhci_readw(struct sdhci_host *host, int reg)
390{
391 return readw(host->ioaddr + reg);
392}
393
394static inline u8 sdhci_readb(struct sdhci_host *host, int reg)
395{
396 return readb(host->ioaddr + reg);
397}
398
399#endif /* CONFIG_MMC_SDHCI_IO_ACCESSORS */
b8c86fc5
PO
400
401extern struct sdhci_host *sdhci_alloc_host(struct device *dev,
402 size_t priv_size);
403extern void sdhci_free_host(struct sdhci_host *host);
404
405static inline void *sdhci_priv(struct sdhci_host *host)
406{
407 return (void *)host->private;
408}
409
17866e14 410extern void sdhci_card_detect(struct sdhci_host *host);
b8c86fc5 411extern int sdhci_add_host(struct sdhci_host *host);
1e72859e 412extern void sdhci_remove_host(struct sdhci_host *host, int dead);
c0e55129
DA
413extern void sdhci_send_command(struct sdhci_host *host,
414 struct mmc_command *cmd);
b8c86fc5 415
be138554
RK
416static inline bool sdhci_sdio_irq_enabled(struct sdhci_host *host)
417{
418 return !!(host->flags & SDHCI_SDIO_IRQ_ENABLED);
419}
420
1771059c 421void sdhci_set_clock(struct sdhci_host *host, unsigned int clock);
2317f56c 422void sdhci_set_bus_width(struct sdhci_host *host, int width);
03231f9b 423void sdhci_reset(struct sdhci_host *host, u8 mask);
96d7b78c 424void sdhci_set_uhs_signaling(struct sdhci_host *host, unsigned timing);
2317f56c 425
b8c86fc5 426#ifdef CONFIG_PM
29495aa0 427extern int sdhci_suspend_host(struct sdhci_host *host);
b8c86fc5 428extern int sdhci_resume_host(struct sdhci_host *host);
5f619704 429extern void sdhci_enable_irq_wakeups(struct sdhci_host *host);
b8c86fc5 430#endif
c0bba0d2 431
66fd8ad5
AH
432#ifdef CONFIG_PM_RUNTIME
433extern int sdhci_runtime_suspend_host(struct sdhci_host *host);
434extern int sdhci_runtime_resume_host(struct sdhci_host *host);
435#endif
436
1978fda8 437#endif /* __SDHCI_HW_H */