2 * linux/include/linux/mmc/host.h
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.
8 * Host driver specific definitions.
10 #ifndef LINUX_MMC_HOST_H
11 #define LINUX_MMC_HOST_H
13 #include <linux/leds.h>
14 #include <linux/mutex.h>
15 #include <linux/sched.h>
16 #include <linux/device.h>
17 #include <linux/fault-inject.h>
18 #include <linux/wakelock.h>
20 #include <linux/mmc/core.h>
21 #include <linux/mmc/pm.h>
24 unsigned int clock; /* clock rate */
27 /* vdd stores the bit number of the selected voltage range from below. */
29 unsigned char bus_mode; /* command output mode */
31 #define MMC_BUSMODE_OPENDRAIN 1
32 #define MMC_BUSMODE_PUSHPULL 2
34 unsigned char chip_select; /* SPI chip select */
36 #define MMC_CS_DONTCARE 0
40 unsigned char power_mode; /* power supply mode */
42 #define MMC_POWER_OFF 0
43 #define MMC_POWER_UP 1
44 #define MMC_POWER_ON 2
46 unsigned char bus_width; /* data bus width */
48 #define MMC_BUS_WIDTH_1 0
49 #define MMC_BUS_WIDTH_4 2
50 #define MMC_BUS_WIDTH_8 3
52 unsigned char timing; /* timing specification used */
54 #define MMC_TIMING_LEGACY 0
55 #define MMC_TIMING_MMC_HS 1
56 #define MMC_TIMING_SD_HS 2
57 #define MMC_TIMING_UHS_SDR12 3
58 #define MMC_TIMING_UHS_SDR25 4
59 #define MMC_TIMING_UHS_SDR50 5
60 #define MMC_TIMING_UHS_SDR104 6
61 #define MMC_TIMING_UHS_DDR50 7
62 #define MMC_TIMING_MMC_HS200 8
64 #define MMC_SDR_MODE 0
65 #define MMC_1_2V_DDR_MODE 1
66 #define MMC_1_8V_DDR_MODE 2
67 #define MMC_1_2V_SDR_MODE 3
68 #define MMC_1_8V_SDR_MODE 4
70 unsigned char signal_voltage; /* signalling voltage (1.8V or 3.3V) */
72 #define MMC_SIGNAL_VOLTAGE_330 0
73 #define MMC_SIGNAL_VOLTAGE_180 1
74 #define MMC_SIGNAL_VOLTAGE_120 2
76 unsigned char drv_type; /* driver type (A, B, C, D) */
78 #define MMC_SET_DRIVER_TYPE_B 0
79 #define MMC_SET_DRIVER_TYPE_A 1
80 #define MMC_SET_DRIVER_TYPE_C 2
81 #define MMC_SET_DRIVER_TYPE_D 3
86 * 'enable' is called when the host is claimed and 'disable' is called
87 * when the host is released. 'enable' and 'disable' are deprecated.
89 int (*enable)(struct mmc_host *host);
90 int (*disable)(struct mmc_host *host);
92 * It is optional for the host to implement pre_req and post_req in
93 * order to support double buffering of requests (prepare one
94 * request while another request is active).
95 * pre_req() must always be followed by a post_req().
96 * To undo a call made to pre_req(), call post_req() with
97 * a nonzero err condition.
99 void (*post_req)(struct mmc_host *host, struct mmc_request *req,
101 void (*pre_req)(struct mmc_host *host, struct mmc_request *req,
103 void (*request)(struct mmc_host *host, struct mmc_request *req);
105 * Avoid calling these three functions too often or in a "fast path",
106 * since underlaying controller might implement them in an expensive
109 * Also note that these functions might sleep, so don't call them
110 * in the atomic contexts!
112 * Return values for the get_ro callback should be:
113 * 0 for a read/write card
114 * 1 for a read-only card
115 * -ENOSYS when not supported (equal to NULL callback)
116 * or a negative errno value when something bad happened
118 * Return values for the get_cd callback should be:
119 * 0 for a absent card
120 * 1 for a present card
121 * -ENOSYS when not supported (equal to NULL callback)
122 * or a negative errno value when something bad happened
124 void (*set_ios)(struct mmc_host *host, struct mmc_ios *ios);
125 int (*get_ro)(struct mmc_host *host);
126 int (*get_cd)(struct mmc_host *host);
127 int (*set_sdio_status)(struct mmc_host *host, int val);//added by xbw,at 2014-03-24
129 void (*enable_sdio_irq)(struct mmc_host *host, int enable);
131 /* optional callback for HC quirks */
132 void (*init_card)(struct mmc_host *host, struct mmc_card *card);
134 int (*start_signal_voltage_switch)(struct mmc_host *host, struct mmc_ios *ios);
136 /* Check if the card is pulling dat[0:3] low */
137 int (*card_busy)(struct mmc_host *host);
139 /* The tuning command opcode value is different for SD and eMMC cards */
140 int (*execute_tuning)(struct mmc_host *host, u32 opcode);
141 int (*select_drive_strength)(unsigned int max_dtr, int host_drv, int card_drv);
142 void (*hw_reset)(struct mmc_host *host);
143 void (*card_event)(struct mmc_host *host);
145 void (*post_tmo)(struct mmc_host *host);
151 struct mmc_async_req {
152 /* active mmc request */
153 struct mmc_request *mrq;
155 * Check error status of completed mmc request.
156 * Returns 0 if success otherwise non zero.
158 int (*err_check) (struct mmc_card *, struct mmc_async_req *);
162 * struct mmc_slot - MMC slot functions
164 * @cd_irq: MMC/SD-card slot hotplug detection IRQ or -EINVAL
165 * @lock: protect the @handler_priv pointer
166 * @handler_priv: MMC/SD-card slot context
168 * Some MMC/SD host controllers implement slot-functions like card and
169 * write-protect detection natively. However, a large number of controllers
170 * leave these functions to the CPU. This struct provides a hook to attach
171 * such slot-function drivers.
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
185 * @lock lock to protect data fields
187 struct mmc_context_info {
190 bool is_waiting_last_req;
191 wait_queue_head_t wait;
198 struct regulator *vmmc; /* Card power supply */
199 struct regulator *vqmmc; /* Optional Vccq supply */
203 struct device *parent;
204 struct device class_dev;
206 const struct mmc_host_ops *ops;
211 u32 ocr_avail_sdio; /* SDIO-specific OCR */
212 u32 ocr_avail_sd; /* SD-specific OCR */
213 u32 ocr_avail_mmc; /* MMC-specific OCR */
214 struct notifier_block pm_notify;
219 #define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
220 #define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
221 #define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
222 #define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
223 #define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
224 #define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
225 #define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
226 #define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
227 #define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
228 #define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
229 #define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
230 #define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
231 #define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
232 #define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
233 #define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
234 #define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
235 #define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
237 u32 caps; /* Host capabilities */
239 #define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */
240 #define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */
241 #define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */
242 #define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */
243 #define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */
244 #define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */
245 #define MMC_CAP_8_BIT_DATA (1 << 6) /* Can the host do 8 bit transfers */
246 #define MMC_CAP_AGGRESSIVE_PM (1 << 7) /* Suspend (e)MMC/SD at idle */
247 #define MMC_CAP_NONREMOVABLE (1 << 8) /* Nonremovable e.g. eMMC */
248 #define MMC_CAP_WAIT_WHILE_BUSY (1 << 9) /* Waits while card is busy */
249 #define MMC_CAP_ERASE (1 << 10) /* Allow erase/trim commands */
250 #define MMC_CAP_1_8V_DDR (1 << 11) /* can support */
251 /* DDR mode at 1.8V */
252 #define MMC_CAP_1_2V_DDR (1 << 12) /* can support */
253 /* DDR mode at 1.2V */
254 #define MMC_CAP_POWER_OFF_CARD (1 << 13) /* Can power off after boot */
255 #define MMC_CAP_BUS_WIDTH_TEST (1 << 14) /* CMD14/CMD19 bus width ok */
256 #define MMC_CAP_UHS_SDR12 (1 << 15) /* Host supports UHS SDR12 mode */
257 #define MMC_CAP_UHS_SDR25 (1 << 16) /* Host supports UHS SDR25 mode */
258 #define MMC_CAP_UHS_SDR50 (1 << 17) /* Host supports UHS SDR50 mode */
259 #define MMC_CAP_UHS_SDR104 (1 << 18) /* Host supports UHS SDR104 mode */
260 #define MMC_CAP_UHS_DDR50 (1 << 19) /* Host supports UHS DDR50 mode */
261 #define MMC_CAP_RUNTIME_RESUME (1 << 20) /* Resume at runtime_resume. */
262 #define MMC_CAP_DRIVER_TYPE_A (1 << 23) /* Host supports Driver Type A */
263 #define MMC_CAP_DRIVER_TYPE_C (1 << 24) /* Host supports Driver Type C */
264 #define MMC_CAP_DRIVER_TYPE_D (1 << 25) /* Host supports Driver Type D */
265 #define MMC_CAP_CMD23 (1 << 30) /* CMD23 supported. */
266 #define MMC_CAP_HW_RESET (1 << 31) /* Hardware reset */
268 u32 caps2; /* More host capabilities */
270 #define MMC_CAP2_BOOTPART_NOACC (1 << 0) /* Boot partition no access */
271 #define MMC_CAP2_CACHE_CTRL (1 << 1) /* Allow cache control */
272 #define MMC_CAP2_FULL_PWR_CYCLE (1 << 2) /* Can do full power cycle */
273 #define MMC_CAP2_NO_MULTI_READ (1 << 3) /* Multiblock reads don't work */
274 #define MMC_CAP2_NO_SLEEP_CMD (1 << 4) /* Don't allow sleep command */
275 #define MMC_CAP2_HS200_1_8V_SDR (1 << 5) /* can support */
276 #define MMC_CAP2_HS200_1_2V_SDR (1 << 6) /* can support */
277 #define MMC_CAP2_HS200 (MMC_CAP2_HS200_1_8V_SDR | \
278 MMC_CAP2_HS200_1_2V_SDR)
279 #define MMC_CAP2_BROKEN_VOLTAGE (1 << 7) /* Use the broken voltage */
280 #define MMC_CAP2_HC_ERASE_SZ (1 << 9) /* High-capacity erase size */
281 #define MMC_CAP2_CD_ACTIVE_HIGH (1 << 10) /* Card-detect signal active high */
282 #define MMC_CAP2_RO_ACTIVE_HIGH (1 << 11) /* Write-protect signal active high */
283 #define MMC_CAP2_PACKED_RD (1 << 12) /* Allow packed read */
284 #define MMC_CAP2_PACKED_WR (1 << 13) /* Allow packed write */
285 #define MMC_CAP2_PACKED_CMD (MMC_CAP2_PACKED_RD | \
287 #define MMC_CAP2_NO_PRESCAN_POWERUP (1 << 14) /* Don't power up before scan */
288 #define MMC_CAP2_SANITIZE (1 << 15) /* Support Sanitize */
290 mmc_pm_flag_t pm_caps; /* supported pm features */
292 u32 restrict_caps; /*restrict the SDMMC controller to support card type;1--SD card; 2--sdio; 4--eMMC */
293 #define RESTRICT_CARD_TYPE_SD (1 << 0) /*support SD*/
294 #define RESTRICT_CARD_TYPE_SDIO (1 << 1) /*support SDIO*/
295 #define RESTRICT_CARD_TYPE_EMMC (1 << 2) /*support EMMC*/
296 #define RESTRICT_CARD_TYPE_TSD (1 << 3) /*support tSD*/
297 unsigned int hold_reg_flag;//to fix the hold_reg value
300 #ifdef CONFIG_MMC_CLKGATE
301 int clk_requests; /* internal reference counter */
302 unsigned int clk_delay; /* number of MCI clk hold cycles */
303 bool clk_gated; /* clock gated */
304 struct delayed_work clk_gate_work; /* delayed clock gate */
305 unsigned int clk_old; /* old clock value cache */
306 spinlock_t clk_lock; /* lock for clk fields */
307 struct mutex clk_gate_mutex; /* mutex for clock gating */
308 struct device_attribute clkgate_delay_attr;
309 unsigned long clkgate_delay;
312 /* host specific block data */
313 unsigned int max_seg_size; /* see blk_queue_max_segment_size */
314 unsigned short max_segs; /* see blk_queue_max_segments */
315 unsigned short unused;
316 unsigned int max_req_size; /* maximum number of bytes in one req */
317 unsigned int max_blk_size; /* maximum size of one mmc block */
318 unsigned int max_blk_count; /* maximum number of blocks in one req */
319 unsigned int max_discard_to; /* max. discard timeout in ms */
322 spinlock_t lock; /* lock for claim and bus ops */
324 struct mmc_ios ios; /* current io bus settings */
326 /* group bitfields together to minimize padding */
327 unsigned int use_spi_crc:1;
328 unsigned int claimed:1; /* host exclusively claimed */
329 unsigned int bus_dead:1; /* bus has been released */
330 #ifdef CONFIG_MMC_DEBUG
331 unsigned int removed:1; /* host is being removed */
334 int rescan_disable; /* disable card detection */
335 int rescan_entered; /* used with nonremovable devices */
338 unsigned int can_retune:1; /* re-tuning can be used */
339 unsigned int doing_retune:1; /* re-tuning in progress */
340 unsigned int retune_now:1; /* do re-tuning at next req */
341 int need_retune; /* re-tuning is needed */
342 int hold_retune; /* hold off re-tuning */
344 struct mmc_card *card; /* device attached to this host */
346 wait_queue_head_t wq;
347 struct task_struct *claimer; /* task that has host claimed */
348 int claim_cnt; /* "claim" nesting count */
350 struct delayed_work detect;
351 struct wake_lock detect_wake_lock;
352 int detect_change; /* card detect flag */
353 struct mmc_slot slot;
355 const struct mmc_bus_ops *bus_ops; /* current bus driver */
356 unsigned int bus_refs; /* reference counter */
358 unsigned int re_initialized_flags; //in order to begin the rescan ; added by xbw@2011-04-07
359 unsigned int doneflag; //added by xbw at 2011-08-27
360 int (*sdmmc_host_hw_init)(void *data);
361 unsigned int bus_resume_flags;
362 #define MMC_BUSRESUME_MANUAL_RESUME (1 << 0)
363 #define MMC_BUSRESUME_NEEDS_RESUME (1 << 1)
365 unsigned int sdio_irqs;
366 struct task_struct *sdio_irq_thread;
367 bool sdio_irq_pending;
368 atomic_t sdio_irq_thread_abort;
370 mmc_pm_flag_t pm_flags; /* requested pm features */
372 struct led_trigger *led; /* activity led */
374 #ifdef CONFIG_REGULATOR
375 bool regulator_enabled; /* regulator state */
377 struct mmc_supply supply;
379 struct dentry *debugfs_root;
381 struct mmc_async_req *areq; /* active async req */
382 struct mmc_context_info context_info; /* async synchronization info */
384 #ifdef CONFIG_FAIL_MMC_REQUEST
385 struct fault_attr fail_mmc_request;
388 unsigned int actual_clock; /* Actual HC clock rate */
390 unsigned int slotno; /* used for sdio acpi binding */
392 #ifdef CONFIG_MMC_EMBEDDED_SDIO
394 struct sdio_cis *cis;
395 struct sdio_cccr *cccr;
396 struct sdio_embedded_func *funcs;
398 } embedded_sdio_data;
401 unsigned long private[0] ____cacheline_aligned;
404 struct mmc_host *mmc_alloc_host(int extra, struct device *);
405 int mmc_add_host(struct mmc_host *);
406 void mmc_remove_host(struct mmc_host *);
407 void mmc_free_host(struct mmc_host *);
408 int mmc_of_parse(struct mmc_host *host);
409 int mmc_host_rescan(struct mmc_host *host, int val, int irq_type);
410 #ifdef CONFIG_MMC_EMBEDDED_SDIO
411 extern void mmc_set_embedded_sdio_data(struct mmc_host *host,
412 struct sdio_cis *cis,
413 struct sdio_cccr *cccr,
414 struct sdio_embedded_func *funcs,
418 static inline void *mmc_priv(struct mmc_host *host)
420 return (void *)host->private;
423 #define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI)
425 #define mmc_dev(x) ((x)->parent)
426 #define mmc_classdev(x) (&(x)->class_dev)
427 #define mmc_hostname(x) (dev_name(&(x)->class_dev))
428 #define mmc_bus_needs_resume(host) ((host)->bus_resume_flags & MMC_BUSRESUME_NEEDS_RESUME)
429 #define mmc_bus_manual_resume(host) ((host)->bus_resume_flags & MMC_BUSRESUME_MANUAL_RESUME)
431 static inline void mmc_set_bus_resume_policy(struct mmc_host *host, int manual)
434 host->bus_resume_flags |= MMC_BUSRESUME_MANUAL_RESUME;
436 host->bus_resume_flags &= ~MMC_BUSRESUME_MANUAL_RESUME;
439 extern int mmc_resume_bus(struct mmc_host *host);
441 int mmc_power_save_host(struct mmc_host *host);
442 int mmc_power_restore_host(struct mmc_host *host);
444 void mmc_detect_change(struct mmc_host *, unsigned long delay);
445 void mmc_request_done(struct mmc_host *, struct mmc_request *);
447 int mmc_cache_ctrl(struct mmc_host *, u8);
449 static inline void mmc_signal_sdio_irq(struct mmc_host *host)
451 host->ops->enable_sdio_irq(host, 0);
452 host->sdio_irq_pending = true;
453 wake_up_process(host->sdio_irq_thread);
456 #ifdef CONFIG_REGULATOR
457 int mmc_regulator_get_ocrmask(struct regulator *supply);
458 int mmc_regulator_set_ocr(struct mmc_host *mmc,
459 struct regulator *supply,
460 unsigned short vdd_bit);
461 int mmc_regulator_get_supply(struct mmc_host *mmc);
463 static inline int mmc_regulator_get_ocrmask(struct regulator *supply)
468 static inline int mmc_regulator_set_ocr(struct mmc_host *mmc,
469 struct regulator *supply,
470 unsigned short vdd_bit)
475 static inline int mmc_regulator_get_supply(struct mmc_host *mmc)
481 int mmc_pm_notify(struct notifier_block *notify_block, unsigned long, void *);
483 /* Module parameter */
484 extern bool mmc_assume_removable;
486 static inline int mmc_card_is_removable(struct mmc_host *host)
488 return !(host->caps & MMC_CAP_NONREMOVABLE) && mmc_assume_removable;
491 static inline int mmc_card_keep_power(struct mmc_host *host)
493 return host->pm_flags & MMC_PM_KEEP_POWER;
496 static inline int mmc_card_wake_sdio_irq(struct mmc_host *host)
498 return host->pm_flags & MMC_PM_WAKE_SDIO_IRQ;
501 static inline int mmc_host_cmd23(struct mmc_host *host)
503 return host->caps & MMC_CAP_CMD23;
506 static inline int mmc_boot_partition_access(struct mmc_host *host)
508 return !(host->caps2 & MMC_CAP2_BOOTPART_NOACC);
511 static inline int mmc_host_uhs(struct mmc_host *host)
514 (MMC_CAP_UHS_SDR12 | MMC_CAP_UHS_SDR25 |
515 MMC_CAP_UHS_SDR50 | MMC_CAP_UHS_SDR104 |
519 static inline int mmc_host_packed_wr(struct mmc_host *host)
521 return host->caps2 & MMC_CAP2_PACKED_WR;
524 #ifdef CONFIG_MMC_CLKGATE
525 void mmc_host_clk_hold(struct mmc_host *host);
526 void mmc_host_clk_release(struct mmc_host *host);
527 unsigned int mmc_host_clk_rate(struct mmc_host *host);
530 static inline void mmc_host_clk_hold(struct mmc_host *host)
534 static inline void mmc_host_clk_release(struct mmc_host *host)
538 static inline unsigned int mmc_host_clk_rate(struct mmc_host *host)
540 return host->ios.clock;
544 void mmc_retune_enable(struct mmc_host *host);
545 void mmc_retune_disable(struct mmc_host *host);
546 void mmc_retune_hold(struct mmc_host *host);
547 void mmc_retune_release(struct mmc_host *host);
548 int mmc_retune(struct mmc_host *host);
550 static inline void mmc_retune_needed(struct mmc_host *host)
552 if ((host->can_retune) && (host->doing_retune == 0)) {
553 host->need_retune = 1;
554 pr_err("[%s] Data transmission error, need to "
555 "try retuning %d.\n", mmc_hostname(host),
558 pr_err("[%s] host was already tuning, Don't"
559 " need to retry tune again ignore %d.\n",
560 mmc_hostname(host), host->need_retune);
564 static inline void mmc_retune_not_needed(struct mmc_host *host)
566 host->need_retune = 0;
569 static inline void mmc_retune_recheck(struct mmc_host *host)
571 if (host->hold_retune <= 1)
572 host->retune_now = 1;
575 #endif /* LINUX_MMC_HOST_H */