host.h 11.8 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12
/*
 *  linux/include/linux/mmc/host.h
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 *  Host driver specific definitions.
 */
#ifndef LINUX_MMC_HOST_H
#define LINUX_MMC_HOST_H

P
Pierre Ossman 已提交
13
#include <linux/leds.h>
14
#include <linux/sched.h>
P
Pierre Ossman 已提交
15

16
#include <linux/mmc/core.h>
17
#include <linux/mmc/pm.h>
L
Linus Torvalds 已提交
18 19 20 21 22

struct mmc_ios {
	unsigned int	clock;			/* clock rate */
	unsigned short	vdd;

23
/* vdd stores the bit number of the selected voltage range from below. */
L
Linus Torvalds 已提交
24 25 26 27 28 29

	unsigned char	bus_mode;		/* command output mode */

#define MMC_BUSMODE_OPENDRAIN	1
#define MMC_BUSMODE_PUSHPULL	2

P
Pierre Ossman 已提交
30 31 32 33 34 35
	unsigned char	chip_select;		/* SPI chip select */

#define MMC_CS_DONTCARE		0
#define MMC_CS_HIGH		1
#define MMC_CS_LOW		2

L
Linus Torvalds 已提交
36 37 38 39 40
	unsigned char	power_mode;		/* power supply mode */

#define MMC_POWER_OFF		0
#define MMC_POWER_UP		1
#define MMC_POWER_ON		2
P
Pierre Ossman 已提交
41 42 43 44 45

	unsigned char	bus_width;		/* data bus width */

#define MMC_BUS_WIDTH_1		0
#define MMC_BUS_WIDTH_4		2
J
Jarkko Lavinen 已提交
46
#define MMC_BUS_WIDTH_8		3
47 48 49 50 51 52

	unsigned char	timing;			/* timing specification used */

#define MMC_TIMING_LEGACY	0
#define MMC_TIMING_MMC_HS	1
#define MMC_TIMING_SD_HS	2
53 54 55 56

	unsigned char	ddr;			/* dual data rate used */

#define MMC_SDR_MODE		0
A
Adrian Hunter 已提交
57 58
#define MMC_1_2V_DDR_MODE	1
#define MMC_1_8V_DDR_MODE	2
59 60 61 62 63

	unsigned char	signal_voltage;		/* signalling voltage (1.8V or 3.3V) */

#define MMC_SIGNAL_VOLTAGE_330	0
#define MMC_SIGNAL_VOLTAGE_180	1
L
Linus Torvalds 已提交
64 65 66
};

struct mmc_host_ops {
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
	/*
	 * Hosts that support power saving can use the 'enable' and 'disable'
	 * methods to exit and enter power saving states. 'enable' is called
	 * when the host is claimed and 'disable' is called (or scheduled with
	 * a delay) when the host is released. The 'disable' is scheduled if
	 * the disable delay set by 'mmc_set_disable_delay()' is non-zero,
	 * otherwise 'disable' is called immediately. 'disable' may be
	 * scheduled repeatedly, to permit ever greater power saving at the
	 * expense of ever greater latency to re-enable. Rescheduling is
	 * determined by the return value of the 'disable' method. A positive
	 * value gives the delay in milliseconds.
	 *
	 * In the case where a host function (like set_ios) may be called
	 * with or without the host claimed, enabling and disabling can be
	 * done directly and will nest correctly. Call 'mmc_host_enable()' and
	 * 'mmc_host_lazy_disable()' for this purpose, but note that these
	 * functions must be paired.
	 *
	 * Alternatively, 'mmc_host_enable()' may be paired with
	 * 'mmc_host_disable()' which calls 'disable' immediately.  In this
	 * case the 'disable' method will be called with 'lazy' set to 0.
	 * This is mainly useful for error paths.
	 *
	 * Because lazy disable may be called from a work queue, the 'disable'
	 * method must claim the host when 'lazy' != 0, which will work
	 * correctly because recursion is detected and handled.
	 */
	int (*enable)(struct mmc_host *host);
	int (*disable)(struct mmc_host *host, int lazy);
L
Linus Torvalds 已提交
96
	void	(*request)(struct mmc_host *host, struct mmc_request *req);
97 98 99 100 101 102 103
	/*
	 * Avoid calling these three functions too often or in a "fast path",
	 * since underlaying controller might implement them in an expensive
	 * and/or slow way.
	 *
	 * Also note that these functions might sleep, so don't call them
	 * in the atomic contexts!
104 105 106 107 108 109 110
	 *
	 * Return values for the get_ro callback should be:
	 *   0 for a read/write card
	 *   1 for a read-only card
	 *   -ENOSYS when not supported (equal to NULL callback)
	 *   or a negative errno value when something bad happened
	 *
111
	 * Return values for the get_cd callback should be:
112 113 114 115
	 *   0 for a absent card
	 *   1 for a present card
	 *   -ENOSYS when not supported (equal to NULL callback)
	 *   or a negative errno value when something bad happened
116
	 */
L
Linus Torvalds 已提交
117
	void	(*set_ios)(struct mmc_host *host, struct mmc_ios *ios);
P
Pierre Ossman 已提交
118
	int	(*get_ro)(struct mmc_host *host);
119 120
	int	(*get_cd)(struct mmc_host *host);

121
	void	(*enable_sdio_irq)(struct mmc_host *host, int enable);
122 123 124

	/* optional callback for HC quirks */
	void	(*init_card)(struct mmc_host *host, struct mmc_card *card);
125 126

	int	(*start_signal_voltage_switch)(struct mmc_host *host, struct mmc_ios *ios);
L
Linus Torvalds 已提交
127 128 129 130 131 132
};

struct mmc_card;
struct device;

struct mmc_host {
133 134
	struct device		*parent;
	struct device		class_dev;
135
	int			index;
D
David Brownell 已提交
136
	const struct mmc_host_ops *ops;
L
Linus Torvalds 已提交
137 138
	unsigned int		f_min;
	unsigned int		f_max;
H
Hein Tibosch 已提交
139
	unsigned int		f_init;
L
Linus Torvalds 已提交
140
	u32			ocr_avail;
141 142 143
	u32			ocr_avail_sdio;	/* SDIO-specific OCR */
	u32			ocr_avail_sd;	/* SD-specific OCR */
	u32			ocr_avail_mmc;	/* MMC-specific OCR */
144
	struct notifier_block	pm_notify;
L
Linus Torvalds 已提交
145

146
#define MMC_VDD_165_195		0x00000080	/* VDD voltage 1.65 - 1.95 */
P
Pierre Ossman 已提交
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
#define MMC_VDD_20_21		0x00000100	/* VDD voltage 2.0 ~ 2.1 */
#define MMC_VDD_21_22		0x00000200	/* VDD voltage 2.1 ~ 2.2 */
#define MMC_VDD_22_23		0x00000400	/* VDD voltage 2.2 ~ 2.3 */
#define MMC_VDD_23_24		0x00000800	/* VDD voltage 2.3 ~ 2.4 */
#define MMC_VDD_24_25		0x00001000	/* VDD voltage 2.4 ~ 2.5 */
#define MMC_VDD_25_26		0x00002000	/* VDD voltage 2.5 ~ 2.6 */
#define MMC_VDD_26_27		0x00004000	/* VDD voltage 2.6 ~ 2.7 */
#define MMC_VDD_27_28		0x00008000	/* VDD voltage 2.7 ~ 2.8 */
#define MMC_VDD_28_29		0x00010000	/* VDD voltage 2.8 ~ 2.9 */
#define MMC_VDD_29_30		0x00020000	/* VDD voltage 2.9 ~ 3.0 */
#define MMC_VDD_30_31		0x00040000	/* VDD voltage 3.0 ~ 3.1 */
#define MMC_VDD_31_32		0x00080000	/* VDD voltage 3.1 ~ 3.2 */
#define MMC_VDD_32_33		0x00100000	/* VDD voltage 3.2 ~ 3.3 */
#define MMC_VDD_33_34		0x00200000	/* VDD voltage 3.3 ~ 3.4 */
#define MMC_VDD_34_35		0x00400000	/* VDD voltage 3.4 ~ 3.5 */
#define MMC_VDD_35_36		0x00800000	/* VDD voltage 3.5 ~ 3.6 */

P
Pierre Ossman 已提交
164 165 166
	unsigned long		caps;		/* Host capabilities */

#define MMC_CAP_4_BIT_DATA	(1 << 0)	/* Can the host do 4 bit transfers */
167 168 169 170 171
#define MMC_CAP_MMC_HIGHSPEED	(1 << 1)	/* Can do MMC high-speed timing */
#define MMC_CAP_SD_HIGHSPEED	(1 << 2)	/* Can do SD high-speed timing */
#define MMC_CAP_SDIO_IRQ	(1 << 3)	/* Can signal pending SDIO IRQs */
#define MMC_CAP_SPI		(1 << 4)	/* Talks only SPI protocols */
#define MMC_CAP_NEEDS_POLL	(1 << 5)	/* Needs polling for card-detection */
J
Jarkko Lavinen 已提交
172
#define MMC_CAP_8_BIT_DATA	(1 << 6)	/* Can the host do 8 bit transfers */
173
#define MMC_CAP_DISABLE		(1 << 7)	/* Can the host be disabled */
174
#define MMC_CAP_NONREMOVABLE	(1 << 8)	/* Nonremovable e.g. eMMC */
175
#define MMC_CAP_WAIT_WHILE_BUSY	(1 << 9)	/* Waits while card is busy */
176
#define MMC_CAP_ERASE		(1 << 10)	/* Allow erase/trim commands */
H
Hanumath Prasad 已提交
177 178 179 180
#define MMC_CAP_1_8V_DDR	(1 << 11)	/* can support */
						/* DDR mode at 1.8V */
#define MMC_CAP_1_2V_DDR	(1 << 12)	/* can support */
						/* DDR mode at 1.2V */
181
#define MMC_CAP_POWER_OFF_CARD	(1 << 13)	/* Can power off after boot */
182
#define MMC_CAP_BUS_WIDTH_TEST	(1 << 14)	/* CMD14/CMD19 bus width ok */
183 184 185 186 187 188 189 190
#define MMC_CAP_UHS_SDR12	(1 << 15)	/* Host supports UHS SDR12 mode */
#define MMC_CAP_UHS_SDR25	(1 << 16)	/* Host supports UHS SDR25 mode */
#define MMC_CAP_UHS_SDR50	(1 << 17)	/* Host supports UHS SDR50 mode */
#define MMC_CAP_UHS_SDR104	(1 << 18)	/* Host supports UHS SDR104 mode */
#define MMC_CAP_UHS_DDR50	(1 << 19)	/* Host supports UHS DDR50 mode */
#define MMC_CAP_SET_XPC_330	(1 << 20)	/* Host supports >150mA current at 3.3V */
#define MMC_CAP_SET_XPC_300	(1 << 21)	/* Host supports >150mA current at 3.0V */
#define MMC_CAP_SET_XPC_180	(1 << 22)	/* Host supports >150mA current at 1.8V */
P
Pierre Ossman 已提交
191

192 193
	mmc_pm_flag_t		pm_caps;	/* supported pm features */

194 195 196 197 198 199 200 201 202
#ifdef CONFIG_MMC_CLKGATE
	int			clk_requests;	/* internal reference counter */
	unsigned int		clk_delay;	/* number of MCI clk hold cycles */
	bool			clk_gated;	/* clock gated */
	struct work_struct	clk_gate_work; /* delayed clock gate */
	unsigned int		clk_old;	/* old clock value cache */
	spinlock_t		clk_lock;	/* lock for clk fields */
#endif

L
Linus Torvalds 已提交
203 204
	/* host specific block data */
	unsigned int		max_seg_size;	/* see blk_queue_max_segment_size */
205
	unsigned short		max_segs;	/* see blk_queue_max_segments */
L
Linus Torvalds 已提交
206
	unsigned short		unused;
207
	unsigned int		max_req_size;	/* maximum number of bytes in one req */
208
	unsigned int		max_blk_size;	/* maximum size of one mmc block */
209
	unsigned int		max_blk_count;	/* maximum number of blocks in one req */
L
Linus Torvalds 已提交
210 211

	/* private data */
P
Pierre Ossman 已提交
212 213
	spinlock_t		lock;		/* lock for claim and bus ops */

L
Linus Torvalds 已提交
214 215 216
	struct mmc_ios		ios;		/* current io bus settings */
	u32			ocr;		/* the current OCR setting */

D
David Brownell 已提交
217 218 219 220 221 222 223 224
	/* group bitfields together to minimize padding */
	unsigned int		use_spi_crc:1;
	unsigned int		claimed:1;	/* host exclusively claimed */
	unsigned int		bus_dead:1;	/* bus has been released */
#ifdef CONFIG_MMC_DEBUG
	unsigned int		removed:1;	/* host is being removed */
#endif

225 226
	/* Only used with MMC_CAP_DISABLE */
	int			enabled;	/* host is enabled */
227
	int			rescan_disable;	/* disable card detection */
228 229 230 231 232
	int			nesting_cnt;	/* "enable" nesting count */
	int			en_dis_recurs;	/* detect recursion */
	unsigned int		disable_delay;	/* disable delay in msecs */
	struct delayed_work	disable;	/* disabling work */

P
Pierre Ossman 已提交
233
	struct mmc_card		*card;		/* device attached to this host */
L
Linus Torvalds 已提交
234 235

	wait_queue_head_t	wq;
236 237
	struct task_struct	*claimer;	/* task that has host claimed */
	int			claim_cnt;	/* "claim" nesting count */
P
Pierre Ossman 已提交
238

D
David Howells 已提交
239
	struct delayed_work	detect;
240

P
Pierre Ossman 已提交
241 242 243
	const struct mmc_bus_ops *bus_ops;	/* current bus driver */
	unsigned int		bus_refs;	/* reference counter */

244 245 246 247
	unsigned int		sdio_irqs;
	struct task_struct	*sdio_irq_thread;
	atomic_t		sdio_irq_thread_abort;

248 249
	mmc_pm_flag_t		pm_flags;	/* requested pm features */

P
Pierre Ossman 已提交
250 251 252 253
#ifdef CONFIG_LEDS_TRIGGERS
	struct led_trigger	*led;		/* activity led */
#endif

254 255 256 257
#ifdef CONFIG_REGULATOR
	bool			regulator_enabled; /* regulator state */
#endif

258 259
	struct dentry		*debugfs_root;

260
	unsigned long		private[0] ____cacheline_aligned;
L
Linus Torvalds 已提交
261 262 263 264 265 266 267
};

extern struct mmc_host *mmc_alloc_host(int extra, struct device *);
extern int mmc_add_host(struct mmc_host *);
extern void mmc_remove_host(struct mmc_host *);
extern void mmc_free_host(struct mmc_host *);

268 269 270 271 272
static inline void *mmc_priv(struct mmc_host *host)
{
	return (void *)host->private;
}

D
David Brownell 已提交
273 274
#define mmc_host_is_spi(host)	((host)->caps & MMC_CAP_SPI)

275
#define mmc_dev(x)	((x)->parent)
P
Pierre Ossman 已提交
276
#define mmc_classdev(x)	(&(x)->class_dev)
277
#define mmc_hostname(x)	(dev_name(&(x)->class_dev))
L
Linus Torvalds 已提交
278

279
extern int mmc_suspend_host(struct mmc_host *);
L
Linus Torvalds 已提交
280 281
extern int mmc_resume_host(struct mmc_host *);

282 283
extern int mmc_power_save_host(struct mmc_host *host);
extern int mmc_power_restore_host(struct mmc_host *host);
284

285
extern void mmc_detect_change(struct mmc_host *, unsigned long delay);
L
Linus Torvalds 已提交
286 287
extern void mmc_request_done(struct mmc_host *, struct mmc_request *);

288 289 290 291 292 293
static inline void mmc_signal_sdio_irq(struct mmc_host *host)
{
	host->ops->enable_sdio_irq(host, 0);
	wake_up_process(host->sdio_irq_thread);
}

D
David Brownell 已提交
294 295
struct regulator;

296
#ifdef CONFIG_REGULATOR
D
David Brownell 已提交
297
int mmc_regulator_get_ocrmask(struct regulator *supply);
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
int mmc_regulator_set_ocr(struct mmc_host *mmc,
			struct regulator *supply,
			unsigned short vdd_bit);
#else
static inline int mmc_regulator_get_ocrmask(struct regulator *supply)
{
	return 0;
}

static inline int mmc_regulator_set_ocr(struct mmc_host *mmc,
				 struct regulator *supply,
				 unsigned short vdd_bit)
{
	return 0;
}
#endif
D
David Brownell 已提交
314

315 316 317 318
int mmc_card_awake(struct mmc_host *host);
int mmc_card_sleep(struct mmc_host *host);
int mmc_card_can_sleep(struct mmc_host *host);

319 320 321
int mmc_host_enable(struct mmc_host *host);
int mmc_host_disable(struct mmc_host *host);
int mmc_host_lazy_disable(struct mmc_host *host);
322
int mmc_pm_notify(struct notifier_block *notify_block, unsigned long, void *);
323 324 325 326 327 328 329

static inline void mmc_set_disable_delay(struct mmc_host *host,
					 unsigned int disable_delay)
{
	host->disable_delay = disable_delay;
}

330 331 332 333 334 335 336 337
/* Module parameter */
extern int mmc_assume_removable;

static inline int mmc_card_is_removable(struct mmc_host *host)
{
	return !(host->caps & MMC_CAP_NONREMOVABLE) && mmc_assume_removable;
}

338
static inline int mmc_card_keep_power(struct mmc_host *host)
339 340 341 342
{
	return host->pm_flags & MMC_PM_KEEP_POWER;
}

343 344 345 346
static inline int mmc_card_wake_sdio_irq(struct mmc_host *host)
{
	return host->pm_flags & MMC_PM_WAKE_SDIO_IRQ;
}
L
Linus Torvalds 已提交
347 348
#endif