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
  17 struct mmc_host;
  18 struct mmc_card;
  19 struct mmc_request;
  20
  21 #define MMC_CMD_RETRIES        3
  22
  23 struct 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
  38 void mmc_attach_bus(struct mmc_host *host, const struct mmc_bus_ops *ops);
  39 void mmc_detach_bus(struct mmc_host *host);
  40
  41 struct device_node *mmc_of_find_child_device(struct mmc_host *host,
  42                 unsigned func_num);
  43
  44 void mmc_init_erase(struct mmc_card *card);
  45
  46 void mmc_set_chip_select(struct mmc_host *host, int mode);
  47 void mmc_set_clock(struct mmc_host *host, unsigned int hz);
  48 void mmc_set_bus_mode(struct mmc_host *host, unsigned int mode);
  49 void mmc_set_bus_width(struct mmc_host *host, unsigned int width);
  50 u32 mmc_select_voltage(struct mmc_host *host, u32 ocr);
  51 int mmc_set_uhs_voltage(struct mmc_host *host, u32 ocr);
  52 int mmc_host_set_uhs_voltage(struct mmc_host *host);
  53 int mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage);
  54 void mmc_set_timing(struct mmc_host *host, unsigned int timing);
  55 void mmc_set_driver_type(struct mmc_host *host, unsigned int drv_type);
  56 int mmc_select_drive_strength(struct mmc_card *card, unsigned int max_dtr,
  57                               int card_drv_type, int *drv_type);
  58 void mmc_power_up(struct mmc_host *host, u32 ocr);
  59 void mmc_power_off(struct mmc_host *host);
  60 void mmc_power_cycle(struct mmc_host *host, u32 ocr);
  61 void mmc_set_initial_state(struct mmc_host *host);
  62
  63 static inline void mmc_delay(unsigned int ms)
  64 {
  65         if (ms < 1000 / HZ) {
  66                 cond_resched();
  67                 mdelay(ms);
  68         } else {
  69                 msleep(ms);
  70         }
  71 }
  72
  73 void mmc_rescan(struct work_struct *work);
  74 void mmc_start_host(struct mmc_host *host);
  75 void mmc_stop_host(struct mmc_host *host);
  76
  77 int _mmc_detect_card_removed(struct mmc_host *host);
  78 int mmc_detect_card_removed(struct mmc_host *host);
  79
  80 int mmc_attach_mmc(struct mmc_host *host);
  81 int mmc_attach_sd(struct mmc_host *host);
  82 int mmc_attach_sdio(struct mmc_host *host);
  83
  84 /* Module parameters */
  85 extern bool use_spi_crc;
  86
  87 /* Debugfs information for hosts and cards */
  88 void mmc_add_host_debugfs(struct mmc_host *host);
  89 void mmc_remove_host_debugfs(struct mmc_host *host);
  90
  91 void mmc_add_card_debugfs(struct mmc_card *card);
  92 void mmc_remove_card_debugfs(struct mmc_card *card);
  93
  94 void mmc_init_context_info(struct mmc_host *host);
  95
  96 int mmc_execute_tuning(struct mmc_card *card);
  97 int mmc_hs200_to_hs400(struct mmc_card *card);
  98 int mmc_hs400_to_hs200(struct mmc_card *card);
  99
 100 #ifdef CONFIG_PM_SLEEP
 101 void mmc_register_pm_notifier(struct mmc_host *host);
 102 void mmc_unregister_pm_notifier(struct mmc_host *host);
 103 #else
 104 static inline void mmc_register_pm_notifier(struct mmc_host *host) { }
 105 static inline void mmc_unregister_pm_notifier(struct mmc_host *host) { }
 106 #endif
 107
 108 void mmc_wait_for_req_done(struct mmc_host *host, struct mmc_request *mrq);
 109 bool mmc_is_req_done(struct mmc_host *host, struct mmc_request *mrq);
 110
 111 int mmc_start_request(struct mmc_host *host, struct mmc_request *mrq);
 112
 113 struct mmc_async_req;
 114
 115 struct mmc_async_req *mmc_start_areq(struct mmc_host *host,
 116                                      struct mmc_async_req *areq,
 117                                      enum mmc_blk_status *ret_stat);
 118
 119 int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr,
 120                 unsigned int arg);
 121 int mmc_can_erase(struct mmc_card *card);
 122 int mmc_can_trim(struct mmc_card *card);
 123 int mmc_can_discard(struct mmc_card *card);
 124 int mmc_can_sanitize(struct mmc_card *card);
 125 int mmc_can_secure_erase_trim(struct mmc_card *card);
 126 int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from,
 127                         unsigned int nr);
 128 unsigned int mmc_calc_max_discard(struct mmc_card *card);
 129
 130 int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen);
 131 int mmc_set_blockcount(struct mmc_card *card, unsigned int blockcount,
 132                         bool is_rel_write);
 133
 134 int __mmc_claim_host(struct mmc_host *host, struct mmc_ctx *ctx,
 135                      atomic_t *abort);
 136 void mmc_release_host(struct mmc_host *host);
 137 void mmc_get_card(struct mmc_card *card, struct mmc_ctx *ctx);
 138 void mmc_put_card(struct mmc_card *card, struct mmc_ctx *ctx);
 139
 140 /**
 141  *      mmc_claim_host - exclusively claim a host
 142  *      @host: mmc host to claim
 143  *
 144  *      Claim a host for a set of operations.
 145  */
 146 static inline void mmc_claim_host(struct mmc_host *host)
 147 {
 148         __mmc_claim_host(host, NULL, NULL);
 149 }
 150
 151 int mmc_cqe_start_req(struct mmc_host *host, struct mmc_request *mrq);
 152 void mmc_cqe_post_req(struct mmc_host *host, struct mmc_request *mrq);
 153 int mmc_cqe_recovery(struct mmc_host *host);
 154
 155 #endif