]>
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 |
9 | #define LINUX_MMC_CORE_H | |
1da177e4 | 10 | |
1da177e4 | 11 | #include <linux/interrupt.h> |
313162d0 | 12 | #include <linux/completion.h> |
1da177e4 LT |
13 | |
14 | struct request; | |
15 | struct mmc_data; | |
16 | struct mmc_request; | |
17 | ||
18 | struct mmc_command { | |
19 | u32 opcode; | |
20 | u32 arg; | |
ce39f9d1 SJ |
21 | #define MMC_CMD23_ARG_REL_WR (1 << 31) |
22 | #define MMC_CMD23_ARG_PACKED ((0 << 31) | (1 << 30)) | |
23 | #define MMC_CMD23_ARG_TAG_REQ (1 << 29) | |
1da177e4 LT |
24 | u32 resp[4]; |
25 | unsigned int flags; /* expected response type */ | |
e9225176 RK |
26 | #define MMC_RSP_PRESENT (1 << 0) |
27 | #define MMC_RSP_136 (1 << 1) /* 136 bit response */ | |
28 | #define MMC_RSP_CRC (1 << 2) /* expect valid crc */ | |
29 | #define MMC_RSP_BUSY (1 << 3) /* card may send busy */ | |
30 | #define MMC_RSP_OPCODE (1 << 4) /* response contains opcode */ | |
97018580 DB |
31 | |
32 | #define MMC_CMD_MASK (3 << 5) /* non-SPI command type */ | |
e9225176 RK |
33 | #define MMC_CMD_AC (0 << 5) |
34 | #define MMC_CMD_ADTC (1 << 5) | |
35 | #define MMC_CMD_BC (2 << 5) | |
36 | #define MMC_CMD_BCR (3 << 5) | |
1da177e4 | 37 | |
97018580 DB |
38 | #define MMC_RSP_SPI_S1 (1 << 7) /* one status byte */ |
39 | #define MMC_RSP_SPI_S2 (1 << 8) /* second byte */ | |
40 | #define MMC_RSP_SPI_B4 (1 << 9) /* four data bytes */ | |
41 | #define MMC_RSP_SPI_BUSY (1 << 10) /* card may send busy */ | |
42 | ||
1da177e4 | 43 | /* |
97018580 | 44 | * These are the native response types, and correspond to valid bit |
1da177e4 LT |
45 | * patterns of the above flags. One additional valid pattern |
46 | * is all zeros, which means we don't expect a response. | |
47 | */ | |
e9225176 RK |
48 | #define MMC_RSP_NONE (0) |
49 | #define MMC_RSP_R1 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE) | |
50 | #define MMC_RSP_R1B (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE|MMC_RSP_BUSY) | |
51 | #define MMC_RSP_R2 (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC) | |
52 | #define MMC_RSP_R3 (MMC_RSP_PRESENT) | |
5c4e6f13 | 53 | #define MMC_RSP_R4 (MMC_RSP_PRESENT) |
b2bcc798 | 54 | #define MMC_RSP_R5 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE) |
6f949909 | 55 | #define MMC_RSP_R6 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE) |
fba68bd2 | 56 | #define MMC_RSP_R7 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE) |
e9225176 RK |
57 | |
58 | #define mmc_resp_type(cmd) ((cmd)->flags & (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC|MMC_RSP_BUSY|MMC_RSP_OPCODE)) | |
59 | ||
97018580 DB |
60 | /* |
61 | * These are the SPI response types for MMC, SD, and SDIO cards. | |
62 | * Commands return R1, with maybe more info. Zero is an error type; | |
63 | * callers must always provide the appropriate MMC_RSP_SPI_Rx flags. | |
64 | */ | |
65 | #define MMC_RSP_SPI_R1 (MMC_RSP_SPI_S1) | |
66 | #define MMC_RSP_SPI_R1B (MMC_RSP_SPI_S1|MMC_RSP_SPI_BUSY) | |
67 | #define MMC_RSP_SPI_R2 (MMC_RSP_SPI_S1|MMC_RSP_SPI_S2) | |
68 | #define MMC_RSP_SPI_R3 (MMC_RSP_SPI_S1|MMC_RSP_SPI_B4) | |
69 | #define MMC_RSP_SPI_R4 (MMC_RSP_SPI_S1|MMC_RSP_SPI_B4) | |
70 | #define MMC_RSP_SPI_R5 (MMC_RSP_SPI_S1|MMC_RSP_SPI_S2) | |
71 | #define MMC_RSP_SPI_R7 (MMC_RSP_SPI_S1|MMC_RSP_SPI_B4) | |
72 | ||
73 | #define mmc_spi_resp_type(cmd) ((cmd)->flags & \ | |
74 | (MMC_RSP_SPI_S1|MMC_RSP_SPI_BUSY|MMC_RSP_SPI_S2|MMC_RSP_SPI_B4)) | |
75 | ||
e9225176 RK |
76 | /* |
77 | * These are the command types. | |
78 | */ | |
5bd546aa | 79 | #define mmc_cmd_type(cmd) ((cmd)->flags & MMC_CMD_MASK) |
1da177e4 LT |
80 | |
81 | unsigned int retries; /* max number of retries */ | |
f5c5179b | 82 | int error; /* command error */ |
1da177e4 | 83 | |
17b0429d PO |
84 | /* |
85 | * Standard errno values are used for errors, but some have specific | |
86 | * meaning in the MMC layer: | |
87 | * | |
88 | * ETIMEDOUT Card took too long to respond | |
89 | * EILSEQ Basic format problem with the received or sent data | |
90 | * (e.g. CRC check failed, incorrect opcode in response | |
91 | * or bad end bit) | |
92 | * EINVAL Request cannot be performed because of restrictions | |
93 | * in hardware and/or the driver | |
94 | * ENOMEDIUM Host can determine that the slot is empty and is | |
95 | * actively failing requests | |
96 | */ | |
1da177e4 | 97 | |
1d4d7744 | 98 | unsigned int busy_timeout; /* busy detect timeout in ms */ |
775a9362 ME |
99 | /* Set this flag only for blocking sanitize request */ |
100 | bool sanitize_busy; | |
dfe86cba | 101 | |
1da177e4 | 102 | struct mmc_data *data; /* data segment associated with cmd */ |
8573b80f | 103 | struct mmc_request *mrq; /* associated request */ |
1da177e4 LT |
104 | }; |
105 | ||
106 | struct mmc_data { | |
107 | unsigned int timeout_ns; /* data timeout (in ns, max 80ms) */ | |
108 | unsigned int timeout_clks; /* data timeout (in clocks) */ | |
2c171bf1 | 109 | unsigned int blksz; /* data block size */ |
1da177e4 | 110 | unsigned int blocks; /* number of blocks */ |
f5c5179b | 111 | int error; /* data error */ |
1da177e4 LT |
112 | unsigned int flags; |
113 | ||
114 | #define MMC_DATA_WRITE (1 << 8) | |
115 | #define MMC_DATA_READ (1 << 9) | |
116 | #define MMC_DATA_STREAM (1 << 10) | |
117 | ||
118 | unsigned int bytes_xfered; | |
119 | ||
120 | struct mmc_command *stop; /* stop command */ | |
8573b80f | 121 | struct mmc_request *mrq; /* associated request */ |
1da177e4 LT |
122 | |
123 | unsigned int sg_len; /* size of scatter list */ | |
124 | struct scatterlist *sg; /* I/O scatter list */ | |
aa8b683a | 125 | s32 host_cookie; /* host private data */ |
1da177e4 LT |
126 | }; |
127 | ||
2220eedf | 128 | struct mmc_host; |
1da177e4 | 129 | struct mmc_request { |
d0c97cfb | 130 | struct mmc_command *sbc; /* SET_BLOCK_COUNT for multiblock */ |
1da177e4 LT |
131 | struct mmc_command *cmd; |
132 | struct mmc_data *data; | |
133 | struct mmc_command *stop; | |
134 | ||
aa8b683a | 135 | struct completion completion; |
1da177e4 | 136 | void (*done)(struct mmc_request *);/* completion function */ |
2220eedf | 137 | struct mmc_host *host; |
1da177e4 LT |
138 | }; |
139 | ||
1da177e4 | 140 | struct mmc_card; |
aa8b683a | 141 | struct mmc_async_req; |
1da177e4 | 142 | |
950d56ac JC |
143 | extern int mmc_stop_bkops(struct mmc_card *); |
144 | extern int mmc_read_bkops_status(struct mmc_card *); | |
aa8b683a PF |
145 | extern struct mmc_async_req *mmc_start_req(struct mmc_host *, |
146 | struct mmc_async_req *, int *); | |
eb0d8f13 | 147 | extern int mmc_interrupt_hpi(struct mmc_card *); |
67a61c48 | 148 | extern void mmc_wait_for_req(struct mmc_host *, struct mmc_request *); |
1da177e4 | 149 | extern int mmc_wait_for_cmd(struct mmc_host *, struct mmc_command *, int); |
cb87ea28 | 150 | extern int mmc_app_cmd(struct mmc_host *, struct mmc_card *); |
da7fbe58 | 151 | extern int mmc_wait_for_app_cmd(struct mmc_host *, struct mmc_card *, |
335eadf2 | 152 | struct mmc_command *, int); |
950d56ac | 153 | extern void mmc_start_bkops(struct mmc_card *card, bool from_exception); |
878e200b | 154 | extern int __mmc_switch(struct mmc_card *, u8, u8, u8, unsigned int, bool, |
4509f847 | 155 | bool, bool); |
d3a8d95d | 156 | extern int mmc_switch(struct mmc_card *, u8, u8, u8, unsigned int); |
fe5afb13 | 157 | extern int mmc_send_tuning(struct mmc_host *host); |
e21aa519 | 158 | extern int mmc_get_ext_csd(struct mmc_card *card, u8 **new_ext_csd); |
1da177e4 | 159 | |
dfe86cba AH |
160 | #define MMC_ERASE_ARG 0x00000000 |
161 | #define MMC_SECURE_ERASE_ARG 0x80000000 | |
162 | #define MMC_TRIM_ARG 0x00000001 | |
b3bf9153 | 163 | #define MMC_DISCARD_ARG 0x00000003 |
dfe86cba AH |
164 | #define MMC_SECURE_TRIM1_ARG 0x80000001 |
165 | #define MMC_SECURE_TRIM2_ARG 0x80008000 | |
166 | ||
167 | #define MMC_SECURE_ARGS 0x80000000 | |
168 | #define MMC_TRIM_ARGS 0x00008001 | |
169 | ||
170 | extern int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr, | |
171 | unsigned int arg); | |
172 | extern int mmc_can_erase(struct mmc_card *card); | |
173 | extern int mmc_can_trim(struct mmc_card *card); | |
b3bf9153 | 174 | extern int mmc_can_discard(struct mmc_card *card); |
d9ddd629 | 175 | extern int mmc_can_sanitize(struct mmc_card *card); |
dfe86cba AH |
176 | extern int mmc_can_secure_erase_trim(struct mmc_card *card); |
177 | extern int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from, | |
178 | unsigned int nr); | |
e056a1b5 | 179 | extern unsigned int mmc_calc_max_discard(struct mmc_card *card); |
dfe86cba | 180 | |
0f8d8ea6 | 181 | extern int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen); |
67c79db8 LP |
182 | extern int mmc_set_blockcount(struct mmc_card *card, unsigned int blockcount, |
183 | bool is_rel_write); | |
b2499518 | 184 | extern int mmc_hw_reset(struct mmc_host *host); |
b2499518 | 185 | extern int mmc_can_reset(struct mmc_card *card); |
0f8d8ea6 | 186 | |
b146d26a | 187 | extern void mmc_set_data_timeout(struct mmc_data *, const struct mmc_card *); |
ad3868b2 | 188 | extern unsigned int mmc_align_data_size(struct mmc_card *, unsigned int); |
d773d725 | 189 | |
2342f332 | 190 | extern int __mmc_claim_host(struct mmc_host *host, atomic_t *abort); |
1da177e4 LT |
191 | extern void mmc_release_host(struct mmc_host *host); |
192 | ||
e94cfef6 UH |
193 | extern void mmc_get_card(struct mmc_card *card); |
194 | extern void mmc_put_card(struct mmc_card *card); | |
195 | ||
881d1c25 SJ |
196 | extern int mmc_flush_cache(struct mmc_card *); |
197 | ||
d3049504 AH |
198 | extern int mmc_detect_card_removed(struct mmc_host *host); |
199 | ||
2342f332 NP |
200 | /** |
201 | * mmc_claim_host - exclusively claim a host | |
202 | * @host: mmc host to claim | |
203 | * | |
204 | * Claim a host for a set of operations. | |
205 | */ | |
206 | static inline void mmc_claim_host(struct mmc_host *host) | |
207 | { | |
208 | __mmc_claim_host(host, NULL); | |
209 | } | |
210 | ||
6e9e318b | 211 | struct device_node; |
86e8286a | 212 | extern u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max); |
6e9e318b | 213 | extern int mmc_of_parse_voltage(struct device_node *np, u32 *mask); |
86e8286a | 214 | |
100e9186 | 215 | #endif /* LINUX_MMC_CORE_H */ |