The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/dev/mmc/mmcreg.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * Copyright (c) 2006 M. Warner Losh.  All rights reserved.
    3  *
    4  * Redistribution and use in source and binary forms, with or without
    5  * modification, are permitted provided that the following conditions
    6  * are met:
    7  * 1. Redistributions of source code must retain the above copyright
    8  *    notice, this list of conditions and the following disclaimer.
    9  * 2. Redistributions in binary form must reproduce the above copyright
   10  *    notice, this list of conditions and the following disclaimer in the
   11  *    documentation and/or other materials provided with the distribution.
   12  *
   13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
   14  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   15  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
   16  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
   17  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
   18  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   19  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
   20  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
   22  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   23  *
   24  * Portions of this software may have been developed with reference to
   25  * the SD Simplified Specification.  The following disclaimer may apply:
   26  *
   27  * The following conditions apply to the release of the simplified
   28  * specification ("Simplified Specification") by the SD Card Association and
   29  * the SD Group. The Simplified Specification is a subset of the complete SD
   30  * Specification which is owned by the SD Card Association and the SD
   31  * Group. This Simplified Specification is provided on a non-confidential
   32  * basis subject to the disclaimers below. Any implementation of the
   33  * Simplified Specification may require a license from the SD Card
   34  * Association, SD Group, SD-3C LLC or other third parties.
   35  *
   36  * Disclaimers:
   37  *
   38  * The information contained in the Simplified Specification is presented only
   39  * as a standard specification for SD Cards and SD Host/Ancillary products and
   40  * is provided "AS-IS" without any representations or warranties of any
   41  * kind. No responsibility is assumed by the SD Group, SD-3C LLC or the SD
   42  * Card Association for any damages, any infringements of patents or other
   43  * right of the SD Group, SD-3C LLC, the SD Card Association or any third
   44  * parties, which may result from its use. No license is granted by
   45  * implication, estoppel or otherwise under any patent or other rights of the
   46  * SD Group, SD-3C LLC, the SD Card Association or any third party. Nothing
   47  * herein shall be construed as an obligation by the SD Group, the SD-3C LLC
   48  * or the SD Card Association to disclose or distribute any technical
   49  * information, know-how or other confidential information to any third party.
   50  *
   51  * $FreeBSD: releng/8.0/sys/dev/mmc/mmcreg.h 188044 2009-02-03 04:28:45Z imp $
   52  */
   53 
   54 #ifndef DEV_MMC_MMCREG_H
   55 #define DEV_MMC_MMCREG_H
   56 
   57 /*
   58  * This file contains the register definitions for the mmc and sd busses.
   59  * They are taken from publicly available sources.
   60  */
   61 
   62 struct mmc_data;
   63 struct mmc_request;
   64 
   65 struct mmc_command {
   66         uint32_t        opcode;
   67         uint32_t        arg;
   68         uint32_t        resp[4];
   69         uint32_t        flags;          /* Expected responses */
   70 #define MMC_RSP_PRESENT (1ul << 0)      /* Response */
   71 #define MMC_RSP_136     (1ul << 1)      /* 136 bit response */
   72 #define MMC_RSP_CRC     (1ul << 2)      /* Expect valid crc */
   73 #define MMC_RSP_BUSY    (1ul << 3)      /* Card may send busy */
   74 #define MMC_RSP_OPCODE  (1ul << 4)      /* Response include opcode */
   75 #define MMC_RSP_MASK    0x1ful
   76 #define MMC_CMD_AC      (0ul << 5)      /* Addressed Command, no data */
   77 #define MMC_CMD_ADTC    (1ul << 5)      /* Addressed Data transfer cmd */
   78 #define MMC_CMD_BC      (2ul << 5)      /* Broadcast command, no response */
   79 #define MMC_CMD_BCR     (3ul << 5)      /* Broadcast command with response */
   80 #define MMC_CMD_MASK    (3ul << 5)
   81 
   82 /* Possible response types defined in the standard: */
   83 #define MMC_RSP_NONE    (0)
   84 #define MMC_RSP_R1      (MMC_RSP_PRESENT | MMC_RSP_CRC | MMC_RSP_OPCODE)
   85 #define MMC_RSP_R1B     (MMC_RSP_PRESENT | MMC_RSP_CRC | MMC_RSP_OPCODE | MMC_RSP_BUSY)
   86 #define MMC_RSP_R2      (MMC_RSP_PRESENT | MMC_RSP_136 | MMC_RSP_CRC)
   87 #define MMC_RSP_R3      (MMC_RSP_PRESENT)
   88 #define MMC_RSP_R6      (MMC_RSP_PRESENT | MMC_RSP_CRC)
   89 #define MMC_RSP_R7      (MMC_RSP_PRESENT | MMC_RSP_CRC)
   90 #define MMC_RSP(x)      ((x) & MMC_RSP_MASK)
   91         uint32_t        retries;
   92         uint32_t        error;
   93 #define MMC_ERR_NONE    0
   94 #define MMC_ERR_TIMEOUT 1
   95 #define MMC_ERR_BADCRC  2
   96 #define MMC_ERR_FIFO    3
   97 #define MMC_ERR_FAILED  4
   98 #define MMC_ERR_INVALID 5
   99 #define MMC_ERR_NO_MEMORY 6
  100 #define MMC_ERR_MAX     6
  101         struct mmc_data *data;          /* Data segment with cmd */
  102         struct mmc_request *mrq;        /* backpointer to request */
  103 };
  104 
  105 /*
  106  * R1 responses
  107  *
  108  * Types (per SD 2.0 standard)
  109  *      e : error bit
  110  *      s : status bit
  111  *      r : detected and set for the actual command response
  112  *      x : Detected and set during command execution.  The host can get
  113  *          the status by issuing a command with R1 response.
  114  *
  115  * Clear Condition (per SD 2.0 standard)
  116  *      a : according to the card current state.
  117  *      b : always related to the previous command.  reception of a valid
  118  *          command will clear it (with a delay of one command).
  119  *      c : clear by read
  120  */
  121 #define R1_OUT_OF_RANGE (1u << 31)              /* erx, c */
  122 #define R1_ADDRESS_ERROR (1u << 30)             /* erx, c */
  123 #define R1_BLOCK_LEN_ERROR (1u << 29)           /* erx, c */
  124 #define R1_ERASE_SEQ_ERROR (1u << 28)           /* er, c */
  125 #define R1_ERASE_PARAM (1u << 27)               /* erx, c */
  126 #define R1_WP_VIOLATION (1u << 26)              /* erx, c */
  127 #define R1_CARD_IS_LOCKED (1u << 25)            /* sx, a */
  128 #define R1_LOCK_UNLOCK_FAILED (1u << 24)        /* erx, c */
  129 #define R1_COM_CRC_ERROR (1u << 23)             /* er, b */
  130 #define R1_ILLEGAL_COMMAND (1u << 22)           /* er, b */
  131 #define R1_CARD_ECC_FAILED (1u << 21)           /* erx, c */
  132 #define R1_CC_ERROR (1u << 20)                  /* erx, c */
  133 #define R1_ERROR (1u << 19)                     /* erx, c */
  134 #define R1_CSD_OVERWRITE (1u << 16)             /* erx, c */
  135 #define R1_WP_ERASE_SKIP (1u << 15)             /* erx, c */
  136 #define R1_CARD_ECC_DISABLED (1u << 14)         /* sx, a */
  137 #define R1_ERASE_RESET (1u << 13)               /* sr, c */
  138 #define R1_CURRENT_STATE_MASK (0xfu << 9)       /* sx, b */
  139 #define R1_READY_FOR_DATA (1u << 8)             /* sx, a */
  140 #define R1_APP_CMD (1u << 5)                    /* sr, c */
  141 #define R1_AKE_SEQ_ERROR (1u << 3)              /* er, c */
  142 #define R1_STATUS(x)            (x & 0xFFFFE000
  143 #define R1_CURRENT_STATE(x) ((x) & R1_CURRENT_STATE_MASK) >> 9
  144 #define R1_STATE_IDLE   0
  145 #define R1_STATE_READY  1
  146 #define R1_STATE_IDENT  2
  147 #define R1_STATE_STBY   3
  148 #define R1_STATE_TRAN   4
  149 #define R1_STATE_DATA   5
  150 #define R1_STATE_RCV    6
  151 #define R1_STATE_PRG    7
  152 #define R1_STATE_DIS    8
  153 
  154 struct mmc_data {
  155         size_t len;             /* size of the data */
  156         size_t xfer_len;
  157         void *data;             /* data buffer */
  158         uint32_t        flags;
  159 #define MMC_DATA_WRITE  (1UL << 0)
  160 #define MMC_DATA_READ   (1UL << 1)
  161 #define MMC_DATA_STREAM (1UL << 2)
  162 #define MMC_DATA_MULTI  (1UL << 3)
  163         struct mmc_request *mrq;
  164 };
  165 
  166 struct mmc_request {
  167         struct mmc_command *cmd;
  168         struct mmc_command *stop;
  169         void (*done)(struct mmc_request *); /* Completion function */
  170         void *done_data;                /* requestor set data */
  171         uint32_t flags;
  172 #define MMC_REQ_DONE    1
  173 };
  174 
  175 /* Command definitions */
  176 
  177 /* Class 0 and 1: Basic commands & read stream commands */
  178 #define MMC_GO_IDLE_STATE       0
  179 #define MMC_SEND_OP_COND        1
  180 #define MMC_ALL_SEND_CID        2
  181 #define MMC_SET_RELATIVE_ADDR   3
  182 #define SD_SEND_RELATIVE_ADDR   3
  183 #define MMC_SET_DSR             4
  184                         /* reserved: 5 */
  185 #define MMC_SWITCH_FUNC         6
  186 #define  MMC_SWITCH_FUNC_CMDS    0
  187 #define  MMC_SWITCH_FUNC_SET     1
  188 #define  MMC_SWITCH_FUNC_CLR     2
  189 #define  MMC_SWITCH_FUNC_WR      3
  190 #define MMC_SELECT_CARD         7
  191 #define MMC_DESELECT_CARD       7
  192 #define MMC_SEND_EXT_CSD        8
  193 #define SD_SEND_IF_COND         8
  194 #define MMC_SEND_CSD            9
  195 #define MMC_SEND_CID            10
  196 #define MMC_READ_DAT_UNTIL_STOP 11
  197 #define MMC_STOP_TRANSMISSION   12
  198 #define MMC_SEND_STATUS         13
  199 #define MMC_BUSTEST_R           14
  200 #define MMC_GO_INACTIVE_STATE   15
  201 #define MMC_BUSTEST_W           19
  202 
  203 /* Class 2: Block oriented read commands */
  204 #define MMC_SET_BLOCKLEN        16
  205 #define MMC_READ_SINGLE_BLOCK   17
  206 #define MMC_READ_MULTIPLE_BLOCK 18
  207                         /* reserved: 19 */
  208 
  209 /* Class 3: Stream write commands */
  210 #define MMC_WRITE_DAT_UNTIL_STOP 20
  211                         /* reserved: 21 */
  212                         /* reserved: 22 */
  213 
  214 /* Class 4: Block oriented write commands */
  215 #define MMC_SET_BLOCK_COUNT     23
  216 #define MMC_WRITE_BLOCK         24
  217 #define MMC_WRITE_MULTIPLE_BLOCK 25
  218 #define MMC_PROGARM_CID         26
  219 #define MMC_PROGRAM_CSD         27
  220 
  221 /* Class 6: Block oriented write protection commands */
  222 #define MMC_SET_WRITE_PROT      28
  223 #define MMC_CLR_WRITE_PROT      29
  224 #define MMC_SEND_WRITE_PROT     30
  225                         /* reserved: 31 */
  226 
  227 /* Class 5: Erase commands */
  228 #define SD_ERASE_WR_BLK_START   32
  229 #define SD_ERASE_WR_BLK_END     33
  230                         /* 34 -- reserved old command */
  231 #define MMC_ERASE_GROUP_START   35
  232 #define MMC_ERASE_GROUP_END     36
  233                         /* 37 -- reserved old command */
  234 #define MMC_ERASE               38
  235 
  236 /* Class 9: I/O mode commands */
  237 #define MMC_FAST_IO             39
  238 #define MMC_GO_IRQ_STATE        40
  239                         /* reserved: 41 */
  240 
  241 /* Class 7: Lock card */
  242 #define MMC_LOCK_UNLOCK         42
  243                         /* reserved: 43 */
  244                         /* reserved: 44 */
  245                         /* reserved: 45 */
  246                         /* reserved: 46 */
  247                         /* reserved: 47 */
  248                         /* reserved: 48 */
  249                         /* reserved: 49 */
  250                         /* reserved: 50 */
  251                         /* reserved: 51 */
  252                         /* reserved: 54 */
  253 
  254 /* Class 8: Application specific commands */
  255 #define MMC_APP_CMD             55
  256 #define MMC_GEN_CMD             56
  257                         /* reserved: 57 */
  258                         /* reserved: 58 */
  259                         /* reserved: 59 */
  260                         /* reserved for mfg: 60 */
  261                         /* reserved for mfg: 61 */
  262                         /* reserved for mfg: 62 */
  263                         /* reserved for mfg: 63 */
  264 
  265 /* Class 9: I/O cards (sd) */
  266 #define SD_IO_RW_DIRECT         52
  267 #define SD_IO_RW_EXTENDED       53
  268 
  269 /* Class 10: Switch function commands */
  270 #define SD_SWITCH_FUNC          6
  271                         /* reserved: 34 */
  272                         /* reserved: 35 */
  273                         /* reserved: 36 */
  274                         /* reserved: 37 */
  275                         /* reserved: 50 */
  276                         /* reserved: 57 */
  277 
  278 
  279 /* Application specific commands for SD */
  280 #define ACMD_SET_BUS_WIDTH      6
  281 #define ACMD_SD_STATUS          13
  282 #define ACMD_SEND_NUM_WR_BLOCKS 22
  283 #define ACMD_SET_WR_BLK_ERASE_COUNT 23
  284 #define ACMD_SD_SEND_OP_COND    41
  285 #define ACMD_SET_CLR_CARD_DETECT 42
  286 #define ACMD_SEND_SCR           51
  287 
  288 /*
  289  * EXT_CSD fields
  290  */
  291 #define EXT_CSD_ERASE_GRP_DEF   175     /* R/W */
  292 #define EXT_CSD_BUS_WIDTH       183     /* R/W */
  293 #define EXT_CSD_HS_TIMING       185     /* R/W */
  294 #define EXT_CSD_CARD_TYPE       196     /* RO */
  295 #define EXT_CSD_REV             192     /* RO */
  296 #define EXT_CSD_SEC_CNT         212     /* RO, 4 bytes */
  297 #define EXT_CSD_ERASE_TO_MULT   223     /* RO */
  298 #define EXT_CSD_ERASE_GRP_SIZE  224     /* RO */
  299 
  300 /*
  301  * EXT_CSD field definitions
  302  */
  303 #define EXT_CSD_CMD_SET_NORMAL          1
  304 #define EXT_CSD_CMD_SET_SECURE          2
  305 #define EXT_CSD_CMD_SET_CPSECURE        4
  306 
  307 #define EXT_CSD_CARD_TYPE_26    1
  308 #define EXT_CSD_CARD_TYPE_52    2
  309 
  310 #define EXT_CSD_BUS_WIDTH_1     0
  311 #define EXT_CSD_BUS_WIDTH_4     1
  312 #define EXT_CSD_BUS_WIDTH_8     2
  313 
  314 #define MMC_TYPE_26_MAX_HS      26000000
  315 #define MMC_TYPE_52_MAX_HS      52000000
  316 
  317 /*
  318  * SD bus widths
  319  */
  320 #define SD_BUS_WIDTH_1          0
  321 #define SD_BUS_WIDTH_4          2
  322 
  323 /*
  324  * SD Switch
  325  */
  326 #define SD_SWITCH_MODE_CHECK    0
  327 #define SD_SWITCH_MODE_SET      1
  328 #define SD_SWITCH_GROUP1        0
  329 #define SD_SWITCH_NORMAL_MODE   0
  330 #define SD_SWITCH_HS_MODE       1
  331 #define SD_SWITCH_NOCHANGE      0xF
  332 
  333 #define SD_MAX_HS               50000000
  334 
  335 /* OCR bits */
  336 
  337 /*
  338  * in SD 2.0 spec, bits 8-14 are now marked reserved
  339  * Low voltage in SD2.0 spec is bit 7, TBD voltage
  340  * Low voltage in MC 3.31 spec is bit 7, 1.65-1.95V
  341  * Specs prior to  MMC 3.31 defined bits 0-7 as voltages down to 1.5V.
  342  * 3.31 redefined them to be reserved and also said that cards had to
  343  * support the 2.7-3.6V and fixed the OCR to be 0xfff8000 for high voltage
  344  * cards.  MMC 4.0 says that a dual voltage card responds with 0xfff8080.
  345  * Looks like the fine-grained control of the voltage tolerance ranges
  346  * was abandoned.
  347  *
  348  * The MMC_OCR_CCS appears to be valid for only SD cards.
  349  */
  350 #define MMC_OCR_VOLTAGE 0x3fffffffU     /* Vdd Voltage mask */
  351 #define MMC_OCR_LOW_VOLTAGE (1u << 7)   /* Low Voltage Range -- tbd */
  352 #define MMC_OCR_200_210 (1U << 8)       /* Vdd voltage 2.00 ~ 2.10 */
  353 #define MMC_OCR_210_220 (1U << 9)       /* Vdd voltage 2.10 ~ 2.20 */
  354 #define MMC_OCR_220_230 (1U << 10)      /* Vdd voltage 2.20 ~ 2.30 */
  355 #define MMC_OCR_230_240 (1U << 11)      /* Vdd voltage 2.30 ~ 2.40 */
  356 #define MMC_OCR_240_250 (1U << 12)      /* Vdd voltage 2.40 ~ 2.50 */
  357 #define MMC_OCR_250_260 (1U << 13)      /* Vdd voltage 2.50 ~ 2.60 */
  358 #define MMC_OCR_260_270 (1U << 14)      /* Vdd voltage 2.60 ~ 2.70 */
  359 #define MMC_OCR_270_280 (1U << 15)      /* Vdd voltage 2.70 ~ 2.80 */
  360 #define MMC_OCR_280_290 (1U << 16)      /* Vdd voltage 2.80 ~ 2.90 */
  361 #define MMC_OCR_290_300 (1U << 17)      /* Vdd voltage 2.90 ~ 3.00 */
  362 #define MMC_OCR_300_310 (1U << 18)      /* Vdd voltage 3.00 ~ 3.10 */
  363 #define MMC_OCR_310_320 (1U << 19)      /* Vdd voltage 3.10 ~ 3.20 */
  364 #define MMC_OCR_320_330 (1U << 20)      /* Vdd voltage 3.20 ~ 3.30 */
  365 #define MMC_OCR_330_340 (1U << 21)      /* Vdd voltage 3.30 ~ 3.40 */
  366 #define MMC_OCR_340_350 (1U << 22)      /* Vdd voltage 3.40 ~ 3.50 */
  367 #define MMC_OCR_350_360 (1U << 23)      /* Vdd voltage 3.50 ~ 3.60 */
  368 #define MMC_OCR_CCS     (1u << 30)      /* Card Capacity status (SD vs SDHC) */
  369 #define MMC_OCR_CARD_BUSY (1U << 31)    /* Card Power up status */
  370 
  371 /* CSD -- decoded structure */
  372 struct mmc_cid {
  373         uint32_t mid;
  374         char pnm[8];
  375         uint32_t psn;
  376         uint16_t oid;
  377         uint16_t mdt_year;
  378         uint8_t mdt_month;
  379         uint8_t prv;
  380         uint8_t fwrev;
  381 };
  382 
  383 struct mmc_csd 
  384 {
  385         uint8_t csd_structure;
  386         uint8_t spec_vers;
  387         uint16_t ccc;
  388         uint16_t tacc;
  389         uint32_t nsac;
  390         uint32_t r2w_factor;
  391         uint32_t tran_speed;
  392         uint32_t read_bl_len;
  393         uint32_t write_bl_len;
  394         uint32_t vdd_r_curr_min;
  395         uint32_t vdd_r_curr_max;
  396         uint32_t vdd_w_curr_min;
  397         uint32_t vdd_w_curr_max;
  398         uint32_t wp_grp_size;
  399         uint32_t erase_sector;
  400         uint64_t capacity;
  401         unsigned int read_bl_partial:1,
  402             read_blk_misalign:1,
  403             write_bl_partial:1,
  404             write_blk_misalign:1,
  405             dsr_imp:1,
  406             erase_blk_en:1,
  407             wp_grp_enable:1;
  408 };
  409 
  410 struct mmc_scr
  411 {
  412         unsigned char           sda_vsn;
  413         unsigned char           bus_widths;
  414 #define SD_SCR_BUS_WIDTH_1      (1<<0)
  415 #define SD_SCR_BUS_WIDTH_4      (1<<2)
  416 };
  417 
  418 struct mmc_sd_status
  419 {
  420         uint8_t                 bus_width;
  421         uint8_t                 secured_mode;
  422         uint16_t                card_type;
  423         uint16_t                prot_area;
  424         uint8_t                 speed_class;
  425         uint8_t                 perf_move;
  426         uint8_t                 au_size;
  427         uint16_t                erase_size;
  428         uint8_t                 erase_timeout;
  429         uint8_t                 erase_offset;
  430 };
  431 
  432 /*
  433  * Older versions of the MMC standard had a variable sector size.  However,
  434  * I've been able to find no old MMC or SD cards that have a non 512
  435  * byte sector size anywhere, so we assume that such cards are very rare
  436  * and only note their existance in passing here...
  437  */
  438 #define MMC_SECTOR_SIZE 512
  439 
  440 #endif /* DEV_MMCREG_H */

Cache object: 1ac10f1db484fb69fa49508c4cb554df


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.