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