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