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 13 #include <linux/leds.h> 14 #include <linux/sched.h> 15 16 #include <linux/mmc/core.h> 17 #include <linux/mmc/pm.h> 18 19 struct mmc_ios { 20 unsigned int clock; /* clock rate */ 21 unsigned short vdd; 22 23 /* vdd stores the bit number of the selected voltage range from below. */ 24 25 unsigned char bus_mode; /* command output mode */ 26 27 #define MMC_BUSMODE_OPENDRAIN 1 28 #define MMC_BUSMODE_PUSHPULL 2 29 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 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 41 42 unsigned char bus_width; /* data bus width */ 43 44 #define MMC_BUS_WIDTH_1 0 45 #define MMC_BUS_WIDTH_4 2 46 #define MMC_BUS_WIDTH_8 3 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 53 54 unsigned char ddr; /* dual data rate used */ 55 56 #define MMC_SDR_MODE 0 57 #define MMC_1_2V_DDR_MODE 1 58 #define MMC_1_8V_DDR_MODE 2 59 }; 60 61 struct mmc_host_ops { 62 /* 63 * Hosts that support power saving can use the 'enable' and 'disable' 64 * methods to exit and enter power saving states. 'enable' is called 65 * when the host is claimed and 'disable' is called (or scheduled with 66 * a delay) when the host is released. The 'disable' is scheduled if 67 * the disable delay set by 'mmc_set_disable_delay()' is non-zero, 68 * otherwise 'disable' is called immediately. 'disable' may be 69 * scheduled repeatedly, to permit ever greater power saving at the 70 * expense of ever greater latency to re-enable. Rescheduling is 71 * determined by the return value of the 'disable' method. A positive 72 * value gives the delay in milliseconds. 73 * 74 * In the case where a host function (like set_ios) may be called 75 * with or without the host claimed, enabling and disabling can be 76 * done directly and will nest correctly. Call 'mmc_host_enable()' and 77 * 'mmc_host_lazy_disable()' for this purpose, but note that these 78 * functions must be paired. 79 * 80 * Alternatively, 'mmc_host_enable()' may be paired with 81 * 'mmc_host_disable()' which calls 'disable' immediately. In this 82 * case the 'disable' method will be called with 'lazy' set to 0. 83 * This is mainly useful for error paths. 84 * 85 * Because lazy disable may be called from a work queue, the 'disable' 86 * method must claim the host when 'lazy' != 0, which will work 87 * correctly because recursion is detected and handled. 88 */ 89 int (*enable)(struct mmc_host *host); 90 int (*disable)(struct mmc_host *host, int lazy); 91 void (*request)(struct mmc_host *host, struct mmc_request *req); 92 /* 93 * Avoid calling these three functions too often or in a "fast path", 94 * since underlaying controller might implement them in an expensive 95 * and/or slow way. 96 * 97 * Also note that these functions might sleep, so don't call them 98 * in the atomic contexts! 99 * 100 * Return values for the get_ro callback should be: 101 * 0 for a read/write card 102 * 1 for a read-only card 103 * -ENOSYS when not supported (equal to NULL callback) 104 * or a negative errno value when something bad happened 105 * 106 * Return values for the get_cd callback should be: 107 * 0 for a absent card 108 * 1 for a present card 109 * -ENOSYS when not supported (equal to NULL callback) 110 * or a negative errno value when something bad happened 111 */ 112 void (*set_ios)(struct mmc_host *host, struct mmc_ios *ios); 113 int (*get_ro)(struct mmc_host *host); 114 int (*get_cd)(struct mmc_host *host); 115 116 void (*enable_sdio_irq)(struct mmc_host *host, int enable); 117 118 /* optional callback for HC quirks */ 119 void (*init_card)(struct mmc_host *host, struct mmc_card *card); 120 }; 121 122 struct mmc_card; 123 struct device; 124 125 struct mmc_host { 126 struct device *parent; 127 struct device class_dev; 128 int index; 129 const struct mmc_host_ops *ops; 130 unsigned int f_min; 131 unsigned int f_max; 132 unsigned int f_init; 133 u32 ocr_avail; 134 struct notifier_block pm_notify; 135 136 #define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */ 137 #define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */ 138 #define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */ 139 #define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */ 140 #define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */ 141 #define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */ 142 #define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */ 143 #define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */ 144 #define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */ 145 #define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */ 146 #define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */ 147 #define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */ 148 #define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */ 149 #define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */ 150 #define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */ 151 #define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */ 152 #define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */ 153 154 unsigned long caps; /* Host capabilities */ 155 156 #define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */ 157 #define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */ 158 #define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */ 159 #define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */ 160 #define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */ 161 #define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */ 162 #define MMC_CAP_8_BIT_DATA (1 << 6) /* Can the host do 8 bit transfers */ 163 #define MMC_CAP_DISABLE (1 << 7) /* Can the host be disabled */ 164 #define MMC_CAP_NONREMOVABLE (1 << 8) /* Nonremovable e.g. eMMC */ 165 #define MMC_CAP_WAIT_WHILE_BUSY (1 << 9) /* Waits while card is busy */ 166 #define MMC_CAP_ERASE (1 << 10) /* Allow erase/trim commands */ 167 #define MMC_CAP_1_8V_DDR (1 << 11) /* can support */ 168 /* DDR mode at 1.8V */ 169 #define MMC_CAP_1_2V_DDR (1 << 12) /* can support */ 170 /* DDR mode at 1.2V */ 171 172 mmc_pm_flag_t pm_caps; /* supported pm features */ 173 174 /* host specific block data */ 175 unsigned int max_seg_size; /* see blk_queue_max_segment_size */ 176 unsigned short max_segs; /* see blk_queue_max_segments */ 177 unsigned short unused; 178 unsigned int max_req_size; /* maximum number of bytes in one req */ 179 unsigned int max_blk_size; /* maximum size of one mmc block */ 180 unsigned int max_blk_count; /* maximum number of blocks in one req */ 181 182 /* private data */ 183 spinlock_t lock; /* lock for claim and bus ops */ 184 185 struct mmc_ios ios; /* current io bus settings */ 186 u32 ocr; /* the current OCR setting */ 187 188 /* group bitfields together to minimize padding */ 189 unsigned int use_spi_crc:1; 190 unsigned int claimed:1; /* host exclusively claimed */ 191 unsigned int bus_dead:1; /* bus has been released */ 192 #ifdef CONFIG_MMC_DEBUG 193 unsigned int removed:1; /* host is being removed */ 194 #endif 195 196 /* Only used with MMC_CAP_DISABLE */ 197 int enabled; /* host is enabled */ 198 int rescan_disable; /* disable card detection */ 199 int nesting_cnt; /* "enable" nesting count */ 200 int en_dis_recurs; /* detect recursion */ 201 unsigned int disable_delay; /* disable delay in msecs */ 202 struct delayed_work disable; /* disabling work */ 203 204 struct mmc_card *card; /* device attached to this host */ 205 206 wait_queue_head_t wq; 207 struct task_struct *claimer; /* task that has host claimed */ 208 int claim_cnt; /* "claim" nesting count */ 209 210 struct delayed_work detect; 211 212 const struct mmc_bus_ops *bus_ops; /* current bus driver */ 213 unsigned int bus_refs; /* reference counter */ 214 215 unsigned int sdio_irqs; 216 struct task_struct *sdio_irq_thread; 217 atomic_t sdio_irq_thread_abort; 218 219 mmc_pm_flag_t pm_flags; /* requested pm features */ 220 221 #ifdef CONFIG_LEDS_TRIGGERS 222 struct led_trigger *led; /* activity led */ 223 #endif 224 225 #ifdef CONFIG_REGULATOR 226 bool regulator_enabled; /* regulator state */ 227 #endif 228 229 struct dentry *debugfs_root; 230 231 unsigned long private[0] ____cacheline_aligned; 232 }; 233 234 extern struct mmc_host *mmc_alloc_host(int extra, struct device *); 235 extern int mmc_add_host(struct mmc_host *); 236 extern void mmc_remove_host(struct mmc_host *); 237 extern void mmc_free_host(struct mmc_host *); 238 239 static inline void *mmc_priv(struct mmc_host *host) 240 { 241 return (void *)host->private; 242 } 243 244 #define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI) 245 246 #define mmc_dev(x) ((x)->parent) 247 #define mmc_classdev(x) (&(x)->class_dev) 248 #define mmc_hostname(x) (dev_name(&(x)->class_dev)) 249 250 extern int mmc_suspend_host(struct mmc_host *); 251 extern int mmc_resume_host(struct mmc_host *); 252 253 extern int mmc_power_save_host(struct mmc_host *host); 254 extern int mmc_power_restore_host(struct mmc_host *host); 255 256 extern void mmc_detect_change(struct mmc_host *, unsigned long delay); 257 extern void mmc_request_done(struct mmc_host *, struct mmc_request *); 258 259 static inline void mmc_signal_sdio_irq(struct mmc_host *host) 260 { 261 host->ops->enable_sdio_irq(host, 0); 262 wake_up_process(host->sdio_irq_thread); 263 } 264 265 struct regulator; 266 267 #ifdef CONFIG_REGULATOR 268 int mmc_regulator_get_ocrmask(struct regulator *supply); 269 int mmc_regulator_set_ocr(struct mmc_host *mmc, 270 struct regulator *supply, 271 unsigned short vdd_bit); 272 #else 273 static inline int mmc_regulator_get_ocrmask(struct regulator *supply) 274 { 275 return 0; 276 } 277 278 static inline int mmc_regulator_set_ocr(struct mmc_host *mmc, 279 struct regulator *supply, 280 unsigned short vdd_bit) 281 { 282 return 0; 283 } 284 #endif 285 286 int mmc_card_awake(struct mmc_host *host); 287 int mmc_card_sleep(struct mmc_host *host); 288 int mmc_card_can_sleep(struct mmc_host *host); 289 290 int mmc_host_enable(struct mmc_host *host); 291 int mmc_host_disable(struct mmc_host *host); 292 int mmc_host_lazy_disable(struct mmc_host *host); 293 int mmc_pm_notify(struct notifier_block *notify_block, unsigned long, void *); 294 295 static inline void mmc_set_disable_delay(struct mmc_host *host, 296 unsigned int disable_delay) 297 { 298 host->disable_delay = disable_delay; 299 } 300 301 /* Module parameter */ 302 extern int mmc_assume_removable; 303 304 static inline int mmc_card_is_removable(struct mmc_host *host) 305 { 306 return !(host->caps & MMC_CAP_NONREMOVABLE) && mmc_assume_removable; 307 } 308 309 #endif 310 311