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 /* Macro for sizing the SDMA bounce buffer on the SDMA buffer boundary. */
  32 #define SDHCI_SDMA_BNDRY_TO_BBUFSZ(bndry)       (4096 * (1 << bndry))
  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 /* Wait to see reset bit asserted before waiting for de-asserted  */
  63 #define SDHCI_QUIRK_WAITFOR_RESET_ASSERTED              (1 << 14)
  64 /* Leave controller in standard mode when putting card in HS mode. */
  65 #define SDHCI_QUIRK_DONT_SET_HISPD_BIT                  (1 << 15)
  66 /* Alternate clock source is required when supplying a 400 KHz clock. */
  67 #define SDHCI_QUIRK_BCM577XX_400KHZ_CLKSRC              (1 << 16)
  68 /* Card insert/remove interrupts don't work, polling required. */
  69 #define SDHCI_QUIRK_POLL_CARD_PRESENT                   (1 << 17)
  70 /* All controller slots are non-removable. */
  71 #define SDHCI_QUIRK_ALL_SLOTS_NON_REMOVABLE             (1 << 18)
  72 /* Issue custom Intel controller reset sequence after power-up. */
  73 #define SDHCI_QUIRK_INTEL_POWER_UP_RESET                (1 << 19)
  74 /* Data timeout is invalid, use 1 MHz clock instead. */
  75 #define SDHCI_QUIRK_DATA_TIMEOUT_1MHZ                   (1 << 20)
  76 /* Controller doesn't allow access boot partitions. */
  77 #define SDHCI_QUIRK_BOOT_NOACC                          (1 << 21)
  78 /* Controller waits for busy responses. */
  79 #define SDHCI_QUIRK_WAIT_WHILE_BUSY                     (1 << 22)
  80 /* Controller supports eMMC DDR52 mode. */
  81 #define SDHCI_QUIRK_MMC_DDR52                           (1 << 23)
  82 /* Controller support for UHS DDR50 mode is broken. */
  83 #define SDHCI_QUIRK_BROKEN_UHS_DDR50                    (1 << 24)
  84 /* Controller support for eMMC HS200 mode is broken. */
  85 #define SDHCI_QUIRK_BROKEN_MMC_HS200                    (1 << 25)
  86 /* Controller reports support for eMMC HS400 mode as SDHCI_CAN_MMC_HS400. */
  87 #define SDHCI_QUIRK_CAPS_BIT63_FOR_MMC_HS400            (1 << 26)
  88 /* Controller support for SDHCI_CTRL2_PRESET_VALUE is broken. */
  89 #define SDHCI_QUIRK_PRESET_VALUE_BROKEN                 (1 << 27)
  90 /* Controller supports eMMC HS400 mode if SDHCI_CAN_SDR104 is set. */
  91 #define SDHCI_QUIRK_MMC_HS400_IF_CAN_SDR104             (1 << 29)
  92 /* SDMA boundary in SDHCI_BLOCK_SIZE broken - use front-end supplied value. */
  93 #define SDHCI_QUIRK_BROKEN_SDMA_BOUNDARY                (1 << 30)
  94
  95 /*
  96  * Controller registers
  97  */
  98 #define SDHCI_DMA_ADDRESS       0x00
  99
 100 #define SDHCI_BLOCK_SIZE        0x04
 101 #define  SDHCI_BLKSZ_SDMA_BNDRY_4K      0x00
 102 #define  SDHCI_BLKSZ_SDMA_BNDRY_8K      0x01
 103 #define  SDHCI_BLKSZ_SDMA_BNDRY_16K     0x02
 104 #define  SDHCI_BLKSZ_SDMA_BNDRY_32K     0x03
 105 #define  SDHCI_BLKSZ_SDMA_BNDRY_64K     0x04
 106 #define  SDHCI_BLKSZ_SDMA_BNDRY_128K    0x05
 107 #define  SDHCI_BLKSZ_SDMA_BNDRY_256K    0x06
 108 #define  SDHCI_BLKSZ_SDMA_BNDRY_512K    0x07
 109 #define  SDHCI_MAKE_BLKSZ(dma, blksz) (((dma & 0x7) << 12) | (blksz & 0xFFF))
 110
 111 #define SDHCI_BLOCK_COUNT       0x06
 112
 113 #define SDHCI_ARGUMENT          0x08
 114
 115 #define SDHCI_TRANSFER_MODE     0x0C
 116 #define  SDHCI_TRNS_DMA         0x01
 117 #define  SDHCI_TRNS_BLK_CNT_EN  0x02
 118 #define  SDHCI_TRNS_ACMD12      0x04
 119 #define  SDHCI_TRNS_READ        0x10
 120 #define  SDHCI_TRNS_MULTI       0x20
 121
 122 #define SDHCI_COMMAND_FLAGS     0x0E
 123 #define  SDHCI_CMD_RESP_NONE    0x00
 124 #define  SDHCI_CMD_RESP_LONG    0x01
 125 #define  SDHCI_CMD_RESP_SHORT   0x02
 126 #define  SDHCI_CMD_RESP_SHORT_BUSY 0x03
 127 #define  SDHCI_CMD_RESP_MASK    0x03
 128 #define  SDHCI_CMD_CRC          0x08
 129 #define  SDHCI_CMD_INDEX        0x10
 130 #define  SDHCI_CMD_DATA         0x20
 131 #define  SDHCI_CMD_TYPE_NORMAL  0x00
 132 #define  SDHCI_CMD_TYPE_SUSPEND 0x40
 133 #define  SDHCI_CMD_TYPE_RESUME  0x80
 134 #define  SDHCI_CMD_TYPE_ABORT   0xc0
 135 #define  SDHCI_CMD_TYPE_MASK    0xc0
 136
 137 #define SDHCI_COMMAND           0x0F
 138
 139 #define SDHCI_RESPONSE          0x10
 140
 141 #define SDHCI_BUFFER            0x20
 142
 143 #define SDHCI_PRESENT_STATE     0x24
 144 #define  SDHCI_CMD_INHIBIT      0x00000001
 145 #define  SDHCI_DAT_INHIBIT      0x00000002
 146 #define  SDHCI_DAT_ACTIVE       0x00000004
 147 #define  SDHCI_RETUNE_REQUEST   0x00000008
 148 #define  SDHCI_DOING_WRITE      0x00000100
 149 #define  SDHCI_DOING_READ       0x00000200
 150 #define  SDHCI_SPACE_AVAILABLE  0x00000400
 151 #define  SDHCI_DATA_AVAILABLE   0x00000800
 152 #define  SDHCI_CARD_PRESENT     0x00010000
 153 #define  SDHCI_CARD_STABLE      0x00020000
 154 #define  SDHCI_CARD_PIN         0x00040000
 155 #define  SDHCI_WRITE_PROTECT    0x00080000
 156 #define  SDHCI_STATE_DAT_MASK   0x00f00000
 157 #define  SDHCI_STATE_CMD        0x01000000
 158
 159 #define SDHCI_HOST_CONTROL      0x28
 160 #define  SDHCI_CTRL_LED         0x01
 161 #define  SDHCI_CTRL_4BITBUS     0x02
 162 #define  SDHCI_CTRL_HISPD       0x04
 163 #define  SDHCI_CTRL_SDMA        0x08
 164 #define  SDHCI_CTRL_ADMA2       0x10
 165 #define  SDHCI_CTRL_ADMA264     0x18
 166 #define  SDHCI_CTRL_DMA_MASK    0x18
 167 #define  SDHCI_CTRL_8BITBUS     0x20
 168 #define  SDHCI_CTRL_CARD_DET    0x40
 169 #define  SDHCI_CTRL_FORCE_CARD  0x80
 170
 171 #define SDHCI_POWER_CONTROL     0x29
 172 #define  SDHCI_POWER_ON         0x01
 173 #define  SDHCI_POWER_180        0x0A
 174 #define  SDHCI_POWER_300        0x0C
 175 #define  SDHCI_POWER_330        0x0E
 176
 177 #define SDHCI_BLOCK_GAP_CONTROL 0x2A
 178
 179 #define SDHCI_WAKE_UP_CONTROL   0x2B
 180
 181 #define SDHCI_CLOCK_CONTROL     0x2C
 182 #define  SDHCI_DIVIDER_MASK     0xff
 183 #define  SDHCI_DIVIDER_MASK_LEN 8
 184 #define  SDHCI_DIVIDER_SHIFT    8
 185 #define  SDHCI_DIVIDER_HI_MASK  3
 186 #define  SDHCI_DIVIDER_HI_SHIFT 6
 187 #define  SDHCI_CLOCK_CARD_EN    0x0004
 188 #define  SDHCI_CLOCK_INT_STABLE 0x0002
 189 #define  SDHCI_CLOCK_INT_EN     0x0001
 190 #define  SDHCI_DIVIDERS_MASK    \
 191     ((SDHCI_DIVIDER_MASK << SDHCI_DIVIDER_SHIFT) | \
 192     (SDHCI_DIVIDER_HI_MASK << SDHCI_DIVIDER_HI_SHIFT))
 193
 194 #define SDHCI_TIMEOUT_CONTROL   0x2E
 195
 196 #define SDHCI_SOFTWARE_RESET    0x2F
 197 #define  SDHCI_RESET_ALL        0x01
 198 #define  SDHCI_RESET_CMD        0x02
 199 #define  SDHCI_RESET_DATA       0x04
 200
 201 #define SDHCI_INT_STATUS        0x30
 202 #define SDHCI_INT_ENABLE        0x34
 203 #define SDHCI_SIGNAL_ENABLE     0x38
 204 #define  SDHCI_INT_RESPONSE     0x00000001
 205 #define  SDHCI_INT_DATA_END     0x00000002
 206 #define  SDHCI_INT_BLOCK_GAP    0x00000004
 207 #define  SDHCI_INT_DMA_END      0x00000008
 208 #define  SDHCI_INT_SPACE_AVAIL  0x00000010
 209 #define  SDHCI_INT_DATA_AVAIL   0x00000020
 210 #define  SDHCI_INT_CARD_INSERT  0x00000040
 211 #define  SDHCI_INT_CARD_REMOVE  0x00000080
 212 #define  SDHCI_INT_CARD_INT     0x00000100
 213 #define  SDHCI_INT_INT_A        0x00000200
 214 #define  SDHCI_INT_INT_B        0x00000400
 215 #define  SDHCI_INT_INT_C        0x00000800
 216 #define  SDHCI_INT_RETUNE       0x00001000
 217 #define  SDHCI_INT_ERROR        0x00008000
 218 #define  SDHCI_INT_TIMEOUT      0x00010000
 219 #define  SDHCI_INT_CRC          0x00020000
 220 #define  SDHCI_INT_END_BIT      0x00040000
 221 #define  SDHCI_INT_INDEX        0x00080000
 222 #define  SDHCI_INT_DATA_TIMEOUT 0x00100000
 223 #define  SDHCI_INT_DATA_CRC     0x00200000
 224 #define  SDHCI_INT_DATA_END_BIT 0x00400000
 225 #define  SDHCI_INT_BUS_POWER    0x00800000
 226 #define  SDHCI_INT_ACMD12ERR    0x01000000
 227 #define  SDHCI_INT_ADMAERR      0x02000000
 228 #define  SDHCI_INT_TUNEERR      0x04000000
 229
 230 #define  SDHCI_INT_NORMAL_MASK  0x00007FFF
 231 #define  SDHCI_INT_ERROR_MASK   0xFFFF8000
 232
 233 #define  SDHCI_INT_CMD_ERROR_MASK       (SDHCI_INT_TIMEOUT | \
 234                 SDHCI_INT_CRC | SDHCI_INT_END_BIT | SDHCI_INT_INDEX)
 235
 236 #define  SDHCI_INT_CMD_MASK     (SDHCI_INT_RESPONSE | SDHCI_INT_CMD_ERROR_MASK)
 237
 238 #define  SDHCI_INT_DATA_MASK    (SDHCI_INT_DATA_END | SDHCI_INT_DMA_END | \
 239                 SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL | \
 240                 SDHCI_INT_DATA_TIMEOUT | SDHCI_INT_DATA_CRC | \
 241                 SDHCI_INT_DATA_END_BIT)
 242
 243 #define SDHCI_ACMD12_ERR        0x3C
 244
 245 #define SDHCI_HOST_CONTROL2     0x3E
 246 #define  SDHCI_CTRL2_PRESET_VALUE       0x8000
 247 #define  SDHCI_CTRL2_ASYNC_INTR 0x4000
 248 #define  SDHCI_CTRL2_64BIT_ENABLE       0x2000
 249 #define  SDHCI_CTRL2_HOST_V4_ENABLE     0x1000
 250 #define  SDHCI_CTRL2_CMD23_ENABLE       0x0800
 251 #define  SDHCI_CTRL2_ADMA2_LENGTH_MODE  0x0400
 252 #define  SDHCI_CTRL2_UHS2_IFACE_ENABLE  0x0100
 253 #define  SDHCI_CTRL2_SAMPLING_CLOCK     0x0080
 254 #define  SDHCI_CTRL2_EXEC_TUNING        0x0040
 255 #define  SDHCI_CTRL2_DRIVER_TYPE_MASK   0x0030
 256 #define  SDHCI_CTRL2_DRIVER_TYPE_B      0x0000
 257 #define  SDHCI_CTRL2_DRIVER_TYPE_A      0x0010
 258 #define  SDHCI_CTRL2_DRIVER_TYPE_C      0x0020
 259 #define  SDHCI_CTRL2_DRIVER_TYPE_D      0x0030
 260 #define  SDHCI_CTRL2_S18_ENABLE 0x0008
 261 #define  SDHCI_CTRL2_UHS_MASK   0x0007
 262 #define  SDHCI_CTRL2_UHS_SDR12  0x0000
 263 #define  SDHCI_CTRL2_UHS_SDR25  0x0001
 264 #define  SDHCI_CTRL2_UHS_SDR50  0x0002
 265 #define  SDHCI_CTRL2_UHS_SDR104 0x0003
 266 #define  SDHCI_CTRL2_UHS_DDR50  0x0004
 267 #define  SDHCI_CTRL2_MMC_HS400  0x0005  /* non-standard */
 268
 269 #define SDHCI_CAPABILITIES      0x40
 270 #define  SDHCI_TIMEOUT_CLK_MASK 0x0000003F
 271 #define  SDHCI_TIMEOUT_CLK_SHIFT 0
 272 #define  SDHCI_TIMEOUT_CLK_UNIT 0x00000080
 273 #define  SDHCI_CLOCK_BASE_MASK  0x00003F00
 274 #define  SDHCI_CLOCK_V3_BASE_MASK       0x0000FF00
 275 #define  SDHCI_CLOCK_BASE_SHIFT 8
 276 #define  SDHCI_MAX_BLOCK_MASK   0x00030000
 277 #define  SDHCI_MAX_BLOCK_SHIFT  16
 278 #define  SDHCI_CAN_DO_8BITBUS   0x00040000
 279 #define  SDHCI_CAN_DO_ADMA2     0x00080000
 280 #define  SDHCI_CAN_DO_HISPD     0x00200000
 281 #define  SDHCI_CAN_DO_DMA       0x00400000
 282 #define  SDHCI_CAN_DO_SUSPEND   0x00800000
 283 #define  SDHCI_CAN_VDD_330      0x01000000
 284 #define  SDHCI_CAN_VDD_300      0x02000000
 285 #define  SDHCI_CAN_VDD_180      0x04000000
 286 #define  SDHCI_CAN_DO_64BIT     0x10000000
 287 #define  SDHCI_CAN_ASYNC_INTR   0x20000000
 288 #define  SDHCI_SLOTTYPE_MASK    0xC0000000
 289 #define  SDHCI_SLOTTYPE_REMOVABLE       0x00000000
 290 #define  SDHCI_SLOTTYPE_EMBEDDED        0x40000000
 291 #define  SDHCI_SLOTTYPE_SHARED  0x80000000
 292
 293 #define SDHCI_CAPABILITIES2     0x44
 294 #define  SDHCI_CAN_SDR50        0x00000001
 295 #define  SDHCI_CAN_SDR104       0x00000002
 296 #define  SDHCI_CAN_DDR50        0x00000004
 297 #define  SDHCI_CAN_DRIVE_TYPE_A 0x00000010
 298 #define  SDHCI_CAN_DRIVE_TYPE_C 0x00000020
 299 #define  SDHCI_CAN_DRIVE_TYPE_D 0x00000040
 300 #define  SDHCI_RETUNE_CNT_MASK  0x00000F00
 301 #define  SDHCI_RETUNE_CNT_SHIFT 8
 302 #define  SDHCI_TUNE_SDR50       0x00002000
 303 #define  SDHCI_RETUNE_MODES_MASK  0x0000C000
 304 #define  SDHCI_RETUNE_MODES_SHIFT 14
 305 #define  SDHCI_CLOCK_MULT_MASK  0x00FF0000
 306 #define  SDHCI_CLOCK_MULT_SHIFT 16
 307 #define  SDHCI_CAN_MMC_HS400    0x80000000      /* non-standard */
 308
 309 #define SDHCI_MAX_CURRENT       0x48
 310 #define SDHCI_FORCE_AUTO_EVENT  0x50
 311 #define SDHCI_FORCE_INTR_EVENT  0x52
 312
 313 #define SDHCI_ADMA_ERR          0x54
 314 #define  SDHCI_ADMA_ERR_LENGTH  0x04
 315 #define  SDHCI_ADMA_ERR_STATE_MASK      0x03
 316 #define  SDHCI_ADMA_ERR_STATE_STOP      0x00
 317 #define  SDHCI_ADMA_ERR_STATE_FDS       0x01
 318 #define  SDHCI_ADMA_ERR_STATE_TFR       0x03
 319
 320 #define SDHCI_ADMA_ADDRESS_LO   0x58
 321 #define SDHCI_ADMA_ADDRESS_HI   0x5C
 322
 323 #define SDHCI_PRESET_VALUE      0x60
 324 #define SDHCI_SHARED_BUS_CTRL   0xE0
 325
 326 #define SDHCI_SLOT_INT_STATUS   0xFC
 327
 328 #define SDHCI_HOST_VERSION      0xFE
 329 #define  SDHCI_VENDOR_VER_MASK  0xFF00
 330 #define  SDHCI_VENDOR_VER_SHIFT 8
 331 #define  SDHCI_SPEC_VER_MASK    0x00FF
 332 #define  SDHCI_SPEC_VER_SHIFT   0
 333 #define SDHCI_SPEC_100          0
 334 #define SDHCI_SPEC_200          1
 335 #define SDHCI_SPEC_300          2
 336 #define SDHCI_SPEC_400          3
 337 #define SDHCI_SPEC_410          4
 338 #define SDHCI_SPEC_420          5
 339
 340 SYSCTL_DECL(_hw_sdhci);
 341
 342 extern u_int sdhci_quirk_clear;
 343 extern u_int sdhci_quirk_set;
 344
 345 struct sdhci_slot {
 346         struct mtx      mtx;            /* Slot mutex */
 347         u_int           quirks;         /* Chip specific quirks */
 348         u_int           caps;           /* Override SDHCI_CAPABILITIES */
 349         u_int           caps2;          /* Override SDHCI_CAPABILITIES2 */
 350         device_t        bus;            /* Bus device */
 351         device_t        dev;            /* Slot device */
 352         u_char          num;            /* Slot number */
 353         u_char          opt;            /* Slot options */
 354 #define SDHCI_HAVE_DMA                  0x01
 355 #define SDHCI_PLATFORM_TRANSFER         0x02
 356 #define SDHCI_NON_REMOVABLE             0x04
 357 #define SDHCI_TUNING_SUPPORTED          0x08
 358 #define SDHCI_TUNING_ENABLED            0x10
 359 #define SDHCI_SDR50_NEEDS_TUNING        0x20
 360 #define SDHCI_SLOT_EMBEDDED             0x40
 361         u_char          version;
 362         int             timeout;        /* Transfer timeout */
 363         uint32_t        max_clk;        /* Max possible freq */
 364         uint32_t        timeout_clk;    /* Timeout freq */
 365         bus_dma_tag_t   dmatag;
 366         bus_dmamap_t    dmamap;
 367         u_char          *dmamem;
 368         bus_addr_t      paddr;          /* DMA buffer address */
 369         uint32_t        sdma_bbufsz;    /* SDMA bounce buffer size */
 370         uint8_t         sdma_boundary;  /* SDMA boundary */
 371         struct task     card_task;      /* Card presence check task */
 372         struct timeout_task
 373                         card_delayed_task;/* Card insert delayed task */
 374         struct callout  card_poll_callout;/* Card present polling callout */
 375         struct callout  timeout_callout;/* Card command/data response timeout */
 376         struct callout  retune_callout; /* Re-tuning mode 1 callout */
 377         struct mmc_host host;           /* Host parameters */
 378         struct mmc_request *req;        /* Current request */
 379         struct mmc_command *curcmd;     /* Current command of current request */
 380
 381         struct mmc_request *tune_req;   /* Tuning request */
 382         struct mmc_command *tune_cmd;   /* Tuning command of tuning request */
 383         struct mmc_data *tune_data;     /* Tuning data of tuning command */
 384         uint32_t        retune_ticks;   /* Re-tuning callout ticks [hz] */
 385         uint32_t        intmask;        /* Current interrupt mask */
 386         uint32_t        clock;          /* Current clock freq. */
 387         size_t          offset;         /* Data buffer offset */
 388         uint8_t         hostctrl;       /* Current host control register */
 389         uint8_t         retune_count;   /* Controller re-tuning count [s] */
 390         uint8_t         retune_mode;    /* Controller re-tuning mode */
 391 #define SDHCI_RETUNE_MODE_1     0x00
 392 #define SDHCI_RETUNE_MODE_2     0x01
 393 #define SDHCI_RETUNE_MODE_3     0x02
 394         uint8_t         retune_req;     /* Re-tuning request status */
 395 #define SDHCI_RETUNE_REQ_NEEDED 0x01    /* Re-tuning w/o circuit reset needed */
 396 #define SDHCI_RETUNE_REQ_RESET  0x02    /* Re-tuning w/ circuit reset needed */
 397         u_char          power;          /* Current power */
 398         u_char          bus_busy;       /* Bus busy status */
 399         u_char          cmd_done;       /* CMD command part done flag */
 400         u_char          data_done;      /* DAT command part done flag */
 401         u_char          flags;          /* Request execution flags */
 402 #define CMD_STARTED             1
 403 #define STOP_STARTED            2
 404 #define SDHCI_USE_DMA           4       /* Use DMA for this req. */
 405 #define PLATFORM_DATA_STARTED   8       /* Data xfer is handled by platform */
 406 };
 407
 408 int sdhci_generic_read_ivar(device_t bus, device_t child, int which,
 409     uintptr_t *result);
 410 int sdhci_generic_write_ivar(device_t bus, device_t child, int which,
 411     uintptr_t value);
 412 int sdhci_init_slot(device_t dev, struct sdhci_slot *slot, int num);
 413 void sdhci_start_slot(struct sdhci_slot *slot);
 414 /* performs generic clean-up for platform transfers */
 415 void sdhci_finish_data(struct sdhci_slot *slot);
 416 int sdhci_cleanup_slot(struct sdhci_slot *slot);
 417 int sdhci_generic_suspend(struct sdhci_slot *slot);
 418 int sdhci_generic_resume(struct sdhci_slot *slot);
 419 int sdhci_generic_update_ios(device_t brdev, device_t reqdev);
 420 int sdhci_generic_tune(device_t brdev, device_t reqdev, bool hs400);
 421 int sdhci_generic_switch_vccq(device_t brdev, device_t reqdev);
 422 int sdhci_generic_retune(device_t brdev, device_t reqdev, bool reset);
 423 int sdhci_generic_request(device_t brdev, device_t reqdev,
 424     struct mmc_request *req);
 425 int sdhci_generic_get_ro(device_t brdev, device_t reqdev);
 426 int sdhci_generic_acquire_host(device_t brdev, device_t reqdev);
 427 int sdhci_generic_release_host(device_t brdev, device_t reqdev);
 428 void sdhci_generic_intr(struct sdhci_slot *slot);
 429 uint32_t sdhci_generic_min_freq(device_t brdev, struct sdhci_slot *slot);
 430 bool sdhci_generic_get_card_present(device_t brdev, struct sdhci_slot *slot);
 431 void sdhci_generic_set_uhs_timing(device_t brdev, struct sdhci_slot *slot);
 432 void sdhci_handle_card_present(struct sdhci_slot *slot, bool is_present);
 433
 434 #define SDHCI_VERSION   2
 435
 436 #define SDHCI_DEPEND(name)                                              \
 437     MODULE_DEPEND(name, sdhci, SDHCI_VERSION, SDHCI_VERSION, SDHCI_VERSION);
 438
 439 #endif  /* __SDHCI_H__ */