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