1
2
3
4
5
6
7#ifndef LINUX_MMC_HOST_H
8#define LINUX_MMC_HOST_H
9
10#include <linux/sched.h>
11#include <linux/device.h>
12#include <linux/fault-inject.h>
13
14#include <linux/mmc/core.h>
15#include <linux/mmc/card.h>
16#include <linux/mmc/pm.h>
17#include <linux/dma-direction.h>
18#include <linux/keyslot-manager.h>
19
20struct mmc_ios {
21 unsigned int clock;
22 unsigned short vdd;
23 unsigned int power_delay_ms;
24
25
26
27 unsigned char bus_mode;
28
29#define MMC_BUSMODE_OPENDRAIN 1
30#define MMC_BUSMODE_PUSHPULL 2
31
32 unsigned char 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;
39
40#define MMC_POWER_OFF 0
41#define MMC_POWER_UP 1
42#define MMC_POWER_ON 2
43#define MMC_POWER_UNDEFINED 3
44
45 unsigned char bus_width;
46
47#define MMC_BUS_WIDTH_1 0
48#define MMC_BUS_WIDTH_4 2
49#define MMC_BUS_WIDTH_8 3
50
51 unsigned char timing;
52
53#define MMC_TIMING_LEGACY 0
54#define MMC_TIMING_MMC_HS 1
55#define MMC_TIMING_SD_HS 2
56#define MMC_TIMING_UHS_SDR12 3
57#define MMC_TIMING_UHS_SDR25 4
58#define MMC_TIMING_UHS_SDR50 5
59#define MMC_TIMING_UHS_SDR104 6
60#define MMC_TIMING_UHS_DDR50 7
61#define MMC_TIMING_MMC_DDR52 8
62#define MMC_TIMING_MMC_HS200 9
63#define MMC_TIMING_MMC_HS400 10
64#define MMC_TIMING_SD_EXP 11
65#define MMC_TIMING_SD_EXP_1_2V 12
66
67 unsigned char signal_voltage;
68
69#define MMC_SIGNAL_VOLTAGE_330 0
70#define MMC_SIGNAL_VOLTAGE_180 1
71#define MMC_SIGNAL_VOLTAGE_120 2
72
73 unsigned char drv_type;
74
75#define MMC_SET_DRIVER_TYPE_B 0
76#define MMC_SET_DRIVER_TYPE_A 1
77#define MMC_SET_DRIVER_TYPE_C 2
78#define MMC_SET_DRIVER_TYPE_D 3
79
80 bool enhanced_strobe;
81};
82
83struct mmc_clk_phase {
84 bool valid;
85 u16 in_deg;
86 u16 out_deg;
87};
88
89#define MMC_NUM_CLK_PHASES (MMC_TIMING_MMC_HS400 + 1)
90struct mmc_clk_phase_map {
91 struct mmc_clk_phase phase[MMC_NUM_CLK_PHASES];
92};
93
94struct mmc_host;
95
96struct mmc_host_ops {
97
98
99
100
101
102
103
104
105 void (*post_req)(struct mmc_host *host, struct mmc_request *req,
106 int err);
107 void (*pre_req)(struct mmc_host *host, struct mmc_request *req);
108 void (*request)(struct mmc_host *host, struct mmc_request *req);
109
110 int (*request_atomic)(struct mmc_host *host,
111 struct mmc_request *req);
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127 void (*set_ios)(struct mmc_host *host, struct mmc_ios *ios);
128
129
130
131
132
133
134
135
136 int (*get_ro)(struct mmc_host *host);
137
138
139
140
141
142
143
144
145 int (*get_cd)(struct mmc_host *host);
146
147 void (*enable_sdio_irq)(struct mmc_host *host, int enable);
148
149 void (*ack_sdio_irq)(struct mmc_host *host);
150
151
152 void (*init_card)(struct mmc_host *host, struct mmc_card *card);
153
154 int (*start_signal_voltage_switch)(struct mmc_host *host, struct mmc_ios *ios);
155
156
157 int (*card_busy)(struct mmc_host *host);
158
159
160 int (*execute_tuning)(struct mmc_host *host, u32 opcode);
161
162
163 int (*prepare_hs400_tuning)(struct mmc_host *host, struct mmc_ios *ios);
164
165
166 int (*hs400_prepare_ddr)(struct mmc_host *host);
167
168
169 void (*hs400_downgrade)(struct mmc_host *host);
170
171
172 void (*hs400_complete)(struct mmc_host *host);
173
174
175 void (*hs400_enhanced_strobe)(struct mmc_host *host,
176 struct mmc_ios *ios);
177 int (*select_drive_strength)(struct mmc_card *card,
178 unsigned int max_dtr, int host_drv,
179 int card_drv, int *drv_type);
180
181 void (*hw_reset)(struct mmc_host *host);
182 void (*card_event)(struct mmc_host *host);
183
184
185
186
187
188 int (*multi_io_quirk)(struct mmc_card *card,
189 unsigned int direction, int blk_size);
190
191
192 int (*init_sd_express)(struct mmc_host *host, struct mmc_ios *ios);
193};
194
195struct mmc_cqe_ops {
196
197 int (*cqe_enable)(struct mmc_host *host, struct mmc_card *card);
198
199 void (*cqe_disable)(struct mmc_host *host);
200
201
202
203
204 int (*cqe_request)(struct mmc_host *host, struct mmc_request *mrq);
205
206 void (*cqe_post_req)(struct mmc_host *host, struct mmc_request *mrq);
207
208
209
210
211
212 void (*cqe_off)(struct mmc_host *host);
213
214
215
216
217 int (*cqe_wait_for_idle)(struct mmc_host *host);
218
219
220
221
222
223 bool (*cqe_timeout)(struct mmc_host *host, struct mmc_request *mrq,
224 bool *recovery_needed);
225
226
227
228
229 void (*cqe_recovery_start)(struct mmc_host *host);
230
231
232
233
234
235
236 void (*cqe_recovery_finish)(struct mmc_host *host);
237};
238
239struct mmc_async_req {
240
241 struct mmc_request *mrq;
242
243
244
245
246 enum mmc_blk_status (*err_check)(struct mmc_card *, struct mmc_async_req *);
247};
248
249
250
251
252
253
254
255
256
257
258
259
260struct mmc_slot {
261 int cd_irq;
262 bool cd_wake_enabled;
263 void *handler_priv;
264};
265
266
267
268
269
270
271
272
273struct mmc_context_info {
274 bool is_done_rcv;
275 bool is_new_req;
276 bool is_waiting_last_req;
277 wait_queue_head_t wait;
278};
279
280struct regulator;
281struct mmc_pwrseq;
282
283struct mmc_supply {
284 struct regulator *vmmc;
285 struct regulator *vqmmc;
286};
287
288struct mmc_ctx {
289 struct task_struct *task;
290};
291
292struct mmc_host {
293 struct device *parent;
294 struct device class_dev;
295 int index;
296 const struct mmc_host_ops *ops;
297 struct mmc_pwrseq *pwrseq;
298 unsigned int f_min;
299 unsigned int f_max;
300 unsigned int f_init;
301 u32 ocr_avail;
302 u32 ocr_avail_sdio;
303 u32 ocr_avail_sd;
304 u32 ocr_avail_mmc;
305 struct wakeup_source *ws;
306 u32 max_current_330;
307 u32 max_current_300;
308 u32 max_current_180;
309
310#define MMC_VDD_165_195 0x00000080
311#define MMC_VDD_20_21 0x00000100
312#define MMC_VDD_21_22 0x00000200
313#define MMC_VDD_22_23 0x00000400
314#define MMC_VDD_23_24 0x00000800
315#define MMC_VDD_24_25 0x00001000
316#define MMC_VDD_25_26 0x00002000
317#define MMC_VDD_26_27 0x00004000
318#define MMC_VDD_27_28 0x00008000
319#define MMC_VDD_28_29 0x00010000
320#define MMC_VDD_29_30 0x00020000
321#define MMC_VDD_30_31 0x00040000
322#define MMC_VDD_31_32 0x00080000
323#define MMC_VDD_32_33 0x00100000
324#define MMC_VDD_33_34 0x00200000
325#define MMC_VDD_34_35 0x00400000
326#define MMC_VDD_35_36 0x00800000
327
328 u32 caps;
329
330#define MMC_CAP_4_BIT_DATA (1 << 0)
331#define MMC_CAP_MMC_HIGHSPEED (1 << 1)
332#define MMC_CAP_SD_HIGHSPEED (1 << 2)
333#define MMC_CAP_SDIO_IRQ (1 << 3)
334#define MMC_CAP_SPI (1 << 4)
335#define MMC_CAP_NEEDS_POLL (1 << 5)
336#define MMC_CAP_8_BIT_DATA (1 << 6)
337#define MMC_CAP_AGGRESSIVE_PM (1 << 7)
338#define MMC_CAP_NONREMOVABLE (1 << 8)
339#define MMC_CAP_WAIT_WHILE_BUSY (1 << 9)
340#define MMC_CAP_3_3V_DDR (1 << 11)
341#define MMC_CAP_1_8V_DDR (1 << 12)
342#define MMC_CAP_1_2V_DDR (1 << 13)
343#define MMC_CAP_DDR (MMC_CAP_3_3V_DDR | MMC_CAP_1_8V_DDR | \
344 MMC_CAP_1_2V_DDR)
345#define MMC_CAP_POWER_OFF_CARD (1 << 14)
346#define MMC_CAP_BUS_WIDTH_TEST (1 << 15)
347#define MMC_CAP_UHS_SDR12 (1 << 16)
348#define MMC_CAP_UHS_SDR25 (1 << 17)
349#define MMC_CAP_UHS_SDR50 (1 << 18)
350#define MMC_CAP_UHS_SDR104 (1 << 19)
351#define MMC_CAP_UHS_DDR50 (1 << 20)
352#define MMC_CAP_UHS (MMC_CAP_UHS_SDR12 | MMC_CAP_UHS_SDR25 | \
353 MMC_CAP_UHS_SDR50 | MMC_CAP_UHS_SDR104 | \
354 MMC_CAP_UHS_DDR50)
355#define MMC_CAP_SYNC_RUNTIME_PM (1 << 21)
356#define MMC_CAP_NEED_RSP_BUSY (1 << 22)
357#define MMC_CAP_DRIVER_TYPE_A (1 << 23)
358#define MMC_CAP_DRIVER_TYPE_C (1 << 24)
359#define MMC_CAP_DRIVER_TYPE_D (1 << 25)
360#define MMC_CAP_DONE_COMPLETE (1 << 27)
361#define MMC_CAP_CD_WAKE (1 << 28)
362#define MMC_CAP_CMD_DURING_TFR (1 << 29)
363#define MMC_CAP_CMD23 (1 << 30)
364#define MMC_CAP_HW_RESET (1 << 31)
365
366 u32 caps2;
367
368#define MMC_CAP2_BOOTPART_NOACC (1 << 0)
369#define MMC_CAP2_FULL_PWR_CYCLE (1 << 2)
370#define MMC_CAP2_FULL_PWR_CYCLE_IN_SUSPEND (1 << 3)
371#define MMC_CAP2_HS200_1_8V_SDR (1 << 5)
372#define MMC_CAP2_HS200_1_2V_SDR (1 << 6)
373#define MMC_CAP2_HS200 (MMC_CAP2_HS200_1_8V_SDR | \
374 MMC_CAP2_HS200_1_2V_SDR)
375#define MMC_CAP2_SD_EXP (1 << 7)
376#define MMC_CAP2_SD_EXP_1_2V (1 << 8)
377#define MMC_CAP2_CD_ACTIVE_HIGH (1 << 10)
378#define MMC_CAP2_RO_ACTIVE_HIGH (1 << 11)
379#define MMC_CAP2_NO_PRESCAN_POWERUP (1 << 14)
380#define MMC_CAP2_HS400_1_8V (1 << 15)
381#define MMC_CAP2_HS400_1_2V (1 << 16)
382#define MMC_CAP2_HS400 (MMC_CAP2_HS400_1_8V | \
383 MMC_CAP2_HS400_1_2V)
384#define MMC_CAP2_HSX00_1_8V (MMC_CAP2_HS200_1_8V_SDR | MMC_CAP2_HS400_1_8V)
385#define MMC_CAP2_HSX00_1_2V (MMC_CAP2_HS200_1_2V_SDR | MMC_CAP2_HS400_1_2V)
386#define MMC_CAP2_SDIO_IRQ_NOTHREAD (1 << 17)
387#define MMC_CAP2_NO_WRITE_PROTECT (1 << 18)
388#define MMC_CAP2_NO_SDIO (1 << 19)
389#define MMC_CAP2_HS400_ES (1 << 20)
390#define MMC_CAP2_NO_SD (1 << 21)
391#define MMC_CAP2_NO_MMC (1 << 22)
392#define MMC_CAP2_CQE (1 << 23)
393#define MMC_CAP2_CQE_DCMD (1 << 24)
394#define MMC_CAP2_AVOID_3_3V (1 << 25)
395#define MMC_CAP2_MERGE_CAPABLE (1 << 26)
396#ifdef CONFIG_MMC_CRYPTO
397#define MMC_CAP2_CRYPTO (1 << 27)
398#else
399#define MMC_CAP2_CRYPTO 0
400#endif
401#define MMC_CAP2_ALT_GPT_TEGRA (1 << 28)
402
403 int fixed_drv_type;
404
405 mmc_pm_flag_t pm_caps;
406
407
408 unsigned int max_seg_size;
409 unsigned short max_segs;
410 unsigned short unused;
411 unsigned int max_req_size;
412 unsigned int max_blk_size;
413 unsigned int max_blk_count;
414 unsigned int max_busy_timeout;
415
416
417 spinlock_t lock;
418
419 struct mmc_ios ios;
420
421
422 unsigned int use_spi_crc:1;
423 unsigned int claimed:1;
424 unsigned int doing_init_tune:1;
425 unsigned int can_retune:1;
426 unsigned int doing_retune:1;
427 unsigned int retune_now:1;
428 unsigned int retune_paused:1;
429 unsigned int retune_crc_disable:1;
430 unsigned int can_dma_map_merge:1;
431
432 int rescan_disable;
433 int rescan_entered;
434
435 int need_retune;
436 int hold_retune;
437 unsigned int retune_period;
438 struct timer_list retune_timer;
439
440 bool trigger_card_event;
441
442 struct mmc_card *card;
443
444 wait_queue_head_t wq;
445 struct mmc_ctx *claimer;
446 int claim_cnt;
447 struct mmc_ctx default_ctx;
448
449 struct delayed_work detect;
450 int detect_change;
451 struct mmc_slot slot;
452
453 const struct mmc_bus_ops *bus_ops;
454
455 unsigned int sdio_irqs;
456 struct task_struct *sdio_irq_thread;
457 struct delayed_work sdio_irq_work;
458 bool sdio_irq_pending;
459 atomic_t sdio_irq_thread_abort;
460
461 mmc_pm_flag_t pm_flags;
462
463 struct led_trigger *led;
464
465#ifdef CONFIG_REGULATOR
466 bool regulator_enabled;
467#endif
468 struct mmc_supply supply;
469
470 struct dentry *debugfs_root;
471
472
473 struct mmc_request *ongoing_mrq;
474
475#ifdef CONFIG_FAIL_MMC_REQUEST
476 struct fault_attr fail_mmc_request;
477#endif
478
479 unsigned int actual_clock;
480
481 unsigned int slotno;
482
483 int dsr_req;
484 u32 dsr;
485
486
487 const struct mmc_cqe_ops *cqe_ops;
488 void *cqe_private;
489 int cqe_qdepth;
490 bool cqe_enabled;
491 bool cqe_on;
492
493
494#ifdef CONFIG_MMC_CRYPTO
495 struct blk_keyslot_manager ksm;
496#endif
497
498
499 bool hsq_enabled;
500
501 unsigned long private[] ____cacheline_aligned;
502};
503
504struct device_node;
505
506struct mmc_host *mmc_alloc_host(int extra, struct device *);
507int mmc_add_host(struct mmc_host *);
508void mmc_remove_host(struct mmc_host *);
509void mmc_free_host(struct mmc_host *);
510void mmc_of_parse_clk_phase(struct mmc_host *host,
511 struct mmc_clk_phase_map *map);
512int mmc_of_parse(struct mmc_host *host);
513int mmc_of_parse_voltage(struct mmc_host *host, u32 *mask);
514
515static inline void *mmc_priv(struct mmc_host *host)
516{
517 return (void *)host->private;
518}
519
520static inline struct mmc_host *mmc_from_priv(void *priv)
521{
522 return container_of(priv, struct mmc_host, private);
523}
524
525#define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI)
526
527#define mmc_dev(x) ((x)->parent)
528#define mmc_classdev(x) (&(x)->class_dev)
529#define mmc_hostname(x) (dev_name(&(x)->class_dev))
530
531void mmc_detect_change(struct mmc_host *, unsigned long delay);
532void mmc_request_done(struct mmc_host *, struct mmc_request *);
533void mmc_command_done(struct mmc_host *host, struct mmc_request *mrq);
534
535void mmc_cqe_request_done(struct mmc_host *host, struct mmc_request *mrq);
536
537
538
539
540
541static inline bool sdio_irq_claimed(struct mmc_host *host)
542{
543 return host->sdio_irqs > 0;
544}
545
546static inline void mmc_signal_sdio_irq(struct mmc_host *host)
547{
548 host->ops->enable_sdio_irq(host, 0);
549 host->sdio_irq_pending = true;
550 if (host->sdio_irq_thread)
551 wake_up_process(host->sdio_irq_thread);
552}
553
554void sdio_signal_irq(struct mmc_host *host);
555
556#ifdef CONFIG_REGULATOR
557int mmc_regulator_set_ocr(struct mmc_host *mmc,
558 struct regulator *supply,
559 unsigned short vdd_bit);
560int mmc_regulator_set_vqmmc(struct mmc_host *mmc, struct mmc_ios *ios);
561#else
562static inline int mmc_regulator_set_ocr(struct mmc_host *mmc,
563 struct regulator *supply,
564 unsigned short vdd_bit)
565{
566 return 0;
567}
568
569static inline int mmc_regulator_set_vqmmc(struct mmc_host *mmc,
570 struct mmc_ios *ios)
571{
572 return -EINVAL;
573}
574#endif
575
576int mmc_regulator_get_supply(struct mmc_host *mmc);
577
578static inline int mmc_card_is_removable(struct mmc_host *host)
579{
580 return !(host->caps & MMC_CAP_NONREMOVABLE);
581}
582
583static inline int mmc_card_keep_power(struct mmc_host *host)
584{
585 return host->pm_flags & MMC_PM_KEEP_POWER;
586}
587
588static inline int mmc_card_wake_sdio_irq(struct mmc_host *host)
589{
590 return host->pm_flags & MMC_PM_WAKE_SDIO_IRQ;
591}
592
593
594static inline int mmc_card_hs(struct mmc_card *card)
595{
596 return card->host->ios.timing == MMC_TIMING_SD_HS ||
597 card->host->ios.timing == MMC_TIMING_MMC_HS;
598}
599
600
601static inline int mmc_card_uhs(struct mmc_card *card)
602{
603 return card->host->ios.timing >= MMC_TIMING_UHS_SDR12 &&
604 card->host->ios.timing <= MMC_TIMING_UHS_DDR50;
605}
606
607void mmc_retune_timer_stop(struct mmc_host *host);
608
609static inline void mmc_retune_needed(struct mmc_host *host)
610{
611 if (host->can_retune)
612 host->need_retune = 1;
613}
614
615static inline bool mmc_can_retune(struct mmc_host *host)
616{
617 return host->can_retune == 1;
618}
619
620static inline bool mmc_doing_retune(struct mmc_host *host)
621{
622 return host->doing_retune == 1;
623}
624
625static inline bool mmc_doing_tune(struct mmc_host *host)
626{
627 return host->doing_retune == 1 || host->doing_init_tune == 1;
628}
629
630static inline enum dma_data_direction mmc_get_dma_dir(struct mmc_data *data)
631{
632 return data->flags & MMC_DATA_WRITE ? DMA_TO_DEVICE : DMA_FROM_DEVICE;
633}
634
635int mmc_send_tuning(struct mmc_host *host, u32 opcode, int *cmd_error);
636int mmc_send_abort_tuning(struct mmc_host *host, u32 opcode);
637
638#endif
639