sys/dev/mmc/mmcreg.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2006 M. Warner Losh <imp@FreeBSD.org>
   5  * Copyright (c) 2017 Marius Strobl <marius@FreeBSD.org>
   6  * Copyright (c) 2015-2016 Ilya Bakulin <kibab@FreeBSD.org>
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Portions of this software may have been developed with reference to
  29  * the SD Simplified Specification.  The following disclaimer may apply:
  30  *
  31  * The following conditions apply to the release of the simplified
  32  * specification ("Simplified Specification") by the SD Card Association and
  33  * the SD Group. The Simplified Specification is a subset of the complete SD
  34  * Specification which is owned by the SD Card Association and the SD
  35  * Group. This Simplified Specification is provided on a non-confidential
  36  * basis subject to the disclaimers below. Any implementation of the
  37  * Simplified Specification may require a license from the SD Card
  38  * Association, SD Group, SD-3C LLC or other third parties.
  39  *
  40  * Disclaimers:
  41  *
  42  * The information contained in the Simplified Specification is presented only
  43  * as a standard specification for SD Cards and SD Host/Ancillary products and
  44  * is provided "AS-IS" without any representations or warranties of any
  45  * kind. No responsibility is assumed by the SD Group, SD-3C LLC or the SD
  46  * Card Association for any damages, any infringements of patents or other
  47  * right of the SD Group, SD-3C LLC, the SD Card Association or any third
  48  * parties, which may result from its use. No license is granted by
  49  * implication, estoppel or otherwise under any patent or other rights of the
  50  * SD Group, SD-3C LLC, the SD Card Association or any third party. Nothing
  51  * herein shall be construed as an obligation by the SD Group, the SD-3C LLC
  52  * or the SD Card Association to disclose or distribute any technical
  53  * information, know-how or other confidential information to any third party.
  54  *
  55  * $FreeBSD$
  56  */
  57
  58 #ifndef DEV_MMC_MMCREG_H
  59 #define DEV_MMC_MMCREG_H
  60
  61 /*
  62  * This file contains the register definitions for the mmc and sd buses.
  63  * They are taken from publicly available sources.
  64  */
  65
  66 struct mmc_data;
  67 struct mmc_request;
  68
  69 struct mmc_command {
  70         uint32_t        opcode;
  71         uint32_t        arg;
  72         uint32_t        resp[4];
  73         uint32_t        flags;          /* Expected responses */
  74 #define MMC_RSP_PRESENT (1ul << 0)      /* Response */
  75 #define MMC_RSP_136     (1ul << 1)      /* 136 bit response */
  76 #define MMC_RSP_CRC     (1ul << 2)      /* Expect valid crc */
  77 #define MMC_RSP_BUSY    (1ul << 3)      /* Card may send busy */
  78 #define MMC_RSP_OPCODE  (1ul << 4)      /* Response include opcode */
  79 #define MMC_RSP_MASK    0x1ful
  80 #define MMC_CMD_AC      (0ul << 5)      /* Addressed Command, no data */
  81 #define MMC_CMD_ADTC    (1ul << 5)      /* Addressed Data transfer cmd */
  82 #define MMC_CMD_BC      (2ul << 5)      /* Broadcast command, no response */
  83 #define MMC_CMD_BCR     (3ul << 5)      /* Broadcast command with response */
  84 #define MMC_CMD_MASK    (3ul << 5)
  85
  86 /* Possible response types defined in the standard: */
  87 #define MMC_RSP_NONE    (0)
  88 #define MMC_RSP_R1      (MMC_RSP_PRESENT | MMC_RSP_CRC | MMC_RSP_OPCODE)
  89 #define MMC_RSP_R1B     (MMC_RSP_PRESENT | MMC_RSP_CRC | MMC_RSP_OPCODE | MMC_RSP_BUSY)
  90 #define MMC_RSP_R2      (MMC_RSP_PRESENT | MMC_RSP_136 | MMC_RSP_CRC)
  91 #define MMC_RSP_R3      (MMC_RSP_PRESENT)
  92 #define MMC_RSP_R4      (MMC_RSP_PRESENT)
  93 #define MMC_RSP_R5      (MMC_RSP_PRESENT | MMC_RSP_CRC | MMC_RSP_OPCODE)
  94 #define MMC_RSP_R5B     (MMC_RSP_PRESENT | MMC_RSP_CRC | MMC_RSP_OPCODE | MMC_RSP_BUSY)
  95 #define MMC_RSP_R6      (MMC_RSP_PRESENT | MMC_RSP_CRC | MMC_RSP_OPCODE)
  96 #define MMC_RSP_R7      (MMC_RSP_PRESENT | MMC_RSP_CRC | MMC_RSP_OPCODE)
  97 #define MMC_RSP(x)      ((x) & MMC_RSP_MASK)
  98         uint32_t        retries;
  99         uint32_t        error;
 100 #define MMC_ERR_NONE    0
 101 #define MMC_ERR_TIMEOUT 1
 102 #define MMC_ERR_BADCRC  2
 103 #define MMC_ERR_FIFO    3
 104 #define MMC_ERR_FAILED  4
 105 #define MMC_ERR_INVALID 5
 106 #define MMC_ERR_NO_MEMORY 6
 107 #define MMC_ERR_MAX     6
 108         struct mmc_data *data;          /* Data segment with cmd */
 109         struct mmc_request *mrq;        /* backpointer to request */
 110 };
 111
 112 /*
 113  * R1 responses
 114  *
 115  * Types (per SD 2.0 standard)
 116  *      e : error bit
 117  *      s : status bit
 118  *      r : detected and set for the actual command response
 119  *      x : Detected and set during command execution.  The host can get
 120  *          the status by issuing a command with R1 response.
 121  *
 122  * Clear Condition (per SD 2.0 standard)
 123  *      a : according to the card current state.
 124  *      b : always related to the previous command.  reception of a valid
 125  *          command will clear it (with a delay of one command).
 126  *      c : clear by read
 127  */
 128 #define R1_OUT_OF_RANGE (1u << 31)              /* erx, c */
 129 #define R1_ADDRESS_ERROR (1u << 30)             /* erx, c */
 130 #define R1_BLOCK_LEN_ERROR (1u << 29)           /* erx, c */
 131 #define R1_ERASE_SEQ_ERROR (1u << 28)           /* er, c */
 132 #define R1_ERASE_PARAM (1u << 27)               /* erx, c */
 133 #define R1_WP_VIOLATION (1u << 26)              /* erx, c */
 134 #define R1_CARD_IS_LOCKED (1u << 25)            /* sx, a */
 135 #define R1_LOCK_UNLOCK_FAILED (1u << 24)        /* erx, c */
 136 #define R1_COM_CRC_ERROR (1u << 23)             /* er, b */
 137 #define R1_ILLEGAL_COMMAND (1u << 22)           /* er, b */
 138 #define R1_CARD_ECC_FAILED (1u << 21)           /* erx, c */
 139 #define R1_CC_ERROR (1u << 20)                  /* erx, c */
 140 #define R1_ERROR (1u << 19)                     /* erx, c */
 141 #define R1_CSD_OVERWRITE (1u << 16)             /* erx, c */
 142 #define R1_WP_ERASE_SKIP (1u << 15)             /* erx, c */
 143 #define R1_CARD_ECC_DISABLED (1u << 14)         /* sx, a */
 144 #define R1_ERASE_RESET (1u << 13)               /* sr, c */
 145 #define R1_CURRENT_STATE_MASK (0xfu << 9)       /* sx, b */
 146 #define R1_READY_FOR_DATA (1u << 8)             /* sx, a */
 147 #define R1_SWITCH_ERROR (1u << 7)               /* sx, c */
 148 #define R1_APP_CMD (1u << 5)                    /* sr, c */
 149 #define R1_AKE_SEQ_ERROR (1u << 3)              /* er, c */
 150 #define R1_STATUS(x)            ((x) & 0xFFFFE000)
 151 #define R1_CURRENT_STATE(x)     (((x) & R1_CURRENT_STATE_MASK) >> 9)
 152 #define R1_STATE_IDLE   0
 153 #define R1_STATE_READY  1
 154 #define R1_STATE_IDENT  2
 155 #define R1_STATE_STBY   3
 156 #define R1_STATE_TRAN   4
 157 #define R1_STATE_DATA   5
 158 #define R1_STATE_RCV    6
 159 #define R1_STATE_PRG    7
 160 #define R1_STATE_DIS    8
 161
 162 /* R4 responses (SDIO) */
 163 #define R4_IO_NUM_FUNCTIONS(ocr)        (((ocr) >> 28) & 0x3)
 164 #define R4_IO_MEM_PRESENT               (0x1 << 27)
 165 #define R4_IO_OCR_MASK                  0x00fffff0
 166
 167 /*
 168  * R5 responses
 169  *
 170  * Types (per SD 2.0 standard)
 171  *      e : error bit
 172  *      s : status bit
 173  *      r : detected and set for the actual command response
 174  *      x : Detected and set during command execution.  The host can get
 175  *          the status by issuing a command with R1 response.
 176  *
 177  * Clear Condition (per SD 2.0 standard)
 178  *      a : according to the card current state.
 179  *      b : always related to the previous command.  reception of a valid
 180  *          command will clear it (with a delay of one command).
 181  *      c : clear by read
 182  */
 183 #define R5_COM_CRC_ERROR                (1u << 15)      /* er, b */
 184 #define R5_ILLEGAL_COMMAND              (1u << 14)      /* er, b */
 185 #define R5_IO_CURRENT_STATE_MASK        (3u << 12)      /* s, b */
 186 #define R5_IO_CURRENT_STATE(x)          (((x) & R5_IO_CURRENT_STATE_MASK) >> 12)
 187 #define R5_ERROR                        (1u << 11)      /* erx, c */
 188 #define R5_FUNCTION_NUMBER              (1u << 9)       /* er, c */
 189 #define R5_OUT_OF_RANGE                 (1u << 8)       /* er, c */
 190
 191 struct mmc_data {
 192         size_t len;             /* size of the data */
 193         size_t xfer_len;
 194         void *data;             /* data buffer */
 195         uint32_t        flags;
 196 #define MMC_DATA_WRITE  (1UL << 0)
 197 #define MMC_DATA_READ   (1UL << 1)
 198 #define MMC_DATA_STREAM (1UL << 2)
 199 #define MMC_DATA_MULTI  (1UL << 3)
 200 #define MMC_DATA_BLOCK_SIZE (1UL << 4)
 201         struct mmc_request *mrq;
 202         size_t block_size;      /* block size for CMD53 */
 203         size_t block_count;     /* block count for CMD53 */
 204 };
 205
 206 struct mmc_request {
 207         struct mmc_command *cmd;
 208         struct mmc_command *stop;
 209         void (*done)(struct mmc_request *); /* Completion function */
 210         void *done_data;                /* requestor set data */
 211         uint32_t flags;
 212 #define MMC_REQ_DONE    1
 213 #define MMC_TUNE_DONE   2
 214 };
 215
 216 /* Command definitions */
 217
 218 /* Class 0 and 1: Basic commands & read stream commands */
 219 #define MMC_GO_IDLE_STATE       0
 220 #define MMC_SEND_OP_COND        1
 221 #define MMC_ALL_SEND_CID        2
 222 #define MMC_SET_RELATIVE_ADDR   3
 223 #define SD_SEND_RELATIVE_ADDR   3
 224 #define MMC_SET_DSR             4
 225 #define MMC_SLEEP_AWAKE         5
 226 #define IO_SEND_OP_COND         5
 227 #define MMC_SWITCH_FUNC         6
 228 #define  MMC_SWITCH_FUNC_CMDS    0
 229 #define  MMC_SWITCH_FUNC_SET     1
 230 #define  MMC_SWITCH_FUNC_CLR     2
 231 #define  MMC_SWITCH_FUNC_WR      3
 232 #define MMC_SELECT_CARD         7
 233 #define MMC_DESELECT_CARD       7
 234 #define MMC_SEND_EXT_CSD        8
 235 #define SD_SEND_IF_COND         8
 236 #define MMC_SEND_CSD            9
 237 #define MMC_SEND_CID            10
 238 #define MMC_READ_DAT_UNTIL_STOP 11
 239 #define MMC_STOP_TRANSMISSION   12
 240 #define MMC_SEND_STATUS         13
 241 #define MMC_BUSTEST_R           14
 242 #define MMC_GO_INACTIVE_STATE   15
 243 #define MMC_BUSTEST_W           19
 244
 245 /* Class 2: Block oriented read commands */
 246 #define MMC_SET_BLOCKLEN        16
 247 #define MMC_READ_SINGLE_BLOCK   17
 248 #define MMC_READ_MULTIPLE_BLOCK 18
 249 #define MMC_SEND_TUNING_BLOCK   19
 250 #define MMC_SEND_TUNING_BLOCK_HS200 21
 251
 252 /* Class 3: Stream write commands */
 253 #define MMC_WRITE_DAT_UNTIL_STOP 20
 254                         /* reserved: 22 */
 255
 256 /* Class 4: Block oriented write commands */
 257 #define MMC_SET_BLOCK_COUNT     23
 258 #define MMC_WRITE_BLOCK         24
 259 #define MMC_WRITE_MULTIPLE_BLOCK 25
 260 #define MMC_PROGARM_CID         26
 261 #define MMC_PROGRAM_CSD         27
 262
 263 /* Class 6: Block oriented write protection commands */
 264 #define MMC_SET_WRITE_PROT      28
 265 #define MMC_CLR_WRITE_PROT      29
 266 #define MMC_SEND_WRITE_PROT     30
 267                         /* reserved: 31 */
 268
 269 /* Class 5: Erase commands */
 270 #define SD_ERASE_WR_BLK_START   32
 271 #define SD_ERASE_WR_BLK_END     33
 272                         /* 34 -- reserved old command */
 273 #define MMC_ERASE_GROUP_START   35
 274 #define MMC_ERASE_GROUP_END     36
 275                         /* 37 -- reserved old command */
 276 #define MMC_ERASE               38
 277 #define  MMC_ERASE_ERASE        0x00000000
 278 #define  MMC_ERASE_TRIM         0x00000001
 279 #define  MMC_ERASE_FULE         0x00000002
 280 #define  MMC_ERASE_DISCARD      0x00000003
 281 #define  MMC_ERASE_SECURE_ERASE 0x80000000
 282 #define  MMC_ERASE_SECURE_TRIM1 0x80000001
 283 #define  MMC_ERASE_SECURE_TRIM2 0x80008000
 284
 285 /* Class 9: I/O mode commands */
 286 #define MMC_FAST_IO             39
 287 #define MMC_GO_IRQ_STATE        40
 288                         /* reserved: 41 */
 289
 290 /* Class 7: Lock card */
 291 #define MMC_LOCK_UNLOCK         42
 292                         /* reserved: 43 */
 293                         /* reserved: 44 */
 294                         /* reserved: 45 */
 295                         /* reserved: 46 */
 296                         /* reserved: 47 */
 297                         /* reserved: 48 */
 298                         /* reserved: 49 */
 299                         /* reserved: 50 */
 300                         /* reserved: 51 */
 301                         /* reserved: 54 */
 302
 303 /* Class 8: Application specific commands */
 304 #define MMC_APP_CMD             55
 305 #define MMC_GEN_CMD             56
 306                         /* reserved: 57 */
 307                         /* reserved: 58 */
 308                         /* reserved: 59 */
 309                         /* reserved for mfg: 60 */
 310                         /* reserved for mfg: 61 */
 311                         /* reserved for mfg: 62 */
 312                         /* reserved for mfg: 63 */
 313
 314 /* Class 9: I/O cards (sd) */
 315 #define SD_IO_RW_DIRECT         52
 316 /* CMD52 arguments */
 317 #define  SD_ARG_CMD52_READ              (0 << 31)
 318 #define  SD_ARG_CMD52_WRITE             (1 << 31)
 319 #define  SD_ARG_CMD52_FUNC_SHIFT        28
 320 #define  SD_ARG_CMD52_FUNC_MASK         0x7
 321 #define  SD_ARG_CMD52_EXCHANGE          (1 << 27)
 322 #define  SD_ARG_CMD52_REG_SHIFT         9
 323 #define  SD_ARG_CMD52_REG_MASK          0x1ffff
 324 #define  SD_ARG_CMD52_DATA_SHIFT        0
 325 #define  SD_ARG_CMD52_DATA_MASK         0xff
 326 #define  SD_R5_DATA(resp)               ((resp)[0] & 0xff)
 327
 328 #define SD_IO_RW_EXTENDED       53
 329 /* CMD53 arguments */
 330 #define  SD_ARG_CMD53_READ              (0 << 31)
 331 #define  SD_ARG_CMD53_WRITE             (1 << 31)
 332 #define  SD_ARG_CMD53_FUNC_SHIFT        28
 333 #define  SD_ARG_CMD53_FUNC_MASK         0x7
 334 #define  SD_ARG_CMD53_BLOCK_MODE        (1 << 27)
 335 #define  SD_ARG_CMD53_INCREMENT         (1 << 26)
 336 #define  SD_ARG_CMD53_REG_SHIFT         9
 337 #define  SD_ARG_CMD53_REG_MASK          0x1ffff
 338 #define  SD_ARG_CMD53_LENGTH_SHIFT      0
 339 #define  SD_ARG_CMD53_LENGTH_MASK       0x1ff
 340 #define  SD_ARG_CMD53_LENGTH_MAX        64      /* XXX should be 511? */
 341
 342 /* Class 10: Switch function commands */
 343 #define SD_SWITCH_FUNC          6
 344                         /* reserved: 34 */
 345                         /* reserved: 35 */
 346                         /* reserved: 36 */
 347                         /* reserved: 37 */
 348                         /* reserved: 50 */
 349                         /* reserved: 57 */
 350
 351 /* Application specific commands for SD */
 352 #define ACMD_SET_BUS_WIDTH      6
 353 #define ACMD_SD_STATUS          13
 354 #define ACMD_SEND_NUM_WR_BLOCKS 22
 355 #define ACMD_SET_WR_BLK_ERASE_COUNT 23
 356 #define ACMD_SD_SEND_OP_COND    41
 357 #define ACMD_SET_CLR_CARD_DETECT 42
 358 #define ACMD_SEND_SCR           51
 359
 360 /*
 361  * EXT_CSD fields
 362  */
 363 #define EXT_CSD_FLUSH_CACHE     32      /* W/E */
 364 #define EXT_CSD_CACHE_CTRL      33      /* R/W/E */
 365 #define EXT_CSD_EXT_PART_ATTR   52      /* R/W, 2 bytes */
 366 #define EXT_CSD_ENH_START_ADDR  136     /* R/W, 4 bytes */
 367 #define EXT_CSD_ENH_SIZE_MULT   140     /* R/W, 3 bytes */
 368 #define EXT_CSD_GP_SIZE_MULT    143     /* R/W, 12 bytes */
 369 #define EXT_CSD_PART_SET        155     /* R/W */
 370 #define EXT_CSD_PART_ATTR       156     /* R/W */
 371 #define EXT_CSD_PART_SUPPORT    160     /* RO */
 372 #define EXT_CSD_RPMB_MULT       168     /* RO */
 373 #define EXT_CSD_BOOT_WP_STATUS  174     /* RO */
 374 #define EXT_CSD_ERASE_GRP_DEF   175     /* R/W */
 375 #define EXT_CSD_PART_CONFIG     179     /* R/W */
 376 #define EXT_CSD_BUS_WIDTH       183     /* R/W */
 377 #define EXT_CSD_STROBE_SUPPORT  184     /* RO */
 378 #define EXT_CSD_HS_TIMING       185     /* R/W */
 379 #define EXT_CSD_POWER_CLASS     187     /* R/W */
 380 #define EXT_CSD_CARD_TYPE       196     /* RO */
 381 #define EXT_CSD_DRIVER_STRENGTH 197     /* RO */
 382 #define EXT_CSD_REV             192     /* RO */
 383 #define EXT_CSD_PART_SWITCH_TO  199     /* RO */
 384 #define EXT_CSD_PWR_CL_52_195   200     /* RO */
 385 #define EXT_CSD_PWR_CL_26_195   201     /* RO */
 386 #define EXT_CSD_PWR_CL_52_360   202     /* RO */
 387 #define EXT_CSD_PWR_CL_26_360   203     /* RO */
 388 #define EXT_CSD_SEC_CNT         212     /* RO, 4 bytes */
 389 #define EXT_CSD_HC_WP_GRP_SIZE  221     /* RO */
 390 #define EXT_CSD_ERASE_TO_MULT   223     /* RO */
 391 #define EXT_CSD_ERASE_GRP_SIZE  224     /* RO */
 392 #define EXT_CSD_BOOT_SIZE_MULT  226     /* RO */
 393 #define EXT_CSD_SEC_FEATURE_SUPPORT 231 /* RO */
 394 #define EXT_CSD_PWR_CL_200_195  236     /* RO */
 395 #define EXT_CSD_PWR_CL_200_360  237     /* RO */
 396 #define EXT_CSD_PWR_CL_52_195_DDR 238   /* RO */
 397 #define EXT_CSD_PWR_CL_52_360_DDR 239   /* RO */
 398 #define EXT_CSD_CACHE_FLUSH_POLICY 249  /* RO */
 399 #define EXT_CSD_GEN_CMD6_TIME   248     /* RO */
 400 #define EXT_CSD_CACHE_SIZE      249     /* RO, 4 bytes */
 401 #define EXT_CSD_PWR_CL_200_360_DDR 253  /* RO */
 402
 403 /*
 404  * EXT_CSD field definitions
 405  */
 406 #define EXT_CSD_FLUSH_CACHE_FLUSH       0x01
 407 #define EXT_CSD_FLUSH_CACHE_BARRIER     0x02
 408
 409 #define EXT_CSD_CACHE_CTRL_CACHE_EN     0x01
 410
 411 #define EXT_CSD_EXT_PART_ATTR_DEFAULT           0x0
 412 #define EXT_CSD_EXT_PART_ATTR_SYSTEMCODE        0x1
 413 #define EXT_CSD_EXT_PART_ATTR_NPERSISTENT       0x2
 414
 415 #define EXT_CSD_PART_SET_COMPLETED              0x01
 416
 417 #define EXT_CSD_PART_ATTR_ENH_USR               0x01
 418 #define EXT_CSD_PART_ATTR_ENH_GP0               0x02
 419 #define EXT_CSD_PART_ATTR_ENH_GP1               0x04
 420 #define EXT_CSD_PART_ATTR_ENH_GP2               0x08
 421 #define EXT_CSD_PART_ATTR_ENH_GP3               0x10
 422 #define EXT_CSD_PART_ATTR_ENH_MASK              0x1f
 423
 424 #define EXT_CSD_PART_SUPPORT_EN                 0x01
 425 #define EXT_CSD_PART_SUPPORT_ENH_ATTR_EN        0x02
 426 #define EXT_CSD_PART_SUPPORT_EXT_ATTR_EN        0x04
 427
 428 #define EXT_CSD_BOOT_WP_STATUS_BOOT0_PWR        0x01
 429 #define EXT_CSD_BOOT_WP_STATUS_BOOT0_PERM       0x02
 430 #define EXT_CSD_BOOT_WP_STATUS_BOOT0_MASK       0x03
 431 #define EXT_CSD_BOOT_WP_STATUS_BOOT1_PWR        0x04
 432 #define EXT_CSD_BOOT_WP_STATUS_BOOT1_PERM       0x08
 433 #define EXT_CSD_BOOT_WP_STATUS_BOOT1_MASK       0x0c
 434
 435 #define EXT_CSD_ERASE_GRP_DEF_EN        0x01
 436
 437 #define EXT_CSD_PART_CONFIG_ACC_DEFAULT 0x00
 438 #define EXT_CSD_PART_CONFIG_ACC_BOOT0   0x01
 439 #define EXT_CSD_PART_CONFIG_ACC_BOOT1   0x02
 440 #define EXT_CSD_PART_CONFIG_ACC_RPMB    0x03
 441 #define EXT_CSD_PART_CONFIG_ACC_GP0     0x04
 442 #define EXT_CSD_PART_CONFIG_ACC_GP1     0x05
 443 #define EXT_CSD_PART_CONFIG_ACC_GP2     0x06
 444 #define EXT_CSD_PART_CONFIG_ACC_GP3     0x07
 445 #define EXT_CSD_PART_CONFIG_ACC_MASK    0x07
 446 #define EXT_CSD_PART_CONFIG_BOOT0       0x08
 447 #define EXT_CSD_PART_CONFIG_BOOT1       0x10
 448 #define EXT_CSD_PART_CONFIG_BOOT_USR    0x38
 449 #define EXT_CSD_PART_CONFIG_BOOT_MASK   0x38
 450 #define EXT_CSD_PART_CONFIG_BOOT_ACK    0x40
 451
 452 #define EXT_CSD_CMD_SET_NORMAL          1
 453 #define EXT_CSD_CMD_SET_SECURE          2
 454 #define EXT_CSD_CMD_SET_CPSECURE        4
 455
 456 #define EXT_CSD_HS_TIMING_BC            0
 457 #define EXT_CSD_HS_TIMING_HS            1
 458 #define EXT_CSD_HS_TIMING_HS200         2
 459 #define EXT_CSD_HS_TIMING_HS400         3
 460 #define EXT_CSD_HS_TIMING_DRV_STR_SHIFT 4
 461
 462 #define EXT_CSD_POWER_CLASS_8BIT_MASK   0xf0
 463 #define EXT_CSD_POWER_CLASS_8BIT_SHIFT  4
 464 #define EXT_CSD_POWER_CLASS_4BIT_MASK   0x0f
 465 #define EXT_CSD_POWER_CLASS_4BIT_SHIFT  0
 466
 467 #define EXT_CSD_CARD_TYPE_HS_26         0x0001
 468 #define EXT_CSD_CARD_TYPE_HS_52         0x0002
 469 #define EXT_CSD_CARD_TYPE_DDR_52_1_8V   0x0004
 470 #define EXT_CSD_CARD_TYPE_DDR_52_1_2V   0x0008
 471 #define EXT_CSD_CARD_TYPE_HS200_1_8V    0x0010
 472 #define EXT_CSD_CARD_TYPE_HS200_1_2V    0x0020
 473 #define EXT_CSD_CARD_TYPE_HS400_1_8V    0x0040
 474 #define EXT_CSD_CARD_TYPE_HS400_1_2V    0x0080
 475
 476 #define EXT_CSD_BUS_WIDTH_1     0
 477 #define EXT_CSD_BUS_WIDTH_4     1
 478 #define EXT_CSD_BUS_WIDTH_8     2
 479 #define EXT_CSD_BUS_WIDTH_4_DDR 5
 480 #define EXT_CSD_BUS_WIDTH_8_DDR 6
 481 #define EXT_CSD_BUS_WIDTH_ES    0x80
 482
 483 #define EXT_CSD_STROBE_SUPPORT_EN       0x01
 484
 485 #define EXT_CSD_SEC_FEATURE_SUPPORT_ER_EN       0x01
 486 #define EXT_CSD_SEC_FEATURE_SUPPORT_BD_BLK_EN   0x04
 487 #define EXT_CSD_SEC_FEATURE_SUPPORT_GB_CL_EN    0x10
 488 #define EXT_CSD_SEC_FEATURE_SUPPORT_SANITIZE    0x40
 489
 490 #define EXT_CSD_CACHE_FLUSH_POLICY_FIFO 0x01
 491
 492 /*
 493  * Vendor specific EXT_CSD fields
 494  */
 495 /* SanDisk iNAND */
 496 #define EXT_CSD_INAND_CMD38                     113
 497 #define  EXT_CSD_INAND_CMD38_ERASE              0x00
 498 #define  EXT_CSD_INAND_CMD38_TRIM               0x01
 499 #define  EXT_CSD_INAND_CMD38_SECURE_ERASE       0x80
 500 #define  EXT_CSD_INAND_CMD38_SECURE_TRIM1       0x81
 501 #define  EXT_CSD_INAND_CMD38_SECURE_TRIM2       0x82
 502
 503 #define MMC_TYPE_HS_26_MAX              26000000
 504 #define MMC_TYPE_HS_52_MAX              52000000
 505 #define MMC_TYPE_DDR52_MAX              52000000
 506 #define MMC_TYPE_HS200_HS400ES_MAX      200000000
 507
 508 /*
 509  * SD bus widths
 510  */
 511 #define SD_BUS_WIDTH_1          0
 512 #define SD_BUS_WIDTH_4          2
 513
 514 /*
 515  * SD Switch
 516  */
 517 #define SD_SWITCH_MODE_CHECK    0
 518 #define SD_SWITCH_MODE_SET      1
 519 #define SD_SWITCH_GROUP1        0
 520 #define SD_SWITCH_NORMAL_MODE   0
 521 #define SD_SWITCH_HS_MODE       1
 522 #define SD_SWITCH_SDR50_MODE    2
 523 #define SD_SWITCH_SDR104_MODE   3
 524 #define SD_SWITCH_DDR50         4
 525 #define SD_SWITCH_NOCHANGE      0xF
 526
 527 #define SD_CLR_CARD_DETECT      0
 528 #define SD_SET_CARD_DETECT      1
 529
 530 #define SD_HS_MAX               50000000
 531 #define SD_DDR50_MAX            50000000
 532 #define SD_SDR12_MAX            25000000
 533 #define SD_SDR25_MAX            50000000
 534 #define SD_SDR50_MAX            100000000
 535 #define SD_SDR104_MAX           208000000
 536
 537 /* Specifications require 400 kHz max. during ID phase. */
 538 #define SD_MMC_CARD_ID_FREQUENCY        400000
 539
 540 /*
 541  * SDIO Direct & Extended I/O
 542  */
 543 #define SD_IO_RW_WR             (1u << 31)
 544 #define SD_IO_RW_FUNC(x)        (((x) & 0x7) << 28)
 545 #define SD_IO_RW_RAW            (1u << 27)
 546 #define SD_IO_RW_INCR           (1u << 26)
 547 #define SD_IO_RW_ADR(x)         (((x) & 0x1FFFF) << 9)
 548 #define SD_IO_RW_DAT(x)         (((x) & 0xFF) << 0)
 549 #define SD_IO_RW_LEN(x)         (((x) & 0xFF) << 0)
 550
 551 #define SD_IOE_RW_LEN(x)        (((x) & 0x1FF) << 0)
 552 #define SD_IOE_RW_ADR(x)        (((x) & 0x1FFFF) << 9)
 553 #define SD_IOE_RW_INCR          (1u << 26)
 554 #define SD_IOE_RW_BLK           (1u << 27)
 555 #define SD_IOE_RW_FUNC(x)       (((x) & 0x7) << 28)
 556 #define SD_IOE_RW_WR            (1u << 31)
 557
 558 /* Card Common Control Registers (CCCR) */
 559 #define SD_IO_CCCR_START                0x00000 /* Offset in F0 address space */
 560 #define SD_IO_CCCR_SIZE                 0x100   /* Total size of CCCR */
 561 #define SD_IO_CCCR_FN_ENABLE            0x02    /* Enabled functions */
 562 #define SD_IO_CCCR_FN_READY             0x03    /* Function ready status */
 563 #define SD_IO_CCCR_INT_ENABLE           0x04    /* Per-function interrupt enable */
 564 #define SD_IO_CCCR_INT_PENDING          0x05    /* Per-function interrupt pending */
 565 #define SD_IO_CCCR_CTL                  0x06    /* I/O Abort register */
 566 #define  CCCR_CTL_RES                   (1 << 3) /* Perform SDIO reset */
 567 #define SD_IO_CCCR_BUS_WIDTH            0x07    /* Bus Width register */
 568 #define  CCCR_BUS_WIDTH_4               (1 << 1)
 569 #define  CCCR_BUS_WIDTH_1               (1 << 0)
 570 #define SD_IO_CCCR_CARDCAP              0x08    /* SDIO card capabilities */
 571 #define  CCCR_CC_SMB                    (1 << 1) /* CMD53 block mode support */
 572 #define SD_IO_CCCR_CISPTR               0x09    /* 0x09 - 0x0B */
 573 #define SD_IO_CCCR_FN0_BLKSZ            0x10    /* 0x10 - 0x11 */
 574 /* Function Basic Registers (FBR) */
 575 #define SD_IO_FBR_START                 0x00100 /* Offset in F0 address space */
 576 #define SD_IO_FBR_SIZE                  0x00700 /* Total size of FBR */
 577 #define SD_IO_FBR_F_SIZE                0x00100 /* Size of each function */
 578 #define SD_IO_FBR_START_F(n)            (SD_IO_FBR_START + (n-1) * SD_IO_FBR_F_SIZE)
 579 #define SD_IO_FBR_CIS_OFFSET            0x9  /* Offset of this function's info block within CIS area */
 580 #define SD_IO_FBR_IOBLKSZ               0x10 /* Block size for CMD53 block mode operations */
 581
 582 /* Card Information Structure (CIS) */
 583 #define SD_IO_CIS_START                 0x01000 /* Offset in F0 address space */
 584 #define SD_IO_CIS_SIZE                  0x17000 /* Total size of CIS */
 585
 586 /* CIS tuple codes (based on PC Card 16) */
 587 #define SD_IO_CISTPL_VERS_1             0x15
 588 #define SD_IO_CISTPL_MANFID             0x20
 589 #define SD_IO_CISTPL_FUNCID             0x21
 590 #define SD_IO_CISTPL_FUNCE              0x22
 591 #define SD_IO_CISTPL_END                0xff
 592
 593 /* CISTPL_FUNCID codes */
 594 /* OpenBSD incorrectly defines 0x0c as FUNCTION_WLAN */
 595 /* #define      SDMMC_FUNCTION_WLAN             0x0c */
 596
 597 /* OCR bits */
 598
 599 /*
 600  * in SD 2.0 spec, bits 8-14 are now marked reserved
 601  * Low voltage in SD2.0 spec is bit 7, TBD voltage
 602  * Low voltage in MC 3.31 spec is bit 7, 1.65-1.95V
 603  * Specs prior to  MMC 3.31 defined bits 0-7 as voltages down to 1.5V.
 604  * 3.31 redefined them to be reserved and also said that cards had to
 605  * support the 2.7-3.6V and fixed the OCR to be 0xfff8000 for high voltage
 606  * cards.  MMC 4.0 says that a dual voltage card responds with 0xfff8080.
 607  * Looks like the fine-grained control of the voltage tolerance ranges
 608  * was abandoned.
 609  *
 610  * The MMC_OCR_CCS appears to be valid for only SD cards.
 611  */
 612 #define MMC_OCR_VOLTAGE 0x3fffffffU     /* Vdd Voltage mask */
 613 #define MMC_OCR_LOW_VOLTAGE (1u << 7)   /* Low Voltage Range -- tbd */
 614 #define MMC_OCR_MIN_VOLTAGE_SHIFT       7
 615 #define MMC_OCR_200_210 (1U << 8)       /* Vdd voltage 2.00 ~ 2.10 */
 616 #define MMC_OCR_210_220 (1U << 9)       /* Vdd voltage 2.10 ~ 2.20 */
 617 #define MMC_OCR_220_230 (1U << 10)      /* Vdd voltage 2.20 ~ 2.30 */
 618 #define MMC_OCR_230_240 (1U << 11)      /* Vdd voltage 2.30 ~ 2.40 */
 619 #define MMC_OCR_240_250 (1U << 12)      /* Vdd voltage 2.40 ~ 2.50 */
 620 #define MMC_OCR_250_260 (1U << 13)      /* Vdd voltage 2.50 ~ 2.60 */
 621 #define MMC_OCR_260_270 (1U << 14)      /* Vdd voltage 2.60 ~ 2.70 */
 622 #define MMC_OCR_270_280 (1U << 15)      /* Vdd voltage 2.70 ~ 2.80 */
 623 #define MMC_OCR_280_290 (1U << 16)      /* Vdd voltage 2.80 ~ 2.90 */
 624 #define MMC_OCR_290_300 (1U << 17)      /* Vdd voltage 2.90 ~ 3.00 */
 625 #define MMC_OCR_300_310 (1U << 18)      /* Vdd voltage 3.00 ~ 3.10 */
 626 #define MMC_OCR_310_320 (1U << 19)      /* Vdd voltage 3.10 ~ 3.20 */
 627 #define MMC_OCR_320_330 (1U << 20)      /* Vdd voltage 3.20 ~ 3.30 */
 628 #define MMC_OCR_330_340 (1U << 21)      /* Vdd voltage 3.30 ~ 3.40 */
 629 #define MMC_OCR_340_350 (1U << 22)      /* Vdd voltage 3.40 ~ 3.50 */
 630 #define MMC_OCR_350_360 (1U << 23)      /* Vdd voltage 3.50 ~ 3.60 */
 631 #define MMC_OCR_MAX_VOLTAGE_SHIFT       23
 632 #define MMC_OCR_S18R    (1U << 24)      /* Switching to 1.8 V requested (SD) */
 633 #define MMC_OCR_S18A    MMC_OCR_S18R    /* Switching to 1.8 V accepted (SD) */
 634 #define MMC_OCR_XPC     (1U << 28)      /* SDXC Power Control */
 635 #define MMC_OCR_ACCESS_MODE_BYTE (0U << 29) /* Access Mode Byte (MMC) */
 636 #define MMC_OCR_ACCESS_MODE_SECT (1U << 29) /* Access Mode Sector (MMC) */
 637 #define MMC_OCR_ACCESS_MODE_MASK (3U << 29)
 638 #define MMC_OCR_CCS     (1u << 30)      /* Card Capacity status (SD vs SDHC) */
 639 #define MMC_OCR_CARD_BUSY (1U << 31)    /* Card Power up status */
 640
 641 /* CSD -- decoded structure */
 642 struct mmc_cid {
 643         uint32_t mid;
 644         char pnm[8];
 645         uint32_t psn;
 646         uint16_t oid;
 647         uint16_t mdt_year;
 648         uint8_t mdt_month;
 649         uint8_t prv;
 650         uint8_t fwrev;
 651 };
 652
 653 struct mmc_csd {
 654         uint8_t csd_structure;
 655         uint8_t spec_vers;
 656         uint16_t ccc;
 657         uint16_t tacc;
 658         uint32_t nsac;
 659         uint32_t r2w_factor;
 660         uint32_t tran_speed;
 661         uint32_t read_bl_len;
 662         uint32_t write_bl_len;
 663         uint32_t vdd_r_curr_min;
 664         uint32_t vdd_r_curr_max;
 665         uint32_t vdd_w_curr_min;
 666         uint32_t vdd_w_curr_max;
 667         uint32_t wp_grp_size;
 668         uint32_t erase_sector;
 669         uint64_t capacity;
 670         unsigned int read_bl_partial:1,
 671             read_blk_misalign:1,
 672             write_bl_partial:1,
 673             write_blk_misalign:1,
 674             dsr_imp:1,
 675             erase_blk_en:1,
 676             wp_grp_enable:1;
 677 };
 678
 679 struct mmc_scr {
 680         unsigned char           sda_vsn;
 681         unsigned char           bus_widths;
 682 #define SD_SCR_BUS_WIDTH_1      (1 << 0)
 683 #define SD_SCR_BUS_WIDTH_4      (1 << 2)
 684 };
 685
 686 struct mmc_sd_status {
 687         uint8_t                 bus_width;
 688         uint8_t                 secured_mode;
 689         uint16_t                card_type;
 690         uint16_t                prot_area;
 691         uint8_t                 speed_class;
 692         uint8_t                 perf_move;
 693         uint8_t                 au_size;
 694         uint16_t                erase_size;
 695         uint8_t                 erase_timeout;
 696         uint8_t                 erase_offset;
 697 };
 698
 699 struct mmc_quirk {
 700         uint32_t mid;
 701 #define MMC_QUIRK_MID_ANY       ((uint32_t)-1)
 702         uint16_t oid;
 703 #define MMC_QUIRK_OID_ANY       ((uint16_t)-1)
 704         const char *pnm;
 705         uint32_t quirks;
 706 #define MMC_QUIRK_INAND_CMD38   0x0001
 707 #define MMC_QUIRK_BROKEN_TRIM   0x0002
 708 };
 709
 710 #define MMC_QUIRKS_FMT          "\020" "\001INAND_CMD38" "\002BROKEN_TRIM"
 711
 712 /*
 713  * Various MMC/SD constants
 714  */
 715 #define MMC_BOOT_RPMB_BLOCK_SIZE        (128 * 1024)
 716
 717 #define MMC_EXTCSD_SIZE 512
 718
 719 #define MMC_PART_GP_MAX 4
 720 #define MMC_PART_MAX    8
 721
 722 #define MMC_TUNING_MAX          64      /* Maximum tuning iterations */
 723 #define MMC_TUNING_LEN          64      /* Size of tuning data */
 724 #define MMC_TUNING_LEN_HS200    128     /* Size of tuning data in HS200 mode */
 725
 726 /*
 727  * Older versions of the MMC standard had a variable sector size.  However,
 728  * I've been able to find no old MMC or SD cards that have a non 512
 729  * byte sector size anywhere, so we assume that such cards are very rare
 730  * and only note their existence in passing here...
 731  */
 732 #define MMC_SECTOR_SIZE 512
 733
 734 #endif /* DEV_MMCREG_H */