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