drivers/mmc/host/sdhci.h

   1 /*
   2  *  linux/drivers/mmc/host/sdhci.h - Secure Digital Host Controller Interface driver
   3  *
   4  *  Copyright (C) 2005-2008 Pierre Ossman, All Rights Reserved.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or (at
   9  * your option) any later version.
  10  */
  11 #ifndef __SDHCI_H
  12 #define __SDHCI_H
  13
  14 #include <linux/scatterlist.h>
  15 #include <linux/compiler.h>
  16 #include <linux/types.h>
  17 #include <linux/io.h>
  18
  19 /*
  20  * Controller registers
  21  */
  22
  23 #define SDHCI_DMA_ADDRESS       0x00
  24
  25 #define SDHCI_BLOCK_SIZE        0x04
  26 #define  SDHCI_MAKE_BLKSZ(dma, blksz) (((dma & 0x7) << 12) | (blksz & 0xFFF))
  27
  28 #define SDHCI_BLOCK_COUNT       0x06
  29
  30 #define SDHCI_ARGUMENT          0x08
  31
  32 #define SDHCI_TRANSFER_MODE     0x0C
  33 #define  SDHCI_TRNS_DMA         0x01
  34 #define  SDHCI_TRNS_BLK_CNT_EN  0x02
  35 #define  SDHCI_TRNS_ACMD12      0x04
  36 #define  SDHCI_TRNS_READ        0x10
  37 #define  SDHCI_TRNS_MULTI       0x20
  38
  39 #define SDHCI_COMMAND           0x0E
  40 #define  SDHCI_CMD_RESP_MASK    0x03
  41 #define  SDHCI_CMD_CRC          0x08
  42 #define  SDHCI_CMD_INDEX        0x10
  43 #define  SDHCI_CMD_DATA         0x20
  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
  52 #define SDHCI_RESPONSE          0x10
  53
  54 #define SDHCI_BUFFER            0x20
  55
  56 #define SDHCI_PRESENT_STATE     0x24
  57 #define  SDHCI_CMD_INHIBIT      0x00000001
  58 #define  SDHCI_DATA_INHIBIT     0x00000002
  59 #define  SDHCI_DOING_WRITE      0x00000100
  60 #define  SDHCI_DOING_READ       0x00000200
  61 #define  SDHCI_SPACE_AVAILABLE  0x00000400
  62 #define  SDHCI_DATA_AVAILABLE   0x00000800
  63 #define  SDHCI_CARD_PRESENT     0x00010000
  64 #define  SDHCI_WRITE_PROTECT    0x00080000
  65
  66 #define SDHCI_HOST_CONTROL      0x28
  67 #define  SDHCI_CTRL_LED         0x01
  68 #define  SDHCI_CTRL_4BITBUS     0x02
  69 #define  SDHCI_CTRL_8BITBUS     0x20
  70 #define  SDHCI_CTRL_HISPD       0x04
  71 #define  SDHCI_CTRL_DMA_MASK    0x18
  72 #define   SDHCI_CTRL_SDMA       0x00
  73 #define   SDHCI_CTRL_ADMA1      0x08
  74 #define   SDHCI_CTRL_ADMA32     0x10
  75 #define   SDHCI_CTRL_ADMA64     0x18
  76 #define  SDHCI_CTRL_8BITBUS     0x20
  77
  78 #define SDHCI_POWER_CONTROL     0x29
  79 #define  SDHCI_POWER_ON         0x01
  80 #define  SDHCI_POWER_180        0x0A
  81 #define  SDHCI_POWER_300        0x0C
  82 #define  SDHCI_POWER_330        0x0E
  83
  84 #define SDHCI_BLOCK_GAP_CONTROL 0x2A
  85
  86 #define SDHCI_WAKE_UP_CONTROL   0x2B
  87
  88 #define SDHCI_CLOCK_CONTROL     0x2C
  89 #define  SDHCI_DIVIDER_SHIFT    8
  90 #define  SDHCI_CLOCK_CARD_EN    0x0004
  91 #define  SDHCI_CLOCK_INT_STABLE 0x0002
  92 #define  SDHCI_CLOCK_INT_EN     0x0001
  93
  94 #define SDHCI_TIMEOUT_CONTROL   0x2E
  95
  96 #define SDHCI_SOFTWARE_RESET    0x2F
  97 #define  SDHCI_RESET_ALL        0x01
  98 #define  SDHCI_RESET_CMD        0x02
  99 #define  SDHCI_RESET_DATA       0x04
 100
 101 #define SDHCI_INT_STATUS        0x30
 102 #define SDHCI_INT_ENABLE        0x34
 103 #define SDHCI_SIGNAL_ENABLE     0x38
 104 #define  SDHCI_INT_RESPONSE     0x00000001
 105 #define  SDHCI_INT_DATA_END     0x00000002
 106 #define  SDHCI_INT_DMA_END      0x00000008
 107 #define  SDHCI_INT_SPACE_AVAIL  0x00000010
 108 #define  SDHCI_INT_DATA_AVAIL   0x00000020
 109 #define  SDHCI_INT_CARD_INSERT  0x00000040
 110 #define  SDHCI_INT_CARD_REMOVE  0x00000080
 111 #define  SDHCI_INT_CARD_INT     0x00000100
 112 #define  SDHCI_INT_ERROR        0x00008000
 113 #define  SDHCI_INT_TIMEOUT      0x00010000
 114 #define  SDHCI_INT_CRC          0x00020000
 115 #define  SDHCI_INT_END_BIT      0x00040000
 116 #define  SDHCI_INT_INDEX        0x00080000
 117 #define  SDHCI_INT_DATA_TIMEOUT 0x00100000
 118 #define  SDHCI_INT_DATA_CRC     0x00200000
 119 #define  SDHCI_INT_DATA_END_BIT 0x00400000
 120 #define  SDHCI_INT_BUS_POWER    0x00800000
 121 #define  SDHCI_INT_ACMD12ERR    0x01000000
 122 #define  SDHCI_INT_ADMA_ERROR   0x02000000
 123
 124 #define  SDHCI_INT_NORMAL_MASK  0x00007FFF
 125 #define  SDHCI_INT_ERROR_MASK   0xFFFF8000
 126
 127 #define  SDHCI_INT_CMD_MASK     (SDHCI_INT_RESPONSE | SDHCI_INT_TIMEOUT | \
 128                 SDHCI_INT_CRC | SDHCI_INT_END_BIT | SDHCI_INT_INDEX)
 129 #define  SDHCI_INT_DATA_MASK    (SDHCI_INT_DATA_END | SDHCI_INT_DMA_END | \
 130                 SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL | \
 131                 SDHCI_INT_DATA_TIMEOUT | SDHCI_INT_DATA_CRC | \
 132                 SDHCI_INT_DATA_END_BIT | SDHCI_INT_ADMA_ERROR)
 133 #define SDHCI_INT_ALL_MASK      ((unsigned int)-1)
 134
 135 #define SDHCI_ACMD12_ERR        0x3C
 136
 137 /* 3E-3F reserved */
 138
 139 #define SDHCI_CAPABILITIES      0x40
 140 #define  SDHCI_TIMEOUT_CLK_MASK 0x0000003F
 141 #define  SDHCI_TIMEOUT_CLK_SHIFT 0
 142 #define  SDHCI_TIMEOUT_CLK_UNIT 0x00000080
 143 #define  SDHCI_CLOCK_BASE_MASK  0x00003F00
 144 #define  SDHCI_CLOCK_BASE_SHIFT 8
 145 #define  SDHCI_MAX_BLOCK_MASK   0x00030000
 146 #define  SDHCI_MAX_BLOCK_SHIFT  16
 147 #define  SDHCI_CAN_DO_ADMA2     0x00080000
 148 #define  SDHCI_CAN_DO_ADMA1     0x00100000
 149 #define  SDHCI_CAN_DO_HISPD     0x00200000
 150 #define  SDHCI_CAN_DO_SDMA      0x00400000
 151 #define  SDHCI_CAN_VDD_330      0x01000000
 152 #define  SDHCI_CAN_VDD_300      0x02000000
 153 #define  SDHCI_CAN_VDD_180      0x04000000
 154 #define  SDHCI_CAN_64BIT        0x10000000
 155
 156 /* 44-47 reserved for more caps */
 157
 158 #define SDHCI_MAX_CURRENT       0x48
 159
 160 /* 4C-4F reserved for more max current */
 161
 162 #define SDHCI_SET_ACMD12_ERROR  0x50
 163 #define SDHCI_SET_INT_ERROR     0x52
 164
 165 #define SDHCI_ADMA_ERROR        0x54
 166
 167 /* 55-57 reserved */
 168
 169 #define SDHCI_ADMA_ADDRESS      0x58
 170
 171 /* 60-FB reserved */
 172
 173 #define SDHCI_SLOT_INT_STATUS   0xFC
 174
 175 #define SDHCI_HOST_VERSION      0xFE
 176 #define  SDHCI_VENDOR_VER_MASK  0xFF00
 177 #define  SDHCI_VENDOR_VER_SHIFT 8
 178 #define  SDHCI_SPEC_VER_MASK    0x00FF
 179 #define  SDHCI_SPEC_VER_SHIFT   0
 180 #define   SDHCI_SPEC_100        0
 181 #define   SDHCI_SPEC_200        1
 182
 183 struct sdhci_ops;
 184
 185 struct sdhci_host {
 186         /* Data set by hardware interface driver */
 187         const char              *hw_name;       /* Hardware bus name */
 188
 189         u64                     quirks;         /* Deviations from spec. */
 190
 191 /* Controller doesn't honor resets unless we touch the clock register */
 192 #define SDHCI_QUIRK_CLOCK_BEFORE_RESET                  (1LL<<0)
 193 /* Controller has bad caps bits, but really supports DMA */
 194 #define SDHCI_QUIRK_FORCE_DMA                           (1LL<<1)
 195 /* Controller doesn't like to be reset when there is no card inserted. */
 196 #define SDHCI_QUIRK_NO_CARD_NO_RESET                    (1LL<<2)
 197 /* Controller doesn't like clearing the power reg before a change */
 198 #define SDHCI_QUIRK_SINGLE_POWER_WRITE                  (1LL<<3)
 199 /* Controller has flaky internal state so reset it on each ios change */
 200 #define SDHCI_QUIRK_RESET_CMD_DATA_ON_IOS               (1LL<<4)
 201 /* Controller has an unusable DMA engine */
 202 #define SDHCI_QUIRK_BROKEN_DMA                          (1LL<<5)
 203 /* Controller has an unusable ADMA engine */
 204 #define SDHCI_QUIRK_BROKEN_ADMA                         (1LL<<6)
 205 /* Controller can only DMA from 32-bit aligned addresses */
 206 #define SDHCI_QUIRK_32BIT_DMA_ADDR                      (1LL<<7)
 207 /* Controller can only DMA chunk sizes that are a multiple of 32 bits */
 208 #define SDHCI_QUIRK_32BIT_DMA_SIZE                      (1LL<<8)
 209 /* Controller can only ADMA chunks that are a multiple of 32 bits */
 210 #define SDHCI_QUIRK_32BIT_ADMA_SIZE                     (1LL<<9)
 211 /* Controller needs to be reset after each request to stay stable */
 212 #define SDHCI_QUIRK_RESET_AFTER_REQUEST                 (1LL<<10)
 213 /* Controller needs voltage and power writes to happen separately */
 214 #define SDHCI_QUIRK_NO_SIMULT_VDD_AND_POWER             (1LL<<11)
 215 /* Controller provides an incorrect timeout value for transfers */
 216 #define SDHCI_QUIRK_BROKEN_TIMEOUT_VAL                  (1LL<<12)
 217 /* Controller has an issue with buffer bits for small transfers */
 218 #define SDHCI_QUIRK_BROKEN_SMALL_PIO                    (1LL<<13)
 219 /* Controller does not provide transfer-complete interrupt when not busy */
 220 #define SDHCI_QUIRK_NO_BUSY_IRQ                         (1LL<<14)
 221 /* Controller has unreliable card detection */
 222 #define SDHCI_QUIRK_BROKEN_CARD_DETECTION               (1LL<<15)
 223 /* Controller reports inverted write-protect state */
 224 #define SDHCI_QUIRK_INVERTED_WRITE_PROTECT              (1LL<<16)
 225 /* Controller has nonstandard clock management */
 226 #define SDHCI_QUIRK_NONSTANDARD_CLOCK                   (1LL<<17)
 227 /* Controller does not like fast PIO transfers */
 228 #define SDHCI_QUIRK_PIO_NEEDS_DELAY                     (1LL<<18)
 229 /* Controller losing signal/interrupt enable states after reset */
 230 #define SDHCI_QUIRK_RESTORE_IRQS_AFTER_RESET            (1LL<<19)
 231 /* Controller has to be forced to use block size of 2048 bytes */
 232 #define SDHCI_QUIRK_FORCE_BLK_SZ_2048                   (1LL<<20)
 233 /* Controller cannot do multi-block transfers */
 234 #define SDHCI_QUIRK_NO_MULTIBLOCK                       (1LL<<21)
 235 /* Controller can only handle 1-bit data transfers */
 236 #define SDHCI_QUIRK_FORCE_1_BIT_DATA                    (1LL<<22)
 237 /* Controller needs 10ms delay between applying power and clock */
 238 #define SDHCI_QUIRK_DELAY_AFTER_POWER                   (1LL<<23)
 239 /* Controller uses SDCLK instead of TMCLK for data timeouts */
 240 #define SDHCI_QUIRK_DATA_TIMEOUT_USES_SDCLK             (1LL<<24)
 241 /* Controller reports wrong base clock capability */
 242 #define SDHCI_QUIRK_CAP_CLOCK_BASE_BROKEN               (1LL<<25)
 243 /* Controller cannot support End Attribute in NOP ADMA descriptor */
 244 #define SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC               (1LL<<26)
 245 /* Controller is missing device caps. Use caps provided by host */
 246 #define SDHCI_QUIRK_MISSING_CAPS                        (1LL<<27)
 247 /* Controller uses Auto CMD12 command to stop the transfer */
 248 #define SDHCI_QUIRK_MULTIBLOCK_READ_ACMD12              (1LL<<28)
 249 /* Controller doesn't have HISPD bit field in HI-SPEED SD card */
 250 #define SDHCI_QUIRK_NO_HISPD_BIT                        (1LL<<29)
 251 /* Controller write protect bit is broken. Assume no write protection */
 252 #define SDHCI_QUIRK_BROKEN_WRITE_PROTECT                (1LL<<30)
 253 /* Controller needs INTERRUPT_AT_BLOCK_GAP enabled to detect card interrupts */
 254 #define SDHCI_QUIRK_ENABLE_INTERRUPT_AT_BLOCK_GAP       (1LL<<31)
 255 /* Controller should not program HIGH_SPEED_EN after switching to high speed */
 256 #define SDHCI_QUIRK_BROKEN_CTRL_HISPD                   (1LL<<32)
 257 /* Controller supports 8-bit data width */
 258 #define SDHCI_QUIRK_8_BIT_DATA                          (1LL<<33)
 259 /* Controller has no version register */
 260 #define SDHCI_QUIRK_NO_VERSION_REG                      (1LL<<34)
 261 /* Controller treats ADMA descriptors with length 0000h incorrectly */
 262 #define SDHCI_QUIRK_BROKEN_ADMA_ZEROLEN_DESC            (1LL<<35)
 263 /* Controller should not use SDIO IRQ */
 264 #define SDHCI_QUIRK_NO_SDIO_IRQ                         (1LL<<36)
 265 /* Controller should only use high-speed mode */
 266 #define SDHCI_QUIRK_FORCE_HIGH_SPEED_MODE               (1LL<<37)
 267 /* Controller allows runtime enable / disable */
 268 #define SDHCI_QUIRK_RUNTIME_DISABLE                     (1LL<<38)
 269
 270         int                     irq;            /* Device IRQ */
 271         void __iomem *          ioaddr;         /* Mapped address */
 272
 273         const struct sdhci_ops  *ops;           /* Low level hw interface */
 274
 275         struct regulator        *vmmc;          /* Power regulator */
 276
 277         /* Internal data */
 278         struct mmc_host         *mmc;           /* MMC structure */
 279         u64                     dma_mask;       /* custom DMA mask */
 280
 281 #if defined(CONFIG_LEDS_CLASS) || defined(CONFIG_LEDS_CLASS_MODULE)
 282         struct led_classdev     led;            /* LED control */
 283         char   led_name[32];
 284 #endif
 285
 286         spinlock_t              lock;           /* Mutex */
 287
 288         int                     flags;          /* Host attributes */
 289 #define SDHCI_USE_SDMA          (1<<0)          /* Host is SDMA capable */
 290 #define SDHCI_USE_ADMA          (1<<1)          /* Host is ADMA capable */
 291 #define SDHCI_REQ_USE_DMA       (1<<2)          /* Use DMA for this req. */
 292 #define SDHCI_DEVICE_DEAD       (1<<3)          /* Device unresponsive */
 293
 294         unsigned int            version;        /* SDHCI spec. version */
 295
 296         unsigned int            max_clk;        /* Max possible freq (MHz) */
 297         unsigned int            timeout_clk;    /* Timeout freq (KHz) */
 298
 299         unsigned int            clock;          /* Current clock (MHz) */
 300         u8                      pwr;            /* Current voltage */
 301
 302         struct mmc_request      *mrq;           /* Current request */
 303         struct mmc_command      *cmd;           /* Current command */
 304         struct mmc_data         *data;          /* Current data request */
 305         unsigned int            data_early:1;   /* Data finished before cmd */
 306
 307         struct sg_mapping_iter  sg_miter;       /* SG state for PIO */
 308         unsigned int            blocks;         /* remaining PIO blocks */
 309
 310         int                     sg_count;       /* Mapped sg entries */
 311
 312         u8                      *adma_desc;     /* ADMA descriptor table */
 313         u8                      *align_buffer;  /* Bounce buffer */
 314
 315         dma_addr_t              adma_addr;      /* Mapped ADMA descr. table */
 316         dma_addr_t              align_addr;     /* Mapped bounce buffer */
 317
 318         struct tasklet_struct   card_tasklet;   /* Tasklet structures */
 319         struct tasklet_struct   finish_tasklet;
 320
 321         struct timer_list       timer;          /* Timer for timeouts */
 322
 323         unsigned int            caps;           /* Alternative capabilities */
 324
 325         unsigned long           private[0] ____cacheline_aligned;
 326 };
 327
 328
 329 struct sdhci_ops {
 330 #ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS
 331         u32             (*read_l)(struct sdhci_host *host, int reg);
 332         u16             (*read_w)(struct sdhci_host *host, int reg);
 333         u8              (*read_b)(struct sdhci_host *host, int reg);
 334         void            (*write_l)(struct sdhci_host *host, u32 val, int reg);
 335         void            (*write_w)(struct sdhci_host *host, u16 val, int reg);
 336         void            (*write_b)(struct sdhci_host *host, u8 val, int reg);
 337 #endif
 338
 339         void    (*set_clock)(struct sdhci_host *host, unsigned int clock);
 340
 341         int             (*enable_dma)(struct sdhci_host *host);
 342         int             (*get_ro)(struct sdhci_host *host);
 343         unsigned int    (*get_max_clock)(struct sdhci_host *host);
 344         unsigned int    (*get_min_clock)(struct sdhci_host *host);
 345         unsigned int    (*get_timeout_clock)(struct sdhci_host *host);
 346 };
 347
 348 #ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS
 349
 350 static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg)
 351 {
 352         if (unlikely(host->ops->write_l))
 353                 host->ops->write_l(host, val, reg);
 354         else
 355                 writel(val, host->ioaddr + reg);
 356 }
 357
 358 static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg)
 359 {
 360         if (unlikely(host->ops->write_w))
 361                 host->ops->write_w(host, val, reg);
 362         else
 363                 writew(val, host->ioaddr + reg);
 364 }
 365
 366 static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg)
 367 {
 368         if (unlikely(host->ops->write_b))
 369                 host->ops->write_b(host, val, reg);
 370         else
 371                 writeb(val, host->ioaddr + reg);
 372 }
 373
 374 static inline u32 sdhci_readl(struct sdhci_host *host, int reg)
 375 {
 376         if (unlikely(host->ops->read_l))
 377                 return host->ops->read_l(host, reg);
 378         else
 379                 return readl(host->ioaddr + reg);
 380 }
 381
 382 static inline u16 sdhci_readw(struct sdhci_host *host, int reg)
 383 {
 384         if (unlikely(host->ops->read_w))
 385                 return host->ops->read_w(host, reg);
 386         else
 387                 return readw(host->ioaddr + reg);
 388 }
 389
 390 static inline u8 sdhci_readb(struct sdhci_host *host, int reg)
 391 {
 392         if (unlikely(host->ops->read_b))
 393                 return host->ops->read_b(host, reg);
 394         else
 395                 return readb(host->ioaddr + reg);
 396 }
 397
 398 #else
 399
 400 static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg)
 401 {
 402         writel(val, host->ioaddr + reg);
 403 }
 404
 405 static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg)
 406 {
 407         writew(val, host->ioaddr + reg);
 408 }
 409
 410 static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg)
 411 {
 412         writeb(val, host->ioaddr + reg);
 413 }
 414
 415 static inline u32 sdhci_readl(struct sdhci_host *host, int reg)
 416 {
 417         return readl(host->ioaddr + reg);
 418 }
 419
 420 static inline u16 sdhci_readw(struct sdhci_host *host, int reg)
 421 {
 422         return readw(host->ioaddr + reg);
 423 }
 424
 425 static inline u8 sdhci_readb(struct sdhci_host *host, int reg)
 426 {
 427         return readb(host->ioaddr + reg);
 428 }
 429
 430 #endif /* CONFIG_MMC_SDHCI_IO_ACCESSORS */
 431
 432 extern struct sdhci_host *sdhci_alloc_host(struct device *dev,
 433         size_t priv_size);
 434 extern void sdhci_free_host(struct sdhci_host *host);
 435 extern void sdhci_card_detect_callback(struct sdhci_host *host);
 436
 437 static inline void *sdhci_priv(struct sdhci_host *host)
 438 {
 439         return (void *)host->private;
 440 }
 441
 442 extern void sdhci_card_detect(struct sdhci_host *host);
 443 extern int sdhci_add_host(struct sdhci_host *host);
 444 extern void sdhci_remove_host(struct sdhci_host *host, int dead);
 445
 446 #ifdef CONFIG_PM
 447 extern int sdhci_suspend_host(struct sdhci_host *host, pm_message_t state);
 448 extern int sdhci_resume_host(struct sdhci_host *host);
 449 #endif
 450
 451 #endif /* __SDHCI_H */