xref: /linux-6.15/include/linux/mmc/mmc.h (revision 87c2ce3b)
1 /*
2  *  linux/include/linux/mmc/mmc.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 MMC_H
9 #define MMC_H
10 
11 #include <linux/list.h>
12 #include <linux/interrupt.h>
13 #include <linux/device.h>
14 
15 struct request;
16 struct mmc_data;
17 struct mmc_request;
18 
19 struct mmc_command {
20 	u32			opcode;
21 	u32			arg;
22 	u32			resp[4];
23 	unsigned int		flags;		/* expected response type */
24 #define MMC_RSP_NONE	(0 << 0)
25 #define MMC_RSP_SHORT	(1 << 0)
26 #define MMC_RSP_LONG	(2 << 0)
27 #define MMC_RSP_MASK	(3 << 0)
28 #define MMC_RSP_CRC	(1 << 3)		/* expect valid crc */
29 #define MMC_RSP_BUSY	(1 << 4)		/* card may send busy */
30 #define MMC_RSP_OPCODE	(1 << 5)		/* response contains opcode */
31 
32 /*
33  * These are the response types, and correspond to valid bit
34  * patterns of the above flags.  One additional valid pattern
35  * is all zeros, which means we don't expect a response.
36  */
37 #define MMC_RSP_R1	(MMC_RSP_SHORT|MMC_RSP_CRC|MMC_RSP_OPCODE)
38 #define MMC_RSP_R1B	(MMC_RSP_SHORT|MMC_RSP_CRC|MMC_RSP_OPCODE|MMC_RSP_BUSY)
39 #define MMC_RSP_R2	(MMC_RSP_LONG|MMC_RSP_CRC)
40 #define MMC_RSP_R3	(MMC_RSP_SHORT)
41 #define MMC_RSP_R6	(MMC_RSP_SHORT|MMC_RSP_CRC)
42 
43 	unsigned int		retries;	/* max number of retries */
44 	unsigned int		error;		/* command error */
45 
46 #define MMC_ERR_NONE	0
47 #define MMC_ERR_TIMEOUT	1
48 #define MMC_ERR_BADCRC	2
49 #define MMC_ERR_FIFO	3
50 #define MMC_ERR_FAILED	4
51 #define MMC_ERR_INVALID	5
52 
53 	struct mmc_data		*data;		/* data segment associated with cmd */
54 	struct mmc_request	*mrq;		/* associated request */
55 };
56 
57 struct mmc_data {
58 	unsigned int		timeout_ns;	/* data timeout (in ns, max 80ms) */
59 	unsigned int		timeout_clks;	/* data timeout (in clocks) */
60 	unsigned int		blksz_bits;	/* data block size */
61 	unsigned int		blocks;		/* number of blocks */
62 	unsigned int		error;		/* data error */
63 	unsigned int		flags;
64 
65 #define MMC_DATA_WRITE	(1 << 8)
66 #define MMC_DATA_READ	(1 << 9)
67 #define MMC_DATA_STREAM	(1 << 10)
68 #define MMC_DATA_MULTI	(1 << 11)
69 
70 	unsigned int		bytes_xfered;
71 
72 	struct mmc_command	*stop;		/* stop command */
73 	struct mmc_request	*mrq;		/* associated request */
74 
75 	unsigned int		sg_len;		/* size of scatter list */
76 	struct scatterlist	*sg;		/* I/O scatter list */
77 };
78 
79 struct mmc_request {
80 	struct mmc_command	*cmd;
81 	struct mmc_data		*data;
82 	struct mmc_command	*stop;
83 
84 	void			*done_data;	/* completion data */
85 	void			(*done)(struct mmc_request *);/* completion function */
86 };
87 
88 struct mmc_host;
89 struct mmc_card;
90 
91 extern int mmc_wait_for_req(struct mmc_host *, struct mmc_request *);
92 extern int mmc_wait_for_cmd(struct mmc_host *, struct mmc_command *, int);
93 extern int mmc_wait_for_app_cmd(struct mmc_host *, unsigned int,
94 	struct mmc_command *, int);
95 
96 extern int __mmc_claim_host(struct mmc_host *host, struct mmc_card *card);
97 
98 static inline void mmc_claim_host(struct mmc_host *host)
99 {
100 	__mmc_claim_host(host, (struct mmc_card *)-1);
101 }
102 
103 extern void mmc_release_host(struct mmc_host *host);
104 
105 #endif
106