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