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 };
  34
  35 void mmc_attach_bus(struct mmc_host *host, const struct mmc_bus_ops *ops);
  36 void mmc_detach_bus(struct mmc_host *host);
  37
  38 struct device_node *mmc_of_find_child_device(struct mmc_host *host,
  39                 unsigned func_num);
  40
  41 void mmc_init_erase(struct mmc_card *card);
  42
  43 void mmc_set_chip_select(struct mmc_host *host, int mode);
  44 void mmc_set_clock(struct mmc_host *host, unsigned int hz);
  45 void mmc_set_bus_mode(struct mmc_host *host, unsigned int mode);
  46 void mmc_set_bus_width(struct mmc_host *host, unsigned int width);
  47 u32 mmc_select_voltage(struct mmc_host *host, u32 ocr);
  48 int mmc_set_uhs_voltage(struct mmc_host *host, u32 ocr);
  49 int mmc_host_set_uhs_voltage(struct mmc_host *host);
  50 int mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage);
  51 void mmc_set_initial_signal_voltage(struct mmc_host *host);
  52 void mmc_set_timing(struct mmc_host *host, unsigned int timing);
  53 void mmc_set_driver_type(struct mmc_host *host, unsigned int drv_type);
  54 int mmc_select_drive_strength(struct mmc_card *card, unsigned int max_dtr,
  55                               int card_drv_type, int *drv_type);
  56 void mmc_power_up(struct mmc_host *host, u32 ocr);
  57 void mmc_power_off(struct mmc_host *host);
  58 void mmc_power_cycle(struct mmc_host *host, u32 ocr);
  59 void mmc_set_initial_state(struct mmc_host *host);
  60 u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max);
  61
  62 static inline void mmc_delay(unsigned int ms)
  63 {
  64         if (ms <= 20)
  65                 usleep_range(ms * 1000, ms * 1250);
  66         else
  67                 msleep(ms);
  68 }
  69
  70 void mmc_rescan(struct work_struct *work);
  71 void mmc_start_host(struct mmc_host *host);
  72 void mmc_stop_host(struct mmc_host *host);
  73
  74 void _mmc_detect_change(struct mmc_host *host, unsigned long delay,
  75                         bool cd_irq);
  76 int _mmc_detect_card_removed(struct mmc_host *host);
  77 int mmc_detect_card_removed(struct mmc_host *host);
  78
  79 int mmc_attach_mmc(struct mmc_host *host);
  80 int mmc_attach_sd(struct mmc_host *host);
  81 int mmc_attach_sdio(struct mmc_host *host);
  82
  83 /* Module parameters */
  84 extern bool use_spi_crc;
  85
  86 /* Debugfs information for hosts and cards */
  87 void mmc_add_host_debugfs(struct mmc_host *host);
  88 void mmc_remove_host_debugfs(struct mmc_host *host);
  89
  90 void mmc_add_card_debugfs(struct mmc_card *card);
  91 void mmc_remove_card_debugfs(struct mmc_card *card);
  92
  93 int mmc_execute_tuning(struct mmc_card *card);
  94 int mmc_hs200_to_hs400(struct mmc_card *card);
  95 int mmc_hs400_to_hs200(struct mmc_card *card);
  96
  97 void mmc_wait_for_req_done(struct mmc_host *host, struct mmc_request *mrq);
  98 bool mmc_is_req_done(struct mmc_host *host, struct mmc_request *mrq);
  99
 100 int mmc_start_request(struct mmc_host *host, struct mmc_request *mrq);
 101
 102 int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr,
 103                 unsigned int arg);
 104 int mmc_can_erase(struct mmc_card *card);
 105 int mmc_can_trim(struct mmc_card *card);
 106 int mmc_can_discard(struct mmc_card *card);
 107 int mmc_can_sanitize(struct mmc_card *card);
 108 int mmc_can_secure_erase_trim(struct mmc_card *card);
 109 int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from,
 110                         unsigned int nr);
 111 unsigned int mmc_calc_max_discard(struct mmc_card *card);
 112
 113 int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen);
 114
 115 int __mmc_claim_host(struct mmc_host *host, struct mmc_ctx *ctx,
 116                      atomic_t *abort);
 117 void mmc_release_host(struct mmc_host *host);
 118 void mmc_get_card(struct mmc_card *card, struct mmc_ctx *ctx);
 119 void mmc_put_card(struct mmc_card *card, struct mmc_ctx *ctx);
 120
 121 /**
 122  *      mmc_claim_host - exclusively claim a host
 123  *      @host: mmc host to claim
 124  *
 125  *      Claim a host for a set of operations.
 126  */
 127 static inline void mmc_claim_host(struct mmc_host *host)
 128 {
 129         __mmc_claim_host(host, NULL, NULL);
 130 }
 131
 132 int mmc_cqe_start_req(struct mmc_host *host, struct mmc_request *mrq);
 133 void mmc_cqe_post_req(struct mmc_host *host, struct mmc_request *mrq);
 134 int mmc_cqe_recovery(struct mmc_host *host);
 135
 136 /**
 137  *      mmc_pre_req - Prepare for a new request
 138  *      @host: MMC host to prepare command
 139  *      @mrq: MMC request to prepare for
 140  *
 141  *      mmc_pre_req() is called in prior to mmc_start_req() to let
 142  *      host prepare for the new request. Preparation of a request may be
 143  *      performed while another request is running on the host.
 144  */
 145 static inline void mmc_pre_req(struct mmc_host *host, struct mmc_request *mrq)
 146 {
 147         if (host->ops->pre_req)
 148                 host->ops->pre_req(host, mrq);
 149 }
 150
 151 /**
 152  *      mmc_post_req - Post process a completed request
 153  *      @host: MMC host to post process command
 154  *      @mrq: MMC request to post process for
 155  *      @err: Error, if non zero, clean up any resources made in pre_req
 156  *
 157  *      Let the host post process a completed request. Post processing of
 158  *      a request may be performed while another request is running.
 159  */
 160 static inline void mmc_post_req(struct mmc_host *host, struct mmc_request *mrq,
 161                                 int err)
 162 {
 163         if (host->ops->post_req)
 164                 host->ops->post_req(host, mrq, err);
 165 }
 166
 167 static inline bool mmc_cache_enabled(struct mmc_host *host)
 168 {
 169         if (host->bus_ops->cache_enabled)
 170                 return host->bus_ops->cache_enabled(host);
 171
 172         return false;
 173 }
 174
 175 #endif