xref: /linux/drivers/mmc/host/sdhci.h (revision e5c86679d5e864947a52fb31e45a425dea3e7fa9)
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 #include <linux/leds.h>
21 #include <linux/interrupt.h>
22 
23 #include <linux/mmc/host.h>
24 
25 /*
26  * Controller registers
27  */
28 
29 #define SDHCI_DMA_ADDRESS	0x00
30 #define SDHCI_ARGUMENT2		SDHCI_DMA_ADDRESS
31 
32 #define SDHCI_BLOCK_SIZE	0x04
33 #define  SDHCI_MAKE_BLKSZ(dma, blksz) (((dma & 0x7) << 12) | (blksz & 0xFFF))
34 
35 #define SDHCI_BLOCK_COUNT	0x06
36 
37 #define SDHCI_ARGUMENT		0x08
38 
39 #define SDHCI_TRANSFER_MODE	0x0C
40 #define  SDHCI_TRNS_DMA		0x01
41 #define  SDHCI_TRNS_BLK_CNT_EN	0x02
42 #define  SDHCI_TRNS_AUTO_CMD12	0x04
43 #define  SDHCI_TRNS_AUTO_CMD23	0x08
44 #define  SDHCI_TRNS_READ	0x10
45 #define  SDHCI_TRNS_MULTI	0x20
46 
47 #define SDHCI_COMMAND		0x0E
48 #define  SDHCI_CMD_RESP_MASK	0x03
49 #define  SDHCI_CMD_CRC		0x08
50 #define  SDHCI_CMD_INDEX	0x10
51 #define  SDHCI_CMD_DATA		0x20
52 #define  SDHCI_CMD_ABORTCMD	0xC0
53 
54 #define  SDHCI_CMD_RESP_NONE	0x00
55 #define  SDHCI_CMD_RESP_LONG	0x01
56 #define  SDHCI_CMD_RESP_SHORT	0x02
57 #define  SDHCI_CMD_RESP_SHORT_BUSY 0x03
58 
59 #define SDHCI_MAKE_CMD(c, f) (((c & 0xff) << 8) | (f & 0xff))
60 #define SDHCI_GET_CMD(c) ((c>>8) & 0x3f)
61 
62 #define SDHCI_RESPONSE		0x10
63 
64 #define SDHCI_BUFFER		0x20
65 
66 #define SDHCI_PRESENT_STATE	0x24
67 #define  SDHCI_CMD_INHIBIT	0x00000001
68 #define  SDHCI_DATA_INHIBIT	0x00000002
69 #define  SDHCI_DOING_WRITE	0x00000100
70 #define  SDHCI_DOING_READ	0x00000200
71 #define  SDHCI_SPACE_AVAILABLE	0x00000400
72 #define  SDHCI_DATA_AVAILABLE	0x00000800
73 #define  SDHCI_CARD_PRESENT	0x00010000
74 #define  SDHCI_WRITE_PROTECT	0x00080000
75 #define  SDHCI_DATA_LVL_MASK	0x00F00000
76 #define   SDHCI_DATA_LVL_SHIFT	20
77 #define   SDHCI_DATA_0_LVL_MASK	0x00100000
78 #define  SDHCI_CMD_LVL		0x01000000
79 
80 #define SDHCI_HOST_CONTROL	0x28
81 #define  SDHCI_CTRL_LED		0x01
82 #define  SDHCI_CTRL_4BITBUS	0x02
83 #define  SDHCI_CTRL_HISPD	0x04
84 #define  SDHCI_CTRL_DMA_MASK	0x18
85 #define   SDHCI_CTRL_SDMA	0x00
86 #define   SDHCI_CTRL_ADMA1	0x08
87 #define   SDHCI_CTRL_ADMA32	0x10
88 #define   SDHCI_CTRL_ADMA64	0x18
89 #define   SDHCI_CTRL_8BITBUS	0x20
90 #define  SDHCI_CTRL_CDTEST_INS	0x40
91 #define  SDHCI_CTRL_CDTEST_EN	0x80
92 
93 #define SDHCI_POWER_CONTROL	0x29
94 #define  SDHCI_POWER_ON		0x01
95 #define  SDHCI_POWER_180	0x0A
96 #define  SDHCI_POWER_300	0x0C
97 #define  SDHCI_POWER_330	0x0E
98 
99 #define SDHCI_BLOCK_GAP_CONTROL	0x2A
100 
101 #define SDHCI_WAKE_UP_CONTROL	0x2B
102 #define  SDHCI_WAKE_ON_INT	0x01
103 #define  SDHCI_WAKE_ON_INSERT	0x02
104 #define  SDHCI_WAKE_ON_REMOVE	0x04
105 
106 #define SDHCI_CLOCK_CONTROL	0x2C
107 #define  SDHCI_DIVIDER_SHIFT	8
108 #define  SDHCI_DIVIDER_HI_SHIFT	6
109 #define  SDHCI_DIV_MASK	0xFF
110 #define  SDHCI_DIV_MASK_LEN	8
111 #define  SDHCI_DIV_HI_MASK	0x300
112 #define  SDHCI_PROG_CLOCK_MODE	0x0020
113 #define  SDHCI_CLOCK_CARD_EN	0x0004
114 #define  SDHCI_CLOCK_INT_STABLE	0x0002
115 #define  SDHCI_CLOCK_INT_EN	0x0001
116 
117 #define SDHCI_TIMEOUT_CONTROL	0x2E
118 
119 #define SDHCI_SOFTWARE_RESET	0x2F
120 #define  SDHCI_RESET_ALL	0x01
121 #define  SDHCI_RESET_CMD	0x02
122 #define  SDHCI_RESET_DATA	0x04
123 
124 #define SDHCI_INT_STATUS	0x30
125 #define SDHCI_INT_ENABLE	0x34
126 #define SDHCI_SIGNAL_ENABLE	0x38
127 #define  SDHCI_INT_RESPONSE	0x00000001
128 #define  SDHCI_INT_DATA_END	0x00000002
129 #define  SDHCI_INT_BLK_GAP	0x00000004
130 #define  SDHCI_INT_DMA_END	0x00000008
131 #define  SDHCI_INT_SPACE_AVAIL	0x00000010
132 #define  SDHCI_INT_DATA_AVAIL	0x00000020
133 #define  SDHCI_INT_CARD_INSERT	0x00000040
134 #define  SDHCI_INT_CARD_REMOVE	0x00000080
135 #define  SDHCI_INT_CARD_INT	0x00000100
136 #define  SDHCI_INT_RETUNE	0x00001000
137 #define  SDHCI_INT_ERROR	0x00008000
138 #define  SDHCI_INT_TIMEOUT	0x00010000
139 #define  SDHCI_INT_CRC		0x00020000
140 #define  SDHCI_INT_END_BIT	0x00040000
141 #define  SDHCI_INT_INDEX	0x00080000
142 #define  SDHCI_INT_DATA_TIMEOUT	0x00100000
143 #define  SDHCI_INT_DATA_CRC	0x00200000
144 #define  SDHCI_INT_DATA_END_BIT	0x00400000
145 #define  SDHCI_INT_BUS_POWER	0x00800000
146 #define  SDHCI_INT_ACMD12ERR	0x01000000
147 #define  SDHCI_INT_ADMA_ERROR	0x02000000
148 
149 #define  SDHCI_INT_NORMAL_MASK	0x00007FFF
150 #define  SDHCI_INT_ERROR_MASK	0xFFFF8000
151 
152 #define  SDHCI_INT_CMD_MASK	(SDHCI_INT_RESPONSE | SDHCI_INT_TIMEOUT | \
153 		SDHCI_INT_CRC | SDHCI_INT_END_BIT | SDHCI_INT_INDEX)
154 #define  SDHCI_INT_DATA_MASK	(SDHCI_INT_DATA_END | SDHCI_INT_DMA_END | \
155 		SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL | \
156 		SDHCI_INT_DATA_TIMEOUT | SDHCI_INT_DATA_CRC | \
157 		SDHCI_INT_DATA_END_BIT | SDHCI_INT_ADMA_ERROR | \
158 		SDHCI_INT_BLK_GAP)
159 #define SDHCI_INT_ALL_MASK	((unsigned int)-1)
160 
161 #define SDHCI_ACMD12_ERR	0x3C
162 
163 #define SDHCI_HOST_CONTROL2		0x3E
164 #define  SDHCI_CTRL_UHS_MASK		0x0007
165 #define   SDHCI_CTRL_UHS_SDR12		0x0000
166 #define   SDHCI_CTRL_UHS_SDR25		0x0001
167 #define   SDHCI_CTRL_UHS_SDR50		0x0002
168 #define   SDHCI_CTRL_UHS_SDR104		0x0003
169 #define   SDHCI_CTRL_UHS_DDR50		0x0004
170 #define   SDHCI_CTRL_HS400		0x0005 /* Non-standard */
171 #define  SDHCI_CTRL_VDD_180		0x0008
172 #define  SDHCI_CTRL_DRV_TYPE_MASK	0x0030
173 #define   SDHCI_CTRL_DRV_TYPE_B		0x0000
174 #define   SDHCI_CTRL_DRV_TYPE_A		0x0010
175 #define   SDHCI_CTRL_DRV_TYPE_C		0x0020
176 #define   SDHCI_CTRL_DRV_TYPE_D		0x0030
177 #define  SDHCI_CTRL_EXEC_TUNING		0x0040
178 #define  SDHCI_CTRL_TUNED_CLK		0x0080
179 #define  SDHCI_CTRL_PRESET_VAL_ENABLE	0x8000
180 
181 #define SDHCI_CAPABILITIES	0x40
182 #define  SDHCI_TIMEOUT_CLK_MASK	0x0000003F
183 #define  SDHCI_TIMEOUT_CLK_SHIFT 0
184 #define  SDHCI_TIMEOUT_CLK_UNIT	0x00000080
185 #define  SDHCI_CLOCK_BASE_MASK	0x00003F00
186 #define  SDHCI_CLOCK_V3_BASE_MASK	0x0000FF00
187 #define  SDHCI_CLOCK_BASE_SHIFT	8
188 #define  SDHCI_MAX_BLOCK_MASK	0x00030000
189 #define  SDHCI_MAX_BLOCK_SHIFT  16
190 #define  SDHCI_CAN_DO_8BIT	0x00040000
191 #define  SDHCI_CAN_DO_ADMA2	0x00080000
192 #define  SDHCI_CAN_DO_ADMA1	0x00100000
193 #define  SDHCI_CAN_DO_HISPD	0x00200000
194 #define  SDHCI_CAN_DO_SDMA	0x00400000
195 #define  SDHCI_CAN_DO_SUSPEND	0x00800000
196 #define  SDHCI_CAN_VDD_330	0x01000000
197 #define  SDHCI_CAN_VDD_300	0x02000000
198 #define  SDHCI_CAN_VDD_180	0x04000000
199 #define  SDHCI_CAN_64BIT	0x10000000
200 
201 #define  SDHCI_SUPPORT_SDR50	0x00000001
202 #define  SDHCI_SUPPORT_SDR104	0x00000002
203 #define  SDHCI_SUPPORT_DDR50	0x00000004
204 #define  SDHCI_DRIVER_TYPE_A	0x00000010
205 #define  SDHCI_DRIVER_TYPE_C	0x00000020
206 #define  SDHCI_DRIVER_TYPE_D	0x00000040
207 #define  SDHCI_RETUNING_TIMER_COUNT_MASK	0x00000F00
208 #define  SDHCI_RETUNING_TIMER_COUNT_SHIFT	8
209 #define  SDHCI_USE_SDR50_TUNING			0x00002000
210 #define  SDHCI_RETUNING_MODE_MASK		0x0000C000
211 #define  SDHCI_RETUNING_MODE_SHIFT		14
212 #define  SDHCI_CLOCK_MUL_MASK	0x00FF0000
213 #define  SDHCI_CLOCK_MUL_SHIFT	16
214 #define  SDHCI_SUPPORT_HS400	0x80000000 /* Non-standard */
215 
216 #define SDHCI_CAPABILITIES_1	0x44
217 
218 #define SDHCI_MAX_CURRENT		0x48
219 #define  SDHCI_MAX_CURRENT_LIMIT	0xFF
220 #define  SDHCI_MAX_CURRENT_330_MASK	0x0000FF
221 #define  SDHCI_MAX_CURRENT_330_SHIFT	0
222 #define  SDHCI_MAX_CURRENT_300_MASK	0x00FF00
223 #define  SDHCI_MAX_CURRENT_300_SHIFT	8
224 #define  SDHCI_MAX_CURRENT_180_MASK	0xFF0000
225 #define  SDHCI_MAX_CURRENT_180_SHIFT	16
226 #define   SDHCI_MAX_CURRENT_MULTIPLIER	4
227 
228 /* 4C-4F reserved for more max current */
229 
230 #define SDHCI_SET_ACMD12_ERROR	0x50
231 #define SDHCI_SET_INT_ERROR	0x52
232 
233 #define SDHCI_ADMA_ERROR	0x54
234 
235 /* 55-57 reserved */
236 
237 #define SDHCI_ADMA_ADDRESS	0x58
238 #define SDHCI_ADMA_ADDRESS_HI	0x5C
239 
240 /* 60-FB reserved */
241 
242 #define SDHCI_PRESET_FOR_SDR12 0x66
243 #define SDHCI_PRESET_FOR_SDR25 0x68
244 #define SDHCI_PRESET_FOR_SDR50 0x6A
245 #define SDHCI_PRESET_FOR_SDR104        0x6C
246 #define SDHCI_PRESET_FOR_DDR50 0x6E
247 #define SDHCI_PRESET_FOR_HS400 0x74 /* Non-standard */
248 #define SDHCI_PRESET_DRV_MASK  0xC000
249 #define SDHCI_PRESET_DRV_SHIFT  14
250 #define SDHCI_PRESET_CLKGEN_SEL_MASK   0x400
251 #define SDHCI_PRESET_CLKGEN_SEL_SHIFT	10
252 #define SDHCI_PRESET_SDCLK_FREQ_MASK   0x3FF
253 #define SDHCI_PRESET_SDCLK_FREQ_SHIFT	0
254 
255 #define SDHCI_SLOT_INT_STATUS	0xFC
256 
257 #define SDHCI_HOST_VERSION	0xFE
258 #define  SDHCI_VENDOR_VER_MASK	0xFF00
259 #define  SDHCI_VENDOR_VER_SHIFT	8
260 #define  SDHCI_SPEC_VER_MASK	0x00FF
261 #define  SDHCI_SPEC_VER_SHIFT	0
262 #define   SDHCI_SPEC_100	0
263 #define   SDHCI_SPEC_200	1
264 #define   SDHCI_SPEC_300	2
265 
266 /*
267  * End of controller registers.
268  */
269 
270 #define SDHCI_MAX_DIV_SPEC_200	256
271 #define SDHCI_MAX_DIV_SPEC_300	2046
272 
273 /*
274  * Host SDMA buffer boundary. Valid values from 4K to 512K in powers of 2.
275  */
276 #define SDHCI_DEFAULT_BOUNDARY_SIZE  (512 * 1024)
277 #define SDHCI_DEFAULT_BOUNDARY_ARG   (ilog2(SDHCI_DEFAULT_BOUNDARY_SIZE) - 12)
278 
279 /* ADMA2 32-bit DMA descriptor size */
280 #define SDHCI_ADMA2_32_DESC_SZ	8
281 
282 /* ADMA2 32-bit descriptor */
283 struct sdhci_adma2_32_desc {
284 	__le16	cmd;
285 	__le16	len;
286 	__le32	addr;
287 }  __packed __aligned(4);
288 
289 /* ADMA2 data alignment */
290 #define SDHCI_ADMA2_ALIGN	4
291 #define SDHCI_ADMA2_MASK	(SDHCI_ADMA2_ALIGN - 1)
292 
293 /*
294  * ADMA2 descriptor alignment.  Some controllers (e.g. Intel) require 8 byte
295  * alignment for the descriptor table even in 32-bit DMA mode.  Memory
296  * allocation is at least 8 byte aligned anyway, so just stipulate 8 always.
297  */
298 #define SDHCI_ADMA2_DESC_ALIGN	8
299 
300 /* ADMA2 64-bit DMA descriptor size */
301 #define SDHCI_ADMA2_64_DESC_SZ	12
302 
303 /*
304  * ADMA2 64-bit descriptor. Note 12-byte descriptor can't always be 8-byte
305  * aligned.
306  */
307 struct sdhci_adma2_64_desc {
308 	__le16	cmd;
309 	__le16	len;
310 	__le32	addr_lo;
311 	__le32	addr_hi;
312 }  __packed __aligned(4);
313 
314 #define ADMA2_TRAN_VALID	0x21
315 #define ADMA2_NOP_END_VALID	0x3
316 #define ADMA2_END		0x2
317 
318 /*
319  * Maximum segments assuming a 512KiB maximum requisition size and a minimum
320  * 4KiB page size.
321  */
322 #define SDHCI_MAX_SEGS		128
323 
324 /* Allow for a a command request and a data request at the same time */
325 #define SDHCI_MAX_MRQS		2
326 
327 enum sdhci_cookie {
328 	COOKIE_UNMAPPED,
329 	COOKIE_PRE_MAPPED,	/* mapped by sdhci_pre_req() */
330 	COOKIE_MAPPED,		/* mapped by sdhci_prepare_data() */
331 };
332 
333 struct sdhci_host {
334 	/* Data set by hardware interface driver */
335 	const char *hw_name;	/* Hardware bus name */
336 
337 	unsigned int quirks;	/* Deviations from spec. */
338 
339 /* Controller doesn't honor resets unless we touch the clock register */
340 #define SDHCI_QUIRK_CLOCK_BEFORE_RESET			(1<<0)
341 /* Controller has bad caps bits, but really supports DMA */
342 #define SDHCI_QUIRK_FORCE_DMA				(1<<1)
343 /* Controller doesn't like to be reset when there is no card inserted. */
344 #define SDHCI_QUIRK_NO_CARD_NO_RESET			(1<<2)
345 /* Controller doesn't like clearing the power reg before a change */
346 #define SDHCI_QUIRK_SINGLE_POWER_WRITE			(1<<3)
347 /* Controller has flaky internal state so reset it on each ios change */
348 #define SDHCI_QUIRK_RESET_CMD_DATA_ON_IOS		(1<<4)
349 /* Controller has an unusable DMA engine */
350 #define SDHCI_QUIRK_BROKEN_DMA				(1<<5)
351 /* Controller has an unusable ADMA engine */
352 #define SDHCI_QUIRK_BROKEN_ADMA				(1<<6)
353 /* Controller can only DMA from 32-bit aligned addresses */
354 #define SDHCI_QUIRK_32BIT_DMA_ADDR			(1<<7)
355 /* Controller can only DMA chunk sizes that are a multiple of 32 bits */
356 #define SDHCI_QUIRK_32BIT_DMA_SIZE			(1<<8)
357 /* Controller can only ADMA chunks that are a multiple of 32 bits */
358 #define SDHCI_QUIRK_32BIT_ADMA_SIZE			(1<<9)
359 /* Controller needs to be reset after each request to stay stable */
360 #define SDHCI_QUIRK_RESET_AFTER_REQUEST			(1<<10)
361 /* Controller needs voltage and power writes to happen separately */
362 #define SDHCI_QUIRK_NO_SIMULT_VDD_AND_POWER		(1<<11)
363 /* Controller provides an incorrect timeout value for transfers */
364 #define SDHCI_QUIRK_BROKEN_TIMEOUT_VAL			(1<<12)
365 /* Controller has an issue with buffer bits for small transfers */
366 #define SDHCI_QUIRK_BROKEN_SMALL_PIO			(1<<13)
367 /* Controller does not provide transfer-complete interrupt when not busy */
368 #define SDHCI_QUIRK_NO_BUSY_IRQ				(1<<14)
369 /* Controller has unreliable card detection */
370 #define SDHCI_QUIRK_BROKEN_CARD_DETECTION		(1<<15)
371 /* Controller reports inverted write-protect state */
372 #define SDHCI_QUIRK_INVERTED_WRITE_PROTECT		(1<<16)
373 /* Controller does not like fast PIO transfers */
374 #define SDHCI_QUIRK_PIO_NEEDS_DELAY			(1<<18)
375 /* Controller has to be forced to use block size of 2048 bytes */
376 #define SDHCI_QUIRK_FORCE_BLK_SZ_2048			(1<<20)
377 /* Controller cannot do multi-block transfers */
378 #define SDHCI_QUIRK_NO_MULTIBLOCK			(1<<21)
379 /* Controller can only handle 1-bit data transfers */
380 #define SDHCI_QUIRK_FORCE_1_BIT_DATA			(1<<22)
381 /* Controller needs 10ms delay between applying power and clock */
382 #define SDHCI_QUIRK_DELAY_AFTER_POWER			(1<<23)
383 /* Controller uses SDCLK instead of TMCLK for data timeouts */
384 #define SDHCI_QUIRK_DATA_TIMEOUT_USES_SDCLK		(1<<24)
385 /* Controller reports wrong base clock capability */
386 #define SDHCI_QUIRK_CAP_CLOCK_BASE_BROKEN		(1<<25)
387 /* Controller cannot support End Attribute in NOP ADMA descriptor */
388 #define SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC		(1<<26)
389 /* Controller is missing device caps. Use caps provided by host */
390 #define SDHCI_QUIRK_MISSING_CAPS			(1<<27)
391 /* Controller uses Auto CMD12 command to stop the transfer */
392 #define SDHCI_QUIRK_MULTIBLOCK_READ_ACMD12		(1<<28)
393 /* Controller doesn't have HISPD bit field in HI-SPEED SD card */
394 #define SDHCI_QUIRK_NO_HISPD_BIT			(1<<29)
395 /* Controller treats ADMA descriptors with length 0000h incorrectly */
396 #define SDHCI_QUIRK_BROKEN_ADMA_ZEROLEN_DESC		(1<<30)
397 /* The read-only detection via SDHCI_PRESENT_STATE register is unstable */
398 #define SDHCI_QUIRK_UNSTABLE_RO_DETECT			(1<<31)
399 
400 	unsigned int quirks2;	/* More deviations from spec. */
401 
402 #define SDHCI_QUIRK2_HOST_OFF_CARD_ON			(1<<0)
403 #define SDHCI_QUIRK2_HOST_NO_CMD23			(1<<1)
404 /* The system physically doesn't support 1.8v, even if the host does */
405 #define SDHCI_QUIRK2_NO_1_8_V				(1<<2)
406 #define SDHCI_QUIRK2_PRESET_VALUE_BROKEN		(1<<3)
407 #define SDHCI_QUIRK2_CARD_ON_NEEDS_BUS_ON		(1<<4)
408 /* Controller has a non-standard host control register */
409 #define SDHCI_QUIRK2_BROKEN_HOST_CONTROL		(1<<5)
410 /* Controller does not support HS200 */
411 #define SDHCI_QUIRK2_BROKEN_HS200			(1<<6)
412 /* Controller does not support DDR50 */
413 #define SDHCI_QUIRK2_BROKEN_DDR50			(1<<7)
414 /* Stop command (CMD12) can set Transfer Complete when not using MMC_RSP_BUSY */
415 #define SDHCI_QUIRK2_STOP_WITH_TC			(1<<8)
416 /* Controller does not support 64-bit DMA */
417 #define SDHCI_QUIRK2_BROKEN_64_BIT_DMA			(1<<9)
418 /* need clear transfer mode register before send cmd */
419 #define SDHCI_QUIRK2_CLEAR_TRANSFERMODE_REG_BEFORE_CMD	(1<<10)
420 /* Capability register bit-63 indicates HS400 support */
421 #define SDHCI_QUIRK2_CAPS_BIT63_FOR_HS400		(1<<11)
422 /* forced tuned clock */
423 #define SDHCI_QUIRK2_TUNING_WORK_AROUND			(1<<12)
424 /* disable the block count for single block transactions */
425 #define SDHCI_QUIRK2_SUPPORT_SINGLE			(1<<13)
426 /* Controller broken with using ACMD23 */
427 #define SDHCI_QUIRK2_ACMD23_BROKEN			(1<<14)
428 /* Broken Clock divider zero in controller */
429 #define SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN		(1<<15)
430 
431 	int irq;		/* Device IRQ */
432 	void __iomem *ioaddr;	/* Mapped address */
433 
434 	const struct sdhci_ops *ops;	/* Low level hw interface */
435 
436 	/* Internal data */
437 	struct mmc_host *mmc;	/* MMC structure */
438 	struct mmc_host_ops mmc_host_ops;	/* MMC host ops */
439 	u64 dma_mask;		/* custom DMA mask */
440 
441 #if IS_ENABLED(CONFIG_LEDS_CLASS)
442 	struct led_classdev led;	/* LED control */
443 	char led_name[32];
444 #endif
445 
446 	spinlock_t lock;	/* Mutex */
447 
448 	int flags;		/* Host attributes */
449 #define SDHCI_USE_SDMA		(1<<0)	/* Host is SDMA capable */
450 #define SDHCI_USE_ADMA		(1<<1)	/* Host is ADMA capable */
451 #define SDHCI_REQ_USE_DMA	(1<<2)	/* Use DMA for this req. */
452 #define SDHCI_DEVICE_DEAD	(1<<3)	/* Device unresponsive */
453 #define SDHCI_SDR50_NEEDS_TUNING (1<<4)	/* SDR50 needs tuning */
454 #define SDHCI_AUTO_CMD12	(1<<6)	/* Auto CMD12 support */
455 #define SDHCI_AUTO_CMD23	(1<<7)	/* Auto CMD23 support */
456 #define SDHCI_PV_ENABLED	(1<<8)	/* Preset value enabled */
457 #define SDHCI_SDIO_IRQ_ENABLED	(1<<9)	/* SDIO irq enabled */
458 #define SDHCI_USE_64_BIT_DMA	(1<<12)	/* Use 64-bit DMA */
459 #define SDHCI_HS400_TUNING	(1<<13)	/* Tuning for HS400 */
460 #define SDHCI_SIGNALING_330	(1<<14)	/* Host is capable of 3.3V signaling */
461 #define SDHCI_SIGNALING_180	(1<<15)	/* Host is capable of 1.8V signaling */
462 #define SDHCI_SIGNALING_120	(1<<16)	/* Host is capable of 1.2V signaling */
463 
464 	unsigned int version;	/* SDHCI spec. version */
465 
466 	unsigned int max_clk;	/* Max possible freq (MHz) */
467 	unsigned int timeout_clk;	/* Timeout freq (KHz) */
468 	unsigned int clk_mul;	/* Clock Muliplier value */
469 
470 	unsigned int clock;	/* Current clock (MHz) */
471 	u8 pwr;			/* Current voltage */
472 
473 	bool runtime_suspended;	/* Host is runtime suspended */
474 	bool bus_on;		/* Bus power prevents runtime suspend */
475 	bool preset_enabled;	/* Preset is enabled */
476 	bool pending_reset;	/* Cmd/data reset is pending */
477 
478 	struct mmc_request *mrqs_done[SDHCI_MAX_MRQS];	/* Requests done */
479 	struct mmc_command *cmd;	/* Current command */
480 	struct mmc_command *data_cmd;	/* Current data command */
481 	struct mmc_data *data;	/* Current data request */
482 	unsigned int data_early:1;	/* Data finished before cmd */
483 
484 	struct sg_mapping_iter sg_miter;	/* SG state for PIO */
485 	unsigned int blocks;	/* remaining PIO blocks */
486 
487 	int sg_count;		/* Mapped sg entries */
488 
489 	void *adma_table;	/* ADMA descriptor table */
490 	void *align_buffer;	/* Bounce buffer */
491 
492 	size_t adma_table_sz;	/* ADMA descriptor table size */
493 	size_t align_buffer_sz;	/* Bounce buffer size */
494 
495 	dma_addr_t adma_addr;	/* Mapped ADMA descr. table */
496 	dma_addr_t align_addr;	/* Mapped bounce buffer */
497 
498 	unsigned int desc_sz;	/* ADMA descriptor size */
499 
500 	struct tasklet_struct finish_tasklet;	/* Tasklet structures */
501 
502 	struct timer_list timer;	/* Timer for timeouts */
503 	struct timer_list data_timer;	/* Timer for data timeouts */
504 
505 	u32 caps;		/* CAPABILITY_0 */
506 	u32 caps1;		/* CAPABILITY_1 */
507 	bool read_caps;		/* Capability flags have been read */
508 
509 	unsigned int            ocr_avail_sdio;	/* OCR bit masks */
510 	unsigned int            ocr_avail_sd;
511 	unsigned int            ocr_avail_mmc;
512 	u32 ocr_mask;		/* available voltages */
513 
514 	unsigned		timing;		/* Current timing */
515 
516 	u32			thread_isr;
517 
518 	/* cached registers */
519 	u32			ier;
520 
521 	wait_queue_head_t	buf_ready_int;	/* Waitqueue for Buffer Read Ready interrupt */
522 	unsigned int		tuning_done;	/* Condition flag set when CMD19 succeeds */
523 
524 	unsigned int		tuning_count;	/* Timer count for re-tuning */
525 	unsigned int		tuning_mode;	/* Re-tuning mode supported by host */
526 #define SDHCI_TUNING_MODE_1	0
527 #define SDHCI_TUNING_MODE_2	1
528 #define SDHCI_TUNING_MODE_3	2
529 
530 	unsigned long private[0] ____cacheline_aligned;
531 };
532 
533 struct sdhci_ops {
534 #ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS
535 	u32		(*read_l)(struct sdhci_host *host, int reg);
536 	u16		(*read_w)(struct sdhci_host *host, int reg);
537 	u8		(*read_b)(struct sdhci_host *host, int reg);
538 	void		(*write_l)(struct sdhci_host *host, u32 val, int reg);
539 	void		(*write_w)(struct sdhci_host *host, u16 val, int reg);
540 	void		(*write_b)(struct sdhci_host *host, u8 val, int reg);
541 #endif
542 
543 	void	(*set_clock)(struct sdhci_host *host, unsigned int clock);
544 	void	(*set_power)(struct sdhci_host *host, unsigned char mode,
545 			     unsigned short vdd);
546 
547 	int		(*enable_dma)(struct sdhci_host *host);
548 	unsigned int	(*get_max_clock)(struct sdhci_host *host);
549 	unsigned int	(*get_min_clock)(struct sdhci_host *host);
550 	unsigned int	(*get_timeout_clock)(struct sdhci_host *host);
551 	unsigned int	(*get_max_timeout_count)(struct sdhci_host *host);
552 	void		(*set_timeout)(struct sdhci_host *host,
553 				       struct mmc_command *cmd);
554 	void		(*set_bus_width)(struct sdhci_host *host, int width);
555 	void (*platform_send_init_74_clocks)(struct sdhci_host *host,
556 					     u8 power_mode);
557 	unsigned int    (*get_ro)(struct sdhci_host *host);
558 	void		(*reset)(struct sdhci_host *host, u8 mask);
559 	int	(*platform_execute_tuning)(struct sdhci_host *host, u32 opcode);
560 	void	(*set_uhs_signaling)(struct sdhci_host *host, unsigned int uhs);
561 	void	(*hw_reset)(struct sdhci_host *host);
562 	void    (*adma_workaround)(struct sdhci_host *host, u32 intmask);
563 	void    (*card_event)(struct sdhci_host *host);
564 	void	(*voltage_switch)(struct sdhci_host *host);
565 	int	(*select_drive_strength)(struct sdhci_host *host,
566 					 struct mmc_card *card,
567 					 unsigned int max_dtr, int host_drv,
568 					 int card_drv, int *drv_type);
569 };
570 
571 #ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS
572 
573 static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg)
574 {
575 	if (unlikely(host->ops->write_l))
576 		host->ops->write_l(host, val, reg);
577 	else
578 		writel(val, host->ioaddr + reg);
579 }
580 
581 static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg)
582 {
583 	if (unlikely(host->ops->write_w))
584 		host->ops->write_w(host, val, reg);
585 	else
586 		writew(val, host->ioaddr + reg);
587 }
588 
589 static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg)
590 {
591 	if (unlikely(host->ops->write_b))
592 		host->ops->write_b(host, val, reg);
593 	else
594 		writeb(val, host->ioaddr + reg);
595 }
596 
597 static inline u32 sdhci_readl(struct sdhci_host *host, int reg)
598 {
599 	if (unlikely(host->ops->read_l))
600 		return host->ops->read_l(host, reg);
601 	else
602 		return readl(host->ioaddr + reg);
603 }
604 
605 static inline u16 sdhci_readw(struct sdhci_host *host, int reg)
606 {
607 	if (unlikely(host->ops->read_w))
608 		return host->ops->read_w(host, reg);
609 	else
610 		return readw(host->ioaddr + reg);
611 }
612 
613 static inline u8 sdhci_readb(struct sdhci_host *host, int reg)
614 {
615 	if (unlikely(host->ops->read_b))
616 		return host->ops->read_b(host, reg);
617 	else
618 		return readb(host->ioaddr + reg);
619 }
620 
621 #else
622 
623 static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg)
624 {
625 	writel(val, host->ioaddr + reg);
626 }
627 
628 static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg)
629 {
630 	writew(val, host->ioaddr + reg);
631 }
632 
633 static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg)
634 {
635 	writeb(val, host->ioaddr + reg);
636 }
637 
638 static inline u32 sdhci_readl(struct sdhci_host *host, int reg)
639 {
640 	return readl(host->ioaddr + reg);
641 }
642 
643 static inline u16 sdhci_readw(struct sdhci_host *host, int reg)
644 {
645 	return readw(host->ioaddr + reg);
646 }
647 
648 static inline u8 sdhci_readb(struct sdhci_host *host, int reg)
649 {
650 	return readb(host->ioaddr + reg);
651 }
652 
653 #endif /* CONFIG_MMC_SDHCI_IO_ACCESSORS */
654 
655 extern struct sdhci_host *sdhci_alloc_host(struct device *dev,
656 	size_t priv_size);
657 extern void sdhci_free_host(struct sdhci_host *host);
658 
659 static inline void *sdhci_priv(struct sdhci_host *host)
660 {
661 	return host->private;
662 }
663 
664 extern void sdhci_card_detect(struct sdhci_host *host);
665 extern void __sdhci_read_caps(struct sdhci_host *host, u16 *ver, u32 *caps,
666 			      u32 *caps1);
667 extern int sdhci_setup_host(struct sdhci_host *host);
668 extern int __sdhci_add_host(struct sdhci_host *host);
669 extern int sdhci_add_host(struct sdhci_host *host);
670 extern void sdhci_remove_host(struct sdhci_host *host, int dead);
671 extern void sdhci_send_command(struct sdhci_host *host,
672 				struct mmc_command *cmd);
673 
674 static inline void sdhci_read_caps(struct sdhci_host *host)
675 {
676 	__sdhci_read_caps(host, NULL, NULL, NULL);
677 }
678 
679 static inline bool sdhci_sdio_irq_enabled(struct sdhci_host *host)
680 {
681 	return !!(host->flags & SDHCI_SDIO_IRQ_ENABLED);
682 }
683 
684 u16 sdhci_calc_clk(struct sdhci_host *host, unsigned int clock,
685 		   unsigned int *actual_clock);
686 void sdhci_set_clock(struct sdhci_host *host, unsigned int clock);
687 void sdhci_enable_clk(struct sdhci_host *host, u16 clk);
688 void sdhci_set_power(struct sdhci_host *host, unsigned char mode,
689 		     unsigned short vdd);
690 void sdhci_set_power_noreg(struct sdhci_host *host, unsigned char mode,
691 			   unsigned short vdd);
692 void sdhci_set_bus_width(struct sdhci_host *host, int width);
693 void sdhci_reset(struct sdhci_host *host, u8 mask);
694 void sdhci_set_uhs_signaling(struct sdhci_host *host, unsigned timing);
695 int sdhci_execute_tuning(struct mmc_host *mmc, u32 opcode);
696 
697 #ifdef CONFIG_PM
698 extern int sdhci_suspend_host(struct sdhci_host *host);
699 extern int sdhci_resume_host(struct sdhci_host *host);
700 extern void sdhci_enable_irq_wakeups(struct sdhci_host *host);
701 extern int sdhci_runtime_suspend_host(struct sdhci_host *host);
702 extern int sdhci_runtime_resume_host(struct sdhci_host *host);
703 #endif
704 
705 #endif /* __SDHCI_HW_H */
706