include/linux/mmc/card.h

   1 /*
   2  *  linux/include/linux/mmc/card.h
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License version 2 as
   6  * published by the Free Software Foundation.
   7  *
   8  *  Card driver specific definitions.
   9  */
  10 #ifndef LINUX_MMC_CARD_H
  11 #define LINUX_MMC_CARD_H
  12
  13 #include <linux/mmc/core.h>
  14 #include <linux/mod_devicetable.h>
  15
  16 struct mmc_cid {
  17         unsigned int            manfid;
  18         char                    prod_name[8];
  19         unsigned int            serial;
  20         unsigned short          oemid;
  21         unsigned short          year;
  22         unsigned char           hwrev;
  23         unsigned char           fwrev;
  24         unsigned char           month;
  25 };
  26
  27 struct mmc_csd {
  28         unsigned char           structure;
  29         unsigned char           mmca_vsn;
  30         unsigned short          cmdclass;
  31         unsigned short          tacc_clks;
  32         unsigned int            tacc_ns;
  33         unsigned int            c_size;
  34         unsigned int            r2w_factor;
  35         unsigned int            max_dtr;
  36         unsigned int            erase_size;             /* In sectors */
  37         unsigned int            read_blkbits;
  38         unsigned int            write_blkbits;
  39         unsigned int            capacity;
  40         unsigned int            read_partial:1,
  41                                 read_misalign:1,
  42                                 write_partial:1,
  43                                 write_misalign:1;
  44 };
  45
  46 struct mmc_ext_csd {
  47         u8                      rev;
  48         u8                      erase_group_def;
  49         u8                      sec_feature_support;
  50         u8                      rel_sectors;
  51         u8                      rel_param;
  52         u8                      part_config;
  53         u8                      cache_ctrl;
  54         u8                      rst_n_function;
  55         unsigned int            part_time;              /* Units: ms */
  56         unsigned int            sa_timeout;             /* Units: 100ns */
  57         unsigned int            generic_cmd6_time;      /* Units: 10ms */
  58         unsigned int            power_off_longtime;     /* Units: ms */
  59         unsigned int            hs_max_dtr;
  60         unsigned int            sectors;
  61         unsigned int            card_type;
  62         unsigned int            hc_erase_size;          /* In sectors */
  63         unsigned int            hc_erase_timeout;       /* In milliseconds */
  64         unsigned int            sec_trim_mult;  /* Secure trim multiplier  */
  65         unsigned int            sec_erase_mult; /* Secure erase multiplier */
  66         unsigned int            trim_timeout;           /* In milliseconds */
  67         bool                    enhanced_area_en;       /* enable bit */
  68         unsigned long long      enhanced_area_offset;   /* Units: Byte */
  69         unsigned int            enhanced_area_size;     /* Units: KB */
  70         unsigned int            cache_size;             /* Units: KB */
  71         bool                    hpi_en;                 /* HPI enablebit */
  72         bool                    hpi;                    /* HPI support bit */
  73         unsigned int            hpi_cmd;                /* cmd used as HPI */
  74         u8                      raw_partition_support;  /* 160 */
  75         u8                      raw_erased_mem_count;   /* 181 */
  76         u8                      raw_ext_csd_structure;  /* 194 */
  77         u8                      raw_card_type;          /* 196 */
  78         u8                      out_of_int_time;        /* 198 */
  79         u8                      raw_s_a_timeout;                /* 217 */
  80         u8                      raw_hc_erase_gap_size;  /* 221 */
  81         u8                      raw_erase_timeout_mult; /* 223 */
  82         u8                      raw_hc_erase_grp_size;  /* 224 */
  83         u8                      raw_sec_trim_mult;      /* 229 */
  84         u8                      raw_sec_erase_mult;     /* 230 */
  85         u8                      raw_sec_feature_support;/* 231 */
  86         u8                      raw_trim_mult;          /* 232 */
  87         u8                      raw_sectors[4];         /* 212 - 4 bytes */
  88
  89         unsigned int            feature_support;
  90 #define MMC_DISCARD_FEATURE     BIT(0)                  /* CMD38 feature */
  91 };
  92
  93 struct sd_scr {
  94         unsigned char           sda_vsn;
  95         unsigned char           sda_spec3;
  96         unsigned char           bus_widths;
  97 #define SD_SCR_BUS_WIDTH_1      (1<<0)
  98 #define SD_SCR_BUS_WIDTH_4      (1<<2)
  99         unsigned char           cmds;
 100 #define SD_SCR_CMD20_SUPPORT   (1<<0)
 101 #define SD_SCR_CMD23_SUPPORT   (1<<1)
 102 };
 103
 104 struct sd_ssr {
 105         unsigned int            au;                     /* In sectors */
 106         unsigned int            erase_timeout;          /* In milliseconds */
 107         unsigned int            erase_offset;           /* In milliseconds */
 108 };
 109
 110 struct sd_switch_caps {
 111         unsigned int            hs_max_dtr;
 112         unsigned int            uhs_max_dtr;
 113 #define HIGH_SPEED_MAX_DTR      50000000
 114 #define UHS_SDR104_MAX_DTR      208000000
 115 #define UHS_SDR50_MAX_DTR       100000000
 116 #define UHS_DDR50_MAX_DTR       50000000
 117 #define UHS_SDR25_MAX_DTR       UHS_DDR50_MAX_DTR
 118 #define UHS_SDR12_MAX_DTR       25000000
 119         unsigned int            sd3_bus_mode;
 120 #define UHS_SDR12_BUS_SPEED     0
 121 #define HIGH_SPEED_BUS_SPEED    1
 122 #define UHS_SDR25_BUS_SPEED     1
 123 #define UHS_SDR50_BUS_SPEED     2
 124 #define UHS_SDR104_BUS_SPEED    3
 125 #define UHS_DDR50_BUS_SPEED     4
 126
 127 #define SD_MODE_HIGH_SPEED      (1 << HIGH_SPEED_BUS_SPEED)
 128 #define SD_MODE_UHS_SDR12       (1 << UHS_SDR12_BUS_SPEED)
 129 #define SD_MODE_UHS_SDR25       (1 << UHS_SDR25_BUS_SPEED)
 130 #define SD_MODE_UHS_SDR50       (1 << UHS_SDR50_BUS_SPEED)
 131 #define SD_MODE_UHS_SDR104      (1 << UHS_SDR104_BUS_SPEED)
 132 #define SD_MODE_UHS_DDR50       (1 << UHS_DDR50_BUS_SPEED)
 133         unsigned int            sd3_drv_type;
 134 #define SD_DRIVER_TYPE_B        0x01
 135 #define SD_DRIVER_TYPE_A        0x02
 136 #define SD_DRIVER_TYPE_C        0x04
 137 #define SD_DRIVER_TYPE_D        0x08
 138         unsigned int            sd3_curr_limit;
 139 #define SD_SET_CURRENT_LIMIT_200        0
 140 #define SD_SET_CURRENT_LIMIT_400        1
 141 #define SD_SET_CURRENT_LIMIT_600        2
 142 #define SD_SET_CURRENT_LIMIT_800        3
 143
 144 #define SD_MAX_CURRENT_200      (1 << SD_SET_CURRENT_LIMIT_200)
 145 #define SD_MAX_CURRENT_400      (1 << SD_SET_CURRENT_LIMIT_400)
 146 #define SD_MAX_CURRENT_600      (1 << SD_SET_CURRENT_LIMIT_600)
 147 #define SD_MAX_CURRENT_800      (1 << SD_SET_CURRENT_LIMIT_800)
 148 };
 149
 150 struct sdio_cccr {
 151         unsigned int            sdio_vsn;
 152         unsigned int            sd_vsn;
 153         unsigned int            multi_block:1,
 154                                 low_speed:1,
 155                                 wide_bus:1,
 156                                 high_power:1,
 157                                 high_speed:1,
 158                                 disable_cd:1;
 159 };
 160
 161 struct sdio_cis {
 162         unsigned short          vendor;
 163         unsigned short          device;
 164         unsigned short          blksize;
 165         unsigned int            max_dtr;
 166 };
 167
 168 struct mmc_host;
 169 struct sdio_func;
 170 struct sdio_func_tuple;
 171
 172 #define SDIO_MAX_FUNCS          7
 173
 174 /* The number of MMC physical partitions.  These consist of:
 175  * boot partitions (2), general purpose partitions (4) in MMC v4.4.
 176  */
 177 #define MMC_NUM_BOOT_PARTITION  2
 178 #define MMC_NUM_GP_PARTITION    4
 179 #define MMC_NUM_PHY_PARTITION   6
 180 #define MAX_MMC_PART_NAME_LEN   20
 181
 182 /*
 183  * MMC Physical partitions
 184  */
 185 struct mmc_part {
 186         unsigned int    size;   /* partition size (in bytes) */
 187         unsigned int    part_cfg;       /* partition type */
 188         char    name[MAX_MMC_PART_NAME_LEN];
 189         bool    force_ro;       /* to make boot parts RO by default */
 190 };
 191
 192 /*
 193  * MMC device
 194  */
 195 struct mmc_card {
 196         struct mmc_host         *host;          /* the host this device belongs to */
 197         struct device           dev;            /* the device */
 198         unsigned int            rca;            /* relative card address of device */
 199         unsigned int            type;           /* card type */
 200 #define MMC_TYPE_MMC            0               /* MMC card */
 201 #define MMC_TYPE_SD             1               /* SD card */
 202 #define MMC_TYPE_SDIO           2               /* SDIO card */
 203 #define MMC_TYPE_SD_COMBO       3               /* SD combo (IO+mem) card */
 204         unsigned int            state;          /* (our) card state */
 205 #define MMC_STATE_PRESENT       (1<<0)          /* present in sysfs */
 206 #define MMC_STATE_READONLY      (1<<1)          /* card is read-only */
 207 #define MMC_STATE_HIGHSPEED     (1<<2)          /* card is in high speed mode */
 208 #define MMC_STATE_BLOCKADDR     (1<<3)          /* card uses block-addressing */
 209 #define MMC_STATE_HIGHSPEED_DDR (1<<4)          /* card is in high speed mode */
 210 #define MMC_STATE_ULTRAHIGHSPEED (1<<5)         /* card is in ultra high speed mode */
 211 #define MMC_CARD_SDXC           (1<<6)          /* card is SDXC */
 212         unsigned int            quirks;         /* card quirks */
 213 #define MMC_QUIRK_LENIENT_FN0   (1<<0)          /* allow SDIO FN0 writes outside of the VS CCCR range */
 214 #define MMC_QUIRK_BLKSZ_FOR_BYTE_MODE (1<<1)    /* use func->cur_blksize */
 215                                                 /* for byte mode */
 216 #define MMC_QUIRK_NONSTD_SDIO   (1<<2)          /* non-standard SDIO card attached */
 217                                                 /* (missing CIA registers) */
 218 #define MMC_QUIRK_BROKEN_CLK_GATING (1<<3)      /* clock gating the sdio bus will make card fail */
 219 #define MMC_QUIRK_NONSTD_FUNC_IF (1<<4)         /* SDIO card has nonstd function interfaces */
 220 #define MMC_QUIRK_DISABLE_CD    (1<<5)          /* disconnect CD/DAT[3] resistor */
 221 #define MMC_QUIRK_INAND_CMD38   (1<<6)          /* iNAND devices have broken CMD38 */
 222 #define MMC_QUIRK_BLK_NO_CMD23  (1<<7)          /* Avoid CMD23 for regular multiblock */
 223 #define MMC_QUIRK_BROKEN_BYTE_MODE_512 (1<<8)   /* Avoid sending 512 bytes in */
 224 #define MMC_QUIRK_LONG_READ_TIME (1<<9)         /* Data read time > CSD says */
 225                                                 /* byte mode */
 226         unsigned int    poweroff_notify_state;  /* eMMC4.5 notify feature */
 227 #define MMC_NO_POWER_NOTIFICATION       0
 228 #define MMC_POWERED_ON                  1
 229 #define MMC_POWEROFF_SHORT              2
 230 #define MMC_POWEROFF_LONG               3
 231
 232         unsigned int            erase_size;     /* erase size in sectors */
 233         unsigned int            erase_shift;    /* if erase unit is power 2 */
 234         unsigned int            pref_erase;     /* in sectors */
 235         u8                      erased_byte;    /* value of erased bytes */
 236
 237         u32                     raw_cid[4];     /* raw card CID */
 238         u32                     raw_csd[4];     /* raw card CSD */
 239         u32                     raw_scr[2];     /* raw card SCR */
 240         struct mmc_cid          cid;            /* card identification */
 241         struct mmc_csd          csd;            /* card specific */
 242         struct mmc_ext_csd      ext_csd;        /* mmc v4 extended card specific */
 243         struct sd_scr           scr;            /* extra SD information */
 244         struct sd_ssr           ssr;            /* yet more SD information */
 245         struct sd_switch_caps   sw_caps;        /* switch (CMD6) caps */
 246
 247         unsigned int            sdio_funcs;     /* number of SDIO functions */
 248         struct sdio_cccr        cccr;           /* common card info */
 249         struct sdio_cis         cis;            /* common tuple info */
 250         struct sdio_func        *sdio_func[SDIO_MAX_FUNCS]; /* SDIO functions (devices) */
 251         struct sdio_func        *sdio_single_irq; /* SDIO function when only one IRQ active */
 252         unsigned                num_info;       /* number of info strings */
 253         const char              **info;         /* info strings */
 254         struct sdio_func_tuple  *tuples;        /* unknown common tuples */
 255
 256         unsigned int            sd_bus_speed;   /* Bus Speed Mode set for the card */
 257
 258         struct dentry           *debugfs_root;
 259         struct mmc_part part[MMC_NUM_PHY_PARTITION]; /* physical partitions */
 260         unsigned int    nr_parts;
 261 };
 262
 263 /*
 264  * This function fill contents in mmc_part.
 265  */
 266 static inline void mmc_part_add(struct mmc_card *card, unsigned int size,
 267                         unsigned int part_cfg, char *name, int idx, bool ro)
 268 {
 269         card->part[card->nr_parts].size = size;
 270         card->part[card->nr_parts].part_cfg = part_cfg;
 271         sprintf(card->part[card->nr_parts].name, name, idx);
 272         card->part[card->nr_parts].force_ro = ro;
 273         card->nr_parts++;
 274 }
 275
 276 /*
 277  *  The world is not perfect and supplies us with broken mmc/sdio devices.
 278  *  For at least some of these bugs we need a work-around.
 279  */
 280
 281 struct mmc_fixup {
 282         /* CID-specific fields. */
 283         const char *name;
 284
 285         /* Valid revision range */
 286         u64 rev_start, rev_end;
 287
 288         unsigned int manfid;
 289         unsigned short oemid;
 290
 291         /* SDIO-specfic fields. You can use SDIO_ANY_ID here of course */
 292         u16 cis_vendor, cis_device;
 293
 294         void (*vendor_fixup)(struct mmc_card *card, int data);
 295         int data;
 296 };
 297
 298 #define CID_MANFID_ANY (-1u)
 299 #define CID_OEMID_ANY ((unsigned short) -1)
 300 #define CID_NAME_ANY (NULL)
 301
 302 #define END_FIXUP { 0 }
 303
 304 #define _FIXUP_EXT(_name, _manfid, _oemid, _rev_start, _rev_end,        \
 305                    _cis_vendor, _cis_device,                            \
 306                    _fixup, _data)                                       \
 307         {                                                  \
 308                 .name = (_name),                           \
 309                 .manfid = (_manfid),                       \
 310                 .oemid = (_oemid),                         \
 311                 .rev_start = (_rev_start),                 \
 312                 .rev_end = (_rev_end),                     \
 313                 .cis_vendor = (_cis_vendor),               \
 314                 .cis_device = (_cis_device),               \
 315                 .vendor_fixup = (_fixup),                  \
 316                 .data = (_data),                           \
 317          }
 318
 319 #define MMC_FIXUP_REV(_name, _manfid, _oemid, _rev_start, _rev_end,     \
 320                       _fixup, _data)                                    \
 321         _FIXUP_EXT(_name, _manfid,                                      \
 322                    _oemid, _rev_start, _rev_end,                        \
 323                    SDIO_ANY_ID, SDIO_ANY_ID,                            \
 324                    _fixup, _data)                                       \
 325
 326 #define MMC_FIXUP(_name, _manfid, _oemid, _fixup, _data) \
 327         MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data)
 328
 329 #define SDIO_FIXUP(_vendor, _device, _fixup, _data)                     \
 330         _FIXUP_EXT(CID_NAME_ANY, CID_MANFID_ANY,                        \
 331                     CID_OEMID_ANY, 0, -1ull,                            \
 332                    _vendor, _device,                                    \
 333                    _fixup, _data)                                       \
 334
 335 #define cid_rev(hwrev, fwrev, year, month)      \
 336         (((u64) hwrev) << 40 |                  \
 337          ((u64) fwrev) << 32 |                  \
 338          ((u64) year) << 16 |                   \
 339          ((u64) month))
 340
 341 #define cid_rev_card(card)                \
 342         cid_rev(card->cid.hwrev,          \
 343                     card->cid.fwrev,      \
 344                     card->cid.year,       \
 345                     card->cid.month)
 346
 347 /*
 348  * Unconditionally quirk add/remove.
 349  */
 350
 351 static inline void __maybe_unused add_quirk(struct mmc_card *card, int data)
 352 {
 353         card->quirks |= data;
 354 }
 355
 356 static inline void __maybe_unused remove_quirk(struct mmc_card *card, int data)
 357 {
 358         card->quirks &= ~data;
 359 }
 360
 361 #define mmc_card_mmc(c)         ((c)->type == MMC_TYPE_MMC)
 362 #define mmc_card_sd(c)          ((c)->type == MMC_TYPE_SD)
 363 #define mmc_card_sdio(c)        ((c)->type == MMC_TYPE_SDIO)
 364
 365 #define mmc_card_present(c)     ((c)->state & MMC_STATE_PRESENT)
 366 #define mmc_card_readonly(c)    ((c)->state & MMC_STATE_READONLY)
 367 #define mmc_card_highspeed(c)   ((c)->state & MMC_STATE_HIGHSPEED)
 368 #define mmc_card_blockaddr(c)   ((c)->state & MMC_STATE_BLOCKADDR)
 369 #define mmc_card_ddr_mode(c)    ((c)->state & MMC_STATE_HIGHSPEED_DDR)
 370 #define mmc_sd_card_uhs(c) ((c)->state & MMC_STATE_ULTRAHIGHSPEED)
 371 #define mmc_card_ext_capacity(c) ((c)->state & MMC_CARD_SDXC)
 372
 373 #define mmc_card_set_present(c) ((c)->state |= MMC_STATE_PRESENT)
 374 #define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY)
 375 #define mmc_card_set_highspeed(c) ((c)->state |= MMC_STATE_HIGHSPEED)
 376 #define mmc_card_set_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR)
 377 #define mmc_card_set_ddr_mode(c) ((c)->state |= MMC_STATE_HIGHSPEED_DDR)
 378 #define mmc_sd_card_set_uhs(c) ((c)->state |= MMC_STATE_ULTRAHIGHSPEED)
 379 #define mmc_card_set_ext_capacity(c) ((c)->state |= MMC_CARD_SDXC)
 380
 381 /*
 382  * Quirk add/remove for MMC products.
 383  */
 384
 385 static inline void __maybe_unused add_quirk_mmc(struct mmc_card *card, int data)
 386 {
 387         if (mmc_card_mmc(card))
 388                 card->quirks |= data;
 389 }
 390
 391 static inline void __maybe_unused remove_quirk_mmc(struct mmc_card *card,
 392                                                    int data)
 393 {
 394         if (mmc_card_mmc(card))
 395                 card->quirks &= ~data;
 396 }
 397
 398 /*
 399  * Quirk add/remove for SD products.
 400  */
 401
 402 static inline void __maybe_unused add_quirk_sd(struct mmc_card *card, int data)
 403 {
 404         if (mmc_card_sd(card))
 405                 card->quirks |= data;
 406 }
 407
 408 static inline void __maybe_unused remove_quirk_sd(struct mmc_card *card,
 409                                                    int data)
 410 {
 411         if (mmc_card_sd(card))
 412                 card->quirks &= ~data;
 413 }
 414
 415 static inline int mmc_card_lenient_fn0(const struct mmc_card *c)
 416 {
 417         return c->quirks & MMC_QUIRK_LENIENT_FN0;
 418 }
 419
 420 static inline int mmc_blksz_for_byte_mode(const struct mmc_card *c)
 421 {
 422         return c->quirks & MMC_QUIRK_BLKSZ_FOR_BYTE_MODE;
 423 }
 424
 425 static inline int mmc_card_disable_cd(const struct mmc_card *c)
 426 {
 427         return c->quirks & MMC_QUIRK_DISABLE_CD;
 428 }
 429
 430 static inline int mmc_card_nonstd_func_interface(const struct mmc_card *c)
 431 {
 432         return c->quirks & MMC_QUIRK_NONSTD_FUNC_IF;
 433 }
 434
 435 static inline int mmc_card_broken_byte_mode_512(const struct mmc_card *c)
 436 {
 437         return c->quirks & MMC_QUIRK_BROKEN_BYTE_MODE_512;
 438 }
 439
 440 static inline int mmc_card_long_read_time(const struct mmc_card *c)
 441 {
 442         return c->quirks & MMC_QUIRK_LONG_READ_TIME;
 443 }
 444
 445 #define mmc_card_name(c)        ((c)->cid.prod_name)
 446 #define mmc_card_id(c)          (dev_name(&(c)->dev))
 447
 448 #define mmc_dev_to_card(d)      container_of(d, struct mmc_card, dev)
 449
 450 #define mmc_list_to_card(l)     container_of(l, struct mmc_card, node)
 451 #define mmc_get_drvdata(c)      dev_get_drvdata(&(c)->dev)
 452 #define mmc_set_drvdata(c,d)    dev_set_drvdata(&(c)->dev, d)
 453
 454 /*
 455  * MMC device driver (e.g., Flash card, I/O card...)
 456  */
 457 struct mmc_driver {
 458         struct device_driver drv;
 459         int (*probe)(struct mmc_card *);
 460         void (*remove)(struct mmc_card *);
 461         int (*suspend)(struct mmc_card *, pm_message_t);
 462         int (*resume)(struct mmc_card *);
 463 };
 464
 465 extern int mmc_register_driver(struct mmc_driver *);
 466 extern void mmc_unregister_driver(struct mmc_driver *);
 467
 468 extern void mmc_fixup_device(struct mmc_card *card,
 469                              const struct mmc_fixup *table);
 470
 471 #endif /* LINUX_MMC_CARD_H */