aboutsummaryrefslogtreecommitdiffstats
path: root/include/linux/mmc
diff options
context:
space:
mode:
authorLinus Torvalds <torvalds@ppc970.osdl.org>2005-04-16 18:20:36 -0400
committerLinus Torvalds <torvalds@ppc970.osdl.org>2005-04-16 18:20:36 -0400
commit1da177e4c3f41524e886b7f1b8a0c1fc7321cac2 (patch)
tree0bba044c4ce775e45a88a51686b5d9f90697ea9d /include/linux/mmc
Linux-2.6.12-rc2v2.6.12-rc2
Initial git repository build. I'm not bothering with the full history, even though we have it. We can create a separate "historical" git archive of that later if we want to, and in the meantime it's about 3.2GB when imported into git - space that would just make the early git days unnecessarily complicated, when we don't have a lot of good infrastructure for it. Let it rip!
Diffstat (limited to 'include/linux/mmc')
-rw-r--r--include/linux/mmc/card.h92
-rw-r--r--include/linux/mmc/host.h108
-rw-r--r--include/linux/mmc/mmc.h101
-rw-r--r--include/linux/mmc/protocol.h213
4 files changed, 514 insertions, 0 deletions
diff --git a/include/linux/mmc/card.h b/include/linux/mmc/card.h
new file mode 100644
index 000000000000..aefedf04b9bb
--- /dev/null
+++ b/include/linux/mmc/card.h
@@ -0,0 +1,92 @@
1/*
2 * linux/include/linux/mmc/card.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 * Card driver specific definitions.
9 */
10#ifndef LINUX_MMC_CARD_H
11#define LINUX_MMC_CARD_H
12
13#include <linux/mmc/mmc.h>
14
15struct mmc_cid {
16 unsigned int manfid;
17 char prod_name[8];
18 unsigned int serial;
19 unsigned short oemid;
20 unsigned short year;
21 unsigned char hwrev;
22 unsigned char fwrev;
23 unsigned char month;
24};
25
26struct mmc_csd {
27 unsigned char mmca_vsn;
28 unsigned short cmdclass;
29 unsigned short tacc_clks;
30 unsigned int tacc_ns;
31 unsigned int max_dtr;
32 unsigned int read_blkbits;
33 unsigned int capacity;
34};
35
36struct mmc_host;
37
38/*
39 * MMC device
40 */
41struct mmc_card {
42 struct list_head node; /* node in hosts devices list */
43 struct mmc_host *host; /* the host this device belongs to */
44 struct device dev; /* the device */
45 unsigned int rca; /* relative card address of device */
46 unsigned int state; /* (our) card state */
47#define MMC_STATE_PRESENT (1<<0) /* present in sysfs */
48#define MMC_STATE_DEAD (1<<1) /* device no longer in stack */
49#define MMC_STATE_BAD (1<<2) /* unrecognised device */
50 u32 raw_cid[4]; /* raw card CID */
51 u32 raw_csd[4]; /* raw card CSD */
52 struct mmc_cid cid; /* card identification */
53 struct mmc_csd csd; /* card specific */
54};
55
56#define mmc_card_present(c) ((c)->state & MMC_STATE_PRESENT)
57#define mmc_card_dead(c) ((c)->state & MMC_STATE_DEAD)
58#define mmc_card_bad(c) ((c)->state & MMC_STATE_BAD)
59
60#define mmc_card_set_present(c) ((c)->state |= MMC_STATE_PRESENT)
61#define mmc_card_set_dead(c) ((c)->state |= MMC_STATE_DEAD)
62#define mmc_card_set_bad(c) ((c)->state |= MMC_STATE_BAD)
63
64#define mmc_card_name(c) ((c)->cid.prod_name)
65#define mmc_card_id(c) ((c)->dev.bus_id)
66
67#define mmc_list_to_card(l) container_of(l, struct mmc_card, node)
68#define mmc_get_drvdata(c) dev_get_drvdata(&(c)->dev)
69#define mmc_set_drvdata(c,d) dev_set_drvdata(&(c)->dev, d)
70
71/*
72 * MMC device driver (e.g., Flash card, I/O card...)
73 */
74struct mmc_driver {
75 struct device_driver drv;
76 int (*probe)(struct mmc_card *);
77 void (*remove)(struct mmc_card *);
78 int (*suspend)(struct mmc_card *, pm_message_t);
79 int (*resume)(struct mmc_card *);
80};
81
82extern int mmc_register_driver(struct mmc_driver *);
83extern void mmc_unregister_driver(struct mmc_driver *);
84
85static inline int mmc_card_claim_host(struct mmc_card *card)
86{
87 return __mmc_claim_host(card->host, card);
88}
89
90#define mmc_card_release_host(c) mmc_release_host((c)->host)
91
92#endif
diff --git a/include/linux/mmc/host.h b/include/linux/mmc/host.h
new file mode 100644
index 000000000000..f67686cef62a
--- /dev/null
+++ b/include/linux/mmc/host.h
@@ -0,0 +1,108 @@
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/mmc.h>
14
15struct mmc_ios {
16 unsigned int clock; /* clock rate */
17 unsigned short vdd;
18
19#define MMC_VDD_150 0
20#define MMC_VDD_155 1
21#define MMC_VDD_160 2
22#define MMC_VDD_165 3
23#define MMC_VDD_170 4
24#define MMC_VDD_180 5
25#define MMC_VDD_190 6
26#define MMC_VDD_200 7
27#define MMC_VDD_210 8
28#define MMC_VDD_220 9
29#define MMC_VDD_230 10
30#define MMC_VDD_240 11
31#define MMC_VDD_250 12
32#define MMC_VDD_260 13
33#define MMC_VDD_270 14
34#define MMC_VDD_280 15
35#define MMC_VDD_290 16
36#define MMC_VDD_300 17
37#define MMC_VDD_310 18
38#define MMC_VDD_320 19
39#define MMC_VDD_330 20
40#define MMC_VDD_340 21
41#define MMC_VDD_350 22
42#define MMC_VDD_360 23
43
44 unsigned char bus_mode; /* command output mode */
45
46#define MMC_BUSMODE_OPENDRAIN 1
47#define MMC_BUSMODE_PUSHPULL 2
48
49 unsigned char power_mode; /* power supply mode */
50
51#define MMC_POWER_OFF 0
52#define MMC_POWER_UP 1
53#define MMC_POWER_ON 2
54};
55
56struct mmc_host_ops {
57 void (*request)(struct mmc_host *host, struct mmc_request *req);
58 void (*set_ios)(struct mmc_host *host, struct mmc_ios *ios);
59};
60
61struct mmc_card;
62struct device;
63
64struct mmc_host {
65 struct device *dev;
66 struct mmc_host_ops *ops;
67 unsigned int f_min;
68 unsigned int f_max;
69 u32 ocr_avail;
70 char host_name[8];
71
72 /* host specific block data */
73 unsigned int max_seg_size; /* see blk_queue_max_segment_size */
74 unsigned short max_hw_segs; /* see blk_queue_max_hw_segments */
75 unsigned short max_phys_segs; /* see blk_queue_max_phys_segments */
76 unsigned short max_sectors; /* see blk_queue_max_sectors */
77 unsigned short unused;
78
79 /* private data */
80 struct mmc_ios ios; /* current io bus settings */
81 u32 ocr; /* the current OCR setting */
82
83 struct list_head cards; /* devices attached to this host */
84
85 wait_queue_head_t wq;
86 spinlock_t lock; /* card_busy lock */
87 struct mmc_card *card_busy; /* the MMC card claiming host */
88 struct mmc_card *card_selected; /* the selected MMC card */
89
90 struct work_struct detect;
91};
92
93extern struct mmc_host *mmc_alloc_host(int extra, struct device *);
94extern int mmc_add_host(struct mmc_host *);
95extern void mmc_remove_host(struct mmc_host *);
96extern void mmc_free_host(struct mmc_host *);
97
98#define mmc_priv(x) ((void *)((x) + 1))
99#define mmc_dev(x) ((x)->dev)
100
101extern int mmc_suspend_host(struct mmc_host *, u32);
102extern int mmc_resume_host(struct mmc_host *);
103
104extern void mmc_detect_change(struct mmc_host *);
105extern void mmc_request_done(struct mmc_host *, struct mmc_request *);
106
107#endif
108
diff --git a/include/linux/mmc/mmc.h b/include/linux/mmc/mmc.h
new file mode 100644
index 000000000000..0d35d4ffb360
--- /dev/null
+++ b/include/linux/mmc/mmc.h
@@ -0,0 +1,101 @@
1/*
2 * linux/include/linux/mmc/mmc.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#ifndef MMC_H
9#define MMC_H
10
11#include <linux/list.h>
12#include <linux/interrupt.h>
13#include <linux/device.h>
14
15struct request;
16struct mmc_data;
17struct mmc_request;
18
19struct mmc_command {
20 u32 opcode;
21 u32 arg;
22 u32 resp[4];
23 unsigned int flags; /* expected response type */
24#define MMC_RSP_NONE (0 << 0)
25#define MMC_RSP_SHORT (1 << 0)
26#define MMC_RSP_LONG (2 << 0)
27#define MMC_RSP_MASK (3 << 0)
28#define MMC_RSP_CRC (1 << 3) /* expect valid crc */
29#define MMC_RSP_BUSY (1 << 4) /* card may send busy */
30
31/*
32 * These are the response types, and correspond to valid bit
33 * patterns of the above flags. One additional valid pattern
34 * is all zeros, which means we don't expect a response.
35 */
36#define MMC_RSP_R1 (MMC_RSP_SHORT|MMC_RSP_CRC)
37#define MMC_RSP_R1B (MMC_RSP_SHORT|MMC_RSP_CRC|MMC_RSP_BUSY)
38#define MMC_RSP_R2 (MMC_RSP_LONG|MMC_RSP_CRC)
39#define MMC_RSP_R3 (MMC_RSP_SHORT)
40#define MMC_RSP_R6 (MMC_RSP_SHORT|MMC_RSP_CRC)
41
42 unsigned int retries; /* max number of retries */
43 unsigned int error; /* command error */
44
45#define MMC_ERR_NONE 0
46#define MMC_ERR_TIMEOUT 1
47#define MMC_ERR_BADCRC 2
48#define MMC_ERR_FIFO 3
49#define MMC_ERR_FAILED 4
50#define MMC_ERR_INVALID 5
51
52 struct mmc_data *data; /* data segment associated with cmd */
53 struct mmc_request *mrq; /* assoicated request */
54};
55
56struct mmc_data {
57 unsigned int timeout_ns; /* data timeout (in ns, max 80ms) */
58 unsigned int timeout_clks; /* data timeout (in clocks) */
59 unsigned int blksz_bits; /* data block size */
60 unsigned int blocks; /* number of blocks */
61 unsigned int error; /* data error */
62 unsigned int flags;
63
64#define MMC_DATA_WRITE (1 << 8)
65#define MMC_DATA_READ (1 << 9)
66#define MMC_DATA_STREAM (1 << 10)
67
68 unsigned int bytes_xfered;
69
70 struct mmc_command *stop; /* stop command */
71 struct mmc_request *mrq; /* assoicated request */
72
73 unsigned int sg_len; /* size of scatter list */
74 struct scatterlist *sg; /* I/O scatter list */
75};
76
77struct mmc_request {
78 struct mmc_command *cmd;
79 struct mmc_data *data;
80 struct mmc_command *stop;
81
82 void *done_data; /* completion data */
83 void (*done)(struct mmc_request *);/* completion function */
84};
85
86struct mmc_host;
87struct mmc_card;
88
89extern int mmc_wait_for_req(struct mmc_host *, struct mmc_request *);
90extern int mmc_wait_for_cmd(struct mmc_host *, struct mmc_command *, int);
91
92extern int __mmc_claim_host(struct mmc_host *host, struct mmc_card *card);
93
94static inline void mmc_claim_host(struct mmc_host *host)
95{
96 __mmc_claim_host(host, (struct mmc_card *)-1);
97}
98
99extern void mmc_release_host(struct mmc_host *host);
100
101#endif
diff --git a/include/linux/mmc/protocol.h b/include/linux/mmc/protocol.h
new file mode 100644
index 000000000000..7b904c5102f6
--- /dev/null
+++ b/include/linux/mmc/protocol.h
@@ -0,0 +1,213 @@
1/*
2 * Header for MultiMediaCard (MMC)
3 *
4 * Copyright 2002 Hewlett-Packard Company
5 *
6 * Use consistent with the GNU GPL is permitted,
7 * provided that this copyright notice is
8 * preserved in its entirety in all copies and derived works.
9 *
10 * HEWLETT-PACKARD COMPANY MAKES NO WARRANTIES, EXPRESSED OR IMPLIED,
11 * AS TO THE USEFULNESS OR CORRECTNESS OF THIS CODE OR ITS
12 * FITNESS FOR ANY PARTICULAR PURPOSE.
13 *
14 * Many thanks to Alessandro Rubini and Jonathan Corbet!
15 *
16 * Based strongly on code by:
17 *
18 * Author: Yong-iL Joh <tolkien@mizi.com>
19 * Date : $Date: 2002/06/18 12:37:30 $
20 *
21 * Author: Andrew Christian
22 * 15 May 2002
23 */
24
25#ifndef MMC_MMC_PROTOCOL_H
26#define MMC_MMC_PROTOCOL_H
27
28/* Standard MMC commands (3.1) type argument response */
29 /* class 1 */
30#define MMC_GO_IDLE_STATE 0 /* bc */
31#define MMC_SEND_OP_COND 1 /* bcr [31:0] OCR R3 */
32#define MMC_ALL_SEND_CID 2 /* bcr R2 */
33#define MMC_SET_RELATIVE_ADDR 3 /* ac [31:16] RCA R1 */
34#define MMC_SET_DSR 4 /* bc [31:16] RCA */
35#define MMC_SELECT_CARD 7 /* ac [31:16] RCA R1 */
36#define MMC_SEND_CSD 9 /* ac [31:16] RCA R2 */
37#define MMC_SEND_CID 10 /* ac [31:16] RCA R2 */
38#define MMC_READ_DAT_UNTIL_STOP 11 /* adtc [31:0] dadr R1 */
39#define MMC_STOP_TRANSMISSION 12 /* ac R1b */
40#define MMC_SEND_STATUS 13 /* ac [31:16] RCA R1 */
41#define MMC_GO_INACTIVE_STATE 15 /* ac [31:16] RCA */
42
43 /* class 2 */
44#define MMC_SET_BLOCKLEN 16 /* ac [31:0] block len R1 */
45#define MMC_READ_SINGLE_BLOCK 17 /* adtc [31:0] data addr R1 */
46#define MMC_READ_MULTIPLE_BLOCK 18 /* adtc [31:0] data addr R1 */
47
48 /* class 3 */
49#define MMC_WRITE_DAT_UNTIL_STOP 20 /* adtc [31:0] data addr R1 */
50
51 /* class 4 */
52#define MMC_SET_BLOCK_COUNT 23 /* adtc [31:0] data addr R1 */
53#define MMC_WRITE_BLOCK 24 /* adtc [31:0] data addr R1 */
54#define MMC_WRITE_MULTIPLE_BLOCK 25 /* adtc R1 */
55#define MMC_PROGRAM_CID 26 /* adtc R1 */
56#define MMC_PROGRAM_CSD 27 /* adtc R1 */
57
58 /* class 6 */
59#define MMC_SET_WRITE_PROT 28 /* ac [31:0] data addr R1b */
60#define MMC_CLR_WRITE_PROT 29 /* ac [31:0] data addr R1b */
61#define MMC_SEND_WRITE_PROT 30 /* adtc [31:0] wpdata addr R1 */
62
63 /* class 5 */
64#define MMC_ERASE_GROUP_START 35 /* ac [31:0] data addr R1 */
65#define MMC_ERASE_GROUP_END 36 /* ac [31:0] data addr R1 */
66#define MMC_ERASE 37 /* ac R1b */
67
68 /* class 9 */
69#define MMC_FAST_IO 39 /* ac <Complex> R4 */
70#define MMC_GO_IRQ_STATE 40 /* bcr R5 */
71
72 /* class 7 */
73#define MMC_LOCK_UNLOCK 42 /* adtc R1b */
74
75 /* class 8 */
76#define MMC_APP_CMD 55 /* ac [31:16] RCA R1 */
77#define MMC_GEN_CMD 56 /* adtc [0] RD/WR R1b */
78
79/* SD commands type argument response */
80 /* class 8 */
81/* This is basically the same command as for MMC with some quirks. */
82#define SD_SEND_RELATIVE_ADDR 3 /* ac R6 */
83
84 /* Application commands */
85#define SD_APP_SET_BUS_WIDTH 6 /* ac [1:0] bus width R1 */
86#define SD_APP_OP_COND 41 /* bcr [31:0] OCR R3 */
87#define SD_APP_SEND_SCR 51 /* adtc R1 */
88
89/*
90 MMC status in R1
91 Type
92 e : error bit
93 s : status bit
94 r : detected and set for the actual command response
95 x : detected and set during command execution. the host must poll
96 the card by sending status command in order to read these bits.
97 Clear condition
98 a : according to the card state
99 b : always related to the previous command. Reception of
100 a valid command will clear it (with a delay of one command)
101 c : clear by read
102 */
103
104#define R1_OUT_OF_RANGE (1 << 31) /* er, c */
105#define R1_ADDRESS_ERROR (1 << 30) /* erx, c */
106#define R1_BLOCK_LEN_ERROR (1 << 29) /* er, c */
107#define R1_ERASE_SEQ_ERROR (1 << 28) /* er, c */
108#define R1_ERASE_PARAM (1 << 27) /* ex, c */
109#define R1_WP_VIOLATION (1 << 26) /* erx, c */
110#define R1_CARD_IS_LOCKED (1 << 25) /* sx, a */
111#define R1_LOCK_UNLOCK_FAILED (1 << 24) /* erx, c */
112#define R1_COM_CRC_ERROR (1 << 23) /* er, b */
113#define R1_ILLEGAL_COMMAND (1 << 22) /* er, b */
114#define R1_CARD_ECC_FAILED (1 << 21) /* ex, c */
115#define R1_CC_ERROR (1 << 20) /* erx, c */
116#define R1_ERROR (1 << 19) /* erx, c */
117#define R1_UNDERRUN (1 << 18) /* ex, c */
118#define R1_OVERRUN (1 << 17) /* ex, c */
119#define R1_CID_CSD_OVERWRITE (1 << 16) /* erx, c, CID/CSD overwrite */
120#define R1_WP_ERASE_SKIP (1 << 15) /* sx, c */
121#define R1_CARD_ECC_DISABLED (1 << 14) /* sx, a */
122#define R1_ERASE_RESET (1 << 13) /* sr, c */
123#define R1_STATUS(x) (x & 0xFFFFE000)
124#define R1_CURRENT_STATE(x) ((x & 0x00001E00) >> 9) /* sx, b (4 bits) */
125#define R1_READY_FOR_DATA (1 << 8) /* sx, a */
126#define R1_APP_CMD (1 << 5) /* sr, c */
127
128/* These are unpacked versions of the actual responses */
129
130struct _mmc_csd {
131 u8 csd_structure;
132 u8 spec_vers;
133 u8 taac;
134 u8 nsac;
135 u8 tran_speed;
136 u16 ccc;
137 u8 read_bl_len;
138 u8 read_bl_partial;
139 u8 write_blk_misalign;
140 u8 read_blk_misalign;
141 u8 dsr_imp;
142 u16 c_size;
143 u8 vdd_r_curr_min;
144 u8 vdd_r_curr_max;
145 u8 vdd_w_curr_min;
146 u8 vdd_w_curr_max;
147 u8 c_size_mult;
148 union {
149 struct { /* MMC system specification version 3.1 */
150 u8 erase_grp_size;
151 u8 erase_grp_mult;
152 } v31;
153 struct { /* MMC system specification version 2.2 */
154 u8 sector_size;
155 u8 erase_grp_size;
156 } v22;
157 } erase;
158 u8 wp_grp_size;
159 u8 wp_grp_enable;
160 u8 default_ecc;
161 u8 r2w_factor;
162 u8 write_bl_len;
163 u8 write_bl_partial;
164 u8 file_format_grp;
165 u8 copy;
166 u8 perm_write_protect;
167 u8 tmp_write_protect;
168 u8 file_format;
169 u8 ecc;
170};
171
172#define MMC_VDD_145_150 0x00000001 /* VDD voltage 1.45 - 1.50 */
173#define MMC_VDD_150_155 0x00000002 /* VDD voltage 1.50 - 1.55 */
174#define MMC_VDD_155_160 0x00000004 /* VDD voltage 1.55 - 1.60 */
175#define MMC_VDD_160_165 0x00000008 /* VDD voltage 1.60 - 1.65 */
176#define MMC_VDD_165_170 0x00000010 /* VDD voltage 1.65 - 1.70 */
177#define MMC_VDD_17_18 0x00000020 /* VDD voltage 1.7 - 1.8 */
178#define MMC_VDD_18_19 0x00000040 /* VDD voltage 1.8 - 1.9 */
179#define MMC_VDD_19_20 0x00000080 /* VDD voltage 1.9 - 2.0 */
180#define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
181#define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
182#define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
183#define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
184#define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
185#define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
186#define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
187#define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
188#define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
189#define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
190#define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
191#define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
192#define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
193#define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
194#define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
195#define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
196#define MMC_CARD_BUSY 0x80000000 /* Card Power up status bit */
197
198
199/*
200 * CSD field definitions
201 */
202
203#define CSD_STRUCT_VER_1_0 0 /* Valid for system specification 1.0 - 1.2 */
204#define CSD_STRUCT_VER_1_1 1 /* Valid for system specification 1.4 - 2.2 */
205#define CSD_STRUCT_VER_1_2 2 /* Valid for system specification 3.1 */
206
207#define CSD_SPEC_VER_0 0 /* Implements system specification 1.0 - 1.2 */
208#define CSD_SPEC_VER_1 1 /* Implements system specification 1.4 */
209#define CSD_SPEC_VER_2 2 /* Implements system specification 2.0 - 2.2 */
210#define CSD_SPEC_VER_3 3 /* Implements system specification 3.1 */
211
212#endif /* MMC_MMC_PROTOCOL_H */
213
generated by cgit v1.2.2 (git 2.25.0) at 2026-01-03 21:49:39 -0500