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