blob: 609f87ca536b845abf355ac9032cdc3c45c25ce2 [file] [log] [blame]
Pierre Ossmand129bce2006-03-24 03:18:17 -08001/*
Pierre Ossman70f10482007-07-11 20:04:50 +02002 * linux/drivers/mmc/host/sdhci.h - Secure Digital Host Controller Interface driver
Pierre Ossmand129bce2006-03-24 03:18:17 -08003 *
Giuseppe Cavallaro1978fda2010-09-28 10:41:29 +02004 * Header file for Host Controller registers and I/O accessors.
5 *
Pierre Ossmanb69c9052008-03-08 23:44:25 +01006 * Copyright (C) 2005-2008 Pierre Ossman, All Rights Reserved.
Pierre Ossmand129bce2006-03-24 03:18:17 -08007 *
8 * This program is free software; you can redistribute it and/or modify
Pierre Ossman643f7202006-09-30 23:27:52 -07009 * 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.
Pierre Ossmand129bce2006-03-24 03:18:17 -080012 */
Giuseppe Cavallaro1978fda2010-09-28 10:41:29 +020013#ifndef __SDHCI_HW_H
14#define __SDHCI_HW_H
Pierre Ossmand129bce2006-03-24 03:18:17 -080015
Andrew Morton0c7ad102008-07-25 19:44:35 -070016#include <linux/scatterlist.h>
Anton Vorontsov4e4141a2009-03-17 00:13:46 +030017#include <linux/compiler.h>
18#include <linux/types.h>
19#include <linux/io.h>
Andrew Morton0c7ad102008-07-25 19:44:35 -070020
Ulf Hansson83f13cc2015-03-04 10:19:14 +010021#include <linux/mmc/host.h>
Giuseppe Cavallaro1978fda2010-09-28 10:41:29 +020022
Pierre Ossmand129bce2006-03-24 03:18:17 -080023/*
Pierre Ossmand129bce2006-03-24 03:18:17 -080024 * Controller registers
25 */
26
27#define SDHCI_DMA_ADDRESS 0x00
Andrei Warkentin8edf63712011-05-23 15:06:39 -050028#define SDHCI_ARGUMENT2 SDHCI_DMA_ADDRESS
Pierre Ossmand129bce2006-03-24 03:18:17 -080029
30#define SDHCI_BLOCK_SIZE 0x04
Pierre Ossmanbab76962006-07-02 16:51:35 +010031#define SDHCI_MAKE_BLKSZ(dma, blksz) (((dma & 0x7) << 12) | (blksz & 0xFFF))
Pierre Ossmand129bce2006-03-24 03:18:17 -080032
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
Andrei Warkentine89d4562011-05-23 15:06:37 -050040#define SDHCI_TRNS_AUTO_CMD12 0x04
Andrei Warkentin8edf63712011-05-23 15:06:39 -050041#define SDHCI_TRNS_AUTO_CMD23 0x08
Pierre Ossmand129bce2006-03-24 03:18:17 -080042#define SDHCI_TRNS_READ 0x10
43#define SDHCI_TRNS_MULTI 0x20
44
45#define SDHCI_COMMAND 0x0E
46#define SDHCI_CMD_RESP_MASK 0x03
47#define SDHCI_CMD_CRC 0x08
48#define SDHCI_CMD_INDEX 0x10
49#define SDHCI_CMD_DATA 0x20
Richard Zhu574e3f52011-03-21 13:22:14 +080050#define SDHCI_CMD_ABORTCMD 0xC0
Pierre Ossmand129bce2006-03-24 03:18:17 -080051
52#define SDHCI_CMD_RESP_NONE 0x00
53#define SDHCI_CMD_RESP_LONG 0x01
54#define SDHCI_CMD_RESP_SHORT 0x02
55#define SDHCI_CMD_RESP_SHORT_BUSY 0x03
56
57#define SDHCI_MAKE_CMD(c, f) (((c & 0xff) << 8) | (f & 0xff))
Aries Lee22113ef2010-12-15 08:14:24 +010058#define SDHCI_GET_CMD(c) ((c>>8) & 0x3f)
Pierre Ossmand129bce2006-03-24 03:18:17 -080059
60#define SDHCI_RESPONSE 0x10
61
62#define SDHCI_BUFFER 0x20
63
64#define SDHCI_PRESENT_STATE 0x24
65#define SDHCI_CMD_INHIBIT 0x00000001
66#define SDHCI_DATA_INHIBIT 0x00000002
67#define SDHCI_DOING_WRITE 0x00000100
68#define SDHCI_DOING_READ 0x00000200
69#define SDHCI_SPACE_AVAILABLE 0x00000400
70#define SDHCI_DATA_AVAILABLE 0x00000800
71#define SDHCI_CARD_PRESENT 0x00010000
72#define SDHCI_WRITE_PROTECT 0x00080000
Arindam Nathf2119df2011-05-05 12:18:57 +053073#define SDHCI_DATA_LVL_MASK 0x00F00000
74#define SDHCI_DATA_LVL_SHIFT 20
Yi Sun7756a96d2014-09-09 02:13:59 +000075#define SDHCI_DATA_0_LVL_MASK 0x00100000
Pierre Ossmand129bce2006-03-24 03:18:17 -080076
Arindam Nathd6d50a12011-05-05 12:18:59 +053077#define SDHCI_HOST_CONTROL 0x28
Pierre Ossmand129bce2006-03-24 03:18:17 -080078#define SDHCI_CTRL_LED 0x01
79#define SDHCI_CTRL_4BITBUS 0x02
Pierre Ossman077df882006-11-08 23:06:35 +010080#define SDHCI_CTRL_HISPD 0x04
Pierre Ossman2134a922008-06-28 18:28:51 +020081#define SDHCI_CTRL_DMA_MASK 0x18
82#define SDHCI_CTRL_SDMA 0x00
83#define SDHCI_CTRL_ADMA1 0x08
84#define SDHCI_CTRL_ADMA32 0x10
85#define SDHCI_CTRL_ADMA64 0x18
Philip Rakity15ec4462010-11-19 16:48:39 -050086#define SDHCI_CTRL_8BITBUS 0x20
Pierre Ossmand129bce2006-03-24 03:18:17 -080087
88#define SDHCI_POWER_CONTROL 0x29
Pierre Ossman146ad662006-06-30 02:22:23 -070089#define SDHCI_POWER_ON 0x01
90#define SDHCI_POWER_180 0x0A
91#define SDHCI_POWER_300 0x0C
92#define SDHCI_POWER_330 0x0E
Pierre Ossmand129bce2006-03-24 03:18:17 -080093
94#define SDHCI_BLOCK_GAP_CONTROL 0x2A
95
Nicolas Pitre2df3b712007-09-29 10:46:20 -040096#define SDHCI_WAKE_UP_CONTROL 0x2B
Daniel Drake5f619702010-11-04 22:20:39 +000097#define SDHCI_WAKE_ON_INT 0x01
98#define SDHCI_WAKE_ON_INSERT 0x02
99#define SDHCI_WAKE_ON_REMOVE 0x04
Pierre Ossmand129bce2006-03-24 03:18:17 -0800100
101#define SDHCI_CLOCK_CONTROL 0x2C
102#define SDHCI_DIVIDER_SHIFT 8
Zhangfei Gao85105c52010-08-06 07:10:01 +0800103#define SDHCI_DIVIDER_HI_SHIFT 6
104#define SDHCI_DIV_MASK 0xFF
105#define SDHCI_DIV_MASK_LEN 8
106#define SDHCI_DIV_HI_MASK 0x300
Arindam Nathc3ed3872011-05-05 12:19:06 +0530107#define SDHCI_PROG_CLOCK_MODE 0x0020
Pierre Ossmand129bce2006-03-24 03:18:17 -0800108#define SDHCI_CLOCK_CARD_EN 0x0004
109#define SDHCI_CLOCK_INT_STABLE 0x0002
110#define SDHCI_CLOCK_INT_EN 0x0001
111
112#define SDHCI_TIMEOUT_CONTROL 0x2E
113
114#define SDHCI_SOFTWARE_RESET 0x2F
115#define SDHCI_RESET_ALL 0x01
116#define SDHCI_RESET_CMD 0x02
117#define SDHCI_RESET_DATA 0x04
118
119#define SDHCI_INT_STATUS 0x30
120#define SDHCI_INT_ENABLE 0x34
121#define SDHCI_SIGNAL_ENABLE 0x38
122#define SDHCI_INT_RESPONSE 0x00000001
123#define SDHCI_INT_DATA_END 0x00000002
Haijun Zhanga4071fb2012-12-04 10:41:28 +0800124#define SDHCI_INT_BLK_GAP 0x00000004
Pierre Ossmand129bce2006-03-24 03:18:17 -0800125#define SDHCI_INT_DMA_END 0x00000008
Pierre Ossmana406f5a2006-07-02 16:50:59 +0100126#define SDHCI_INT_SPACE_AVAIL 0x00000010
127#define SDHCI_INT_DATA_AVAIL 0x00000020
Pierre Ossmand129bce2006-03-24 03:18:17 -0800128#define SDHCI_INT_CARD_INSERT 0x00000040
129#define SDHCI_INT_CARD_REMOVE 0x00000080
130#define SDHCI_INT_CARD_INT 0x00000100
Pierre Ossman964f9ce2007-07-20 18:20:36 +0200131#define SDHCI_INT_ERROR 0x00008000
Pierre Ossmand129bce2006-03-24 03:18:17 -0800132#define SDHCI_INT_TIMEOUT 0x00010000
133#define SDHCI_INT_CRC 0x00020000
134#define SDHCI_INT_END_BIT 0x00040000
135#define SDHCI_INT_INDEX 0x00080000
136#define SDHCI_INT_DATA_TIMEOUT 0x00100000
137#define SDHCI_INT_DATA_CRC 0x00200000
138#define SDHCI_INT_DATA_END_BIT 0x00400000
139#define SDHCI_INT_BUS_POWER 0x00800000
140#define SDHCI_INT_ACMD12ERR 0x01000000
Pierre Ossman2134a922008-06-28 18:28:51 +0200141#define SDHCI_INT_ADMA_ERROR 0x02000000
Pierre Ossmand129bce2006-03-24 03:18:17 -0800142
143#define SDHCI_INT_NORMAL_MASK 0x00007FFF
144#define SDHCI_INT_ERROR_MASK 0xFFFF8000
145
146#define SDHCI_INT_CMD_MASK (SDHCI_INT_RESPONSE | SDHCI_INT_TIMEOUT | \
147 SDHCI_INT_CRC | SDHCI_INT_END_BIT | SDHCI_INT_INDEX)
148#define SDHCI_INT_DATA_MASK (SDHCI_INT_DATA_END | SDHCI_INT_DMA_END | \
Pierre Ossmana406f5a2006-07-02 16:50:59 +0100149 SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL | \
Pierre Ossmand129bce2006-03-24 03:18:17 -0800150 SDHCI_INT_DATA_TIMEOUT | SDHCI_INT_DATA_CRC | \
Haijun Zhanga4071fb2012-12-04 10:41:28 +0800151 SDHCI_INT_DATA_END_BIT | SDHCI_INT_ADMA_ERROR | \
152 SDHCI_INT_BLK_GAP)
Anton Vorontsov7260cf52009-03-17 00:13:48 +0300153#define SDHCI_INT_ALL_MASK ((unsigned int)-1)
Pierre Ossmand129bce2006-03-24 03:18:17 -0800154
155#define SDHCI_ACMD12_ERR 0x3C
156
Arindam Nathf2119df2011-05-05 12:18:57 +0530157#define SDHCI_HOST_CONTROL2 0x3E
Arindam Nath49c468f2011-05-05 12:19:01 +0530158#define SDHCI_CTRL_UHS_MASK 0x0007
159#define SDHCI_CTRL_UHS_SDR12 0x0000
160#define SDHCI_CTRL_UHS_SDR25 0x0001
161#define SDHCI_CTRL_UHS_SDR50 0x0002
162#define SDHCI_CTRL_UHS_SDR104 0x0003
163#define SDHCI_CTRL_UHS_DDR50 0x0004
Adrian Huntere9fb05d2014-11-06 15:19:06 +0200164#define SDHCI_CTRL_HS400 0x0005 /* Non-standard */
Arindam Nathf2119df2011-05-05 12:18:57 +0530165#define SDHCI_CTRL_VDD_180 0x0008
Arindam Nathd6d50a12011-05-05 12:18:59 +0530166#define SDHCI_CTRL_DRV_TYPE_MASK 0x0030
167#define SDHCI_CTRL_DRV_TYPE_B 0x0000
168#define SDHCI_CTRL_DRV_TYPE_A 0x0010
169#define SDHCI_CTRL_DRV_TYPE_C 0x0020
170#define SDHCI_CTRL_DRV_TYPE_D 0x0030
Arindam Nathb513ea22011-05-05 12:19:04 +0530171#define SDHCI_CTRL_EXEC_TUNING 0x0040
172#define SDHCI_CTRL_TUNED_CLK 0x0080
Arindam Nathd6d50a12011-05-05 12:18:59 +0530173#define SDHCI_CTRL_PRESET_VAL_ENABLE 0x8000
Pierre Ossmand129bce2006-03-24 03:18:17 -0800174
175#define SDHCI_CAPABILITIES 0x40
Pierre Ossman1c8cde92006-06-30 02:22:25 -0700176#define SDHCI_TIMEOUT_CLK_MASK 0x0000003F
177#define SDHCI_TIMEOUT_CLK_SHIFT 0
178#define SDHCI_TIMEOUT_CLK_UNIT 0x00000080
Pierre Ossmand129bce2006-03-24 03:18:17 -0800179#define SDHCI_CLOCK_BASE_MASK 0x00003F00
Zhangfei Gaoc4687d52010-08-20 14:02:36 -0400180#define SDHCI_CLOCK_V3_BASE_MASK 0x0000FF00
Pierre Ossmand129bce2006-03-24 03:18:17 -0800181#define SDHCI_CLOCK_BASE_SHIFT 8
Pierre Ossman1d676e02006-07-02 16:52:10 +0100182#define SDHCI_MAX_BLOCK_MASK 0x00030000
183#define SDHCI_MAX_BLOCK_SHIFT 16
Philip Rakity15ec4462010-11-19 16:48:39 -0500184#define SDHCI_CAN_DO_8BIT 0x00040000
Pierre Ossman2134a922008-06-28 18:28:51 +0200185#define SDHCI_CAN_DO_ADMA2 0x00080000
186#define SDHCI_CAN_DO_ADMA1 0x00100000
Pierre Ossman077df882006-11-08 23:06:35 +0100187#define SDHCI_CAN_DO_HISPD 0x00200000
Richard Röjforsa13abc72009-09-22 16:45:30 -0700188#define SDHCI_CAN_DO_SDMA 0x00400000
Pierre Ossman146ad662006-06-30 02:22:23 -0700189#define SDHCI_CAN_VDD_330 0x01000000
190#define SDHCI_CAN_VDD_300 0x02000000
191#define SDHCI_CAN_VDD_180 0x04000000
Pierre Ossman2134a922008-06-28 18:28:51 +0200192#define SDHCI_CAN_64BIT 0x10000000
Pierre Ossmand129bce2006-03-24 03:18:17 -0800193
Arindam Nathf2119df2011-05-05 12:18:57 +0530194#define SDHCI_SUPPORT_SDR50 0x00000001
195#define SDHCI_SUPPORT_SDR104 0x00000002
196#define SDHCI_SUPPORT_DDR50 0x00000004
Arindam Nathd6d50a12011-05-05 12:18:59 +0530197#define SDHCI_DRIVER_TYPE_A 0x00000010
198#define SDHCI_DRIVER_TYPE_C 0x00000020
199#define SDHCI_DRIVER_TYPE_D 0x00000040
Arindam Nathcf2b5ee2011-05-05 12:19:07 +0530200#define SDHCI_RETUNING_TIMER_COUNT_MASK 0x00000F00
201#define SDHCI_RETUNING_TIMER_COUNT_SHIFT 8
202#define SDHCI_USE_SDR50_TUNING 0x00002000
203#define SDHCI_RETUNING_MODE_MASK 0x0000C000
204#define SDHCI_RETUNING_MODE_SHIFT 14
Arindam Nathc3ed3872011-05-05 12:19:06 +0530205#define SDHCI_CLOCK_MUL_MASK 0x00FF0000
206#define SDHCI_CLOCK_MUL_SHIFT 16
Adrian Huntere9fb05d2014-11-06 15:19:06 +0200207#define SDHCI_SUPPORT_HS400 0x80000000 /* Non-standard */
Arindam Nathf2119df2011-05-05 12:18:57 +0530208
Philip Rakitye8120ad2010-11-30 00:55:23 -0500209#define SDHCI_CAPABILITIES_1 0x44
Pierre Ossmand129bce2006-03-24 03:18:17 -0800210
Arindam Nathf2119df2011-05-05 12:18:57 +0530211#define SDHCI_MAX_CURRENT 0x48
Philip Rakitybad37e12012-05-27 18:36:44 -0700212#define SDHCI_MAX_CURRENT_LIMIT 0xFF
Arindam Nathf2119df2011-05-05 12:18:57 +0530213#define SDHCI_MAX_CURRENT_330_MASK 0x0000FF
214#define SDHCI_MAX_CURRENT_330_SHIFT 0
215#define SDHCI_MAX_CURRENT_300_MASK 0x00FF00
216#define SDHCI_MAX_CURRENT_300_SHIFT 8
217#define SDHCI_MAX_CURRENT_180_MASK 0xFF0000
218#define SDHCI_MAX_CURRENT_180_SHIFT 16
219#define SDHCI_MAX_CURRENT_MULTIPLIER 4
Pierre Ossmand129bce2006-03-24 03:18:17 -0800220
221/* 4C-4F reserved for more max current */
222
Pierre Ossman2134a922008-06-28 18:28:51 +0200223#define SDHCI_SET_ACMD12_ERROR 0x50
224#define SDHCI_SET_INT_ERROR 0x52
225
226#define SDHCI_ADMA_ERROR 0x54
227
228/* 55-57 reserved */
229
230#define SDHCI_ADMA_ADDRESS 0x58
Adrian Huntere57a5f62014-11-04 12:42:46 +0200231#define SDHCI_ADMA_ADDRESS_HI 0x5C
Pierre Ossman2134a922008-06-28 18:28:51 +0200232
233/* 60-FB reserved */
Pierre Ossmand129bce2006-03-24 03:18:17 -0800234
Kevin Liu52983382013-01-31 11:31:37 +0800235#define SDHCI_PRESET_FOR_SDR12 0x66
236#define SDHCI_PRESET_FOR_SDR25 0x68
237#define SDHCI_PRESET_FOR_SDR50 0x6A
238#define SDHCI_PRESET_FOR_SDR104 0x6C
239#define SDHCI_PRESET_FOR_DDR50 0x6E
Adrian Huntere9fb05d2014-11-06 15:19:06 +0200240#define SDHCI_PRESET_FOR_HS400 0x74 /* Non-standard */
Kevin Liu52983382013-01-31 11:31:37 +0800241#define SDHCI_PRESET_DRV_MASK 0xC000
242#define SDHCI_PRESET_DRV_SHIFT 14
243#define SDHCI_PRESET_CLKGEN_SEL_MASK 0x400
244#define SDHCI_PRESET_CLKGEN_SEL_SHIFT 10
245#define SDHCI_PRESET_SDCLK_FREQ_MASK 0x3FF
246#define SDHCI_PRESET_SDCLK_FREQ_SHIFT 0
247
Pierre Ossmand129bce2006-03-24 03:18:17 -0800248#define SDHCI_SLOT_INT_STATUS 0xFC
249
250#define SDHCI_HOST_VERSION 0xFE
Pierre Ossman4a965502006-06-30 02:22:29 -0700251#define SDHCI_VENDOR_VER_MASK 0xFF00
252#define SDHCI_VENDOR_VER_SHIFT 8
253#define SDHCI_SPEC_VER_MASK 0x00FF
254#define SDHCI_SPEC_VER_SHIFT 0
Pierre Ossman2134a922008-06-28 18:28:51 +0200255#define SDHCI_SPEC_100 0
256#define SDHCI_SPEC_200 1
Zhangfei Gao85105c52010-08-06 07:10:01 +0800257#define SDHCI_SPEC_300 2
Pierre Ossmand129bce2006-03-24 03:18:17 -0800258
Zhangfei Gao03975262010-09-20 15:15:18 -0400259/*
260 * End of controller registers.
261 */
262
263#define SDHCI_MAX_DIV_SPEC_200 256
264#define SDHCI_MAX_DIV_SPEC_300 2046
265
Mikko Vinnif6a03cb2011-04-12 09:36:18 -0400266/*
267 * Host SDMA buffer boundary. Valid values from 4K to 512K in powers of 2.
268 */
269#define SDHCI_DEFAULT_BOUNDARY_SIZE (512 * 1024)
270#define SDHCI_DEFAULT_BOUNDARY_ARG (ilog2(SDHCI_DEFAULT_BOUNDARY_SIZE) - 12)
271
Adrian Hunter739d46d2014-11-04 12:42:44 +0200272/* ADMA2 32-bit DMA descriptor size */
273#define SDHCI_ADMA2_32_DESC_SZ 8
274
Adrian Hunter05452302014-11-04 12:42:45 +0200275/* ADMA2 32-bit descriptor */
276struct sdhci_adma2_32_desc {
277 __le16 cmd;
278 __le16 len;
279 __le32 addr;
Adrian Hunter04a5ae62015-11-26 14:00:49 +0200280} __packed __aligned(4);
281
282/* ADMA2 data alignment */
283#define SDHCI_ADMA2_ALIGN 4
284#define SDHCI_ADMA2_MASK (SDHCI_ADMA2_ALIGN - 1)
285
286/*
287 * ADMA2 descriptor alignment. Some controllers (e.g. Intel) require 8 byte
288 * alignment for the descriptor table even in 32-bit DMA mode. Memory
289 * allocation is at least 8 byte aligned anyway, so just stipulate 8 always.
290 */
291#define SDHCI_ADMA2_DESC_ALIGN 8
Adrian Hunter05452302014-11-04 12:42:45 +0200292
Adrian Huntere57a5f62014-11-04 12:42:46 +0200293/* ADMA2 64-bit DMA descriptor size */
294#define SDHCI_ADMA2_64_DESC_SZ 12
295
Adrian Huntere57a5f62014-11-04 12:42:46 +0200296/*
297 * ADMA2 64-bit descriptor. Note 12-byte descriptor can't always be 8-byte
298 * aligned.
299 */
300struct sdhci_adma2_64_desc {
301 __le16 cmd;
302 __le16 len;
303 __le32 addr_lo;
304 __le32 addr_hi;
305} __packed __aligned(4);
306
Adrian Hunter739d46d2014-11-04 12:42:44 +0200307#define ADMA2_TRAN_VALID 0x21
308#define ADMA2_NOP_END_VALID 0x3
309#define ADMA2_END 0x2
310
Adrian Hunter4fb213f2014-11-04 12:42:43 +0200311/*
312 * Maximum segments assuming a 512KiB maximum requisition size and a minimum
313 * 4KiB page size.
314 */
315#define SDHCI_MAX_SEGS 128
316
Haibo Chend31911b2015-08-25 10:02:11 +0800317enum sdhci_cookie {
318 COOKIE_UNMAPPED,
Russell King94538e52016-01-26 13:40:37 +0000319 COOKIE_PRE_MAPPED, /* mapped by sdhci_pre_req() */
320 COOKIE_MAPPED, /* mapped by sdhci_prepare_data() */
Ulf Hansson83f13cc2015-03-04 10:19:14 +0100321};
322
323struct sdhci_host {
324 /* Data set by hardware interface driver */
325 const char *hw_name; /* Hardware bus name */
326
327 unsigned int quirks; /* Deviations from spec. */
328
329/* Controller doesn't honor resets unless we touch the clock register */
330#define SDHCI_QUIRK_CLOCK_BEFORE_RESET (1<<0)
331/* Controller has bad caps bits, but really supports DMA */
332#define SDHCI_QUIRK_FORCE_DMA (1<<1)
333/* Controller doesn't like to be reset when there is no card inserted. */
334#define SDHCI_QUIRK_NO_CARD_NO_RESET (1<<2)
335/* Controller doesn't like clearing the power reg before a change */
336#define SDHCI_QUIRK_SINGLE_POWER_WRITE (1<<3)
337/* Controller has flaky internal state so reset it on each ios change */
338#define SDHCI_QUIRK_RESET_CMD_DATA_ON_IOS (1<<4)
339/* Controller has an unusable DMA engine */
340#define SDHCI_QUIRK_BROKEN_DMA (1<<5)
341/* Controller has an unusable ADMA engine */
342#define SDHCI_QUIRK_BROKEN_ADMA (1<<6)
343/* Controller can only DMA from 32-bit aligned addresses */
344#define SDHCI_QUIRK_32BIT_DMA_ADDR (1<<7)
345/* Controller can only DMA chunk sizes that are a multiple of 32 bits */
346#define SDHCI_QUIRK_32BIT_DMA_SIZE (1<<8)
347/* Controller can only ADMA chunks that are a multiple of 32 bits */
348#define SDHCI_QUIRK_32BIT_ADMA_SIZE (1<<9)
349/* Controller needs to be reset after each request to stay stable */
350#define SDHCI_QUIRK_RESET_AFTER_REQUEST (1<<10)
351/* Controller needs voltage and power writes to happen separately */
352#define SDHCI_QUIRK_NO_SIMULT_VDD_AND_POWER (1<<11)
353/* Controller provides an incorrect timeout value for transfers */
354#define SDHCI_QUIRK_BROKEN_TIMEOUT_VAL (1<<12)
355/* Controller has an issue with buffer bits for small transfers */
356#define SDHCI_QUIRK_BROKEN_SMALL_PIO (1<<13)
357/* Controller does not provide transfer-complete interrupt when not busy */
358#define SDHCI_QUIRK_NO_BUSY_IRQ (1<<14)
359/* Controller has unreliable card detection */
360#define SDHCI_QUIRK_BROKEN_CARD_DETECTION (1<<15)
361/* Controller reports inverted write-protect state */
362#define SDHCI_QUIRK_INVERTED_WRITE_PROTECT (1<<16)
363/* Controller does not like fast PIO transfers */
364#define SDHCI_QUIRK_PIO_NEEDS_DELAY (1<<18)
365/* Controller has to be forced to use block size of 2048 bytes */
366#define SDHCI_QUIRK_FORCE_BLK_SZ_2048 (1<<20)
367/* Controller cannot do multi-block transfers */
368#define SDHCI_QUIRK_NO_MULTIBLOCK (1<<21)
369/* Controller can only handle 1-bit data transfers */
370#define SDHCI_QUIRK_FORCE_1_BIT_DATA (1<<22)
371/* Controller needs 10ms delay between applying power and clock */
372#define SDHCI_QUIRK_DELAY_AFTER_POWER (1<<23)
373/* Controller uses SDCLK instead of TMCLK for data timeouts */
374#define SDHCI_QUIRK_DATA_TIMEOUT_USES_SDCLK (1<<24)
375/* Controller reports wrong base clock capability */
376#define SDHCI_QUIRK_CAP_CLOCK_BASE_BROKEN (1<<25)
377/* Controller cannot support End Attribute in NOP ADMA descriptor */
378#define SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC (1<<26)
379/* Controller is missing device caps. Use caps provided by host */
380#define SDHCI_QUIRK_MISSING_CAPS (1<<27)
381/* Controller uses Auto CMD12 command to stop the transfer */
382#define SDHCI_QUIRK_MULTIBLOCK_READ_ACMD12 (1<<28)
383/* Controller doesn't have HISPD bit field in HI-SPEED SD card */
384#define SDHCI_QUIRK_NO_HISPD_BIT (1<<29)
385/* Controller treats ADMA descriptors with length 0000h incorrectly */
386#define SDHCI_QUIRK_BROKEN_ADMA_ZEROLEN_DESC (1<<30)
387/* The read-only detection via SDHCI_PRESENT_STATE register is unstable */
388#define SDHCI_QUIRK_UNSTABLE_RO_DETECT (1<<31)
389
390 unsigned int quirks2; /* More deviations from spec. */
391
392#define SDHCI_QUIRK2_HOST_OFF_CARD_ON (1<<0)
393#define SDHCI_QUIRK2_HOST_NO_CMD23 (1<<1)
394/* The system physically doesn't support 1.8v, even if the host does */
395#define SDHCI_QUIRK2_NO_1_8_V (1<<2)
396#define SDHCI_QUIRK2_PRESET_VALUE_BROKEN (1<<3)
397#define SDHCI_QUIRK2_CARD_ON_NEEDS_BUS_ON (1<<4)
398/* Controller has a non-standard host control register */
399#define SDHCI_QUIRK2_BROKEN_HOST_CONTROL (1<<5)
400/* Controller does not support HS200 */
401#define SDHCI_QUIRK2_BROKEN_HS200 (1<<6)
402/* Controller does not support DDR50 */
403#define SDHCI_QUIRK2_BROKEN_DDR50 (1<<7)
404/* Stop command (CMD12) can set Transfer Complete when not using MMC_RSP_BUSY */
405#define SDHCI_QUIRK2_STOP_WITH_TC (1<<8)
406/* Controller does not support 64-bit DMA */
407#define SDHCI_QUIRK2_BROKEN_64_BIT_DMA (1<<9)
408/* need clear transfer mode register before send cmd */
409#define SDHCI_QUIRK2_CLEAR_TRANSFERMODE_REG_BEFORE_CMD (1<<10)
410/* Capability register bit-63 indicates HS400 support */
411#define SDHCI_QUIRK2_CAPS_BIT63_FOR_HS400 (1<<11)
412/* forced tuned clock */
413#define SDHCI_QUIRK2_TUNING_WORK_AROUND (1<<12)
414/* disable the block count for single block transactions */
415#define SDHCI_QUIRK2_SUPPORT_SINGLE (1<<13)
416/* Controller broken with using ACMD23 */
417#define SDHCI_QUIRK2_ACMD23_BROKEN (1<<14)
Suneel Garapatid1955c32015-06-09 13:01:50 +0530418/* Broken Clock divider zero in controller */
419#define SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN (1<<15)
Ulf Hansson83f13cc2015-03-04 10:19:14 +0100420
421 int irq; /* Device IRQ */
422 void __iomem *ioaddr; /* Mapped address */
423
424 const struct sdhci_ops *ops; /* Low level hw interface */
425
426 /* Internal data */
427 struct mmc_host *mmc; /* MMC structure */
Adrian Hunterbf60e592016-02-09 16:12:35 +0200428 struct mmc_host_ops mmc_host_ops; /* MMC host ops */
Ulf Hansson83f13cc2015-03-04 10:19:14 +0100429 u64 dma_mask; /* custom DMA mask */
430
Masahiro Yamada74479c52016-04-14 13:19:40 +0900431#if IS_ENABLED(CONFIG_LEDS_CLASS)
Ulf Hansson83f13cc2015-03-04 10:19:14 +0100432 struct led_classdev led; /* LED control */
433 char led_name[32];
434#endif
435
436 spinlock_t lock; /* Mutex */
437
438 int flags; /* Host attributes */
439#define SDHCI_USE_SDMA (1<<0) /* Host is SDMA capable */
440#define SDHCI_USE_ADMA (1<<1) /* Host is ADMA capable */
441#define SDHCI_REQ_USE_DMA (1<<2) /* Use DMA for this req. */
442#define SDHCI_DEVICE_DEAD (1<<3) /* Device unresponsive */
443#define SDHCI_SDR50_NEEDS_TUNING (1<<4) /* SDR50 needs tuning */
Ulf Hansson83f13cc2015-03-04 10:19:14 +0100444#define SDHCI_AUTO_CMD12 (1<<6) /* Auto CMD12 support */
445#define SDHCI_AUTO_CMD23 (1<<7) /* Auto CMD23 support */
446#define SDHCI_PV_ENABLED (1<<8) /* Preset value enabled */
447#define SDHCI_SDIO_IRQ_ENABLED (1<<9) /* SDIO irq enabled */
Ulf Hansson83f13cc2015-03-04 10:19:14 +0100448#define SDHCI_USE_64_BIT_DMA (1<<12) /* Use 64-bit DMA */
449#define SDHCI_HS400_TUNING (1<<13) /* Tuning for HS400 */
450
451 unsigned int version; /* SDHCI spec. version */
452
453 unsigned int max_clk; /* Max possible freq (MHz) */
454 unsigned int timeout_clk; /* Timeout freq (KHz) */
455 unsigned int clk_mul; /* Clock Muliplier value */
456
457 unsigned int clock; /* Current clock (MHz) */
458 u8 pwr; /* Current voltage */
459
460 bool runtime_suspended; /* Host is runtime suspended */
461 bool bus_on; /* Bus power prevents runtime suspend */
462 bool preset_enabled; /* Preset is enabled */
463
464 struct mmc_request *mrq; /* Current request */
465 struct mmc_command *cmd; /* Current command */
466 struct mmc_data *data; /* Current data request */
467 unsigned int data_early:1; /* Data finished before cmd */
468 unsigned int busy_handle:1; /* Handling the order of Busy-end */
469
470 struct sg_mapping_iter sg_miter; /* SG state for PIO */
471 unsigned int blocks; /* remaining PIO blocks */
472
473 int sg_count; /* Mapped sg entries */
474
475 void *adma_table; /* ADMA descriptor table */
476 void *align_buffer; /* Bounce buffer */
477
478 size_t adma_table_sz; /* ADMA descriptor table size */
479 size_t align_buffer_sz; /* Bounce buffer size */
480
481 dma_addr_t adma_addr; /* Mapped ADMA descr. table */
482 dma_addr_t align_addr; /* Mapped bounce buffer */
483
484 unsigned int desc_sz; /* ADMA descriptor size */
Ulf Hansson83f13cc2015-03-04 10:19:14 +0100485
486 struct tasklet_struct finish_tasklet; /* Tasklet structures */
487
488 struct timer_list timer; /* Timer for timeouts */
489
490 u32 caps; /* Alternative CAPABILITY_0 */
491 u32 caps1; /* Alternative CAPABILITY_1 */
492
493 unsigned int ocr_avail_sdio; /* OCR bit masks */
494 unsigned int ocr_avail_sd;
495 unsigned int ocr_avail_mmc;
496 u32 ocr_mask; /* available voltages */
497
498 unsigned timing; /* Current timing */
499
500 u32 thread_isr;
501
502 /* cached registers */
503 u32 ier;
504
505 wait_queue_head_t buf_ready_int; /* Waitqueue for Buffer Read Ready interrupt */
506 unsigned int tuning_done; /* Condition flag set when CMD19 succeeds */
507
508 unsigned int tuning_count; /* Timer count for re-tuning */
509 unsigned int tuning_mode; /* Re-tuning mode supported by host */
510#define SDHCI_TUNING_MODE_1 0
Ulf Hansson83f13cc2015-03-04 10:19:14 +0100511
Ulf Hansson83f13cc2015-03-04 10:19:14 +0100512 unsigned long private[0] ____cacheline_aligned;
513};
514
Pierre Ossmanb8c86fc2008-03-18 17:35:49 +0100515struct sdhci_ops {
Anton Vorontsov4e4141a2009-03-17 00:13:46 +0300516#ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS
Matt Flemingdc297c92010-05-26 14:42:03 -0700517 u32 (*read_l)(struct sdhci_host *host, int reg);
518 u16 (*read_w)(struct sdhci_host *host, int reg);
519 u8 (*read_b)(struct sdhci_host *host, int reg);
520 void (*write_l)(struct sdhci_host *host, u32 val, int reg);
521 void (*write_w)(struct sdhci_host *host, u16 val, int reg);
522 void (*write_b)(struct sdhci_host *host, u8 val, int reg);
Anton Vorontsov4e4141a2009-03-17 00:13:46 +0300523#endif
524
Anton Vorontsov81146342009-03-17 00:13:59 +0300525 void (*set_clock)(struct sdhci_host *host, unsigned int clock);
Adrian Hunter1dceb042016-03-29 12:45:43 +0300526 void (*set_power)(struct sdhci_host *host, unsigned char mode,
527 unsigned short vdd);
Anton Vorontsov81146342009-03-17 00:13:59 +0300528
Pierre Ossmanb8c86fc2008-03-18 17:35:49 +0100529 int (*enable_dma)(struct sdhci_host *host);
Ben Dooks4240ff02009-03-17 00:13:57 +0300530 unsigned int (*get_max_clock)(struct sdhci_host *host);
Anton Vorontsova9e58f22009-07-29 15:04:16 -0700531 unsigned int (*get_min_clock)(struct sdhci_host *host);
Ben Dooks4240ff02009-03-17 00:13:57 +0300532 unsigned int (*get_timeout_clock)(struct sdhci_host *host);
Aisheng Donga6ff5ae2014-08-27 15:26:27 +0800533 unsigned int (*get_max_timeout_count)(struct sdhci_host *host);
Aisheng Dongb45e6682014-08-27 15:26:29 +0800534 void (*set_timeout)(struct sdhci_host *host,
535 struct mmc_command *cmd);
Russell King2317f562014-04-25 12:57:07 +0100536 void (*set_bus_width)(struct sdhci_host *host, int width);
Philip Rakity643a81f2010-09-23 08:24:32 -0700537 void (*platform_send_init_74_clocks)(struct sdhci_host *host,
538 u8 power_mode);
Wolfram Sang2dfb5792010-10-15 12:21:01 +0200539 unsigned int (*get_ro)(struct sdhci_host *host);
Russell King03231f92014-04-25 12:57:12 +0100540 void (*reset)(struct sdhci_host *host, u8 mask);
Dong Aisheng45251812013-09-13 19:11:30 +0800541 int (*platform_execute_tuning)(struct sdhci_host *host, u32 opcode);
Russell King13e64502014-04-25 12:59:20 +0100542 void (*set_uhs_signaling)(struct sdhci_host *host, unsigned int uhs);
Adrian Hunter20758b62011-08-29 16:42:12 +0300543 void (*hw_reset)(struct sdhci_host *host);
Haijun Zhanga4071fb2012-12-04 10:41:28 +0800544 void (*adma_workaround)(struct sdhci_host *host, u32 intmask);
Jerry Huang63ef5d82012-10-25 13:47:19 +0800545 void (*platform_init)(struct sdhci_host *host);
Christian Daudt722e1282013-06-20 14:26:36 -0700546 void (*card_event)(struct sdhci_host *host);
Vincent Yang9d967a62015-01-20 16:05:15 +0800547 void (*voltage_switch)(struct sdhci_host *host);
Adrian Huntercb849642015-02-06 14:12:59 +0200548 int (*select_drive_strength)(struct sdhci_host *host,
549 struct mmc_card *card,
550 unsigned int max_dtr, int host_drv,
551 int card_drv, int *drv_type);
Pierre Ossmand129bce2006-03-24 03:18:17 -0800552};
Pierre Ossmanb8c86fc2008-03-18 17:35:49 +0100553
Anton Vorontsov4e4141a2009-03-17 00:13:46 +0300554#ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS
555
556static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg)
557{
Matt Flemingdc297c92010-05-26 14:42:03 -0700558 if (unlikely(host->ops->write_l))
559 host->ops->write_l(host, val, reg);
Anton Vorontsov4e4141a2009-03-17 00:13:46 +0300560 else
561 writel(val, host->ioaddr + reg);
562}
563
564static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg)
565{
Matt Flemingdc297c92010-05-26 14:42:03 -0700566 if (unlikely(host->ops->write_w))
567 host->ops->write_w(host, val, reg);
Anton Vorontsov4e4141a2009-03-17 00:13:46 +0300568 else
569 writew(val, host->ioaddr + reg);
570}
571
572static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg)
573{
Matt Flemingdc297c92010-05-26 14:42:03 -0700574 if (unlikely(host->ops->write_b))
575 host->ops->write_b(host, val, reg);
Anton Vorontsov4e4141a2009-03-17 00:13:46 +0300576 else
577 writeb(val, host->ioaddr + reg);
578}
579
580static inline u32 sdhci_readl(struct sdhci_host *host, int reg)
581{
Matt Flemingdc297c92010-05-26 14:42:03 -0700582 if (unlikely(host->ops->read_l))
583 return host->ops->read_l(host, reg);
Anton Vorontsov4e4141a2009-03-17 00:13:46 +0300584 else
585 return readl(host->ioaddr + reg);
586}
587
588static inline u16 sdhci_readw(struct sdhci_host *host, int reg)
589{
Matt Flemingdc297c92010-05-26 14:42:03 -0700590 if (unlikely(host->ops->read_w))
591 return host->ops->read_w(host, reg);
Anton Vorontsov4e4141a2009-03-17 00:13:46 +0300592 else
593 return readw(host->ioaddr + reg);
594}
595
596static inline u8 sdhci_readb(struct sdhci_host *host, int reg)
597{
Matt Flemingdc297c92010-05-26 14:42:03 -0700598 if (unlikely(host->ops->read_b))
599 return host->ops->read_b(host, reg);
Anton Vorontsov4e4141a2009-03-17 00:13:46 +0300600 else
601 return readb(host->ioaddr + reg);
602}
603
604#else
605
606static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg)
607{
608 writel(val, host->ioaddr + reg);
609}
610
611static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg)
612{
613 writew(val, host->ioaddr + reg);
614}
615
616static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg)
617{
618 writeb(val, host->ioaddr + reg);
619}
620
621static inline u32 sdhci_readl(struct sdhci_host *host, int reg)
622{
623 return readl(host->ioaddr + reg);
624}
625
626static inline u16 sdhci_readw(struct sdhci_host *host, int reg)
627{
628 return readw(host->ioaddr + reg);
629}
630
631static inline u8 sdhci_readb(struct sdhci_host *host, int reg)
632{
633 return readb(host->ioaddr + reg);
634}
635
636#endif /* CONFIG_MMC_SDHCI_IO_ACCESSORS */
Pierre Ossmanb8c86fc2008-03-18 17:35:49 +0100637
638extern struct sdhci_host *sdhci_alloc_host(struct device *dev,
639 size_t priv_size);
640extern void sdhci_free_host(struct sdhci_host *host);
641
642static inline void *sdhci_priv(struct sdhci_host *host)
643{
644 return (void *)host->private;
645}
646
Marek Szyprowski17866e12010-08-10 18:01:58 -0700647extern void sdhci_card_detect(struct sdhci_host *host);
Pierre Ossmanb8c86fc2008-03-18 17:35:49 +0100648extern int sdhci_add_host(struct sdhci_host *host);
Pierre Ossman1e728592008-04-16 19:13:13 +0200649extern void sdhci_remove_host(struct sdhci_host *host, int dead);
Dong Aishengc0e551292013-09-13 19:11:31 +0800650extern void sdhci_send_command(struct sdhci_host *host,
651 struct mmc_command *cmd);
Pierre Ossmanb8c86fc2008-03-18 17:35:49 +0100652
Russell Kingbe138552014-04-25 12:55:56 +0100653static inline bool sdhci_sdio_irq_enabled(struct sdhci_host *host)
654{
655 return !!(host->flags & SDHCI_SDIO_IRQ_ENABLED);
656}
657
Ludovic Desrochesfb9ee042016-04-07 11:13:08 +0200658u16 sdhci_calc_clk(struct sdhci_host *host, unsigned int clock,
659 unsigned int *actual_clock);
Russell King17710592014-04-25 12:58:55 +0100660void sdhci_set_clock(struct sdhci_host *host, unsigned int clock);
Adrian Hunter1dceb042016-03-29 12:45:43 +0300661void sdhci_set_power(struct sdhci_host *host, unsigned char mode,
662 unsigned short vdd);
Russell King2317f562014-04-25 12:57:07 +0100663void sdhci_set_bus_width(struct sdhci_host *host, int width);
Russell King03231f92014-04-25 12:57:12 +0100664void sdhci_reset(struct sdhci_host *host, u8 mask);
Russell King96d7b782014-04-25 12:59:26 +0100665void sdhci_set_uhs_signaling(struct sdhci_host *host, unsigned timing);
Russell King2317f562014-04-25 12:57:07 +0100666
Pierre Ossmanb8c86fc2008-03-18 17:35:49 +0100667#ifdef CONFIG_PM
Manuel Lauss29495aa2011-11-03 11:09:45 +0100668extern int sdhci_suspend_host(struct sdhci_host *host);
Pierre Ossmanb8c86fc2008-03-18 17:35:49 +0100669extern int sdhci_resume_host(struct sdhci_host *host);
Daniel Drake5f619702010-11-04 22:20:39 +0000670extern void sdhci_enable_irq_wakeups(struct sdhci_host *host);
Adrian Hunter66fd8ad2011-10-03 15:33:34 +0300671extern int sdhci_runtime_suspend_host(struct sdhci_host *host);
672extern int sdhci_runtime_resume_host(struct sdhci_host *host);
673#endif
674
Giuseppe Cavallaro1978fda2010-09-28 10:41:29 +0200675#endif /* __SDHCI_HW_H */