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