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 };
  33
  34 void mmc_attach_bus(struct mmc_host *host, const struct mmc_bus_ops *ops);
  35 void mmc_detach_bus(struct mmc_host *host);
  36
  37 struct device_node *mmc_of_find_child_device(struct mmc_host *host,
  38                 unsigned func_num);
  39
  40 void mmc_init_erase(struct mmc_card *card);
  41
  42 void mmc_set_chip_select(struct mmc_host *host, int mode);
  43 void mmc_set_clock(struct mmc_host *host, unsigned int hz);
  44 void mmc_set_bus_mode(struct mmc_host *host, unsigned int mode);
  45 void mmc_set_bus_width(struct mmc_host *host, unsigned int width);
  46 u32 mmc_select_voltage(struct mmc_host *host, u32 ocr);
  47 int mmc_set_uhs_voltage(struct mmc_host *host, u32 ocr);
  48 int mmc_host_set_uhs_voltage(struct mmc_host *host);
  49 int mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage);
  50 void mmc_set_initial_signal_voltage(struct mmc_host *host);
  51 void mmc_set_timing(struct mmc_host *host, unsigned int timing);
  52 void mmc_set_driver_type(struct mmc_host *host, unsigned int drv_type);
  53 int mmc_select_drive_strength(struct mmc_card *card, unsigned int max_dtr,
  54                               int card_drv_type, int *drv_type);
  55 void mmc_power_up(struct mmc_host *host, u32 ocr);
  56 void mmc_power_off(struct mmc_host *host);
  57 void mmc_power_cycle(struct mmc_host *host, u32 ocr);
  58 void mmc_set_initial_state(struct mmc_host *host);
  59 u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max);
  60
  61 static inline void mmc_delay(unsigned int ms)
  62 {
  63         if (ms <= 20)
  64                 usleep_range(ms * 1000, ms * 1250);
  65         else
  66                 msleep(ms);
  67 }
  68
  69 void mmc_rescan(struct work_struct *work);
  70 void mmc_start_host(struct mmc_host *host);
  71 void mmc_stop_host(struct mmc_host *host);
  72
  73 void _mmc_detect_change(struct mmc_host *host, unsigned long delay,
  74                         bool cd_irq);
  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
 122 int __mmc_claim_host(struct mmc_host *host, struct mmc_ctx *ctx,
 123                      atomic_t *abort);
 124 void mmc_release_host(struct mmc_host *host);
 125 void mmc_get_card(struct mmc_card *card, struct mmc_ctx *ctx);
 126 void mmc_put_card(struct mmc_card *card, struct mmc_ctx *ctx);
 127
 128 /**
 129  *      mmc_claim_host - exclusively claim a host
 130  *      @host: mmc host to claim
 131  *
 132  *      Claim a host for a set of operations.
 133  */
 134 static inline void mmc_claim_host(struct mmc_host *host)
 135 {
 136         __mmc_claim_host(host, NULL, NULL);
 137 }
 138
 139 int mmc_cqe_start_req(struct mmc_host *host, struct mmc_request *mrq);
 140 void mmc_cqe_post_req(struct mmc_host *host, struct mmc_request *mrq);
 141 int mmc_cqe_recovery(struct mmc_host *host);
 142
 143 /**
 144  *      mmc_pre_req - Prepare for a new request
 145  *      @host: MMC host to prepare command
 146  *      @mrq: MMC request to prepare for
 147  *
 148  *      mmc_pre_req() is called in prior to mmc_start_req() to let
 149  *      host prepare for the new request. Preparation of a request may be
 150  *      performed while another request is running on the host.
 151  */
 152 static inline void mmc_pre_req(struct mmc_host *host, struct mmc_request *mrq)
 153 {
 154         if (host->ops->pre_req)
 155                 host->ops->pre_req(host, mrq);
 156 }
 157
 158 /**
 159  *      mmc_post_req - Post process a completed request
 160  *      @host: MMC host to post process command
 161  *      @mrq: MMC request to post process for
 162  *      @err: Error, if non zero, clean up any resources made in pre_req
 163  *
 164  *      Let the host post process a completed request. Post processing of
 165  *      a request may be performed while another request is running.
 166  */
 167 static inline void mmc_post_req(struct mmc_host *host, struct mmc_request *mrq,
 168                                 int err)
 169 {
 170         if (host->ops->post_req)
 171                 host->ops->post_req(host, mrq, err);
 172 }
 173
 174 #endif