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
  15 struct mmc_cid {
  16         unsigned int            manfid;
  17         char                    prod_name[8];
  18         unsigned int            serial;
  19         unsigned short          oemid;
  20         unsigned short          year;
  21         unsigned char           hwrev;
  22         unsigned char           fwrev;
  23         unsigned char           month;
  24 };
  25
  26 struct mmc_csd {
  27         unsigned char           structure;
  28         unsigned char           mmca_vsn;
  29         unsigned short          cmdclass;
  30         unsigned short          tacc_clks;
  31         unsigned int            tacc_ns;
  32         unsigned int            r2w_factor;
  33         unsigned int            max_dtr;
  34         unsigned int            read_blkbits;
  35         unsigned int            write_blkbits;
  36         unsigned int            capacity;
  37         unsigned int            read_partial:1,
  38                                 read_misalign:1,
  39                                 write_partial:1,
  40                                 write_misalign:1;
  41 };
  42
  43 struct mmc_ext_csd {
  44         u8                      rev;
  45         unsigned int            sa_timeout;             /* Units: 100ns */
  46         unsigned int            hs_max_dtr;
  47         unsigned int            sectors;
  48 };
  49
  50 struct sd_scr {
  51         unsigned char           sda_vsn;
  52         unsigned char           bus_widths;
  53 #define SD_SCR_BUS_WIDTH_1      (1<<0)
  54 #define SD_SCR_BUS_WIDTH_4      (1<<2)
  55 };
  56
  57 struct sd_switch_caps {
  58         unsigned int            hs_max_dtr;
  59 };
  60
  61 struct sdio_cccr {
  62         unsigned int            sdio_vsn;
  63         unsigned int            sd_vsn;
  64         unsigned int            multi_block:1,
  65                                 low_speed:1,
  66                                 wide_bus:1,
  67                                 high_power:1,
  68                                 high_speed:1,
  69                                 disable_cd:1;
  70 };
  71
  72 struct sdio_cis {
  73         unsigned short          vendor;
  74         unsigned short          device;
  75         unsigned short          blksize;
  76         unsigned int            max_dtr;
  77 };
  78
  79 struct mmc_host;
  80 struct sdio_func;
  81 struct sdio_func_tuple;
  82
  83 #define SDIO_MAX_FUNCS          7
  84
  85 /*
  86  * MMC device
  87  */
  88 struct mmc_card {
  89         struct mmc_host         *host;          /* the host this device belongs to */
  90         struct device           dev;            /* the device */
  91         unsigned int            rca;            /* relative card address of device */
  92         unsigned int            type;           /* card type */
  93 #define MMC_TYPE_MMC            0               /* MMC card */
  94 #define MMC_TYPE_SD             1               /* SD card */
  95 #define MMC_TYPE_SDIO           2               /* SDIO card */
  96 #define MMC_TYPE_SD_COMBO       3               /* SD combo (IO+mem) card */
  97         unsigned int            state;          /* (our) card state */
  98 #define MMC_STATE_PRESENT       (1<<0)          /* present in sysfs */
  99 #define MMC_STATE_READONLY      (1<<1)          /* card is read-only */
 100 #define MMC_STATE_HIGHSPEED     (1<<2)          /* card is in high speed mode */
 101 #define MMC_STATE_BLOCKADDR     (1<<3)          /* card uses block-addressing */
 102         unsigned int            quirks;         /* card quirks */
 103 #define MMC_QUIRK_LENIENT_FN0   (1<<0)          /* allow SDIO FN0 writes outside of the VS CCCR range */
 104 #define MMC_QUIRK_BLKSZ_FOR_BYTE_MODE (1<<1)    /* use func->cur_blksize */
 105                                                 /* for byte mode */
 106
 107         u32                     raw_cid[4];     /* raw card CID */
 108         u32                     raw_csd[4];     /* raw card CSD */
 109         u32                     raw_scr[2];     /* raw card SCR */
 110         struct mmc_cid          cid;            /* card identification */
 111         struct mmc_csd          csd;            /* card specific */
 112         struct mmc_ext_csd      ext_csd;        /* mmc v4 extended card specific */
 113         struct sd_scr           scr;            /* extra SD information */
 114         struct sd_switch_caps   sw_caps;        /* switch (CMD6) caps */
 115
 116         unsigned int            sdio_funcs;     /* number of SDIO functions */
 117         struct sdio_cccr        cccr;           /* common card info */
 118         struct sdio_cis         cis;            /* common tuple info */
 119         struct sdio_func        *sdio_func[SDIO_MAX_FUNCS]; /* SDIO functions (devices) */
 120         unsigned                num_info;       /* number of info strings */
 121         const char              **info;         /* info strings */
 122         struct sdio_func_tuple  *tuples;        /* unknown common tuples */
 123
 124         struct dentry           *debugfs_root;
 125 };
 126
 127 #define mmc_card_mmc(c)         ((c)->type == MMC_TYPE_MMC)
 128 #define mmc_card_sd(c)          ((c)->type == MMC_TYPE_SD)
 129 #define mmc_card_sdio(c)        ((c)->type == MMC_TYPE_SDIO)
 130
 131 #define mmc_card_present(c)     ((c)->state & MMC_STATE_PRESENT)
 132 #define mmc_card_readonly(c)    ((c)->state & MMC_STATE_READONLY)
 133 #define mmc_card_highspeed(c)   ((c)->state & MMC_STATE_HIGHSPEED)
 134 #define mmc_card_blockaddr(c)   ((c)->state & MMC_STATE_BLOCKADDR)
 135
 136 #define mmc_card_set_present(c) ((c)->state |= MMC_STATE_PRESENT)
 137 #define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY)
 138 #define mmc_card_set_highspeed(c) ((c)->state |= MMC_STATE_HIGHSPEED)
 139 #define mmc_card_set_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR)
 140
 141 static inline int mmc_card_lenient_fn0(const struct mmc_card *c)
 142 {
 143         return c->quirks & MMC_QUIRK_LENIENT_FN0;
 144 }
 145
 146 static inline int mmc_blksz_for_byte_mode(const struct mmc_card *c)
 147 {
 148         return c->quirks & MMC_QUIRK_BLKSZ_FOR_BYTE_MODE;
 149 }
 150
 151 #define mmc_card_name(c)        ((c)->cid.prod_name)
 152 #define mmc_card_id(c)          (dev_name(&(c)->dev))
 153
 154 #define mmc_list_to_card(l)     container_of(l, struct mmc_card, node)
 155 #define mmc_get_drvdata(c)      dev_get_drvdata(&(c)->dev)
 156 #define mmc_set_drvdata(c,d)    dev_set_drvdata(&(c)->dev, d)
 157
 158 /*
 159  * MMC device driver (e.g., Flash card, I/O card...)
 160  */
 161 struct mmc_driver {
 162         struct device_driver drv;
 163         int (*probe)(struct mmc_card *);
 164         void (*remove)(struct mmc_card *);
 165         int (*suspend)(struct mmc_card *, pm_message_t);
 166         int (*resume)(struct mmc_card *);
 167 };
 168
 169 extern int mmc_register_driver(struct mmc_driver *);
 170 extern void mmc_unregister_driver(struct mmc_driver *);
 171
 172 #endif