sys/dev/sdhci/sdhci.h

   1 /*-
   2  * Copyright (c) 2008 Alexander Motin <mav@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  *
  25  * $FreeBSD$
  26  */
  27
  28 #ifndef __SDHCI_H__
  29 #define __SDHCI_H__
  30
  31 #define DMA_BLOCK_SIZE  4096
  32 #define DMA_BOUNDARY    0       /* DMA reload every 4K */
  33
  34 /* Controller doesn't honor resets unless we touch the clock register */
  35 #define SDHCI_QUIRK_CLOCK_BEFORE_RESET                  (1<<0)
  36 /* Controller really supports DMA */
  37 #define SDHCI_QUIRK_FORCE_DMA                           (1<<1)
  38 /* Controller has unusable DMA engine */
  39 #define SDHCI_QUIRK_BROKEN_DMA                          (1<<2)
  40 /* Controller doesn't like to be reset when there is no card inserted. */
  41 #define SDHCI_QUIRK_NO_CARD_NO_RESET                    (1<<3)
  42 /* Controller has flaky internal state so reset it on each ios change */
  43 #define SDHCI_QUIRK_RESET_ON_IOS                        (1<<4)
  44 /* Controller can only DMA chunk sizes that are a multiple of 32 bits */
  45 #define SDHCI_QUIRK_32BIT_DMA_SIZE                      (1<<5)
  46 /* Controller needs to be reset after each request to stay stable */
  47 #define SDHCI_QUIRK_RESET_AFTER_REQUEST                 (1<<6)
  48 /* Controller has an off-by-one issue with timeout value */
  49 #define SDHCI_QUIRK_INCR_TIMEOUT_CONTROL                (1<<7)
  50 /* Controller has broken read timings */
  51 #define SDHCI_QUIRK_BROKEN_TIMINGS                      (1<<8)
  52 /* Controller needs lowered frequency */
  53 #define SDHCI_QUIRK_LOWER_FREQUENCY                     (1<<9)
  54 /* Data timeout is invalid, should use SD clock */
  55 #define SDHCI_QUIRK_DATA_TIMEOUT_USES_SDCLK             (1<<10)
  56 /* Timeout value is invalid, should be overriden */
  57 #define SDHCI_QUIRK_BROKEN_TIMEOUT_VAL                  (1<<11)
  58 /* SDHCI_CAPABILITIES is invalid */
  59 #define SDHCI_QUIRK_MISSING_CAPS                        (1<<12)
  60 /* Hardware shifts the 136-bit response, don't do it in software. */
  61 #define SDHCI_QUIRK_DONT_SHIFT_RESPONSE                 (1<<13)
  62
  63 /*
  64  * Controller registers
  65  */
  66 #define SDHCI_DMA_ADDRESS       0x00
  67
  68 #define SDHCI_BLOCK_SIZE        0x04
  69 #define  SDHCI_MAKE_BLKSZ(dma, blksz) (((dma & 0x7) << 12) | (blksz & 0xFFF))
  70
  71 #define SDHCI_BLOCK_COUNT       0x06
  72
  73 #define SDHCI_ARGUMENT          0x08
  74
  75 #define SDHCI_TRANSFER_MODE     0x0C
  76 #define  SDHCI_TRNS_DMA         0x01
  77 #define  SDHCI_TRNS_BLK_CNT_EN  0x02
  78 #define  SDHCI_TRNS_ACMD12      0x04
  79 #define  SDHCI_TRNS_READ        0x10
  80 #define  SDHCI_TRNS_MULTI       0x20
  81
  82 #define SDHCI_COMMAND_FLAGS     0x0E
  83 #define  SDHCI_CMD_RESP_NONE    0x00
  84 #define  SDHCI_CMD_RESP_LONG    0x01
  85 #define  SDHCI_CMD_RESP_SHORT   0x02
  86 #define  SDHCI_CMD_RESP_SHORT_BUSY 0x03
  87 #define  SDHCI_CMD_RESP_MASK    0x03
  88 #define  SDHCI_CMD_CRC          0x08
  89 #define  SDHCI_CMD_INDEX        0x10
  90 #define  SDHCI_CMD_DATA         0x20
  91 #define  SDHCI_CMD_TYPE_NORMAL  0x00
  92 #define  SDHCI_CMD_TYPE_SUSPEND 0x40
  93 #define  SDHCI_CMD_TYPE_RESUME  0x80
  94 #define  SDHCI_CMD_TYPE_ABORT   0xc0
  95 #define  SDHCI_CMD_TYPE_MASK    0xc0
  96
  97 #define SDHCI_COMMAND           0x0F
  98
  99 #define SDHCI_RESPONSE          0x10
 100
 101 #define SDHCI_BUFFER            0x20
 102
 103 #define SDHCI_PRESENT_STATE     0x24
 104 #define  SDHCI_CMD_INHIBIT      0x00000001
 105 #define  SDHCI_DAT_INHIBIT      0x00000002
 106 #define  SDHCI_DAT_ACTIVE       0x00000004
 107 #define  SDHCI_RETUNE_REQUEST   0x00000008
 108 #define  SDHCI_DOING_WRITE      0x00000100
 109 #define  SDHCI_DOING_READ       0x00000200
 110 #define  SDHCI_SPACE_AVAILABLE  0x00000400
 111 #define  SDHCI_DATA_AVAILABLE   0x00000800
 112 #define  SDHCI_CARD_PRESENT     0x00010000
 113 #define  SDHCI_CARD_STABLE      0x00020000
 114 #define  SDHCI_CARD_PIN         0x00040000
 115 #define  SDHCI_WRITE_PROTECT    0x00080000
 116 #define  SDHCI_STATE_DAT_MASK   0x00f00000
 117 #define  SDHCI_STATE_CMD        0x01000000
 118
 119 #define SDHCI_HOST_CONTROL      0x28
 120 #define  SDHCI_CTRL_LED         0x01
 121 #define  SDHCI_CTRL_4BITBUS     0x02
 122 #define  SDHCI_CTRL_HISPD       0x04
 123 #define  SDHCI_CTRL_SDMA        0x08
 124 #define  SDHCI_CTRL_ADMA2       0x10
 125 #define  SDHCI_CTRL_ADMA264     0x18
 126 #define  SDHCI_CTRL_DMA_MASK    0x18
 127 #define  SDHCI_CTRL_8BITBUS     0x20
 128 #define  SDHCI_CTRL_CARD_DET    0x40
 129 #define  SDHCI_CTRL_FORCE_CARD  0x80
 130
 131 #define SDHCI_POWER_CONTROL     0x29
 132 #define  SDHCI_POWER_ON         0x01
 133 #define  SDHCI_POWER_180        0x0A
 134 #define  SDHCI_POWER_300        0x0C
 135 #define  SDHCI_POWER_330        0x0E
 136
 137 #define SDHCI_BLOCK_GAP_CONTROL 0x2A
 138
 139 #define SDHCI_WAKE_UP_CONTROL   0x2B
 140
 141 #define SDHCI_CLOCK_CONTROL     0x2C
 142 #define  SDHCI_DIVIDER_MASK     0xff
 143 #define  SDHCI_DIVIDER_MASK_LEN 8
 144 #define  SDHCI_DIVIDER_SHIFT    8
 145 #define  SDHCI_DIVIDER_HI_MASK  3
 146 #define  SDHCI_DIVIDER_HI_SHIFT 6
 147 #define  SDHCI_CLOCK_CARD_EN    0x0004
 148 #define  SDHCI_CLOCK_INT_STABLE 0x0002
 149 #define  SDHCI_CLOCK_INT_EN     0x0001
 150
 151 #define SDHCI_TIMEOUT_CONTROL   0x2E
 152
 153 #define SDHCI_SOFTWARE_RESET    0x2F
 154 #define  SDHCI_RESET_ALL        0x01
 155 #define  SDHCI_RESET_CMD        0x02
 156 #define  SDHCI_RESET_DATA       0x04
 157
 158 #define SDHCI_INT_STATUS        0x30
 159 #define SDHCI_INT_ENABLE        0x34
 160 #define SDHCI_SIGNAL_ENABLE     0x38
 161 #define  SDHCI_INT_RESPONSE     0x00000001
 162 #define  SDHCI_INT_DATA_END     0x00000002
 163 #define  SDHCI_INT_BLOCK_GAP    0x00000004
 164 #define  SDHCI_INT_DMA_END      0x00000008
 165 #define  SDHCI_INT_SPACE_AVAIL  0x00000010
 166 #define  SDHCI_INT_DATA_AVAIL   0x00000020
 167 #define  SDHCI_INT_CARD_INSERT  0x00000040
 168 #define  SDHCI_INT_CARD_REMOVE  0x00000080
 169 #define  SDHCI_INT_CARD_INT     0x00000100
 170 #define  SDHCI_INT_ERROR        0x00008000
 171 #define  SDHCI_INT_TIMEOUT      0x00010000
 172 #define  SDHCI_INT_CRC          0x00020000
 173 #define  SDHCI_INT_END_BIT      0x00040000
 174 #define  SDHCI_INT_INDEX        0x00080000
 175 #define  SDHCI_INT_DATA_TIMEOUT 0x00100000
 176 #define  SDHCI_INT_DATA_CRC     0x00200000
 177 #define  SDHCI_INT_DATA_END_BIT 0x00400000
 178 #define  SDHCI_INT_BUS_POWER    0x00800000
 179 #define  SDHCI_INT_ACMD12ERR    0x01000000
 180 #define  SDHCI_INT_ADMAERR      0x02000000
 181
 182 #define  SDHCI_INT_NORMAL_MASK  0x00007FFF
 183 #define  SDHCI_INT_ERROR_MASK   0xFFFF8000
 184
 185 #define  SDHCI_INT_CMD_MASK     (SDHCI_INT_RESPONSE | SDHCI_INT_TIMEOUT | \
 186                 SDHCI_INT_CRC | SDHCI_INT_END_BIT | SDHCI_INT_INDEX)
 187 #define  SDHCI_INT_DATA_MASK    (SDHCI_INT_DATA_END | SDHCI_INT_DMA_END | \
 188                 SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL | \
 189                 SDHCI_INT_DATA_TIMEOUT | SDHCI_INT_DATA_CRC | \
 190                 SDHCI_INT_DATA_END_BIT)
 191
 192 #define SDHCI_ACMD12_ERR        0x3C
 193
 194 #define SDHCI_CAPABILITIES      0x40
 195 #define  SDHCI_TIMEOUT_CLK_MASK 0x0000003F
 196 #define  SDHCI_TIMEOUT_CLK_SHIFT 0
 197 #define  SDHCI_TIMEOUT_CLK_UNIT 0x00000080
 198 #define  SDHCI_CLOCK_BASE_MASK  0x00003F00
 199 #define  SDHCI_CLOCK_V3_BASE_MASK       0x0000FF00
 200 #define  SDHCI_CLOCK_BASE_SHIFT 8
 201 #define  SDHCI_MAX_BLOCK_MASK   0x00030000
 202 #define  SDHCI_MAX_BLOCK_SHIFT  16
 203 #define  SDHCI_CAN_DO_8BITBUS   0x00040000
 204 #define  SDHCI_CAN_DO_ADMA2     0x00080000
 205 #define  SDHCI_CAN_DO_HISPD     0x00200000
 206 #define  SDHCI_CAN_DO_DMA       0x00400000
 207 #define  SDHCI_CAN_DO_SUSPEND   0x00800000
 208 #define  SDHCI_CAN_VDD_330      0x01000000
 209 #define  SDHCI_CAN_VDD_300      0x02000000
 210 #define  SDHCI_CAN_VDD_180      0x04000000
 211 #define  SDHCI_CAN_DO_64BIT     0x10000000
 212
 213 #define SDHCI_MAX_CURRENT       0x48
 214
 215 #define SDHCI_SLOT_INT_STATUS   0xFC
 216
 217 #define SDHCI_HOST_VERSION      0xFE
 218 #define  SDHCI_VENDOR_VER_MASK  0xFF00
 219 #define  SDHCI_VENDOR_VER_SHIFT 8
 220 #define  SDHCI_SPEC_VER_MASK    0x00FF
 221 #define  SDHCI_SPEC_VER_SHIFT   0
 222 #define SDHCI_SPEC_100          0
 223 #define SDHCI_SPEC_200          1
 224 #define SDHCI_SPEC_300          2
 225
 226 SYSCTL_DECL(_hw_sdhci);
 227
 228 struct sdhci_slot {
 229         u_int           quirks;         /* Chip specific quirks */
 230         u_int           caps;           /* Override SDHCI_CAPABILITIES */
 231         device_t        bus;            /* Bus device */
 232         device_t        dev;            /* Slot device */
 233         u_char          num;            /* Slot number */
 234         u_char          opt;            /* Slot options */
 235 #define SDHCI_HAVE_DMA                  1
 236 #define SDHCI_PLATFORM_TRANSFER         2
 237         u_char          version;
 238         uint32_t        max_clk;        /* Max possible freq */
 239         uint32_t        timeout_clk;    /* Timeout freq */
 240         bus_dma_tag_t   dmatag;
 241         bus_dmamap_t    dmamap;
 242         u_char          *dmamem;
 243         bus_addr_t      paddr;          /* DMA buffer address */
 244         struct task     card_task;      /* Card presence check task */
 245         struct callout  card_callout;   /* Card insert delay callout */
 246         struct callout  timeout_callout;/* Card command/data response timeout */
 247         struct mmc_host host;           /* Host parameters */
 248         struct mmc_request *req;        /* Current request */
 249         struct mmc_command *curcmd;     /* Current command of current request */
 250
 251         uint32_t        intmask;        /* Current interrupt mask */
 252         uint32_t        clock;          /* Current clock freq. */
 253         size_t          offset;         /* Data buffer offset */
 254         uint8_t         hostctrl;       /* Current host control register */
 255         u_char          power;          /* Current power */
 256         u_char          bus_busy;       /* Bus busy status */
 257         u_char          cmd_done;       /* CMD command part done flag */
 258         u_char          data_done;      /* DAT command part done flag */
 259         u_char          flags;          /* Request execution flags */
 260 #define CMD_STARTED             1
 261 #define STOP_STARTED            2
 262 #define SDHCI_USE_DMA           4       /* Use DMA for this req. */
 263 #define PLATFORM_DATA_STARTED   8       /* Data transfer is handled by platform */
 264         struct mtx      mtx;            /* Slot mutex */
 265 };
 266
 267 int sdhci_generic_read_ivar(device_t bus, device_t child, int which, uintptr_t *result);
 268 int sdhci_generic_write_ivar(device_t bus, device_t child, int which, uintptr_t value);
 269 int sdhci_init_slot(device_t dev, struct sdhci_slot *slot, int num);
 270 void sdhci_start_slot(struct sdhci_slot *slot);
 271 /* performs generic clean-up for platform transfers */
 272 void sdhci_finish_data(struct sdhci_slot *slot);
 273 int sdhci_cleanup_slot(struct sdhci_slot *slot);
 274 int sdhci_generic_suspend(struct sdhci_slot *slot);
 275 int sdhci_generic_resume(struct sdhci_slot *slot);
 276 int sdhci_generic_update_ios(device_t brdev, device_t reqdev);
 277 int sdhci_generic_request(device_t brdev, device_t reqdev, struct mmc_request *req);
 278 int sdhci_generic_get_ro(device_t brdev, device_t reqdev);
 279 int sdhci_generic_acquire_host(device_t brdev, device_t reqdev);
 280 int sdhci_generic_release_host(device_t brdev, device_t reqdev);
 281 void sdhci_generic_intr(struct sdhci_slot *slot);
 282 uint32_t sdhci_generic_min_freq(device_t brdev, struct sdhci_slot *slot);
 283
 284 #endif  /* __SDHCI_H__ */