| /* |
| * linux/include/linux/mmc/card.h |
| * |
| * This program is free software; you can redistribute it and/or modify |
| * it under the terms of the GNU General Public License version 2 as |
| * published by the Free Software Foundation. |
| * |
| * Card driver specific definitions. |
| */ |
| #ifndef LINUX_MMC_CARD_H |
| #define LINUX_MMC_CARD_H |
| |
| #include <linux/device.h> |
| #include <linux/mmc/core.h> |
| #include <linux/mod_devicetable.h> |
| |
| struct mmc_cid { |
| unsigned int manfid; |
| char prod_name[8]; |
| unsigned int serial; |
| unsigned short oemid; |
| unsigned short year; |
| unsigned char hwrev; |
| unsigned char fwrev; |
| unsigned char month; |
| }; |
| |
| struct mmc_csd { |
| unsigned char structure; |
| unsigned char mmca_vsn; |
| unsigned short cmdclass; |
| unsigned short tacc_clks; |
| unsigned int tacc_ns; |
| unsigned int c_size; |
| unsigned int r2w_factor; |
| unsigned int max_dtr; |
| unsigned int erase_size; /* In sectors */ |
| unsigned int read_blkbits; |
| unsigned int write_blkbits; |
| unsigned int capacity; |
| unsigned int read_partial:1, |
| read_misalign:1, |
| write_partial:1, |
| write_misalign:1; |
| }; |
| |
| struct mmc_ext_csd { |
| u8 rev; |
| u8 erase_group_def; |
| u8 sec_feature_support; |
| u8 rel_sectors; |
| u8 rel_param; |
| u8 part_config; |
| u8 cache_ctrl; |
| u8 rst_n_function; |
| unsigned int part_time; /* Units: ms */ |
| unsigned int sa_timeout; /* Units: 100ns */ |
| unsigned int generic_cmd6_time; /* Units: 10ms */ |
| unsigned int power_off_longtime; /* Units: ms */ |
| unsigned int hs_max_dtr; |
| unsigned int sectors; |
| unsigned int card_type; |
| unsigned int hc_erase_size; /* In sectors */ |
| unsigned int hc_erase_timeout; /* In milliseconds */ |
| unsigned int sec_trim_mult; /* Secure trim multiplier */ |
| unsigned int sec_erase_mult; /* Secure erase multiplier */ |
| unsigned int trim_timeout; /* In milliseconds */ |
| bool enhanced_area_en; /* enable bit */ |
| unsigned long long enhanced_area_offset; /* Units: Byte */ |
| unsigned int enhanced_area_size; /* Units: KB */ |
| unsigned int cache_size; /* Units: KB */ |
| bool hpi_en; /* HPI enablebit */ |
| bool hpi; /* HPI support bit */ |
| unsigned int hpi_cmd; /* cmd used as HPI */ |
| unsigned int data_sector_size; /* 512 bytes or 4KB */ |
| unsigned int data_tag_unit_size; /* DATA TAG UNIT size */ |
| unsigned int boot_ro_lock; /* ro lock support */ |
| bool boot_ro_lockable; |
| u8 raw_partition_support; /* 160 */ |
| u8 raw_erased_mem_count; /* 181 */ |
| u8 raw_ext_csd_structure; /* 194 */ |
| u8 raw_card_type; /* 196 */ |
| u8 out_of_int_time; /* 198 */ |
| u8 raw_s_a_timeout; /* 217 */ |
| u8 raw_hc_erase_gap_size; /* 221 */ |
| u8 raw_erase_timeout_mult; /* 223 */ |
| u8 raw_hc_erase_grp_size; /* 224 */ |
| u8 raw_sec_trim_mult; /* 229 */ |
| u8 raw_sec_erase_mult; /* 230 */ |
| u8 raw_sec_feature_support;/* 231 */ |
| u8 raw_trim_mult; /* 232 */ |
| u8 raw_sectors[4]; /* 212 - 4 bytes */ |
| |
| unsigned int feature_support; |
| #define MMC_DISCARD_FEATURE BIT(0) /* CMD38 feature */ |
| }; |
| |
| struct sd_scr { |
| unsigned char sda_vsn; |
| unsigned char sda_spec3; |
| unsigned char bus_widths; |
| #define SD_SCR_BUS_WIDTH_1 (1<<0) |
| #define SD_SCR_BUS_WIDTH_4 (1<<2) |
| unsigned char cmds; |
| #define SD_SCR_CMD20_SUPPORT (1<<0) |
| #define SD_SCR_CMD23_SUPPORT (1<<1) |
| }; |
| |
| struct sd_ssr { |
| unsigned int au; /* In sectors */ |
| unsigned int erase_timeout; /* In milliseconds */ |
| unsigned int erase_offset; /* In milliseconds */ |
| }; |
| |
| struct sd_switch_caps { |
| unsigned int hs_max_dtr; |
| unsigned int uhs_max_dtr; |
| #define HIGH_SPEED_MAX_DTR 50000000 |
| #define UHS_SDR104_MAX_DTR 208000000 |
| #define UHS_SDR50_MAX_DTR 100000000 |
| #define UHS_DDR50_MAX_DTR 50000000 |
| #define UHS_SDR25_MAX_DTR UHS_DDR50_MAX_DTR |
| #define UHS_SDR12_MAX_DTR 25000000 |
| unsigned int sd3_bus_mode; |
| #define UHS_SDR12_BUS_SPEED 0 |
| #define HIGH_SPEED_BUS_SPEED 1 |
| #define UHS_SDR25_BUS_SPEED 1 |
| #define UHS_SDR50_BUS_SPEED 2 |
| #define UHS_SDR104_BUS_SPEED 3 |
| #define UHS_DDR50_BUS_SPEED 4 |
| |
| #define SD_MODE_HIGH_SPEED (1 << HIGH_SPEED_BUS_SPEED) |
| #define SD_MODE_UHS_SDR12 (1 << UHS_SDR12_BUS_SPEED) |
| #define SD_MODE_UHS_SDR25 (1 << UHS_SDR25_BUS_SPEED) |
| #define SD_MODE_UHS_SDR50 (1 << UHS_SDR50_BUS_SPEED) |
| #define SD_MODE_UHS_SDR104 (1 << UHS_SDR104_BUS_SPEED) |
| #define SD_MODE_UHS_DDR50 (1 << UHS_DDR50_BUS_SPEED) |
| unsigned int sd3_drv_type; |
| #define SD_DRIVER_TYPE_B 0x01 |
| #define SD_DRIVER_TYPE_A 0x02 |
| #define SD_DRIVER_TYPE_C 0x04 |
| #define SD_DRIVER_TYPE_D 0x08 |
| unsigned int sd3_curr_limit; |
| #define SD_SET_CURRENT_LIMIT_200 0 |
| #define SD_SET_CURRENT_LIMIT_400 1 |
| #define SD_SET_CURRENT_LIMIT_600 2 |
| #define SD_SET_CURRENT_LIMIT_800 3 |
| |
| #define SD_MAX_CURRENT_200 (1 << SD_SET_CURRENT_LIMIT_200) |
| #define SD_MAX_CURRENT_400 (1 << SD_SET_CURRENT_LIMIT_400) |
| #define SD_MAX_CURRENT_600 (1 << SD_SET_CURRENT_LIMIT_600) |
| #define SD_MAX_CURRENT_800 (1 << SD_SET_CURRENT_LIMIT_800) |
| }; |
| |
| struct sdio_cccr { |
| unsigned int sdio_vsn; |
| unsigned int sd_vsn; |
| unsigned int multi_block:1, |
| low_speed:1, |
| wide_bus:1, |
| high_power:1, |
| high_speed:1, |
| disable_cd:1; |
| }; |
| |
| struct sdio_cis { |
| unsigned short vendor; |
| unsigned short device; |
| unsigned short blksize; |
| unsigned int max_dtr; |
| }; |
| |
| struct mmc_host; |
| struct sdio_func; |
| struct sdio_func_tuple; |
| |
| #define SDIO_MAX_FUNCS 7 |
| |
| /* The number of MMC physical partitions. These consist of: |
| * boot partitions (2), general purpose partitions (4) in MMC v4.4. |
| */ |
| #define MMC_NUM_BOOT_PARTITION 2 |
| #define MMC_NUM_GP_PARTITION 4 |
| #define MMC_NUM_PHY_PARTITION 6 |
| #define MAX_MMC_PART_NAME_LEN 20 |
| |
| /* |
| * MMC Physical partitions |
| */ |
| struct mmc_part { |
| unsigned int size; /* partition size (in bytes) */ |
| unsigned int part_cfg; /* partition type */ |
| char name[MAX_MMC_PART_NAME_LEN]; |
| bool force_ro; /* to make boot parts RO by default */ |
| unsigned int area_type; |
| #define MMC_BLK_DATA_AREA_MAIN (1<<0) |
| #define MMC_BLK_DATA_AREA_BOOT (1<<1) |
| #define MMC_BLK_DATA_AREA_GP (1<<2) |
| }; |
| |
| /* |
| * MMC device |
| */ |
| struct mmc_card { |
| struct mmc_host *host; /* the host this device belongs to */ |
| struct device dev; /* the device */ |
| unsigned int rca; /* relative card address of device */ |
| unsigned int type; /* card type */ |
| #define MMC_TYPE_MMC 0 /* MMC card */ |
| #define MMC_TYPE_SD 1 /* SD card */ |
| #define MMC_TYPE_SDIO 2 /* SDIO card */ |
| #define MMC_TYPE_SD_COMBO 3 /* SD combo (IO+mem) card */ |
| unsigned int state; /* (our) card state */ |
| #define MMC_STATE_PRESENT (1<<0) /* present in sysfs */ |
| #define MMC_STATE_READONLY (1<<1) /* card is read-only */ |
| #define MMC_STATE_HIGHSPEED (1<<2) /* card is in high speed mode */ |
| #define MMC_STATE_BLOCKADDR (1<<3) /* card uses block-addressing */ |
| #define MMC_STATE_HIGHSPEED_DDR (1<<4) /* card is in high speed mode */ |
| #define MMC_STATE_ULTRAHIGHSPEED (1<<5) /* card is in ultra high speed mode */ |
| #define MMC_CARD_SDXC (1<<6) /* card is SDXC */ |
| #define MMC_CARD_REMOVED (1<<7) /* card has been removed */ |
| #define MMC_STATE_HIGHSPEED_200 (1<<8) /* card is in HS200 mode */ |
| #define MMC_STATE_SLEEP (1<<9) /* card is in sleep state */ |
| unsigned int quirks; /* card quirks */ |
| #define MMC_QUIRK_LENIENT_FN0 (1<<0) /* allow SDIO FN0 writes outside of the VS CCCR range */ |
| #define MMC_QUIRK_BLKSZ_FOR_BYTE_MODE (1<<1) /* use func->cur_blksize */ |
| /* for byte mode */ |
| #define MMC_QUIRK_NONSTD_SDIO (1<<2) /* non-standard SDIO card attached */ |
| /* (missing CIA registers) */ |
| #define MMC_QUIRK_BROKEN_CLK_GATING (1<<3) /* clock gating the sdio bus will make card fail */ |
| #define MMC_QUIRK_NONSTD_FUNC_IF (1<<4) /* SDIO card has nonstd function interfaces */ |
| #define MMC_QUIRK_DISABLE_CD (1<<5) /* disconnect CD/DAT[3] resistor */ |
| #define MMC_QUIRK_INAND_CMD38 (1<<6) /* iNAND devices have broken CMD38 */ |
| #define MMC_QUIRK_BLK_NO_CMD23 (1<<7) /* Avoid CMD23 for regular multiblock */ |
| #define MMC_QUIRK_BROKEN_BYTE_MODE_512 (1<<8) /* Avoid sending 512 bytes in */ |
| #define MMC_QUIRK_LONG_READ_TIME (1<<9) /* Data read time > CSD says */ |
| /* byte mode */ |
| unsigned int poweroff_notify_state; /* eMMC4.5 notify feature */ |
| #define MMC_NO_POWER_NOTIFICATION 0 |
| #define MMC_POWERED_ON 1 |
| #define MMC_POWEROFF_SHORT 2 |
| #define MMC_POWEROFF_LONG 3 |
| |
| unsigned int erase_size; /* erase size in sectors */ |
| unsigned int erase_shift; /* if erase unit is power 2 */ |
| unsigned int pref_erase; /* in sectors */ |
| u8 erased_byte; /* value of erased bytes */ |
| |
| u32 raw_cid[4]; /* raw card CID */ |
| u32 raw_csd[4]; /* raw card CSD */ |
| u32 raw_scr[2]; /* raw card SCR */ |
| struct mmc_cid cid; /* card identification */ |
| struct mmc_csd csd; /* card specific */ |
| struct mmc_ext_csd ext_csd; /* mmc v4 extended card specific */ |
| struct sd_scr scr; /* extra SD information */ |
| struct sd_ssr ssr; /* yet more SD information */ |
| struct sd_switch_caps sw_caps; /* switch (CMD6) caps */ |
| |
| unsigned int sdio_funcs; /* number of SDIO functions */ |
| struct sdio_cccr cccr; /* common card info */ |
| struct sdio_cis cis; /* common tuple info */ |
| struct sdio_func *sdio_func[SDIO_MAX_FUNCS]; /* SDIO functions (devices) */ |
| struct sdio_func *sdio_single_irq; /* SDIO function when only one IRQ active */ |
| unsigned num_info; /* number of info strings */ |
| const char **info; /* info strings */ |
| struct sdio_func_tuple *tuples; /* unknown common tuples */ |
| |
| unsigned int sd_bus_speed; /* Bus Speed Mode set for the card */ |
| |
| struct dentry *debugfs_root; |
| struct mmc_part part[MMC_NUM_PHY_PARTITION]; /* physical partitions */ |
| unsigned int nr_parts; |
| }; |
| |
| /* |
| * This function fill contents in mmc_part. |
| */ |
| static inline void mmc_part_add(struct mmc_card *card, unsigned int size, |
| unsigned int part_cfg, char *name, int idx, bool ro, |
| int area_type) |
| { |
| card->part[card->nr_parts].size = size; |
| card->part[card->nr_parts].part_cfg = part_cfg; |
| sprintf(card->part[card->nr_parts].name, name, idx); |
| card->part[card->nr_parts].force_ro = ro; |
| card->part[card->nr_parts].area_type = area_type; |
| card->nr_parts++; |
| } |
| |
| /* |
| * The world is not perfect and supplies us with broken mmc/sdio devices. |
| * For at least some of these bugs we need a work-around. |
| */ |
| |
| struct mmc_fixup { |
| /* CID-specific fields. */ |
| const char *name; |
| |
| /* Valid revision range */ |
| u64 rev_start, rev_end; |
| |
| unsigned int manfid; |
| unsigned short oemid; |
| |
| /* SDIO-specfic fields. You can use SDIO_ANY_ID here of course */ |
| u16 cis_vendor, cis_device; |
| |
| void (*vendor_fixup)(struct mmc_card *card, int data); |
| int data; |
| }; |
| |
| #define CID_MANFID_ANY (-1u) |
| #define CID_OEMID_ANY ((unsigned short) -1) |
| #define CID_NAME_ANY (NULL) |
| |
| #define END_FIXUP { 0 } |
| |
| #define _FIXUP_EXT(_name, _manfid, _oemid, _rev_start, _rev_end, \ |
| _cis_vendor, _cis_device, \ |
| _fixup, _data) \ |
| { \ |
| .name = (_name), \ |
| .manfid = (_manfid), \ |
| .oemid = (_oemid), \ |
| .rev_start = (_rev_start), \ |
| .rev_end = (_rev_end), \ |
| .cis_vendor = (_cis_vendor), \ |
| .cis_device = (_cis_device), \ |
| .vendor_fixup = (_fixup), \ |
| .data = (_data), \ |
| } |
| |
| #define MMC_FIXUP_REV(_name, _manfid, _oemid, _rev_start, _rev_end, \ |
| _fixup, _data) \ |
| _FIXUP_EXT(_name, _manfid, \ |
| _oemid, _rev_start, _rev_end, \ |
| SDIO_ANY_ID, SDIO_ANY_ID, \ |
| _fixup, _data) \ |
| |
| #define MMC_FIXUP(_name, _manfid, _oemid, _fixup, _data) \ |
| MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data) |
| |
| #define SDIO_FIXUP(_vendor, _device, _fixup, _data) \ |
| _FIXUP_EXT(CID_NAME_ANY, CID_MANFID_ANY, \ |
| CID_OEMID_ANY, 0, -1ull, \ |
| _vendor, _device, \ |
| _fixup, _data) \ |
| |
| #define cid_rev(hwrev, fwrev, year, month) \ |
| (((u64) hwrev) << 40 | \ |
| ((u64) fwrev) << 32 | \ |
| ((u64) year) << 16 | \ |
| ((u64) month)) |
| |
| #define cid_rev_card(card) \ |
| cid_rev(card->cid.hwrev, \ |
| card->cid.fwrev, \ |
| card->cid.year, \ |
| card->cid.month) |
| |
| /* |
| * Unconditionally quirk add/remove. |
| */ |
| |
| static inline void __maybe_unused add_quirk(struct mmc_card *card, int data) |
| { |
| card->quirks |= data; |
| } |
| |
| static inline void __maybe_unused remove_quirk(struct mmc_card *card, int data) |
| { |
| card->quirks &= ~data; |
| } |
| |
| #define mmc_card_mmc(c) ((c)->type == MMC_TYPE_MMC) |
| #define mmc_card_sd(c) ((c)->type == MMC_TYPE_SD) |
| #define mmc_card_sdio(c) ((c)->type == MMC_TYPE_SDIO) |
| |
| #define mmc_card_present(c) ((c)->state & MMC_STATE_PRESENT) |
| #define mmc_card_readonly(c) ((c)->state & MMC_STATE_READONLY) |
| #define mmc_card_highspeed(c) ((c)->state & MMC_STATE_HIGHSPEED) |
| #define mmc_card_hs200(c) ((c)->state & MMC_STATE_HIGHSPEED_200) |
| #define mmc_card_blockaddr(c) ((c)->state & MMC_STATE_BLOCKADDR) |
| #define mmc_card_ddr_mode(c) ((c)->state & MMC_STATE_HIGHSPEED_DDR) |
| #define mmc_card_uhs(c) ((c)->state & MMC_STATE_ULTRAHIGHSPEED) |
| #define mmc_sd_card_uhs(c) ((c)->state & MMC_STATE_ULTRAHIGHSPEED) |
| #define mmc_card_ext_capacity(c) ((c)->state & MMC_CARD_SDXC) |
| #define mmc_card_removed(c) ((c) && ((c)->state & MMC_CARD_REMOVED)) |
| #define mmc_card_is_sleep(c) ((c)->state & MMC_STATE_SLEEP) |
| |
| #define mmc_card_set_present(c) ((c)->state |= MMC_STATE_PRESENT) |
| #define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY) |
| #define mmc_card_set_highspeed(c) ((c)->state |= MMC_STATE_HIGHSPEED) |
| #define mmc_card_set_hs200(c) ((c)->state |= MMC_STATE_HIGHSPEED_200) |
| #define mmc_card_set_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR) |
| #define mmc_card_set_ddr_mode(c) ((c)->state |= MMC_STATE_HIGHSPEED_DDR) |
| #define mmc_card_set_uhs(c) ((c)->state |= MMC_STATE_ULTRAHIGHSPEED) |
| #define mmc_sd_card_set_uhs(c) ((c)->state |= MMC_STATE_ULTRAHIGHSPEED) |
| #define mmc_card_set_ext_capacity(c) ((c)->state |= MMC_CARD_SDXC) |
| #define mmc_card_set_removed(c) ((c)->state |= MMC_CARD_REMOVED) |
| #define mmc_card_set_sleep(c) ((c)->state |= MMC_STATE_SLEEP) |
| |
| #define mmc_card_clr_sleep(c) ((c)->state &= ~MMC_STATE_SLEEP) |
| /* |
| * Quirk add/remove for MMC products. |
| */ |
| |
| static inline void __maybe_unused add_quirk_mmc(struct mmc_card *card, int data) |
| { |
| if (mmc_card_mmc(card)) |
| card->quirks |= data; |
| } |
| |
| static inline void __maybe_unused remove_quirk_mmc(struct mmc_card *card, |
| int data) |
| { |
| if (mmc_card_mmc(card)) |
| card->quirks &= ~data; |
| } |
| |
| /* |
| * Quirk add/remove for SD products. |
| */ |
| |
| static inline void __maybe_unused add_quirk_sd(struct mmc_card *card, int data) |
| { |
| if (mmc_card_sd(card)) |
| card->quirks |= data; |
| } |
| |
| static inline void __maybe_unused remove_quirk_sd(struct mmc_card *card, |
| int data) |
| { |
| if (mmc_card_sd(card)) |
| card->quirks &= ~data; |
| } |
| |
| static inline int mmc_card_lenient_fn0(const struct mmc_card *c) |
| { |
| return c->quirks & MMC_QUIRK_LENIENT_FN0; |
| } |
| |
| static inline int mmc_blksz_for_byte_mode(const struct mmc_card *c) |
| { |
| return c->quirks & MMC_QUIRK_BLKSZ_FOR_BYTE_MODE; |
| } |
| |
| static inline int mmc_card_disable_cd(const struct mmc_card *c) |
| { |
| return c->quirks & MMC_QUIRK_DISABLE_CD; |
| } |
| |
| static inline int mmc_card_nonstd_func_interface(const struct mmc_card *c) |
| { |
| return c->quirks & MMC_QUIRK_NONSTD_FUNC_IF; |
| } |
| |
| static inline int mmc_card_broken_byte_mode_512(const struct mmc_card *c) |
| { |
| return c->quirks & MMC_QUIRK_BROKEN_BYTE_MODE_512; |
| } |
| |
| static inline int mmc_card_long_read_time(const struct mmc_card *c) |
| { |
| return c->quirks & MMC_QUIRK_LONG_READ_TIME; |
| } |
| |
| #define mmc_card_name(c) ((c)->cid.prod_name) |
| #define mmc_card_id(c) (dev_name(&(c)->dev)) |
| |
| #define mmc_dev_to_card(d) container_of(d, struct mmc_card, dev) |
| |
| #define mmc_list_to_card(l) container_of(l, struct mmc_card, node) |
| #define mmc_get_drvdata(c) dev_get_drvdata(&(c)->dev) |
| #define mmc_set_drvdata(c,d) dev_set_drvdata(&(c)->dev, d) |
| |
| /* |
| * MMC device driver (e.g., Flash card, I/O card...) |
| */ |
| struct mmc_driver { |
| struct device_driver drv; |
| int (*probe)(struct mmc_card *); |
| void (*remove)(struct mmc_card *); |
| int (*suspend)(struct mmc_card *, pm_message_t); |
| int (*resume)(struct mmc_card *); |
| }; |
| |
| extern int mmc_register_driver(struct mmc_driver *); |
| extern void mmc_unregister_driver(struct mmc_driver *); |
| |
| extern void mmc_fixup_device(struct mmc_card *card, |
| const struct mmc_fixup *table); |
| |
| #endif /* LINUX_MMC_CARD_H */ |