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 int (*handle_undervoltage)(struct mmc_host *host); 35 }; 36 37 void mmc_attach_bus(struct mmc_host *host, const struct mmc_bus_ops *ops); 38 void mmc_detach_bus(struct mmc_host *host); 39 40 struct device_node *mmc_of_find_child_device(struct mmc_host *host, 41 unsigned func_num); 42 43 void mmc_init_erase(struct mmc_card *card); 44 45 void mmc_set_chip_select(struct mmc_host *host, int mode); 46 void mmc_set_clock(struct mmc_host *host, unsigned int hz); 47 void mmc_set_bus_mode(struct mmc_host *host, unsigned int mode); 48 void mmc_set_bus_width(struct mmc_host *host, unsigned int width); 49 u32 mmc_select_voltage(struct mmc_host *host, u32 ocr); 50 int mmc_set_uhs_voltage(struct mmc_host *host, u32 ocr); 51 int mmc_host_set_uhs_voltage(struct mmc_host *host); 52 int mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage); 53 void mmc_set_initial_signal_voltage(struct mmc_host *host); 54 void mmc_set_timing(struct mmc_host *host, unsigned int timing); 55 void mmc_set_driver_type(struct mmc_host *host, unsigned int drv_type); 56 int mmc_select_drive_strength(struct mmc_card *card, unsigned int max_dtr, 57 int card_drv_type, int *drv_type); 58 void mmc_power_up(struct mmc_host *host, u32 ocr); 59 void mmc_power_off(struct mmc_host *host); 60 void mmc_power_cycle(struct mmc_host *host, u32 ocr); 61 void mmc_set_initial_state(struct mmc_host *host); 62 u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max); 63 int mmc_handle_undervoltage(struct mmc_host *host); 64 void mmc_regulator_register_undervoltage_notifier(struct mmc_host *host); 65 void mmc_regulator_unregister_undervoltage_notifier(struct mmc_host *host); 66 void mmc_undervoltage_workfn(struct work_struct *work); 67 68 static inline void mmc_delay(unsigned int ms) 69 { 70 if (ms <= 20) 71 usleep_range(ms * 1000, ms * 1250); 72 else 73 msleep(ms); 74 } 75 76 static inline void mmc_delay_us(unsigned int us) 77 { 78 if (us == 0) 79 return; 80 81 fsleep(us); 82 } 83 84 void mmc_rescan(struct work_struct *work); 85 void mmc_start_host(struct mmc_host *host); 86 void __mmc_stop_host(struct mmc_host *host); 87 void mmc_stop_host(struct mmc_host *host); 88 89 void _mmc_detect_change(struct mmc_host *host, unsigned long delay, 90 bool cd_irq); 91 int _mmc_detect_card_removed(struct mmc_host *host); 92 int mmc_detect_card_removed(struct mmc_host *host); 93 94 int mmc_attach_mmc(struct mmc_host *host); 95 int mmc_attach_sd(struct mmc_host *host); 96 int mmc_attach_sdio(struct mmc_host *host); 97 int mmc_attach_sd_uhs2(struct mmc_host *host); 98 99 /* Module parameters */ 100 extern bool use_spi_crc; 101 102 /* Debugfs information for hosts and cards */ 103 #ifdef CONFIG_DEBUG_FS 104 void mmc_add_host_debugfs(struct mmc_host *host); 105 void mmc_remove_host_debugfs(struct mmc_host *host); 106 107 void mmc_add_card_debugfs(struct mmc_card *card); 108 void mmc_remove_card_debugfs(struct mmc_card *card); 109 #else 110 static inline void mmc_add_host_debugfs(struct mmc_host *host) 111 { 112 } 113 static inline void mmc_remove_host_debugfs(struct mmc_host *host) 114 { 115 } 116 static inline void mmc_add_card_debugfs(struct mmc_card *card) 117 { 118 } 119 static inline void mmc_remove_card_debugfs(struct mmc_card *card) 120 { 121 } 122 #endif 123 124 int mmc_execute_tuning(struct mmc_card *card); 125 int mmc_hs200_to_hs400(struct mmc_card *card); 126 int mmc_hs400_to_hs200(struct mmc_card *card); 127 128 void mmc_wait_for_req_done(struct mmc_host *host, struct mmc_request *mrq); 129 bool mmc_is_req_done(struct mmc_host *host, struct mmc_request *mrq); 130 131 int mmc_start_request(struct mmc_host *host, struct mmc_request *mrq); 132 133 int mmc_erase(struct mmc_card *card, sector_t from, unsigned int nr, unsigned int arg); 134 bool mmc_card_can_erase(struct mmc_card *card); 135 bool mmc_card_can_trim(struct mmc_card *card); 136 bool mmc_card_can_discard(struct mmc_card *card); 137 bool mmc_card_can_sanitize(struct mmc_card *card); 138 bool mmc_card_can_secure_erase_trim(struct mmc_card *card); 139 bool mmc_card_can_cmd23(struct mmc_card *card); 140 int mmc_erase_group_aligned(struct mmc_card *card, sector_t from, unsigned int nr); 141 unsigned int mmc_calc_max_discard(struct mmc_card *card); 142 143 int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen); 144 145 int __mmc_claim_host(struct mmc_host *host, struct mmc_ctx *ctx, 146 atomic_t *abort); 147 void mmc_release_host(struct mmc_host *host); 148 void mmc_get_card(struct mmc_card *card, struct mmc_ctx *ctx); 149 void mmc_put_card(struct mmc_card *card, struct mmc_ctx *ctx); 150 151 int mmc_card_alternative_gpt_sector(struct mmc_card *card, sector_t *sector); 152 153 /** 154 * mmc_claim_host - exclusively claim a host 155 * @host: mmc host to claim 156 * 157 * Claim a host for a set of operations. 158 */ 159 static inline void mmc_claim_host(struct mmc_host *host) 160 { 161 __mmc_claim_host(host, NULL, NULL); 162 } 163 164 int mmc_cqe_start_req(struct mmc_host *host, struct mmc_request *mrq); 165 void mmc_cqe_post_req(struct mmc_host *host, struct mmc_request *mrq); 166 int mmc_cqe_recovery(struct mmc_host *host); 167 168 /** 169 * mmc_pre_req - Prepare for a new request 170 * @host: MMC host to prepare command 171 * @mrq: MMC request to prepare for 172 * 173 * mmc_pre_req() is called in prior to mmc_start_request() to let 174 * host prepare for the new request. Preparation of a request may be 175 * performed while another request is running on the host. 176 */ 177 static inline void mmc_pre_req(struct mmc_host *host, struct mmc_request *mrq) 178 { 179 if (host->ops->pre_req) 180 host->ops->pre_req(host, mrq); 181 } 182 183 /** 184 * mmc_post_req - Post process a completed request 185 * @host: MMC host to post process command 186 * @mrq: MMC request to post process for 187 * @err: Error, if non zero, clean up any resources made in pre_req 188 * 189 * Let the host post process a completed request. Post processing of 190 * a request may be performed while another request is running. 191 */ 192 static inline void mmc_post_req(struct mmc_host *host, struct mmc_request *mrq, 193 int err) 194 { 195 if (host->ops->post_req) 196 host->ops->post_req(host, mrq, err); 197 } 198 199 static inline bool mmc_cache_enabled(struct mmc_host *host) 200 { 201 if (host->bus_ops->cache_enabled) 202 return host->bus_ops->cache_enabled(host); 203 204 return false; 205 } 206 207 static inline int mmc_flush_cache(struct mmc_host *host) 208 { 209 if (host->bus_ops->flush_cache) 210 return host->bus_ops->flush_cache(host); 211 212 return 0; 213 } 214 215 static inline unsigned int mmc_sector_div(sector_t dividend, u32 divisor) 216 { 217 return div_u64(dividend, divisor); 218 } 219 220 static inline unsigned int mmc_sector_mod(sector_t dividend, u32 divisor) 221 { 222 return sector_div(dividend, divisor); 223 } 224 225 #endif 226