SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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
  12 /*
  13  * Controller registers
  14  */
  15
  16 #define SDHCI_DMA_ADDRESS       0x00
  17
  18 #define SDHCI_BLOCK_SIZE        0x04
  19 #define  SDHCI_MAKE_BLKSZ(dma, blksz) (((dma & 0x7) << 12) | (blksz & 0xFFF))
  20
  21 #define SDHCI_BLOCK_COUNT       0x06
  22
  23 #define SDHCI_ARGUMENT          0x08
  24
  25 #define SDHCI_TRANSFER_MODE     0x0C
  26 #define  SDHCI_TRNS_DMA         0x01
  27 #define  SDHCI_TRNS_BLK_CNT_EN  0x02
  28 #define  SDHCI_TRNS_ACMD12      0x04
  29 #define  SDHCI_TRNS_READ        0x10
  30 #define  SDHCI_TRNS_MULTI       0x20
  31
  32 #define SDHCI_COMMAND           0x0E
  33 #define  SDHCI_CMD_RESP_MASK    0x03
  34 #define  SDHCI_CMD_CRC          0x08
  35 #define  SDHCI_CMD_INDEX        0x10
  36 #define  SDHCI_CMD_DATA         0x20
  37
  38 #define  SDHCI_CMD_RESP_NONE    0x00
  39 #define  SDHCI_CMD_RESP_LONG    0x01
  40 #define  SDHCI_CMD_RESP_SHORT   0x02
  41 #define  SDHCI_CMD_RESP_SHORT_BUSY 0x03
  42
  43 #define SDHCI_MAKE_CMD(c, f) (((c & 0xff) << 8) | (f & 0xff))
  44
  45 #define SDHCI_RESPONSE          0x10
  46
  47 #define SDHCI_BUFFER            0x20
  48
  49 #define SDHCI_PRESENT_STATE     0x24
  50 #define  SDHCI_CMD_INHIBIT      0x00000001
  51 #define  SDHCI_DATA_INHIBIT     0x00000002
  52 #define  SDHCI_DOING_WRITE      0x00000100
  53 #define  SDHCI_DOING_READ       0x00000200
  54 #define  SDHCI_SPACE_AVAILABLE  0x00000400
  55 #define  SDHCI_DATA_AVAILABLE   0x00000800
  56 #define  SDHCI_CARD_PRESENT     0x00010000
  57 #define  SDHCI_WRITE_PROTECT    0x00080000
  58
  59 #define SDHCI_HOST_CONTROL      0x28
  60 #define  SDHCI_CTRL_LED         0x01
  61 #define  SDHCI_CTRL_4BITBUS     0x02
  62 #define  SDHCI_CTRL_HISPD       0x04
  63
  64 #define SDHCI_POWER_CONTROL     0x29
  65 #define  SDHCI_POWER_ON         0x01
  66 #define  SDHCI_POWER_180        0x0A
  67 #define  SDHCI_POWER_300        0x0C
  68 #define  SDHCI_POWER_330        0x0E
  69
  70 #define SDHCI_BLOCK_GAP_CONTROL 0x2A
  71
  72 #define SDHCI_WAKE_UP_CONTROL   0x2B
  73
  74 #define SDHCI_CLOCK_CONTROL     0x2C
  75 #define  SDHCI_DIVIDER_SHIFT    8
  76 #define  SDHCI_CLOCK_CARD_EN    0x0004
  77 #define  SDHCI_CLOCK_INT_STABLE 0x0002
  78 #define  SDHCI_CLOCK_INT_EN     0x0001
  79
  80 #define SDHCI_TIMEOUT_CONTROL   0x2E
  81
  82 #define SDHCI_SOFTWARE_RESET    0x2F
  83 #define  SDHCI_RESET_ALL        0x01
  84 #define  SDHCI_RESET_CMD        0x02
  85 #define  SDHCI_RESET_DATA       0x04
  86
  87 #define SDHCI_INT_STATUS        0x30
  88 #define SDHCI_INT_ENABLE        0x34
  89 #define SDHCI_SIGNAL_ENABLE     0x38
  90 #define  SDHCI_INT_RESPONSE     0x00000001
  91 #define  SDHCI_INT_DATA_END     0x00000002
  92 #define  SDHCI_INT_DMA_END      0x00000008
  93 #define  SDHCI_INT_SPACE_AVAIL  0x00000010
  94 #define  SDHCI_INT_DATA_AVAIL   0x00000020
  95 #define  SDHCI_INT_CARD_INSERT  0x00000040
  96 #define  SDHCI_INT_CARD_REMOVE  0x00000080
  97 #define  SDHCI_INT_CARD_INT     0x00000100
  98 #define  SDHCI_INT_ERROR        0x00008000
  99 #define  SDHCI_INT_TIMEOUT      0x00010000
 100 #define  SDHCI_INT_CRC          0x00020000
 101 #define  SDHCI_INT_END_BIT      0x00040000
 102 #define  SDHCI_INT_INDEX        0x00080000
 103 #define  SDHCI_INT_DATA_TIMEOUT 0x00100000
 104 #define  SDHCI_INT_DATA_CRC     0x00200000
 105 #define  SDHCI_INT_DATA_END_BIT 0x00400000
 106 #define  SDHCI_INT_BUS_POWER    0x00800000
 107 #define  SDHCI_INT_ACMD12ERR    0x01000000
 108
 109 #define  SDHCI_INT_NORMAL_MASK  0x00007FFF
 110 #define  SDHCI_INT_ERROR_MASK   0xFFFF8000
 111
 112 #define  SDHCI_INT_CMD_MASK     (SDHCI_INT_RESPONSE | SDHCI_INT_TIMEOUT | \
 113                 SDHCI_INT_CRC | SDHCI_INT_END_BIT | SDHCI_INT_INDEX)
 114 #define  SDHCI_INT_DATA_MASK    (SDHCI_INT_DATA_END | SDHCI_INT_DMA_END | \
 115                 SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL | \
 116                 SDHCI_INT_DATA_TIMEOUT | SDHCI_INT_DATA_CRC | \
 117                 SDHCI_INT_DATA_END_BIT)
 118
 119 #define SDHCI_ACMD12_ERR        0x3C
 120
 121 /* 3E-3F reserved */
 122
 123 #define SDHCI_CAPABILITIES      0x40
 124 #define  SDHCI_TIMEOUT_CLK_MASK 0x0000003F
 125 #define  SDHCI_TIMEOUT_CLK_SHIFT 0
 126 #define  SDHCI_TIMEOUT_CLK_UNIT 0x00000080
 127 #define  SDHCI_CLOCK_BASE_MASK  0x00003F00
 128 #define  SDHCI_CLOCK_BASE_SHIFT 8
 129 #define  SDHCI_MAX_BLOCK_MASK   0x00030000
 130 #define  SDHCI_MAX_BLOCK_SHIFT  16
 131 #define  SDHCI_CAN_DO_HISPD     0x00200000
 132 #define  SDHCI_CAN_DO_DMA       0x00400000
 133 #define  SDHCI_CAN_VDD_330      0x01000000
 134 #define  SDHCI_CAN_VDD_300      0x02000000
 135 #define  SDHCI_CAN_VDD_180      0x04000000
 136
 137 /* 44-47 reserved for more caps */
 138
 139 #define SDHCI_MAX_CURRENT       0x48
 140
 141 /* 4C-4F reserved for more max current */
 142
 143 /* 50-FB reserved */
 144
 145 #define SDHCI_SLOT_INT_STATUS   0xFC
 146
 147 #define SDHCI_HOST_VERSION      0xFE
 148 #define  SDHCI_VENDOR_VER_MASK  0xFF00
 149 #define  SDHCI_VENDOR_VER_SHIFT 8
 150 #define  SDHCI_SPEC_VER_MASK    0x00FF
 151 #define  SDHCI_SPEC_VER_SHIFT   0
 152
 153 struct sdhci_ops;
 154
 155 struct sdhci_host {
 156         /* Data set by hardware interface driver */
 157         const char              *hw_name;       /* Hardware bus name */
 158
 159         unsigned int            quirks;         /* Deviations from spec. */
 160
 161 /* Controller doesn't honor resets unless we touch the clock register */
 162 #define SDHCI_QUIRK_CLOCK_BEFORE_RESET                  (1<<0)
 163 /* Controller has bad caps bits, but really supports DMA */
 164 #define SDHCI_QUIRK_FORCE_DMA                           (1<<1)
 165 /* Controller doesn't like to be reset when there is no card inserted. */
 166 #define SDHCI_QUIRK_NO_CARD_NO_RESET                    (1<<2)
 167 /* Controller doesn't like clearing the power reg before a change */
 168 #define SDHCI_QUIRK_SINGLE_POWER_WRITE                  (1<<3)
 169 /* Controller has flaky internal state so reset it on each ios change */
 170 #define SDHCI_QUIRK_RESET_CMD_DATA_ON_IOS               (1<<4)
 171 /* Controller has an unusable DMA engine */
 172 #define SDHCI_QUIRK_BROKEN_DMA                          (1<<5)
 173 /* Controller can only DMA from 32-bit aligned addresses */
 174 #define SDHCI_QUIRK_32BIT_DMA_ADDR                      (1<<6)
 175 /* Controller can only DMA chunk sizes that are a multiple of 32 bits */
 176 #define SDHCI_QUIRK_32BIT_DMA_SIZE                      (1<<7)
 177 /* Controller needs to be reset after each request to stay stable */
 178 #define SDHCI_QUIRK_RESET_AFTER_REQUEST                 (1<<8)
 179 /* Controller needs voltage and power writes to happen separately */
 180 #define SDHCI_QUIRK_NO_SIMULT_VDD_AND_POWER             (1<<9)
 181 /* Controller has an off-by-one issue with timeout value */
 182 #define SDHCI_QUIRK_INCR_TIMEOUT_CONTROL                (1<<10)
 183
 184         int                     irq;            /* Device IRQ */
 185         void __iomem *          ioaddr;         /* Mapped address */
 186
 187         const struct sdhci_ops  *ops;           /* Low level hw interface */
 188
 189         /* Internal data */
 190         struct mmc_host         *mmc;           /* MMC structure */
 191
 192 #ifdef CONFIG_LEDS_CLASS
 193         struct led_classdev     led;            /* LED control */
 194 #endif
 195
 196         spinlock_t              lock;           /* Mutex */
 197
 198         int                     flags;          /* Host attributes */
 199 #define SDHCI_USE_DMA           (1<<0)          /* Host is DMA capable */
 200 #define SDHCI_REQ_USE_DMA       (1<<1)          /* Use DMA for this req. */
 201
 202         unsigned int            max_clk;        /* Max possible freq (MHz) */
 203         unsigned int            timeout_clk;    /* Timeout freq (KHz) */
 204
 205         unsigned int            clock;          /* Current clock (MHz) */
 206         unsigned short          power;          /* Current voltage */
 207
 208         struct mmc_request      *mrq;           /* Current request */
 209         struct mmc_command      *cmd;           /* Current command */
 210         struct mmc_data         *data;          /* Current data request */
 211         unsigned int            data_early:1;   /* Data finished before cmd */
 212
 213         struct scatterlist      *cur_sg;        /* We're working on this */
 214         int                     num_sg;         /* Entries left */
 215         int                     offset;         /* Offset into current sg */
 216         int                     remain;         /* Bytes left in current */
 217
 218         struct tasklet_struct   card_tasklet;   /* Tasklet structures */
 219         struct tasklet_struct   finish_tasklet;
 220
 221         struct timer_list       timer;          /* Timer for timeouts */
 222
 223         unsigned long           private[0] ____cacheline_aligned;
 224 };
 225
 226
 227 struct sdhci_ops {
 228         int             (*enable_dma)(struct sdhci_host *host);
 229 };
 230
 231
 232 extern struct sdhci_host *sdhci_alloc_host(struct device *dev,
 233         size_t priv_size);
 234 extern void sdhci_free_host(struct sdhci_host *host);
 235
 236 static inline void *sdhci_priv(struct sdhci_host *host)
 237 {
 238         return (void *)host->private;
 239 }
 240
 241 extern int sdhci_add_host(struct sdhci_host *host);
 242 extern void sdhci_remove_host(struct sdhci_host *host);
 243
 244 #ifdef CONFIG_PM
 245 extern int sdhci_suspend_host(struct sdhci_host *host, pm_message_t state);
 246 extern int sdhci_resume_host(struct sdhci_host *host);
 247 #endif