1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * linux/drivers/mmc/core/core.h 4 * 5 * Copyright (C) 2003 Russell King, All Rights Reserved. 6 * Copyright 2007 Pierre Ossman 7 */ 8 #ifndef _MMC_CORE_CORE_H 9 #define _MMC_CORE_CORE_H 10 11 #include <linux/delay.h> 12 #include <linux/sched.h> 13 14 struct mmc_host; 15 struct mmc_card; 16 struct mmc_request; 17 18 #define MMC_CMD_RETRIES 3 19 20 struct mmc_bus_ops { 21 void (*remove)(struct mmc_host *); 22 void (*detect)(struct mmc_host *); 23 int (*pre_suspend)(struct mmc_host *); 24 int (*suspend)(struct mmc_host *); 25 int (*resume)(struct mmc_host *); 26 int (*runtime_suspend)(struct mmc_host *); 27 int (*runtime_resume)(struct mmc_host *); 28 int (*alive)(struct mmc_host *); 29 int (*shutdown)(struct mmc_host *); 30 int (*hw_reset)(struct mmc_host *); 31 int (*sw_reset)(struct mmc_host *); 32 bool (*cache_enabled)(struct mmc_host *); 33 int (*flush_cache)(struct mmc_host *); 34 }; 35 36 void mmc_attach_bus(struct mmc_host *host, const struct mmc_bus_ops *ops); 37 void mmc_detach_bus(struct mmc_host *host); 38 39 struct device_node *mmc_of_find_child_device(struct mmc_host *host, 40 unsigned func_num); 41 42 void mmc_init_erase(struct mmc_card *card); 43 44 void mmc_set_chip_select(struct mmc_host *host, int mode); 45 void mmc_set_clock(struct mmc_host *host, unsigned int hz); 46 void mmc_set_bus_mode(struct mmc_host *host, unsigned int mode); 47 void mmc_set_bus_width(struct mmc_host *host, unsigned int width); 48 u32 mmc_select_voltage(struct mmc_host *host, u32 ocr); 49 int mmc_set_uhs_voltage(struct mmc_host *host, u32 ocr); 50 int mmc_host_set_uhs_voltage(struct mmc_host *host); 51 int mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage); 52 void mmc_set_initial_signal_voltage(struct mmc_host *host); 53 void mmc_set_timing(struct mmc_host *host, unsigned int timing); 54 void mmc_set_driver_type(struct mmc_host *host, unsigned int drv_type); 55 int mmc_select_drive_strength(struct mmc_card *card, unsigned int max_dtr, 56 int card_drv_type, int *drv_type); 57 void mmc_power_up(struct mmc_host *host, u32 ocr); 58 void mmc_power_off(struct mmc_host *host); 59 void mmc_power_cycle(struct mmc_host *host, u32 ocr); 60 void mmc_set_initial_state(struct mmc_host *host); 61 u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max); 62 63 static inline void mmc_delay(unsigned int ms) 64 { 65 if (ms <= 20) 66 usleep_range(ms * 1000, ms * 1250); 67 else 68 msleep(ms); 69 } 70 71 void mmc_rescan(struct work_struct *work); 72 void mmc_start_host(struct mmc_host *host); 73 void mmc_stop_host(struct mmc_host *host); 74 75 void _mmc_detect_change(struct mmc_host *host, unsigned long delay, 76 bool cd_irq); 77 int _mmc_detect_card_removed(struct mmc_host *host); 78 int mmc_detect_card_removed(struct mmc_host *host); 79 80 int mmc_attach_mmc(struct mmc_host *host); 81 int mmc_attach_sd(struct mmc_host *host); 82 int mmc_attach_sdio(struct mmc_host *host); 83 84 /* Module parameters */ 85 extern bool use_spi_crc; 86 87 /* Debugfs information for hosts and cards */ 88 void mmc_add_host_debugfs(struct mmc_host *host); 89 void mmc_remove_host_debugfs(struct mmc_host *host); 90 91 void mmc_add_card_debugfs(struct mmc_card *card); 92 void mmc_remove_card_debugfs(struct mmc_card *card); 93 94 int mmc_execute_tuning(struct mmc_card *card); 95 int mmc_hs200_to_hs400(struct mmc_card *card); 96 int mmc_hs400_to_hs200(struct mmc_card *card); 97 98 void mmc_wait_for_req_done(struct mmc_host *host, struct mmc_request *mrq); 99 bool mmc_is_req_done(struct mmc_host *host, struct mmc_request *mrq); 100 101 int mmc_start_request(struct mmc_host *host, struct mmc_request *mrq); 102 103 int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr, 104 unsigned int arg); 105 int mmc_can_erase(struct mmc_card *card); 106 int mmc_can_trim(struct mmc_card *card); 107 int mmc_can_discard(struct mmc_card *card); 108 int mmc_can_sanitize(struct mmc_card *card); 109 int mmc_can_secure_erase_trim(struct mmc_card *card); 110 int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from, 111 unsigned int nr); 112 unsigned int mmc_calc_max_discard(struct mmc_card *card); 113 114 int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen); 115 116 int __mmc_claim_host(struct mmc_host *host, struct mmc_ctx *ctx, 117 atomic_t *abort); 118 void mmc_release_host(struct mmc_host *host); 119 void mmc_get_card(struct mmc_card *card, struct mmc_ctx *ctx); 120 void mmc_put_card(struct mmc_card *card, struct mmc_ctx *ctx); 121 122 /** 123 * mmc_claim_host - exclusively claim a host 124 * @host: mmc host to claim 125 * 126 * Claim a host for a set of operations. 127 */ 128 static inline void mmc_claim_host(struct mmc_host *host) 129 { 130 __mmc_claim_host(host, NULL, NULL); 131 } 132 133 int mmc_cqe_start_req(struct mmc_host *host, struct mmc_request *mrq); 134 void mmc_cqe_post_req(struct mmc_host *host, struct mmc_request *mrq); 135 int mmc_cqe_recovery(struct mmc_host *host); 136 137 /** 138 * mmc_pre_req - Prepare for a new request 139 * @host: MMC host to prepare command 140 * @mrq: MMC request to prepare for 141 * 142 * mmc_pre_req() is called in prior to mmc_start_req() to let 143 * host prepare for the new request. Preparation of a request may be 144 * performed while another request is running on the host. 145 */ 146 static inline void mmc_pre_req(struct mmc_host *host, struct mmc_request *mrq) 147 { 148 if (host->ops->pre_req) 149 host->ops->pre_req(host, mrq); 150 } 151 152 /** 153 * mmc_post_req - Post process a completed request 154 * @host: MMC host to post process command 155 * @mrq: MMC request to post process for 156 * @err: Error, if non zero, clean up any resources made in pre_req 157 * 158 * Let the host post process a completed request. Post processing of 159 * a request may be performed while another request is running. 160 */ 161 static inline void mmc_post_req(struct mmc_host *host, struct mmc_request *mrq, 162 int err) 163 { 164 if (host->ops->post_req) 165 host->ops->post_req(host, mrq, err); 166 } 167 168 static inline bool mmc_cache_enabled(struct mmc_host *host) 169 { 170 if (host->bus_ops->cache_enabled) 171 return host->bus_ops->cache_enabled(host); 172 173 return false; 174 } 175 176 static inline int mmc_flush_cache(struct mmc_host *host) 177 { 178 if (host->bus_ops->flush_cache) 179 return host->bus_ops->flush_cache(host); 180 181 return 0; 182 } 183 184 #endif 185