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