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