]> bbs.cooldavid.org Git - net-next-2.6.git/blame - drivers/mmc/host/sdhci.h
mmc: fix all hangs related to mmc/sd card insert/removal during suspend/resume
[net-next-2.6.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 *
b69c9058 4 * Copyright (C) 2005-2008 Pierre Ossman, All Rights Reserved.
d129bceb
PO
5 *
6 * This program is free software; you can redistribute it and/or modify
643f720c
PO
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or (at
9 * your option) any later version.
d129bceb 10 */
c0bba0d2
AH
11#ifndef __SDHCI_H
12#define __SDHCI_H
d129bceb 13
0c7ad106 14#include <linux/scatterlist.h>
4e4141a5
AV
15#include <linux/compiler.h>
16#include <linux/types.h>
17#include <linux/io.h>
0c7ad106 18
d129bceb
PO
19/*
20 * Controller registers
21 */
22
23#define SDHCI_DMA_ADDRESS 0x00
24
25#define SDHCI_BLOCK_SIZE 0x04
bab76961 26#define SDHCI_MAKE_BLKSZ(dma, blksz) (((dma & 0x7) << 12) | (blksz & 0xFFF))
d129bceb
PO
27
28#define SDHCI_BLOCK_COUNT 0x06
29
30#define SDHCI_ARGUMENT 0x08
31
32#define SDHCI_TRANSFER_MODE 0x0C
33#define SDHCI_TRNS_DMA 0x01
34#define SDHCI_TRNS_BLK_CNT_EN 0x02
35#define SDHCI_TRNS_ACMD12 0x04
36#define SDHCI_TRNS_READ 0x10
37#define SDHCI_TRNS_MULTI 0x20
38
39#define SDHCI_COMMAND 0x0E
40#define SDHCI_CMD_RESP_MASK 0x03
41#define SDHCI_CMD_CRC 0x08
42#define SDHCI_CMD_INDEX 0x10
43#define SDHCI_CMD_DATA 0x20
44
45#define SDHCI_CMD_RESP_NONE 0x00
46#define SDHCI_CMD_RESP_LONG 0x01
47#define SDHCI_CMD_RESP_SHORT 0x02
48#define SDHCI_CMD_RESP_SHORT_BUSY 0x03
49
50#define SDHCI_MAKE_CMD(c, f) (((c & 0xff) << 8) | (f & 0xff))
51
52#define SDHCI_RESPONSE 0x10
53
54#define SDHCI_BUFFER 0x20
55
56#define SDHCI_PRESENT_STATE 0x24
57#define SDHCI_CMD_INHIBIT 0x00000001
58#define SDHCI_DATA_INHIBIT 0x00000002
59#define SDHCI_DOING_WRITE 0x00000100
60#define SDHCI_DOING_READ 0x00000200
61#define SDHCI_SPACE_AVAILABLE 0x00000400
62#define SDHCI_DATA_AVAILABLE 0x00000800
63#define SDHCI_CARD_PRESENT 0x00010000
64#define SDHCI_WRITE_PROTECT 0x00080000
65
66#define SDHCI_HOST_CONTROL 0x28
67#define SDHCI_CTRL_LED 0x01
68#define SDHCI_CTRL_4BITBUS 0x02
077df884 69#define SDHCI_CTRL_HISPD 0x04
2134a922
PO
70#define SDHCI_CTRL_DMA_MASK 0x18
71#define SDHCI_CTRL_SDMA 0x00
72#define SDHCI_CTRL_ADMA1 0x08
73#define SDHCI_CTRL_ADMA32 0x10
74#define SDHCI_CTRL_ADMA64 0x18
d129bceb
PO
75
76#define SDHCI_POWER_CONTROL 0x29
146ad66e
PO
77#define SDHCI_POWER_ON 0x01
78#define SDHCI_POWER_180 0x0A
79#define SDHCI_POWER_300 0x0C
80#define SDHCI_POWER_330 0x0E
d129bceb
PO
81
82#define SDHCI_BLOCK_GAP_CONTROL 0x2A
83
2df3b71b 84#define SDHCI_WAKE_UP_CONTROL 0x2B
d129bceb
PO
85
86#define SDHCI_CLOCK_CONTROL 0x2C
87#define SDHCI_DIVIDER_SHIFT 8
88#define SDHCI_CLOCK_CARD_EN 0x0004
89#define SDHCI_CLOCK_INT_STABLE 0x0002
90#define SDHCI_CLOCK_INT_EN 0x0001
91
92#define SDHCI_TIMEOUT_CONTROL 0x2E
93
94#define SDHCI_SOFTWARE_RESET 0x2F
95#define SDHCI_RESET_ALL 0x01
96#define SDHCI_RESET_CMD 0x02
97#define SDHCI_RESET_DATA 0x04
98
99#define SDHCI_INT_STATUS 0x30
100#define SDHCI_INT_ENABLE 0x34
101#define SDHCI_SIGNAL_ENABLE 0x38
102#define SDHCI_INT_RESPONSE 0x00000001
103#define SDHCI_INT_DATA_END 0x00000002
104#define SDHCI_INT_DMA_END 0x00000008
a406f5a3
PO
105#define SDHCI_INT_SPACE_AVAIL 0x00000010
106#define SDHCI_INT_DATA_AVAIL 0x00000020
d129bceb
PO
107#define SDHCI_INT_CARD_INSERT 0x00000040
108#define SDHCI_INT_CARD_REMOVE 0x00000080
109#define SDHCI_INT_CARD_INT 0x00000100
964f9ce2 110#define SDHCI_INT_ERROR 0x00008000
d129bceb
PO
111#define SDHCI_INT_TIMEOUT 0x00010000
112#define SDHCI_INT_CRC 0x00020000
113#define SDHCI_INT_END_BIT 0x00040000
114#define SDHCI_INT_INDEX 0x00080000
115#define SDHCI_INT_DATA_TIMEOUT 0x00100000
116#define SDHCI_INT_DATA_CRC 0x00200000
117#define SDHCI_INT_DATA_END_BIT 0x00400000
118#define SDHCI_INT_BUS_POWER 0x00800000
119#define SDHCI_INT_ACMD12ERR 0x01000000
2134a922 120#define SDHCI_INT_ADMA_ERROR 0x02000000
d129bceb
PO
121
122#define SDHCI_INT_NORMAL_MASK 0x00007FFF
123#define SDHCI_INT_ERROR_MASK 0xFFFF8000
124
125#define SDHCI_INT_CMD_MASK (SDHCI_INT_RESPONSE | SDHCI_INT_TIMEOUT | \
126 SDHCI_INT_CRC | SDHCI_INT_END_BIT | SDHCI_INT_INDEX)
127#define SDHCI_INT_DATA_MASK (SDHCI_INT_DATA_END | SDHCI_INT_DMA_END | \
a406f5a3 128 SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL | \
d129bceb 129 SDHCI_INT_DATA_TIMEOUT | SDHCI_INT_DATA_CRC | \
a751a7d6 130 SDHCI_INT_DATA_END_BIT | SDHCI_INT_ADMA_ERROR)
7260cf5e 131#define SDHCI_INT_ALL_MASK ((unsigned int)-1)
d129bceb
PO
132
133#define SDHCI_ACMD12_ERR 0x3C
134
135/* 3E-3F reserved */
136
137#define SDHCI_CAPABILITIES 0x40
1c8cde92
PO
138#define SDHCI_TIMEOUT_CLK_MASK 0x0000003F
139#define SDHCI_TIMEOUT_CLK_SHIFT 0
140#define SDHCI_TIMEOUT_CLK_UNIT 0x00000080
d129bceb
PO
141#define SDHCI_CLOCK_BASE_MASK 0x00003F00
142#define SDHCI_CLOCK_BASE_SHIFT 8
1d676e02
PO
143#define SDHCI_MAX_BLOCK_MASK 0x00030000
144#define SDHCI_MAX_BLOCK_SHIFT 16
2134a922
PO
145#define SDHCI_CAN_DO_ADMA2 0x00080000
146#define SDHCI_CAN_DO_ADMA1 0x00100000
077df884 147#define SDHCI_CAN_DO_HISPD 0x00200000
a13abc7b 148#define SDHCI_CAN_DO_SDMA 0x00400000
146ad66e
PO
149#define SDHCI_CAN_VDD_330 0x01000000
150#define SDHCI_CAN_VDD_300 0x02000000
151#define SDHCI_CAN_VDD_180 0x04000000
2134a922 152#define SDHCI_CAN_64BIT 0x10000000
d129bceb
PO
153
154/* 44-47 reserved for more caps */
155
156#define SDHCI_MAX_CURRENT 0x48
157
158/* 4C-4F reserved for more max current */
159
2134a922
PO
160#define SDHCI_SET_ACMD12_ERROR 0x50
161#define SDHCI_SET_INT_ERROR 0x52
162
163#define SDHCI_ADMA_ERROR 0x54
164
165/* 55-57 reserved */
166
167#define SDHCI_ADMA_ADDRESS 0x58
168
169/* 60-FB reserved */
d129bceb
PO
170
171#define SDHCI_SLOT_INT_STATUS 0xFC
172
173#define SDHCI_HOST_VERSION 0xFE
4a965505
PO
174#define SDHCI_VENDOR_VER_MASK 0xFF00
175#define SDHCI_VENDOR_VER_SHIFT 8
176#define SDHCI_SPEC_VER_MASK 0x00FF
177#define SDHCI_SPEC_VER_SHIFT 0
2134a922
PO
178#define SDHCI_SPEC_100 0
179#define SDHCI_SPEC_200 1
d129bceb 180
b8c86fc5 181struct sdhci_ops;
d129bceb
PO
182
183struct sdhci_host {
b8c86fc5
PO
184 /* Data set by hardware interface driver */
185 const char *hw_name; /* Hardware bus name */
186
187 unsigned int quirks; /* Deviations from spec. */
188
189/* Controller doesn't honor resets unless we touch the clock register */
190#define SDHCI_QUIRK_CLOCK_BEFORE_RESET (1<<0)
191/* Controller has bad caps bits, but really supports DMA */
192#define SDHCI_QUIRK_FORCE_DMA (1<<1)
193/* Controller doesn't like to be reset when there is no card inserted. */
194#define SDHCI_QUIRK_NO_CARD_NO_RESET (1<<2)
195/* Controller doesn't like clearing the power reg before a change */
196#define SDHCI_QUIRK_SINGLE_POWER_WRITE (1<<3)
197/* Controller has flaky internal state so reset it on each ios change */
198#define SDHCI_QUIRK_RESET_CMD_DATA_ON_IOS (1<<4)
199/* Controller has an unusable DMA engine */
200#define SDHCI_QUIRK_BROKEN_DMA (1<<5)
2134a922
PO
201/* Controller has an unusable ADMA engine */
202#define SDHCI_QUIRK_BROKEN_ADMA (1<<6)
b8c86fc5 203/* Controller can only DMA from 32-bit aligned addresses */
2134a922 204#define SDHCI_QUIRK_32BIT_DMA_ADDR (1<<7)
b8c86fc5 205/* Controller can only DMA chunk sizes that are a multiple of 32 bits */
2134a922
PO
206#define SDHCI_QUIRK_32BIT_DMA_SIZE (1<<8)
207/* Controller can only ADMA chunks that are a multiple of 32 bits */
208#define SDHCI_QUIRK_32BIT_ADMA_SIZE (1<<9)
b8c86fc5 209/* Controller needs to be reset after each request to stay stable */
2134a922 210#define SDHCI_QUIRK_RESET_AFTER_REQUEST (1<<10)
b8c86fc5 211/* Controller needs voltage and power writes to happen separately */
2134a922 212#define SDHCI_QUIRK_NO_SIMULT_VDD_AND_POWER (1<<11)
ee53ab5d 213/* Controller provides an incorrect timeout value for transfers */
2134a922 214#define SDHCI_QUIRK_BROKEN_TIMEOUT_VAL (1<<12)
4a3cba32
PO
215/* Controller has an issue with buffer bits for small transfers */
216#define SDHCI_QUIRK_BROKEN_SMALL_PIO (1<<13)
f945405c
BD
217/* Controller does not provide transfer-complete interrupt when not busy */
218#define SDHCI_QUIRK_NO_BUSY_IRQ (1<<14)
68d1fb7e
AV
219/* Controller has unreliable card detection */
220#define SDHCI_QUIRK_BROKEN_CARD_DETECTION (1<<15)
c5075a10
AV
221/* Controller reports inverted write-protect state */
222#define SDHCI_QUIRK_INVERTED_WRITE_PROTECT (1<<16)
8114634c
AV
223/* Controller has nonstandard clock management */
224#define SDHCI_QUIRK_NONSTANDARD_CLOCK (1<<17)
3e3bf207
AV
225/* Controller does not like fast PIO transfers */
226#define SDHCI_QUIRK_PIO_NEEDS_DELAY (1<<18)
063a9dbb
AV
227/* Controller losing signal/interrupt enable states after reset */
228#define SDHCI_QUIRK_RESTORE_IRQS_AFTER_RESET (1<<19)
0633f654
AV
229/* Controller has to be forced to use block size of 2048 bytes */
230#define SDHCI_QUIRK_FORCE_BLK_SZ_2048 (1<<20)
1388eefd
BD
231/* Controller cannot do multi-block transfers */
232#define SDHCI_QUIRK_NO_MULTIBLOCK (1<<21)
5fe23c7f
AV
233/* Controller can only handle 1-bit data transfers */
234#define SDHCI_QUIRK_FORCE_1_BIT_DATA (1<<22)
557b0697
HW
235/* Controller needs 10ms delay between applying power and clock */
236#define SDHCI_QUIRK_DELAY_AFTER_POWER (1<<23)
81b39802
AV
237/* Controller uses SDCLK instead of TMCLK for data timeouts */
238#define SDHCI_QUIRK_DATA_TIMEOUT_USES_SDCLK (1<<24)
f27f47ef
AV
239/* Controller reports wrong base clock capability */
240#define SDHCI_QUIRK_CAP_CLOCK_BASE_BROKEN (1<<25)
70764a90
TA
241/* Controller cannot support End Attribute in NOP ADMA descriptor */
242#define SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC (1<<26)
b8c86fc5
PO
243
244 int irq; /* Device IRQ */
245 void __iomem * ioaddr; /* Mapped address */
246
247 const struct sdhci_ops *ops; /* Low level hw interface */
248
249 /* Internal data */
d129bceb 250 struct mmc_host *mmc; /* MMC structure */
7659150c 251 u64 dma_mask; /* custom DMA mask */
d129bceb 252
35ff8554 253#if defined(CONFIG_LEDS_CLASS) || defined(CONFIG_LEDS_CLASS_MODULE)
2f730fec 254 struct led_classdev led; /* LED control */
5dbace0c 255 char led_name[32];
2f730fec
PO
256#endif
257
d129bceb
PO
258 spinlock_t lock; /* Mutex */
259
260 int flags; /* Host attributes */
a13abc7b 261#define SDHCI_USE_SDMA (1<<0) /* Host is SDMA capable */
2134a922
PO
262#define SDHCI_USE_ADMA (1<<1) /* Host is ADMA capable */
263#define SDHCI_REQ_USE_DMA (1<<2) /* Use DMA for this req. */
264#define SDHCI_DEVICE_DEAD (1<<3) /* Device unresponsive */
265
266 unsigned int version; /* SDHCI spec. version */
d129bceb
PO
267
268 unsigned int max_clk; /* Max possible freq (MHz) */
1c8cde92 269 unsigned int timeout_clk; /* Timeout freq (KHz) */
d129bceb
PO
270
271 unsigned int clock; /* Current clock (MHz) */
ae628903 272 u8 pwr; /* Current voltage */
d129bceb
PO
273
274 struct mmc_request *mrq; /* Current request */
275 struct mmc_command *cmd; /* Current command */
276 struct mmc_data *data; /* Current data request */
55654be9 277 unsigned int data_early:1; /* Data finished before cmd */
d129bceb 278
7659150c
PO
279 struct sg_mapping_iter sg_miter; /* SG state for PIO */
280 unsigned int blocks; /* remaining PIO blocks */
d129bceb 281
2134a922
PO
282 int sg_count; /* Mapped sg entries */
283
284 u8 *adma_desc; /* ADMA descriptor table */
285 u8 *align_buffer; /* Bounce buffer */
286
287 dma_addr_t adma_addr; /* Mapped ADMA descr. table */
288 dma_addr_t align_addr; /* Mapped bounce buffer */
289
d129bceb
PO
290 struct tasklet_struct card_tasklet; /* Tasklet structures */
291 struct tasklet_struct finish_tasklet;
292
293 struct timer_list timer; /* Timer for timeouts */
d129bceb 294
b8c86fc5
PO
295 unsigned long private[0] ____cacheline_aligned;
296};
d129bceb 297
df673b22 298
b8c86fc5 299struct sdhci_ops {
4e4141a5 300#ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS
dc297c92
MF
301 u32 (*read_l)(struct sdhci_host *host, int reg);
302 u16 (*read_w)(struct sdhci_host *host, int reg);
303 u8 (*read_b)(struct sdhci_host *host, int reg);
304 void (*write_l)(struct sdhci_host *host, u32 val, int reg);
305 void (*write_w)(struct sdhci_host *host, u16 val, int reg);
306 void (*write_b)(struct sdhci_host *host, u8 val, int reg);
4e4141a5
AV
307#endif
308
8114634c
AV
309 void (*set_clock)(struct sdhci_host *host, unsigned int clock);
310
b8c86fc5 311 int (*enable_dma)(struct sdhci_host *host);
4240ff0a 312 unsigned int (*get_max_clock)(struct sdhci_host *host);
a9e58f25 313 unsigned int (*get_min_clock)(struct sdhci_host *host);
4240ff0a 314 unsigned int (*get_timeout_clock)(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
410extern int sdhci_add_host(struct sdhci_host *host);
1e72859e 411extern void sdhci_remove_host(struct sdhci_host *host, int dead);
b8c86fc5
PO
412
413#ifdef CONFIG_PM
414extern int sdhci_suspend_host(struct sdhci_host *host, pm_message_t state);
415extern int sdhci_resume_host(struct sdhci_host *host);
416#endif
c0bba0d2
AH
417
418#endif /* __SDHCI_H */