[deliverable/linux.git] / include / linux / mmc / card.h

/*
 *  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/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 */
	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 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 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_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 */
};

/*
 * 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 */
	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 */
						/* 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)
{
	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->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_blockaddr(c)	((c)->state & MMC_STATE_BLOCKADDR)
#define mmc_card_ddr_mode(c)	((c)->state & MMC_STATE_HIGHSPEED_DDR)
#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_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_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR)
#define mmc_card_set_ddr_mode(c) ((c)->state |= MMC_STATE_HIGHSPEED_DDR)
#define mmc_sd_card_set_uhs(c) ((c)->state |= MMC_STATE_ULTRAHIGHSPEED)
#define mmc_card_set_ext_capacity(c) ((c)->state |= MMC_CARD_SDXC)

/*
 * 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;
}

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