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
  18 struct mmc_ios {
  19         unsigned int    clock;                  /* clock rate */
  20         unsigned short  vdd;
  21
  22 /* vdd stores the bit number of the selected voltage range from below. */
  23
  24         unsigned char   bus_mode;               /* command output mode */
  25
  26 #define MMC_BUSMODE_OPENDRAIN   1
  27 #define MMC_BUSMODE_PUSHPULL    2
  28
  29         unsigned char   chip_select;            /* SPI chip select */
  30
  31 #define MMC_CS_DONTCARE         0
  32 #define MMC_CS_HIGH             1
  33 #define MMC_CS_LOW              2
  34
  35         unsigned char   power_mode;             /* power supply mode */
  36
  37 #define MMC_POWER_OFF           0
  38 #define MMC_POWER_UP            1
  39 #define MMC_POWER_ON            2
  40
  41         unsigned char   bus_width;              /* data bus width */
  42
  43 #define MMC_BUS_WIDTH_1         0
  44 #define MMC_BUS_WIDTH_4         2
  45 #define MMC_BUS_WIDTH_8         3
  46
  47         unsigned char   timing;                 /* timing specification used */
  48
  49 #define MMC_TIMING_LEGACY       0
  50 #define MMC_TIMING_MMC_HS       1
  51 #define MMC_TIMING_SD_HS        2
  52 };
  53
  54 struct mmc_host_ops {
  55         /*
  56          * Hosts that support power saving can use the 'enable' and 'disable'
  57          * methods to exit and enter power saving states. 'enable' is called
  58          * when the host is claimed and 'disable' is called (or scheduled with
  59          * a delay) when the host is released. The 'disable' is scheduled if
  60          * the disable delay set by 'mmc_set_disable_delay()' is non-zero,
  61          * otherwise 'disable' is called immediately. 'disable' may be
  62          * scheduled repeatedly, to permit ever greater power saving at the
  63          * expense of ever greater latency to re-enable. Rescheduling is
  64          * determined by the return value of the 'disable' method. A positive
  65          * value gives the delay in milliseconds.
  66          *
  67          * In the case where a host function (like set_ios) may be called
  68          * with or without the host claimed, enabling and disabling can be
  69          * done directly and will nest correctly. Call 'mmc_host_enable()' and
  70          * 'mmc_host_lazy_disable()' for this purpose, but note that these
  71          * functions must be paired.
  72          *
  73          * Alternatively, 'mmc_host_enable()' may be paired with
  74          * 'mmc_host_disable()' which calls 'disable' immediately.  In this
  75          * case the 'disable' method will be called with 'lazy' set to 0.
  76          * This is mainly useful for error paths.
  77          *
  78          * Because lazy disable may be called from a work queue, the 'disable'
  79          * method must claim the host when 'lazy' != 0, which will work
  80          * correctly because recursion is detected and handled.
  81          */
  82         int (*enable)(struct mmc_host *host);
  83         int (*disable)(struct mmc_host *host, int lazy);
  84         void    (*request)(struct mmc_host *host, struct mmc_request *req);
  85         /*
  86          * Avoid calling these three functions too often or in a "fast path",
  87          * since underlaying controller might implement them in an expensive
  88          * and/or slow way.
  89          *
  90          * Also note that these functions might sleep, so don't call them
  91          * in the atomic contexts!
  92          *
  93          * Return values for the get_ro callback should be:
  94          *   0 for a read/write card
  95          *   1 for a read-only card
  96          *   -ENOSYS when not supported (equal to NULL callback)
  97          *   or a negative errno value when something bad happened
  98          *
  99          * Return values for the get_cd callback should be:
 100          *   0 for a absent card
 101          *   1 for a present card
 102          *   -ENOSYS when not supported (equal to NULL callback)
 103          *   or a negative errno value when something bad happened
 104          */
 105         void    (*set_ios)(struct mmc_host *host, struct mmc_ios *ios);
 106         int     (*get_ro)(struct mmc_host *host);
 107         int     (*get_cd)(struct mmc_host *host);
 108
 109         void    (*enable_sdio_irq)(struct mmc_host *host, int enable);
 110
 111         /* optional callback for HC quirks */
 112         void    (*init_card)(struct mmc_host *host, struct mmc_card *card);
 113 };
 114
 115 struct mmc_card;
 116 struct device;
 117
 118 struct mmc_host {
 119         struct device           *parent;
 120         struct device           class_dev;
 121         int                     index;
 122         const struct mmc_host_ops *ops;
 123         unsigned int            f_min;
 124         unsigned int            f_max;
 125         u32                     ocr_avail;
 126         struct notifier_block   pm_notify;
 127
 128 #define MMC_VDD_165_195         0x00000080      /* VDD voltage 1.65 - 1.95 */
 129 #define MMC_VDD_20_21           0x00000100      /* VDD voltage 2.0 ~ 2.1 */
 130 #define MMC_VDD_21_22           0x00000200      /* VDD voltage 2.1 ~ 2.2 */
 131 #define MMC_VDD_22_23           0x00000400      /* VDD voltage 2.2 ~ 2.3 */
 132 #define MMC_VDD_23_24           0x00000800      /* VDD voltage 2.3 ~ 2.4 */
 133 #define MMC_VDD_24_25           0x00001000      /* VDD voltage 2.4 ~ 2.5 */
 134 #define MMC_VDD_25_26           0x00002000      /* VDD voltage 2.5 ~ 2.6 */
 135 #define MMC_VDD_26_27           0x00004000      /* VDD voltage 2.6 ~ 2.7 */
 136 #define MMC_VDD_27_28           0x00008000      /* VDD voltage 2.7 ~ 2.8 */
 137 #define MMC_VDD_28_29           0x00010000      /* VDD voltage 2.8 ~ 2.9 */
 138 #define MMC_VDD_29_30           0x00020000      /* VDD voltage 2.9 ~ 3.0 */
 139 #define MMC_VDD_30_31           0x00040000      /* VDD voltage 3.0 ~ 3.1 */
 140 #define MMC_VDD_31_32           0x00080000      /* VDD voltage 3.1 ~ 3.2 */
 141 #define MMC_VDD_32_33           0x00100000      /* VDD voltage 3.2 ~ 3.3 */
 142 #define MMC_VDD_33_34           0x00200000      /* VDD voltage 3.3 ~ 3.4 */
 143 #define MMC_VDD_34_35           0x00400000      /* VDD voltage 3.4 ~ 3.5 */
 144 #define MMC_VDD_35_36           0x00800000      /* VDD voltage 3.5 ~ 3.6 */
 145
 146         unsigned long           caps;           /* Host capabilities */
 147
 148 #define MMC_CAP_4_BIT_DATA      (1 << 0)        /* Can the host do 4 bit transfers */
 149 #define MMC_CAP_MMC_HIGHSPEED   (1 << 1)        /* Can do MMC high-speed timing */
 150 #define MMC_CAP_SD_HIGHSPEED    (1 << 2)        /* Can do SD high-speed timing */
 151 #define MMC_CAP_SDIO_IRQ        (1 << 3)        /* Can signal pending SDIO IRQs */
 152 #define MMC_CAP_SPI             (1 << 4)        /* Talks only SPI protocols */
 153 #define MMC_CAP_NEEDS_POLL      (1 << 5)        /* Needs polling for card-detection */
 154 #define MMC_CAP_8_BIT_DATA      (1 << 6)        /* Can the host do 8 bit transfers */
 155 #define MMC_CAP_DISABLE         (1 << 7)        /* Can the host be disabled */
 156 #define MMC_CAP_NONREMOVABLE    (1 << 8)        /* Nonremovable e.g. eMMC */
 157 #define MMC_CAP_WAIT_WHILE_BUSY (1 << 9)        /* Waits while card is busy */
 158
 159         /* host specific block data */
 160         unsigned int            max_seg_size;   /* see blk_queue_max_segment_size */
 161         unsigned short          max_hw_segs;    /* see blk_queue_max_hw_segments */
 162         unsigned short          max_phys_segs;  /* see blk_queue_max_phys_segments */
 163         unsigned short          unused;
 164         unsigned int            max_req_size;   /* maximum number of bytes in one req */
 165         unsigned int            max_blk_size;   /* maximum size of one mmc block */
 166         unsigned int            max_blk_count;  /* maximum number of blocks in one req */
 167
 168         /* private data */
 169         spinlock_t              lock;           /* lock for claim and bus ops */
 170
 171         struct mmc_ios          ios;            /* current io bus settings */
 172         u32                     ocr;            /* the current OCR setting */
 173
 174         /* group bitfields together to minimize padding */
 175         unsigned int            use_spi_crc:1;
 176         unsigned int            claimed:1;      /* host exclusively claimed */
 177         unsigned int            bus_dead:1;     /* bus has been released */
 178 #ifdef CONFIG_MMC_DEBUG
 179         unsigned int            removed:1;      /* host is being removed */
 180 #endif
 181
 182         /* Only used with MMC_CAP_DISABLE */
 183         int                     enabled;        /* host is enabled */
 184         int                     rescan_disable; /* disable card detection */
 185         int                     nesting_cnt;    /* "enable" nesting count */
 186         int                     en_dis_recurs;  /* detect recursion */
 187         unsigned int            disable_delay;  /* disable delay in msecs */
 188         struct delayed_work     disable;        /* disabling work */
 189
 190         struct mmc_card         *card;          /* device attached to this host */
 191
 192         wait_queue_head_t       wq;
 193         struct task_struct      *claimer;       /* task that has host claimed */
 194         int                     claim_cnt;      /* "claim" nesting count */
 195
 196         struct delayed_work     detect;
 197
 198         const struct mmc_bus_ops *bus_ops;      /* current bus driver */
 199         unsigned int            bus_refs;       /* reference counter */
 200
 201         unsigned int            bus_resume_flags;
 202 #define MMC_BUSRESUME_MANUAL_RESUME     (1 << 0)
 203 #define MMC_BUSRESUME_NEEDS_RESUME      (1 << 1)
 204
 205         unsigned int            sdio_irqs;
 206         struct task_struct      *sdio_irq_thread;
 207         atomic_t                sdio_irq_thread_abort;
 208
 209 #ifdef CONFIG_LEDS_TRIGGERS
 210         struct led_trigger      *led;           /* activity led */
 211 #endif
 212
 213         struct dentry           *debugfs_root;
 214
 215 #ifdef CONFIG_MMC_EMBEDDED_SDIO
 216         struct {
 217                 struct sdio_cis                 *cis;
 218                 struct sdio_cccr                *cccr;
 219                 struct sdio_embedded_func       *funcs;
 220                 int                             num_funcs;
 221         } embedded_sdio_data;
 222 #endif
 223
 224         unsigned long           private[0] ____cacheline_aligned;
 225 };
 226
 227 extern struct mmc_host *mmc_alloc_host(int extra, struct device *);
 228 extern int mmc_add_host(struct mmc_host *);
 229 extern void mmc_remove_host(struct mmc_host *);
 230 extern void mmc_free_host(struct mmc_host *);
 231
 232 #ifdef CONFIG_MMC_EMBEDDED_SDIO
 233 extern void mmc_set_embedded_sdio_data(struct mmc_host *host,
 234                                        struct sdio_cis *cis,
 235                                        struct sdio_cccr *cccr,
 236                                        struct sdio_embedded_func *funcs,
 237                                        int num_funcs);
 238 #endif
 239
 240 static inline void *mmc_priv(struct mmc_host *host)
 241 {
 242         return (void *)host->private;
 243 }
 244
 245 #define mmc_host_is_spi(host)   ((host)->caps & MMC_CAP_SPI)
 246
 247 #define mmc_dev(x)      ((x)->parent)
 248 #define mmc_classdev(x) (&(x)->class_dev)
 249 #define mmc_hostname(x) (dev_name(&(x)->class_dev))
 250 #define mmc_bus_needs_resume(host) ((host)->bus_resume_flags & MMC_BUSRESUME_NEEDS_RESUME)
 251
 252 static inline void mmc_set_bus_resume_policy(struct mmc_host *host, int manual)
 253 {
 254         if (manual)
 255                 host->bus_resume_flags |= MMC_BUSRESUME_MANUAL_RESUME;
 256         else
 257                 host->bus_resume_flags &= ~MMC_BUSRESUME_MANUAL_RESUME;
 258 }
 259
 260 extern int mmc_resume_bus(struct mmc_host *host);
 261
 262 extern int mmc_suspend_host(struct mmc_host *, pm_message_t);
 263 extern int mmc_resume_host(struct mmc_host *);
 264
 265 extern void mmc_power_save_host(struct mmc_host *host);
 266 extern void mmc_power_restore_host(struct mmc_host *host);
 267
 268 extern void mmc_detect_change(struct mmc_host *, unsigned long delay);
 269 extern void mmc_request_done(struct mmc_host *, struct mmc_request *);
 270
 271 static inline void mmc_signal_sdio_irq(struct mmc_host *host)
 272 {
 273         host->ops->enable_sdio_irq(host, 0);
 274         wake_up_process(host->sdio_irq_thread);
 275 }
 276
 277 struct regulator;
 278
 279 int mmc_regulator_get_ocrmask(struct regulator *supply);
 280 int mmc_regulator_set_ocr(struct regulator *supply, unsigned short vdd_bit);
 281
 282 int mmc_card_awake(struct mmc_host *host);
 283 int mmc_card_sleep(struct mmc_host *host);
 284 int mmc_card_can_sleep(struct mmc_host *host);
 285
 286 int mmc_host_enable(struct mmc_host *host);
 287 int mmc_host_disable(struct mmc_host *host);
 288 int mmc_host_lazy_disable(struct mmc_host *host);
 289 int mmc_pm_notify(struct notifier_block *notify_block, unsigned long, void *);
 290
 291 static inline void mmc_set_disable_delay(struct mmc_host *host,
 292                                          unsigned int disable_delay)
 293 {
 294         host->disable_delay = disable_delay;
 295 }
 296
 297 #endif
 298