13d0407baSopenharmony_ci/* SPDX-License-Identifier: GPL-2.0-only */ 23d0407baSopenharmony_ci/* 33d0407baSopenharmony_ci * linux/include/linux/mmc/host.h 43d0407baSopenharmony_ci * 53d0407baSopenharmony_ci * Host driver specific definitions. 63d0407baSopenharmony_ci */ 73d0407baSopenharmony_ci#ifndef LINUX_MMC_HOST_H 83d0407baSopenharmony_ci#define LINUX_MMC_HOST_H 93d0407baSopenharmony_ci 103d0407baSopenharmony_ci#include <linux/sched.h> 113d0407baSopenharmony_ci#include <linux/device.h> 123d0407baSopenharmony_ci#include <linux/fault-inject.h> 133d0407baSopenharmony_ci 143d0407baSopenharmony_ci#include <linux/mmc/core.h> 153d0407baSopenharmony_ci#include <linux/mmc/card.h> 163d0407baSopenharmony_ci#include <linux/mmc/pm.h> 173d0407baSopenharmony_ci#include <linux/dma-direction.h> 183d0407baSopenharmony_ci 193d0407baSopenharmony_cistruct mmc_ios { 203d0407baSopenharmony_ci unsigned int clock; /* clock rate */ 213d0407baSopenharmony_ci unsigned short vdd; 223d0407baSopenharmony_ci unsigned int power_delay_ms; /* waiting for stable power */ 233d0407baSopenharmony_ci 243d0407baSopenharmony_ci /* vdd stores the bit number of the selected voltage range from below. */ 253d0407baSopenharmony_ci 263d0407baSopenharmony_ci unsigned char bus_mode; /* command output mode */ 273d0407baSopenharmony_ci 283d0407baSopenharmony_ci#define MMC_BUSMODE_OPENDRAIN 1 293d0407baSopenharmony_ci#define MMC_BUSMODE_PUSHPULL 2 303d0407baSopenharmony_ci 313d0407baSopenharmony_ci unsigned char chip_select; /* SPI chip select */ 323d0407baSopenharmony_ci 333d0407baSopenharmony_ci#define MMC_CS_DONTCARE 0 343d0407baSopenharmony_ci#define MMC_CS_HIGH 1 353d0407baSopenharmony_ci#define MMC_CS_LOW 2 363d0407baSopenharmony_ci 373d0407baSopenharmony_ci unsigned char power_mode; /* power supply mode */ 383d0407baSopenharmony_ci 393d0407baSopenharmony_ci#define MMC_POWER_OFF 0 403d0407baSopenharmony_ci#define MMC_POWER_UP 1 413d0407baSopenharmony_ci#define MMC_POWER_ON 2 423d0407baSopenharmony_ci#define MMC_POWER_UNDEFINED 3 433d0407baSopenharmony_ci 443d0407baSopenharmony_ci unsigned char bus_width; /* data bus width */ 453d0407baSopenharmony_ci 463d0407baSopenharmony_ci#define MMC_BUS_WIDTH_1 0 473d0407baSopenharmony_ci#define MMC_BUS_WIDTH_4 2 483d0407baSopenharmony_ci#define MMC_BUS_WIDTH_8 3 493d0407baSopenharmony_ci 503d0407baSopenharmony_ci unsigned char timing; /* timing specification used */ 513d0407baSopenharmony_ci 523d0407baSopenharmony_ci#define MMC_TIMING_LEGACY 0 533d0407baSopenharmony_ci#define MMC_TIMING_MMC_HS 1 543d0407baSopenharmony_ci#define MMC_TIMING_SD_HS 2 553d0407baSopenharmony_ci#define MMC_TIMING_UHS_SDR12 3 563d0407baSopenharmony_ci#define MMC_TIMING_UHS_SDR25 4 573d0407baSopenharmony_ci#define MMC_TIMING_UHS_SDR50 5 583d0407baSopenharmony_ci#define MMC_TIMING_UHS_SDR104 6 593d0407baSopenharmony_ci#define MMC_TIMING_UHS_DDR50 7 603d0407baSopenharmony_ci#define MMC_TIMING_MMC_DDR52 8 613d0407baSopenharmony_ci#define MMC_TIMING_MMC_HS200 9 623d0407baSopenharmony_ci#define MMC_TIMING_MMC_HS400 10 633d0407baSopenharmony_ci 643d0407baSopenharmony_ci unsigned char signal_voltage; /* signalling voltage (1.8V or 3.3V) */ 653d0407baSopenharmony_ci 663d0407baSopenharmony_ci#define MMC_SIGNAL_VOLTAGE_330 0 673d0407baSopenharmony_ci#define MMC_SIGNAL_VOLTAGE_180 1 683d0407baSopenharmony_ci#define MMC_SIGNAL_VOLTAGE_120 2 693d0407baSopenharmony_ci 703d0407baSopenharmony_ci unsigned char drv_type; /* driver type (A, B, C, D) */ 713d0407baSopenharmony_ci 723d0407baSopenharmony_ci#define MMC_SET_DRIVER_TYPE_B 0 733d0407baSopenharmony_ci#define MMC_SET_DRIVER_TYPE_A 1 743d0407baSopenharmony_ci#define MMC_SET_DRIVER_TYPE_C 2 753d0407baSopenharmony_ci#define MMC_SET_DRIVER_TYPE_D 3 763d0407baSopenharmony_ci 773d0407baSopenharmony_ci bool enhanced_strobe; /* hs400es selection */ 783d0407baSopenharmony_ci}; 793d0407baSopenharmony_ci 803d0407baSopenharmony_cistruct mmc_host; 813d0407baSopenharmony_ci 823d0407baSopenharmony_cistruct mmc_host_ops { 833d0407baSopenharmony_ci /* 843d0407baSopenharmony_ci * It is optional for the host to implement pre_req and post_req in 853d0407baSopenharmony_ci * order to support double buffering of requests (prepare one 863d0407baSopenharmony_ci * request while another request is active). 873d0407baSopenharmony_ci * pre_req() must always be followed by a post_req(). 883d0407baSopenharmony_ci * To undo a call made to pre_req(), call post_req() with 893d0407baSopenharmony_ci * a nonzero err condition. 903d0407baSopenharmony_ci */ 913d0407baSopenharmony_ci void (*post_req)(struct mmc_host *host, struct mmc_request *req, int err); 923d0407baSopenharmony_ci void (*pre_req)(struct mmc_host *host, struct mmc_request *req); 933d0407baSopenharmony_ci void (*request)(struct mmc_host *host, struct mmc_request *req); 943d0407baSopenharmony_ci /* Submit one request to host in atomic context. */ 953d0407baSopenharmony_ci int (*request_atomic)(struct mmc_host *host, struct mmc_request *req); 963d0407baSopenharmony_ci 973d0407baSopenharmony_ci /* 983d0407baSopenharmony_ci * Avoid calling the next three functions too often or in a "fast 993d0407baSopenharmony_ci * path", since underlaying controller might implement them in an 1003d0407baSopenharmony_ci * expensive and/or slow way. Also note that these functions might 1013d0407baSopenharmony_ci * sleep, so don't call them in the atomic contexts! 1023d0407baSopenharmony_ci */ 1033d0407baSopenharmony_ci 1043d0407baSopenharmony_ci /* 1053d0407baSopenharmony_ci * Notes to the set_ios callback: 1063d0407baSopenharmony_ci * ios->clock might be 0. For some controllers, setting 0Hz 1073d0407baSopenharmony_ci * as any other frequency works. However, some controllers 1083d0407baSopenharmony_ci * explicitly need to disable the clock. Otherwise e.g. voltage 1093d0407baSopenharmony_ci * switching might fail because the SDCLK is not really quiet. 1103d0407baSopenharmony_ci */ 1113d0407baSopenharmony_ci void (*set_ios)(struct mmc_host *host, struct mmc_ios *ios); 1123d0407baSopenharmony_ci 1133d0407baSopenharmony_ci /* 1143d0407baSopenharmony_ci * Return values for the get_ro callback should be: 1153d0407baSopenharmony_ci * 0 for a read/write card 1163d0407baSopenharmony_ci * 1 for a read-only card 1173d0407baSopenharmony_ci * -ENOSYS when not supported (equal to NULL callback) 1183d0407baSopenharmony_ci * or a negative errno value when something bad happened 1193d0407baSopenharmony_ci */ 1203d0407baSopenharmony_ci int (*get_ro)(struct mmc_host *host); 1213d0407baSopenharmony_ci 1223d0407baSopenharmony_ci /* 1233d0407baSopenharmony_ci * Return values for the get_cd callback should be: 1243d0407baSopenharmony_ci * 0 for a absent card 1253d0407baSopenharmony_ci * 1 for a present card 1263d0407baSopenharmony_ci * -ENOSYS when not supported (equal to NULL callback) 1273d0407baSopenharmony_ci * or a negative errno value when something bad happened 1283d0407baSopenharmony_ci */ 1293d0407baSopenharmony_ci int (*get_cd)(struct mmc_host *host); 1303d0407baSopenharmony_ci 1313d0407baSopenharmony_ci void (*enable_sdio_irq)(struct mmc_host *host, int enable); 1323d0407baSopenharmony_ci /* Mandatory callback when using MMC_CAP2_SDIO_IRQ_NOTHREAD. */ 1333d0407baSopenharmony_ci void (*ack_sdio_irq)(struct mmc_host *host); 1343d0407baSopenharmony_ci 1353d0407baSopenharmony_ci /* optional callback for HC quirks */ 1363d0407baSopenharmony_ci void (*init_card)(struct mmc_host *host, struct mmc_card *card); 1373d0407baSopenharmony_ci 1383d0407baSopenharmony_ci int (*start_signal_voltage_switch)(struct mmc_host *host, struct mmc_ios *ios); 1393d0407baSopenharmony_ci 1403d0407baSopenharmony_ci /* Check if the card is pulling dat[0:3] low */ 1413d0407baSopenharmony_ci int (*card_busy)(struct mmc_host *host); 1423d0407baSopenharmony_ci int (*set_sdio_status)(struct mmc_host *host, int val); 1433d0407baSopenharmony_ci 1443d0407baSopenharmony_ci /* The tuning command opcode value is different for SD and eMMC cards */ 1453d0407baSopenharmony_ci int (*execute_tuning)(struct mmc_host *host, u32 opcode); 1463d0407baSopenharmony_ci 1473d0407baSopenharmony_ci /* Prepare HS400 target operating frequency depending host driver */ 1483d0407baSopenharmony_ci int (*prepare_hs400_tuning)(struct mmc_host *host, struct mmc_ios *ios); 1493d0407baSopenharmony_ci 1503d0407baSopenharmony_ci /* Prepare switch to DDR during the HS400 init sequence */ 1513d0407baSopenharmony_ci int (*hs400_prepare_ddr)(struct mmc_host *host); 1523d0407baSopenharmony_ci 1533d0407baSopenharmony_ci /* Prepare for switching from HS400 to HS200 */ 1543d0407baSopenharmony_ci void (*hs400_downgrade)(struct mmc_host *host); 1553d0407baSopenharmony_ci 1563d0407baSopenharmony_ci /* Complete selection of HS400 */ 1573d0407baSopenharmony_ci void (*hs400_complete)(struct mmc_host *host); 1583d0407baSopenharmony_ci 1593d0407baSopenharmony_ci /* Prepare enhanced strobe depending host driver */ 1603d0407baSopenharmony_ci void (*hs400_enhanced_strobe)(struct mmc_host *host, struct mmc_ios *ios); 1613d0407baSopenharmony_ci int (*select_drive_strength)(struct mmc_card *card, unsigned int max_dtr, int host_drv, int card_drv, 1623d0407baSopenharmony_ci int *drv_type); 1633d0407baSopenharmony_ci /* Reset the eMMC card via RST_n */ 1643d0407baSopenharmony_ci void (*hw_reset)(struct mmc_host *host); 1653d0407baSopenharmony_ci void (*card_event)(struct mmc_host *host); 1663d0407baSopenharmony_ci 1673d0407baSopenharmony_ci /* 1683d0407baSopenharmony_ci * Optional callback to support controllers with HW issues for multiple 1693d0407baSopenharmony_ci * I/O. Returns the number of supported blocks for the request. 1703d0407baSopenharmony_ci */ 1713d0407baSopenharmony_ci int (*multi_io_quirk)(struct mmc_card *card, unsigned int direction, int blk_size); 1723d0407baSopenharmony_ci}; 1733d0407baSopenharmony_ci 1743d0407baSopenharmony_cistruct mmc_cqe_ops { 1753d0407baSopenharmony_ci /* Allocate resources, and make the CQE operational */ 1763d0407baSopenharmony_ci int (*cqe_enable)(struct mmc_host *host, struct mmc_card *card); 1773d0407baSopenharmony_ci /* Free resources, and make the CQE non-operational */ 1783d0407baSopenharmony_ci void (*cqe_disable)(struct mmc_host *host); 1793d0407baSopenharmony_ci /* 1803d0407baSopenharmony_ci * Issue a read, write or DCMD request to the CQE. Also deal with the 1813d0407baSopenharmony_ci * effect of ->cqe_off(). 1823d0407baSopenharmony_ci */ 1833d0407baSopenharmony_ci int (*cqe_request)(struct mmc_host *host, struct mmc_request *mrq); 1843d0407baSopenharmony_ci /* Free resources (e.g. DMA mapping) associated with the request */ 1853d0407baSopenharmony_ci void (*cqe_post_req)(struct mmc_host *host, struct mmc_request *mrq); 1863d0407baSopenharmony_ci /* 1873d0407baSopenharmony_ci * Prepare the CQE and host controller to accept non-CQ commands. There 1883d0407baSopenharmony_ci * is no corresponding ->cqe_on(), instead ->cqe_request() is required 1893d0407baSopenharmony_ci * to deal with that. 1903d0407baSopenharmony_ci */ 1913d0407baSopenharmony_ci void (*cqe_off)(struct mmc_host *host); 1923d0407baSopenharmony_ci /* 1933d0407baSopenharmony_ci * Wait for all CQE tasks to complete. Return an error if recovery 1943d0407baSopenharmony_ci * becomes necessary. 1953d0407baSopenharmony_ci */ 1963d0407baSopenharmony_ci int (*cqe_wait_for_idle)(struct mmc_host *host); 1973d0407baSopenharmony_ci /* 1983d0407baSopenharmony_ci * Notify CQE that a request has timed out. Return false if the request 1993d0407baSopenharmony_ci * completed or true if a timeout happened in which case indicate if 2003d0407baSopenharmony_ci * recovery is needed. 2013d0407baSopenharmony_ci */ 2023d0407baSopenharmony_ci bool (*cqe_timeout)(struct mmc_host *host, struct mmc_request *mrq, bool *recovery_needed); 2033d0407baSopenharmony_ci /* 2043d0407baSopenharmony_ci * Stop all CQE activity and prepare the CQE and host controller to 2053d0407baSopenharmony_ci * accept recovery commands. 2063d0407baSopenharmony_ci */ 2073d0407baSopenharmony_ci void (*cqe_recovery_start)(struct mmc_host *host); 2083d0407baSopenharmony_ci /* 2093d0407baSopenharmony_ci * Clear the queue and call mmc_cqe_request_done() on all requests. 2103d0407baSopenharmony_ci * Requests that errored will have the error set on the mmc_request 2113d0407baSopenharmony_ci * (data->error or cmd->error for DCMD). Requests that did not error 2123d0407baSopenharmony_ci * will have zero data bytes transferred. 2133d0407baSopenharmony_ci */ 2143d0407baSopenharmony_ci void (*cqe_recovery_finish)(struct mmc_host *host); 2153d0407baSopenharmony_ci}; 2163d0407baSopenharmony_ci 2173d0407baSopenharmony_cistruct mmc_async_req { 2183d0407baSopenharmony_ci /* active mmc request */ 2193d0407baSopenharmony_ci struct mmc_request *mrq; 2203d0407baSopenharmony_ci /* 2213d0407baSopenharmony_ci * Check error status of completed mmc request. 2223d0407baSopenharmony_ci * Returns 0 if success otherwise non zero. 2233d0407baSopenharmony_ci */ 2243d0407baSopenharmony_ci enum mmc_blk_status (*err_check)(struct mmc_card *, struct mmc_async_req *); 2253d0407baSopenharmony_ci}; 2263d0407baSopenharmony_ci 2273d0407baSopenharmony_ci/** 2283d0407baSopenharmony_ci * struct mmc_slot - MMC slot functions 2293d0407baSopenharmony_ci * 2303d0407baSopenharmony_ci * @cd_irq: MMC/SD-card slot hotplug detection IRQ or -EINVAL 2313d0407baSopenharmony_ci * @handler_priv: MMC/SD-card slot context 2323d0407baSopenharmony_ci * 2333d0407baSopenharmony_ci * Some MMC/SD host controllers implement slot-functions like card and 2343d0407baSopenharmony_ci * write-protect detection natively. However, a large number of controllers 2353d0407baSopenharmony_ci * leave these functions to the CPU. This struct provides a hook to attach 2363d0407baSopenharmony_ci * such slot-function drivers. 2373d0407baSopenharmony_ci */ 2383d0407baSopenharmony_cistruct mmc_slot { 2393d0407baSopenharmony_ci int cd_irq; 2403d0407baSopenharmony_ci bool cd_wake_enabled; 2413d0407baSopenharmony_ci void *handler_priv; 2423d0407baSopenharmony_ci}; 2433d0407baSopenharmony_ci 2443d0407baSopenharmony_ci/** 2453d0407baSopenharmony_ci * mmc_context_info - synchronization details for mmc context 2463d0407baSopenharmony_ci * @is_done_rcv wake up reason was done request 2473d0407baSopenharmony_ci * @is_new_req wake up reason was new request 2483d0407baSopenharmony_ci * @is_waiting_last_req mmc context waiting for single running request 2493d0407baSopenharmony_ci * @wait wait queue 2503d0407baSopenharmony_ci */ 2513d0407baSopenharmony_cistruct mmc_context_info { 2523d0407baSopenharmony_ci bool is_done_rcv; 2533d0407baSopenharmony_ci bool is_new_req; 2543d0407baSopenharmony_ci bool is_waiting_last_req; 2553d0407baSopenharmony_ci wait_queue_head_t wait; 2563d0407baSopenharmony_ci}; 2573d0407baSopenharmony_ci 2583d0407baSopenharmony_cistruct regulator; 2593d0407baSopenharmony_cistruct mmc_pwrseq; 2603d0407baSopenharmony_ci 2613d0407baSopenharmony_cistruct mmc_supply { 2623d0407baSopenharmony_ci struct regulator *vmmc; /* Card power supply */ 2633d0407baSopenharmony_ci struct regulator *vqmmc; /* Optional Vccq supply */ 2643d0407baSopenharmony_ci}; 2653d0407baSopenharmony_ci 2663d0407baSopenharmony_cistruct mmc_ctx { 2673d0407baSopenharmony_ci struct task_struct *task; 2683d0407baSopenharmony_ci}; 2693d0407baSopenharmony_ci 2703d0407baSopenharmony_cistruct mmc_host { 2713d0407baSopenharmony_ci struct device *parent; 2723d0407baSopenharmony_ci struct device class_dev; 2733d0407baSopenharmony_ci int index; 2743d0407baSopenharmony_ci const struct mmc_host_ops *ops; 2753d0407baSopenharmony_ci struct mmc_pwrseq *pwrseq; 2763d0407baSopenharmony_ci unsigned int f_min; 2773d0407baSopenharmony_ci unsigned int f_max; 2783d0407baSopenharmony_ci unsigned int f_init; 2793d0407baSopenharmony_ci u32 ocr_avail; 2803d0407baSopenharmony_ci u32 ocr_avail_sdio; /* SDIO-specific OCR */ 2813d0407baSopenharmony_ci u32 ocr_avail_sd; /* SD-specific OCR */ 2823d0407baSopenharmony_ci u32 ocr_avail_mmc; /* MMC-specific OCR */ 2833d0407baSopenharmony_ci struct wakeup_source *ws; /* Enable consume of uevents */ 2843d0407baSopenharmony_ci u32 max_current_330; 2853d0407baSopenharmony_ci u32 max_current_300; 2863d0407baSopenharmony_ci u32 max_current_180; 2873d0407baSopenharmony_ci 2883d0407baSopenharmony_ci#define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */ 2893d0407baSopenharmony_ci#define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */ 2903d0407baSopenharmony_ci#define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */ 2913d0407baSopenharmony_ci#define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */ 2923d0407baSopenharmony_ci#define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */ 2933d0407baSopenharmony_ci#define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */ 2943d0407baSopenharmony_ci#define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */ 2953d0407baSopenharmony_ci#define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */ 2963d0407baSopenharmony_ci#define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */ 2973d0407baSopenharmony_ci#define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */ 2983d0407baSopenharmony_ci#define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */ 2993d0407baSopenharmony_ci#define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */ 3003d0407baSopenharmony_ci#define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */ 3013d0407baSopenharmony_ci#define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */ 3023d0407baSopenharmony_ci#define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */ 3033d0407baSopenharmony_ci#define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */ 3043d0407baSopenharmony_ci#define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */ 3053d0407baSopenharmony_ci 3063d0407baSopenharmony_ci u32 caps; /* Host capabilities */ 3073d0407baSopenharmony_ci 3083d0407baSopenharmony_ci#define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */ 3093d0407baSopenharmony_ci#define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */ 3103d0407baSopenharmony_ci#define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */ 3113d0407baSopenharmony_ci#define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */ 3123d0407baSopenharmony_ci#define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */ 3133d0407baSopenharmony_ci#define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */ 3143d0407baSopenharmony_ci#define MMC_CAP_8_BIT_DATA (1 << 6) /* Can the host do 8 bit transfers */ 3153d0407baSopenharmony_ci#define MMC_CAP_AGGRESSIVE_PM (1 << 7) /* Suspend (e)MMC/SD at idle */ 3163d0407baSopenharmony_ci#define MMC_CAP_NONREMOVABLE (1 << 8) /* Nonremovable e.g. eMMC */ 3173d0407baSopenharmony_ci#define MMC_CAP_WAIT_WHILE_BUSY (1 << 9) /* Waits while card is busy */ 3183d0407baSopenharmony_ci#define MMC_CAP_3_3V_DDR (1 << 11) /* Host supports eMMC DDR 3.3V */ 3193d0407baSopenharmony_ci#define MMC_CAP_1_8V_DDR (1 << 12) /* Host supports eMMC DDR 1.8V */ 3203d0407baSopenharmony_ci#define MMC_CAP_1_2V_DDR (1 << 13) /* Host supports eMMC DDR 1.2V */ 3213d0407baSopenharmony_ci#define MMC_CAP_DDR (MMC_CAP_3_3V_DDR | MMC_CAP_1_8V_DDR | MMC_CAP_1_2V_DDR) 3223d0407baSopenharmony_ci#define MMC_CAP_POWER_OFF_CARD (1 << 14) /* Can power off after boot */ 3233d0407baSopenharmony_ci#define MMC_CAP_BUS_WIDTH_TEST (1 << 15) /* CMD14/CMD19 bus width ok */ 3243d0407baSopenharmony_ci#define MMC_CAP_UHS_SDR12 (1 << 16) /* Host supports UHS SDR12 mode */ 3253d0407baSopenharmony_ci#define MMC_CAP_UHS_SDR25 (1 << 17) /* Host supports UHS SDR25 mode */ 3263d0407baSopenharmony_ci#define MMC_CAP_UHS_SDR50 (1 << 18) /* Host supports UHS SDR50 mode */ 3273d0407baSopenharmony_ci#define MMC_CAP_UHS_SDR104 (1 << 19) /* Host supports UHS SDR104 mode */ 3283d0407baSopenharmony_ci#define MMC_CAP_UHS_DDR50 (1 << 20) /* Host supports UHS DDR50 mode */ 3293d0407baSopenharmony_ci#define MMC_CAP_UHS (MMC_CAP_UHS_SDR12 | MMC_CAP_UHS_SDR25 | MMC_CAP_UHS_SDR50 | MMC_CAP_UHS_SDR104 | MMC_CAP_UHS_DDR50) 3303d0407baSopenharmony_ci#define MMC_CAP_SYNC_RUNTIME_PM (1 << 21) /* Synced runtime PM suspends. */ 3313d0407baSopenharmony_ci#define MMC_CAP_NEED_RSP_BUSY (1 << 22) /* Commands with R1B can't use R1. */ 3323d0407baSopenharmony_ci#define MMC_CAP_DRIVER_TYPE_A (1 << 23) /* Host supports Driver Type A */ 3333d0407baSopenharmony_ci#define MMC_CAP_DRIVER_TYPE_C (1 << 24) /* Host supports Driver Type C */ 3343d0407baSopenharmony_ci#define MMC_CAP_DRIVER_TYPE_D (1 << 25) /* Host supports Driver Type D */ 3353d0407baSopenharmony_ci#define MMC_CAP_DONE_COMPLETE (1 << 27) /* RW reqs can be completed within mmc_request_done() */ 3363d0407baSopenharmony_ci#define MMC_CAP_CD_WAKE (1 << 28) /* Enable card detect wake */ 3373d0407baSopenharmony_ci#define MMC_CAP_CMD_DURING_TFR (1 << 29) /* Commands during data transfer */ 3383d0407baSopenharmony_ci#define MMC_CAP_CMD23 (1 << 30) /* CMD23 supported. */ 3393d0407baSopenharmony_ci#define MMC_CAP_HW_RESET (1 << 31) /* Reset the eMMC card via RST_n */ 3403d0407baSopenharmony_ci 3413d0407baSopenharmony_ci u32 caps2; /* More host capabilities */ 3423d0407baSopenharmony_ci 3433d0407baSopenharmony_ci#define MMC_CAP2_BOOTPART_NOACC (1 << 0) /* Boot partition no access */ 3443d0407baSopenharmony_ci#define MMC_CAP2_FULL_PWR_CYCLE (1 << 2) /* Can do full power cycle */ 3453d0407baSopenharmony_ci#define MMC_CAP2_FULL_PWR_CYCLE_IN_SUSPEND (1 << 3) /* Can do full power cycle in suspend */ 3463d0407baSopenharmony_ci#define MMC_CAP2_HS200_1_8V_SDR (1 << 5) /* can support */ 3473d0407baSopenharmony_ci#define MMC_CAP2_HS200_1_2V_SDR (1 << 6) /* can support */ 3483d0407baSopenharmony_ci#define MMC_CAP2_HS200 (MMC_CAP2_HS200_1_8V_SDR | MMC_CAP2_HS200_1_2V_SDR) 3493d0407baSopenharmony_ci#define MMC_CAP2_CD_ACTIVE_HIGH (1 << 10) /* Card-detect signal active high */ 3503d0407baSopenharmony_ci#define MMC_CAP2_RO_ACTIVE_HIGH (1 << 11) /* Write-protect signal active high */ 3513d0407baSopenharmony_ci#define MMC_CAP2_NO_PRESCAN_POWERUP (1 << 14) /* Don't power up before scan */ 3523d0407baSopenharmony_ci#define MMC_CAP2_HS400_1_8V (1 << 15) /* Can support HS400 1.8V */ 3533d0407baSopenharmony_ci#define MMC_CAP2_HS400_1_2V (1 << 16) /* Can support HS400 1.2V */ 3543d0407baSopenharmony_ci#define MMC_CAP2_HS400 (MMC_CAP2_HS400_1_8V | MMC_CAP2_HS400_1_2V) 3553d0407baSopenharmony_ci#define MMC_CAP2_HSX00_1_8V (MMC_CAP2_HS200_1_8V_SDR | MMC_CAP2_HS400_1_8V) 3563d0407baSopenharmony_ci#define MMC_CAP2_HSX00_1_2V (MMC_CAP2_HS200_1_2V_SDR | MMC_CAP2_HS400_1_2V) 3573d0407baSopenharmony_ci#define MMC_CAP2_SDIO_IRQ_NOTHREAD (1 << 17) 3583d0407baSopenharmony_ci#define MMC_CAP2_NO_WRITE_PROTECT (1 << 18) /* No physical write protect pin, assume that card is always read-write */ 3593d0407baSopenharmony_ci#define MMC_CAP2_NO_SDIO (1 << 19) /* Do not send SDIO commands during initialization */ 3603d0407baSopenharmony_ci#define MMC_CAP2_HS400_ES (1 << 20) /* Host supports enhanced strobe */ 3613d0407baSopenharmony_ci#define MMC_CAP2_NO_SD (1 << 21) /* Do not send SD commands during initialization */ 3623d0407baSopenharmony_ci#define MMC_CAP2_NO_MMC (1 << 22) /* Do not send (e)MMC commands during initialization */ 3633d0407baSopenharmony_ci#define MMC_CAP2_CQE (1 << 23) /* Has eMMC command queue engine */ 3643d0407baSopenharmony_ci#define MMC_CAP2_CQE_DCMD (1 << 24) /* CQE can issue a direct command */ 3653d0407baSopenharmony_ci#define MMC_CAP2_AVOID_3_3V (1 << 25) /* Host must negotiate down from 3.3V */ 3663d0407baSopenharmony_ci#define MMC_CAP2_MERGE_CAPABLE (1 << 26) /* Host can merge a segment over the segment size */ 3673d0407baSopenharmony_ci 3683d0407baSopenharmony_ci int fixed_drv_type; /* fixed driver type for non-removable media */ 3693d0407baSopenharmony_ci 3703d0407baSopenharmony_ci mmc_pm_flag_t pm_caps; /* supported pm features */ 3713d0407baSopenharmony_ci 3723d0407baSopenharmony_ci /* host specific block data */ 3733d0407baSopenharmony_ci unsigned int max_seg_size; /* see blk_queue_max_segment_size */ 3743d0407baSopenharmony_ci unsigned short max_segs; /* see blk_queue_max_segments */ 3753d0407baSopenharmony_ci unsigned short unused; 3763d0407baSopenharmony_ci unsigned int max_req_size; /* maximum number of bytes in one req */ 3773d0407baSopenharmony_ci unsigned int max_blk_size; /* maximum size of one mmc block */ 3783d0407baSopenharmony_ci unsigned int max_blk_count; /* maximum number of blocks in one req */ 3793d0407baSopenharmony_ci unsigned int max_busy_timeout; /* max busy timeout in ms */ 3803d0407baSopenharmony_ci 3813d0407baSopenharmony_ci /* private data */ 3823d0407baSopenharmony_ci spinlock_t lock; /* lock for claim and bus ops */ 3833d0407baSopenharmony_ci 3843d0407baSopenharmony_ci struct mmc_ios ios; /* current io bus settings */ 3853d0407baSopenharmony_ci 3863d0407baSopenharmony_ci /* group bitfields together to minimize padding */ 3873d0407baSopenharmony_ci unsigned int use_spi_crc : 1; 3883d0407baSopenharmony_ci unsigned int claimed : 1; /* host exclusively claimed */ 3893d0407baSopenharmony_ci unsigned int bus_dead : 1; /* bus has been released */ 3903d0407baSopenharmony_ci unsigned int doing_init_tune : 1; /* initial tuning in progress */ 3913d0407baSopenharmony_ci unsigned int can_retune : 1; /* re-tuning can be used */ 3923d0407baSopenharmony_ci unsigned int doing_retune : 1; /* re-tuning in progress */ 3933d0407baSopenharmony_ci unsigned int retune_now : 1; /* do re-tuning at next req */ 3943d0407baSopenharmony_ci unsigned int retune_paused : 1; /* re-tuning is temporarily disabled */ 3953d0407baSopenharmony_ci unsigned int use_blk_mq : 1; /* use blk-mq */ 3963d0407baSopenharmony_ci unsigned int retune_crc_disable : 1; /* don't trigger retune upon crc */ 3973d0407baSopenharmony_ci unsigned int can_dma_map_merge : 1; /* merging can be used */ 3983d0407baSopenharmony_ci 3993d0407baSopenharmony_ci int rescan_disable; /* disable card detection */ 4003d0407baSopenharmony_ci int rescan_entered; /* used with nonremovable devices */ 4013d0407baSopenharmony_ci 4023d0407baSopenharmony_ci int need_retune; /* re-tuning is needed */ 4033d0407baSopenharmony_ci int hold_retune; /* hold off re-tuning */ 4043d0407baSopenharmony_ci unsigned int retune_period; /* re-tuning period in secs */ 4053d0407baSopenharmony_ci struct timer_list retune_timer; /* for periodic re-tuning */ 4063d0407baSopenharmony_ci 4073d0407baSopenharmony_ci bool trigger_card_event; /* card_event necessary */ 4083d0407baSopenharmony_ci 4093d0407baSopenharmony_ci struct mmc_card *card; /* device attached to this host */ 4103d0407baSopenharmony_ci 4113d0407baSopenharmony_ci wait_queue_head_t wq; 4123d0407baSopenharmony_ci struct mmc_ctx *claimer; /* context that has host claimed */ 4133d0407baSopenharmony_ci int claim_cnt; /* "claim" nesting count */ 4143d0407baSopenharmony_ci struct mmc_ctx default_ctx; /* default context */ 4153d0407baSopenharmony_ci 4163d0407baSopenharmony_ci struct delayed_work detect; 4173d0407baSopenharmony_ci int detect_change; /* card detect flag */ 4183d0407baSopenharmony_ci struct mmc_slot slot; 4193d0407baSopenharmony_ci 4203d0407baSopenharmony_ci const struct mmc_bus_ops *bus_ops; /* current bus driver */ 4213d0407baSopenharmony_ci unsigned int bus_refs; /* reference counter */ 4223d0407baSopenharmony_ci 4233d0407baSopenharmony_ci unsigned int sdio_irqs; 4243d0407baSopenharmony_ci struct task_struct *sdio_irq_thread; 4253d0407baSopenharmony_ci struct delayed_work sdio_irq_work; 4263d0407baSopenharmony_ci bool sdio_irq_pending; 4273d0407baSopenharmony_ci atomic_t sdio_irq_thread_abort; 4283d0407baSopenharmony_ci 4293d0407baSopenharmony_ci mmc_pm_flag_t pm_flags; /* requested pm features */ 4303d0407baSopenharmony_ci 4313d0407baSopenharmony_ci struct led_trigger *led; /* activity led */ 4323d0407baSopenharmony_ci 4333d0407baSopenharmony_ci#ifdef CONFIG_REGULATOR 4343d0407baSopenharmony_ci bool regulator_enabled; /* regulator state */ 4353d0407baSopenharmony_ci#endif 4363d0407baSopenharmony_ci struct mmc_supply supply; 4373d0407baSopenharmony_ci 4383d0407baSopenharmony_ci struct dentry *debugfs_root; 4393d0407baSopenharmony_ci 4403d0407baSopenharmony_ci /* Ongoing data transfer that allows commands during transfer */ 4413d0407baSopenharmony_ci struct mmc_request *ongoing_mrq; 4423d0407baSopenharmony_ci 4433d0407baSopenharmony_ci#ifdef CONFIG_FAIL_MMC_REQUEST 4443d0407baSopenharmony_ci struct fault_attr fail_mmc_request; 4453d0407baSopenharmony_ci#endif 4463d0407baSopenharmony_ci 4473d0407baSopenharmony_ci unsigned int actual_clock; /* Actual HC clock rate */ 4483d0407baSopenharmony_ci 4493d0407baSopenharmony_ci unsigned int slotno; /* used for sdio acpi binding */ 4503d0407baSopenharmony_ci 4513d0407baSopenharmony_ci int dsr_req; /* DSR value is valid */ 4523d0407baSopenharmony_ci u32 dsr; /* optional driver stage (DSR) value */ 4533d0407baSopenharmony_ci 4543d0407baSopenharmony_ci /* Command Queue Engine (CQE) support */ 4553d0407baSopenharmony_ci const struct mmc_cqe_ops *cqe_ops; 4563d0407baSopenharmony_ci void *cqe_private; 4573d0407baSopenharmony_ci int cqe_qdepth; 4583d0407baSopenharmony_ci bool cqe_enabled; 4593d0407baSopenharmony_ci bool cqe_on; 4603d0407baSopenharmony_ci 4613d0407baSopenharmony_ci /* Host Software Queue support */ 4623d0407baSopenharmony_ci bool hsq_enabled; 4633d0407baSopenharmony_ci 4643d0407baSopenharmony_ci unsigned long private[] ____cacheline_aligned; 4653d0407baSopenharmony_ci}; 4663d0407baSopenharmony_ci 4673d0407baSopenharmony_cistruct device_node; 4683d0407baSopenharmony_ci 4693d0407baSopenharmony_cistruct mmc_host *mmc_alloc_host(int extra, struct device *); 4703d0407baSopenharmony_ciint mmc_add_host(struct mmc_host *); 4713d0407baSopenharmony_civoid mmc_remove_host(struct mmc_host *); 4723d0407baSopenharmony_civoid mmc_free_host(struct mmc_host *); 4733d0407baSopenharmony_ciint mmc_of_parse(struct mmc_host *host); 4743d0407baSopenharmony_ciint mmc_of_parse_voltage(struct device_node *np, u32 *mask); 4753d0407baSopenharmony_ci 4763d0407baSopenharmony_ciextern struct mmc_host *primary_sdio_host; 4773d0407baSopenharmony_ciint mmc_host_rescan(struct mmc_host *host, int val, int is_cap_sdio_irq); 4783d0407baSopenharmony_ci 4793d0407baSopenharmony_cistatic inline void *mmc_priv(struct mmc_host *host) 4803d0407baSopenharmony_ci{ 4813d0407baSopenharmony_ci return (void *)host->private; 4823d0407baSopenharmony_ci} 4833d0407baSopenharmony_ci 4843d0407baSopenharmony_cistatic inline struct mmc_host *mmc_from_priv(void *priv) 4853d0407baSopenharmony_ci{ 4863d0407baSopenharmony_ci return container_of(priv, struct mmc_host, private); 4873d0407baSopenharmony_ci} 4883d0407baSopenharmony_ci 4893d0407baSopenharmony_ci#define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI) 4903d0407baSopenharmony_ci 4913d0407baSopenharmony_ci#define mmc_dev(x) ((x)->parent) 4923d0407baSopenharmony_ci#define mmc_classdev(x) (&(x)->class_dev) 4933d0407baSopenharmony_ci#define mmc_hostname(x) (dev_name(&(x)->class_dev)) 4943d0407baSopenharmony_ci 4953d0407baSopenharmony_civoid mmc_detect_change(struct mmc_host *, unsigned long delay); 4963d0407baSopenharmony_civoid mmc_request_done(struct mmc_host *, struct mmc_request *); 4973d0407baSopenharmony_civoid mmc_command_done(struct mmc_host *host, struct mmc_request *mrq); 4983d0407baSopenharmony_ci 4993d0407baSopenharmony_civoid mmc_cqe_request_done(struct mmc_host *host, struct mmc_request *mrq); 5003d0407baSopenharmony_ci 5013d0407baSopenharmony_ci/* 5023d0407baSopenharmony_ci * May be called from host driver's system/runtime suspend/resume callbacks, 5033d0407baSopenharmony_ci * to know if SDIO IRQs has been claimed. 5043d0407baSopenharmony_ci */ 5053d0407baSopenharmony_cistatic inline bool sdio_irq_claimed(struct mmc_host *host) 5063d0407baSopenharmony_ci{ 5073d0407baSopenharmony_ci return host->sdio_irqs > 0; 5083d0407baSopenharmony_ci} 5093d0407baSopenharmony_ci 5103d0407baSopenharmony_cistatic inline void mmc_signal_sdio_irq(struct mmc_host *host) 5113d0407baSopenharmony_ci{ 5123d0407baSopenharmony_ci host->ops->enable_sdio_irq(host, 0); 5133d0407baSopenharmony_ci host->sdio_irq_pending = true; 5143d0407baSopenharmony_ci if (host->sdio_irq_thread) { 5153d0407baSopenharmony_ci wake_up_process(host->sdio_irq_thread); 5163d0407baSopenharmony_ci } 5173d0407baSopenharmony_ci} 5183d0407baSopenharmony_ci 5193d0407baSopenharmony_civoid sdio_signal_irq(struct mmc_host *host); 5203d0407baSopenharmony_ci 5213d0407baSopenharmony_ci#ifdef CONFIG_REGULATOR 5223d0407baSopenharmony_ciint mmc_regulator_set_ocr(struct mmc_host *mmc, struct regulator *supply, unsigned short vdd_bit); 5233d0407baSopenharmony_ciint mmc_regulator_set_vqmmc(struct mmc_host *mmc, struct mmc_ios *ios); 5243d0407baSopenharmony_ci#else 5253d0407baSopenharmony_cistatic inline int mmc_regulator_set_ocr(struct mmc_host *mmc, struct regulator *supply, unsigned short vdd_bit) 5263d0407baSopenharmony_ci{ 5273d0407baSopenharmony_ci return 0; 5283d0407baSopenharmony_ci} 5293d0407baSopenharmony_ci 5303d0407baSopenharmony_cistatic inline int mmc_regulator_set_vqmmc(struct mmc_host *mmc, struct mmc_ios *ios) 5313d0407baSopenharmony_ci{ 5323d0407baSopenharmony_ci return -EINVAL; 5333d0407baSopenharmony_ci} 5343d0407baSopenharmony_ci#endif 5353d0407baSopenharmony_ci 5363d0407baSopenharmony_ciint mmc_regulator_get_supply(struct mmc_host *mmc); 5373d0407baSopenharmony_ci 5383d0407baSopenharmony_cistatic inline int mmc_card_is_removable(struct mmc_host *host) 5393d0407baSopenharmony_ci{ 5403d0407baSopenharmony_ci return !(host->caps & MMC_CAP_NONREMOVABLE); 5413d0407baSopenharmony_ci} 5423d0407baSopenharmony_ci 5433d0407baSopenharmony_cistatic inline int mmc_card_keep_power(struct mmc_host *host) 5443d0407baSopenharmony_ci{ 5453d0407baSopenharmony_ci return host->pm_flags & MMC_PM_KEEP_POWER; 5463d0407baSopenharmony_ci} 5473d0407baSopenharmony_ci 5483d0407baSopenharmony_cistatic inline int mmc_card_wake_sdio_irq(struct mmc_host *host) 5493d0407baSopenharmony_ci{ 5503d0407baSopenharmony_ci return host->pm_flags & MMC_PM_WAKE_SDIO_IRQ; 5513d0407baSopenharmony_ci} 5523d0407baSopenharmony_ci 5533d0407baSopenharmony_ci/* Move to private header */ 5543d0407baSopenharmony_cistatic inline int mmc_card_hs(struct mmc_card *card) 5553d0407baSopenharmony_ci{ 5563d0407baSopenharmony_ci return card->host->ios.timing == MMC_TIMING_SD_HS || card->host->ios.timing == MMC_TIMING_MMC_HS; 5573d0407baSopenharmony_ci} 5583d0407baSopenharmony_ci 5593d0407baSopenharmony_ci/* Move to private header */ 5603d0407baSopenharmony_cistatic inline int mmc_card_uhs(struct mmc_card *card) 5613d0407baSopenharmony_ci{ 5623d0407baSopenharmony_ci return card->host->ios.timing >= MMC_TIMING_UHS_SDR12 && card->host->ios.timing <= MMC_TIMING_UHS_DDR50; 5633d0407baSopenharmony_ci} 5643d0407baSopenharmony_ci 5653d0407baSopenharmony_civoid mmc_retune_timer_stop(struct mmc_host *host); 5663d0407baSopenharmony_ci 5673d0407baSopenharmony_cistatic inline void mmc_retune_needed(struct mmc_host *host) 5683d0407baSopenharmony_ci{ 5693d0407baSopenharmony_ci if (host->can_retune) { 5703d0407baSopenharmony_ci host->need_retune = 1; 5713d0407baSopenharmony_ci } 5723d0407baSopenharmony_ci} 5733d0407baSopenharmony_ci 5743d0407baSopenharmony_cistatic inline bool mmc_can_retune(struct mmc_host *host) 5753d0407baSopenharmony_ci{ 5763d0407baSopenharmony_ci return host->can_retune == 1; 5773d0407baSopenharmony_ci} 5783d0407baSopenharmony_ci 5793d0407baSopenharmony_cistatic inline bool mmc_doing_retune(struct mmc_host *host) 5803d0407baSopenharmony_ci{ 5813d0407baSopenharmony_ci return host->doing_retune == 1; 5823d0407baSopenharmony_ci} 5833d0407baSopenharmony_ci 5843d0407baSopenharmony_cistatic inline bool mmc_doing_tune(struct mmc_host *host) 5853d0407baSopenharmony_ci{ 5863d0407baSopenharmony_ci return host->doing_retune == 1 || host->doing_init_tune == 1; 5873d0407baSopenharmony_ci} 5883d0407baSopenharmony_ci 5893d0407baSopenharmony_cistatic inline enum dma_data_direction mmc_get_dma_dir(struct mmc_data *data) 5903d0407baSopenharmony_ci{ 5913d0407baSopenharmony_ci return data->flags & MMC_DATA_WRITE ? DMA_TO_DEVICE : DMA_FROM_DEVICE; 5923d0407baSopenharmony_ci} 5933d0407baSopenharmony_ci 5943d0407baSopenharmony_ciint mmc_send_tuning(struct mmc_host *host, u32 opcode, int *cmd_error); 5953d0407baSopenharmony_ciint mmc_abort_tuning(struct mmc_host *host, u32 opcode); 5963d0407baSopenharmony_ci 5973d0407baSopenharmony_ci#endif /* LINUX_MMC_HOST_H */ 598