LXR linux/drivers/mmc/core/core.h

   1/*
   2 *  linux/drivers/mmc/core/core.h
   3 *
   4 *  Copyright (C) 2003 Russell King, All Rights Reserved.
   5 *  Copyright 2007 Pierre Ossman
   6 *
   7 * This program is free software; you can redistribute it and/or modify
   8 * it under the terms of the GNU General Public License version 2 as
   9 * published by the Free Software Foundation.
  10 */
  11#ifndef _MMC_CORE_CORE_H
  12#define _MMC_CORE_CORE_H
  13
  14#include <linux/delay.h>
  15#include <linux/sched.h>
  16
  17struct mmc_host;
  18struct mmc_card;
  19struct mmc_request;
  20
  21#define MMC_CMD_RETRIES        3
  22
  23struct mmc_bus_ops {
  24        void (*remove)(struct mmc_host *);
  25        void (*detect)(struct mmc_host *);
  26        int (*pre_suspend)(struct mmc_host *);
  27        int (*suspend)(struct mmc_host *);
  28        int (*resume)(struct mmc_host *);
  29        int (*runtime_suspend)(struct mmc_host *);
  30        int (*runtime_resume)(struct mmc_host *);
  31        int (*power_save)(struct mmc_host *);
  32        int (*power_restore)(struct mmc_host *);
  33        int (*alive)(struct mmc_host *);
  34        int (*shutdown)(struct mmc_host *);
  35        int (*reset)(struct mmc_host *);
  36};
  37
  38void mmc_attach_bus(struct mmc_host *host, const struct mmc_bus_ops *ops);
  39void mmc_detach_bus(struct mmc_host *host);
  40
  41struct device_node *mmc_of_find_child_device(struct mmc_host *host,
  42                unsigned func_num);
  43
  44void mmc_init_erase(struct mmc_card *card);
  45
  46void mmc_set_chip_select(struct mmc_host *host, int mode);
  47void mmc_set_clock(struct mmc_host *host, unsigned int hz);
  48void mmc_set_bus_mode(struct mmc_host *host, unsigned int mode);
  49void mmc_set_bus_width(struct mmc_host *host, unsigned int width);
  50u32 mmc_select_voltage(struct mmc_host *host, u32 ocr);
  51int mmc_set_uhs_voltage(struct mmc_host *host, u32 ocr);
  52int mmc_host_set_uhs_voltage(struct mmc_host *host);
  53int mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage);
  54void mmc_set_timing(struct mmc_host *host, unsigned int timing);
  55void mmc_set_driver_type(struct mmc_host *host, unsigned int drv_type);
  56int mmc_select_drive_strength(struct mmc_card *card, unsigned int max_dtr,
  57                              int card_drv_type, int *drv_type);
  58void mmc_power_up(struct mmc_host *host, u32 ocr);
  59void mmc_power_off(struct mmc_host *host);
  60void mmc_power_cycle(struct mmc_host *host, u32 ocr);
  61void mmc_set_initial_state(struct mmc_host *host);
  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
  75int _mmc_detect_card_removed(struct mmc_host *host);
  76int mmc_detect_card_removed(struct mmc_host *host);
  77
  78int mmc_attach_mmc(struct mmc_host *host);
  79int mmc_attach_sd(struct mmc_host *host);
  80int mmc_attach_sdio(struct mmc_host *host);
  81
  82/* Module parameters */
  83extern bool use_spi_crc;
  84
  85/* Debugfs information for hosts and cards */
  86void mmc_add_host_debugfs(struct mmc_host *host);
  87void mmc_remove_host_debugfs(struct mmc_host *host);
  88
  89void mmc_add_card_debugfs(struct mmc_card *card);
  90void mmc_remove_card_debugfs(struct mmc_card *card);
  91
  92int mmc_execute_tuning(struct mmc_card *card);
  93int mmc_hs200_to_hs400(struct mmc_card *card);
  94int mmc_hs400_to_hs200(struct mmc_card *card);
  95
  96#ifdef CONFIG_PM_SLEEP
  97void mmc_register_pm_notifier(struct mmc_host *host);
  98void mmc_unregister_pm_notifier(struct mmc_host *host);
  99#else
 100static inline void mmc_register_pm_notifier(struct mmc_host *host) { }
 101static inline void mmc_unregister_pm_notifier(struct mmc_host *host) { }
 102#endif
 103
 104void mmc_wait_for_req_done(struct mmc_host *host, struct mmc_request *mrq);
 105bool mmc_is_req_done(struct mmc_host *host, struct mmc_request *mrq);
 106
 107int mmc_start_request(struct mmc_host *host, struct mmc_request *mrq);
 108
 109int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr,
 110                unsigned int arg);
 111int mmc_can_erase(struct mmc_card *card);
 112int mmc_can_trim(struct mmc_card *card);
 113int mmc_can_discard(struct mmc_card *card);
 114int mmc_can_sanitize(struct mmc_card *card);
 115int mmc_can_secure_erase_trim(struct mmc_card *card);
 116int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from,
 117                        unsigned int nr);
 118unsigned int mmc_calc_max_discard(struct mmc_card *card);
 119
 120int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen);
 121int mmc_set_blockcount(struct mmc_card *card, unsigned int blockcount,
 122                        bool is_rel_write);
 123
 124int __mmc_claim_host(struct mmc_host *host, struct mmc_ctx *ctx,
 125                     atomic_t *abort);
 126void mmc_release_host(struct mmc_host *host);
 127void mmc_get_card(struct mmc_card *card, struct mmc_ctx *ctx);
 128void mmc_put_card(struct mmc_card *card, struct mmc_ctx *ctx);
 129
 130/**
 131 *      mmc_claim_host - exclusively claim a host
 132 *      @host: mmc host to claim
 133 *
 134 *      Claim a host for a set of operations.
 135 */
 136static inline void mmc_claim_host(struct mmc_host *host)
 137{
 138        __mmc_claim_host(host, NULL, NULL);
 139}
 140
 141int mmc_cqe_start_req(struct mmc_host *host, struct mmc_request *mrq);
 142void mmc_cqe_post_req(struct mmc_host *host, struct mmc_request *mrq);
 143int mmc_cqe_recovery(struct mmc_host *host);
 144
 145/**
 146 *      mmc_pre_req - Prepare for a new request
 147 *      @host: MMC host to prepare command
 148 *      @mrq: MMC request to prepare for
 149 *
 150 *      mmc_pre_req() is called in prior to mmc_start_req() to let
 151 *      host prepare for the new request. Preparation of a request may be
 152 *      performed while another request is running on the host.
 153 */
 154static inline void mmc_pre_req(struct mmc_host *host, struct mmc_request *mrq)
 155{
 156        if (host->ops->pre_req)
 157                host->ops->pre_req(host, mrq);
 158}
 159
 160/**
 161 *      mmc_post_req - Post process a completed request
 162 *      @host: MMC host to post process command
 163 *      @mrq: MMC request to post process for
 164 *      @err: Error, if non zero, clean up any resources made in pre_req
 165 *
 166 *      Let the host post process a completed request. Post processing of
 167 *      a request may be performed while another request is running.
 168 */
 169static inline void mmc_post_req(struct mmc_host *host, struct mmc_request *mrq,
 170                                int err)
 171{
 172        if (host->ops->post_req)
 173                host->ops->post_req(host, mrq, err);
 174}
 175
 176#endif
 177