include/linux/mmc/host.h

   1 /*
   2  *  linux/include/linux/mmc/host.h
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License version 2 as
   6  * published by the Free Software Foundation.
   7  *
   8  *  Host driver specific definitions.
   9  */
  10 #ifndef LINUX_MMC_HOST_H
  11 #define LINUX_MMC_HOST_H
  12
  13 #include <linux/leds.h>
  14 #include <linux/sched.h>
  15
  16 #include <linux/mmc/core.h>
  17 #include <linux/mmc/pm.h>
  18
  19 struct mmc_ios {
  20         unsigned int    clock;                  /* clock rate */
  21         unsigned short  vdd;
  22
  23 /* vdd stores the bit number of the selected voltage range from below. */
  24
  25         unsigned char   bus_mode;               /* command output mode */
  26
  27 #define MMC_BUSMODE_OPENDRAIN   1
  28 #define MMC_BUSMODE_PUSHPULL    2
  29
  30         unsigned char   chip_select;            /* SPI chip select */
  31
  32 #define MMC_CS_DONTCARE         0
  33 #define MMC_CS_HIGH             1
  34 #define MMC_CS_LOW              2
  35
  36         unsigned char   power_mode;             /* power supply mode */
  37
  38 #define MMC_POWER_OFF           0
  39 #define MMC_POWER_UP            1
  40 #define MMC_POWER_ON            2
  41
  42         unsigned char   bus_width;              /* data bus width */
  43
  44 #define MMC_BUS_WIDTH_1         0
  45 #define MMC_BUS_WIDTH_4         2
  46 #define MMC_BUS_WIDTH_8         3
  47
  48         unsigned char   timing;                 /* timing specification used */
  49
  50 #define MMC_TIMING_LEGACY       0
  51 #define MMC_TIMING_MMC_HS       1
  52 #define MMC_TIMING_SD_HS        2
  53
  54         unsigned char   ddr;                    /* dual data rate used */
  55
  56 #define MMC_SDR_MODE            0
  57 #define MMC_1_2V_DDR_MODE       1
  58 #define MMC_1_8V_DDR_MODE       2
  59
  60         unsigned char   signal_voltage;         /* signalling voltage (1.8V or 3.3V) */
  61
  62 #define MMC_SIGNAL_VOLTAGE_330  0
  63 #define MMC_SIGNAL_VOLTAGE_180  1
  64 };
  65
  66 struct mmc_host_ops {
  67         /*
  68          * Hosts that support power saving can use the 'enable' and 'disable'
  69          * methods to exit and enter power saving states. 'enable' is called
  70          * when the host is claimed and 'disable' is called (or scheduled with
  71          * a delay) when the host is released. The 'disable' is scheduled if
  72          * the disable delay set by 'mmc_set_disable_delay()' is non-zero,
  73          * otherwise 'disable' is called immediately. 'disable' may be
  74          * scheduled repeatedly, to permit ever greater power saving at the
  75          * expense of ever greater latency to re-enable. Rescheduling is
  76          * determined by the return value of the 'disable' method. A positive
  77          * value gives the delay in milliseconds.
  78          *
  79          * In the case where a host function (like set_ios) may be called
  80          * with or without the host claimed, enabling and disabling can be
  81          * done directly and will nest correctly. Call 'mmc_host_enable()' and
  82          * 'mmc_host_lazy_disable()' for this purpose, but note that these
  83          * functions must be paired.
  84          *
  85          * Alternatively, 'mmc_host_enable()' may be paired with
  86          * 'mmc_host_disable()' which calls 'disable' immediately.  In this
  87          * case the 'disable' method will be called with 'lazy' set to 0.
  88          * This is mainly useful for error paths.
  89          *
  90          * Because lazy disable may be called from a work queue, the 'disable'
  91          * method must claim the host when 'lazy' != 0, which will work
  92          * correctly because recursion is detected and handled.
  93          */
  94         int (*enable)(struct mmc_host *host);
  95         int (*disable)(struct mmc_host *host, int lazy);
  96         void    (*request)(struct mmc_host *host, struct mmc_request *req);
  97         /*
  98          * Avoid calling these three functions too often or in a "fast path",
  99          * since underlaying controller might implement them in an expensive
 100          * and/or slow way.
 101          *
 102          * Also note that these functions might sleep, so don't call them
 103          * in the atomic contexts!
 104          *
 105          * Return values for the get_ro callback should be:
 106          *   0 for a read/write card
 107          *   1 for a read-only card
 108          *   -ENOSYS when not supported (equal to NULL callback)
 109          *   or a negative errno value when something bad happened
 110          *
 111          * Return values for the get_cd callback should be:
 112          *   0 for a absent card
 113          *   1 for a present card
 114          *   -ENOSYS when not supported (equal to NULL callback)
 115          *   or a negative errno value when something bad happened
 116          */
 117         void    (*set_ios)(struct mmc_host *host, struct mmc_ios *ios);
 118         int     (*get_ro)(struct mmc_host *host);
 119         int     (*get_cd)(struct mmc_host *host);
 120
 121         void    (*enable_sdio_irq)(struct mmc_host *host, int enable);
 122
 123         /* optional callback for HC quirks */
 124         void    (*init_card)(struct mmc_host *host, struct mmc_card *card);
 125
 126         int     (*start_signal_voltage_switch)(struct mmc_host *host, struct mmc_ios *ios);
 127 };
 128
 129 struct mmc_card;
 130 struct device;
 131
 132 struct mmc_host {
 133         struct device           *parent;
 134         struct device           class_dev;
 135         int                     index;
 136         const struct mmc_host_ops *ops;
 137         unsigned int            f_min;
 138         unsigned int            f_max;
 139         unsigned int            f_init;
 140         u32                     ocr_avail;
 141         u32                     ocr_avail_sdio; /* SDIO-specific OCR */
 142         u32                     ocr_avail_sd;   /* SD-specific OCR */
 143         u32                     ocr_avail_mmc;  /* MMC-specific OCR */
 144         struct notifier_block   pm_notify;
 145
 146 #define MMC_VDD_165_195         0x00000080      /* VDD voltage 1.65 - 1.95 */
 147 #define MMC_VDD_20_21           0x00000100      /* VDD voltage 2.0 ~ 2.1 */
 148 #define MMC_VDD_21_22           0x00000200      /* VDD voltage 2.1 ~ 2.2 */
 149 #define MMC_VDD_22_23           0x00000400      /* VDD voltage 2.2 ~ 2.3 */
 150 #define MMC_VDD_23_24           0x00000800      /* VDD voltage 2.3 ~ 2.4 */
 151 #define MMC_VDD_24_25           0x00001000      /* VDD voltage 2.4 ~ 2.5 */
 152 #define MMC_VDD_25_26           0x00002000      /* VDD voltage 2.5 ~ 2.6 */
 153 #define MMC_VDD_26_27           0x00004000      /* VDD voltage 2.6 ~ 2.7 */
 154 #define MMC_VDD_27_28           0x00008000      /* VDD voltage 2.7 ~ 2.8 */
 155 #define MMC_VDD_28_29           0x00010000      /* VDD voltage 2.8 ~ 2.9 */
 156 #define MMC_VDD_29_30           0x00020000      /* VDD voltage 2.9 ~ 3.0 */
 157 #define MMC_VDD_30_31           0x00040000      /* VDD voltage 3.0 ~ 3.1 */
 158 #define MMC_VDD_31_32           0x00080000      /* VDD voltage 3.1 ~ 3.2 */
 159 #define MMC_VDD_32_33           0x00100000      /* VDD voltage 3.2 ~ 3.3 */
 160 #define MMC_VDD_33_34           0x00200000      /* VDD voltage 3.3 ~ 3.4 */
 161 #define MMC_VDD_34_35           0x00400000      /* VDD voltage 3.4 ~ 3.5 */
 162 #define MMC_VDD_35_36           0x00800000      /* VDD voltage 3.5 ~ 3.6 */
 163
 164         unsigned long           caps;           /* Host capabilities */
 165
 166 #define MMC_CAP_4_BIT_DATA      (1 << 0)        /* Can the host do 4 bit transfers */
 167 #define MMC_CAP_MMC_HIGHSPEED   (1 << 1)        /* Can do MMC high-speed timing */
 168 #define MMC_CAP_SD_HIGHSPEED    (1 << 2)        /* Can do SD high-speed timing */
 169 #define MMC_CAP_SDIO_IRQ        (1 << 3)        /* Can signal pending SDIO IRQs */
 170 #define MMC_CAP_SPI             (1 << 4)        /* Talks only SPI protocols */
 171 #define MMC_CAP_NEEDS_POLL      (1 << 5)        /* Needs polling for card-detection */
 172 #define MMC_CAP_8_BIT_DATA      (1 << 6)        /* Can the host do 8 bit transfers */
 173 #define MMC_CAP_DISABLE         (1 << 7)        /* Can the host be disabled */
 174 #define MMC_CAP_NONREMOVABLE    (1 << 8)        /* Nonremovable e.g. eMMC */
 175 #define MMC_CAP_WAIT_WHILE_BUSY (1 << 9)        /* Waits while card is busy */
 176 #define MMC_CAP_ERASE           (1 << 10)       /* Allow erase/trim commands */
 177 #define MMC_CAP_1_8V_DDR        (1 << 11)       /* can support */
 178                                                 /* DDR mode at 1.8V */
 179 #define MMC_CAP_1_2V_DDR        (1 << 12)       /* can support */
 180                                                 /* DDR mode at 1.2V */
 181 #define MMC_CAP_POWER_OFF_CARD  (1 << 13)       /* Can power off after boot */
 182 #define MMC_CAP_BUS_WIDTH_TEST  (1 << 14)       /* CMD14/CMD19 bus width ok */
 183 #define MMC_CAP_UHS_SDR12       (1 << 15)       /* Host supports UHS SDR12 mode */
 184 #define MMC_CAP_UHS_SDR25       (1 << 16)       /* Host supports UHS SDR25 mode */
 185 #define MMC_CAP_UHS_SDR50       (1 << 17)       /* Host supports UHS SDR50 mode */
 186 #define MMC_CAP_UHS_SDR104      (1 << 18)       /* Host supports UHS SDR104 mode */
 187 #define MMC_CAP_UHS_DDR50       (1 << 19)       /* Host supports UHS DDR50 mode */
 188 #define MMC_CAP_SET_XPC_330     (1 << 20)       /* Host supports >150mA current at 3.3V */
 189 #define MMC_CAP_SET_XPC_300     (1 << 21)       /* Host supports >150mA current at 3.0V */
 190 #define MMC_CAP_SET_XPC_180     (1 << 22)       /* Host supports >150mA current at 1.8V */
 191
 192         mmc_pm_flag_t           pm_caps;        /* supported pm features */
 193
 194 #ifdef CONFIG_MMC_CLKGATE
 195         int                     clk_requests;   /* internal reference counter */
 196         unsigned int            clk_delay;      /* number of MCI clk hold cycles */
 197         bool                    clk_gated;      /* clock gated */
 198         struct work_struct      clk_gate_work; /* delayed clock gate */
 199         unsigned int            clk_old;        /* old clock value cache */
 200         spinlock_t              clk_lock;       /* lock for clk fields */
 201 #endif
 202
 203         /* host specific block data */
 204         unsigned int            max_seg_size;   /* see blk_queue_max_segment_size */
 205         unsigned short          max_segs;       /* see blk_queue_max_segments */
 206         unsigned short          unused;
 207         unsigned int            max_req_size;   /* maximum number of bytes in one req */
 208         unsigned int            max_blk_size;   /* maximum size of one mmc block */
 209         unsigned int            max_blk_count;  /* maximum number of blocks in one req */
 210
 211         /* private data */
 212         spinlock_t              lock;           /* lock for claim and bus ops */
 213
 214         struct mmc_ios          ios;            /* current io bus settings */
 215         u32                     ocr;            /* the current OCR setting */
 216
 217         /* group bitfields together to minimize padding */
 218         unsigned int            use_spi_crc:1;
 219         unsigned int            claimed:1;      /* host exclusively claimed */
 220         unsigned int            bus_dead:1;     /* bus has been released */
 221 #ifdef CONFIG_MMC_DEBUG
 222         unsigned int            removed:1;      /* host is being removed */
 223 #endif
 224
 225         /* Only used with MMC_CAP_DISABLE */
 226         int                     enabled;        /* host is enabled */
 227         int                     rescan_disable; /* disable card detection */
 228         int                     nesting_cnt;    /* "enable" nesting count */
 229         int                     en_dis_recurs;  /* detect recursion */
 230         unsigned int            disable_delay;  /* disable delay in msecs */
 231         struct delayed_work     disable;        /* disabling work */
 232
 233         struct mmc_card         *card;          /* device attached to this host */
 234
 235         wait_queue_head_t       wq;
 236         struct task_struct      *claimer;       /* task that has host claimed */
 237         int                     claim_cnt;      /* "claim" nesting count */
 238
 239         struct delayed_work     detect;
 240
 241         const struct mmc_bus_ops *bus_ops;      /* current bus driver */
 242         unsigned int            bus_refs;       /* reference counter */
 243
 244         unsigned int            sdio_irqs;
 245         struct task_struct      *sdio_irq_thread;
 246         atomic_t                sdio_irq_thread_abort;
 247
 248         mmc_pm_flag_t           pm_flags;       /* requested pm features */
 249
 250 #ifdef CONFIG_LEDS_TRIGGERS
 251         struct led_trigger      *led;           /* activity led */
 252 #endif
 253
 254 #ifdef CONFIG_REGULATOR
 255         bool                    regulator_enabled; /* regulator state */
 256 #endif
 257
 258         struct dentry           *debugfs_root;
 259
 260         unsigned long           private[0] ____cacheline_aligned;
 261 };
 262
 263 extern struct mmc_host *mmc_alloc_host(int extra, struct device *);
 264 extern int mmc_add_host(struct mmc_host *);
 265 extern void mmc_remove_host(struct mmc_host *);
 266 extern void mmc_free_host(struct mmc_host *);
 267
 268 static inline void *mmc_priv(struct mmc_host *host)
 269 {
 270         return (void *)host->private;
 271 }
 272
 273 #define mmc_host_is_spi(host)   ((host)->caps & MMC_CAP_SPI)
 274
 275 #define mmc_dev(x)      ((x)->parent)
 276 #define mmc_classdev(x) (&(x)->class_dev)
 277 #define mmc_hostname(x) (dev_name(&(x)->class_dev))
 278
 279 extern int mmc_suspend_host(struct mmc_host *);
 280 extern int mmc_resume_host(struct mmc_host *);
 281
 282 extern int mmc_power_save_host(struct mmc_host *host);
 283 extern int mmc_power_restore_host(struct mmc_host *host);
 284
 285 extern void mmc_detect_change(struct mmc_host *, unsigned long delay);
 286 extern void mmc_request_done(struct mmc_host *, struct mmc_request *);
 287
 288 static inline void mmc_signal_sdio_irq(struct mmc_host *host)
 289 {
 290         host->ops->enable_sdio_irq(host, 0);
 291         wake_up_process(host->sdio_irq_thread);
 292 }
 293
 294 struct regulator;
 295
 296 #ifdef CONFIG_REGULATOR
 297 int mmc_regulator_get_ocrmask(struct regulator *supply);
 298 int mmc_regulator_set_ocr(struct mmc_host *mmc,
 299                         struct regulator *supply,
 300                         unsigned short vdd_bit);
 301 #else
 302 static inline int mmc_regulator_get_ocrmask(struct regulator *supply)
 303 {
 304         return 0;
 305 }
 306
 307 static inline int mmc_regulator_set_ocr(struct mmc_host *mmc,
 308                                  struct regulator *supply,
 309                                  unsigned short vdd_bit)
 310 {
 311         return 0;
 312 }
 313 #endif
 314
 315 int mmc_card_awake(struct mmc_host *host);
 316 int mmc_card_sleep(struct mmc_host *host);
 317 int mmc_card_can_sleep(struct mmc_host *host);
 318
 319 int mmc_host_enable(struct mmc_host *host);
 320 int mmc_host_disable(struct mmc_host *host);
 321 int mmc_host_lazy_disable(struct mmc_host *host);
 322 int mmc_pm_notify(struct notifier_block *notify_block, unsigned long, void *);
 323
 324 static inline void mmc_set_disable_delay(struct mmc_host *host,
 325                                          unsigned int disable_delay)
 326 {
 327         host->disable_delay = disable_delay;
 328 }
 329
 330 /* Module parameter */
 331 extern int mmc_assume_removable;
 332
 333 static inline int mmc_card_is_removable(struct mmc_host *host)
 334 {
 335         return !(host->caps & MMC_CAP_NONREMOVABLE) && mmc_assume_removable;
 336 }
 337
 338 static inline int mmc_card_keep_power(struct mmc_host *host)
 339 {
 340         return host->pm_flags & MMC_PM_KEEP_POWER;
 341 }
 342
 343 static inline int mmc_card_wake_sdio_irq(struct mmc_host *host)
 344 {
 345         return host->pm_flags & MMC_PM_WAKE_SDIO_IRQ;
 346 }
 347 #endif
 348