blob: 8e2642ebf02f48fe3e817e116158e24edfaaea41 [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 Ossmanaaac1b42007-02-28 15:33:10 +010013#include <linux/mmc/core.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014
15struct mmc_ios {
16 unsigned int clock; /* clock rate */
17 unsigned short vdd;
18
Philip Langdale4be34c92007-03-11 17:15:15 -070019/* vdd stores the bit number of the selected voltage range from below. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21 unsigned char bus_mode; /* command output mode */
22
23#define MMC_BUSMODE_OPENDRAIN 1
24#define MMC_BUSMODE_PUSHPULL 2
25
Pierre Ossman865e9f12005-09-03 16:45:02 +010026 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070032 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
Pierre Ossmanf2182782005-09-06 15:18:55 -070037
38 unsigned char bus_width; /* data bus width */
39
40#define MMC_BUS_WIDTH_1 0
41#define MMC_BUS_WIDTH_4 2
Pierre Ossmancd9277c2007-02-18 12:07:47 +010042
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070048};
49
50struct 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);
Pierre Ossmana00fc092005-09-06 15:18:52 -070053 int (*get_ro)(struct mmc_host *host);
Linus Torvalds1da177e2005-04-16 15:20:36 -070054};
55
56struct mmc_card;
57struct device;
58
59struct mmc_host {
Greg Kroah-Hartmanfcaf71f2006-09-12 17:00:10 +020060 struct device *parent;
61 struct device class_dev;
Russell Kingdce77372005-08-19 09:42:52 +010062 int index;
David Brownellf57b2252006-09-03 06:43:33 -070063 const struct mmc_host_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 unsigned int f_min;
65 unsigned int f_max;
66 u32 ocr_avail;
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
Philip Langdale55556da2007-03-16 19:39:00 -070068#define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
Pierre Ossmanf74d1322007-02-09 22:49:31 +010069#define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
70#define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
71#define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
72#define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
73#define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
74#define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
75#define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
76#define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
77#define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
78#define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
79#define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
80#define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
81#define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
82#define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
83#define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
84#define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
85
Pierre Ossmanf2182782005-09-06 15:18:55 -070086 unsigned long caps; /* Host capabilities */
87
88#define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */
Russell Kingdb53f282006-08-30 15:14:56 +010089#define MMC_CAP_MULTIWRITE (1 << 1) /* Can accurately report bytes sent to card on error */
Pierre Ossman255d01a2007-07-24 20:38:53 +020090#define MMC_CAP_MMC_HIGHSPEED (1 << 2) /* Can do MMC high-speed timing */
91#define MMC_CAP_SD_HIGHSPEED (1 << 3) /* Can do SD high-speed timing */
Pierre Ossmanf2182782005-09-06 15:18:55 -070092
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 /* host specific block data */
94 unsigned int max_seg_size; /* see blk_queue_max_segment_size */
95 unsigned short max_hw_segs; /* see blk_queue_max_hw_segments */
96 unsigned short max_phys_segs; /* see blk_queue_max_phys_segments */
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 unsigned short unused;
Pierre Ossman55db8902006-11-21 17:55:45 +010098 unsigned int max_req_size; /* maximum number of bytes in one req */
Pierre Ossmanfe4a3c72006-11-21 17:54:23 +010099 unsigned int max_blk_size; /* maximum size of one mmc block */
Pierre Ossman55db8902006-11-21 17:55:45 +0100100 unsigned int max_blk_count; /* maximum number of blocks in one req */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
102 /* private data */
Pierre Ossman7ea239d2006-12-31 00:11:32 +0100103 spinlock_t lock; /* lock for claim and bus ops */
104
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 struct mmc_ios ios; /* current io bus settings */
106 u32 ocr; /* the current OCR setting */
107
Pierre Ossman335eadf2005-09-06 15:18:50 -0700108 unsigned int mode; /* current card mode of host */
109#define MMC_MODE_MMC 0
110#define MMC_MODE_SD 1
111
Pierre Ossmanb8558852007-01-03 19:47:29 +0100112 struct mmc_card *card; /* device attached to this host */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
114 wait_queue_head_t wq;
Pierre Ossmanf22ee4e2006-12-26 15:11:23 +0100115 unsigned int claimed:1; /* host exclusively claimed */
116
David Howellsc4028952006-11-22 14:57:56 +0000117 struct delayed_work detect;
Pierre Ossman3b91e552007-02-11 20:43:19 +0100118#ifdef CONFIG_MMC_DEBUG
119 unsigned int removed:1; /* host is being removed */
120#endif
Russell King01357dc2005-09-08 22:46:00 +0100121
Pierre Ossman7ea239d2006-12-31 00:11:32 +0100122 const struct mmc_bus_ops *bus_ops; /* current bus driver */
123 unsigned int bus_refs; /* reference counter */
124 unsigned int bus_dead:1; /* bus has been released */
125
Russell King01357dc2005-09-08 22:46:00 +0100126 unsigned long private[0] ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127};
128
129extern struct mmc_host *mmc_alloc_host(int extra, struct device *);
130extern int mmc_add_host(struct mmc_host *);
131extern void mmc_remove_host(struct mmc_host *);
132extern void mmc_free_host(struct mmc_host *);
133
Russell King01357dc2005-09-08 22:46:00 +0100134static inline void *mmc_priv(struct mmc_host *host)
135{
136 return (void *)host->private;
137}
138
Greg Kroah-Hartmanfcaf71f2006-09-12 17:00:10 +0200139#define mmc_dev(x) ((x)->parent)
Pierre Ossman11354d02007-01-14 01:41:45 +0100140#define mmc_classdev(x) (&(x)->class_dev)
Greg Kroah-Hartmanfcaf71f2006-09-12 17:00:10 +0200141#define mmc_hostname(x) ((x)->class_dev.bus_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
Pavel Machek3bfffd92005-04-16 15:25:37 -0700143extern int mmc_suspend_host(struct mmc_host *, pm_message_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144extern int mmc_resume_host(struct mmc_host *);
145
Richard Purdie8dc00332005-09-08 17:53:01 +0100146extern void mmc_detect_change(struct mmc_host *, unsigned long delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147extern void mmc_request_done(struct mmc_host *, struct mmc_request *);
148
149#endif
150