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