include/linux/mmc/card.h - kernel/msm - Gitiles

 /*
  *  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		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;
 	unsigned int		part_time;		/* Units: ms */
 	unsigned int		sa_timeout;		/* Units: 100ns */
 	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		boot_size;		/* in bytes */
 };

 struct sd_scr {
 	unsigned char		sda_vsn;
 	unsigned char		bus_widths;
 #define SD_SCR_BUS_WIDTH_1	(1<<0)
 #define SD_SCR_BUS_WIDTH_4	(1<<2)
 };

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

 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

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

 	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) */
 	unsigned		num_info;	/* number of info strings */
 	const char		**info;		/* info strings */
 	struct sdio_func_tuple	*tuples;	/* unknown common tuples */

 	struct dentry		*debugfs_root;
 };

 /*
  *  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)

 /*
  * This hook just adds a quirk unconditionally.
  */
 static inline void __maybe_unused add_quirk(struct mmc_card *card, int data)
 {
 	card->quirks |= data;
 }

 /*
  * This hook just removes a quirk unconditionally.
  */
 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_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)

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

 #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/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 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;
	unsigned int part_time; /* Units: ms */
	unsigned int sa_timeout; /* Units: 100ns */
	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 boot_size; /* in bytes */
	};

	struct sd_scr {
	unsigned char sda_vsn;
	unsigned char bus_widths;
	#define SD_SCR_BUS_WIDTH_1 (1<<0)
	#define SD_SCR_BUS_WIDTH_4 (1<<2)
	};

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

	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

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

	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) */
	unsigned num_info; /* number of info strings */
	const char *info; / info strings */
	struct sdio_func_tuple tuples; / unknown common tuples */

	struct dentry *debugfs_root;
	};

	/*
	* 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)

	/*
	* This hook just adds a quirk unconditionally.
	*/
	static inline void __maybe_unused add_quirk(struct mmc_card *card, int data)
	{
	card->quirks \|= data;
	}

	/*
	* This hook just removes a quirk unconditionally.
	*/
	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_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)

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

	#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