David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame^] | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 2 | /* |
| 3 | * linux/include/linux/mmc/host.h |
| 4 | * |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 5 | * Host driver specific definitions. |
| 6 | */ |
| 7 | #ifndef LINUX_MMC_HOST_H |
| 8 | #define LINUX_MMC_HOST_H |
| 9 | |
| 10 | #include <linux/sched.h> |
| 11 | #include <linux/device.h> |
| 12 | #include <linux/fault-inject.h> |
| 13 | |
| 14 | #include <linux/mmc/core.h> |
| 15 | #include <linux/mmc/card.h> |
| 16 | #include <linux/mmc/pm.h> |
| 17 | #include <linux/dma-direction.h> |
| 18 | |
| 19 | struct mmc_ios { |
| 20 | unsigned int clock; /* clock rate */ |
| 21 | unsigned short vdd; |
| 22 | unsigned int power_delay_ms; /* waiting for stable power */ |
| 23 | |
| 24 | /* vdd stores the bit number of the selected voltage range from below. */ |
| 25 | |
| 26 | unsigned char bus_mode; /* command output mode */ |
| 27 | |
| 28 | #define MMC_BUSMODE_OPENDRAIN 1 |
| 29 | #define MMC_BUSMODE_PUSHPULL 2 |
| 30 | |
| 31 | unsigned char chip_select; /* SPI chip select */ |
| 32 | |
| 33 | #define MMC_CS_DONTCARE 0 |
| 34 | #define MMC_CS_HIGH 1 |
| 35 | #define MMC_CS_LOW 2 |
| 36 | |
| 37 | unsigned char power_mode; /* power supply mode */ |
| 38 | |
| 39 | #define MMC_POWER_OFF 0 |
| 40 | #define MMC_POWER_UP 1 |
| 41 | #define MMC_POWER_ON 2 |
| 42 | #define MMC_POWER_UNDEFINED 3 |
| 43 | |
| 44 | unsigned char bus_width; /* data bus width */ |
| 45 | |
| 46 | #define MMC_BUS_WIDTH_1 0 |
| 47 | #define MMC_BUS_WIDTH_4 2 |
| 48 | #define MMC_BUS_WIDTH_8 3 |
| 49 | |
| 50 | unsigned char timing; /* timing specification used */ |
| 51 | |
| 52 | #define MMC_TIMING_LEGACY 0 |
| 53 | #define MMC_TIMING_MMC_HS 1 |
| 54 | #define MMC_TIMING_SD_HS 2 |
| 55 | #define MMC_TIMING_UHS_SDR12 3 |
| 56 | #define MMC_TIMING_UHS_SDR25 4 |
| 57 | #define MMC_TIMING_UHS_SDR50 5 |
| 58 | #define MMC_TIMING_UHS_SDR104 6 |
| 59 | #define MMC_TIMING_UHS_DDR50 7 |
| 60 | #define MMC_TIMING_MMC_DDR52 8 |
| 61 | #define MMC_TIMING_MMC_HS200 9 |
| 62 | #define MMC_TIMING_MMC_HS400 10 |
| 63 | |
| 64 | unsigned char signal_voltage; /* signalling voltage (1.8V or 3.3V) */ |
| 65 | |
| 66 | #define MMC_SIGNAL_VOLTAGE_330 0 |
| 67 | #define MMC_SIGNAL_VOLTAGE_180 1 |
| 68 | #define MMC_SIGNAL_VOLTAGE_120 2 |
| 69 | |
| 70 | unsigned char drv_type; /* driver type (A, B, C, D) */ |
| 71 | |
| 72 | #define MMC_SET_DRIVER_TYPE_B 0 |
| 73 | #define MMC_SET_DRIVER_TYPE_A 1 |
| 74 | #define MMC_SET_DRIVER_TYPE_C 2 |
| 75 | #define MMC_SET_DRIVER_TYPE_D 3 |
| 76 | |
| 77 | bool enhanced_strobe; /* hs400es selection */ |
| 78 | }; |
| 79 | |
| 80 | struct mmc_host; |
| 81 | |
| 82 | struct mmc_host_ops { |
| 83 | /* |
| 84 | * It is optional for the host to implement pre_req and post_req in |
| 85 | * order to support double buffering of requests (prepare one |
| 86 | * request while another request is active). |
| 87 | * pre_req() must always be followed by a post_req(). |
| 88 | * To undo a call made to pre_req(), call post_req() with |
| 89 | * a nonzero err condition. |
| 90 | */ |
| 91 | void (*post_req)(struct mmc_host *host, struct mmc_request *req, |
| 92 | int err); |
| 93 | void (*pre_req)(struct mmc_host *host, struct mmc_request *req); |
| 94 | void (*request)(struct mmc_host *host, struct mmc_request *req); |
| 95 | |
| 96 | /* |
| 97 | * Avoid calling the next three functions too often or in a "fast |
| 98 | * path", since underlaying controller might implement them in an |
| 99 | * expensive and/or slow way. Also note that these functions might |
| 100 | * sleep, so don't call them in the atomic contexts! |
| 101 | */ |
| 102 | |
| 103 | /* |
| 104 | * Notes to the set_ios callback: |
| 105 | * ios->clock might be 0. For some controllers, setting 0Hz |
| 106 | * as any other frequency works. However, some controllers |
| 107 | * explicitly need to disable the clock. Otherwise e.g. voltage |
| 108 | * switching might fail because the SDCLK is not really quiet. |
| 109 | */ |
| 110 | void (*set_ios)(struct mmc_host *host, struct mmc_ios *ios); |
| 111 | |
| 112 | /* |
| 113 | * Return values for the get_ro callback should be: |
| 114 | * 0 for a read/write card |
| 115 | * 1 for a read-only card |
| 116 | * -ENOSYS when not supported (equal to NULL callback) |
| 117 | * or a negative errno value when something bad happened |
| 118 | */ |
| 119 | int (*get_ro)(struct mmc_host *host); |
| 120 | |
| 121 | /* |
| 122 | * Return values for the get_cd callback should be: |
| 123 | * 0 for a absent card |
| 124 | * 1 for a present card |
| 125 | * -ENOSYS when not supported (equal to NULL callback) |
| 126 | * or a negative errno value when something bad happened |
| 127 | */ |
| 128 | int (*get_cd)(struct mmc_host *host); |
| 129 | |
| 130 | void (*enable_sdio_irq)(struct mmc_host *host, int enable); |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame^] | 131 | /* Mandatory callback when using MMC_CAP2_SDIO_IRQ_NOTHREAD. */ |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 132 | void (*ack_sdio_irq)(struct mmc_host *host); |
| 133 | |
| 134 | /* optional callback for HC quirks */ |
| 135 | void (*init_card)(struct mmc_host *host, struct mmc_card *card); |
| 136 | |
| 137 | int (*start_signal_voltage_switch)(struct mmc_host *host, struct mmc_ios *ios); |
| 138 | |
| 139 | /* Check if the card is pulling dat[0:3] low */ |
| 140 | int (*card_busy)(struct mmc_host *host); |
| 141 | |
| 142 | /* The tuning command opcode value is different for SD and eMMC cards */ |
| 143 | int (*execute_tuning)(struct mmc_host *host, u32 opcode); |
| 144 | |
| 145 | /* Prepare HS400 target operating frequency depending host driver */ |
| 146 | int (*prepare_hs400_tuning)(struct mmc_host *host, struct mmc_ios *ios); |
| 147 | |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame^] | 148 | /* Prepare switch to DDR during the HS400 init sequence */ |
| 149 | int (*hs400_prepare_ddr)(struct mmc_host *host); |
| 150 | |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 151 | /* Prepare for switching from HS400 to HS200 */ |
| 152 | void (*hs400_downgrade)(struct mmc_host *host); |
| 153 | |
| 154 | /* Complete selection of HS400 */ |
| 155 | void (*hs400_complete)(struct mmc_host *host); |
| 156 | |
| 157 | /* Prepare enhanced strobe depending host driver */ |
| 158 | void (*hs400_enhanced_strobe)(struct mmc_host *host, |
| 159 | struct mmc_ios *ios); |
| 160 | int (*select_drive_strength)(struct mmc_card *card, |
| 161 | unsigned int max_dtr, int host_drv, |
| 162 | int card_drv, int *drv_type); |
| 163 | void (*hw_reset)(struct mmc_host *host); |
| 164 | void (*card_event)(struct mmc_host *host); |
| 165 | |
| 166 | /* |
| 167 | * Optional callback to support controllers with HW issues for multiple |
| 168 | * I/O. Returns the number of supported blocks for the request. |
| 169 | */ |
| 170 | int (*multi_io_quirk)(struct mmc_card *card, |
| 171 | unsigned int direction, int blk_size); |
| 172 | }; |
| 173 | |
| 174 | struct mmc_cqe_ops { |
| 175 | /* Allocate resources, and make the CQE operational */ |
| 176 | int (*cqe_enable)(struct mmc_host *host, struct mmc_card *card); |
| 177 | /* Free resources, and make the CQE non-operational */ |
| 178 | void (*cqe_disable)(struct mmc_host *host); |
| 179 | /* |
| 180 | * Issue a read, write or DCMD request to the CQE. Also deal with the |
| 181 | * effect of ->cqe_off(). |
| 182 | */ |
| 183 | int (*cqe_request)(struct mmc_host *host, struct mmc_request *mrq); |
| 184 | /* Free resources (e.g. DMA mapping) associated with the request */ |
| 185 | void (*cqe_post_req)(struct mmc_host *host, struct mmc_request *mrq); |
| 186 | /* |
| 187 | * Prepare the CQE and host controller to accept non-CQ commands. There |
| 188 | * is no corresponding ->cqe_on(), instead ->cqe_request() is required |
| 189 | * to deal with that. |
| 190 | */ |
| 191 | void (*cqe_off)(struct mmc_host *host); |
| 192 | /* |
| 193 | * Wait for all CQE tasks to complete. Return an error if recovery |
| 194 | * becomes necessary. |
| 195 | */ |
| 196 | int (*cqe_wait_for_idle)(struct mmc_host *host); |
| 197 | /* |
| 198 | * Notify CQE that a request has timed out. Return false if the request |
| 199 | * completed or true if a timeout happened in which case indicate if |
| 200 | * recovery is needed. |
| 201 | */ |
| 202 | bool (*cqe_timeout)(struct mmc_host *host, struct mmc_request *mrq, |
| 203 | bool *recovery_needed); |
| 204 | /* |
| 205 | * Stop all CQE activity and prepare the CQE and host controller to |
| 206 | * accept recovery commands. |
| 207 | */ |
| 208 | void (*cqe_recovery_start)(struct mmc_host *host); |
| 209 | /* |
| 210 | * Clear the queue and call mmc_cqe_request_done() on all requests. |
| 211 | * Requests that errored will have the error set on the mmc_request |
| 212 | * (data->error or cmd->error for DCMD). Requests that did not error |
| 213 | * will have zero data bytes transferred. |
| 214 | */ |
| 215 | void (*cqe_recovery_finish)(struct mmc_host *host); |
| 216 | }; |
| 217 | |
| 218 | struct mmc_async_req { |
| 219 | /* active mmc request */ |
| 220 | struct mmc_request *mrq; |
| 221 | /* |
| 222 | * Check error status of completed mmc request. |
| 223 | * Returns 0 if success otherwise non zero. |
| 224 | */ |
| 225 | enum mmc_blk_status (*err_check)(struct mmc_card *, struct mmc_async_req *); |
| 226 | }; |
| 227 | |
| 228 | /** |
| 229 | * struct mmc_slot - MMC slot functions |
| 230 | * |
| 231 | * @cd_irq: MMC/SD-card slot hotplug detection IRQ or -EINVAL |
| 232 | * @handler_priv: MMC/SD-card slot context |
| 233 | * |
| 234 | * Some MMC/SD host controllers implement slot-functions like card and |
| 235 | * write-protect detection natively. However, a large number of controllers |
| 236 | * leave these functions to the CPU. This struct provides a hook to attach |
| 237 | * such slot-function drivers. |
| 238 | */ |
| 239 | struct mmc_slot { |
| 240 | int cd_irq; |
| 241 | bool cd_wake_enabled; |
| 242 | void *handler_priv; |
| 243 | }; |
| 244 | |
| 245 | /** |
| 246 | * mmc_context_info - synchronization details for mmc context |
| 247 | * @is_done_rcv wake up reason was done request |
| 248 | * @is_new_req wake up reason was new request |
| 249 | * @is_waiting_last_req mmc context waiting for single running request |
| 250 | * @wait wait queue |
| 251 | */ |
| 252 | struct mmc_context_info { |
| 253 | bool is_done_rcv; |
| 254 | bool is_new_req; |
| 255 | bool is_waiting_last_req; |
| 256 | wait_queue_head_t wait; |
| 257 | }; |
| 258 | |
| 259 | struct regulator; |
| 260 | struct mmc_pwrseq; |
| 261 | |
| 262 | struct mmc_supply { |
| 263 | struct regulator *vmmc; /* Card power supply */ |
| 264 | struct regulator *vqmmc; /* Optional Vccq supply */ |
| 265 | }; |
| 266 | |
| 267 | struct mmc_ctx { |
| 268 | struct task_struct *task; |
| 269 | }; |
| 270 | |
| 271 | struct mmc_host { |
| 272 | struct device *parent; |
| 273 | struct device class_dev; |
| 274 | int index; |
| 275 | const struct mmc_host_ops *ops; |
| 276 | struct mmc_pwrseq *pwrseq; |
| 277 | unsigned int f_min; |
| 278 | unsigned int f_max; |
| 279 | unsigned int f_init; |
| 280 | u32 ocr_avail; |
| 281 | u32 ocr_avail_sdio; /* SDIO-specific OCR */ |
| 282 | u32 ocr_avail_sd; /* SD-specific OCR */ |
| 283 | u32 ocr_avail_mmc; /* MMC-specific OCR */ |
| 284 | #ifdef CONFIG_PM_SLEEP |
| 285 | struct notifier_block pm_notify; |
| 286 | #endif |
| 287 | u32 max_current_330; |
| 288 | u32 max_current_300; |
| 289 | u32 max_current_180; |
| 290 | |
| 291 | #define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */ |
| 292 | #define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */ |
| 293 | #define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */ |
| 294 | #define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */ |
| 295 | #define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */ |
| 296 | #define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */ |
| 297 | #define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */ |
| 298 | #define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */ |
| 299 | #define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */ |
| 300 | #define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */ |
| 301 | #define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */ |
| 302 | #define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */ |
| 303 | #define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */ |
| 304 | #define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */ |
| 305 | #define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */ |
| 306 | #define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */ |
| 307 | #define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */ |
| 308 | |
| 309 | u32 caps; /* Host capabilities */ |
| 310 | |
| 311 | #define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */ |
| 312 | #define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */ |
| 313 | #define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */ |
| 314 | #define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */ |
| 315 | #define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */ |
| 316 | #define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */ |
| 317 | #define MMC_CAP_8_BIT_DATA (1 << 6) /* Can the host do 8 bit transfers */ |
| 318 | #define MMC_CAP_AGGRESSIVE_PM (1 << 7) /* Suspend (e)MMC/SD at idle */ |
| 319 | #define MMC_CAP_NONREMOVABLE (1 << 8) /* Nonremovable e.g. eMMC */ |
| 320 | #define MMC_CAP_WAIT_WHILE_BUSY (1 << 9) /* Waits while card is busy */ |
| 321 | #define MMC_CAP_ERASE (1 << 10) /* Allow erase/trim commands */ |
| 322 | #define MMC_CAP_3_3V_DDR (1 << 11) /* Host supports eMMC DDR 3.3V */ |
| 323 | #define MMC_CAP_1_8V_DDR (1 << 12) /* Host supports eMMC DDR 1.8V */ |
| 324 | #define MMC_CAP_1_2V_DDR (1 << 13) /* Host supports eMMC DDR 1.2V */ |
| 325 | #define MMC_CAP_POWER_OFF_CARD (1 << 14) /* Can power off after boot */ |
| 326 | #define MMC_CAP_BUS_WIDTH_TEST (1 << 15) /* CMD14/CMD19 bus width ok */ |
| 327 | #define MMC_CAP_UHS_SDR12 (1 << 16) /* Host supports UHS SDR12 mode */ |
| 328 | #define MMC_CAP_UHS_SDR25 (1 << 17) /* Host supports UHS SDR25 mode */ |
| 329 | #define MMC_CAP_UHS_SDR50 (1 << 18) /* Host supports UHS SDR50 mode */ |
| 330 | #define MMC_CAP_UHS_SDR104 (1 << 19) /* Host supports UHS SDR104 mode */ |
| 331 | #define MMC_CAP_UHS_DDR50 (1 << 20) /* Host supports UHS DDR50 mode */ |
| 332 | #define MMC_CAP_UHS (MMC_CAP_UHS_SDR12 | MMC_CAP_UHS_SDR25 | \ |
| 333 | MMC_CAP_UHS_SDR50 | MMC_CAP_UHS_SDR104 | \ |
| 334 | MMC_CAP_UHS_DDR50) |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame^] | 335 | #define MMC_CAP_SYNC_RUNTIME_PM (1 << 21) /* Synced runtime PM suspends. */ |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 336 | #define MMC_CAP_DRIVER_TYPE_A (1 << 23) /* Host supports Driver Type A */ |
| 337 | #define MMC_CAP_DRIVER_TYPE_C (1 << 24) /* Host supports Driver Type C */ |
| 338 | #define MMC_CAP_DRIVER_TYPE_D (1 << 25) /* Host supports Driver Type D */ |
| 339 | #define MMC_CAP_DONE_COMPLETE (1 << 27) /* RW reqs can be completed within mmc_request_done() */ |
| 340 | #define MMC_CAP_CD_WAKE (1 << 28) /* Enable card detect wake */ |
| 341 | #define MMC_CAP_CMD_DURING_TFR (1 << 29) /* Commands during data transfer */ |
| 342 | #define MMC_CAP_CMD23 (1 << 30) /* CMD23 supported. */ |
| 343 | #define MMC_CAP_HW_RESET (1 << 31) /* Hardware reset */ |
| 344 | |
| 345 | u32 caps2; /* More host capabilities */ |
| 346 | |
| 347 | #define MMC_CAP2_BOOTPART_NOACC (1 << 0) /* Boot partition no access */ |
| 348 | #define MMC_CAP2_FULL_PWR_CYCLE (1 << 2) /* Can do full power cycle */ |
| 349 | #define MMC_CAP2_HS200_1_8V_SDR (1 << 5) /* can support */ |
| 350 | #define MMC_CAP2_HS200_1_2V_SDR (1 << 6) /* can support */ |
| 351 | #define MMC_CAP2_HS200 (MMC_CAP2_HS200_1_8V_SDR | \ |
| 352 | MMC_CAP2_HS200_1_2V_SDR) |
| 353 | #define MMC_CAP2_CD_ACTIVE_HIGH (1 << 10) /* Card-detect signal active high */ |
| 354 | #define MMC_CAP2_RO_ACTIVE_HIGH (1 << 11) /* Write-protect signal active high */ |
| 355 | #define MMC_CAP2_NO_PRESCAN_POWERUP (1 << 14) /* Don't power up before scan */ |
| 356 | #define MMC_CAP2_HS400_1_8V (1 << 15) /* Can support HS400 1.8V */ |
| 357 | #define MMC_CAP2_HS400_1_2V (1 << 16) /* Can support HS400 1.2V */ |
| 358 | #define MMC_CAP2_HS400 (MMC_CAP2_HS400_1_8V | \ |
| 359 | MMC_CAP2_HS400_1_2V) |
| 360 | #define MMC_CAP2_HSX00_1_8V (MMC_CAP2_HS200_1_8V_SDR | MMC_CAP2_HS400_1_8V) |
| 361 | #define MMC_CAP2_HSX00_1_2V (MMC_CAP2_HS200_1_2V_SDR | MMC_CAP2_HS400_1_2V) |
| 362 | #define MMC_CAP2_SDIO_IRQ_NOTHREAD (1 << 17) |
| 363 | #define MMC_CAP2_NO_WRITE_PROTECT (1 << 18) /* No physical write protect pin, assume that card is always read-write */ |
| 364 | #define MMC_CAP2_NO_SDIO (1 << 19) /* Do not send SDIO commands during initialization */ |
| 365 | #define MMC_CAP2_HS400_ES (1 << 20) /* Host supports enhanced strobe */ |
| 366 | #define MMC_CAP2_NO_SD (1 << 21) /* Do not send SD commands during initialization */ |
| 367 | #define MMC_CAP2_NO_MMC (1 << 22) /* Do not send (e)MMC commands during initialization */ |
| 368 | #define MMC_CAP2_CQE (1 << 23) /* Has eMMC command queue engine */ |
| 369 | #define MMC_CAP2_CQE_DCMD (1 << 24) /* CQE can issue a direct command */ |
| 370 | #define MMC_CAP2_AVOID_3_3V (1 << 25) /* Host must negotiate down from 3.3V */ |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame^] | 371 | #define MMC_CAP2_MERGE_CAPABLE (1 << 26) /* Host can merge a segment over the segment size */ |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 372 | |
| 373 | int fixed_drv_type; /* fixed driver type for non-removable media */ |
| 374 | |
| 375 | mmc_pm_flag_t pm_caps; /* supported pm features */ |
| 376 | |
| 377 | /* host specific block data */ |
| 378 | unsigned int max_seg_size; /* see blk_queue_max_segment_size */ |
| 379 | unsigned short max_segs; /* see blk_queue_max_segments */ |
| 380 | unsigned short unused; |
| 381 | unsigned int max_req_size; /* maximum number of bytes in one req */ |
| 382 | unsigned int max_blk_size; /* maximum size of one mmc block */ |
| 383 | unsigned int max_blk_count; /* maximum number of blocks in one req */ |
| 384 | unsigned int max_busy_timeout; /* max busy timeout in ms */ |
| 385 | |
| 386 | /* private data */ |
| 387 | spinlock_t lock; /* lock for claim and bus ops */ |
| 388 | |
| 389 | struct mmc_ios ios; /* current io bus settings */ |
| 390 | |
| 391 | /* group bitfields together to minimize padding */ |
| 392 | unsigned int use_spi_crc:1; |
| 393 | unsigned int claimed:1; /* host exclusively claimed */ |
| 394 | unsigned int bus_dead:1; /* bus has been released */ |
| 395 | unsigned int can_retune:1; /* re-tuning can be used */ |
| 396 | unsigned int doing_retune:1; /* re-tuning in progress */ |
| 397 | unsigned int retune_now:1; /* do re-tuning at next req */ |
| 398 | unsigned int retune_paused:1; /* re-tuning is temporarily disabled */ |
| 399 | unsigned int use_blk_mq:1; /* use blk-mq */ |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame^] | 400 | unsigned int retune_crc_disable:1; /* don't trigger retune upon crc */ |
| 401 | unsigned int can_dma_map_merge:1; /* merging can be used */ |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 402 | |
| 403 | int rescan_disable; /* disable card detection */ |
| 404 | int rescan_entered; /* used with nonremovable devices */ |
| 405 | |
| 406 | int need_retune; /* re-tuning is needed */ |
| 407 | int hold_retune; /* hold off re-tuning */ |
| 408 | unsigned int retune_period; /* re-tuning period in secs */ |
| 409 | struct timer_list retune_timer; /* for periodic re-tuning */ |
| 410 | |
| 411 | bool trigger_card_event; /* card_event necessary */ |
| 412 | |
| 413 | struct mmc_card *card; /* device attached to this host */ |
| 414 | |
| 415 | wait_queue_head_t wq; |
| 416 | struct mmc_ctx *claimer; /* context that has host claimed */ |
| 417 | int claim_cnt; /* "claim" nesting count */ |
| 418 | struct mmc_ctx default_ctx; /* default context */ |
| 419 | |
| 420 | struct delayed_work detect; |
| 421 | int detect_change; /* card detect flag */ |
| 422 | struct mmc_slot slot; |
| 423 | |
| 424 | const struct mmc_bus_ops *bus_ops; /* current bus driver */ |
| 425 | unsigned int bus_refs; /* reference counter */ |
| 426 | |
| 427 | unsigned int sdio_irqs; |
| 428 | struct task_struct *sdio_irq_thread; |
| 429 | struct delayed_work sdio_irq_work; |
| 430 | bool sdio_irq_pending; |
| 431 | atomic_t sdio_irq_thread_abort; |
| 432 | |
| 433 | mmc_pm_flag_t pm_flags; /* requested pm features */ |
| 434 | |
| 435 | struct led_trigger *led; /* activity led */ |
| 436 | |
| 437 | #ifdef CONFIG_REGULATOR |
| 438 | bool regulator_enabled; /* regulator state */ |
| 439 | #endif |
| 440 | struct mmc_supply supply; |
| 441 | |
| 442 | struct dentry *debugfs_root; |
| 443 | |
| 444 | /* Ongoing data transfer that allows commands during transfer */ |
| 445 | struct mmc_request *ongoing_mrq; |
| 446 | |
| 447 | #ifdef CONFIG_FAIL_MMC_REQUEST |
| 448 | struct fault_attr fail_mmc_request; |
| 449 | #endif |
| 450 | |
| 451 | unsigned int actual_clock; /* Actual HC clock rate */ |
| 452 | |
| 453 | unsigned int slotno; /* used for sdio acpi binding */ |
| 454 | |
| 455 | int dsr_req; /* DSR value is valid */ |
| 456 | u32 dsr; /* optional driver stage (DSR) value */ |
| 457 | |
| 458 | /* Command Queue Engine (CQE) support */ |
| 459 | const struct mmc_cqe_ops *cqe_ops; |
| 460 | void *cqe_private; |
| 461 | int cqe_qdepth; |
| 462 | bool cqe_enabled; |
| 463 | bool cqe_on; |
| 464 | |
| 465 | unsigned long private[0] ____cacheline_aligned; |
| 466 | }; |
| 467 | |
| 468 | struct device_node; |
| 469 | |
| 470 | struct mmc_host *mmc_alloc_host(int extra, struct device *); |
| 471 | int mmc_add_host(struct mmc_host *); |
| 472 | void mmc_remove_host(struct mmc_host *); |
| 473 | void mmc_free_host(struct mmc_host *); |
| 474 | int mmc_of_parse(struct mmc_host *host); |
| 475 | int mmc_of_parse_voltage(struct device_node *np, u32 *mask); |
| 476 | |
| 477 | static inline void *mmc_priv(struct mmc_host *host) |
| 478 | { |
| 479 | return (void *)host->private; |
| 480 | } |
| 481 | |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame^] | 482 | static inline struct mmc_host *mmc_from_priv(void *priv) |
| 483 | { |
| 484 | return container_of(priv, struct mmc_host, private); |
| 485 | } |
| 486 | |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 487 | #define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI) |
| 488 | |
| 489 | #define mmc_dev(x) ((x)->parent) |
| 490 | #define mmc_classdev(x) (&(x)->class_dev) |
| 491 | #define mmc_hostname(x) (dev_name(&(x)->class_dev)) |
| 492 | |
| 493 | void mmc_detect_change(struct mmc_host *, unsigned long delay); |
| 494 | void mmc_request_done(struct mmc_host *, struct mmc_request *); |
| 495 | void mmc_command_done(struct mmc_host *host, struct mmc_request *mrq); |
| 496 | |
| 497 | void mmc_cqe_request_done(struct mmc_host *host, struct mmc_request *mrq); |
| 498 | |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame^] | 499 | /* |
| 500 | * May be called from host driver's system/runtime suspend/resume callbacks, |
| 501 | * to know if SDIO IRQs has been claimed. |
| 502 | */ |
| 503 | static inline bool sdio_irq_claimed(struct mmc_host *host) |
| 504 | { |
| 505 | return host->sdio_irqs > 0; |
| 506 | } |
| 507 | |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 508 | static inline void mmc_signal_sdio_irq(struct mmc_host *host) |
| 509 | { |
| 510 | host->ops->enable_sdio_irq(host, 0); |
| 511 | host->sdio_irq_pending = true; |
| 512 | if (host->sdio_irq_thread) |
| 513 | wake_up_process(host->sdio_irq_thread); |
| 514 | } |
| 515 | |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 516 | void sdio_signal_irq(struct mmc_host *host); |
| 517 | |
| 518 | #ifdef CONFIG_REGULATOR |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 519 | int mmc_regulator_set_ocr(struct mmc_host *mmc, |
| 520 | struct regulator *supply, |
| 521 | unsigned short vdd_bit); |
| 522 | int mmc_regulator_set_vqmmc(struct mmc_host *mmc, struct mmc_ios *ios); |
| 523 | #else |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 524 | static inline int mmc_regulator_set_ocr(struct mmc_host *mmc, |
| 525 | struct regulator *supply, |
| 526 | unsigned short vdd_bit) |
| 527 | { |
| 528 | return 0; |
| 529 | } |
| 530 | |
| 531 | static inline int mmc_regulator_set_vqmmc(struct mmc_host *mmc, |
| 532 | struct mmc_ios *ios) |
| 533 | { |
| 534 | return -EINVAL; |
| 535 | } |
| 536 | #endif |
| 537 | |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 538 | int mmc_regulator_get_supply(struct mmc_host *mmc); |
| 539 | |
| 540 | static inline int mmc_card_is_removable(struct mmc_host *host) |
| 541 | { |
| 542 | return !(host->caps & MMC_CAP_NONREMOVABLE); |
| 543 | } |
| 544 | |
| 545 | static inline int mmc_card_keep_power(struct mmc_host *host) |
| 546 | { |
| 547 | return host->pm_flags & MMC_PM_KEEP_POWER; |
| 548 | } |
| 549 | |
| 550 | static inline int mmc_card_wake_sdio_irq(struct mmc_host *host) |
| 551 | { |
| 552 | return host->pm_flags & MMC_PM_WAKE_SDIO_IRQ; |
| 553 | } |
| 554 | |
| 555 | /* TODO: Move to private header */ |
| 556 | static inline int mmc_card_hs(struct mmc_card *card) |
| 557 | { |
| 558 | return card->host->ios.timing == MMC_TIMING_SD_HS || |
| 559 | card->host->ios.timing == MMC_TIMING_MMC_HS; |
| 560 | } |
| 561 | |
| 562 | /* TODO: Move to private header */ |
| 563 | static inline int mmc_card_uhs(struct mmc_card *card) |
| 564 | { |
| 565 | return card->host->ios.timing >= MMC_TIMING_UHS_SDR12 && |
| 566 | card->host->ios.timing <= MMC_TIMING_UHS_DDR50; |
| 567 | } |
| 568 | |
| 569 | void mmc_retune_timer_stop(struct mmc_host *host); |
| 570 | |
| 571 | static inline void mmc_retune_needed(struct mmc_host *host) |
| 572 | { |
| 573 | if (host->can_retune) |
| 574 | host->need_retune = 1; |
| 575 | } |
| 576 | |
| 577 | static inline bool mmc_can_retune(struct mmc_host *host) |
| 578 | { |
| 579 | return host->can_retune == 1; |
| 580 | } |
| 581 | |
David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame^] | 582 | static inline bool mmc_doing_retune(struct mmc_host *host) |
| 583 | { |
| 584 | return host->doing_retune == 1; |
| 585 | } |
| 586 | |
Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 587 | static inline enum dma_data_direction mmc_get_dma_dir(struct mmc_data *data) |
| 588 | { |
| 589 | return data->flags & MMC_DATA_WRITE ? DMA_TO_DEVICE : DMA_FROM_DEVICE; |
| 590 | } |
| 591 | |
| 592 | int mmc_send_tuning(struct mmc_host *host, u32 opcode, int *cmd_error); |
| 593 | int mmc_abort_tuning(struct mmc_host *host, u32 opcode); |
| 594 | |
| 595 | #endif /* LINUX_MMC_HOST_H */ |