1 /* 2 * linux/drivers/mmc/core/core.h 3 * 4 * Copyright (C) 2003 Russell King, All Rights Reserved. 5 * Copyright 2007 Pierre Ossman 6 * 7 * This program is free software; you can redistribute it and/or modify 8 * it under the terms of the GNU General Public License version 2 as 9 * published by the Free Software Foundation. 10 */ 11 #ifndef _MMC_CORE_CORE_H 12 #define _MMC_CORE_CORE_H 13 14 #include <linux/delay.h> 15 #include <linux/sched.h> 16 17 struct mmc_host; 18 struct mmc_card; 19 struct mmc_request; 20 21 #define MMC_CMD_RETRIES 3 22 23 struct mmc_bus_ops { 24 void (*remove)(struct mmc_host *); 25 void (*detect)(struct mmc_host *); 26 int (*pre_suspend)(struct mmc_host *); 27 int (*suspend)(struct mmc_host *); 28 int (*resume)(struct mmc_host *); 29 int (*runtime_suspend)(struct mmc_host *); 30 int (*runtime_resume)(struct mmc_host *); 31 int (*power_save)(struct mmc_host *); 32 int (*power_restore)(struct mmc_host *); 33 int (*alive)(struct mmc_host *); 34 int (*shutdown)(struct mmc_host *); 35 int (*hw_reset)(struct mmc_host *); 36 int (*sw_reset)(struct mmc_host *); 37 }; 38 39 void mmc_attach_bus(struct mmc_host *host, const struct mmc_bus_ops *ops); 40 void mmc_detach_bus(struct mmc_host *host); 41 42 struct device_node *mmc_of_find_child_device(struct mmc_host *host, 43 unsigned func_num); 44 45 void mmc_init_erase(struct mmc_card *card); 46 47 void mmc_set_chip_select(struct mmc_host *host, int mode); 48 void mmc_set_clock(struct mmc_host *host, unsigned int hz); 49 void mmc_set_bus_mode(struct mmc_host *host, unsigned int mode); 50 void mmc_set_bus_width(struct mmc_host *host, unsigned int width); 51 u32 mmc_select_voltage(struct mmc_host *host, u32 ocr); 52 int mmc_set_uhs_voltage(struct mmc_host *host, u32 ocr); 53 int mmc_host_set_uhs_voltage(struct mmc_host *host); 54 int mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage); 55 void mmc_set_initial_signal_voltage(struct mmc_host *host); 56 void mmc_set_timing(struct mmc_host *host, unsigned int timing); 57 void mmc_set_driver_type(struct mmc_host *host, unsigned int drv_type); 58 int mmc_select_drive_strength(struct mmc_card *card, unsigned int max_dtr, 59 int card_drv_type, int *drv_type); 60 void mmc_power_up(struct mmc_host *host, u32 ocr); 61 void mmc_power_off(struct mmc_host *host); 62 void mmc_power_cycle(struct mmc_host *host, u32 ocr); 63 void mmc_set_initial_state(struct mmc_host *host); 64 65 static inline void mmc_delay(unsigned int ms) 66 { 67 if (ms <= 20) 68 usleep_range(ms * 1000, ms * 1250); 69 else 70 msleep(ms); 71 } 72 73 void mmc_rescan(struct work_struct *work); 74 void mmc_start_host(struct mmc_host *host); 75 void mmc_stop_host(struct mmc_host *host); 76 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 #ifdef CONFIG_PM_SLEEP 99 void mmc_register_pm_notifier(struct mmc_host *host); 100 void mmc_unregister_pm_notifier(struct mmc_host *host); 101 #else 102 static inline void mmc_register_pm_notifier(struct mmc_host *host) { } 103 static inline void mmc_unregister_pm_notifier(struct mmc_host *host) { } 104 #endif 105 106 void mmc_wait_for_req_done(struct mmc_host *host, struct mmc_request *mrq); 107 bool mmc_is_req_done(struct mmc_host *host, struct mmc_request *mrq); 108 109 int mmc_start_request(struct mmc_host *host, struct mmc_request *mrq); 110 111 int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr, 112 unsigned int arg); 113 int mmc_can_erase(struct mmc_card *card); 114 int mmc_can_trim(struct mmc_card *card); 115 int mmc_can_discard(struct mmc_card *card); 116 int mmc_can_sanitize(struct mmc_card *card); 117 int mmc_can_secure_erase_trim(struct mmc_card *card); 118 int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from, 119 unsigned int nr); 120 unsigned int mmc_calc_max_discard(struct mmc_card *card); 121 122 int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen); 123 int mmc_set_blockcount(struct mmc_card *card, unsigned int blockcount, 124 bool is_rel_write); 125 126 int __mmc_claim_host(struct mmc_host *host, struct mmc_ctx *ctx, 127 atomic_t *abort); 128 void mmc_release_host(struct mmc_host *host); 129 void mmc_get_card(struct mmc_card *card, struct mmc_ctx *ctx); 130 void mmc_put_card(struct mmc_card *card, struct mmc_ctx *ctx); 131 132 /** 133 * mmc_claim_host - exclusively claim a host 134 * @host: mmc host to claim 135 * 136 * Claim a host for a set of operations. 137 */ 138 static inline void mmc_claim_host(struct mmc_host *host) 139 { 140 __mmc_claim_host(host, NULL, NULL); 141 } 142 143 int mmc_cqe_start_req(struct mmc_host *host, struct mmc_request *mrq); 144 void mmc_cqe_post_req(struct mmc_host *host, struct mmc_request *mrq); 145 int mmc_cqe_recovery(struct mmc_host *host); 146 147 /** 148 * mmc_pre_req - Prepare for a new request 149 * @host: MMC host to prepare command 150 * @mrq: MMC request to prepare for 151 * 152 * mmc_pre_req() is called in prior to mmc_start_req() to let 153 * host prepare for the new request. Preparation of a request may be 154 * performed while another request is running on the host. 155 */ 156 static inline void mmc_pre_req(struct mmc_host *host, struct mmc_request *mrq) 157 { 158 if (host->ops->pre_req) 159 host->ops->pre_req(host, mrq); 160 } 161 162 /** 163 * mmc_post_req - Post process a completed request 164 * @host: MMC host to post process command 165 * @mrq: MMC request to post process for 166 * @err: Error, if non zero, clean up any resources made in pre_req 167 * 168 * Let the host post process a completed request. Post processing of 169 * a request may be performed while another request is running. 170 */ 171 static inline void mmc_post_req(struct mmc_host *host, struct mmc_request *mrq, 172 int err) 173 { 174 if (host->ops->post_req) 175 host->ops->post_req(host, mrq, err); 176 } 177 178 #endif 179