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 #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) 24 u32 resp[4]; 25 unsigned int flags; /* expected response type */ 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 */ 31 32 #define MMC_CMD_MASK (3 << 5) /* non-SPI command type */ 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) 37 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 43 /* 44 * These are the native response types, and correspond to valid bit 45 * patterns of the above flags. One additional valid pattern 46 * is all zeros, which means we don't expect a response. 47 */ 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) 53 #define MMC_RSP_R4 (MMC_RSP_PRESENT) 54 #define MMC_RSP_R5 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE) 55 #define MMC_RSP_R6 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE) 56 #define MMC_RSP_R7 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE) 57 58 /* Can be used by core to poll after switch to MMC HS mode */ 59 #define MMC_RSP_R1_NO_CRC (MMC_RSP_PRESENT|MMC_RSP_OPCODE) 60 61 #define mmc_resp_type(cmd) ((cmd)->flags & (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC|MMC_RSP_BUSY|MMC_RSP_OPCODE)) 62 63 /* 64 * These are the SPI response types for MMC, SD, and SDIO cards. 65 * Commands return R1, with maybe more info. Zero is an error type; 66 * callers must always provide the appropriate MMC_RSP_SPI_Rx flags. 67 */ 68 #define MMC_RSP_SPI_R1 (MMC_RSP_SPI_S1) 69 #define MMC_RSP_SPI_R1B (MMC_RSP_SPI_S1|MMC_RSP_SPI_BUSY) 70 #define MMC_RSP_SPI_R2 (MMC_RSP_SPI_S1|MMC_RSP_SPI_S2) 71 #define MMC_RSP_SPI_R3 (MMC_RSP_SPI_S1|MMC_RSP_SPI_B4) 72 #define MMC_RSP_SPI_R4 (MMC_RSP_SPI_S1|MMC_RSP_SPI_B4) 73 #define MMC_RSP_SPI_R5 (MMC_RSP_SPI_S1|MMC_RSP_SPI_S2) 74 #define MMC_RSP_SPI_R7 (MMC_RSP_SPI_S1|MMC_RSP_SPI_B4) 75 76 #define mmc_spi_resp_type(cmd) ((cmd)->flags & \ 77 (MMC_RSP_SPI_S1|MMC_RSP_SPI_BUSY|MMC_RSP_SPI_S2|MMC_RSP_SPI_B4)) 78 79 /* 80 * These are the command types. 81 */ 82 #define mmc_cmd_type(cmd) ((cmd)->flags & MMC_CMD_MASK) 83 84 unsigned int retries; /* max number of retries */ 85 int error; /* command error */ 86 87 /* 88 * Standard errno values are used for errors, but some have specific 89 * meaning in the MMC layer: 90 * 91 * ETIMEDOUT Card took too long to respond 92 * EILSEQ Basic format problem with the received or sent data 93 * (e.g. CRC check failed, incorrect opcode in response 94 * or bad end bit) 95 * EINVAL Request cannot be performed because of restrictions 96 * in hardware and/or the driver 97 * ENOMEDIUM Host can determine that the slot is empty and is 98 * actively failing requests 99 */ 100 101 unsigned int busy_timeout; /* busy detect timeout in ms */ 102 /* Set this flag only for blocking sanitize request */ 103 bool sanitize_busy; 104 105 struct mmc_data *data; /* data segment associated with cmd */ 106 struct mmc_request *mrq; /* associated request */ 107 }; 108 109 struct mmc_data { 110 unsigned int timeout_ns; /* data timeout (in ns, max 80ms) */ 111 unsigned int timeout_clks; /* data timeout (in clocks) */ 112 unsigned int blksz; /* data block size */ 113 unsigned int blocks; /* number of blocks */ 114 int error; /* data error */ 115 unsigned int flags; 116 117 #define MMC_DATA_WRITE (1 << 8) 118 #define MMC_DATA_READ (1 << 9) 119 120 unsigned int bytes_xfered; 121 122 struct mmc_command *stop; /* stop command */ 123 struct mmc_request *mrq; /* associated request */ 124 125 unsigned int sg_len; /* size of scatter list */ 126 int sg_count; /* mapped sg entries */ 127 struct scatterlist *sg; /* I/O scatter list */ 128 s32 host_cookie; /* host private data */ 129 }; 130 131 struct mmc_host; 132 struct mmc_request { 133 struct mmc_command *sbc; /* SET_BLOCK_COUNT for multiblock */ 134 struct mmc_command *cmd; 135 struct mmc_data *data; 136 struct mmc_command *stop; 137 138 struct completion completion; 139 struct completion cmd_completion; 140 void (*done)(struct mmc_request *);/* completion function */ 141 struct mmc_host *host; 142 143 /* Allow other commands during this ongoing data transfer or busy wait */ 144 bool cap_cmd_during_tfr; 145 }; 146 147 struct mmc_card; 148 struct mmc_async_req; 149 150 extern int mmc_stop_bkops(struct mmc_card *); 151 extern int mmc_read_bkops_status(struct mmc_card *); 152 extern struct mmc_async_req *mmc_start_req(struct mmc_host *, 153 struct mmc_async_req *, int *); 154 extern int mmc_interrupt_hpi(struct mmc_card *); 155 extern void mmc_wait_for_req(struct mmc_host *, struct mmc_request *); 156 extern void mmc_wait_for_req_done(struct mmc_host *host, 157 struct mmc_request *mrq); 158 extern bool mmc_is_req_done(struct mmc_host *host, struct mmc_request *mrq); 159 extern int mmc_wait_for_cmd(struct mmc_host *, struct mmc_command *, int); 160 extern int mmc_app_cmd(struct mmc_host *, struct mmc_card *); 161 extern int mmc_wait_for_app_cmd(struct mmc_host *, struct mmc_card *, 162 struct mmc_command *, int); 163 extern void mmc_start_bkops(struct mmc_card *card, bool from_exception); 164 extern int mmc_switch(struct mmc_card *, u8, u8, u8, unsigned int); 165 extern int mmc_send_tuning(struct mmc_host *host, u32 opcode, int *cmd_error); 166 extern int mmc_get_ext_csd(struct mmc_card *card, u8 **new_ext_csd); 167 168 #define MMC_ERASE_ARG 0x00000000 169 #define MMC_SECURE_ERASE_ARG 0x80000000 170 #define MMC_TRIM_ARG 0x00000001 171 #define MMC_DISCARD_ARG 0x00000003 172 #define MMC_SECURE_TRIM1_ARG 0x80000001 173 #define MMC_SECURE_TRIM2_ARG 0x80008000 174 175 #define MMC_SECURE_ARGS 0x80000000 176 #define MMC_TRIM_ARGS 0x00008001 177 178 extern int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr, 179 unsigned int arg); 180 extern int mmc_can_erase(struct mmc_card *card); 181 extern int mmc_can_trim(struct mmc_card *card); 182 extern int mmc_can_discard(struct mmc_card *card); 183 extern int mmc_can_sanitize(struct mmc_card *card); 184 extern int mmc_can_secure_erase_trim(struct mmc_card *card); 185 extern int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from, 186 unsigned int nr); 187 extern unsigned int mmc_calc_max_discard(struct mmc_card *card); 188 189 extern int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen); 190 extern int mmc_set_blockcount(struct mmc_card *card, unsigned int blockcount, 191 bool is_rel_write); 192 extern int mmc_hw_reset(struct mmc_host *host); 193 extern int mmc_can_reset(struct mmc_card *card); 194 195 extern void mmc_set_data_timeout(struct mmc_data *, const struct mmc_card *); 196 extern unsigned int mmc_align_data_size(struct mmc_card *, unsigned int); 197 198 extern int __mmc_claim_host(struct mmc_host *host, atomic_t *abort); 199 extern void mmc_release_host(struct mmc_host *host); 200 201 extern void mmc_get_card(struct mmc_card *card); 202 extern void mmc_put_card(struct mmc_card *card); 203 204 extern int mmc_flush_cache(struct mmc_card *); 205 206 extern int mmc_detect_card_removed(struct mmc_host *host); 207 208 /** 209 * mmc_claim_host - exclusively claim a host 210 * @host: mmc host to claim 211 * 212 * Claim a host for a set of operations. 213 */ 214 static inline void mmc_claim_host(struct mmc_host *host) 215 { 216 __mmc_claim_host(host, NULL); 217 } 218 219 struct device_node; 220 extern u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max); 221 extern int mmc_of_parse_voltage(struct device_node *np, u32 *mask); 222 223 #endif /* LINUX_MMC_CORE_H */ 224