[net-next-2.6.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/device.h>

struct request;
struct mmc_data;
struct mmc_request;

struct mmc_command {
	u32			opcode;
	u32			arg;
	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 */
	unsigned 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		erase_timeout;	/* in milliseconds */

	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 */
	unsigned int		error;		/* data error */
	unsigned int		flags;

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

	unsigned int		bytes_xfered;

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

	unsigned int		sg_len;		/* size of scatter list */
	struct scatterlist	*sg;		/* I/O scatter list */
};

struct mmc_request {
	struct mmc_command	*cmd;
	struct mmc_data		*data;
	struct mmc_command	*stop;

	void			*done_data;	/* completion data */
	void			(*done)(struct mmc_request *);/* completion function */
};

struct mmc_host;
struct mmc_card;

extern void mmc_wait_for_req(struct mmc_host *, struct mmc_request *);
extern int mmc_wait_for_cmd(struct mmc_host *, struct mmc_command *, int);
extern int mmc_wait_for_app_cmd(struct mmc_host *, struct mmc_card *,
	struct mmc_command *, int);

#define MMC_ERASE_ARG		0x00000000
#define MMC_SECURE_ERASE_ARG	0x80000000
#define MMC_TRIM_ARG		0x00000001
#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_secure_erase_trim(struct mmc_card *card);
extern int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from,
				   unsigned int nr);

extern int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen);

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 int mmc_try_claim_host(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);
}

extern u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max);

#endif
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 LT	11	#include <linux/interrupt.h>
	12	#include <linux/device.h>
	13
	14	struct request;
	15	struct mmc_data;
	16	struct mmc_request;
	17
	18	struct mmc_command {
	19	u32 opcode;
	20	u32 arg;
	21	u32 resp[4];
	22	unsigned int flags; /* expected response type */
e9225176 RK	23	#define MMC_RSP_PRESENT (1 << 0)
	24	#define MMC_RSP_136 (1 << 1) /* 136 bit response */
	25	#define MMC_RSP_CRC (1 << 2) /* expect valid crc */
	26	#define MMC_RSP_BUSY (1 << 3) /* card may send busy */
	27	#define MMC_RSP_OPCODE (1 << 4) /* response contains opcode */
97018580 DB	28
97018580 DB	29	#define MMC_CMD_MASK (3 << 5) /* non-SPI command type */
e9225176 RK	30	#define MMC_CMD_AC (0 << 5)
	31	#define MMC_CMD_ADTC (1 << 5)
	32	#define MMC_CMD_BC (2 << 5)
	33	#define MMC_CMD_BCR (3 << 5)
1da177e4	34
97018580 DB	35	#define MMC_RSP_SPI_S1 (1 << 7) /* one status byte */
	36	#define MMC_RSP_SPI_S2 (1 << 8) /* second byte */
	37	#define MMC_RSP_SPI_B4 (1 << 9) /* four data bytes */
	38	#define MMC_RSP_SPI_BUSY (1 << 10) /* card may send busy */
	39
1da177e4	40	/*
97018580	41	* These are the native response types, and correspond to valid bit
1da177e4 LT	42	* patterns of the above flags. One additional valid pattern
	43	* is all zeros, which means we don't expect a response.
	44	*/
e9225176 RK	45	#define MMC_RSP_NONE (0)
	46	#define MMC_RSP_R1 (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE)
	47	#define MMC_RSP_R1B (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE\|MMC_RSP_BUSY)
	48	#define MMC_RSP_R2 (MMC_RSP_PRESENT\|MMC_RSP_136\|MMC_RSP_CRC)
	49	#define MMC_RSP_R3 (MMC_RSP_PRESENT)
5c4e6f13	50	#define MMC_RSP_R4 (MMC_RSP_PRESENT)
b2bcc798	51	#define MMC_RSP_R5 (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE)
6f949909	52	#define MMC_RSP_R6 (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE)
fba68bd2	53	#define MMC_RSP_R7 (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE)
e9225176 RK	54
	55	#define mmc_resp_type(cmd) ((cmd)->flags & (MMC_RSP_PRESENT\|MMC_RSP_136\|MMC_RSP_CRC\|MMC_RSP_BUSY\|MMC_RSP_OPCODE))
	56
97018580 DB	57	/*
	58	* These are the SPI response types for MMC, SD, and SDIO cards.
	59	* Commands return R1, with maybe more info. Zero is an error type;
	60	* callers must always provide the appropriate MMC_RSP_SPI_Rx flags.
	61	*/
	62	#define MMC_RSP_SPI_R1 (MMC_RSP_SPI_S1)
	63	#define MMC_RSP_SPI_R1B (MMC_RSP_SPI_S1\|MMC_RSP_SPI_BUSY)
	64	#define MMC_RSP_SPI_R2 (MMC_RSP_SPI_S1\|MMC_RSP_SPI_S2)
	65	#define MMC_RSP_SPI_R3 (MMC_RSP_SPI_S1\|MMC_RSP_SPI_B4)
	66	#define MMC_RSP_SPI_R4 (MMC_RSP_SPI_S1\|MMC_RSP_SPI_B4)
	67	#define MMC_RSP_SPI_R5 (MMC_RSP_SPI_S1\|MMC_RSP_SPI_S2)
	68	#define MMC_RSP_SPI_R7 (MMC_RSP_SPI_S1\|MMC_RSP_SPI_B4)
	69
	70	#define mmc_spi_resp_type(cmd) ((cmd)->flags & \
	71	(MMC_RSP_SPI_S1\|MMC_RSP_SPI_BUSY\|MMC_RSP_SPI_S2\|MMC_RSP_SPI_B4))
	72
e9225176 RK	73	/*
	74	* These are the command types.
	75	*/
5bd546aa	76	#define mmc_cmd_type(cmd) ((cmd)->flags & MMC_CMD_MASK)
1da177e4 LT	77
	78	unsigned int retries; /* max number of retries */
	79	unsigned int error; /* command error */
	80
17b0429d PO	81	/*
	82	* Standard errno values are used for errors, but some have specific
	83	* meaning in the MMC layer:
	84	*
	85	* ETIMEDOUT Card took too long to respond
	86	* EILSEQ Basic format problem with the received or sent data
	87	* (e.g. CRC check failed, incorrect opcode in response
	88	* or bad end bit)
	89	* EINVAL Request cannot be performed because of restrictions
	90	* in hardware and/or the driver
	91	* ENOMEDIUM Host can determine that the slot is empty and is
	92	* actively failing requests
	93	*/
1da177e4	94
dfe86cba AH	95	unsigned int erase_timeout; /* in milliseconds */
dfe86cba AH	96
1da177e4	97	struct mmc_data data; / data segment associated with cmd */
8573b80f	98	struct mmc_request mrq; / associated request */
1da177e4 LT	99	};
	100
	101	struct mmc_data {
	102	unsigned int timeout_ns; /* data timeout (in ns, max 80ms) */
	103	unsigned int timeout_clks; /* data timeout (in clocks) */
2c171bf1	104	unsigned int blksz; /* data block size */
1da177e4 LT	105	unsigned int blocks; /* number of blocks */
	106	unsigned int error; /* data error */
	107	unsigned int flags;
	108
	109	#define MMC_DATA_WRITE (1 << 8)
	110	#define MMC_DATA_READ (1 << 9)
	111	#define MMC_DATA_STREAM (1 << 10)
	112
	113	unsigned int bytes_xfered;
	114
	115	struct mmc_command stop; / stop command */
8573b80f	116	struct mmc_request mrq; / associated request */
1da177e4 LT	117
	118	unsigned int sg_len; /* size of scatter list */
	119	struct scatterlist sg; / I/O scatter list */
	120	};
	121
	122	struct mmc_request {
	123	struct mmc_command *cmd;
	124	struct mmc_data *data;
	125	struct mmc_command *stop;
	126
	127	void done_data; / completion data */
	128	void (done)(struct mmc_request );/* completion function */
	129	};
	130
	131	struct mmc_host;
	132	struct mmc_card;
	133
67a61c48	134	extern void mmc_wait_for_req(struct mmc_host , struct mmc_request );
1da177e4	135	extern int mmc_wait_for_cmd(struct mmc_host , struct mmc_command , int);
da7fbe58	136	extern int mmc_wait_for_app_cmd(struct mmc_host , struct mmc_card ,
335eadf2	137	struct mmc_command *, int);
1da177e4	138
dfe86cba AH	139	#define MMC_ERASE_ARG 0x00000000
	140	#define MMC_SECURE_ERASE_ARG 0x80000000
	141	#define MMC_TRIM_ARG 0x00000001
	142	#define MMC_SECURE_TRIM1_ARG 0x80000001
	143	#define MMC_SECURE_TRIM2_ARG 0x80008000
	144
	145	#define MMC_SECURE_ARGS 0x80000000
	146	#define MMC_TRIM_ARGS 0x00008001
	147
	148	extern int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr,
	149	unsigned int arg);
	150	extern int mmc_can_erase(struct mmc_card *card);
	151	extern int mmc_can_trim(struct mmc_card *card);
	152	extern int mmc_can_secure_erase_trim(struct mmc_card *card);
	153	extern int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from,
	154	unsigned int nr);
	155
0f8d8ea6 AH	156	extern int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen);
0f8d8ea6 AH	157
b146d26a	158	extern void mmc_set_data_timeout(struct mmc_data , const struct mmc_card );
ad3868b2	159	extern unsigned int mmc_align_data_size(struct mmc_card *, unsigned int);
d773d725	160
2342f332	161	extern int __mmc_claim_host(struct mmc_host host, atomic_t abort);
1da177e4	162	extern void mmc_release_host(struct mmc_host *host);
319a3f14	163	extern int mmc_try_claim_host(struct mmc_host *host);
1da177e4	164
2342f332 NP	165	/**
	166	* mmc_claim_host - exclusively claim a host
	167	* @host: mmc host to claim
	168	*
	169	* Claim a host for a set of operations.
	170	*/
	171	static inline void mmc_claim_host(struct mmc_host *host)
	172	{
	173	__mmc_claim_host(host, NULL);
	174	}
	175
86e8286a AV	176	extern u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max);
86e8286a AV	177
1da177e4	178	#endif