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 (*reset)(struct mmc_host *); 36 }; 37 38 void mmc_attach_bus(struct mmc_host *host, const struct mmc_bus_ops *ops); 39 void mmc_detach_bus(struct mmc_host *host); 40 41 struct device_node *mmc_of_find_child_device(struct mmc_host *host, 42 unsigned func_num); 43 44 void mmc_init_erase(struct mmc_card *card); 45 46 void mmc_set_chip_select(struct mmc_host *host, int mode); 47 void mmc_set_clock(struct mmc_host *host, unsigned int hz); 48 void mmc_set_bus_mode(struct mmc_host *host, unsigned int mode); 49 void mmc_set_bus_width(struct mmc_host *host, unsigned int width); 50 u32 mmc_select_voltage(struct mmc_host *host, u32 ocr); 51 int mmc_set_uhs_voltage(struct mmc_host *host, u32 ocr); 52 int mmc_host_set_uhs_voltage(struct mmc_host *host); 53 int mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage); 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 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 int _mmc_detect_card_removed(struct mmc_host *host); 76 int mmc_detect_card_removed(struct mmc_host *host); 77 78 int mmc_attach_mmc(struct mmc_host *host); 79 int mmc_attach_sd(struct mmc_host *host); 80 int mmc_attach_sdio(struct mmc_host *host); 81 82 /* Module parameters */ 83 extern bool use_spi_crc; 84 85 /* Debugfs information for hosts and cards */ 86 void mmc_add_host_debugfs(struct mmc_host *host); 87 void mmc_remove_host_debugfs(struct mmc_host *host); 88 89 void mmc_add_card_debugfs(struct mmc_card *card); 90 void mmc_remove_card_debugfs(struct mmc_card *card); 91 92 int mmc_execute_tuning(struct mmc_card *card); 93 int mmc_hs200_to_hs400(struct mmc_card *card); 94 int mmc_hs400_to_hs200(struct mmc_card *card); 95 96 #ifdef CONFIG_PM_SLEEP 97 void mmc_register_pm_notifier(struct mmc_host *host); 98 void mmc_unregister_pm_notifier(struct mmc_host *host); 99 #else 100 static inline void mmc_register_pm_notifier(struct mmc_host *host) { } 101 static inline void mmc_unregister_pm_notifier(struct mmc_host *host) { } 102 #endif 103 104 void mmc_wait_for_req_done(struct mmc_host *host, struct mmc_request *mrq); 105 bool mmc_is_req_done(struct mmc_host *host, struct mmc_request *mrq); 106 107 int mmc_start_request(struct mmc_host *host, struct mmc_request *mrq); 108 109 int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr, 110 unsigned int arg); 111 int mmc_can_erase(struct mmc_card *card); 112 int mmc_can_trim(struct mmc_card *card); 113 int mmc_can_discard(struct mmc_card *card); 114 int mmc_can_sanitize(struct mmc_card *card); 115 int mmc_can_secure_erase_trim(struct mmc_card *card); 116 int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from, 117 unsigned int nr); 118 unsigned int mmc_calc_max_discard(struct mmc_card *card); 119 120 int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen); 121 int mmc_set_blockcount(struct mmc_card *card, unsigned int blockcount, 122 bool is_rel_write); 123 124 int __mmc_claim_host(struct mmc_host *host, struct mmc_ctx *ctx, 125 atomic_t *abort); 126 void mmc_release_host(struct mmc_host *host); 127 void mmc_get_card(struct mmc_card *card, struct mmc_ctx *ctx); 128 void mmc_put_card(struct mmc_card *card, struct mmc_ctx *ctx); 129 130 /** 131 * mmc_claim_host - exclusively claim a host 132 * @host: mmc host to claim 133 * 134 * Claim a host for a set of operations. 135 */ 136 static inline void mmc_claim_host(struct mmc_host *host) 137 { 138 __mmc_claim_host(host, NULL, NULL); 139 } 140 141 int mmc_cqe_start_req(struct mmc_host *host, struct mmc_request *mrq); 142 void mmc_cqe_post_req(struct mmc_host *host, struct mmc_request *mrq); 143 int mmc_cqe_recovery(struct mmc_host *host); 144 145 /** 146 * mmc_pre_req - Prepare for a new request 147 * @host: MMC host to prepare command 148 * @mrq: MMC request to prepare for 149 * 150 * mmc_pre_req() is called in prior to mmc_start_req() to let 151 * host prepare for the new request. Preparation of a request may be 152 * performed while another request is running on the host. 153 */ 154 static inline void mmc_pre_req(struct mmc_host *host, struct mmc_request *mrq) 155 { 156 if (host->ops->pre_req) 157 host->ops->pre_req(host, mrq); 158 } 159 160 /** 161 * mmc_post_req - Post process a completed request 162 * @host: MMC host to post process command 163 * @mrq: MMC request to post process for 164 * @err: Error, if non zero, clean up any resources made in pre_req 165 * 166 * Let the host post process a completed request. Post processing of 167 * a request may be performed while another request is running. 168 */ 169 static inline void mmc_post_req(struct mmc_host *host, struct mmc_request *mrq, 170 int err) 171 { 172 if (host->ops->post_req) 173 host->ops->post_req(host, mrq, err); 174 } 175 176 #endif 177