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