Loading...
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 * linux/drivers/mmc/host/sdhci.h - Secure Digital Host Controller Interface driver
4 *
5 * Header file for Host Controller registers and I/O accessors.
6 *
7 * Copyright (C) 2005-2008 Pierre Ossman, All Rights Reserved.
8 */
9#ifndef __SDHCI_HW_H
10#define __SDHCI_HW_H
11
12#include <linux/bits.h>
13#include <linux/scatterlist.h>
14#include <linux/compiler.h>
15#include <linux/types.h>
16#include <linux/io.h>
17#include <linux/leds.h>
18#include <linux/interrupt.h>
19
20#include <linux/mmc/host.h>
21
22/*
23 * Controller registers
24 */
25
26#define SDHCI_DMA_ADDRESS 0x00
27#define SDHCI_ARGUMENT2 SDHCI_DMA_ADDRESS
28#define SDHCI_32BIT_BLK_CNT SDHCI_DMA_ADDRESS
29
30#define SDHCI_BLOCK_SIZE 0x04
31#define SDHCI_MAKE_BLKSZ(dma, blksz) (((dma & 0x7) << 12) | (blksz & 0xFFF))
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
40#define SDHCI_TRNS_AUTO_CMD12 0x04
41#define SDHCI_TRNS_AUTO_CMD23 0x08
42#define SDHCI_TRNS_AUTO_SEL 0x0C
43#define SDHCI_TRNS_READ 0x10
44#define SDHCI_TRNS_MULTI 0x20
45
46#define SDHCI_COMMAND 0x0E
47#define SDHCI_CMD_RESP_MASK 0x03
48#define SDHCI_CMD_CRC 0x08
49#define SDHCI_CMD_INDEX 0x10
50#define SDHCI_CMD_DATA 0x20
51#define SDHCI_CMD_ABORTCMD 0xC0
52
53#define SDHCI_CMD_RESP_NONE 0x00
54#define SDHCI_CMD_RESP_LONG 0x01
55#define SDHCI_CMD_RESP_SHORT 0x02
56#define SDHCI_CMD_RESP_SHORT_BUSY 0x03
57
58#define SDHCI_MAKE_CMD(c, f) (((c & 0xff) << 8) | (f & 0xff))
59#define SDHCI_GET_CMD(c) ((c>>8) & 0x3f)
60
61#define SDHCI_RESPONSE 0x10
62
63#define SDHCI_BUFFER 0x20
64
65#define SDHCI_PRESENT_STATE 0x24
66#define SDHCI_CMD_INHIBIT 0x00000001
67#define SDHCI_DATA_INHIBIT 0x00000002
68#define SDHCI_DOING_WRITE 0x00000100
69#define SDHCI_DOING_READ 0x00000200
70#define SDHCI_SPACE_AVAILABLE 0x00000400
71#define SDHCI_DATA_AVAILABLE 0x00000800
72#define SDHCI_CARD_PRESENT 0x00010000
73#define SDHCI_CARD_PRES_SHIFT 16
74#define SDHCI_CD_STABLE 0x00020000
75#define SDHCI_CD_LVL 0x00040000
76#define SDHCI_CD_LVL_SHIFT 18
77#define SDHCI_WRITE_PROTECT 0x00080000
78#define SDHCI_DATA_LVL_MASK 0x00F00000
79#define SDHCI_DATA_LVL_SHIFT 20
80#define SDHCI_DATA_0_LVL_MASK 0x00100000
81#define SDHCI_CMD_LVL 0x01000000
82
83#define SDHCI_HOST_CONTROL 0x28
84#define SDHCI_CTRL_LED 0x01
85#define SDHCI_CTRL_4BITBUS 0x02
86#define SDHCI_CTRL_HISPD 0x04
87#define SDHCI_CTRL_DMA_MASK 0x18
88#define SDHCI_CTRL_SDMA 0x00
89#define SDHCI_CTRL_ADMA1 0x08
90#define SDHCI_CTRL_ADMA32 0x10
91#define SDHCI_CTRL_ADMA64 0x18
92#define SDHCI_CTRL_ADMA3 0x18
93#define SDHCI_CTRL_8BITBUS 0x20
94#define SDHCI_CTRL_CDTEST_INS 0x40
95#define SDHCI_CTRL_CDTEST_EN 0x80
96
97#define SDHCI_POWER_CONTROL 0x29
98#define SDHCI_POWER_ON 0x01
99#define SDHCI_POWER_180 0x0A
100#define SDHCI_POWER_300 0x0C
101#define SDHCI_POWER_330 0x0E
102
103#define SDHCI_BLOCK_GAP_CONTROL 0x2A
104
105#define SDHCI_WAKE_UP_CONTROL 0x2B
106#define SDHCI_WAKE_ON_INT 0x01
107#define SDHCI_WAKE_ON_INSERT 0x02
108#define SDHCI_WAKE_ON_REMOVE 0x04
109
110#define SDHCI_CLOCK_CONTROL 0x2C
111#define SDHCI_DIVIDER_SHIFT 8
112#define SDHCI_DIVIDER_HI_SHIFT 6
113#define SDHCI_DIV_MASK 0xFF
114#define SDHCI_DIV_MASK_LEN 8
115#define SDHCI_DIV_HI_MASK 0x300
116#define SDHCI_PROG_CLOCK_MODE 0x0020
117#define SDHCI_CLOCK_CARD_EN 0x0004
118#define SDHCI_CLOCK_PLL_EN 0x0008
119#define SDHCI_CLOCK_INT_STABLE 0x0002
120#define SDHCI_CLOCK_INT_EN 0x0001
121
122#define SDHCI_TIMEOUT_CONTROL 0x2E
123
124#define SDHCI_SOFTWARE_RESET 0x2F
125#define SDHCI_RESET_ALL 0x01
126#define SDHCI_RESET_CMD 0x02
127#define SDHCI_RESET_DATA 0x04
128
129#define SDHCI_INT_STATUS 0x30
130#define SDHCI_INT_ENABLE 0x34
131#define SDHCI_SIGNAL_ENABLE 0x38
132#define SDHCI_INT_RESPONSE 0x00000001
133#define SDHCI_INT_DATA_END 0x00000002
134#define SDHCI_INT_BLK_GAP 0x00000004
135#define SDHCI_INT_DMA_END 0x00000008
136#define SDHCI_INT_SPACE_AVAIL 0x00000010
137#define SDHCI_INT_DATA_AVAIL 0x00000020
138#define SDHCI_INT_CARD_INSERT 0x00000040
139#define SDHCI_INT_CARD_REMOVE 0x00000080
140#define SDHCI_INT_CARD_INT 0x00000100
141#define SDHCI_INT_RETUNE 0x00001000
142#define SDHCI_INT_CQE 0x00004000
143#define SDHCI_INT_ERROR 0x00008000
144#define SDHCI_INT_TIMEOUT 0x00010000
145#define SDHCI_INT_CRC 0x00020000
146#define SDHCI_INT_END_BIT 0x00040000
147#define SDHCI_INT_INDEX 0x00080000
148#define SDHCI_INT_DATA_TIMEOUT 0x00100000
149#define SDHCI_INT_DATA_CRC 0x00200000
150#define SDHCI_INT_DATA_END_BIT 0x00400000
151#define SDHCI_INT_BUS_POWER 0x00800000
152#define SDHCI_INT_AUTO_CMD_ERR 0x01000000
153#define SDHCI_INT_ADMA_ERROR 0x02000000
154
155#define SDHCI_INT_NORMAL_MASK 0x00007FFF
156#define SDHCI_INT_ERROR_MASK 0xFFFF8000
157
158#define SDHCI_INT_CMD_MASK (SDHCI_INT_RESPONSE | SDHCI_INT_TIMEOUT | \
159 SDHCI_INT_CRC | SDHCI_INT_END_BIT | SDHCI_INT_INDEX | \
160 SDHCI_INT_AUTO_CMD_ERR)
161#define SDHCI_INT_DATA_MASK (SDHCI_INT_DATA_END | SDHCI_INT_DMA_END | \
162 SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL | \
163 SDHCI_INT_DATA_TIMEOUT | SDHCI_INT_DATA_CRC | \
164 SDHCI_INT_DATA_END_BIT | SDHCI_INT_ADMA_ERROR | \
165 SDHCI_INT_BLK_GAP)
166#define SDHCI_INT_ALL_MASK ((unsigned int)-1)
167
168#define SDHCI_CQE_INT_ERR_MASK ( \
169 SDHCI_INT_ADMA_ERROR | SDHCI_INT_BUS_POWER | SDHCI_INT_DATA_END_BIT | \
170 SDHCI_INT_DATA_CRC | SDHCI_INT_DATA_TIMEOUT | SDHCI_INT_INDEX | \
171 SDHCI_INT_END_BIT | SDHCI_INT_CRC | SDHCI_INT_TIMEOUT)
172
173#define SDHCI_CQE_INT_MASK (SDHCI_CQE_INT_ERR_MASK | SDHCI_INT_CQE)
174
175#define SDHCI_AUTO_CMD_STATUS 0x3C
176#define SDHCI_AUTO_CMD_TIMEOUT 0x00000002
177#define SDHCI_AUTO_CMD_CRC 0x00000004
178#define SDHCI_AUTO_CMD_END_BIT 0x00000008
179#define SDHCI_AUTO_CMD_INDEX 0x00000010
180
181#define SDHCI_HOST_CONTROL2 0x3E
182#define SDHCI_CTRL_UHS_MASK 0x0007
183#define SDHCI_CTRL_UHS_SDR12 0x0000
184#define SDHCI_CTRL_UHS_SDR25 0x0001
185#define SDHCI_CTRL_UHS_SDR50 0x0002
186#define SDHCI_CTRL_UHS_SDR104 0x0003
187#define SDHCI_CTRL_UHS_DDR50 0x0004
188#define SDHCI_CTRL_HS400 0x0005 /* Non-standard */
189#define SDHCI_CTRL_VDD_180 0x0008
190#define SDHCI_CTRL_DRV_TYPE_MASK 0x0030
191#define SDHCI_CTRL_DRV_TYPE_B 0x0000
192#define SDHCI_CTRL_DRV_TYPE_A 0x0010
193#define SDHCI_CTRL_DRV_TYPE_C 0x0020
194#define SDHCI_CTRL_DRV_TYPE_D 0x0030
195#define SDHCI_CTRL_EXEC_TUNING 0x0040
196#define SDHCI_CTRL_TUNED_CLK 0x0080
197#define SDHCI_CMD23_ENABLE 0x0800
198#define SDHCI_CTRL_V4_MODE 0x1000
199#define SDHCI_CTRL_64BIT_ADDR 0x2000
200#define SDHCI_CTRL_PRESET_VAL_ENABLE 0x8000
201
202#define SDHCI_CAPABILITIES 0x40
203#define SDHCI_TIMEOUT_CLK_MASK GENMASK(5, 0)
204#define SDHCI_TIMEOUT_CLK_SHIFT 0
205#define SDHCI_TIMEOUT_CLK_UNIT 0x00000080
206#define SDHCI_CLOCK_BASE_MASK GENMASK(13, 8)
207#define SDHCI_CLOCK_BASE_SHIFT 8
208#define SDHCI_CLOCK_V3_BASE_MASK GENMASK(15, 8)
209#define SDHCI_MAX_BLOCK_MASK 0x00030000
210#define SDHCI_MAX_BLOCK_SHIFT 16
211#define SDHCI_CAN_DO_8BIT 0x00040000
212#define SDHCI_CAN_DO_ADMA2 0x00080000
213#define SDHCI_CAN_DO_ADMA1 0x00100000
214#define SDHCI_CAN_DO_HISPD 0x00200000
215#define SDHCI_CAN_DO_SDMA 0x00400000
216#define SDHCI_CAN_DO_SUSPEND 0x00800000
217#define SDHCI_CAN_VDD_330 0x01000000
218#define SDHCI_CAN_VDD_300 0x02000000
219#define SDHCI_CAN_VDD_180 0x04000000
220#define SDHCI_CAN_64BIT_V4 0x08000000
221#define SDHCI_CAN_64BIT 0x10000000
222
223#define SDHCI_CAPABILITIES_1 0x44
224#define SDHCI_SUPPORT_SDR50 0x00000001
225#define SDHCI_SUPPORT_SDR104 0x00000002
226#define SDHCI_SUPPORT_DDR50 0x00000004
227#define SDHCI_DRIVER_TYPE_A 0x00000010
228#define SDHCI_DRIVER_TYPE_C 0x00000020
229#define SDHCI_DRIVER_TYPE_D 0x00000040
230#define SDHCI_RETUNING_TIMER_COUNT_MASK GENMASK(11, 8)
231#define SDHCI_USE_SDR50_TUNING 0x00002000
232#define SDHCI_RETUNING_MODE_MASK GENMASK(15, 14)
233#define SDHCI_CLOCK_MUL_MASK GENMASK(23, 16)
234#define SDHCI_CAN_DO_ADMA3 0x08000000
235#define SDHCI_SUPPORT_HS400 0x80000000 /* Non-standard */
236
237#define SDHCI_MAX_CURRENT 0x48
238#define SDHCI_MAX_CURRENT_LIMIT GENMASK(7, 0)
239#define SDHCI_MAX_CURRENT_330_MASK GENMASK(7, 0)
240#define SDHCI_MAX_CURRENT_300_MASK GENMASK(15, 8)
241#define SDHCI_MAX_CURRENT_180_MASK GENMASK(23, 16)
242#define SDHCI_MAX_CURRENT_MULTIPLIER 4
243
244/* 4C-4F reserved for more max current */
245
246#define SDHCI_SET_ACMD12_ERROR 0x50
247#define SDHCI_SET_INT_ERROR 0x52
248
249#define SDHCI_ADMA_ERROR 0x54
250
251/* 55-57 reserved */
252
253#define SDHCI_ADMA_ADDRESS 0x58
254#define SDHCI_ADMA_ADDRESS_HI 0x5C
255
256/* 60-FB reserved */
257
258#define SDHCI_PRESET_FOR_HIGH_SPEED 0x64
259#define SDHCI_PRESET_FOR_SDR12 0x66
260#define SDHCI_PRESET_FOR_SDR25 0x68
261#define SDHCI_PRESET_FOR_SDR50 0x6A
262#define SDHCI_PRESET_FOR_SDR104 0x6C
263#define SDHCI_PRESET_FOR_DDR50 0x6E
264#define SDHCI_PRESET_FOR_HS400 0x74 /* Non-standard */
265#define SDHCI_PRESET_DRV_MASK GENMASK(15, 14)
266#define SDHCI_PRESET_CLKGEN_SEL BIT(10)
267#define SDHCI_PRESET_SDCLK_FREQ_MASK GENMASK(9, 0)
268
269#define SDHCI_SLOT_INT_STATUS 0xFC
270
271#define SDHCI_HOST_VERSION 0xFE
272#define SDHCI_VENDOR_VER_MASK 0xFF00
273#define SDHCI_VENDOR_VER_SHIFT 8
274#define SDHCI_SPEC_VER_MASK 0x00FF
275#define SDHCI_SPEC_VER_SHIFT 0
276#define SDHCI_SPEC_100 0
277#define SDHCI_SPEC_200 1
278#define SDHCI_SPEC_300 2
279#define SDHCI_SPEC_400 3
280#define SDHCI_SPEC_410 4
281#define SDHCI_SPEC_420 5
282
283/*
284 * End of controller registers.
285 */
286
287#define SDHCI_MAX_DIV_SPEC_200 256
288#define SDHCI_MAX_DIV_SPEC_300 2046
289
290/*
291 * Host SDMA buffer boundary. Valid values from 4K to 512K in powers of 2.
292 */
293#define SDHCI_DEFAULT_BOUNDARY_SIZE (512 * 1024)
294#define SDHCI_DEFAULT_BOUNDARY_ARG (ilog2(SDHCI_DEFAULT_BOUNDARY_SIZE) - 12)
295
296/* ADMA2 32-bit DMA descriptor size */
297#define SDHCI_ADMA2_32_DESC_SZ 8
298
299/* ADMA2 32-bit descriptor */
300struct sdhci_adma2_32_desc {
301 __le16 cmd;
302 __le16 len;
303 __le32 addr;
304} __packed __aligned(4);
305
306/* ADMA2 data alignment */
307#define SDHCI_ADMA2_ALIGN 4
308#define SDHCI_ADMA2_MASK (SDHCI_ADMA2_ALIGN - 1)
309
310/*
311 * ADMA2 descriptor alignment. Some controllers (e.g. Intel) require 8 byte
312 * alignment for the descriptor table even in 32-bit DMA mode. Memory
313 * allocation is at least 8 byte aligned anyway, so just stipulate 8 always.
314 */
315#define SDHCI_ADMA2_DESC_ALIGN 8
316
317/*
318 * ADMA2 64-bit DMA descriptor size
319 * According to SD Host Controller spec v4.10, there are two kinds of
320 * descriptors for 64-bit addressing mode: 96-bit Descriptor and 128-bit
321 * Descriptor, if Host Version 4 Enable is set in the Host Control 2
322 * register, 128-bit Descriptor will be selected.
323 */
324#define SDHCI_ADMA2_64_DESC_SZ(host) ((host)->v4_mode ? 16 : 12)
325
326/*
327 * ADMA2 64-bit descriptor. Note 12-byte descriptor can't always be 8-byte
328 * aligned.
329 */
330struct sdhci_adma2_64_desc {
331 __le16 cmd;
332 __le16 len;
333 __le32 addr_lo;
334 __le32 addr_hi;
335} __packed __aligned(4);
336
337#define ADMA2_TRAN_VALID 0x21
338#define ADMA2_NOP_END_VALID 0x3
339#define ADMA2_END 0x2
340
341/*
342 * Maximum segments assuming a 512KiB maximum requisition size and a minimum
343 * 4KiB page size. Note this also allows enough for multiple descriptors in
344 * case of PAGE_SIZE >= 64KiB.
345 */
346#define SDHCI_MAX_SEGS 128
347
348/* Allow for a command request and a data request at the same time */
349#define SDHCI_MAX_MRQS 2
350
351/*
352 * 48bit command and 136 bit response in 100KHz clock could take upto 2.48ms.
353 * However since the start time of the command, the time between
354 * command and response, and the time between response and start of data is
355 * not known, set the command transfer time to 10ms.
356 */
357#define MMC_CMD_TRANSFER_TIME (10 * NSEC_PER_MSEC) /* max 10 ms */
358
359#define sdhci_err_stats_inc(host, err_name) \
360 mmc_debugfs_err_stats_inc((host)->mmc, MMC_ERR_##err_name)
361
362enum sdhci_cookie {
363 COOKIE_UNMAPPED,
364 COOKIE_PRE_MAPPED, /* mapped by sdhci_pre_req() */
365 COOKIE_MAPPED, /* mapped by sdhci_prepare_data() */
366};
367
368struct sdhci_host {
369 /* Data set by hardware interface driver */
370 const char *hw_name; /* Hardware bus name */
371
372 unsigned int quirks; /* Deviations from spec. */
373
374/* Controller doesn't honor resets unless we touch the clock register */
375#define SDHCI_QUIRK_CLOCK_BEFORE_RESET (1<<0)
376/* Controller has bad caps bits, but really supports DMA */
377#define SDHCI_QUIRK_FORCE_DMA (1<<1)
378/* Controller doesn't like to be reset when there is no card inserted. */
379#define SDHCI_QUIRK_NO_CARD_NO_RESET (1<<2)
380/* Controller doesn't like clearing the power reg before a change */
381#define SDHCI_QUIRK_SINGLE_POWER_WRITE (1<<3)
382/* Controller has an unusable DMA engine */
383#define SDHCI_QUIRK_BROKEN_DMA (1<<5)
384/* Controller has an unusable ADMA engine */
385#define SDHCI_QUIRK_BROKEN_ADMA (1<<6)
386/* Controller can only DMA from 32-bit aligned addresses */
387#define SDHCI_QUIRK_32BIT_DMA_ADDR (1<<7)
388/* Controller can only DMA chunk sizes that are a multiple of 32 bits */
389#define SDHCI_QUIRK_32BIT_DMA_SIZE (1<<8)
390/* Controller can only ADMA chunks that are a multiple of 32 bits */
391#define SDHCI_QUIRK_32BIT_ADMA_SIZE (1<<9)
392/* Controller needs to be reset after each request to stay stable */
393#define SDHCI_QUIRK_RESET_AFTER_REQUEST (1<<10)
394/* Controller needs voltage and power writes to happen separately */
395#define SDHCI_QUIRK_NO_SIMULT_VDD_AND_POWER (1<<11)
396/* Controller provides an incorrect timeout value for transfers */
397#define SDHCI_QUIRK_BROKEN_TIMEOUT_VAL (1<<12)
398/* Controller has an issue with buffer bits for small transfers */
399#define SDHCI_QUIRK_BROKEN_SMALL_PIO (1<<13)
400/* Controller does not provide transfer-complete interrupt when not busy */
401#define SDHCI_QUIRK_NO_BUSY_IRQ (1<<14)
402/* Controller has unreliable card detection */
403#define SDHCI_QUIRK_BROKEN_CARD_DETECTION (1<<15)
404/* Controller reports inverted write-protect state */
405#define SDHCI_QUIRK_INVERTED_WRITE_PROTECT (1<<16)
406/* Controller has unusable command queue engine */
407#define SDHCI_QUIRK_BROKEN_CQE (1<<17)
408/* Controller does not like fast PIO transfers */
409#define SDHCI_QUIRK_PIO_NEEDS_DELAY (1<<18)
410/* Controller does not have a LED */
411#define SDHCI_QUIRK_NO_LED (1<<19)
412/* Controller has to be forced to use block size of 2048 bytes */
413#define SDHCI_QUIRK_FORCE_BLK_SZ_2048 (1<<20)
414/* Controller cannot do multi-block transfers */
415#define SDHCI_QUIRK_NO_MULTIBLOCK (1<<21)
416/* Controller can only handle 1-bit data transfers */
417#define SDHCI_QUIRK_FORCE_1_BIT_DATA (1<<22)
418/* Controller needs 10ms delay between applying power and clock */
419#define SDHCI_QUIRK_DELAY_AFTER_POWER (1<<23)
420/* Controller uses SDCLK instead of TMCLK for data timeouts */
421#define SDHCI_QUIRK_DATA_TIMEOUT_USES_SDCLK (1<<24)
422/* Controller reports wrong base clock capability */
423#define SDHCI_QUIRK_CAP_CLOCK_BASE_BROKEN (1<<25)
424/* Controller cannot support End Attribute in NOP ADMA descriptor */
425#define SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC (1<<26)
426/* Controller is missing device caps. Use caps provided by host */
427#define SDHCI_QUIRK_MISSING_CAPS (1<<27)
428/* Controller uses Auto CMD12 command to stop the transfer */
429#define SDHCI_QUIRK_MULTIBLOCK_READ_ACMD12 (1<<28)
430/* Controller doesn't have HISPD bit field in HI-SPEED SD card */
431#define SDHCI_QUIRK_NO_HISPD_BIT (1<<29)
432/* Controller treats ADMA descriptors with length 0000h incorrectly */
433#define SDHCI_QUIRK_BROKEN_ADMA_ZEROLEN_DESC (1<<30)
434/* The read-only detection via SDHCI_PRESENT_STATE register is unstable */
435#define SDHCI_QUIRK_UNSTABLE_RO_DETECT (1<<31)
436
437 unsigned int quirks2; /* More deviations from spec. */
438
439#define SDHCI_QUIRK2_HOST_OFF_CARD_ON (1<<0)
440#define SDHCI_QUIRK2_HOST_NO_CMD23 (1<<1)
441/* The system physically doesn't support 1.8v, even if the host does */
442#define SDHCI_QUIRK2_NO_1_8_V (1<<2)
443#define SDHCI_QUIRK2_PRESET_VALUE_BROKEN (1<<3)
444#define SDHCI_QUIRK2_CARD_ON_NEEDS_BUS_ON (1<<4)
445/* Controller has a non-standard host control register */
446#define SDHCI_QUIRK2_BROKEN_HOST_CONTROL (1<<5)
447/* Controller does not support HS200 */
448#define SDHCI_QUIRK2_BROKEN_HS200 (1<<6)
449/* Controller does not support DDR50 */
450#define SDHCI_QUIRK2_BROKEN_DDR50 (1<<7)
451/* Stop command (CMD12) can set Transfer Complete when not using MMC_RSP_BUSY */
452#define SDHCI_QUIRK2_STOP_WITH_TC (1<<8)
453/* Controller does not support 64-bit DMA */
454#define SDHCI_QUIRK2_BROKEN_64_BIT_DMA (1<<9)
455/* need clear transfer mode register before send cmd */
456#define SDHCI_QUIRK2_CLEAR_TRANSFERMODE_REG_BEFORE_CMD (1<<10)
457/* Capability register bit-63 indicates HS400 support */
458#define SDHCI_QUIRK2_CAPS_BIT63_FOR_HS400 (1<<11)
459/* forced tuned clock */
460#define SDHCI_QUIRK2_TUNING_WORK_AROUND (1<<12)
461/* disable the block count for single block transactions */
462#define SDHCI_QUIRK2_SUPPORT_SINGLE (1<<13)
463/* Controller broken with using ACMD23 */
464#define SDHCI_QUIRK2_ACMD23_BROKEN (1<<14)
465/* Broken Clock divider zero in controller */
466#define SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN (1<<15)
467/* Controller has CRC in 136 bit Command Response */
468#define SDHCI_QUIRK2_RSP_136_HAS_CRC (1<<16)
469/*
470 * Disable HW timeout if the requested timeout is more than the maximum
471 * obtainable timeout.
472 */
473#define SDHCI_QUIRK2_DISABLE_HW_TIMEOUT (1<<17)
474/*
475 * 32-bit block count may not support eMMC where upper bits of CMD23 are used
476 * for other purposes. Consequently we support 16-bit block count by default.
477 * Otherwise, SDHCI_QUIRK2_USE_32BIT_BLK_CNT can be selected to use 32-bit
478 * block count.
479 */
480#define SDHCI_QUIRK2_USE_32BIT_BLK_CNT (1<<18)
481/* Issue CMD and DATA reset together */
482#define SDHCI_QUIRK2_ISSUE_CMD_DAT_RESET_TOGETHER (1<<19)
483
484 int irq; /* Device IRQ */
485 void __iomem *ioaddr; /* Mapped address */
486 phys_addr_t mapbase; /* physical address base */
487 char *bounce_buffer; /* For packing SDMA reads/writes */
488 dma_addr_t bounce_addr;
489 unsigned int bounce_buffer_size;
490
491 const struct sdhci_ops *ops; /* Low level hw interface */
492
493 /* Internal data */
494 struct mmc_host *mmc; /* MMC structure */
495 struct mmc_host_ops mmc_host_ops; /* MMC host ops */
496 u64 dma_mask; /* custom DMA mask */
497
498#if IS_ENABLED(CONFIG_LEDS_CLASS)
499 struct led_classdev led; /* LED control */
500 char led_name[32];
501#endif
502
503 spinlock_t lock; /* Mutex */
504
505 int flags; /* Host attributes */
506#define SDHCI_USE_SDMA (1<<0) /* Host is SDMA capable */
507#define SDHCI_USE_ADMA (1<<1) /* Host is ADMA capable */
508#define SDHCI_REQ_USE_DMA (1<<2) /* Use DMA for this req. */
509#define SDHCI_DEVICE_DEAD (1<<3) /* Device unresponsive */
510#define SDHCI_SDR50_NEEDS_TUNING (1<<4) /* SDR50 needs tuning */
511#define SDHCI_AUTO_CMD12 (1<<6) /* Auto CMD12 support */
512#define SDHCI_AUTO_CMD23 (1<<7) /* Auto CMD23 support */
513#define SDHCI_PV_ENABLED (1<<8) /* Preset value enabled */
514#define SDHCI_USE_64_BIT_DMA (1<<12) /* Use 64-bit DMA */
515#define SDHCI_HS400_TUNING (1<<13) /* Tuning for HS400 */
516#define SDHCI_SIGNALING_330 (1<<14) /* Host is capable of 3.3V signaling */
517#define SDHCI_SIGNALING_180 (1<<15) /* Host is capable of 1.8V signaling */
518#define SDHCI_SIGNALING_120 (1<<16) /* Host is capable of 1.2V signaling */
519
520 unsigned int version; /* SDHCI spec. version */
521
522 unsigned int max_clk; /* Max possible freq (MHz) */
523 unsigned int timeout_clk; /* Timeout freq (KHz) */
524 u8 max_timeout_count; /* Vendor specific max timeout count */
525 unsigned int clk_mul; /* Clock Muliplier value */
526
527 unsigned int clock; /* Current clock (MHz) */
528 u8 pwr; /* Current voltage */
529 u8 drv_type; /* Current UHS-I driver type */
530 bool reinit_uhs; /* Force UHS-related re-initialization */
531
532 bool runtime_suspended; /* Host is runtime suspended */
533 bool bus_on; /* Bus power prevents runtime suspend */
534 bool preset_enabled; /* Preset is enabled */
535 bool pending_reset; /* Cmd/data reset is pending */
536 bool irq_wake_enabled; /* IRQ wakeup is enabled */
537 bool v4_mode; /* Host Version 4 Enable */
538 bool use_external_dma; /* Host selects to use external DMA */
539 bool always_defer_done; /* Always defer to complete requests */
540
541 struct mmc_request *mrqs_done[SDHCI_MAX_MRQS]; /* Requests done */
542 struct mmc_command *cmd; /* Current command */
543 struct mmc_command *data_cmd; /* Current data command */
544 struct mmc_command *deferred_cmd; /* Deferred command */
545 struct mmc_data *data; /* Current data request */
546 unsigned int data_early:1; /* Data finished before cmd */
547
548 struct sg_mapping_iter sg_miter; /* SG state for PIO */
549 unsigned int blocks; /* remaining PIO blocks */
550
551 int sg_count; /* Mapped sg entries */
552 int max_adma; /* Max. length in ADMA descriptor */
553
554 void *adma_table; /* ADMA descriptor table */
555 void *align_buffer; /* Bounce buffer */
556
557 size_t adma_table_sz; /* ADMA descriptor table size */
558 size_t align_buffer_sz; /* Bounce buffer size */
559
560 dma_addr_t adma_addr; /* Mapped ADMA descr. table */
561 dma_addr_t align_addr; /* Mapped bounce buffer */
562
563 unsigned int desc_sz; /* ADMA current descriptor size */
564 unsigned int alloc_desc_sz; /* ADMA descr. max size host supports */
565
566 struct workqueue_struct *complete_wq; /* Request completion wq */
567 struct work_struct complete_work; /* Request completion work */
568
569 struct timer_list timer; /* Timer for timeouts */
570 struct timer_list data_timer; /* Timer for data timeouts */
571
572#if IS_ENABLED(CONFIG_MMC_SDHCI_EXTERNAL_DMA)
573 struct dma_chan *rx_chan;
574 struct dma_chan *tx_chan;
575#endif
576
577 u32 caps; /* CAPABILITY_0 */
578 u32 caps1; /* CAPABILITY_1 */
579 bool read_caps; /* Capability flags have been read */
580
581 bool sdhci_core_to_disable_vqmmc; /* sdhci core can disable vqmmc */
582 unsigned int ocr_avail_sdio; /* OCR bit masks */
583 unsigned int ocr_avail_sd;
584 unsigned int ocr_avail_mmc;
585 u32 ocr_mask; /* available voltages */
586
587 unsigned timing; /* Current timing */
588
589 u32 thread_isr;
590
591 /* cached registers */
592 u32 ier;
593
594 bool cqe_on; /* CQE is operating */
595 u32 cqe_ier; /* CQE interrupt mask */
596 u32 cqe_err_ier; /* CQE error interrupt mask */
597
598 wait_queue_head_t buf_ready_int; /* Waitqueue for Buffer Read Ready interrupt */
599 unsigned int tuning_done; /* Condition flag set when CMD19 succeeds */
600
601 unsigned int tuning_count; /* Timer count for re-tuning */
602 unsigned int tuning_mode; /* Re-tuning mode supported by host */
603 unsigned int tuning_err; /* Error code for re-tuning */
604#define SDHCI_TUNING_MODE_1 0
605#define SDHCI_TUNING_MODE_2 1
606#define SDHCI_TUNING_MODE_3 2
607 /* Delay (ms) between tuning commands */
608 int tuning_delay;
609 int tuning_loop_count;
610
611 /* Host SDMA buffer boundary. */
612 u32 sdma_boundary;
613
614 /* Host ADMA table count */
615 u32 adma_table_cnt;
616
617 u64 data_timeout;
618
619 unsigned long private[] ____cacheline_aligned;
620};
621
622struct sdhci_ops {
623#ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS
624 u32 (*read_l)(struct sdhci_host *host, int reg);
625 u16 (*read_w)(struct sdhci_host *host, int reg);
626 u8 (*read_b)(struct sdhci_host *host, int reg);
627 void (*write_l)(struct sdhci_host *host, u32 val, int reg);
628 void (*write_w)(struct sdhci_host *host, u16 val, int reg);
629 void (*write_b)(struct sdhci_host *host, u8 val, int reg);
630#endif
631
632 void (*set_clock)(struct sdhci_host *host, unsigned int clock);
633 void (*set_power)(struct sdhci_host *host, unsigned char mode,
634 unsigned short vdd);
635
636 u32 (*irq)(struct sdhci_host *host, u32 intmask);
637
638 int (*set_dma_mask)(struct sdhci_host *host);
639 int (*enable_dma)(struct sdhci_host *host);
640 unsigned int (*get_max_clock)(struct sdhci_host *host);
641 unsigned int (*get_min_clock)(struct sdhci_host *host);
642 /* get_timeout_clock should return clk rate in unit of Hz */
643 unsigned int (*get_timeout_clock)(struct sdhci_host *host);
644 unsigned int (*get_max_timeout_count)(struct sdhci_host *host);
645 void (*set_timeout)(struct sdhci_host *host,
646 struct mmc_command *cmd);
647 void (*set_bus_width)(struct sdhci_host *host, int width);
648 void (*platform_send_init_74_clocks)(struct sdhci_host *host,
649 u8 power_mode);
650 unsigned int (*get_ro)(struct sdhci_host *host);
651 void (*reset)(struct sdhci_host *host, u8 mask);
652 int (*platform_execute_tuning)(struct sdhci_host *host, u32 opcode);
653 void (*set_uhs_signaling)(struct sdhci_host *host, unsigned int uhs);
654 void (*hw_reset)(struct sdhci_host *host);
655 void (*adma_workaround)(struct sdhci_host *host, u32 intmask);
656 void (*card_event)(struct sdhci_host *host);
657 void (*voltage_switch)(struct sdhci_host *host);
658 void (*adma_write_desc)(struct sdhci_host *host, void **desc,
659 dma_addr_t addr, int len, unsigned int cmd);
660 void (*copy_to_bounce_buffer)(struct sdhci_host *host,
661 struct mmc_data *data,
662 unsigned int length);
663 void (*request_done)(struct sdhci_host *host,
664 struct mmc_request *mrq);
665 void (*dump_vendor_regs)(struct sdhci_host *host);
666};
667
668#ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS
669
670static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg)
671{
672 if (unlikely(host->ops->write_l))
673 host->ops->write_l(host, val, reg);
674 else
675 writel(val, host->ioaddr + reg);
676}
677
678static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg)
679{
680 if (unlikely(host->ops->write_w))
681 host->ops->write_w(host, val, reg);
682 else
683 writew(val, host->ioaddr + reg);
684}
685
686static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg)
687{
688 if (unlikely(host->ops->write_b))
689 host->ops->write_b(host, val, reg);
690 else
691 writeb(val, host->ioaddr + reg);
692}
693
694static inline u32 sdhci_readl(struct sdhci_host *host, int reg)
695{
696 if (unlikely(host->ops->read_l))
697 return host->ops->read_l(host, reg);
698 else
699 return readl(host->ioaddr + reg);
700}
701
702static inline u16 sdhci_readw(struct sdhci_host *host, int reg)
703{
704 if (unlikely(host->ops->read_w))
705 return host->ops->read_w(host, reg);
706 else
707 return readw(host->ioaddr + reg);
708}
709
710static inline u8 sdhci_readb(struct sdhci_host *host, int reg)
711{
712 if (unlikely(host->ops->read_b))
713 return host->ops->read_b(host, reg);
714 else
715 return readb(host->ioaddr + reg);
716}
717
718#else
719
720static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg)
721{
722 writel(val, host->ioaddr + reg);
723}
724
725static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg)
726{
727 writew(val, host->ioaddr + reg);
728}
729
730static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg)
731{
732 writeb(val, host->ioaddr + reg);
733}
734
735static inline u32 sdhci_readl(struct sdhci_host *host, int reg)
736{
737 return readl(host->ioaddr + reg);
738}
739
740static inline u16 sdhci_readw(struct sdhci_host *host, int reg)
741{
742 return readw(host->ioaddr + reg);
743}
744
745static inline u8 sdhci_readb(struct sdhci_host *host, int reg)
746{
747 return readb(host->ioaddr + reg);
748}
749
750#endif /* CONFIG_MMC_SDHCI_IO_ACCESSORS */
751
752struct sdhci_host *sdhci_alloc_host(struct device *dev, size_t priv_size);
753void sdhci_free_host(struct sdhci_host *host);
754
755static inline void *sdhci_priv(struct sdhci_host *host)
756{
757 return host->private;
758}
759
760void __sdhci_read_caps(struct sdhci_host *host, const u16 *ver,
761 const u32 *caps, const u32 *caps1);
762int sdhci_setup_host(struct sdhci_host *host);
763void sdhci_cleanup_host(struct sdhci_host *host);
764int __sdhci_add_host(struct sdhci_host *host);
765int sdhci_add_host(struct sdhci_host *host);
766void sdhci_remove_host(struct sdhci_host *host, int dead);
767
768static inline void sdhci_read_caps(struct sdhci_host *host)
769{
770 __sdhci_read_caps(host, NULL, NULL, NULL);
771}
772
773u16 sdhci_calc_clk(struct sdhci_host *host, unsigned int clock,
774 unsigned int *actual_clock);
775void sdhci_set_clock(struct sdhci_host *host, unsigned int clock);
776void sdhci_enable_clk(struct sdhci_host *host, u16 clk);
777void sdhci_set_power(struct sdhci_host *host, unsigned char mode,
778 unsigned short vdd);
779void sdhci_set_power_and_bus_voltage(struct sdhci_host *host,
780 unsigned char mode,
781 unsigned short vdd);
782void sdhci_set_power_noreg(struct sdhci_host *host, unsigned char mode,
783 unsigned short vdd);
784int sdhci_get_cd_nogpio(struct mmc_host *mmc);
785void sdhci_request(struct mmc_host *mmc, struct mmc_request *mrq);
786int sdhci_request_atomic(struct mmc_host *mmc, struct mmc_request *mrq);
787void sdhci_set_bus_width(struct sdhci_host *host, int width);
788void sdhci_reset(struct sdhci_host *host, u8 mask);
789void sdhci_set_uhs_signaling(struct sdhci_host *host, unsigned timing);
790int sdhci_execute_tuning(struct mmc_host *mmc, u32 opcode);
791void sdhci_set_ios(struct mmc_host *mmc, struct mmc_ios *ios);
792int sdhci_start_signal_voltage_switch(struct mmc_host *mmc,
793 struct mmc_ios *ios);
794void sdhci_enable_sdio_irq(struct mmc_host *mmc, int enable);
795void sdhci_adma_write_desc(struct sdhci_host *host, void **desc,
796 dma_addr_t addr, int len, unsigned int cmd);
797
798#ifdef CONFIG_PM
799int sdhci_suspend_host(struct sdhci_host *host);
800int sdhci_resume_host(struct sdhci_host *host);
801int sdhci_runtime_suspend_host(struct sdhci_host *host);
802int sdhci_runtime_resume_host(struct sdhci_host *host, int soft_reset);
803#endif
804
805void sdhci_cqe_enable(struct mmc_host *mmc);
806void sdhci_cqe_disable(struct mmc_host *mmc, bool recovery);
807bool sdhci_cqe_irq(struct sdhci_host *host, u32 intmask, int *cmd_error,
808 int *data_error);
809
810void sdhci_dumpregs(struct sdhci_host *host);
811void sdhci_enable_v4_mode(struct sdhci_host *host);
812
813void sdhci_start_tuning(struct sdhci_host *host);
814void sdhci_end_tuning(struct sdhci_host *host);
815void sdhci_reset_tuning(struct sdhci_host *host);
816void sdhci_send_tuning(struct sdhci_host *host, u32 opcode);
817void sdhci_abort_tuning(struct sdhci_host *host, u32 opcode);
818void sdhci_switch_external_dma(struct sdhci_host *host, bool en);
819void sdhci_set_data_timeout_irq(struct sdhci_host *host, bool enable);
820void __sdhci_set_timeout(struct sdhci_host *host, struct mmc_command *cmd);
821
822#endif /* __SDHCI_HW_H */
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 * linux/drivers/mmc/host/sdhci.h - Secure Digital Host Controller Interface driver
4 *
5 * Header file for Host Controller registers and I/O accessors.
6 *
7 * Copyright (C) 2005-2008 Pierre Ossman, All Rights Reserved.
8 */
9#ifndef __SDHCI_HW_H
10#define __SDHCI_HW_H
11
12#include <linux/bits.h>
13#include <linux/scatterlist.h>
14#include <linux/compiler.h>
15#include <linux/types.h>
16#include <linux/io.h>
17#include <linux/leds.h>
18#include <linux/interrupt.h>
19
20#include <linux/mmc/host.h>
21
22/*
23 * Controller registers
24 */
25
26#define SDHCI_DMA_ADDRESS 0x00
27#define SDHCI_ARGUMENT2 SDHCI_DMA_ADDRESS
28#define SDHCI_32BIT_BLK_CNT SDHCI_DMA_ADDRESS
29
30#define SDHCI_BLOCK_SIZE 0x04
31#define SDHCI_MAKE_BLKSZ(dma, blksz) (((dma & 0x7) << 12) | (blksz & 0xFFF))
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
40#define SDHCI_TRNS_AUTO_CMD12 0x04
41#define SDHCI_TRNS_AUTO_CMD23 0x08
42#define SDHCI_TRNS_AUTO_SEL 0x0C
43#define SDHCI_TRNS_READ 0x10
44#define SDHCI_TRNS_MULTI 0x20
45
46#define SDHCI_COMMAND 0x0E
47#define SDHCI_CMD_RESP_MASK 0x03
48#define SDHCI_CMD_CRC 0x08
49#define SDHCI_CMD_INDEX 0x10
50#define SDHCI_CMD_DATA 0x20
51#define SDHCI_CMD_ABORTCMD 0xC0
52
53#define SDHCI_CMD_RESP_NONE 0x00
54#define SDHCI_CMD_RESP_LONG 0x01
55#define SDHCI_CMD_RESP_SHORT 0x02
56#define SDHCI_CMD_RESP_SHORT_BUSY 0x03
57
58#define SDHCI_MAKE_CMD(c, f) (((c & 0xff) << 8) | (f & 0xff))
59#define SDHCI_GET_CMD(c) ((c>>8) & 0x3f)
60
61#define SDHCI_RESPONSE 0x10
62
63#define SDHCI_BUFFER 0x20
64
65#define SDHCI_PRESENT_STATE 0x24
66#define SDHCI_CMD_INHIBIT 0x00000001
67#define SDHCI_DATA_INHIBIT 0x00000002
68#define SDHCI_DOING_WRITE 0x00000100
69#define SDHCI_DOING_READ 0x00000200
70#define SDHCI_SPACE_AVAILABLE 0x00000400
71#define SDHCI_DATA_AVAILABLE 0x00000800
72#define SDHCI_CARD_PRESENT 0x00010000
73#define SDHCI_CARD_PRES_SHIFT 16
74#define SDHCI_CD_STABLE 0x00020000
75#define SDHCI_CD_LVL 0x00040000
76#define SDHCI_CD_LVL_SHIFT 18
77#define SDHCI_WRITE_PROTECT 0x00080000
78#define SDHCI_DATA_LVL_MASK 0x00F00000
79#define SDHCI_DATA_LVL_SHIFT 20
80#define SDHCI_DATA_0_LVL_MASK 0x00100000
81#define SDHCI_CMD_LVL 0x01000000
82
83#define SDHCI_HOST_CONTROL 0x28
84#define SDHCI_CTRL_LED 0x01
85#define SDHCI_CTRL_4BITBUS 0x02
86#define SDHCI_CTRL_HISPD 0x04
87#define SDHCI_CTRL_DMA_MASK 0x18
88#define SDHCI_CTRL_SDMA 0x00
89#define SDHCI_CTRL_ADMA1 0x08
90#define SDHCI_CTRL_ADMA32 0x10
91#define SDHCI_CTRL_ADMA64 0x18
92#define SDHCI_CTRL_ADMA3 0x18
93#define SDHCI_CTRL_8BITBUS 0x20
94#define SDHCI_CTRL_CDTEST_INS 0x40
95#define SDHCI_CTRL_CDTEST_EN 0x80
96
97#define SDHCI_POWER_CONTROL 0x29
98#define SDHCI_POWER_ON 0x01
99#define SDHCI_POWER_180 0x0A
100#define SDHCI_POWER_300 0x0C
101#define SDHCI_POWER_330 0x0E
102/*
103 * VDD2 - UHS2 or PCIe/NVMe
104 * VDD2 power on/off and voltage select
105 */
106#define SDHCI_VDD2_POWER_ON 0x10
107#define SDHCI_VDD2_POWER_120 0x80
108#define SDHCI_VDD2_POWER_180 0xA0
109
110#define SDHCI_BLOCK_GAP_CONTROL 0x2A
111
112#define SDHCI_WAKE_UP_CONTROL 0x2B
113#define SDHCI_WAKE_ON_INT 0x01
114#define SDHCI_WAKE_ON_INSERT 0x02
115#define SDHCI_WAKE_ON_REMOVE 0x04
116
117#define SDHCI_CLOCK_CONTROL 0x2C
118#define SDHCI_DIVIDER_SHIFT 8
119#define SDHCI_DIVIDER_HI_SHIFT 6
120#define SDHCI_DIV_MASK 0xFF
121#define SDHCI_DIV_MASK_LEN 8
122#define SDHCI_DIV_HI_MASK 0x300
123#define SDHCI_PROG_CLOCK_MODE 0x0020
124#define SDHCI_CLOCK_CARD_EN 0x0004
125#define SDHCI_CLOCK_PLL_EN 0x0008
126#define SDHCI_CLOCK_INT_STABLE 0x0002
127#define SDHCI_CLOCK_INT_EN 0x0001
128
129#define SDHCI_TIMEOUT_CONTROL 0x2E
130
131#define SDHCI_SOFTWARE_RESET 0x2F
132#define SDHCI_RESET_ALL 0x01
133#define SDHCI_RESET_CMD 0x02
134#define SDHCI_RESET_DATA 0x04
135
136#define SDHCI_INT_STATUS 0x30
137#define SDHCI_INT_ENABLE 0x34
138#define SDHCI_SIGNAL_ENABLE 0x38
139#define SDHCI_INT_RESPONSE 0x00000001
140#define SDHCI_INT_DATA_END 0x00000002
141#define SDHCI_INT_BLK_GAP 0x00000004
142#define SDHCI_INT_DMA_END 0x00000008
143#define SDHCI_INT_SPACE_AVAIL 0x00000010
144#define SDHCI_INT_DATA_AVAIL 0x00000020
145#define SDHCI_INT_CARD_INSERT 0x00000040
146#define SDHCI_INT_CARD_REMOVE 0x00000080
147#define SDHCI_INT_CARD_INT 0x00000100
148#define SDHCI_INT_RETUNE 0x00001000
149#define SDHCI_INT_CQE 0x00004000
150#define SDHCI_INT_ERROR 0x00008000
151#define SDHCI_INT_TIMEOUT 0x00010000
152#define SDHCI_INT_CRC 0x00020000
153#define SDHCI_INT_END_BIT 0x00040000
154#define SDHCI_INT_INDEX 0x00080000
155#define SDHCI_INT_DATA_TIMEOUT 0x00100000
156#define SDHCI_INT_DATA_CRC 0x00200000
157#define SDHCI_INT_DATA_END_BIT 0x00400000
158#define SDHCI_INT_BUS_POWER 0x00800000
159#define SDHCI_INT_AUTO_CMD_ERR 0x01000000
160#define SDHCI_INT_ADMA_ERROR 0x02000000
161
162#define SDHCI_INT_NORMAL_MASK 0x00007FFF
163#define SDHCI_INT_ERROR_MASK 0xFFFF8000
164
165#define SDHCI_INT_CMD_MASK (SDHCI_INT_RESPONSE | SDHCI_INT_TIMEOUT | \
166 SDHCI_INT_CRC | SDHCI_INT_END_BIT | SDHCI_INT_INDEX | \
167 SDHCI_INT_AUTO_CMD_ERR)
168#define SDHCI_INT_DATA_MASK (SDHCI_INT_DATA_END | SDHCI_INT_DMA_END | \
169 SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL | \
170 SDHCI_INT_DATA_TIMEOUT | SDHCI_INT_DATA_CRC | \
171 SDHCI_INT_DATA_END_BIT | SDHCI_INT_ADMA_ERROR | \
172 SDHCI_INT_BLK_GAP)
173#define SDHCI_INT_ALL_MASK ((unsigned int)-1)
174
175#define SDHCI_CQE_INT_ERR_MASK ( \
176 SDHCI_INT_ADMA_ERROR | SDHCI_INT_BUS_POWER | SDHCI_INT_DATA_END_BIT | \
177 SDHCI_INT_DATA_CRC | SDHCI_INT_DATA_TIMEOUT | SDHCI_INT_INDEX | \
178 SDHCI_INT_END_BIT | SDHCI_INT_CRC | SDHCI_INT_TIMEOUT)
179
180#define SDHCI_CQE_INT_MASK (SDHCI_CQE_INT_ERR_MASK | SDHCI_INT_CQE)
181
182#define SDHCI_AUTO_CMD_STATUS 0x3C
183#define SDHCI_AUTO_CMD_TIMEOUT 0x00000002
184#define SDHCI_AUTO_CMD_CRC 0x00000004
185#define SDHCI_AUTO_CMD_END_BIT 0x00000008
186#define SDHCI_AUTO_CMD_INDEX 0x00000010
187
188#define SDHCI_HOST_CONTROL2 0x3E
189#define SDHCI_CTRL_UHS_MASK 0x0007
190#define SDHCI_CTRL_UHS_SDR12 0x0000
191#define SDHCI_CTRL_UHS_SDR25 0x0001
192#define SDHCI_CTRL_UHS_SDR50 0x0002
193#define SDHCI_CTRL_UHS_SDR104 0x0003
194#define SDHCI_CTRL_UHS_DDR50 0x0004
195#define SDHCI_CTRL_HS400 0x0005 /* Non-standard */
196#define SDHCI_CTRL_VDD_180 0x0008
197#define SDHCI_CTRL_DRV_TYPE_MASK 0x0030
198#define SDHCI_CTRL_DRV_TYPE_B 0x0000
199#define SDHCI_CTRL_DRV_TYPE_A 0x0010
200#define SDHCI_CTRL_DRV_TYPE_C 0x0020
201#define SDHCI_CTRL_DRV_TYPE_D 0x0030
202#define SDHCI_CTRL_EXEC_TUNING 0x0040
203#define SDHCI_CTRL_TUNED_CLK 0x0080
204#define SDHCI_CMD23_ENABLE 0x0800
205#define SDHCI_CTRL_V4_MODE 0x1000
206#define SDHCI_CTRL_64BIT_ADDR 0x2000
207#define SDHCI_CTRL_PRESET_VAL_ENABLE 0x8000
208
209#define SDHCI_CAPABILITIES 0x40
210#define SDHCI_TIMEOUT_CLK_MASK GENMASK(5, 0)
211#define SDHCI_TIMEOUT_CLK_SHIFT 0
212#define SDHCI_TIMEOUT_CLK_UNIT 0x00000080
213#define SDHCI_CLOCK_BASE_MASK GENMASK(13, 8)
214#define SDHCI_CLOCK_BASE_SHIFT 8
215#define SDHCI_CLOCK_V3_BASE_MASK GENMASK(15, 8)
216#define SDHCI_MAX_BLOCK_MASK 0x00030000
217#define SDHCI_MAX_BLOCK_SHIFT 16
218#define SDHCI_CAN_DO_8BIT 0x00040000
219#define SDHCI_CAN_DO_ADMA2 0x00080000
220#define SDHCI_CAN_DO_ADMA1 0x00100000
221#define SDHCI_CAN_DO_HISPD 0x00200000
222#define SDHCI_CAN_DO_SDMA 0x00400000
223#define SDHCI_CAN_DO_SUSPEND 0x00800000
224#define SDHCI_CAN_VDD_330 0x01000000
225#define SDHCI_CAN_VDD_300 0x02000000
226#define SDHCI_CAN_VDD_180 0x04000000
227#define SDHCI_CAN_64BIT_V4 0x08000000
228#define SDHCI_CAN_64BIT 0x10000000
229
230#define SDHCI_CAPABILITIES_1 0x44
231#define SDHCI_SUPPORT_SDR50 0x00000001
232#define SDHCI_SUPPORT_SDR104 0x00000002
233#define SDHCI_SUPPORT_DDR50 0x00000004
234#define SDHCI_DRIVER_TYPE_A 0x00000010
235#define SDHCI_DRIVER_TYPE_C 0x00000020
236#define SDHCI_DRIVER_TYPE_D 0x00000040
237#define SDHCI_RETUNING_TIMER_COUNT_MASK GENMASK(11, 8)
238#define SDHCI_USE_SDR50_TUNING 0x00002000
239#define SDHCI_RETUNING_MODE_MASK GENMASK(15, 14)
240#define SDHCI_CLOCK_MUL_MASK GENMASK(23, 16)
241#define SDHCI_CAN_DO_ADMA3 0x08000000
242#define SDHCI_SUPPORT_HS400 0x80000000 /* Non-standard */
243
244#define SDHCI_MAX_CURRENT 0x48
245#define SDHCI_MAX_CURRENT_LIMIT GENMASK(7, 0)
246#define SDHCI_MAX_CURRENT_330_MASK GENMASK(7, 0)
247#define SDHCI_MAX_CURRENT_300_MASK GENMASK(15, 8)
248#define SDHCI_MAX_CURRENT_180_MASK GENMASK(23, 16)
249#define SDHCI_MAX_CURRENT_MULTIPLIER 4
250
251/* 4C-4F reserved for more max current */
252
253#define SDHCI_SET_ACMD12_ERROR 0x50
254#define SDHCI_SET_INT_ERROR 0x52
255
256#define SDHCI_ADMA_ERROR 0x54
257
258/* 55-57 reserved */
259
260#define SDHCI_ADMA_ADDRESS 0x58
261#define SDHCI_ADMA_ADDRESS_HI 0x5C
262
263/* 60-FB reserved */
264
265#define SDHCI_PRESET_FOR_HIGH_SPEED 0x64
266#define SDHCI_PRESET_FOR_SDR12 0x66
267#define SDHCI_PRESET_FOR_SDR25 0x68
268#define SDHCI_PRESET_FOR_SDR50 0x6A
269#define SDHCI_PRESET_FOR_SDR104 0x6C
270#define SDHCI_PRESET_FOR_DDR50 0x6E
271#define SDHCI_PRESET_FOR_HS400 0x74 /* Non-standard */
272#define SDHCI_PRESET_DRV_MASK GENMASK(15, 14)
273#define SDHCI_PRESET_CLKGEN_SEL BIT(10)
274#define SDHCI_PRESET_SDCLK_FREQ_MASK GENMASK(9, 0)
275
276#define SDHCI_SLOT_INT_STATUS 0xFC
277
278#define SDHCI_HOST_VERSION 0xFE
279#define SDHCI_VENDOR_VER_MASK 0xFF00
280#define SDHCI_VENDOR_VER_SHIFT 8
281#define SDHCI_SPEC_VER_MASK 0x00FF
282#define SDHCI_SPEC_VER_SHIFT 0
283#define SDHCI_SPEC_100 0
284#define SDHCI_SPEC_200 1
285#define SDHCI_SPEC_300 2
286#define SDHCI_SPEC_400 3
287#define SDHCI_SPEC_410 4
288#define SDHCI_SPEC_420 5
289
290/*
291 * End of controller registers.
292 */
293
294#define SDHCI_MAX_DIV_SPEC_200 256
295#define SDHCI_MAX_DIV_SPEC_300 2046
296
297/*
298 * Host SDMA buffer boundary. Valid values from 4K to 512K in powers of 2.
299 */
300#define SDHCI_DEFAULT_BOUNDARY_SIZE (512 * 1024)
301#define SDHCI_DEFAULT_BOUNDARY_ARG (ilog2(SDHCI_DEFAULT_BOUNDARY_SIZE) - 12)
302
303/* ADMA2 32-bit DMA descriptor size */
304#define SDHCI_ADMA2_32_DESC_SZ 8
305
306/* ADMA2 32-bit descriptor */
307struct sdhci_adma2_32_desc {
308 __le16 cmd;
309 __le16 len;
310 __le32 addr;
311} __packed __aligned(4);
312
313/* ADMA2 data alignment */
314#define SDHCI_ADMA2_ALIGN 4
315#define SDHCI_ADMA2_MASK (SDHCI_ADMA2_ALIGN - 1)
316
317/*
318 * ADMA2 descriptor alignment. Some controllers (e.g. Intel) require 8 byte
319 * alignment for the descriptor table even in 32-bit DMA mode. Memory
320 * allocation is at least 8 byte aligned anyway, so just stipulate 8 always.
321 */
322#define SDHCI_ADMA2_DESC_ALIGN 8
323
324/*
325 * ADMA2 64-bit DMA descriptor size
326 * According to SD Host Controller spec v4.10, there are two kinds of
327 * descriptors for 64-bit addressing mode: 96-bit Descriptor and 128-bit
328 * Descriptor, if Host Version 4 Enable is set in the Host Control 2
329 * register, 128-bit Descriptor will be selected.
330 */
331#define SDHCI_ADMA2_64_DESC_SZ(host) ((host)->v4_mode ? 16 : 12)
332
333/*
334 * ADMA2 64-bit descriptor. Note 12-byte descriptor can't always be 8-byte
335 * aligned.
336 */
337struct sdhci_adma2_64_desc {
338 __le16 cmd;
339 __le16 len;
340 __le32 addr_lo;
341 __le32 addr_hi;
342} __packed __aligned(4);
343
344#define ADMA2_TRAN_VALID 0x21
345#define ADMA2_NOP_END_VALID 0x3
346#define ADMA2_END 0x2
347
348/*
349 * Maximum segments assuming a 512KiB maximum requisition size and a minimum
350 * 4KiB page size. Note this also allows enough for multiple descriptors in
351 * case of PAGE_SIZE >= 64KiB.
352 */
353#define SDHCI_MAX_SEGS 128
354
355/* Allow for a command request and a data request at the same time */
356#define SDHCI_MAX_MRQS 2
357
358/*
359 * 48bit command and 136 bit response in 100KHz clock could take upto 2.48ms.
360 * However since the start time of the command, the time between
361 * command and response, and the time between response and start of data is
362 * not known, set the command transfer time to 10ms.
363 */
364#define MMC_CMD_TRANSFER_TIME (10 * NSEC_PER_MSEC) /* max 10 ms */
365
366#define sdhci_err_stats_inc(host, err_name) \
367 mmc_debugfs_err_stats_inc((host)->mmc, MMC_ERR_##err_name)
368
369enum sdhci_cookie {
370 COOKIE_UNMAPPED,
371 COOKIE_PRE_MAPPED, /* mapped by sdhci_pre_req() */
372 COOKIE_MAPPED, /* mapped by sdhci_prepare_data() */
373};
374
375struct sdhci_host {
376 /* Data set by hardware interface driver */
377 const char *hw_name; /* Hardware bus name */
378
379 unsigned int quirks; /* Deviations from spec. */
380
381/* Controller doesn't honor resets unless we touch the clock register */
382#define SDHCI_QUIRK_CLOCK_BEFORE_RESET (1<<0)
383/* Controller has bad caps bits, but really supports DMA */
384#define SDHCI_QUIRK_FORCE_DMA (1<<1)
385/* Controller doesn't like to be reset when there is no card inserted. */
386#define SDHCI_QUIRK_NO_CARD_NO_RESET (1<<2)
387/* Controller doesn't like clearing the power reg before a change */
388#define SDHCI_QUIRK_SINGLE_POWER_WRITE (1<<3)
389/* Controller has an unusable DMA engine */
390#define SDHCI_QUIRK_BROKEN_DMA (1<<5)
391/* Controller has an unusable ADMA engine */
392#define SDHCI_QUIRK_BROKEN_ADMA (1<<6)
393/* Controller can only DMA from 32-bit aligned addresses */
394#define SDHCI_QUIRK_32BIT_DMA_ADDR (1<<7)
395/* Controller can only DMA chunk sizes that are a multiple of 32 bits */
396#define SDHCI_QUIRK_32BIT_DMA_SIZE (1<<8)
397/* Controller can only ADMA chunks that are a multiple of 32 bits */
398#define SDHCI_QUIRK_32BIT_ADMA_SIZE (1<<9)
399/* Controller needs to be reset after each request to stay stable */
400#define SDHCI_QUIRK_RESET_AFTER_REQUEST (1<<10)
401/* Controller needs voltage and power writes to happen separately */
402#define SDHCI_QUIRK_NO_SIMULT_VDD_AND_POWER (1<<11)
403/* Controller provides an incorrect timeout value for transfers */
404#define SDHCI_QUIRK_BROKEN_TIMEOUT_VAL (1<<12)
405/* Controller has an issue with buffer bits for small transfers */
406#define SDHCI_QUIRK_BROKEN_SMALL_PIO (1<<13)
407/* Controller does not provide transfer-complete interrupt when not busy */
408#define SDHCI_QUIRK_NO_BUSY_IRQ (1<<14)
409/* Controller has unreliable card detection */
410#define SDHCI_QUIRK_BROKEN_CARD_DETECTION (1<<15)
411/* Controller reports inverted write-protect state */
412#define SDHCI_QUIRK_INVERTED_WRITE_PROTECT (1<<16)
413/* Controller has unusable command queue engine */
414#define SDHCI_QUIRK_BROKEN_CQE (1<<17)
415/* Controller does not like fast PIO transfers */
416#define SDHCI_QUIRK_PIO_NEEDS_DELAY (1<<18)
417/* Controller does not have a LED */
418#define SDHCI_QUIRK_NO_LED (1<<19)
419/* Controller has to be forced to use block size of 2048 bytes */
420#define SDHCI_QUIRK_FORCE_BLK_SZ_2048 (1<<20)
421/* Controller cannot do multi-block transfers */
422#define SDHCI_QUIRK_NO_MULTIBLOCK (1<<21)
423/* Controller can only handle 1-bit data transfers */
424#define SDHCI_QUIRK_FORCE_1_BIT_DATA (1<<22)
425/* Controller needs 10ms delay between applying power and clock */
426#define SDHCI_QUIRK_DELAY_AFTER_POWER (1<<23)
427/* Controller uses SDCLK instead of TMCLK for data timeouts */
428#define SDHCI_QUIRK_DATA_TIMEOUT_USES_SDCLK (1<<24)
429/* Controller reports wrong base clock capability */
430#define SDHCI_QUIRK_CAP_CLOCK_BASE_BROKEN (1<<25)
431/* Controller cannot support End Attribute in NOP ADMA descriptor */
432#define SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC (1<<26)
433/* Controller uses Auto CMD12 command to stop the transfer */
434#define SDHCI_QUIRK_MULTIBLOCK_READ_ACMD12 (1<<28)
435/* Controller doesn't have HISPD bit field in HI-SPEED SD card */
436#define SDHCI_QUIRK_NO_HISPD_BIT (1<<29)
437/* Controller treats ADMA descriptors with length 0000h incorrectly */
438#define SDHCI_QUIRK_BROKEN_ADMA_ZEROLEN_DESC (1<<30)
439/* The read-only detection via SDHCI_PRESENT_STATE register is unstable */
440#define SDHCI_QUIRK_UNSTABLE_RO_DETECT (1<<31)
441
442 unsigned int quirks2; /* More deviations from spec. */
443
444#define SDHCI_QUIRK2_HOST_OFF_CARD_ON (1<<0)
445#define SDHCI_QUIRK2_HOST_NO_CMD23 (1<<1)
446/* The system physically doesn't support 1.8v, even if the host does */
447#define SDHCI_QUIRK2_NO_1_8_V (1<<2)
448#define SDHCI_QUIRK2_PRESET_VALUE_BROKEN (1<<3)
449#define SDHCI_QUIRK2_CARD_ON_NEEDS_BUS_ON (1<<4)
450/* Controller has a non-standard host control register */
451#define SDHCI_QUIRK2_BROKEN_HOST_CONTROL (1<<5)
452/* Controller does not support HS200 */
453#define SDHCI_QUIRK2_BROKEN_HS200 (1<<6)
454/* Controller does not support DDR50 */
455#define SDHCI_QUIRK2_BROKEN_DDR50 (1<<7)
456/* Stop command (CMD12) can set Transfer Complete when not using MMC_RSP_BUSY */
457#define SDHCI_QUIRK2_STOP_WITH_TC (1<<8)
458/* Controller does not support 64-bit DMA */
459#define SDHCI_QUIRK2_BROKEN_64_BIT_DMA (1<<9)
460/* need clear transfer mode register before send cmd */
461#define SDHCI_QUIRK2_CLEAR_TRANSFERMODE_REG_BEFORE_CMD (1<<10)
462/* Capability register bit-63 indicates HS400 support */
463#define SDHCI_QUIRK2_CAPS_BIT63_FOR_HS400 (1<<11)
464/* forced tuned clock */
465#define SDHCI_QUIRK2_TUNING_WORK_AROUND (1<<12)
466/* disable the block count for single block transactions */
467#define SDHCI_QUIRK2_SUPPORT_SINGLE (1<<13)
468/* Controller broken with using ACMD23 */
469#define SDHCI_QUIRK2_ACMD23_BROKEN (1<<14)
470/* Broken Clock divider zero in controller */
471#define SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN (1<<15)
472/* Controller has CRC in 136 bit Command Response */
473#define SDHCI_QUIRK2_RSP_136_HAS_CRC (1<<16)
474/*
475 * Disable HW timeout if the requested timeout is more than the maximum
476 * obtainable timeout.
477 */
478#define SDHCI_QUIRK2_DISABLE_HW_TIMEOUT (1<<17)
479/*
480 * 32-bit block count may not support eMMC where upper bits of CMD23 are used
481 * for other purposes. Consequently we support 16-bit block count by default.
482 * Otherwise, SDHCI_QUIRK2_USE_32BIT_BLK_CNT can be selected to use 32-bit
483 * block count.
484 */
485#define SDHCI_QUIRK2_USE_32BIT_BLK_CNT (1<<18)
486/* Issue CMD and DATA reset together */
487#define SDHCI_QUIRK2_ISSUE_CMD_DAT_RESET_TOGETHER (1<<19)
488
489 int irq; /* Device IRQ */
490 void __iomem *ioaddr; /* Mapped address */
491 phys_addr_t mapbase; /* physical address base */
492 char *bounce_buffer; /* For packing SDMA reads/writes */
493 dma_addr_t bounce_addr;
494 unsigned int bounce_buffer_size;
495
496 const struct sdhci_ops *ops; /* Low level hw interface */
497
498 /* Internal data */
499 struct mmc_host *mmc; /* MMC structure */
500 struct mmc_host_ops mmc_host_ops; /* MMC host ops */
501 u64 dma_mask; /* custom DMA mask */
502
503#if IS_ENABLED(CONFIG_LEDS_CLASS)
504 struct led_classdev led; /* LED control */
505 char led_name[32];
506#endif
507
508 spinlock_t lock; /* Mutex */
509
510 int flags; /* Host attributes */
511#define SDHCI_USE_SDMA (1<<0) /* Host is SDMA capable */
512#define SDHCI_USE_ADMA (1<<1) /* Host is ADMA capable */
513#define SDHCI_REQ_USE_DMA (1<<2) /* Use DMA for this req. */
514#define SDHCI_DEVICE_DEAD (1<<3) /* Device unresponsive */
515#define SDHCI_SDR50_NEEDS_TUNING (1<<4) /* SDR50 needs tuning */
516#define SDHCI_AUTO_CMD12 (1<<6) /* Auto CMD12 support */
517#define SDHCI_AUTO_CMD23 (1<<7) /* Auto CMD23 support */
518#define SDHCI_PV_ENABLED (1<<8) /* Preset value enabled */
519#define SDHCI_USE_64_BIT_DMA (1<<12) /* Use 64-bit DMA */
520#define SDHCI_HS400_TUNING (1<<13) /* Tuning for HS400 */
521#define SDHCI_SIGNALING_330 (1<<14) /* Host is capable of 3.3V signaling */
522#define SDHCI_SIGNALING_180 (1<<15) /* Host is capable of 1.8V signaling */
523#define SDHCI_SIGNALING_120 (1<<16) /* Host is capable of 1.2V signaling */
524
525 unsigned int version; /* SDHCI spec. version */
526
527 unsigned int max_clk; /* Max possible freq (MHz) */
528 unsigned int timeout_clk; /* Timeout freq (KHz) */
529 u8 max_timeout_count; /* Vendor specific max timeout count */
530 unsigned int clk_mul; /* Clock Muliplier value */
531
532 unsigned int clock; /* Current clock (MHz) */
533 u8 pwr; /* Current voltage */
534 u8 drv_type; /* Current UHS-I driver type */
535 bool reinit_uhs; /* Force UHS-related re-initialization */
536
537 bool runtime_suspended; /* Host is runtime suspended */
538 bool bus_on; /* Bus power prevents runtime suspend */
539 bool preset_enabled; /* Preset is enabled */
540 bool pending_reset; /* Cmd/data reset is pending */
541 bool irq_wake_enabled; /* IRQ wakeup is enabled */
542 bool v4_mode; /* Host Version 4 Enable */
543 bool use_external_dma; /* Host selects to use external DMA */
544 bool always_defer_done; /* Always defer to complete requests */
545
546 struct mmc_request *mrqs_done[SDHCI_MAX_MRQS]; /* Requests done */
547 struct mmc_command *cmd; /* Current command */
548 struct mmc_command *data_cmd; /* Current data command */
549 struct mmc_command *deferred_cmd; /* Deferred command */
550 struct mmc_data *data; /* Current data request */
551 unsigned int data_early:1; /* Data finished before cmd */
552
553 struct sg_mapping_iter sg_miter; /* SG state for PIO */
554 unsigned int blocks; /* remaining PIO blocks */
555
556 int sg_count; /* Mapped sg entries */
557 int max_adma; /* Max. length in ADMA descriptor */
558
559 void *adma_table; /* ADMA descriptor table */
560 void *align_buffer; /* Bounce buffer */
561
562 size_t adma_table_sz; /* ADMA descriptor table size */
563 size_t align_buffer_sz; /* Bounce buffer size */
564
565 dma_addr_t adma_addr; /* Mapped ADMA descr. table */
566 dma_addr_t align_addr; /* Mapped bounce buffer */
567
568 unsigned int desc_sz; /* ADMA current descriptor size */
569 unsigned int alloc_desc_sz; /* ADMA descr. max size host supports */
570
571 struct workqueue_struct *complete_wq; /* Request completion wq */
572 struct work_struct complete_work; /* Request completion work */
573
574 struct timer_list timer; /* Timer for timeouts */
575 struct timer_list data_timer; /* Timer for data timeouts */
576
577#if IS_ENABLED(CONFIG_MMC_SDHCI_EXTERNAL_DMA)
578 struct dma_chan *rx_chan;
579 struct dma_chan *tx_chan;
580#endif
581
582 u32 caps; /* CAPABILITY_0 */
583 u32 caps1; /* CAPABILITY_1 */
584 bool read_caps; /* Capability flags have been read */
585
586 bool sdhci_core_to_disable_vqmmc; /* sdhci core can disable vqmmc */
587 unsigned int ocr_avail_sdio; /* OCR bit masks */
588 unsigned int ocr_avail_sd;
589 unsigned int ocr_avail_mmc;
590 u32 ocr_mask; /* available voltages */
591
592 unsigned timing; /* Current timing */
593
594 u32 thread_isr;
595
596 /* cached registers */
597 u32 ier;
598
599 bool cqe_on; /* CQE is operating */
600 u32 cqe_ier; /* CQE interrupt mask */
601 u32 cqe_err_ier; /* CQE error interrupt mask */
602
603 wait_queue_head_t buf_ready_int; /* Waitqueue for Buffer Read Ready interrupt */
604 unsigned int tuning_done; /* Condition flag set when CMD19 succeeds */
605
606 unsigned int tuning_count; /* Timer count for re-tuning */
607 unsigned int tuning_mode; /* Re-tuning mode supported by host */
608 unsigned int tuning_err; /* Error code for re-tuning */
609#define SDHCI_TUNING_MODE_1 0
610#define SDHCI_TUNING_MODE_2 1
611#define SDHCI_TUNING_MODE_3 2
612 /* Delay (ms) between tuning commands */
613 int tuning_delay;
614 int tuning_loop_count;
615
616 /* Host SDMA buffer boundary. */
617 u32 sdma_boundary;
618
619 /* Host ADMA table count */
620 u32 adma_table_cnt;
621
622 u64 data_timeout;
623
624 unsigned long private[] ____cacheline_aligned;
625};
626
627struct sdhci_ops {
628#ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS
629 u32 (*read_l)(struct sdhci_host *host, int reg);
630 u16 (*read_w)(struct sdhci_host *host, int reg);
631 u8 (*read_b)(struct sdhci_host *host, int reg);
632 void (*write_l)(struct sdhci_host *host, u32 val, int reg);
633 void (*write_w)(struct sdhci_host *host, u16 val, int reg);
634 void (*write_b)(struct sdhci_host *host, u8 val, int reg);
635#endif
636
637 void (*set_clock)(struct sdhci_host *host, unsigned int clock);
638 void (*set_power)(struct sdhci_host *host, unsigned char mode,
639 unsigned short vdd);
640
641 u32 (*irq)(struct sdhci_host *host, u32 intmask);
642
643 int (*set_dma_mask)(struct sdhci_host *host);
644 int (*enable_dma)(struct sdhci_host *host);
645 unsigned int (*get_max_clock)(struct sdhci_host *host);
646 unsigned int (*get_min_clock)(struct sdhci_host *host);
647 /* get_timeout_clock should return clk rate in unit of Hz */
648 unsigned int (*get_timeout_clock)(struct sdhci_host *host);
649 unsigned int (*get_max_timeout_count)(struct sdhci_host *host);
650 void (*set_timeout)(struct sdhci_host *host,
651 struct mmc_command *cmd);
652 void (*set_bus_width)(struct sdhci_host *host, int width);
653 void (*platform_send_init_74_clocks)(struct sdhci_host *host,
654 u8 power_mode);
655 unsigned int (*get_ro)(struct sdhci_host *host);
656 void (*reset)(struct sdhci_host *host, u8 mask);
657 int (*platform_execute_tuning)(struct sdhci_host *host, u32 opcode);
658 void (*set_uhs_signaling)(struct sdhci_host *host, unsigned int uhs);
659 void (*hw_reset)(struct sdhci_host *host);
660 void (*adma_workaround)(struct sdhci_host *host, u32 intmask);
661 void (*card_event)(struct sdhci_host *host);
662 void (*voltage_switch)(struct sdhci_host *host);
663 void (*adma_write_desc)(struct sdhci_host *host, void **desc,
664 dma_addr_t addr, int len, unsigned int cmd);
665 void (*copy_to_bounce_buffer)(struct sdhci_host *host,
666 struct mmc_data *data,
667 unsigned int length);
668 void (*request_done)(struct sdhci_host *host,
669 struct mmc_request *mrq);
670 void (*dump_vendor_regs)(struct sdhci_host *host);
671};
672
673#ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS
674
675static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg)
676{
677 if (unlikely(host->ops->write_l))
678 host->ops->write_l(host, val, reg);
679 else
680 writel(val, host->ioaddr + reg);
681}
682
683static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg)
684{
685 if (unlikely(host->ops->write_w))
686 host->ops->write_w(host, val, reg);
687 else
688 writew(val, host->ioaddr + reg);
689}
690
691static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg)
692{
693 if (unlikely(host->ops->write_b))
694 host->ops->write_b(host, val, reg);
695 else
696 writeb(val, host->ioaddr + reg);
697}
698
699static inline u32 sdhci_readl(struct sdhci_host *host, int reg)
700{
701 if (unlikely(host->ops->read_l))
702 return host->ops->read_l(host, reg);
703 else
704 return readl(host->ioaddr + reg);
705}
706
707static inline u16 sdhci_readw(struct sdhci_host *host, int reg)
708{
709 if (unlikely(host->ops->read_w))
710 return host->ops->read_w(host, reg);
711 else
712 return readw(host->ioaddr + reg);
713}
714
715static inline u8 sdhci_readb(struct sdhci_host *host, int reg)
716{
717 if (unlikely(host->ops->read_b))
718 return host->ops->read_b(host, reg);
719 else
720 return readb(host->ioaddr + reg);
721}
722
723#else
724
725static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg)
726{
727 writel(val, host->ioaddr + reg);
728}
729
730static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg)
731{
732 writew(val, host->ioaddr + reg);
733}
734
735static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg)
736{
737 writeb(val, host->ioaddr + reg);
738}
739
740static inline u32 sdhci_readl(struct sdhci_host *host, int reg)
741{
742 return readl(host->ioaddr + reg);
743}
744
745static inline u16 sdhci_readw(struct sdhci_host *host, int reg)
746{
747 return readw(host->ioaddr + reg);
748}
749
750static inline u8 sdhci_readb(struct sdhci_host *host, int reg)
751{
752 return readb(host->ioaddr + reg);
753}
754
755#endif /* CONFIG_MMC_SDHCI_IO_ACCESSORS */
756
757struct sdhci_host *sdhci_alloc_host(struct device *dev, size_t priv_size);
758void sdhci_free_host(struct sdhci_host *host);
759
760static inline void *sdhci_priv(struct sdhci_host *host)
761{
762 return host->private;
763}
764
765void __sdhci_read_caps(struct sdhci_host *host, const u16 *ver,
766 const u32 *caps, const u32 *caps1);
767int sdhci_setup_host(struct sdhci_host *host);
768void sdhci_cleanup_host(struct sdhci_host *host);
769int __sdhci_add_host(struct sdhci_host *host);
770int sdhci_add_host(struct sdhci_host *host);
771void sdhci_remove_host(struct sdhci_host *host, int dead);
772
773static inline void sdhci_read_caps(struct sdhci_host *host)
774{
775 __sdhci_read_caps(host, NULL, NULL, NULL);
776}
777
778u16 sdhci_calc_clk(struct sdhci_host *host, unsigned int clock,
779 unsigned int *actual_clock);
780void sdhci_set_clock(struct sdhci_host *host, unsigned int clock);
781void sdhci_enable_clk(struct sdhci_host *host, u16 clk);
782void sdhci_set_power(struct sdhci_host *host, unsigned char mode,
783 unsigned short vdd);
784void sdhci_set_power_and_bus_voltage(struct sdhci_host *host,
785 unsigned char mode,
786 unsigned short vdd);
787void sdhci_set_power_noreg(struct sdhci_host *host, unsigned char mode,
788 unsigned short vdd);
789int sdhci_get_cd_nogpio(struct mmc_host *mmc);
790void sdhci_request(struct mmc_host *mmc, struct mmc_request *mrq);
791int sdhci_request_atomic(struct mmc_host *mmc, struct mmc_request *mrq);
792void sdhci_set_bus_width(struct sdhci_host *host, int width);
793void sdhci_reset(struct sdhci_host *host, u8 mask);
794void sdhci_set_uhs_signaling(struct sdhci_host *host, unsigned timing);
795int sdhci_execute_tuning(struct mmc_host *mmc, u32 opcode);
796int __sdhci_execute_tuning(struct sdhci_host *host, u32 opcode);
797void sdhci_set_ios(struct mmc_host *mmc, struct mmc_ios *ios);
798int sdhci_start_signal_voltage_switch(struct mmc_host *mmc,
799 struct mmc_ios *ios);
800void sdhci_enable_sdio_irq(struct mmc_host *mmc, int enable);
801void sdhci_adma_write_desc(struct sdhci_host *host, void **desc,
802 dma_addr_t addr, int len, unsigned int cmd);
803
804#ifdef CONFIG_PM
805int sdhci_suspend_host(struct sdhci_host *host);
806int sdhci_resume_host(struct sdhci_host *host);
807int sdhci_runtime_suspend_host(struct sdhci_host *host);
808int sdhci_runtime_resume_host(struct sdhci_host *host, int soft_reset);
809#endif
810
811void sdhci_cqe_enable(struct mmc_host *mmc);
812void sdhci_cqe_disable(struct mmc_host *mmc, bool recovery);
813bool sdhci_cqe_irq(struct sdhci_host *host, u32 intmask, int *cmd_error,
814 int *data_error);
815
816void sdhci_dumpregs(struct sdhci_host *host);
817void sdhci_enable_v4_mode(struct sdhci_host *host);
818
819void sdhci_start_tuning(struct sdhci_host *host);
820void sdhci_end_tuning(struct sdhci_host *host);
821void sdhci_reset_tuning(struct sdhci_host *host);
822void sdhci_send_tuning(struct sdhci_host *host, u32 opcode);
823void sdhci_abort_tuning(struct sdhci_host *host, u32 opcode);
824void sdhci_switch_external_dma(struct sdhci_host *host, bool en);
825void sdhci_set_data_timeout_irq(struct sdhci_host *host, bool enable);
826void __sdhci_set_timeout(struct sdhci_host *host, struct mmc_command *cmd);
827
828#endif /* __SDHCI_HW_H */