Merge tag 'tpm-030822' of https://source.denx.de/u-boot/custodians/u-boot-tpm
[platform/kernel/u-boot.git] / include / sdhci.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * Copyright 2011, Marvell Semiconductor Inc.
4  * Lei Wen <leiwen@marvell.com>
5  *
6  * Back ported to the 8xx platform (from the 8260 platform) by
7  * Murray.Jensen@cmst.csiro.au, 27-Jan-01.
8  */
9 #ifndef __SDHCI_HW_H
10 #define __SDHCI_HW_H
11
12 #include <linux/bitops.h>
13 #include <linux/types.h>
14 #include <asm/io.h>
15 #include <mmc.h>
16 #include <asm/gpio.h>
17
18 /*
19  * Controller registers
20  */
21
22 #define SDHCI_DMA_ADDRESS       0x00
23
24 #define SDHCI_BLOCK_SIZE        0x04
25 #define  SDHCI_MAKE_BLKSZ(dma, blksz) (((dma & 0x7) << 12) | (blksz & 0xFFF))
26
27 #define SDHCI_BLOCK_COUNT       0x06
28
29 #define SDHCI_ARGUMENT          0x08
30
31 #define SDHCI_TRANSFER_MODE     0x0C
32 #define  SDHCI_TRNS_DMA         BIT(0)
33 #define  SDHCI_TRNS_BLK_CNT_EN  BIT(1)
34 #define  SDHCI_TRNS_ACMD12      BIT(2)
35 #define  SDHCI_TRNS_READ        BIT(4)
36 #define  SDHCI_TRNS_MULTI       BIT(5)
37
38 #define SDHCI_COMMAND           0x0E
39 #define  SDHCI_CMD_RESP_MASK    0x03
40 #define  SDHCI_CMD_CRC          0x08
41 #define  SDHCI_CMD_INDEX        0x10
42 #define  SDHCI_CMD_DATA         0x20
43 #define  SDHCI_CMD_ABORTCMD     0xC0
44
45 #define  SDHCI_CMD_RESP_NONE    0x00
46 #define  SDHCI_CMD_RESP_LONG    0x01
47 #define  SDHCI_CMD_RESP_SHORT   0x02
48 #define  SDHCI_CMD_RESP_SHORT_BUSY 0x03
49
50 #define SDHCI_MAKE_CMD(c, f) (((c & 0xff) << 8) | (f & 0xff))
51 #define SDHCI_GET_CMD(c) ((c>>8) & 0x3f)
52
53 #define SDHCI_RESPONSE          0x10
54
55 #define SDHCI_BUFFER            0x20
56
57 #define SDHCI_PRESENT_STATE     0x24
58 #define  SDHCI_CMD_INHIBIT      BIT(0)
59 #define  SDHCI_DATA_INHIBIT     BIT(1)
60 #define  SDHCI_DOING_WRITE      BIT(8)
61 #define  SDHCI_DOING_READ       BIT(9)
62 #define  SDHCI_SPACE_AVAILABLE  BIT(10)
63 #define  SDHCI_DATA_AVAILABLE   BIT(11)
64 #define  SDHCI_CARD_PRESENT     BIT(16)
65 #define  SDHCI_CARD_STATE_STABLE        BIT(17)
66 #define  SDHCI_CARD_DETECT_PIN_LEVEL    BIT(18)
67 #define  SDHCI_WRITE_PROTECT    BIT(19)
68 #define  SDHCI_DATA_LVL_MASK    0x00F00000
69 #define   SDHCI_DATA_0_LVL_MASK BIT(20)
70
71 #define SDHCI_HOST_CONTROL      0x28
72 #define  SDHCI_CTRL_LED         BIT(0)
73 #define  SDHCI_CTRL_4BITBUS     BIT(1)
74 #define  SDHCI_CTRL_HISPD       BIT(2)
75 #define  SDHCI_CTRL_DMA_MASK    0x18
76 #define   SDHCI_CTRL_SDMA       0x00
77 #define   SDHCI_CTRL_ADMA1      0x08
78 #define   SDHCI_CTRL_ADMA32     0x10
79 #define   SDHCI_CTRL_ADMA64     0x18
80 #define  SDHCI_CTRL_8BITBUS     BIT(5)
81 #define  SDHCI_CTRL_CD_TEST_INS BIT(6)
82 #define  SDHCI_CTRL_CD_TEST     BIT(7)
83
84 #define SDHCI_POWER_CONTROL     0x29
85 #define  SDHCI_POWER_ON         0x01
86 #define  SDHCI_POWER_180        0x0A
87 #define  SDHCI_POWER_300        0x0C
88 #define  SDHCI_POWER_330        0x0E
89
90 #define SDHCI_BLOCK_GAP_CONTROL 0x2A
91
92 #define SDHCI_WAKE_UP_CONTROL   0x2B
93 #define  SDHCI_WAKE_ON_INT      BIT(0)
94 #define  SDHCI_WAKE_ON_INSERT   BIT(1)
95 #define  SDHCI_WAKE_ON_REMOVE   BIT(2)
96
97 #define SDHCI_CLOCK_CONTROL     0x2C
98 #define  SDHCI_DIVIDER_SHIFT    8
99 #define  SDHCI_DIVIDER_HI_SHIFT 6
100 #define  SDHCI_DIV_MASK 0xFF
101 #define  SDHCI_DIV_MASK_LEN     8
102 #define  SDHCI_DIV_HI_MASK      0x300
103 #define  SDHCI_PROG_CLOCK_MODE  BIT(5)
104 #define  SDHCI_CLOCK_CARD_EN    BIT(2)
105 #define  SDHCI_CLOCK_INT_STABLE BIT(1)
106 #define  SDHCI_CLOCK_INT_EN     BIT(0)
107
108 #define SDHCI_TIMEOUT_CONTROL   0x2E
109
110 #define SDHCI_SOFTWARE_RESET    0x2F
111 #define  SDHCI_RESET_ALL        0x01
112 #define  SDHCI_RESET_CMD        0x02
113 #define  SDHCI_RESET_DATA       0x04
114
115 #define SDHCI_INT_STATUS        0x30
116 #define SDHCI_INT_ENABLE        0x34
117 #define SDHCI_SIGNAL_ENABLE     0x38
118 #define  SDHCI_INT_RESPONSE     BIT(0)
119 #define  SDHCI_INT_DATA_END     BIT(1)
120 #define  SDHCI_INT_DMA_END      BIT(3)
121 #define  SDHCI_INT_SPACE_AVAIL  BIT(4)
122 #define  SDHCI_INT_DATA_AVAIL   BIT(5)
123 #define  SDHCI_INT_CARD_INSERT  BIT(6)
124 #define  SDHCI_INT_CARD_REMOVE  BIT(7)
125 #define  SDHCI_INT_CARD_INT     BIT(8)
126 #define  SDHCI_INT_ERROR        BIT(15)
127 #define  SDHCI_INT_TIMEOUT      BIT(16)
128 #define  SDHCI_INT_CRC          BIT(17)
129 #define  SDHCI_INT_END_BIT      BIT(18)
130 #define  SDHCI_INT_INDEX        BIT(19)
131 #define  SDHCI_INT_DATA_TIMEOUT BIT(20)
132 #define  SDHCI_INT_DATA_CRC     BIT(21)
133 #define  SDHCI_INT_DATA_END_BIT BIT(22)
134 #define  SDHCI_INT_BUS_POWER    BIT(23)
135 #define  SDHCI_INT_ACMD12ERR    BIT(24)
136 #define  SDHCI_INT_ADMA_ERROR   BIT(25)
137
138 #define  SDHCI_INT_NORMAL_MASK  0x00007FFF
139 #define  SDHCI_INT_ERROR_MASK   0xFFFF8000
140
141 #define  SDHCI_INT_CMD_MASK     (SDHCI_INT_RESPONSE | SDHCI_INT_TIMEOUT | \
142                 SDHCI_INT_CRC | SDHCI_INT_END_BIT | SDHCI_INT_INDEX)
143 #define  SDHCI_INT_DATA_MASK    (SDHCI_INT_DATA_END | SDHCI_INT_DMA_END | \
144                 SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL | \
145                 SDHCI_INT_DATA_TIMEOUT | SDHCI_INT_DATA_CRC | \
146                 SDHCI_INT_DATA_END_BIT | SDHCI_INT_ADMA_ERROR)
147 #define SDHCI_INT_ALL_MASK      ((unsigned int)-1)
148
149 #define SDHCI_ACMD12_ERR        0x3C
150
151 #define SDHCI_HOST_CONTROL2     0x3E
152 #define  SDHCI_CTRL_UHS_MASK    0x0007
153 #define  SDHCI_CTRL_UHS_SDR12   0x0000
154 #define  SDHCI_CTRL_UHS_SDR25   0x0001
155 #define  SDHCI_CTRL_UHS_SDR50   0x0002
156 #define  SDHCI_CTRL_UHS_SDR104  0x0003
157 #define  SDHCI_CTRL_UHS_DDR50   0x0004
158 #define  SDHCI_CTRL_HS400       0x0005 /* Non-standard */
159 #define  SDHCI_CTRL_VDD_180     0x0008
160 #define  SDHCI_CTRL_DRV_TYPE_MASK       0x0030
161 #define  SDHCI_CTRL_DRV_TYPE_B  0x0000
162 #define  SDHCI_CTRL_DRV_TYPE_A  0x0010
163 #define  SDHCI_CTRL_DRV_TYPE_C  0x0020
164 #define  SDHCI_CTRL_DRV_TYPE_D  0x0030
165 #define  SDHCI_CTRL_EXEC_TUNING 0x0040
166 #define  SDHCI_CTRL_TUNED_CLK   0x0080
167 #define  SDHCI_CTRL_PRESET_VAL_ENABLE   0x8000
168
169 #define SDHCI_CAPABILITIES      0x40
170 #define  SDHCI_TIMEOUT_CLK_MASK 0x0000003F
171 #define  SDHCI_TIMEOUT_CLK_SHIFT 0
172 #define  SDHCI_TIMEOUT_CLK_UNIT 0x00000080
173 #define  SDHCI_CLOCK_BASE_MASK  0x00003F00
174 #define  SDHCI_CLOCK_V3_BASE_MASK       0x0000FF00
175 #define  SDHCI_CLOCK_BASE_SHIFT 8
176 #define  SDHCI_MAX_BLOCK_MASK   0x00030000
177 #define  SDHCI_MAX_BLOCK_SHIFT  16
178 #define  SDHCI_CAN_DO_8BIT      BIT(18)
179 #define  SDHCI_CAN_DO_ADMA2     BIT(19)
180 #define  SDHCI_CAN_DO_ADMA1     BIT(20)
181 #define  SDHCI_CAN_DO_HISPD     BIT(21)
182 #define  SDHCI_CAN_DO_SDMA      BIT(22)
183 #define  SDHCI_CAN_VDD_330      BIT(24)
184 #define  SDHCI_CAN_VDD_300      BIT(25)
185 #define  SDHCI_CAN_VDD_180      BIT(26)
186 #define  SDHCI_CAN_64BIT        BIT(28)
187
188 #define SDHCI_CAPABILITIES_1    0x44
189 #define  SDHCI_SUPPORT_SDR50    0x00000001
190 #define  SDHCI_SUPPORT_SDR104   0x00000002
191 #define  SDHCI_SUPPORT_DDR50    0x00000004
192 #define  SDHCI_USE_SDR50_TUNING 0x00002000
193
194 #define  SDHCI_CLOCK_MUL_MASK   0x00FF0000
195 #define  SDHCI_CLOCK_MUL_SHIFT  16
196
197 #define SDHCI_MAX_CURRENT       0x48
198
199 /* 4C-4F reserved for more max current */
200
201 #define SDHCI_SET_ACMD12_ERROR  0x50
202 #define SDHCI_SET_INT_ERROR     0x52
203
204 #define SDHCI_ADMA_ERROR        0x54
205
206 /* 55-57 reserved */
207
208 #define SDHCI_ADMA_ADDRESS      0x58
209 #define SDHCI_ADMA_ADDRESS_HI   0x5c
210
211 /* 60-FB reserved */
212
213 #define SDHCI_SLOT_INT_STATUS   0xFC
214
215 #define SDHCI_HOST_VERSION      0xFE
216 #define  SDHCI_VENDOR_VER_MASK  0xFF00
217 #define  SDHCI_VENDOR_VER_SHIFT 8
218 #define  SDHCI_SPEC_VER_MASK    0x00FF
219 #define  SDHCI_SPEC_VER_SHIFT   0
220 #define   SDHCI_SPEC_100        0
221 #define   SDHCI_SPEC_200        1
222 #define   SDHCI_SPEC_300        2
223
224 #define SDHCI_GET_VERSION(x) (x->version & SDHCI_SPEC_VER_MASK)
225
226 /*
227  * End of controller registers.
228  */
229
230 #define SDHCI_MAX_DIV_SPEC_200  256
231 #define SDHCI_MAX_DIV_SPEC_300  2046
232
233 /*
234  * quirks
235  */
236 #define SDHCI_QUIRK_32BIT_DMA_ADDR      (1 << 0)
237 #define SDHCI_QUIRK_REG32_RW            (1 << 1)
238 #define SDHCI_QUIRK_BROKEN_R1B          (1 << 2)
239 #define SDHCI_QUIRK_NO_HISPD_BIT        (1 << 3)
240 #define SDHCI_QUIRK_BROKEN_VOLTAGE      (1 << 4)
241 /*
242  * SDHCI_QUIRK_BROKEN_HISPD_MODE
243  * the hardware cannot operate correctly in high-speed mode,
244  * this quirk forces the sdhci host-controller to non high-speed mode
245  */
246 #define SDHCI_QUIRK_BROKEN_HISPD_MODE   BIT(5)
247 #define SDHCI_QUIRK_WAIT_SEND_CMD       (1 << 6)
248 #define SDHCI_QUIRK_USE_WIDE8           (1 << 8)
249 #define SDHCI_QUIRK_NO_1_8_V            (1 << 9)
250
251 /* to make gcc happy */
252 struct sdhci_host;
253
254 /*
255  * Host SDMA buffer boundary. Valid values from 4K to 512K in powers of 2.
256  */
257 #define SDHCI_DEFAULT_BOUNDARY_SIZE     (512 * 1024)
258 #define SDHCI_DEFAULT_BOUNDARY_ARG      (7)
259 struct sdhci_ops {
260 #ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS
261         u32     (*read_l)(struct sdhci_host *host, int reg);
262         u16     (*read_w)(struct sdhci_host *host, int reg);
263         u8      (*read_b)(struct sdhci_host *host, int reg);
264         void    (*write_l)(struct sdhci_host *host, u32 val, int reg);
265         void    (*write_w)(struct sdhci_host *host, u16 val, int reg);
266         void    (*write_b)(struct sdhci_host *host, u8 val, int reg);
267 #endif
268         int     (*get_cd)(struct sdhci_host *host);
269         void    (*set_control_reg)(struct sdhci_host *host);
270         int     (*set_ios_post)(struct sdhci_host *host);
271         void    (*set_clock)(struct sdhci_host *host, u32 div);
272         int (*platform_execute_tuning)(struct mmc *host, u8 opcode);
273         int (*set_delay)(struct sdhci_host *host);
274         int     (*deferred_probe)(struct sdhci_host *host);
275
276         /**
277          * set_enhanced_strobe() - Set HS400 Enhanced Strobe config
278          *
279          * This is called after setting the card speed and mode to
280          * HS400 ES, and should set any host-specific configuration
281          * necessary for it.
282          *
283          * @host: SDHCI host structure
284          * Return: 0 if successful, -ve on error
285          */
286         int     (*set_enhanced_strobe)(struct sdhci_host *host);
287 };
288
289 #define ADMA_MAX_LEN    65532
290 #ifdef CONFIG_DMA_ADDR_T_64BIT
291 #define ADMA_DESC_LEN   16
292 #else
293 #define ADMA_DESC_LEN   8
294 #endif
295 #define ADMA_TABLE_NO_ENTRIES (CONFIG_SYS_MMC_MAX_BLK_COUNT * \
296                                MMC_MAX_BLOCK_LEN) / ADMA_MAX_LEN
297
298 #define ADMA_TABLE_SZ (ADMA_TABLE_NO_ENTRIES * ADMA_DESC_LEN)
299
300 /* Decriptor table defines */
301 #define ADMA_DESC_ATTR_VALID            BIT(0)
302 #define ADMA_DESC_ATTR_END              BIT(1)
303 #define ADMA_DESC_ATTR_INT              BIT(2)
304 #define ADMA_DESC_ATTR_ACT1             BIT(4)
305 #define ADMA_DESC_ATTR_ACT2             BIT(5)
306
307 #define ADMA_DESC_TRANSFER_DATA         ADMA_DESC_ATTR_ACT2
308 #define ADMA_DESC_LINK_DESC     (ADMA_DESC_ATTR_ACT1 | ADMA_DESC_ATTR_ACT2)
309
310 struct sdhci_adma_desc {
311         u8 attr;
312         u8 reserved;
313         u16 len;
314         u32 addr_lo;
315 #ifdef CONFIG_DMA_ADDR_T_64BIT
316         u32 addr_hi;
317 #endif
318 } __packed;
319
320 struct sdhci_host {
321         const char *name;
322         void *ioaddr;
323         unsigned int quirks;
324         unsigned int host_caps;
325         unsigned int version;
326         unsigned int max_clk;   /* Maximum Base Clock frequency */
327         unsigned int clk_mul;   /* Clock Multiplier value */
328         unsigned int clock;
329         struct mmc *mmc;
330         const struct sdhci_ops *ops;
331         int index;
332
333         int bus_width;
334         struct gpio_desc pwr_gpio;      /* Power GPIO */
335         struct gpio_desc cd_gpio;               /* Card Detect GPIO */
336
337         uint    voltages;
338
339         struct mmc_config cfg;
340         void *align_buffer;
341         bool force_align_buffer;
342         dma_addr_t start_addr;
343         int flags;
344 #define USE_SDMA        (0x1 << 0)
345 #define USE_ADMA        (0x1 << 1)
346 #define USE_ADMA64      (0x1 << 2)
347 #define USE_DMA         (USE_SDMA | USE_ADMA | USE_ADMA64)
348         dma_addr_t adma_addr;
349 #if CONFIG_IS_ENABLED(MMC_SDHCI_ADMA)
350         struct sdhci_adma_desc *adma_desc_table;
351 #endif
352 };
353
354 #ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS
355
356 static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg)
357 {
358         if (unlikely(host->ops->write_l))
359                 host->ops->write_l(host, val, reg);
360         else
361                 writel(val, host->ioaddr + reg);
362 }
363
364 static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg)
365 {
366         if (unlikely(host->ops->write_w))
367                 host->ops->write_w(host, val, reg);
368         else
369                 writew(val, host->ioaddr + reg);
370 }
371
372 static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg)
373 {
374         if (unlikely(host->ops->write_b))
375                 host->ops->write_b(host, val, reg);
376         else
377                 writeb(val, host->ioaddr + reg);
378 }
379
380 static inline u32 sdhci_readl(struct sdhci_host *host, int reg)
381 {
382         if (unlikely(host->ops->read_l))
383                 return host->ops->read_l(host, reg);
384         else
385                 return readl(host->ioaddr + reg);
386 }
387
388 static inline u16 sdhci_readw(struct sdhci_host *host, int reg)
389 {
390         if (unlikely(host->ops->read_w))
391                 return host->ops->read_w(host, reg);
392         else
393                 return readw(host->ioaddr + reg);
394 }
395
396 static inline u8 sdhci_readb(struct sdhci_host *host, int reg)
397 {
398         if (unlikely(host->ops->read_b))
399                 return host->ops->read_b(host, reg);
400         else
401                 return readb(host->ioaddr + reg);
402 }
403
404 #else
405
406 static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg)
407 {
408         writel(val, host->ioaddr + reg);
409 }
410
411 static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg)
412 {
413         writew(val, host->ioaddr + reg);
414 }
415
416 static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg)
417 {
418         writeb(val, host->ioaddr + reg);
419 }
420 static inline u32 sdhci_readl(struct sdhci_host *host, int reg)
421 {
422         return readl(host->ioaddr + reg);
423 }
424
425 static inline u16 sdhci_readw(struct sdhci_host *host, int reg)
426 {
427         return readw(host->ioaddr + reg);
428 }
429
430 static inline u8 sdhci_readb(struct sdhci_host *host, int reg)
431 {
432         return readb(host->ioaddr + reg);
433 }
434 #endif
435
436 #ifdef CONFIG_BLK
437 /**
438  * sdhci_setup_cfg() - Set up the configuration for DWMMC
439  *
440  * This is used to set up an SDHCI device when you are using CONFIG_BLK.
441  *
442  * This should be called from your MMC driver's probe() method once you have
443  * the information required.
444  *
445  * Generally your driver will have a platform data structure which holds both
446  * the configuration (struct mmc_config) and the MMC device info (struct mmc).
447  * For example:
448  *
449  * struct msm_sdhc_plat {
450  *      struct mmc_config cfg;
451  *      struct mmc mmc;
452  * };
453  *
454  * ...
455  *
456  * Inside U_BOOT_DRIVER():
457  *      .plat_auto      = sizeof(struct msm_sdhc_plat),
458  *
459  * To access platform data:
460  *      struct msm_sdhc_plat *plat = dev_get_plat(dev);
461  *
462  * See msm_sdhci.c for an example.
463  *
464  * @cfg:        Configuration structure to fill in (generally &plat->mmc)
465  * @host:       SDHCI host structure
466  * @f_max:      Maximum supported clock frequency in HZ (0 for default)
467  * @f_min:      Minimum supported clock frequency in HZ (0 for default)
468  */
469 int sdhci_setup_cfg(struct mmc_config *cfg, struct sdhci_host *host,
470                     u32 f_max, u32 f_min);
471
472 /**
473  * sdhci_bind() - Set up a new MMC block device
474  *
475  * This is used to set up an SDHCI block device when you are using CONFIG_BLK.
476  * It should be called from your driver's bind() method.
477  *
478  * See msm_sdhci.c for an example.
479  *
480  * @dev:        Device to set up
481  * @mmc:        Pointer to mmc structure (normally &plat->mmc)
482  * @cfg:        Empty configuration structure (generally &plat->cfg). This is
483  *              normally all zeroes at this point. The only purpose of passing
484  *              this in is to set mmc->cfg to it.
485  * Return: 0 if OK, -ve if the block device could not be created
486  */
487 int sdhci_bind(struct udevice *dev, struct mmc *mmc, struct mmc_config *cfg);
488 #else
489
490 /**
491  * add_sdhci() - Add a new SDHCI interface
492  *
493  * This is used when you are not using CONFIG_BLK. Convert your driver over!
494  *
495  * @host:       SDHCI host structure
496  * @f_max:      Maximum supported clock frequency in HZ (0 for default)
497  * @f_min:      Minimum supported clock frequency in HZ (0 for default)
498  * Return: 0 if OK, -ve on error
499  */
500 int add_sdhci(struct sdhci_host *host, u32 f_max, u32 f_min);
501 #endif /* !CONFIG_BLK */
502
503 void sdhci_set_uhs_timing(struct sdhci_host *host);
504 #ifdef CONFIG_DM_MMC
505 /* Export the operations to drivers */
506 int sdhci_probe(struct udevice *dev);
507 int sdhci_set_clock(struct mmc *mmc, unsigned int clock);
508
509 /**
510  * sdhci_set_control_reg - Set control registers
511  *
512  * This is used set up control registers for voltage level and UHS speed
513  * mode.
514  *
515  * @host: SDHCI host structure
516  */
517 void sdhci_set_control_reg(struct sdhci_host *host);
518 extern const struct dm_mmc_ops sdhci_ops;
519 #else
520 #endif
521
522 struct sdhci_adma_desc *sdhci_adma_init(void);
523 void sdhci_prepare_adma_table(struct sdhci_adma_desc *table,
524                               struct mmc_data *data, dma_addr_t addr);
525
526 #endif /* __SDHCI_HW_H */