blob: 10a2080086ca9e6402eec37178bd8dea384f3f92 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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 Ossmanaf8350c2007-09-24 07:15:48 +020013#include <linux/leds.h>
14
Pierre Ossmanaaac1b42007-02-28 15:33:10 +010015#include <linux/mmc/core.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016
17struct mmc_ios {
18 unsigned int clock; /* clock rate */
19 unsigned short vdd;
20
Philip Langdale4be34c92007-03-11 17:15:15 -070021/* vdd stores the bit number of the selected voltage range from below. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070022
23 unsigned char bus_mode; /* command output mode */
24
25#define MMC_BUSMODE_OPENDRAIN 1
26#define MMC_BUSMODE_PUSHPULL 2
27
Pierre Ossman865e9f12005-09-03 16:45:02 +010028 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 Torvalds1da177e2005-04-16 15:20:36 -070034 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 Ossmanf2182782005-09-06 15:18:55 -070039
40 unsigned char bus_width; /* data bus width */
41
42#define MMC_BUS_WIDTH_1 0
43#define MMC_BUS_WIDTH_4 2
Pierre Ossmancd9277c2007-02-18 12:07:47 +010044
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 Torvalds1da177e2005-04-16 15:20:36 -070050};
51
52struct mmc_host_ops {
53 void (*request)(struct mmc_host *host, struct mmc_request *req);
Anton Vorontsov28f52482008-06-17 18:17:15 +040054 /*
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!
Anton Vorontsov08f80bb2008-06-17 18:17:39 +040061 *
62 * Return values for the get_ro callback should be:
63 * 0 for a read/write card
64 * 1 for a read-only card
65 * -ENOSYS when not supported (equal to NULL callback)
66 * or a negative errno value when something bad happened
67 *
68 * Return values for the get_ro callback should be:
69 * 0 for a absent card
70 * 1 for a present card
71 * -ENOSYS when not supported (equal to NULL callback)
72 * or a negative errno value when something bad happened
Anton Vorontsov28f52482008-06-17 18:17:15 +040073 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 void (*set_ios)(struct mmc_host *host, struct mmc_ios *ios);
Pierre Ossmana00fc092005-09-06 15:18:52 -070075 int (*get_ro)(struct mmc_host *host);
Anton Vorontsov28f52482008-06-17 18:17:15 +040076 int (*get_cd)(struct mmc_host *host);
77
Nicolas Pitre17b759a2007-07-24 02:09:39 -040078 void (*enable_sdio_irq)(struct mmc_host *host, int enable);
Linus Torvalds1da177e2005-04-16 15:20:36 -070079};
80
81struct mmc_card;
82struct device;
83
84struct mmc_host {
Greg Kroah-Hartmanfcaf71f2006-09-12 17:00:10 +020085 struct device *parent;
86 struct device class_dev;
Russell Kingdce77372005-08-19 09:42:52 +010087 int index;
David Brownellf57b2252006-09-03 06:43:33 -070088 const struct mmc_host_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 unsigned int f_min;
90 unsigned int f_max;
91 u32 ocr_avail;
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
Philip Langdale55556da2007-03-16 19:39:00 -070093#define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
Pierre Ossmanf74d1322007-02-09 22:49:31 +010094#define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
95#define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
96#define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
97#define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
98#define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
99#define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
100#define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
101#define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
102#define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
103#define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
104#define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
105#define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
106#define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
107#define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
108#define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
109#define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
110
Pierre Ossmanf2182782005-09-06 15:18:55 -0700111 unsigned long caps; /* Host capabilities */
112
113#define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */
Pierre Ossman23af6032008-07-06 01:10:27 +0200114#define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */
115#define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */
116#define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */
117#define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */
118#define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */
Pierre Ossmanf2182782005-09-06 15:18:55 -0700119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 /* host specific block data */
121 unsigned int max_seg_size; /* see blk_queue_max_segment_size */
122 unsigned short max_hw_segs; /* see blk_queue_max_hw_segments */
123 unsigned short max_phys_segs; /* see blk_queue_max_phys_segments */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 unsigned short unused;
Pierre Ossman55db8902006-11-21 17:55:45 +0100125 unsigned int max_req_size; /* maximum number of bytes in one req */
Pierre Ossmanfe4a3c72006-11-21 17:54:23 +0100126 unsigned int max_blk_size; /* maximum size of one mmc block */
Pierre Ossman55db8902006-11-21 17:55:45 +0100127 unsigned int max_blk_count; /* maximum number of blocks in one req */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
129 /* private data */
Pierre Ossman7ea239d2006-12-31 00:11:32 +0100130 spinlock_t lock; /* lock for claim and bus ops */
131
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 struct mmc_ios ios; /* current io bus settings */
133 u32 ocr; /* the current OCR setting */
134
David Brownell97018582007-08-08 09:09:01 -0700135 /* group bitfields together to minimize padding */
136 unsigned int use_spi_crc:1;
137 unsigned int claimed:1; /* host exclusively claimed */
138 unsigned int bus_dead:1; /* bus has been released */
139#ifdef CONFIG_MMC_DEBUG
140 unsigned int removed:1; /* host is being removed */
141#endif
142
Pierre Ossmanb8558852007-01-03 19:47:29 +0100143 struct mmc_card *card; /* device attached to this host */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
145 wait_queue_head_t wq;
Pierre Ossmanf22ee4e2006-12-26 15:11:23 +0100146
David Howellsc4028952006-11-22 14:57:56 +0000147 struct delayed_work detect;
Russell King01357dc2005-09-08 22:46:00 +0100148
Pierre Ossman7ea239d2006-12-31 00:11:32 +0100149 const struct mmc_bus_ops *bus_ops; /* current bus driver */
150 unsigned int bus_refs; /* reference counter */
Pierre Ossman7ea239d2006-12-31 00:11:32 +0100151
Nicolas Pitred1496c32007-06-30 16:29:41 +0200152 unsigned int sdio_irqs;
153 struct task_struct *sdio_irq_thread;
154 atomic_t sdio_irq_thread_abort;
155
Pierre Ossmanaf8350c2007-09-24 07:15:48 +0200156#ifdef CONFIG_LEDS_TRIGGERS
157 struct led_trigger *led; /* activity led */
158#endif
159
Russell King01357dc2005-09-08 22:46:00 +0100160 unsigned long private[0] ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161};
162
163extern struct mmc_host *mmc_alloc_host(int extra, struct device *);
164extern int mmc_add_host(struct mmc_host *);
165extern void mmc_remove_host(struct mmc_host *);
166extern void mmc_free_host(struct mmc_host *);
167
Russell King01357dc2005-09-08 22:46:00 +0100168static inline void *mmc_priv(struct mmc_host *host)
169{
170 return (void *)host->private;
171}
172
David Brownell97018582007-08-08 09:09:01 -0700173#define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI)
174
Greg Kroah-Hartmanfcaf71f2006-09-12 17:00:10 +0200175#define mmc_dev(x) ((x)->parent)
Pierre Ossman11354d02007-01-14 01:41:45 +0100176#define mmc_classdev(x) (&(x)->class_dev)
Greg Kroah-Hartmanfcaf71f2006-09-12 17:00:10 +0200177#define mmc_hostname(x) ((x)->class_dev.bus_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
Pavel Machek3bfffd92005-04-16 15:25:37 -0700179extern int mmc_suspend_host(struct mmc_host *, pm_message_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180extern int mmc_resume_host(struct mmc_host *);
181
Richard Purdie8dc00332005-09-08 17:53:01 +0100182extern void mmc_detect_change(struct mmc_host *, unsigned long delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183extern void mmc_request_done(struct mmc_host *, struct mmc_request *);
184
Nicolas Pitre17b759a2007-07-24 02:09:39 -0400185static inline void mmc_signal_sdio_irq(struct mmc_host *host)
186{
187 host->ops->enable_sdio_irq(host, 0);
188 wake_up_process(host->sdio_irq_thread);
189}
190
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191#endif
192