drivers/mmc/core/core.h

   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 void mmc_stop_host(struct mmc_host *host);
  75
  76 void _mmc_detect_change(struct mmc_host *host, unsigned long delay,
  77                         bool cd_irq);
  78 int _mmc_detect_card_removed(struct mmc_host *host);
  79 int mmc_detect_card_removed(struct mmc_host *host);
  80
  81 int mmc_attach_mmc(struct mmc_host *host);
  82 int mmc_attach_sd(struct mmc_host *host);
  83 int mmc_attach_sdio(struct mmc_host *host);
  84 int mmc_attach_sd_uhs2(struct mmc_host *host);
  85
  86 /* Module parameters */
  87 extern bool use_spi_crc;
  88
  89 /* Debugfs information for hosts and cards */
  90 #ifdef CONFIG_DEBUG_FS
  91 void mmc_add_host_debugfs(struct mmc_host *host);
  92 void mmc_remove_host_debugfs(struct mmc_host *host);
  93
  94 void mmc_add_card_debugfs(struct mmc_card *card);
  95 void mmc_remove_card_debugfs(struct mmc_card *card);
  96 #else
  97 static inline void mmc_add_host_debugfs(struct mmc_host *host)
  98 {
  99 }
 100 static inline void mmc_remove_host_debugfs(struct mmc_host *host)
 101 {
 102 }
 103 static inline void mmc_add_card_debugfs(struct mmc_card *card)
 104 {
 105 }
 106 static inline void mmc_remove_card_debugfs(struct mmc_card *card)
 107 {
 108 }
 109 #endif
 110
 111 int mmc_execute_tuning(struct mmc_card *card);
 112 int mmc_hs200_to_hs400(struct mmc_card *card);
 113 int mmc_hs400_to_hs200(struct mmc_card *card);
 114
 115 void mmc_wait_for_req_done(struct mmc_host *host, struct mmc_request *mrq);
 116 bool mmc_is_req_done(struct mmc_host *host, struct mmc_request *mrq);
 117
 118 int mmc_start_request(struct mmc_host *host, struct mmc_request *mrq);
 119
 120 int mmc_erase(struct mmc_card *card, sector_t from, unsigned int nr, unsigned int arg);
 121 int mmc_can_erase(struct mmc_card *card);
 122 int mmc_can_trim(struct mmc_card *card);
 123 int mmc_can_discard(struct mmc_card *card);
 124 int mmc_can_sanitize(struct mmc_card *card);
 125 int mmc_can_secure_erase_trim(struct mmc_card *card);
 126 int mmc_erase_group_aligned(struct mmc_card *card, sector_t from, unsigned int nr);
 127 unsigned int mmc_calc_max_discard(struct mmc_card *card);
 128
 129 int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen);
 130
 131 int __mmc_claim_host(struct mmc_host *host, struct mmc_ctx *ctx,
 132                      atomic_t *abort);
 133 void mmc_release_host(struct mmc_host *host);
 134 void mmc_get_card(struct mmc_card *card, struct mmc_ctx *ctx);
 135 void mmc_put_card(struct mmc_card *card, struct mmc_ctx *ctx);
 136
 137 int mmc_card_alternative_gpt_sector(struct mmc_card *card, sector_t *sector);
 138
 139 /**
 140  *      mmc_claim_host - exclusively claim a host
 141  *      @host: mmc host to claim
 142  *
 143  *      Claim a host for a set of operations.
 144  */
 145 static inline void mmc_claim_host(struct mmc_host *host)
 146 {
 147         __mmc_claim_host(host, NULL, NULL);
 148 }
 149
 150 int mmc_cqe_start_req(struct mmc_host *host, struct mmc_request *mrq);
 151 void mmc_cqe_post_req(struct mmc_host *host, struct mmc_request *mrq);
 152 int mmc_cqe_recovery(struct mmc_host *host);
 153
 154 /**
 155  *      mmc_pre_req - Prepare for a new request
 156  *      @host: MMC host to prepare command
 157  *      @mrq: MMC request to prepare for
 158  *
 159  *      mmc_pre_req() is called in prior to mmc_start_req() to let
 160  *      host prepare for the new request. Preparation of a request may be
 161  *      performed while another request is running on the host.
 162  */
 163 static inline void mmc_pre_req(struct mmc_host *host, struct mmc_request *mrq)
 164 {
 165         if (host->ops->pre_req)
 166                 host->ops->pre_req(host, mrq);
 167 }
 168
 169 /**
 170  *      mmc_post_req - Post process a completed request
 171  *      @host: MMC host to post process command
 172  *      @mrq: MMC request to post process for
 173  *      @err: Error, if non zero, clean up any resources made in pre_req
 174  *
 175  *      Let the host post process a completed request. Post processing of
 176  *      a request may be performed while another request is running.
 177  */
 178 static inline void mmc_post_req(struct mmc_host *host, struct mmc_request *mrq,
 179                                 int err)
 180 {
 181         if (host->ops->post_req)
 182                 host->ops->post_req(host, mrq, err);
 183 }
 184
 185 static inline bool mmc_cache_enabled(struct mmc_host *host)
 186 {
 187         if (host->bus_ops->cache_enabled)
 188                 return host->bus_ops->cache_enabled(host);
 189
 190         return false;
 191 }
 192
 193 static inline int mmc_flush_cache(struct mmc_host *host)
 194 {
 195         if (host->bus_ops->flush_cache)
 196                 return host->bus_ops->flush_cache(host);
 197
 198         return 0;
 199 }
 200
 201 static inline unsigned int mmc_sector_div(sector_t dividend, u32 divisor)
 202 {
 203         return div_u64(dividend, divisor);
 204 }
 205
 206 static inline unsigned int mmc_sector_mod(sector_t dividend, u32 divisor)
 207 {
 208         return sector_div(dividend, divisor);
 209 }
 210
 211 #endif