xref: /linux-6.15/include/linux/mmc/core.h (revision eb2bce7f)
1 /*
2  *  linux/include/linux/mmc/core.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 #ifndef LINUX_MMC_CORE_H
9 #define LINUX_MMC_CORE_H
10 
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 */
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 */
28 #define MMC_CMD_MASK	(3 << 5)		/* command type */
29 #define MMC_CMD_AC	(0 << 5)
30 #define MMC_CMD_ADTC	(1 << 5)
31 #define MMC_CMD_BC	(2 << 5)
32 #define MMC_CMD_BCR	(3 << 5)
33 
34 /*
35  * These are the response types, and correspond to valid bit
36  * patterns of the above flags.  One additional valid pattern
37  * is all zeros, which means we don't expect a response.
38  */
39 #define MMC_RSP_NONE	(0)
40 #define MMC_RSP_R1	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
41 #define MMC_RSP_R1B	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE|MMC_RSP_BUSY)
42 #define MMC_RSP_R2	(MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC)
43 #define MMC_RSP_R3	(MMC_RSP_PRESENT)
44 #define MMC_RSP_R6	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
45 #define MMC_RSP_R7	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
46 
47 #define mmc_resp_type(cmd)	((cmd)->flags & (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC|MMC_RSP_BUSY|MMC_RSP_OPCODE))
48 
49 /*
50  * These are the command types.
51  */
52 #define mmc_cmd_type(cmd)	((cmd)->flags & MMC_CMD_MASK)
53 
54 	unsigned int		retries;	/* max number of retries */
55 	unsigned int		error;		/* command error */
56 
57 #define MMC_ERR_NONE	0
58 #define MMC_ERR_TIMEOUT	1
59 #define MMC_ERR_BADCRC	2
60 #define MMC_ERR_FIFO	3
61 #define MMC_ERR_FAILED	4
62 #define MMC_ERR_INVALID	5
63 
64 	struct mmc_data		*data;		/* data segment associated with cmd */
65 	struct mmc_request	*mrq;		/* associated request */
66 };
67 
68 struct mmc_data {
69 	unsigned int		timeout_ns;	/* data timeout (in ns, max 80ms) */
70 	unsigned int		timeout_clks;	/* data timeout (in clocks) */
71 	unsigned int		blksz;		/* data block size */
72 	unsigned int		blocks;		/* number of blocks */
73 	unsigned int		error;		/* data error */
74 	unsigned int		flags;
75 
76 #define MMC_DATA_WRITE	(1 << 8)
77 #define MMC_DATA_READ	(1 << 9)
78 #define MMC_DATA_STREAM	(1 << 10)
79 #define MMC_DATA_MULTI	(1 << 11)
80 
81 	unsigned int		bytes_xfered;
82 
83 	struct mmc_command	*stop;		/* stop command */
84 	struct mmc_request	*mrq;		/* associated request */
85 
86 	unsigned int		sg_len;		/* size of scatter list */
87 	struct scatterlist	*sg;		/* I/O scatter list */
88 };
89 
90 struct mmc_request {
91 	struct mmc_command	*cmd;
92 	struct mmc_data		*data;
93 	struct mmc_command	*stop;
94 
95 	void			*done_data;	/* completion data */
96 	void			(*done)(struct mmc_request *);/* completion function */
97 };
98 
99 struct mmc_host;
100 struct mmc_card;
101 
102 extern int mmc_wait_for_req(struct mmc_host *, struct mmc_request *);
103 extern int mmc_wait_for_cmd(struct mmc_host *, struct mmc_command *, int);
104 extern int mmc_wait_for_app_cmd(struct mmc_host *, struct mmc_card *,
105 	struct mmc_command *, int);
106 
107 extern void mmc_set_data_timeout(struct mmc_data *, const struct mmc_card *, int);
108 
109 extern void mmc_claim_host(struct mmc_host *host);
110 extern void mmc_release_host(struct mmc_host *host);
111 
112 #endif
113