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