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