6e0969e40650709c4e785267e63e8c1656f2a7b0
[muen/linux.git] / drivers / mmc / host / sdhci.h
1 /*
2  *  linux/drivers/mmc/host/sdhci.h - Secure Digital Host Controller Interface driver
3  *
4  * Header file for Host Controller registers and I/O accessors.
5  *
6  *  Copyright (C) 2005-2008 Pierre Ossman, All Rights Reserved.
7  *
8  * This program is free software; you can redistribute it and/or modify
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.
12  */
13 #ifndef __SDHCI_HW_H
14 #define __SDHCI_HW_H
15
16 #include <linux/scatterlist.h>
17 #include <linux/compiler.h>
18 #include <linux/types.h>
19 #include <linux/io.h>
20
21 #include <linux/mmc/sdhci.h>
22
23 /*
24  * Controller registers
25  */
26
27 #define SDHCI_DMA_ADDRESS       0x00
28
29 #define SDHCI_BLOCK_SIZE        0x04
30 #define  SDHCI_MAKE_BLKSZ(dma, blksz) (((dma & 0x7) << 12) | (blksz & 0xFFF))
31
32 #define SDHCI_BLOCK_COUNT       0x06
33
34 #define SDHCI_ARGUMENT          0x08
35
36 #define SDHCI_TRANSFER_MODE     0x0C
37 #define  SDHCI_TRNS_DMA         0x01
38 #define  SDHCI_TRNS_BLK_CNT_EN  0x02
39 #define  SDHCI_TRNS_ACMD12      0x04
40 #define  SDHCI_TRNS_READ        0x10
41 #define  SDHCI_TRNS_MULTI       0x20
42
43 #define SDHCI_COMMAND           0x0E
44 #define  SDHCI_CMD_RESP_MASK    0x03
45 #define  SDHCI_CMD_CRC          0x08
46 #define  SDHCI_CMD_INDEX        0x10
47 #define  SDHCI_CMD_DATA         0x20
48
49 #define  SDHCI_CMD_RESP_NONE    0x00
50 #define  SDHCI_CMD_RESP_LONG    0x01
51 #define  SDHCI_CMD_RESP_SHORT   0x02
52 #define  SDHCI_CMD_RESP_SHORT_BUSY 0x03
53
54 #define SDHCI_MAKE_CMD(c, f) (((c & 0xff) << 8) | (f & 0xff))
55 #define SDHCI_GET_CMD(c) ((c>>8) & 0x3f)
56
57 #define SDHCI_RESPONSE          0x10
58
59 #define SDHCI_BUFFER            0x20
60
61 #define SDHCI_PRESENT_STATE     0x24
62 #define  SDHCI_CMD_INHIBIT      0x00000001
63 #define  SDHCI_DATA_INHIBIT     0x00000002
64 #define  SDHCI_DOING_WRITE      0x00000100
65 #define  SDHCI_DOING_READ       0x00000200
66 #define  SDHCI_SPACE_AVAILABLE  0x00000400
67 #define  SDHCI_DATA_AVAILABLE   0x00000800
68 #define  SDHCI_CARD_PRESENT     0x00010000
69 #define  SDHCI_WRITE_PROTECT    0x00080000
70
71 #define SDHCI_HOST_CONTROL      0x28
72 #define  SDHCI_CTRL_LED         0x01
73 #define  SDHCI_CTRL_4BITBUS     0x02
74 #define  SDHCI_CTRL_HISPD       0x04
75 #define  SDHCI_CTRL_DMA_MASK    0x18
76 #define   SDHCI_CTRL_SDMA       0x00
77 #define   SDHCI_CTRL_ADMA1      0x08
78 #define   SDHCI_CTRL_ADMA32     0x10
79 #define   SDHCI_CTRL_ADMA64     0x18
80 #define   SDHCI_CTRL_8BITBUS    0x20
81
82 #define SDHCI_POWER_CONTROL     0x29
83 #define  SDHCI_POWER_ON         0x01
84 #define  SDHCI_POWER_180        0x0A
85 #define  SDHCI_POWER_300        0x0C
86 #define  SDHCI_POWER_330        0x0E
87
88 #define SDHCI_BLOCK_GAP_CONTROL 0x2A
89
90 #define SDHCI_WAKE_UP_CONTROL   0x2B
91 #define  SDHCI_WAKE_ON_INT      0x01
92 #define  SDHCI_WAKE_ON_INSERT   0x02
93 #define  SDHCI_WAKE_ON_REMOVE   0x04
94
95 #define SDHCI_CLOCK_CONTROL     0x2C
96 #define  SDHCI_DIVIDER_SHIFT    8
97 #define  SDHCI_DIVIDER_HI_SHIFT 6
98 #define  SDHCI_DIV_MASK 0xFF
99 #define  SDHCI_DIV_MASK_LEN     8
100 #define  SDHCI_DIV_HI_MASK      0x300
101 #define  SDHCI_CLOCK_CARD_EN    0x0004
102 #define  SDHCI_CLOCK_INT_STABLE 0x0002
103 #define  SDHCI_CLOCK_INT_EN     0x0001
104
105 #define SDHCI_TIMEOUT_CONTROL   0x2E
106
107 #define SDHCI_SOFTWARE_RESET    0x2F
108 #define  SDHCI_RESET_ALL        0x01
109 #define  SDHCI_RESET_CMD        0x02
110 #define  SDHCI_RESET_DATA       0x04
111
112 #define SDHCI_INT_STATUS        0x30
113 #define SDHCI_INT_ENABLE        0x34
114 #define SDHCI_SIGNAL_ENABLE     0x38
115 #define  SDHCI_INT_RESPONSE     0x00000001
116 #define  SDHCI_INT_DATA_END     0x00000002
117 #define  SDHCI_INT_DMA_END      0x00000008
118 #define  SDHCI_INT_SPACE_AVAIL  0x00000010
119 #define  SDHCI_INT_DATA_AVAIL   0x00000020
120 #define  SDHCI_INT_CARD_INSERT  0x00000040
121 #define  SDHCI_INT_CARD_REMOVE  0x00000080
122 #define  SDHCI_INT_CARD_INT     0x00000100
123 #define  SDHCI_INT_ERROR        0x00008000
124 #define  SDHCI_INT_TIMEOUT      0x00010000
125 #define  SDHCI_INT_CRC          0x00020000
126 #define  SDHCI_INT_END_BIT      0x00040000
127 #define  SDHCI_INT_INDEX        0x00080000
128 #define  SDHCI_INT_DATA_TIMEOUT 0x00100000
129 #define  SDHCI_INT_DATA_CRC     0x00200000
130 #define  SDHCI_INT_DATA_END_BIT 0x00400000
131 #define  SDHCI_INT_BUS_POWER    0x00800000
132 #define  SDHCI_INT_ACMD12ERR    0x01000000
133 #define  SDHCI_INT_ADMA_ERROR   0x02000000
134
135 #define  SDHCI_INT_NORMAL_MASK  0x00007FFF
136 #define  SDHCI_INT_ERROR_MASK   0xFFFF8000
137
138 #define  SDHCI_INT_CMD_MASK     (SDHCI_INT_RESPONSE | SDHCI_INT_TIMEOUT | \
139                 SDHCI_INT_CRC | SDHCI_INT_END_BIT | SDHCI_INT_INDEX)
140 #define  SDHCI_INT_DATA_MASK    (SDHCI_INT_DATA_END | SDHCI_INT_DMA_END | \
141                 SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL | \
142                 SDHCI_INT_DATA_TIMEOUT | SDHCI_INT_DATA_CRC | \
143                 SDHCI_INT_DATA_END_BIT | SDHCI_INT_ADMA_ERROR)
144 #define SDHCI_INT_ALL_MASK      ((unsigned int)-1)
145
146 #define SDHCI_ACMD12_ERR        0x3C
147
148 /* 3E-3F reserved */
149
150 #define SDHCI_CAPABILITIES      0x40
151 #define  SDHCI_TIMEOUT_CLK_MASK 0x0000003F
152 #define  SDHCI_TIMEOUT_CLK_SHIFT 0
153 #define  SDHCI_TIMEOUT_CLK_UNIT 0x00000080
154 #define  SDHCI_CLOCK_BASE_MASK  0x00003F00
155 #define  SDHCI_CLOCK_V3_BASE_MASK       0x0000FF00
156 #define  SDHCI_CLOCK_BASE_SHIFT 8
157 #define  SDHCI_MAX_BLOCK_MASK   0x00030000
158 #define  SDHCI_MAX_BLOCK_SHIFT  16
159 #define  SDHCI_CAN_DO_8BIT      0x00040000
160 #define  SDHCI_CAN_DO_ADMA2     0x00080000
161 #define  SDHCI_CAN_DO_ADMA1     0x00100000
162 #define  SDHCI_CAN_DO_HISPD     0x00200000
163 #define  SDHCI_CAN_DO_SDMA      0x00400000
164 #define  SDHCI_CAN_VDD_330      0x01000000
165 #define  SDHCI_CAN_VDD_300      0x02000000
166 #define  SDHCI_CAN_VDD_180      0x04000000
167 #define  SDHCI_CAN_64BIT        0x10000000
168
169 #define SDHCI_CAPABILITIES_1    0x44
170
171 #define SDHCI_MAX_CURRENT       0x48
172
173 /* 4C-4F reserved for more max current */
174
175 #define SDHCI_SET_ACMD12_ERROR  0x50
176 #define SDHCI_SET_INT_ERROR     0x52
177
178 #define SDHCI_ADMA_ERROR        0x54
179
180 /* 55-57 reserved */
181
182 #define SDHCI_ADMA_ADDRESS      0x58
183
184 /* 60-FB reserved */
185
186 #define SDHCI_SLOT_INT_STATUS   0xFC
187
188 #define SDHCI_HOST_VERSION      0xFE
189 #define  SDHCI_VENDOR_VER_MASK  0xFF00
190 #define  SDHCI_VENDOR_VER_SHIFT 8
191 #define  SDHCI_SPEC_VER_MASK    0x00FF
192 #define  SDHCI_SPEC_VER_SHIFT   0
193 #define   SDHCI_SPEC_100        0
194 #define   SDHCI_SPEC_200        1
195 #define   SDHCI_SPEC_300        2
196
197 /*
198  * End of controller registers.
199  */
200
201 #define SDHCI_MAX_DIV_SPEC_200  256
202 #define SDHCI_MAX_DIV_SPEC_300  2046
203
204 struct sdhci_ops {
205 #ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS
206         u32             (*read_l)(struct sdhci_host *host, int reg);
207         u16             (*read_w)(struct sdhci_host *host, int reg);
208         u8              (*read_b)(struct sdhci_host *host, int reg);
209         void            (*write_l)(struct sdhci_host *host, u32 val, int reg);
210         void            (*write_w)(struct sdhci_host *host, u16 val, int reg);
211         void            (*write_b)(struct sdhci_host *host, u8 val, int reg);
212 #endif
213
214         void    (*set_clock)(struct sdhci_host *host, unsigned int clock);
215
216         int             (*enable_dma)(struct sdhci_host *host);
217         unsigned int    (*get_max_clock)(struct sdhci_host *host);
218         unsigned int    (*get_min_clock)(struct sdhci_host *host);
219         unsigned int    (*get_timeout_clock)(struct sdhci_host *host);
220         int             (*platform_8bit_width)(struct sdhci_host *host,
221                                                int width);
222         void (*platform_send_init_74_clocks)(struct sdhci_host *host,
223                                              u8 power_mode);
224         unsigned int    (*get_ro)(struct sdhci_host *host);
225 };
226
227 #ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS
228
229 static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg)
230 {
231         if (unlikely(host->ops->write_l))
232                 host->ops->write_l(host, val, reg);
233         else
234                 writel(val, host->ioaddr + reg);
235 }
236
237 static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg)
238 {
239         if (unlikely(host->ops->write_w))
240                 host->ops->write_w(host, val, reg);
241         else
242                 writew(val, host->ioaddr + reg);
243 }
244
245 static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg)
246 {
247         if (unlikely(host->ops->write_b))
248                 host->ops->write_b(host, val, reg);
249         else
250                 writeb(val, host->ioaddr + reg);
251 }
252
253 static inline u32 sdhci_readl(struct sdhci_host *host, int reg)
254 {
255         if (unlikely(host->ops->read_l))
256                 return host->ops->read_l(host, reg);
257         else
258                 return readl(host->ioaddr + reg);
259 }
260
261 static inline u16 sdhci_readw(struct sdhci_host *host, int reg)
262 {
263         if (unlikely(host->ops->read_w))
264                 return host->ops->read_w(host, reg);
265         else
266                 return readw(host->ioaddr + reg);
267 }
268
269 static inline u8 sdhci_readb(struct sdhci_host *host, int reg)
270 {
271         if (unlikely(host->ops->read_b))
272                 return host->ops->read_b(host, reg);
273         else
274                 return readb(host->ioaddr + reg);
275 }
276
277 #else
278
279 static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg)
280 {
281         writel(val, host->ioaddr + reg);
282 }
283
284 static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg)
285 {
286         writew(val, host->ioaddr + reg);
287 }
288
289 static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg)
290 {
291         writeb(val, host->ioaddr + reg);
292 }
293
294 static inline u32 sdhci_readl(struct sdhci_host *host, int reg)
295 {
296         return readl(host->ioaddr + reg);
297 }
298
299 static inline u16 sdhci_readw(struct sdhci_host *host, int reg)
300 {
301         return readw(host->ioaddr + reg);
302 }
303
304 static inline u8 sdhci_readb(struct sdhci_host *host, int reg)
305 {
306         return readb(host->ioaddr + reg);
307 }
308
309 #endif /* CONFIG_MMC_SDHCI_IO_ACCESSORS */
310
311 extern struct sdhci_host *sdhci_alloc_host(struct device *dev,
312         size_t priv_size);
313 extern void sdhci_free_host(struct sdhci_host *host);
314
315 static inline void *sdhci_priv(struct sdhci_host *host)
316 {
317         return (void *)host->private;
318 }
319
320 extern void sdhci_card_detect(struct sdhci_host *host);
321 extern int sdhci_add_host(struct sdhci_host *host);
322 extern void sdhci_remove_host(struct sdhci_host *host, int dead);
323
324 #ifdef CONFIG_PM
325 extern int sdhci_suspend_host(struct sdhci_host *host, pm_message_t state);
326 extern int sdhci_resume_host(struct sdhci_host *host);
327 extern void sdhci_enable_irq_wakeups(struct sdhci_host *host);
328 #endif
329
330 #endif /* __SDHCI_HW_H */