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/completion.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
29 #define MMC_CMD_MASK (3 << 5) /* non-SPI command type */
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)
34
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
40 /*
41 * These are the native response types, and correspond to valid bit
42 * patterns of the above flags. One additional valid pattern
43 * is all zeros, which means we don't expect a response.
44 */
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)
50 #define MMC_RSP_R4 (MMC_RSP_PRESENT)
51 #define MMC_RSP_R5 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
52 #define MMC_RSP_R6 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
53 #define MMC_RSP_R7 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
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
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
73 /*
74 * These are the command types.
75 */
76 #define mmc_cmd_type(cmd) ((cmd)->flags & MMC_CMD_MASK)
77
78 unsigned int retries; /* max number of retries */
79 unsigned int error; /* command error */
80
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 */
94
95 unsigned int cmd_timeout_ms; /* in milliseconds */
96
97 struct mmc_data *data; /* data segment associated with cmd */
98 struct mmc_request *mrq; /* associated request */
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) */
104 unsigned int blksz; /* data block size */
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 */
116 struct mmc_request *mrq; /* associated request */
117
118 unsigned int sg_len; /* size of scatter list */
119 struct scatterlist *sg; /* I/O scatter list */
120 s32 host_cookie; /* host private data */
121 };
122
123 struct mmc_request {
124 struct mmc_command *sbc; /* SET_BLOCK_COUNT for multiblock */
125 struct mmc_command *cmd;
126 struct mmc_data *data;
127 struct mmc_command *stop;
128
129 struct completion completion;
130 void (*done)(struct mmc_request *);/* completion function */
131 };
132
133 struct mmc_host;
134 struct mmc_card;
135 struct mmc_async_req;
136
137 extern struct mmc_async_req *mmc_start_req(struct mmc_host *,
138 struct mmc_async_req *, int *);
139 extern int mmc_interrupt_hpi(struct mmc_card *);
140 extern void mmc_wait_for_req(struct mmc_host *, struct mmc_request *);
141 extern int mmc_wait_for_cmd(struct mmc_host *, struct mmc_command *, int);
142 extern int mmc_app_cmd(struct mmc_host *, struct mmc_card *);
143 extern int mmc_wait_for_app_cmd(struct mmc_host *, struct mmc_card *,
144 struct mmc_command *, int);
145 extern int mmc_switch(struct mmc_card *, u8, u8, u8, unsigned int);
146
147 #define MMC_ERASE_ARG 0x00000000
148 #define MMC_SECURE_ERASE_ARG 0x80000000
149 #define MMC_TRIM_ARG 0x00000001
150 #define MMC_DISCARD_ARG 0x00000003
151 #define MMC_SECURE_TRIM1_ARG 0x80000001
152 #define MMC_SECURE_TRIM2_ARG 0x80008000
153
154 #define MMC_SECURE_ARGS 0x80000000
155 #define MMC_TRIM_ARGS 0x00008001
156
157 extern int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr,
158 unsigned int arg);
159 extern int mmc_can_erase(struct mmc_card *card);
160 extern int mmc_can_trim(struct mmc_card *card);
161 extern int mmc_can_discard(struct mmc_card *card);
162 extern int mmc_can_sanitize(struct mmc_card *card);
163 extern int mmc_can_secure_erase_trim(struct mmc_card *card);
164 extern int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from,
165 unsigned int nr);
166 extern unsigned int mmc_calc_max_discard(struct mmc_card *card);
167
168 extern int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen);
169 extern int mmc_hw_reset(struct mmc_host *host);
170 extern int mmc_hw_reset_check(struct mmc_host *host);
171 extern int mmc_can_reset(struct mmc_card *card);
172
173 extern void mmc_set_data_timeout(struct mmc_data *, const struct mmc_card *);
174 extern unsigned int mmc_align_data_size(struct mmc_card *, unsigned int);
175
176 extern int __mmc_claim_host(struct mmc_host *host, atomic_t *abort);
177 extern void mmc_release_host(struct mmc_host *host);
178 extern int mmc_try_claim_host(struct mmc_host *host);
179
180 extern int mmc_flush_cache(struct mmc_card *);
181
182 extern int mmc_detect_card_removed(struct mmc_host *host);
183
184 /**
185 * mmc_claim_host - exclusively claim a host
186 * @host: mmc host to claim
187 *
188 * Claim a host for a set of operations.
189 */
mmc_claim_host(struct mmc_host * host)190 static inline void mmc_claim_host(struct mmc_host *host)
191 {
192 __mmc_claim_host(host, NULL);
193 }
194
195 extern u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max);
196
197 #endif /* LINUX_MMC_CORE_H */
198