MMC headers learn about SPI
[linux-2.6.git] / include / linux / mmc / host.h
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/mmc/core.h>
14
15 struct mmc_ios {
16         unsigned int    clock;                  /* clock rate */
17         unsigned short  vdd;
18
19 /* vdd stores the bit number of the selected voltage range from below. */
20
21         unsigned char   bus_mode;               /* command output mode */
22
23 #define MMC_BUSMODE_OPENDRAIN   1
24 #define MMC_BUSMODE_PUSHPULL    2
25
26         unsigned char   chip_select;            /* SPI chip select */
27
28 #define MMC_CS_DONTCARE         0
29 #define MMC_CS_HIGH             1
30 #define MMC_CS_LOW              2
31
32         unsigned char   power_mode;             /* power supply mode */
33
34 #define MMC_POWER_OFF           0
35 #define MMC_POWER_UP            1
36 #define MMC_POWER_ON            2
37
38         unsigned char   bus_width;              /* data bus width */
39
40 #define MMC_BUS_WIDTH_1         0
41 #define MMC_BUS_WIDTH_4         2
42
43         unsigned char   timing;                 /* timing specification used */
44
45 #define MMC_TIMING_LEGACY       0
46 #define MMC_TIMING_MMC_HS       1
47 #define MMC_TIMING_SD_HS        2
48 };
49
50 struct mmc_host_ops {
51         void    (*request)(struct mmc_host *host, struct mmc_request *req);
52         void    (*set_ios)(struct mmc_host *host, struct mmc_ios *ios);
53         int     (*get_ro)(struct mmc_host *host);
54         void    (*enable_sdio_irq)(struct mmc_host *host, int enable);
55 };
56
57 struct mmc_card;
58 struct device;
59
60 struct mmc_host {
61         struct device           *parent;
62         struct device           class_dev;
63         int                     index;
64         const struct mmc_host_ops *ops;
65         unsigned int            f_min;
66         unsigned int            f_max;
67         u32                     ocr_avail;
68
69 #define MMC_VDD_165_195         0x00000080      /* VDD voltage 1.65 - 1.95 */
70 #define MMC_VDD_20_21           0x00000100      /* VDD voltage 2.0 ~ 2.1 */
71 #define MMC_VDD_21_22           0x00000200      /* VDD voltage 2.1 ~ 2.2 */
72 #define MMC_VDD_22_23           0x00000400      /* VDD voltage 2.2 ~ 2.3 */
73 #define MMC_VDD_23_24           0x00000800      /* VDD voltage 2.3 ~ 2.4 */
74 #define MMC_VDD_24_25           0x00001000      /* VDD voltage 2.4 ~ 2.5 */
75 #define MMC_VDD_25_26           0x00002000      /* VDD voltage 2.5 ~ 2.6 */
76 #define MMC_VDD_26_27           0x00004000      /* VDD voltage 2.6 ~ 2.7 */
77 #define MMC_VDD_27_28           0x00008000      /* VDD voltage 2.7 ~ 2.8 */
78 #define MMC_VDD_28_29           0x00010000      /* VDD voltage 2.8 ~ 2.9 */
79 #define MMC_VDD_29_30           0x00020000      /* VDD voltage 2.9 ~ 3.0 */
80 #define MMC_VDD_30_31           0x00040000      /* VDD voltage 3.0 ~ 3.1 */
81 #define MMC_VDD_31_32           0x00080000      /* VDD voltage 3.1 ~ 3.2 */
82 #define MMC_VDD_32_33           0x00100000      /* VDD voltage 3.2 ~ 3.3 */
83 #define MMC_VDD_33_34           0x00200000      /* VDD voltage 3.3 ~ 3.4 */
84 #define MMC_VDD_34_35           0x00400000      /* VDD voltage 3.4 ~ 3.5 */
85 #define MMC_VDD_35_36           0x00800000      /* VDD voltage 3.5 ~ 3.6 */
86
87         unsigned long           caps;           /* Host capabilities */
88
89 #define MMC_CAP_4_BIT_DATA      (1 << 0)        /* Can the host do 4 bit transfers */
90 #define MMC_CAP_MULTIWRITE      (1 << 1)        /* Can accurately report bytes sent to card on error */
91 #define MMC_CAP_MMC_HIGHSPEED   (1 << 2)        /* Can do MMC high-speed timing */
92 #define MMC_CAP_SD_HIGHSPEED    (1 << 3)        /* Can do SD high-speed timing */
93 #define MMC_CAP_SDIO_IRQ        (1 << 4)        /* Can signal pending SDIO IRQs */
94 #define MMC_CAP_SPI             (1 << 5)        /* Talks only SPI protocols */
95
96         /* host specific block data */
97         unsigned int            max_seg_size;   /* see blk_queue_max_segment_size */
98         unsigned short          max_hw_segs;    /* see blk_queue_max_hw_segments */
99         unsigned short          max_phys_segs;  /* see blk_queue_max_phys_segments */
100         unsigned short          unused;
101         unsigned int            max_req_size;   /* maximum number of bytes in one req */
102         unsigned int            max_blk_size;   /* maximum size of one mmc block */
103         unsigned int            max_blk_count;  /* maximum number of blocks in one req */
104
105         /* private data */
106         spinlock_t              lock;           /* lock for claim and bus ops */
107
108         struct mmc_ios          ios;            /* current io bus settings */
109         u32                     ocr;            /* the current OCR setting */
110
111         /* group bitfields together to minimize padding */
112         unsigned int            use_spi_crc:1;
113         unsigned int            claimed:1;      /* host exclusively claimed */
114         unsigned int            bus_dead:1;     /* bus has been released */
115 #ifdef CONFIG_MMC_DEBUG
116         unsigned int            removed:1;      /* host is being removed */
117 #endif
118
119         unsigned int            mode;           /* current card mode of host */
120 #define MMC_MODE_MMC            0
121 #define MMC_MODE_SD             1
122
123         struct mmc_card         *card;          /* device attached to this host */
124
125         wait_queue_head_t       wq;
126
127         struct delayed_work     detect;
128
129         const struct mmc_bus_ops *bus_ops;      /* current bus driver */
130         unsigned int            bus_refs;       /* reference counter */
131
132         unsigned int            sdio_irqs;
133         struct task_struct      *sdio_irq_thread;
134         atomic_t                sdio_irq_thread_abort;
135
136         unsigned long           private[0] ____cacheline_aligned;
137 };
138
139 extern struct mmc_host *mmc_alloc_host(int extra, struct device *);
140 extern int mmc_add_host(struct mmc_host *);
141 extern void mmc_remove_host(struct mmc_host *);
142 extern void mmc_free_host(struct mmc_host *);
143
144 static inline void *mmc_priv(struct mmc_host *host)
145 {
146         return (void *)host->private;
147 }
148
149 #define mmc_host_is_spi(host)   ((host)->caps & MMC_CAP_SPI)
150
151 #define mmc_dev(x)      ((x)->parent)
152 #define mmc_classdev(x) (&(x)->class_dev)
153 #define mmc_hostname(x) ((x)->class_dev.bus_id)
154
155 extern int mmc_suspend_host(struct mmc_host *, pm_message_t);
156 extern int mmc_resume_host(struct mmc_host *);
157
158 extern void mmc_detect_change(struct mmc_host *, unsigned long delay);
159 extern void mmc_request_done(struct mmc_host *, struct mmc_request *);
160
161 static inline void mmc_signal_sdio_irq(struct mmc_host *host)
162 {
163         host->ops->enable_sdio_irq(host, 0);
164         wake_up_process(host->sdio_irq_thread);
165 }
166
167 #endif
168