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