Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * linux/include/linux/mmc/host.h |
| 3 | * |
| 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. |
| 7 | * |
| 8 | * Host driver specific definitions. |
| 9 | */ |
| 10 | #ifndef LINUX_MMC_HOST_H |
| 11 | #define LINUX_MMC_HOST_H |
| 12 | |
Pierre Ossman | af8350c | 2007-09-24 07:15:48 +0200 | [diff] [blame] | 13 | #include <linux/leds.h> |
Alexey Dobriyan | d43c36d | 2009-10-07 17:09:06 +0400 | [diff] [blame] | 14 | #include <linux/sched.h> |
Pierre Ossman | af8350c | 2007-09-24 07:15:48 +0200 | [diff] [blame] | 15 | |
Pierre Ossman | aaac1b4 | 2007-02-28 15:33:10 +0100 | [diff] [blame] | 16 | #include <linux/mmc/core.h> |
Nicolas Pitre | da68c4e | 2010-03-05 13:43:31 -0800 | [diff] [blame] | 17 | #include <linux/mmc/pm.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 18 | |
| 19 | struct mmc_ios { |
| 20 | unsigned int clock; /* clock rate */ |
| 21 | unsigned short vdd; |
| 22 | |
Philip Langdale | 4be34c9 | 2007-03-11 17:15:15 -0700 | [diff] [blame] | 23 | /* vdd stores the bit number of the selected voltage range from below. */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 24 | |
| 25 | unsigned char bus_mode; /* command output mode */ |
| 26 | |
| 27 | #define MMC_BUSMODE_OPENDRAIN 1 |
| 28 | #define MMC_BUSMODE_PUSHPULL 2 |
| 29 | |
Pierre Ossman | 865e9f1 | 2005-09-03 16:45:02 +0100 | [diff] [blame] | 30 | unsigned char chip_select; /* SPI chip select */ |
| 31 | |
| 32 | #define MMC_CS_DONTCARE 0 |
| 33 | #define MMC_CS_HIGH 1 |
| 34 | #define MMC_CS_LOW 2 |
| 35 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 36 | unsigned char power_mode; /* power supply mode */ |
| 37 | |
| 38 | #define MMC_POWER_OFF 0 |
| 39 | #define MMC_POWER_UP 1 |
| 40 | #define MMC_POWER_ON 2 |
Pierre Ossman | f218278 | 2005-09-06 15:18:55 -0700 | [diff] [blame] | 41 | |
| 42 | unsigned char bus_width; /* data bus width */ |
| 43 | |
| 44 | #define MMC_BUS_WIDTH_1 0 |
| 45 | #define MMC_BUS_WIDTH_4 2 |
Jarkko Lavinen | b30f8af | 2008-11-17 14:35:21 +0200 | [diff] [blame] | 46 | #define MMC_BUS_WIDTH_8 3 |
Pierre Ossman | cd9277c | 2007-02-18 12:07:47 +0100 | [diff] [blame] | 47 | |
| 48 | unsigned char timing; /* timing specification used */ |
| 49 | |
| 50 | #define MMC_TIMING_LEGACY 0 |
| 51 | #define MMC_TIMING_MMC_HS 1 |
| 52 | #define MMC_TIMING_SD_HS 2 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 53 | }; |
| 54 | |
| 55 | struct mmc_host_ops { |
Adrian Hunter | 8ea926b | 2009-09-22 16:44:29 -0700 | [diff] [blame] | 56 | /* |
| 57 | * Hosts that support power saving can use the 'enable' and 'disable' |
| 58 | * methods to exit and enter power saving states. 'enable' is called |
| 59 | * when the host is claimed and 'disable' is called (or scheduled with |
| 60 | * a delay) when the host is released. The 'disable' is scheduled if |
| 61 | * the disable delay set by 'mmc_set_disable_delay()' is non-zero, |
| 62 | * otherwise 'disable' is called immediately. 'disable' may be |
| 63 | * scheduled repeatedly, to permit ever greater power saving at the |
| 64 | * expense of ever greater latency to re-enable. Rescheduling is |
| 65 | * determined by the return value of the 'disable' method. A positive |
| 66 | * value gives the delay in milliseconds. |
| 67 | * |
| 68 | * In the case where a host function (like set_ios) may be called |
| 69 | * with or without the host claimed, enabling and disabling can be |
| 70 | * done directly and will nest correctly. Call 'mmc_host_enable()' and |
| 71 | * 'mmc_host_lazy_disable()' for this purpose, but note that these |
| 72 | * functions must be paired. |
| 73 | * |
| 74 | * Alternatively, 'mmc_host_enable()' may be paired with |
| 75 | * 'mmc_host_disable()' which calls 'disable' immediately. In this |
| 76 | * case the 'disable' method will be called with 'lazy' set to 0. |
| 77 | * This is mainly useful for error paths. |
| 78 | * |
| 79 | * Because lazy disable may be called from a work queue, the 'disable' |
| 80 | * method must claim the host when 'lazy' != 0, which will work |
| 81 | * correctly because recursion is detected and handled. |
| 82 | */ |
| 83 | int (*enable)(struct mmc_host *host); |
| 84 | int (*disable)(struct mmc_host *host, int lazy); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 85 | void (*request)(struct mmc_host *host, struct mmc_request *req); |
Anton Vorontsov | 28f5248 | 2008-06-17 18:17:15 +0400 | [diff] [blame] | 86 | /* |
| 87 | * Avoid calling these three functions too often or in a "fast path", |
| 88 | * since underlaying controller might implement them in an expensive |
| 89 | * and/or slow way. |
| 90 | * |
| 91 | * Also note that these functions might sleep, so don't call them |
| 92 | * in the atomic contexts! |
Anton Vorontsov | 08f80bb | 2008-06-17 18:17:39 +0400 | [diff] [blame] | 93 | * |
| 94 | * Return values for the get_ro callback should be: |
| 95 | * 0 for a read/write card |
| 96 | * 1 for a read-only card |
| 97 | * -ENOSYS when not supported (equal to NULL callback) |
| 98 | * or a negative errno value when something bad happened |
| 99 | * |
Thomas Petazzoni | ee63a7d | 2008-09-02 10:14:13 +0200 | [diff] [blame] | 100 | * Return values for the get_cd callback should be: |
Anton Vorontsov | 08f80bb | 2008-06-17 18:17:39 +0400 | [diff] [blame] | 101 | * 0 for a absent card |
| 102 | * 1 for a present card |
| 103 | * -ENOSYS when not supported (equal to NULL callback) |
| 104 | * or a negative errno value when something bad happened |
Anton Vorontsov | 28f5248 | 2008-06-17 18:17:15 +0400 | [diff] [blame] | 105 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 106 | void (*set_ios)(struct mmc_host *host, struct mmc_ios *ios); |
Pierre Ossman | a00fc09 | 2005-09-06 15:18:52 -0700 | [diff] [blame] | 107 | int (*get_ro)(struct mmc_host *host); |
Anton Vorontsov | 28f5248 | 2008-06-17 18:17:15 +0400 | [diff] [blame] | 108 | int (*get_cd)(struct mmc_host *host); |
| 109 | |
Nicolas Pitre | 17b759a | 2007-07-24 02:09:39 -0400 | [diff] [blame] | 110 | void (*enable_sdio_irq)(struct mmc_host *host, int enable); |
Daniel Mack | 3fcb027 | 2010-04-01 10:03:25 +0200 | [diff] [blame] | 111 | |
| 112 | /* optional callback for HC quirks */ |
| 113 | void (*init_card)(struct mmc_host *host, struct mmc_card *card); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 114 | }; |
| 115 | |
| 116 | struct mmc_card; |
| 117 | struct device; |
| 118 | |
| 119 | struct mmc_host { |
Greg Kroah-Hartman | fcaf71f | 2006-09-12 17:00:10 +0200 | [diff] [blame] | 120 | struct device *parent; |
| 121 | struct device class_dev; |
Russell King | dce7737 | 2005-08-19 09:42:52 +0100 | [diff] [blame] | 122 | int index; |
David Brownell | f57b225 | 2006-09-03 06:43:33 -0700 | [diff] [blame] | 123 | const struct mmc_host_ops *ops; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 124 | unsigned int f_min; |
| 125 | unsigned int f_max; |
| 126 | u32 ocr_avail; |
Maxim Levitsky | 4c2ef25 | 2010-08-10 18:01:41 -0700 | [diff] [blame] | 127 | struct notifier_block pm_notify; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 128 | |
Philip Langdale | 55556da | 2007-03-16 19:39:00 -0700 | [diff] [blame] | 129 | #define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */ |
Pierre Ossman | f74d132 | 2007-02-09 22:49:31 +0100 | [diff] [blame] | 130 | #define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */ |
| 131 | #define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */ |
| 132 | #define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */ |
| 133 | #define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */ |
| 134 | #define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */ |
| 135 | #define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */ |
| 136 | #define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */ |
| 137 | #define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */ |
| 138 | #define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */ |
| 139 | #define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */ |
| 140 | #define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */ |
| 141 | #define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */ |
| 142 | #define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */ |
| 143 | #define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */ |
| 144 | #define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */ |
| 145 | #define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */ |
| 146 | |
Pierre Ossman | f218278 | 2005-09-06 15:18:55 -0700 | [diff] [blame] | 147 | unsigned long caps; /* Host capabilities */ |
| 148 | |
| 149 | #define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */ |
Pierre Ossman | 23af603 | 2008-07-06 01:10:27 +0200 | [diff] [blame] | 150 | #define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */ |
| 151 | #define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */ |
| 152 | #define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */ |
| 153 | #define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */ |
| 154 | #define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */ |
Jarkko Lavinen | b30f8af | 2008-11-17 14:35:21 +0200 | [diff] [blame] | 155 | #define MMC_CAP_8_BIT_DATA (1 << 6) /* Can the host do 8 bit transfers */ |
Adrian Hunter | 8ea926b | 2009-09-22 16:44:29 -0700 | [diff] [blame] | 156 | #define MMC_CAP_DISABLE (1 << 7) /* Can the host be disabled */ |
Adrian Hunter | 9feae24 | 2009-09-22 16:44:32 -0700 | [diff] [blame] | 157 | #define MMC_CAP_NONREMOVABLE (1 << 8) /* Nonremovable e.g. eMMC */ |
Jarkko Lavinen | b1ebe38 | 2009-09-22 16:44:34 -0700 | [diff] [blame] | 158 | #define MMC_CAP_WAIT_WHILE_BUSY (1 << 9) /* Waits while card is busy */ |
Adrian Hunter | dfe86cb | 2010-08-11 14:17:46 -0700 | [diff] [blame] | 159 | #define MMC_CAP_ERASE (1 << 10) /* Allow erase/trim commands */ |
Pierre Ossman | f218278 | 2005-09-06 15:18:55 -0700 | [diff] [blame] | 160 | |
Nicolas Pitre | da68c4e | 2010-03-05 13:43:31 -0800 | [diff] [blame] | 161 | mmc_pm_flag_t pm_caps; /* supported pm features */ |
| 162 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 163 | /* host specific block data */ |
| 164 | unsigned int max_seg_size; /* see blk_queue_max_segment_size */ |
Martin K. Petersen | a36274e | 2010-09-10 01:33:59 -0400 | [diff] [blame] | 165 | unsigned short max_segs; /* see blk_queue_max_segments */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 166 | unsigned short unused; |
Pierre Ossman | 55db890 | 2006-11-21 17:55:45 +0100 | [diff] [blame] | 167 | unsigned int max_req_size; /* maximum number of bytes in one req */ |
Pierre Ossman | fe4a3c7 | 2006-11-21 17:54:23 +0100 | [diff] [blame] | 168 | unsigned int max_blk_size; /* maximum size of one mmc block */ |
Pierre Ossman | 55db890 | 2006-11-21 17:55:45 +0100 | [diff] [blame] | 169 | unsigned int max_blk_count; /* maximum number of blocks in one req */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 170 | |
| 171 | /* private data */ |
Pierre Ossman | 7ea239d | 2006-12-31 00:11:32 +0100 | [diff] [blame] | 172 | spinlock_t lock; /* lock for claim and bus ops */ |
| 173 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 174 | struct mmc_ios ios; /* current io bus settings */ |
| 175 | u32 ocr; /* the current OCR setting */ |
| 176 | |
David Brownell | 9701858 | 2007-08-08 09:09:01 -0700 | [diff] [blame] | 177 | /* group bitfields together to minimize padding */ |
| 178 | unsigned int use_spi_crc:1; |
| 179 | unsigned int claimed:1; /* host exclusively claimed */ |
| 180 | unsigned int bus_dead:1; /* bus has been released */ |
| 181 | #ifdef CONFIG_MMC_DEBUG |
| 182 | unsigned int removed:1; /* host is being removed */ |
| 183 | #endif |
| 184 | |
Adrian Hunter | 8ea926b | 2009-09-22 16:44:29 -0700 | [diff] [blame] | 185 | /* Only used with MMC_CAP_DISABLE */ |
| 186 | int enabled; /* host is enabled */ |
Maxim Levitsky | 4c2ef25 | 2010-08-10 18:01:41 -0700 | [diff] [blame] | 187 | int rescan_disable; /* disable card detection */ |
Adrian Hunter | 8ea926b | 2009-09-22 16:44:29 -0700 | [diff] [blame] | 188 | int nesting_cnt; /* "enable" nesting count */ |
| 189 | int en_dis_recurs; /* detect recursion */ |
| 190 | unsigned int disable_delay; /* disable delay in msecs */ |
| 191 | struct delayed_work disable; /* disabling work */ |
| 192 | |
Pierre Ossman | b855885 | 2007-01-03 19:47:29 +0100 | [diff] [blame] | 193 | struct mmc_card *card; /* device attached to this host */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 194 | |
| 195 | wait_queue_head_t wq; |
Adrian Hunter | 319a3f1 | 2009-09-22 16:44:30 -0700 | [diff] [blame] | 196 | struct task_struct *claimer; /* task that has host claimed */ |
| 197 | int claim_cnt; /* "claim" nesting count */ |
Pierre Ossman | f22ee4e | 2006-12-26 15:11:23 +0100 | [diff] [blame] | 198 | |
David Howells | c402895 | 2006-11-22 14:57:56 +0000 | [diff] [blame] | 199 | struct delayed_work detect; |
Russell King | 01357dc | 2005-09-08 22:46:00 +0100 | [diff] [blame] | 200 | |
Pierre Ossman | 7ea239d | 2006-12-31 00:11:32 +0100 | [diff] [blame] | 201 | const struct mmc_bus_ops *bus_ops; /* current bus driver */ |
| 202 | unsigned int bus_refs; /* reference counter */ |
Pierre Ossman | 7ea239d | 2006-12-31 00:11:32 +0100 | [diff] [blame] | 203 | |
Nicolas Pitre | d1496c3 | 2007-06-30 16:29:41 +0200 | [diff] [blame] | 204 | unsigned int sdio_irqs; |
| 205 | struct task_struct *sdio_irq_thread; |
| 206 | atomic_t sdio_irq_thread_abort; |
| 207 | |
Nicolas Pitre | da68c4e | 2010-03-05 13:43:31 -0800 | [diff] [blame] | 208 | mmc_pm_flag_t pm_flags; /* requested pm features */ |
| 209 | |
Pierre Ossman | af8350c | 2007-09-24 07:15:48 +0200 | [diff] [blame] | 210 | #ifdef CONFIG_LEDS_TRIGGERS |
| 211 | struct led_trigger *led; /* activity led */ |
| 212 | #endif |
| 213 | |
Haavard Skinnemoen | 6edd8ee | 2008-07-24 14:18:57 +0200 | [diff] [blame] | 214 | struct dentry *debugfs_root; |
| 215 | |
Russell King | 01357dc | 2005-09-08 22:46:00 +0100 | [diff] [blame] | 216 | unsigned long private[0] ____cacheline_aligned; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 217 | }; |
| 218 | |
| 219 | extern struct mmc_host *mmc_alloc_host(int extra, struct device *); |
| 220 | extern int mmc_add_host(struct mmc_host *); |
| 221 | extern void mmc_remove_host(struct mmc_host *); |
| 222 | extern void mmc_free_host(struct mmc_host *); |
| 223 | |
Russell King | 01357dc | 2005-09-08 22:46:00 +0100 | [diff] [blame] | 224 | static inline void *mmc_priv(struct mmc_host *host) |
| 225 | { |
| 226 | return (void *)host->private; |
| 227 | } |
| 228 | |
David Brownell | 9701858 | 2007-08-08 09:09:01 -0700 | [diff] [blame] | 229 | #define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI) |
| 230 | |
Greg Kroah-Hartman | fcaf71f | 2006-09-12 17:00:10 +0200 | [diff] [blame] | 231 | #define mmc_dev(x) ((x)->parent) |
Pierre Ossman | 11354d0 | 2007-01-14 01:41:45 +0100 | [diff] [blame] | 232 | #define mmc_classdev(x) (&(x)->class_dev) |
Kay Sievers | d1b2686 | 2008-11-08 21:37:46 +0100 | [diff] [blame] | 233 | #define mmc_hostname(x) (dev_name(&(x)->class_dev)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 234 | |
Matt Fleming | 1a13f8f | 2010-05-26 14:42:08 -0700 | [diff] [blame] | 235 | extern int mmc_suspend_host(struct mmc_host *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 236 | extern int mmc_resume_host(struct mmc_host *); |
| 237 | |
Adrian Hunter | eae1aee | 2009-09-22 16:44:33 -0700 | [diff] [blame] | 238 | extern void mmc_power_save_host(struct mmc_host *host); |
| 239 | extern void mmc_power_restore_host(struct mmc_host *host); |
| 240 | |
Richard Purdie | 8dc0033 | 2005-09-08 17:53:01 +0100 | [diff] [blame] | 241 | extern void mmc_detect_change(struct mmc_host *, unsigned long delay); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 242 | extern void mmc_request_done(struct mmc_host *, struct mmc_request *); |
| 243 | |
Nicolas Pitre | 17b759a | 2007-07-24 02:09:39 -0400 | [diff] [blame] | 244 | static inline void mmc_signal_sdio_irq(struct mmc_host *host) |
| 245 | { |
| 246 | host->ops->enable_sdio_irq(host, 0); |
| 247 | wake_up_process(host->sdio_irq_thread); |
| 248 | } |
| 249 | |
David Brownell | 5c13941 | 2009-03-11 03:30:43 -0800 | [diff] [blame] | 250 | struct regulator; |
| 251 | |
| 252 | int mmc_regulator_get_ocrmask(struct regulator *supply); |
| 253 | int mmc_regulator_set_ocr(struct regulator *supply, unsigned short vdd_bit); |
| 254 | |
Jarkko Lavinen | b1ebe38 | 2009-09-22 16:44:34 -0700 | [diff] [blame] | 255 | int mmc_card_awake(struct mmc_host *host); |
| 256 | int mmc_card_sleep(struct mmc_host *host); |
| 257 | int mmc_card_can_sleep(struct mmc_host *host); |
| 258 | |
Adrian Hunter | 8ea926b | 2009-09-22 16:44:29 -0700 | [diff] [blame] | 259 | int mmc_host_enable(struct mmc_host *host); |
| 260 | int mmc_host_disable(struct mmc_host *host); |
| 261 | int mmc_host_lazy_disable(struct mmc_host *host); |
Maxim Levitsky | 4c2ef25 | 2010-08-10 18:01:41 -0700 | [diff] [blame] | 262 | int mmc_pm_notify(struct notifier_block *notify_block, unsigned long, void *); |
Adrian Hunter | 8ea926b | 2009-09-22 16:44:29 -0700 | [diff] [blame] | 263 | |
| 264 | static inline void mmc_set_disable_delay(struct mmc_host *host, |
| 265 | unsigned int disable_delay) |
| 266 | { |
| 267 | host->disable_delay = disable_delay; |
| 268 | } |
| 269 | |
Matt Fleming | 71d7d3d | 2010-09-27 09:42:19 +0100 | [diff] [blame] | 270 | /* Module parameter */ |
| 271 | extern int mmc_assume_removable; |
| 272 | |
| 273 | static inline int mmc_card_is_removable(struct mmc_host *host) |
| 274 | { |
| 275 | return !(host->caps & MMC_CAP_NONREMOVABLE) && mmc_assume_removable; |
| 276 | } |
| 277 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 278 | #endif |
| 279 | |