| 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 | #define mmc_resp_type(cmd) ((cmd)->flags & (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC|MMC_RSP_BUSY|MMC_RSP_OPCODE)) |
| 59 | |
| 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 | |
| 76 | /* |
| 77 | * These are the command types. |
| 78 | */ |
| 79 | #define mmc_cmd_type(cmd) ((cmd)->flags & MMC_CMD_MASK) |
| 80 | |
| 81 | unsigned int retries; /* max number of retries */ |
| 82 | int error; /* command error */ |
| 83 | |
| 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 | */ |
| 97 | |
| 98 | unsigned int busy_timeout; /* busy detect timeout in ms */ |
| 99 | /* Set this flag only for blocking sanitize request */ |
| 100 | bool sanitize_busy; |
| 101 | |
| 102 | struct mmc_data *data; /* data segment associated with cmd */ |
| 103 | struct mmc_request *mrq; /* associated request */ |
| 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) */ |
| 109 | unsigned int blksz; /* data block size */ |
| 110 | unsigned int blocks; /* number of blocks */ |
| 111 | int error; /* data error */ |
| 112 | unsigned int flags; |
| 113 | |
| 114 | #define MMC_DATA_WRITE (1 << 8) |
| 115 | #define MMC_DATA_READ (1 << 9) |
| 116 | |
| 117 | unsigned int bytes_xfered; |
| 118 | |
| 119 | struct mmc_command *stop; /* stop command */ |
| 120 | struct mmc_request *mrq; /* associated request */ |
| 121 | |
| 122 | unsigned int sg_len; /* size of scatter list */ |
| 123 | int sg_count; /* mapped sg entries */ |
| 124 | struct scatterlist *sg; /* I/O scatter list */ |
| 125 | s32 host_cookie; /* host private data */ |
| 126 | }; |
| 127 | |
| 128 | struct mmc_host; |
| 129 | struct mmc_request { |
| 130 | struct mmc_command *sbc; /* SET_BLOCK_COUNT for multiblock */ |
| 131 | struct mmc_command *cmd; |
| 132 | struct mmc_data *data; |
| 133 | struct mmc_command *stop; |
| 134 | |
| 135 | struct completion completion; |
| 136 | struct completion cmd_completion; |
| 137 | void (*done)(struct mmc_request *);/* completion function */ |
| 138 | struct mmc_host *host; |
| 139 | |
| 140 | /* Allow other commands during this ongoing data transfer or busy wait */ |
| 141 | bool cap_cmd_during_tfr; |
| 142 | }; |
| 143 | |
| 144 | struct mmc_card; |
| 145 | struct mmc_async_req; |
| 146 | |
| 147 | extern int mmc_stop_bkops(struct mmc_card *); |
| 148 | extern int mmc_read_bkops_status(struct mmc_card *); |
| 149 | extern struct mmc_async_req *mmc_start_req(struct mmc_host *, |
| 150 | struct mmc_async_req *, int *); |
| 151 | extern int mmc_interrupt_hpi(struct mmc_card *); |
| 152 | extern void mmc_wait_for_req(struct mmc_host *, struct mmc_request *); |
| 153 | extern void mmc_wait_for_req_done(struct mmc_host *host, |
| 154 | struct mmc_request *mrq); |
| 155 | extern bool mmc_is_req_done(struct mmc_host *host, struct mmc_request *mrq); |
| 156 | extern int mmc_wait_for_cmd(struct mmc_host *, struct mmc_command *, int); |
| 157 | extern int mmc_app_cmd(struct mmc_host *, struct mmc_card *); |
| 158 | extern int mmc_wait_for_app_cmd(struct mmc_host *, struct mmc_card *, |
| 159 | struct mmc_command *, int); |
| 160 | extern void mmc_start_bkops(struct mmc_card *card, bool from_exception); |
| 161 | extern int mmc_switch(struct mmc_card *, u8, u8, u8, unsigned int); |
| 162 | extern int mmc_send_tuning(struct mmc_host *host, u32 opcode, int *cmd_error); |
| 163 | extern int mmc_get_ext_csd(struct mmc_card *card, u8 **new_ext_csd); |
| 164 | |
| 165 | #define MMC_ERASE_ARG 0x00000000 |
| 166 | #define MMC_SECURE_ERASE_ARG 0x80000000 |
| 167 | #define MMC_TRIM_ARG 0x00000001 |
| 168 | #define MMC_DISCARD_ARG 0x00000003 |
| 169 | #define MMC_SECURE_TRIM1_ARG 0x80000001 |
| 170 | #define MMC_SECURE_TRIM2_ARG 0x80008000 |
| 171 | |
| 172 | #define MMC_SECURE_ARGS 0x80000000 |
| 173 | #define MMC_TRIM_ARGS 0x00008001 |
| 174 | |
| 175 | extern int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr, |
| 176 | unsigned int arg); |
| 177 | extern int mmc_can_erase(struct mmc_card *card); |
| 178 | extern int mmc_can_trim(struct mmc_card *card); |
| 179 | extern int mmc_can_discard(struct mmc_card *card); |
| 180 | extern int mmc_can_sanitize(struct mmc_card *card); |
| 181 | extern int mmc_can_secure_erase_trim(struct mmc_card *card); |
| 182 | extern int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from, |
| 183 | unsigned int nr); |
| 184 | extern unsigned int mmc_calc_max_discard(struct mmc_card *card); |
| 185 | |
| 186 | extern int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen); |
| 187 | extern int mmc_set_blockcount(struct mmc_card *card, unsigned int blockcount, |
| 188 | bool is_rel_write); |
| 189 | extern int mmc_hw_reset(struct mmc_host *host); |
| 190 | extern int mmc_can_reset(struct mmc_card *card); |
| 191 | |
| 192 | extern void mmc_set_data_timeout(struct mmc_data *, const struct mmc_card *); |
| 193 | extern unsigned int mmc_align_data_size(struct mmc_card *, unsigned int); |
| 194 | |
| 195 | extern int __mmc_claim_host(struct mmc_host *host, atomic_t *abort); |
| 196 | extern void mmc_release_host(struct mmc_host *host); |
| 197 | |
| 198 | extern void mmc_get_card(struct mmc_card *card); |
| 199 | extern void mmc_put_card(struct mmc_card *card); |
| 200 | |
| 201 | extern int mmc_flush_cache(struct mmc_card *); |
| 202 | |
| 203 | extern int mmc_detect_card_removed(struct mmc_host *host); |
| 204 | |
| 205 | /** |
| 206 | * mmc_claim_host - exclusively claim a host |
| 207 | * @host: mmc host to claim |
| 208 | * |
| 209 | * Claim a host for a set of operations. |
| 210 | */ |
| 211 | static inline void mmc_claim_host(struct mmc_host *host) |
| 212 | { |
| 213 | __mmc_claim_host(host, NULL); |
| 214 | } |
| 215 | |
| 216 | struct device_node; |
| 217 | extern u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max); |
| 218 | extern int mmc_of_parse_voltage(struct device_node *np, u32 *mask); |
| 219 | |
| 220 | #endif /* LINUX_MMC_CORE_H */ |