]>
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 | |
313162d0 | 11 | #include <linux/completion.h> |
8da00734 | 12 | #include <linux/types.h> |
1da177e4 | 13 | |
1da177e4 LT |
14 | struct mmc_data; |
15 | struct mmc_request; | |
16 | ||
8e8b3f51 LW |
17 | enum mmc_blk_status { |
18 | MMC_BLK_SUCCESS = 0, | |
19 | MMC_BLK_PARTIAL, | |
20 | MMC_BLK_CMD_ERR, | |
21 | MMC_BLK_RETRY, | |
22 | MMC_BLK_ABORT, | |
23 | MMC_BLK_DATA_ERR, | |
24 | MMC_BLK_ECC_ERR, | |
25 | MMC_BLK_NOMEDIUM, | |
26 | MMC_BLK_NEW_REQUEST, | |
27 | }; | |
28 | ||
1da177e4 LT |
29 | struct mmc_command { |
30 | u32 opcode; | |
31 | u32 arg; | |
ce39f9d1 SJ |
32 | #define MMC_CMD23_ARG_REL_WR (1 << 31) |
33 | #define MMC_CMD23_ARG_PACKED ((0 << 31) | (1 << 30)) | |
34 | #define MMC_CMD23_ARG_TAG_REQ (1 << 29) | |
1da177e4 LT |
35 | u32 resp[4]; |
36 | unsigned int flags; /* expected response type */ | |
e9225176 RK |
37 | #define MMC_RSP_PRESENT (1 << 0) |
38 | #define MMC_RSP_136 (1 << 1) /* 136 bit response */ | |
39 | #define MMC_RSP_CRC (1 << 2) /* expect valid crc */ | |
40 | #define MMC_RSP_BUSY (1 << 3) /* card may send busy */ | |
41 | #define MMC_RSP_OPCODE (1 << 4) /* response contains opcode */ | |
97018580 DB |
42 | |
43 | #define MMC_CMD_MASK (3 << 5) /* non-SPI command type */ | |
e9225176 RK |
44 | #define MMC_CMD_AC (0 << 5) |
45 | #define MMC_CMD_ADTC (1 << 5) | |
46 | #define MMC_CMD_BC (2 << 5) | |
47 | #define MMC_CMD_BCR (3 << 5) | |
1da177e4 | 48 | |
97018580 DB |
49 | #define MMC_RSP_SPI_S1 (1 << 7) /* one status byte */ |
50 | #define MMC_RSP_SPI_S2 (1 << 8) /* second byte */ | |
51 | #define MMC_RSP_SPI_B4 (1 << 9) /* four data bytes */ | |
52 | #define MMC_RSP_SPI_BUSY (1 << 10) /* card may send busy */ | |
53 | ||
1da177e4 | 54 | /* |
97018580 | 55 | * These are the native response types, and correspond to valid bit |
1da177e4 LT |
56 | * patterns of the above flags. One additional valid pattern |
57 | * is all zeros, which means we don't expect a response. | |
58 | */ | |
e9225176 RK |
59 | #define MMC_RSP_NONE (0) |
60 | #define MMC_RSP_R1 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE) | |
61 | #define MMC_RSP_R1B (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE|MMC_RSP_BUSY) | |
62 | #define MMC_RSP_R2 (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC) | |
63 | #define MMC_RSP_R3 (MMC_RSP_PRESENT) | |
5c4e6f13 | 64 | #define MMC_RSP_R4 (MMC_RSP_PRESENT) |
b2bcc798 | 65 | #define MMC_RSP_R5 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE) |
6f949909 | 66 | #define MMC_RSP_R6 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE) |
fba68bd2 | 67 | #define MMC_RSP_R7 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE) |
e9225176 | 68 | |
51b50c96 WS |
69 | /* Can be used by core to poll after switch to MMC HS mode */ |
70 | #define MMC_RSP_R1_NO_CRC (MMC_RSP_PRESENT|MMC_RSP_OPCODE) | |
71 | ||
e9225176 RK |
72 | #define mmc_resp_type(cmd) ((cmd)->flags & (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC|MMC_RSP_BUSY|MMC_RSP_OPCODE)) |
73 | ||
97018580 DB |
74 | /* |
75 | * These are the SPI response types for MMC, SD, and SDIO cards. | |
76 | * Commands return R1, with maybe more info. Zero is an error type; | |
77 | * callers must always provide the appropriate MMC_RSP_SPI_Rx flags. | |
78 | */ | |
79 | #define MMC_RSP_SPI_R1 (MMC_RSP_SPI_S1) | |
80 | #define MMC_RSP_SPI_R1B (MMC_RSP_SPI_S1|MMC_RSP_SPI_BUSY) | |
81 | #define MMC_RSP_SPI_R2 (MMC_RSP_SPI_S1|MMC_RSP_SPI_S2) | |
82 | #define MMC_RSP_SPI_R3 (MMC_RSP_SPI_S1|MMC_RSP_SPI_B4) | |
83 | #define MMC_RSP_SPI_R4 (MMC_RSP_SPI_S1|MMC_RSP_SPI_B4) | |
84 | #define MMC_RSP_SPI_R5 (MMC_RSP_SPI_S1|MMC_RSP_SPI_S2) | |
85 | #define MMC_RSP_SPI_R7 (MMC_RSP_SPI_S1|MMC_RSP_SPI_B4) | |
86 | ||
87 | #define mmc_spi_resp_type(cmd) ((cmd)->flags & \ | |
88 | (MMC_RSP_SPI_S1|MMC_RSP_SPI_BUSY|MMC_RSP_SPI_S2|MMC_RSP_SPI_B4)) | |
89 | ||
e9225176 RK |
90 | /* |
91 | * These are the command types. | |
92 | */ | |
5bd546aa | 93 | #define mmc_cmd_type(cmd) ((cmd)->flags & MMC_CMD_MASK) |
1da177e4 LT |
94 | |
95 | unsigned int retries; /* max number of retries */ | |
f5c5179b | 96 | int error; /* command error */ |
1da177e4 | 97 | |
17b0429d PO |
98 | /* |
99 | * Standard errno values are used for errors, but some have specific | |
100 | * meaning in the MMC layer: | |
101 | * | |
102 | * ETIMEDOUT Card took too long to respond | |
103 | * EILSEQ Basic format problem with the received or sent data | |
104 | * (e.g. CRC check failed, incorrect opcode in response | |
105 | * or bad end bit) | |
106 | * EINVAL Request cannot be performed because of restrictions | |
107 | * in hardware and/or the driver | |
108 | * ENOMEDIUM Host can determine that the slot is empty and is | |
109 | * actively failing requests | |
110 | */ | |
1da177e4 | 111 | |
1d4d7744 | 112 | unsigned int busy_timeout; /* busy detect timeout in ms */ |
775a9362 ME |
113 | /* Set this flag only for blocking sanitize request */ |
114 | bool sanitize_busy; | |
dfe86cba | 115 | |
1da177e4 | 116 | struct mmc_data *data; /* data segment associated with cmd */ |
8573b80f | 117 | struct mmc_request *mrq; /* associated request */ |
1da177e4 LT |
118 | }; |
119 | ||
120 | struct mmc_data { | |
121 | unsigned int timeout_ns; /* data timeout (in ns, max 80ms) */ | |
122 | unsigned int timeout_clks; /* data timeout (in clocks) */ | |
2c171bf1 | 123 | unsigned int blksz; /* data block size */ |
1da177e4 | 124 | unsigned int blocks; /* number of blocks */ |
d2f82254 | 125 | unsigned int blk_addr; /* block address */ |
f5c5179b | 126 | int error; /* data error */ |
1da177e4 LT |
127 | unsigned int flags; |
128 | ||
d2f82254 AH |
129 | #define MMC_DATA_WRITE BIT(8) |
130 | #define MMC_DATA_READ BIT(9) | |
131 | /* Extra flags used by CQE */ | |
132 | #define MMC_DATA_QBR BIT(10) /* CQE queue barrier*/ | |
133 | #define MMC_DATA_PRIO BIT(11) /* CQE high priority */ | |
134 | #define MMC_DATA_REL_WR BIT(12) /* Reliable write */ | |
135 | #define MMC_DATA_DAT_TAG BIT(13) /* Tag request */ | |
136 | #define MMC_DATA_FORCED_PRG BIT(14) /* Forced programming */ | |
1da177e4 LT |
137 | |
138 | unsigned int bytes_xfered; | |
139 | ||
140 | struct mmc_command *stop; /* stop command */ | |
8573b80f | 141 | struct mmc_request *mrq; /* associated request */ |
1da177e4 LT |
142 | |
143 | unsigned int sg_len; /* size of scatter list */ | |
20848903 | 144 | int sg_count; /* mapped sg entries */ |
1da177e4 | 145 | struct scatterlist *sg; /* I/O scatter list */ |
aa8b683a | 146 | s32 host_cookie; /* host private data */ |
1da177e4 LT |
147 | }; |
148 | ||
2220eedf | 149 | struct mmc_host; |
1da177e4 | 150 | struct mmc_request { |
d0c97cfb | 151 | struct mmc_command *sbc; /* SET_BLOCK_COUNT for multiblock */ |
1da177e4 LT |
152 | struct mmc_command *cmd; |
153 | struct mmc_data *data; | |
154 | struct mmc_command *stop; | |
155 | ||
aa8b683a | 156 | struct completion completion; |
5163af5a | 157 | struct completion cmd_completion; |
1da177e4 | 158 | void (*done)(struct mmc_request *);/* completion function */ |
d3bf68ae AH |
159 | /* |
160 | * Notify uppers layers (e.g. mmc block driver) that recovery is needed | |
161 | * due to an error associated with the mmc_request. Currently used only | |
162 | * by CQE. | |
163 | */ | |
164 | void (*recovery_notifier)(struct mmc_request *); | |
2220eedf | 165 | struct mmc_host *host; |
5163af5a AH |
166 | |
167 | /* Allow other commands during this ongoing data transfer or busy wait */ | |
168 | bool cap_cmd_during_tfr; | |
d2f82254 AH |
169 | |
170 | int tag; | |
1da177e4 LT |
171 | }; |
172 | ||
1da177e4 LT |
173 | struct mmc_card; |
174 | ||
23888bfe UH |
175 | void mmc_wait_for_req(struct mmc_host *host, struct mmc_request *mrq); |
176 | int mmc_wait_for_cmd(struct mmc_host *host, struct mmc_command *cmd, | |
177 | int retries); | |
178 | ||
179 | int mmc_hw_reset(struct mmc_host *host); | |
180 | void mmc_set_data_timeout(struct mmc_data *data, const struct mmc_card *card); | |
2342f332 | 181 | |
100e9186 | 182 | #endif /* LINUX_MMC_CORE_H */ |