drivers/mmc/host/sdhci.h

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