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> |
| 14 | |
Pierre Ossman | aaac1b4 | 2007-02-28 15:33:10 +0100 | [diff] [blame] | 15 | #include <linux/mmc/core.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 16 | |
| 17 | struct mmc_ios { |
| 18 | unsigned int clock; /* clock rate */ |
| 19 | unsigned short vdd; |
| 20 | |
Philip Langdale | 4be34c9 | 2007-03-11 17:15:15 -0700 | [diff] [blame] | 21 | /* vdd stores the bit number of the selected voltage range from below. */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 22 | |
| 23 | unsigned char bus_mode; /* command output mode */ |
| 24 | |
| 25 | #define MMC_BUSMODE_OPENDRAIN 1 |
| 26 | #define MMC_BUSMODE_PUSHPULL 2 |
| 27 | |
Pierre Ossman | 865e9f1 | 2005-09-03 16:45:02 +0100 | [diff] [blame] | 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 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 |
Pierre Ossman | f218278 | 2005-09-06 15:18:55 -0700 | [diff] [blame] | 39 | |
| 40 | unsigned char bus_width; /* data bus width */ |
| 41 | |
| 42 | #define MMC_BUS_WIDTH_1 0 |
| 43 | #define MMC_BUS_WIDTH_4 2 |
Pierre Ossman | cd9277c | 2007-02-18 12:07:47 +0100 | [diff] [blame] | 44 | |
| 45 | unsigned char timing; /* timing specification used */ |
| 46 | |
| 47 | #define MMC_TIMING_LEGACY 0 |
| 48 | #define MMC_TIMING_MMC_HS 1 |
| 49 | #define MMC_TIMING_SD_HS 2 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 50 | }; |
| 51 | |
| 52 | struct mmc_host_ops { |
| 53 | void (*request)(struct mmc_host *host, struct mmc_request *req); |
Anton Vorontsov | 28f5248 | 2008-06-17 18:17:15 +0400 | [diff] [blame] | 54 | /* |
| 55 | * Avoid calling these three functions too often or in a "fast path", |
| 56 | * since underlaying controller might implement them in an expensive |
| 57 | * and/or slow way. |
| 58 | * |
| 59 | * Also note that these functions might sleep, so don't call them |
| 60 | * in the atomic contexts! |
| 61 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 62 | void (*set_ios)(struct mmc_host *host, struct mmc_ios *ios); |
Pierre Ossman | a00fc09 | 2005-09-06 15:18:52 -0700 | [diff] [blame] | 63 | int (*get_ro)(struct mmc_host *host); |
Anton Vorontsov | 28f5248 | 2008-06-17 18:17:15 +0400 | [diff] [blame] | 64 | int (*get_cd)(struct mmc_host *host); |
| 65 | |
Nicolas Pitre | 17b759a | 2007-07-24 02:09:39 -0400 | [diff] [blame] | 66 | void (*enable_sdio_irq)(struct mmc_host *host, int enable); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 67 | }; |
| 68 | |
| 69 | struct mmc_card; |
| 70 | struct device; |
| 71 | |
| 72 | struct mmc_host { |
Greg Kroah-Hartman | fcaf71f | 2006-09-12 17:00:10 +0200 | [diff] [blame] | 73 | struct device *parent; |
| 74 | struct device class_dev; |
Russell King | dce7737 | 2005-08-19 09:42:52 +0100 | [diff] [blame] | 75 | int index; |
David Brownell | f57b225 | 2006-09-03 06:43:33 -0700 | [diff] [blame] | 76 | const struct mmc_host_ops *ops; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 77 | unsigned int f_min; |
| 78 | unsigned int f_max; |
| 79 | u32 ocr_avail; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 80 | |
Philip Langdale | 55556da | 2007-03-16 19:39:00 -0700 | [diff] [blame] | 81 | #define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */ |
Pierre Ossman | f74d132 | 2007-02-09 22:49:31 +0100 | [diff] [blame] | 82 | #define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */ |
| 83 | #define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */ |
| 84 | #define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */ |
| 85 | #define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */ |
| 86 | #define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */ |
| 87 | #define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */ |
| 88 | #define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */ |
| 89 | #define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */ |
| 90 | #define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */ |
| 91 | #define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */ |
| 92 | #define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */ |
| 93 | #define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */ |
| 94 | #define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */ |
| 95 | #define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */ |
| 96 | #define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */ |
| 97 | #define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */ |
| 98 | |
Pierre Ossman | f218278 | 2005-09-06 15:18:55 -0700 | [diff] [blame] | 99 | unsigned long caps; /* Host capabilities */ |
| 100 | |
| 101 | #define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */ |
Russell King | db53f28 | 2006-08-30 15:14:56 +0100 | [diff] [blame] | 102 | #define MMC_CAP_MULTIWRITE (1 << 1) /* Can accurately report bytes sent to card on error */ |
Pierre Ossman | 255d01a | 2007-07-24 20:38:53 +0200 | [diff] [blame] | 103 | #define MMC_CAP_MMC_HIGHSPEED (1 << 2) /* Can do MMC high-speed timing */ |
| 104 | #define MMC_CAP_SD_HIGHSPEED (1 << 3) /* Can do SD high-speed timing */ |
Nicolas Pitre | 17b759a | 2007-07-24 02:09:39 -0400 | [diff] [blame] | 105 | #define MMC_CAP_SDIO_IRQ (1 << 4) /* Can signal pending SDIO IRQs */ |
David Brownell | 9701858 | 2007-08-08 09:09:01 -0700 | [diff] [blame] | 106 | #define MMC_CAP_SPI (1 << 5) /* Talks only SPI protocols */ |
Anton Vorontsov | 28f5248 | 2008-06-17 18:17:15 +0400 | [diff] [blame] | 107 | #define MMC_CAP_NEEDS_POLL (1 << 6) /* Needs polling for card-detection */ |
Pierre Ossman | f218278 | 2005-09-06 15:18:55 -0700 | [diff] [blame] | 108 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 109 | /* host specific block data */ |
| 110 | unsigned int max_seg_size; /* see blk_queue_max_segment_size */ |
| 111 | unsigned short max_hw_segs; /* see blk_queue_max_hw_segments */ |
| 112 | unsigned short max_phys_segs; /* see blk_queue_max_phys_segments */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 113 | unsigned short unused; |
Pierre Ossman | 55db890 | 2006-11-21 17:55:45 +0100 | [diff] [blame] | 114 | unsigned int max_req_size; /* maximum number of bytes in one req */ |
Pierre Ossman | fe4a3c7 | 2006-11-21 17:54:23 +0100 | [diff] [blame] | 115 | unsigned int max_blk_size; /* maximum size of one mmc block */ |
Pierre Ossman | 55db890 | 2006-11-21 17:55:45 +0100 | [diff] [blame] | 116 | unsigned int max_blk_count; /* maximum number of blocks in one req */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 117 | |
| 118 | /* private data */ |
Pierre Ossman | 7ea239d | 2006-12-31 00:11:32 +0100 | [diff] [blame] | 119 | spinlock_t lock; /* lock for claim and bus ops */ |
| 120 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 121 | struct mmc_ios ios; /* current io bus settings */ |
| 122 | u32 ocr; /* the current OCR setting */ |
| 123 | |
David Brownell | 9701858 | 2007-08-08 09:09:01 -0700 | [diff] [blame] | 124 | /* group bitfields together to minimize padding */ |
| 125 | unsigned int use_spi_crc:1; |
| 126 | unsigned int claimed:1; /* host exclusively claimed */ |
| 127 | unsigned int bus_dead:1; /* bus has been released */ |
| 128 | #ifdef CONFIG_MMC_DEBUG |
| 129 | unsigned int removed:1; /* host is being removed */ |
| 130 | #endif |
| 131 | |
Pierre Ossman | b855885 | 2007-01-03 19:47:29 +0100 | [diff] [blame] | 132 | struct mmc_card *card; /* device attached to this host */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 133 | |
| 134 | wait_queue_head_t wq; |
Pierre Ossman | f22ee4e | 2006-12-26 15:11:23 +0100 | [diff] [blame] | 135 | |
David Howells | c402895 | 2006-11-22 14:57:56 +0000 | [diff] [blame] | 136 | struct delayed_work detect; |
Russell King | 01357dc | 2005-09-08 22:46:00 +0100 | [diff] [blame] | 137 | |
Pierre Ossman | 7ea239d | 2006-12-31 00:11:32 +0100 | [diff] [blame] | 138 | const struct mmc_bus_ops *bus_ops; /* current bus driver */ |
| 139 | unsigned int bus_refs; /* reference counter */ |
Pierre Ossman | 7ea239d | 2006-12-31 00:11:32 +0100 | [diff] [blame] | 140 | |
Nicolas Pitre | d1496c3 | 2007-06-30 16:29:41 +0200 | [diff] [blame] | 141 | unsigned int sdio_irqs; |
| 142 | struct task_struct *sdio_irq_thread; |
| 143 | atomic_t sdio_irq_thread_abort; |
| 144 | |
Pierre Ossman | af8350c | 2007-09-24 07:15:48 +0200 | [diff] [blame] | 145 | #ifdef CONFIG_LEDS_TRIGGERS |
| 146 | struct led_trigger *led; /* activity led */ |
| 147 | #endif |
| 148 | |
Russell King | 01357dc | 2005-09-08 22:46:00 +0100 | [diff] [blame] | 149 | unsigned long private[0] ____cacheline_aligned; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 150 | }; |
| 151 | |
| 152 | extern struct mmc_host *mmc_alloc_host(int extra, struct device *); |
| 153 | extern int mmc_add_host(struct mmc_host *); |
| 154 | extern void mmc_remove_host(struct mmc_host *); |
| 155 | extern void mmc_free_host(struct mmc_host *); |
| 156 | |
Russell King | 01357dc | 2005-09-08 22:46:00 +0100 | [diff] [blame] | 157 | static inline void *mmc_priv(struct mmc_host *host) |
| 158 | { |
| 159 | return (void *)host->private; |
| 160 | } |
| 161 | |
David Brownell | 9701858 | 2007-08-08 09:09:01 -0700 | [diff] [blame] | 162 | #define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI) |
| 163 | |
Greg Kroah-Hartman | fcaf71f | 2006-09-12 17:00:10 +0200 | [diff] [blame] | 164 | #define mmc_dev(x) ((x)->parent) |
Pierre Ossman | 11354d0 | 2007-01-14 01:41:45 +0100 | [diff] [blame] | 165 | #define mmc_classdev(x) (&(x)->class_dev) |
Greg Kroah-Hartman | fcaf71f | 2006-09-12 17:00:10 +0200 | [diff] [blame] | 166 | #define mmc_hostname(x) ((x)->class_dev.bus_id) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 167 | |
Pavel Machek | 3bfffd9 | 2005-04-16 15:25:37 -0700 | [diff] [blame] | 168 | extern int mmc_suspend_host(struct mmc_host *, pm_message_t); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 169 | extern int mmc_resume_host(struct mmc_host *); |
| 170 | |
Richard Purdie | 8dc0033 | 2005-09-08 17:53:01 +0100 | [diff] [blame] | 171 | extern void mmc_detect_change(struct mmc_host *, unsigned long delay); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 172 | extern void mmc_request_done(struct mmc_host *, struct mmc_request *); |
| 173 | |
Nicolas Pitre | 17b759a | 2007-07-24 02:09:39 -0400 | [diff] [blame] | 174 | static inline void mmc_signal_sdio_irq(struct mmc_host *host) |
| 175 | { |
| 176 | host->ops->enable_sdio_irq(host, 0); |
| 177 | wake_up_process(host->sdio_irq_thread); |
| 178 | } |
| 179 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 180 | #endif |
| 181 | |