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

/*
 *  linux/include/linux/mmc/core.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.
 */
#ifndef LINUX_MMC_CORE_H
#define LINUX_MMC_CORE_H

#include <linux/interrupt.h>
#include <linux/completion.h>

struct request;
struct mmc_data;
struct mmc_request;

struct mmc_command {
	u32			opcode;
	u32			arg;
#define MMC_CMD23_ARG_REL_WR	(1 << 31)
#define MMC_CMD23_ARG_PACKED	((0 << 31) | (1 << 30))
#define MMC_CMD23_ARG_TAG_REQ	(1 << 29)
	u32			resp[4];
	unsigned int		flags;		/* expected response type */
#define MMC_RSP_PRESENT	(1 << 0)
#define MMC_RSP_136	(1 << 1)		/* 136 bit response */
#define MMC_RSP_CRC	(1 << 2)		/* expect valid crc */
#define MMC_RSP_BUSY	(1 << 3)		/* card may send busy */
#define MMC_RSP_OPCODE	(1 << 4)		/* response contains opcode */

#define MMC_CMD_MASK	(3 << 5)		/* non-SPI command type */
#define MMC_CMD_AC	(0 << 5)
#define MMC_CMD_ADTC	(1 << 5)
#define MMC_CMD_BC	(2 << 5)
#define MMC_CMD_BCR	(3 << 5)

#define MMC_RSP_SPI_S1	(1 << 7)		/* one status byte */
#define MMC_RSP_SPI_S2	(1 << 8)		/* second byte */
#define MMC_RSP_SPI_B4	(1 << 9)		/* four data bytes */
#define MMC_RSP_SPI_BUSY (1 << 10)		/* card may send busy */

/*
 * These are the native response types, and correspond to valid bit
 * patterns of the above flags.  One additional valid pattern
 * is all zeros, which means we don't expect a response.
 */
#define MMC_RSP_NONE	(0)
#define MMC_RSP_R1	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
#define MMC_RSP_R1B	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE|MMC_RSP_BUSY)
#define MMC_RSP_R2	(MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC)
#define MMC_RSP_R3	(MMC_RSP_PRESENT)
#define MMC_RSP_R4	(MMC_RSP_PRESENT)
#define MMC_RSP_R5	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
#define MMC_RSP_R6	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
#define MMC_RSP_R7	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)

#define mmc_resp_type(cmd)	((cmd)->flags & (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC|MMC_RSP_BUSY|MMC_RSP_OPCODE))

/*
 * These are the SPI response types for MMC, SD, and SDIO cards.
 * Commands return R1, with maybe more info.  Zero is an error type;
 * callers must always provide the appropriate MMC_RSP_SPI_Rx flags.
 */
#define MMC_RSP_SPI_R1	(MMC_RSP_SPI_S1)
#define MMC_RSP_SPI_R1B	(MMC_RSP_SPI_S1|MMC_RSP_SPI_BUSY)
#define MMC_RSP_SPI_R2	(MMC_RSP_SPI_S1|MMC_RSP_SPI_S2)
#define MMC_RSP_SPI_R3	(MMC_RSP_SPI_S1|MMC_RSP_SPI_B4)
#define MMC_RSP_SPI_R4	(MMC_RSP_SPI_S1|MMC_RSP_SPI_B4)
#define MMC_RSP_SPI_R5	(MMC_RSP_SPI_S1|MMC_RSP_SPI_S2)
#define MMC_RSP_SPI_R7	(MMC_RSP_SPI_S1|MMC_RSP_SPI_B4)

#define mmc_spi_resp_type(cmd)	((cmd)->flags & \
		(MMC_RSP_SPI_S1|MMC_RSP_SPI_BUSY|MMC_RSP_SPI_S2|MMC_RSP_SPI_B4))

/*
 * These are the command types.
 */
#define mmc_cmd_type(cmd)	((cmd)->flags & MMC_CMD_MASK)

	unsigned int		retries;	/* max number of retries */
	int			error;		/* command error */

/*
 * Standard errno values are used for errors, but some have specific
 * meaning in the MMC layer:
 *
 * ETIMEDOUT    Card took too long to respond
 * EILSEQ       Basic format problem with the received or sent data
 *              (e.g. CRC check failed, incorrect opcode in response
 *              or bad end bit)
 * EINVAL       Request cannot be performed because of restrictions
 *              in hardware and/or the driver
 * ENOMEDIUM    Host can determine that the slot is empty and is
 *              actively failing requests
 */

	unsigned int		busy_timeout;	/* busy detect timeout in ms */
	/* Set this flag only for blocking sanitize request */
	bool			sanitize_busy;

	struct mmc_data		*data;		/* data segment associated with cmd */
	struct mmc_request	*mrq;		/* associated request */
};

struct mmc_data {
	unsigned int		timeout_ns;	/* data timeout (in ns, max 80ms) */
	unsigned int		timeout_clks;	/* data timeout (in clocks) */
	unsigned int		blksz;		/* data block size */
	unsigned int		blocks;		/* number of blocks */
	int			error;		/* data error */
	unsigned int		flags;

#define MMC_DATA_WRITE	(1 << 8)
#define MMC_DATA_READ	(1 << 9)

	unsigned int		bytes_xfered;

	struct mmc_command	*stop;		/* stop command */
	struct mmc_request	*mrq;		/* associated request */

	unsigned int		sg_len;		/* size of scatter list */
	int			sg_count;	/* mapped sg entries */
	struct scatterlist	*sg;		/* I/O scatter list */
	s32			host_cookie;	/* host private data */
};

struct mmc_host;
struct mmc_request {
	struct mmc_command	*sbc;		/* SET_BLOCK_COUNT for multiblock */
	struct mmc_command	*cmd;
	struct mmc_data		*data;
	struct mmc_command	*stop;

	struct completion	completion;
	struct completion	cmd_completion;
	void			(*done)(struct mmc_request *);/* completion function */
	struct mmc_host		*host;

	/* Allow other commands during this ongoing data transfer or busy wait */
	bool			cap_cmd_during_tfr;
};

struct mmc_card;
struct mmc_async_req;

extern int mmc_stop_bkops(struct mmc_card *);
extern int mmc_read_bkops_status(struct mmc_card *);
extern struct mmc_async_req *mmc_start_req(struct mmc_host *,
					   struct mmc_async_req *, int *);
extern int mmc_interrupt_hpi(struct mmc_card *);
extern void mmc_wait_for_req(struct mmc_host *, struct mmc_request *);
extern void mmc_wait_for_req_done(struct mmc_host *host,
				  struct mmc_request *mrq);
extern bool mmc_is_req_done(struct mmc_host *host, struct mmc_request *mrq);
extern int mmc_wait_for_cmd(struct mmc_host *, struct mmc_command *, int);
extern int mmc_app_cmd(struct mmc_host *, struct mmc_card *);
extern int mmc_wait_for_app_cmd(struct mmc_host *, struct mmc_card *,
	struct mmc_command *, int);
extern void mmc_start_bkops(struct mmc_card *card, bool from_exception);
extern int mmc_switch(struct mmc_card *, u8, u8, u8, unsigned int);
extern int mmc_send_tuning(struct mmc_host *host, u32 opcode, int *cmd_error);
extern int mmc_get_ext_csd(struct mmc_card *card, u8 **new_ext_csd);

#define MMC_ERASE_ARG		0x00000000
#define MMC_SECURE_ERASE_ARG	0x80000000
#define MMC_TRIM_ARG		0x00000001
#define MMC_DISCARD_ARG		0x00000003
#define MMC_SECURE_TRIM1_ARG	0x80000001
#define MMC_SECURE_TRIM2_ARG	0x80008000

#define MMC_SECURE_ARGS		0x80000000
#define MMC_TRIM_ARGS		0x00008001

extern int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr,
		     unsigned int arg);
extern int mmc_can_erase(struct mmc_card *card);
extern int mmc_can_trim(struct mmc_card *card);
extern int mmc_can_discard(struct mmc_card *card);
extern int mmc_can_sanitize(struct mmc_card *card);
extern int mmc_can_secure_erase_trim(struct mmc_card *card);
extern int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from,
				   unsigned int nr);
extern unsigned int mmc_calc_max_discard(struct mmc_card *card);

extern int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen);
extern int mmc_set_blockcount(struct mmc_card *card, unsigned int blockcount,
			      bool is_rel_write);
extern int mmc_hw_reset(struct mmc_host *host);
extern int mmc_can_reset(struct mmc_card *card);

extern void mmc_set_data_timeout(struct mmc_data *, const struct mmc_card *);
extern unsigned int mmc_align_data_size(struct mmc_card *, unsigned int);

extern int __mmc_claim_host(struct mmc_host *host, atomic_t *abort);
extern void mmc_release_host(struct mmc_host *host);

extern void mmc_get_card(struct mmc_card *card);
extern void mmc_put_card(struct mmc_card *card);

extern int mmc_flush_cache(struct mmc_card *);

extern int mmc_detect_card_removed(struct mmc_host *host);

/**
 *	mmc_claim_host - exclusively claim a host
 *	@host: mmc host to claim
 *
 *	Claim a host for a set of operations.
 */
static inline void mmc_claim_host(struct mmc_host *host)
{
	__mmc_claim_host(host, NULL);
}

struct device_node;
extern u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max);
extern int mmc_of_parse_voltage(struct device_node *np, u32 *mask);

#endif /* LINUX_MMC_CORE_H */
Commit	Line	Data
1da177e4	1	/*
aaac1b47	2	* linux/include/linux/mmc/core.h
1da177e4 LT	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	*/
aaac1b47 PO	8	#ifndef LINUX_MMC_CORE_H
aaac1b47 PO	9	#define LINUX_MMC_CORE_H
1da177e4	10
1da177e4	11	#include <linux/interrupt.h>
313162d0	12	#include <linux/completion.h>
1da177e4 LT	13
	14	struct request;
	15	struct mmc_data;
	16	struct mmc_request;
	17
	18	struct mmc_command {
	19	u32 opcode;
	20	u32 arg;
ce39f9d1 SJ	21	#define MMC_CMD23_ARG_REL_WR (1 << 31)
	22	#define MMC_CMD23_ARG_PACKED ((0 << 31) \| (1 << 30))
	23	#define MMC_CMD23_ARG_TAG_REQ (1 << 29)
1da177e4 LT	24	u32 resp[4];
1da177e4 LT	25	unsigned int flags; /* expected response type */
e9225176 RK	26	#define MMC_RSP_PRESENT (1 << 0)
	27	#define MMC_RSP_136 (1 << 1) /* 136 bit response */
	28	#define MMC_RSP_CRC (1 << 2) /* expect valid crc */
	29	#define MMC_RSP_BUSY (1 << 3) /* card may send busy */
	30	#define MMC_RSP_OPCODE (1 << 4) /* response contains opcode */
97018580 DB	31
97018580 DB	32	#define MMC_CMD_MASK (3 << 5) /* non-SPI command type */
e9225176 RK	33	#define MMC_CMD_AC (0 << 5)
	34	#define MMC_CMD_ADTC (1 << 5)
	35	#define MMC_CMD_BC (2 << 5)
	36	#define MMC_CMD_BCR (3 << 5)
1da177e4	37
97018580 DB	38	#define MMC_RSP_SPI_S1 (1 << 7) /* one status byte */
	39	#define MMC_RSP_SPI_S2 (1 << 8) /* second byte */
	40	#define MMC_RSP_SPI_B4 (1 << 9) /* four data bytes */
	41	#define MMC_RSP_SPI_BUSY (1 << 10) /* card may send busy */
	42
1da177e4	43	/*
97018580	44	* These are the native response types, and correspond to valid bit
1da177e4 LT	45	* patterns of the above flags. One additional valid pattern
	46	* is all zeros, which means we don't expect a response.
	47	*/
e9225176 RK	48	#define MMC_RSP_NONE (0)
	49	#define MMC_RSP_R1 (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE)
	50	#define MMC_RSP_R1B (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE\|MMC_RSP_BUSY)
	51	#define MMC_RSP_R2 (MMC_RSP_PRESENT\|MMC_RSP_136\|MMC_RSP_CRC)
	52	#define MMC_RSP_R3 (MMC_RSP_PRESENT)
5c4e6f13	53	#define MMC_RSP_R4 (MMC_RSP_PRESENT)
b2bcc798	54	#define MMC_RSP_R5 (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE)
6f949909	55	#define MMC_RSP_R6 (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE)
fba68bd2	56	#define MMC_RSP_R7 (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE)
e9225176 RK	57
	58	#define mmc_resp_type(cmd) ((cmd)->flags & (MMC_RSP_PRESENT\|MMC_RSP_136\|MMC_RSP_CRC\|MMC_RSP_BUSY\|MMC_RSP_OPCODE))
	59
97018580 DB	60	/*
	61	* These are the SPI response types for MMC, SD, and SDIO cards.
	62	* Commands return R1, with maybe more info. Zero is an error type;
	63	* callers must always provide the appropriate MMC_RSP_SPI_Rx flags.
	64	*/
	65	#define MMC_RSP_SPI_R1 (MMC_RSP_SPI_S1)
	66	#define MMC_RSP_SPI_R1B (MMC_RSP_SPI_S1\|MMC_RSP_SPI_BUSY)
	67	#define MMC_RSP_SPI_R2 (MMC_RSP_SPI_S1\|MMC_RSP_SPI_S2)
	68	#define MMC_RSP_SPI_R3 (MMC_RSP_SPI_S1\|MMC_RSP_SPI_B4)
	69	#define MMC_RSP_SPI_R4 (MMC_RSP_SPI_S1\|MMC_RSP_SPI_B4)
	70	#define MMC_RSP_SPI_R5 (MMC_RSP_SPI_S1\|MMC_RSP_SPI_S2)
	71	#define MMC_RSP_SPI_R7 (MMC_RSP_SPI_S1\|MMC_RSP_SPI_B4)
	72
	73	#define mmc_spi_resp_type(cmd) ((cmd)->flags & \
	74	(MMC_RSP_SPI_S1\|MMC_RSP_SPI_BUSY\|MMC_RSP_SPI_S2\|MMC_RSP_SPI_B4))
	75
e9225176 RK	76	/*
	77	* These are the command types.
	78	*/
5bd546aa	79	#define mmc_cmd_type(cmd) ((cmd)->flags & MMC_CMD_MASK)
1da177e4 LT	80
1da177e4 LT	81	unsigned int retries; /* max number of retries */
f5c5179b	82	int error; /* command error */
1da177e4	83
17b0429d PO	84	/*
	85	* Standard errno values are used for errors, but some have specific
	86	* meaning in the MMC layer:
	87	*
	88	* ETIMEDOUT Card took too long to respond
	89	* EILSEQ Basic format problem with the received or sent data
	90	* (e.g. CRC check failed, incorrect opcode in response
	91	* or bad end bit)
	92	* EINVAL Request cannot be performed because of restrictions
	93	* in hardware and/or the driver
	94	* ENOMEDIUM Host can determine that the slot is empty and is
	95	* actively failing requests
	96	*/
1da177e4	97
1d4d7744	98	unsigned int busy_timeout; /* busy detect timeout in ms */
775a9362 ME	99	/* Set this flag only for blocking sanitize request */
775a9362 ME	100	bool sanitize_busy;
dfe86cba	101
1da177e4	102	struct mmc_data data; / data segment associated with cmd */
8573b80f	103	struct mmc_request mrq; / associated request */
1da177e4 LT	104	};
	105
	106	struct mmc_data {
	107	unsigned int timeout_ns; /* data timeout (in ns, max 80ms) */
	108	unsigned int timeout_clks; /* data timeout (in clocks) */
2c171bf1	109	unsigned int blksz; /* data block size */
1da177e4	110	unsigned int blocks; /* number of blocks */
f5c5179b	111	int error; /* data error */
1da177e4 LT	112	unsigned int flags;
	113
	114	#define MMC_DATA_WRITE (1 << 8)
	115	#define MMC_DATA_READ (1 << 9)
1da177e4 LT	116
	117	unsigned int bytes_xfered;
	118
	119	struct mmc_command stop; / stop command */
8573b80f	120	struct mmc_request mrq; / associated request */
1da177e4 LT	121
1da177e4 LT	122	unsigned int sg_len; /* size of scatter list */
20848903	123	int sg_count; /* mapped sg entries */
1da177e4	124	struct scatterlist sg; / I/O scatter list */
aa8b683a	125	s32 host_cookie; /* host private data */
1da177e4 LT	126	};
1da177e4 LT	127
2220eedf	128	struct mmc_host;
1da177e4	129	struct mmc_request {
d0c97cfb	130	struct mmc_command sbc; / SET_BLOCK_COUNT for multiblock */
1da177e4 LT	131	struct mmc_command *cmd;
	132	struct mmc_data *data;
	133	struct mmc_command *stop;
	134
aa8b683a	135	struct completion completion;
30137903	136	struct completion cmd_completion;
1da177e4	137	void (done)(struct mmc_request );/* completion function */
2220eedf	138	struct mmc_host *host;
30137903 AH	139
	140	/* Allow other commands during this ongoing data transfer or busy wait */
	141	bool cap_cmd_during_tfr;
1da177e4 LT	142	};
1da177e4 LT	143
1da177e4	144	struct mmc_card;
aa8b683a	145	struct mmc_async_req;
1da177e4	146
950d56ac JC	147	extern int mmc_stop_bkops(struct mmc_card *);
950d56ac JC	148	extern int mmc_read_bkops_status(struct mmc_card *);
aa8b683a PF	149	extern struct mmc_async_req mmc_start_req(struct mmc_host ,
aa8b683a PF	150	struct mmc_async_req , int );
eb0d8f13	151	extern int mmc_interrupt_hpi(struct mmc_card *);
67a61c48	152	extern void mmc_wait_for_req(struct mmc_host , struct mmc_request );
30137903 AH	153	extern void mmc_wait_for_req_done(struct mmc_host *host,
	154	struct mmc_request *mrq);
	155	extern bool mmc_is_req_done(struct mmc_host host, struct mmc_request mrq);
1da177e4	156	extern int mmc_wait_for_cmd(struct mmc_host , struct mmc_command , int);
cb87ea28	157	extern int mmc_app_cmd(struct mmc_host , struct mmc_card );
da7fbe58	158	extern int mmc_wait_for_app_cmd(struct mmc_host , struct mmc_card ,
335eadf2	159	struct mmc_command *, int);
950d56ac	160	extern void mmc_start_bkops(struct mmc_card *card, bool from_exception);
d3a8d95d	161	extern int mmc_switch(struct mmc_card *, u8, u8, u8, unsigned int);
9979dbe5	162	extern int mmc_send_tuning(struct mmc_host host, u32 opcode, int cmd_error);
e21aa519	163	extern int mmc_get_ext_csd(struct mmc_card card, u8 *new_ext_csd);
1da177e4	164
dfe86cba AH	165	#define MMC_ERASE_ARG 0x00000000
	166	#define MMC_SECURE_ERASE_ARG 0x80000000
	167	#define MMC_TRIM_ARG 0x00000001
b3bf9153	168	#define MMC_DISCARD_ARG 0x00000003
dfe86cba AH	169	#define MMC_SECURE_TRIM1_ARG 0x80000001
	170	#define MMC_SECURE_TRIM2_ARG 0x80008000
	171
	172	#define MMC_SECURE_ARGS 0x80000000
	173	#define MMC_TRIM_ARGS 0x00008001
	174
	175	extern int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr,
	176	unsigned int arg);
	177	extern int mmc_can_erase(struct mmc_card *card);
	178	extern int mmc_can_trim(struct mmc_card *card);
b3bf9153	179	extern int mmc_can_discard(struct mmc_card *card);
d9ddd629	180	extern int mmc_can_sanitize(struct mmc_card *card);
dfe86cba AH	181	extern int mmc_can_secure_erase_trim(struct mmc_card *card);
	182	extern int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from,
	183	unsigned int nr);
e056a1b5	184	extern unsigned int mmc_calc_max_discard(struct mmc_card *card);
dfe86cba	185
0f8d8ea6	186	extern int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen);
67c79db8 LP	187	extern int mmc_set_blockcount(struct mmc_card *card, unsigned int blockcount,
67c79db8 LP	188	bool is_rel_write);
b2499518	189	extern int mmc_hw_reset(struct mmc_host *host);
b2499518	190	extern int mmc_can_reset(struct mmc_card *card);
0f8d8ea6	191
b146d26a	192	extern void mmc_set_data_timeout(struct mmc_data , const struct mmc_card );
ad3868b2	193	extern unsigned int mmc_align_data_size(struct mmc_card *, unsigned int);
d773d725	194
2342f332	195	extern int __mmc_claim_host(struct mmc_host host, atomic_t abort);
1da177e4 LT	196	extern void mmc_release_host(struct mmc_host *host);
1da177e4 LT	197
e94cfef6 UH	198	extern void mmc_get_card(struct mmc_card *card);
	199	extern void mmc_put_card(struct mmc_card *card);
	200
881d1c25 SJ	201	extern int mmc_flush_cache(struct mmc_card *);
881d1c25 SJ	202
d3049504 AH	203	extern int mmc_detect_card_removed(struct mmc_host *host);
d3049504 AH	204
2342f332 NP	205	/**
	206	* mmc_claim_host - exclusively claim a host
	207	* @host: mmc host to claim
	208	*
	209	* Claim a host for a set of operations.
	210	*/
	211	static inline void mmc_claim_host(struct mmc_host *host)
	212	{
	213	__mmc_claim_host(host, NULL);
	214	}
	215
6e9e318b	216	struct device_node;
86e8286a	217	extern u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max);
6e9e318b	218	extern int mmc_of_parse_voltage(struct device_node np, u32 mask);
86e8286a	219
100e9186	220	#endif /* LINUX_MMC_CORE_H */