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 #define MMC_TIMING_UHS_SDR12 MMC_TIMING_LEGACY 54 #define MMC_TIMING_UHS_SDR25 MMC_TIMING_SD_HS 55 #define MMC_TIMING_UHS_SDR50 3 56 #define MMC_TIMING_UHS_SDR104 4 57 #define MMC_TIMING_UHS_DDR50 5 58 59 unsigned char ddr; /* dual data rate used */ 60 61 #define MMC_SDR_MODE 0 62 #define MMC_1_2V_DDR_MODE 1 63 #define MMC_1_8V_DDR_MODE 2 64 65 unsigned char signal_voltage; /* signalling voltage (1.8V or 3.3V) */ 66 67 #define MMC_SIGNAL_VOLTAGE_330 0 68 #define MMC_SIGNAL_VOLTAGE_180 1 69 #define MMC_SIGNAL_VOLTAGE_120 2 70 71 unsigned char drv_type; /* driver type (A, B, C, D) */ 72 73 #define MMC_SET_DRIVER_TYPE_B 0 74 #define MMC_SET_DRIVER_TYPE_A 1 75 #define MMC_SET_DRIVER_TYPE_C 2 76 #define MMC_SET_DRIVER_TYPE_D 3 77 }; 78 79 struct mmc_host_ops { 80 /* 81 * Hosts that support power saving can use the 'enable' and 'disable' 82 * methods to exit and enter power saving states. 'enable' is called 83 * when the host is claimed and 'disable' is called (or scheduled with 84 * a delay) when the host is released. The 'disable' is scheduled if 85 * the disable delay set by 'mmc_set_disable_delay()' is non-zero, 86 * otherwise 'disable' is called immediately. 'disable' may be 87 * scheduled repeatedly, to permit ever greater power saving at the 88 * expense of ever greater latency to re-enable. Rescheduling is 89 * determined by the return value of the 'disable' method. A positive 90 * value gives the delay in milliseconds. 91 * 92 * In the case where a host function (like set_ios) may be called 93 * with or without the host claimed, enabling and disabling can be 94 * done directly and will nest correctly. Call 'mmc_host_enable()' and 95 * 'mmc_host_lazy_disable()' for this purpose, but note that these 96 * functions must be paired. 97 * 98 * Alternatively, 'mmc_host_enable()' may be paired with 99 * 'mmc_host_disable()' which calls 'disable' immediately. In this 100 * case the 'disable' method will be called with 'lazy' set to 0. 101 * This is mainly useful for error paths. 102 * 103 * Because lazy disable may be called from a work queue, the 'disable' 104 * method must claim the host when 'lazy' != 0, which will work 105 * correctly because recursion is detected and handled. 106 */ 107 int (*enable)(struct mmc_host *host); 108 int (*disable)(struct mmc_host *host, int lazy); 109 /* 110 * It is optional for the host to implement pre_req and post_req in 111 * order to support double buffering of requests (prepare one 112 * request while another request is active). 113 */ 114 void (*post_req)(struct mmc_host *host, struct mmc_request *req, 115 int err); 116 void (*pre_req)(struct mmc_host *host, struct mmc_request *req, 117 bool is_first_req); 118 void (*request)(struct mmc_host *host, struct mmc_request *req); 119 /* 120 * Avoid calling these three functions too often or in a "fast path", 121 * since underlaying controller might implement them in an expensive 122 * and/or slow way. 123 * 124 * Also note that these functions might sleep, so don't call them 125 * in the atomic contexts! 126 * 127 * Return values for the get_ro callback should be: 128 * 0 for a read/write card 129 * 1 for a read-only card 130 * -ENOSYS when not supported (equal to NULL callback) 131 * or a negative errno value when something bad happened 132 * 133 * Return values for the get_cd callback should be: 134 * 0 for a absent card 135 * 1 for a present card 136 * -ENOSYS when not supported (equal to NULL callback) 137 * or a negative errno value when something bad happened 138 */ 139 void (*set_ios)(struct mmc_host *host, struct mmc_ios *ios); 140 int (*get_ro)(struct mmc_host *host); 141 int (*get_cd)(struct mmc_host *host); 142 143 void (*enable_sdio_irq)(struct mmc_host *host, int enable); 144 145 /* optional callback for HC quirks */ 146 void (*init_card)(struct mmc_host *host, struct mmc_card *card); 147 148 int (*start_signal_voltage_switch)(struct mmc_host *host, struct mmc_ios *ios); 149 int (*execute_tuning)(struct mmc_host *host); 150 void (*enable_preset_value)(struct mmc_host *host, bool enable); 151 int (*select_drive_strength)(unsigned int max_dtr, int host_drv, int card_drv); 152 }; 153 154 struct mmc_card; 155 struct device; 156 157 struct mmc_async_req { 158 /* active mmc request */ 159 struct mmc_request *mrq; 160 /* 161 * Check error status of completed mmc request. 162 * Returns 0 if success otherwise non zero. 163 */ 164 int (*err_check) (struct mmc_card *, struct mmc_async_req *); 165 }; 166 167 struct mmc_host { 168 struct device *parent; 169 struct device class_dev; 170 int index; 171 const struct mmc_host_ops *ops; 172 unsigned int f_min; 173 unsigned int f_max; 174 unsigned int f_init; 175 u32 ocr_avail; 176 u32 ocr_avail_sdio; /* SDIO-specific OCR */ 177 u32 ocr_avail_sd; /* SD-specific OCR */ 178 u32 ocr_avail_mmc; /* MMC-specific OCR */ 179 struct notifier_block pm_notify; 180 181 #define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */ 182 #define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */ 183 #define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */ 184 #define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */ 185 #define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */ 186 #define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */ 187 #define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */ 188 #define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */ 189 #define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */ 190 #define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */ 191 #define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */ 192 #define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */ 193 #define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */ 194 #define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */ 195 #define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */ 196 #define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */ 197 #define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */ 198 199 unsigned long caps; /* Host capabilities */ 200 201 #define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */ 202 #define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */ 203 #define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */ 204 #define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */ 205 #define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */ 206 #define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */ 207 #define MMC_CAP_8_BIT_DATA (1 << 6) /* Can the host do 8 bit transfers */ 208 #define MMC_CAP_DISABLE (1 << 7) /* Can the host be disabled */ 209 #define MMC_CAP_NONREMOVABLE (1 << 8) /* Nonremovable e.g. eMMC */ 210 #define MMC_CAP_WAIT_WHILE_BUSY (1 << 9) /* Waits while card is busy */ 211 #define MMC_CAP_ERASE (1 << 10) /* Allow erase/trim commands */ 212 #define MMC_CAP_1_8V_DDR (1 << 11) /* can support */ 213 /* DDR mode at 1.8V */ 214 #define MMC_CAP_1_2V_DDR (1 << 12) /* can support */ 215 /* DDR mode at 1.2V */ 216 #define MMC_CAP_POWER_OFF_CARD (1 << 13) /* Can power off after boot */ 217 #define MMC_CAP_BUS_WIDTH_TEST (1 << 14) /* CMD14/CMD19 bus width ok */ 218 #define MMC_CAP_UHS_SDR12 (1 << 15) /* Host supports UHS SDR12 mode */ 219 #define MMC_CAP_UHS_SDR25 (1 << 16) /* Host supports UHS SDR25 mode */ 220 #define MMC_CAP_UHS_SDR50 (1 << 17) /* Host supports UHS SDR50 mode */ 221 #define MMC_CAP_UHS_SDR104 (1 << 18) /* Host supports UHS SDR104 mode */ 222 #define MMC_CAP_UHS_DDR50 (1 << 19) /* Host supports UHS DDR50 mode */ 223 #define MMC_CAP_SET_XPC_330 (1 << 20) /* Host supports >150mA current at 3.3V */ 224 #define MMC_CAP_SET_XPC_300 (1 << 21) /* Host supports >150mA current at 3.0V */ 225 #define MMC_CAP_SET_XPC_180 (1 << 22) /* Host supports >150mA current at 1.8V */ 226 #define MMC_CAP_DRIVER_TYPE_A (1 << 23) /* Host supports Driver Type A */ 227 #define MMC_CAP_DRIVER_TYPE_C (1 << 24) /* Host supports Driver Type C */ 228 #define MMC_CAP_DRIVER_TYPE_D (1 << 25) /* Host supports Driver Type D */ 229 #define MMC_CAP_MAX_CURRENT_200 (1 << 26) /* Host max current limit is 200mA */ 230 #define MMC_CAP_MAX_CURRENT_400 (1 << 27) /* Host max current limit is 400mA */ 231 #define MMC_CAP_MAX_CURRENT_600 (1 << 28) /* Host max current limit is 600mA */ 232 #define MMC_CAP_MAX_CURRENT_800 (1 << 29) /* Host max current limit is 800mA */ 233 #define MMC_CAP_CMD23 (1 << 30) /* CMD23 supported. */ 234 235 mmc_pm_flag_t pm_caps; /* supported pm features */ 236 237 #ifdef CONFIG_MMC_CLKGATE 238 int clk_requests; /* internal reference counter */ 239 unsigned int clk_delay; /* number of MCI clk hold cycles */ 240 bool clk_gated; /* clock gated */ 241 struct work_struct clk_gate_work; /* delayed clock gate */ 242 unsigned int clk_old; /* old clock value cache */ 243 spinlock_t clk_lock; /* lock for clk fields */ 244 struct mutex clk_gate_mutex; /* mutex for clock gating */ 245 #endif 246 247 /* host specific block data */ 248 unsigned int max_seg_size; /* see blk_queue_max_segment_size */ 249 unsigned short max_segs; /* see blk_queue_max_segments */ 250 unsigned short unused; 251 unsigned int max_req_size; /* maximum number of bytes in one req */ 252 unsigned int max_blk_size; /* maximum size of one mmc block */ 253 unsigned int max_blk_count; /* maximum number of blocks in one req */ 254 unsigned int max_discard_to; /* max. discard timeout in ms */ 255 256 /* private data */ 257 spinlock_t lock; /* lock for claim and bus ops */ 258 259 struct mmc_ios ios; /* current io bus settings */ 260 u32 ocr; /* the current OCR setting */ 261 262 /* group bitfields together to minimize padding */ 263 unsigned int use_spi_crc:1; 264 unsigned int claimed:1; /* host exclusively claimed */ 265 unsigned int bus_dead:1; /* bus has been released */ 266 #ifdef CONFIG_MMC_DEBUG 267 unsigned int removed:1; /* host is being removed */ 268 #endif 269 270 /* Only used with MMC_CAP_DISABLE */ 271 int enabled; /* host is enabled */ 272 int rescan_disable; /* disable card detection */ 273 int nesting_cnt; /* "enable" nesting count */ 274 int en_dis_recurs; /* detect recursion */ 275 unsigned int disable_delay; /* disable delay in msecs */ 276 struct delayed_work disable; /* disabling work */ 277 278 struct mmc_card *card; /* device attached to this host */ 279 280 wait_queue_head_t wq; 281 struct task_struct *claimer; /* task that has host claimed */ 282 int claim_cnt; /* "claim" nesting count */ 283 284 struct delayed_work detect; 285 286 const struct mmc_bus_ops *bus_ops; /* current bus driver */ 287 unsigned int bus_refs; /* reference counter */ 288 289 unsigned int sdio_irqs; 290 struct task_struct *sdio_irq_thread; 291 atomic_t sdio_irq_thread_abort; 292 293 mmc_pm_flag_t pm_flags; /* requested pm features */ 294 295 #ifdef CONFIG_LEDS_TRIGGERS 296 struct led_trigger *led; /* activity led */ 297 #endif 298 299 #ifdef CONFIG_REGULATOR 300 bool regulator_enabled; /* regulator state */ 301 #endif 302 303 struct dentry *debugfs_root; 304 305 struct mmc_async_req *areq; /* active async req */ 306 307 unsigned long private[0] ____cacheline_aligned; 308 }; 309 310 extern struct mmc_host *mmc_alloc_host(int extra, struct device *); 311 extern int mmc_add_host(struct mmc_host *); 312 extern void mmc_remove_host(struct mmc_host *); 313 extern void mmc_free_host(struct mmc_host *); 314 315 static inline void *mmc_priv(struct mmc_host *host) 316 { 317 return (void *)host->private; 318 } 319 320 #define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI) 321 322 #define mmc_dev(x) ((x)->parent) 323 #define mmc_classdev(x) (&(x)->class_dev) 324 #define mmc_hostname(x) (dev_name(&(x)->class_dev)) 325 326 extern int mmc_suspend_host(struct mmc_host *); 327 extern int mmc_resume_host(struct mmc_host *); 328 329 extern int mmc_power_save_host(struct mmc_host *host); 330 extern int mmc_power_restore_host(struct mmc_host *host); 331 332 extern void mmc_detect_change(struct mmc_host *, unsigned long delay); 333 extern void mmc_request_done(struct mmc_host *, struct mmc_request *); 334 335 static inline void mmc_signal_sdio_irq(struct mmc_host *host) 336 { 337 host->ops->enable_sdio_irq(host, 0); 338 wake_up_process(host->sdio_irq_thread); 339 } 340 341 struct regulator; 342 343 #ifdef CONFIG_REGULATOR 344 int mmc_regulator_get_ocrmask(struct regulator *supply); 345 int mmc_regulator_set_ocr(struct mmc_host *mmc, 346 struct regulator *supply, 347 unsigned short vdd_bit); 348 #else 349 static inline int mmc_regulator_get_ocrmask(struct regulator *supply) 350 { 351 return 0; 352 } 353 354 static inline int mmc_regulator_set_ocr(struct mmc_host *mmc, 355 struct regulator *supply, 356 unsigned short vdd_bit) 357 { 358 return 0; 359 } 360 #endif 361 362 int mmc_card_awake(struct mmc_host *host); 363 int mmc_card_sleep(struct mmc_host *host); 364 int mmc_card_can_sleep(struct mmc_host *host); 365 366 int mmc_host_enable(struct mmc_host *host); 367 int mmc_host_disable(struct mmc_host *host); 368 int mmc_host_lazy_disable(struct mmc_host *host); 369 int mmc_pm_notify(struct notifier_block *notify_block, unsigned long, void *); 370 371 static inline void mmc_set_disable_delay(struct mmc_host *host, 372 unsigned int disable_delay) 373 { 374 host->disable_delay = disable_delay; 375 } 376 377 /* Module parameter */ 378 extern int mmc_assume_removable; 379 380 static inline int mmc_card_is_removable(struct mmc_host *host) 381 { 382 return !(host->caps & MMC_CAP_NONREMOVABLE) && mmc_assume_removable; 383 } 384 385 static inline int mmc_card_keep_power(struct mmc_host *host) 386 { 387 return host->pm_flags & MMC_PM_KEEP_POWER; 388 } 389 390 static inline int mmc_card_wake_sdio_irq(struct mmc_host *host) 391 { 392 return host->pm_flags & MMC_PM_WAKE_SDIO_IRQ; 393 } 394 395 static inline int mmc_host_cmd23(struct mmc_host *host) 396 { 397 return host->caps & MMC_CAP_CMD23; 398 } 399 #endif /* LINUX_MMC_HOST_H */ 400