[mirror_ubuntu-artful-kernel.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/completion.h>
#include <linux/types.h>

struct mmc_data;
struct mmc_request;

enum mmc_blk_status {
	MMC_BLK_SUCCESS = 0,
	MMC_BLK_PARTIAL,
	MMC_BLK_CMD_ERR,
	MMC_BLK_RETRY,
	MMC_BLK_ABORT,
	MMC_BLK_DATA_ERR,
	MMC_BLK_ECC_ERR,
	MMC_BLK_NOMEDIUM,
	MMC_BLK_NEW_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)

/* Can be used by core to poll after switch to MMC HS mode */
#define MMC_RSP_R1_NO_CRC	(MMC_RSP_PRESENT|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;

struct mmc_async_req *mmc_start_areq(struct mmc_host *host,
				struct mmc_async_req *areq,
				enum mmc_blk_status *ret_stat);
void mmc_wait_for_req(struct mmc_host *host, struct mmc_request *mrq);
int mmc_wait_for_cmd(struct mmc_host *host, struct mmc_command *cmd,
		int retries);

int mmc_hw_reset(struct mmc_host *host);
void mmc_set_data_timeout(struct mmc_data *data, const struct mmc_card *card);

#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
313162d0	11	#include <linux/completion.h>
8da00734	12	#include <linux/types.h>
1da177e4	13
1da177e4 LT	14	struct mmc_data;
	15	struct mmc_request;
	16
8e8b3f51 LW	17	enum mmc_blk_status {
	18	MMC_BLK_SUCCESS = 0,
	19	MMC_BLK_PARTIAL,
	20	MMC_BLK_CMD_ERR,
	21	MMC_BLK_RETRY,
	22	MMC_BLK_ABORT,
	23	MMC_BLK_DATA_ERR,
	24	MMC_BLK_ECC_ERR,
	25	MMC_BLK_NOMEDIUM,
	26	MMC_BLK_NEW_REQUEST,
	27	};
	28
1da177e4 LT	29	struct mmc_command {
	30	u32 opcode;
	31	u32 arg;
ce39f9d1 SJ	32	#define MMC_CMD23_ARG_REL_WR (1 << 31)
	33	#define MMC_CMD23_ARG_PACKED ((0 << 31) \| (1 << 30))
	34	#define MMC_CMD23_ARG_TAG_REQ (1 << 29)
1da177e4 LT	35	u32 resp[4];
1da177e4 LT	36	unsigned int flags; /* expected response type */
e9225176 RK	37	#define MMC_RSP_PRESENT (1 << 0)
	38	#define MMC_RSP_136 (1 << 1) /* 136 bit response */
	39	#define MMC_RSP_CRC (1 << 2) /* expect valid crc */
	40	#define MMC_RSP_BUSY (1 << 3) /* card may send busy */
	41	#define MMC_RSP_OPCODE (1 << 4) /* response contains opcode */
97018580 DB	42
97018580 DB	43	#define MMC_CMD_MASK (3 << 5) /* non-SPI command type */
e9225176 RK	44	#define MMC_CMD_AC (0 << 5)
	45	#define MMC_CMD_ADTC (1 << 5)
	46	#define MMC_CMD_BC (2 << 5)
	47	#define MMC_CMD_BCR (3 << 5)
1da177e4	48
97018580 DB	49	#define MMC_RSP_SPI_S1 (1 << 7) /* one status byte */
	50	#define MMC_RSP_SPI_S2 (1 << 8) /* second byte */
	51	#define MMC_RSP_SPI_B4 (1 << 9) /* four data bytes */
	52	#define MMC_RSP_SPI_BUSY (1 << 10) /* card may send busy */
	53
1da177e4	54	/*
97018580	55	* These are the native response types, and correspond to valid bit
1da177e4 LT	56	* patterns of the above flags. One additional valid pattern
	57	* is all zeros, which means we don't expect a response.
	58	*/
e9225176 RK	59	#define MMC_RSP_NONE (0)
	60	#define MMC_RSP_R1 (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE)
	61	#define MMC_RSP_R1B (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE\|MMC_RSP_BUSY)
	62	#define MMC_RSP_R2 (MMC_RSP_PRESENT\|MMC_RSP_136\|MMC_RSP_CRC)
	63	#define MMC_RSP_R3 (MMC_RSP_PRESENT)
5c4e6f13	64	#define MMC_RSP_R4 (MMC_RSP_PRESENT)
b2bcc798	65	#define MMC_RSP_R5 (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE)
6f949909	66	#define MMC_RSP_R6 (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE)
fba68bd2	67	#define MMC_RSP_R7 (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE)
e9225176	68
51b50c96 WS	69	/* Can be used by core to poll after switch to MMC HS mode */
	70	#define MMC_RSP_R1_NO_CRC (MMC_RSP_PRESENT\|MMC_RSP_OPCODE)
	71
e9225176 RK	72	#define mmc_resp_type(cmd) ((cmd)->flags & (MMC_RSP_PRESENT\|MMC_RSP_136\|MMC_RSP_CRC\|MMC_RSP_BUSY\|MMC_RSP_OPCODE))
e9225176 RK	73
97018580 DB	74	/*
	75	* These are the SPI response types for MMC, SD, and SDIO cards.
	76	* Commands return R1, with maybe more info. Zero is an error type;
	77	* callers must always provide the appropriate MMC_RSP_SPI_Rx flags.
	78	*/
	79	#define MMC_RSP_SPI_R1 (MMC_RSP_SPI_S1)
	80	#define MMC_RSP_SPI_R1B (MMC_RSP_SPI_S1\|MMC_RSP_SPI_BUSY)
	81	#define MMC_RSP_SPI_R2 (MMC_RSP_SPI_S1\|MMC_RSP_SPI_S2)
	82	#define MMC_RSP_SPI_R3 (MMC_RSP_SPI_S1\|MMC_RSP_SPI_B4)
	83	#define MMC_RSP_SPI_R4 (MMC_RSP_SPI_S1\|MMC_RSP_SPI_B4)
	84	#define MMC_RSP_SPI_R5 (MMC_RSP_SPI_S1\|MMC_RSP_SPI_S2)
	85	#define MMC_RSP_SPI_R7 (MMC_RSP_SPI_S1\|MMC_RSP_SPI_B4)
	86
	87	#define mmc_spi_resp_type(cmd) ((cmd)->flags & \
	88	(MMC_RSP_SPI_S1\|MMC_RSP_SPI_BUSY\|MMC_RSP_SPI_S2\|MMC_RSP_SPI_B4))
	89
e9225176 RK	90	/*
	91	* These are the command types.
	92	*/
5bd546aa	93	#define mmc_cmd_type(cmd) ((cmd)->flags & MMC_CMD_MASK)
1da177e4 LT	94
1da177e4 LT	95	unsigned int retries; /* max number of retries */
f5c5179b	96	int error; /* command error */
1da177e4	97
17b0429d PO	98	/*
	99	* Standard errno values are used for errors, but some have specific
	100	* meaning in the MMC layer:
	101	*
	102	* ETIMEDOUT Card took too long to respond
	103	* EILSEQ Basic format problem with the received or sent data
	104	* (e.g. CRC check failed, incorrect opcode in response
	105	* or bad end bit)
	106	* EINVAL Request cannot be performed because of restrictions
	107	* in hardware and/or the driver
	108	* ENOMEDIUM Host can determine that the slot is empty and is
	109	* actively failing requests
	110	*/
1da177e4	111
1d4d7744	112	unsigned int busy_timeout; /* busy detect timeout in ms */
775a9362 ME	113	/* Set this flag only for blocking sanitize request */
775a9362 ME	114	bool sanitize_busy;
dfe86cba	115
1da177e4	116	struct mmc_data data; / data segment associated with cmd */
8573b80f	117	struct mmc_request mrq; / associated request */
1da177e4 LT	118	};
	119
	120	struct mmc_data {
	121	unsigned int timeout_ns; /* data timeout (in ns, max 80ms) */
	122	unsigned int timeout_clks; /* data timeout (in clocks) */
2c171bf1	123	unsigned int blksz; /* data block size */
1da177e4	124	unsigned int blocks; /* number of blocks */
f5c5179b	125	int error; /* data error */
1da177e4 LT	126	unsigned int flags;
	127
	128	#define MMC_DATA_WRITE (1 << 8)
	129	#define MMC_DATA_READ (1 << 9)
1da177e4 LT	130
	131	unsigned int bytes_xfered;
	132
	133	struct mmc_command stop; / stop command */
8573b80f	134	struct mmc_request mrq; / associated request */
1da177e4 LT	135
1da177e4 LT	136	unsigned int sg_len; /* size of scatter list */
20848903	137	int sg_count; /* mapped sg entries */
1da177e4	138	struct scatterlist sg; / I/O scatter list */
aa8b683a	139	s32 host_cookie; /* host private data */
1da177e4 LT	140	};
1da177e4 LT	141
2220eedf	142	struct mmc_host;
1da177e4	143	struct mmc_request {
d0c97cfb	144	struct mmc_command sbc; / SET_BLOCK_COUNT for multiblock */
1da177e4 LT	145	struct mmc_command *cmd;
	146	struct mmc_data *data;
	147	struct mmc_command *stop;
	148
aa8b683a	149	struct completion completion;
5163af5a	150	struct completion cmd_completion;
1da177e4	151	void (done)(struct mmc_request );/* completion function */
2220eedf	152	struct mmc_host *host;
5163af5a AH	153
	154	/* Allow other commands during this ongoing data transfer or busy wait */
	155	bool cap_cmd_during_tfr;
1da177e4 LT	156	};
1da177e4 LT	157
1da177e4	158	struct mmc_card;
aa8b683a	159	struct mmc_async_req;
1da177e4	160
c3399ef5	161	struct mmc_async_req mmc_start_areq(struct mmc_host host,
23888bfe UH	162	struct mmc_async_req *areq,
	163	enum mmc_blk_status *ret_stat);
	164	void mmc_wait_for_req(struct mmc_host host, struct mmc_request mrq);
	165	int mmc_wait_for_cmd(struct mmc_host host, struct mmc_command cmd,
	166	int retries);
	167
	168	int mmc_hw_reset(struct mmc_host *host);
	169	void mmc_set_data_timeout(struct mmc_data data, const struct mmc_card card);
2342f332	170
100e9186	171	#endif /* LINUX_MMC_CORE_H */