blob: 6b7525099e56a943f014c9fbfcc0c6bc45b62579 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Pierre Ossmanaaac1b42007-02-28 15:33:10 +010013#include <linux/mmc/core.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014
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 {
Kyungmin Park6da24b72010-08-10 18:01:36 -070027 unsigned char structure;
Linus Torvalds1da177e2005-04-16 15:20:36 -070028 unsigned char mmca_vsn;
29 unsigned short cmdclass;
30 unsigned short tacc_clks;
31 unsigned int tacc_ns;
Russell King37be4e72006-05-02 17:24:59 +010032 unsigned int r2w_factor;
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 unsigned int max_dtr;
Adrian Hunterdfe86cb2010-08-11 14:17:46 -070034 unsigned int erase_size; /* In sectors */
Linus Torvalds1da177e2005-04-16 15:20:36 -070035 unsigned int read_blkbits;
Russell Kinga6f6c962006-01-03 22:38:44 +000036 unsigned int write_blkbits;
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 unsigned int capacity;
Russell Kinga6f6c962006-01-03 22:38:44 +000038 unsigned int read_partial:1,
39 read_misalign:1,
Russell Kingce11a162006-01-04 12:40:39 +000040 write_partial:1,
Russell Kinga6f6c962006-01-03 22:38:44 +000041 write_misalign:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070042};
43
Philip Langdalebce40a32006-10-21 12:35:02 +020044struct mmc_ext_csd {
Jarkko Lavinenb1ebe382009-09-22 16:44:34 -070045 u8 rev;
Adrian Hunterdfe86cb2010-08-11 14:17:46 -070046 u8 erase_group_def;
47 u8 sec_feature_support;
Jarkko Lavinenb1ebe382009-09-22 16:44:34 -070048 unsigned int sa_timeout; /* Units: 100ns */
Philip Langdalebce40a32006-10-21 12:35:02 +020049 unsigned int hs_max_dtr;
Pierre Ossman85a18ad2007-02-17 22:15:27 +010050 unsigned int sectors;
Adrian Hunterdfe86cb2010-08-11 14:17:46 -070051 unsigned int hc_erase_size; /* In sectors */
52 unsigned int hc_erase_timeout; /* In milliseconds */
53 unsigned int sec_trim_mult; /* Secure trim multiplier */
54 unsigned int sec_erase_mult; /* Secure erase multiplier */
55 unsigned int trim_timeout; /* In milliseconds */
Philip Langdalebce40a32006-10-21 12:35:02 +020056};
57
Pierre Ossmanb57c43a2005-09-06 15:18:53 -070058struct sd_scr {
59 unsigned char sda_vsn;
60 unsigned char bus_widths;
61#define SD_SCR_BUS_WIDTH_1 (1<<0)
62#define SD_SCR_BUS_WIDTH_4 (1<<2)
63};
64
Adrian Hunterdfe86cb2010-08-11 14:17:46 -070065struct sd_ssr {
66 unsigned int au; /* In sectors */
67 unsigned int erase_timeout; /* In milliseconds */
68 unsigned int erase_offset; /* In milliseconds */
69};
70
Pierre Ossman7ccd2662006-11-08 23:03:10 +010071struct sd_switch_caps {
72 unsigned int hs_max_dtr;
73};
74
Pierre Ossman35c66c12007-06-11 20:25:43 +020075struct sdio_cccr {
76 unsigned int sdio_vsn;
77 unsigned int sd_vsn;
78 unsigned int multi_block:1,
79 low_speed:1,
80 wide_bus:1,
81 high_power:1,
Ohad Ben-Cohen006ebd52009-09-22 16:45:07 -070082 high_speed:1,
83 disable_cd:1;
Pierre Ossman35c66c12007-06-11 20:25:43 +020084};
85
Pierre Ossman1a632f82007-07-30 15:15:30 +020086struct sdio_cis {
87 unsigned short vendor;
88 unsigned short device;
89 unsigned short blksize;
90 unsigned int max_dtr;
91};
92
Linus Torvalds1da177e2005-04-16 15:20:36 -070093struct mmc_host;
Pierre Ossmane29a7d72007-05-26 13:48:18 +020094struct sdio_func;
Pierre Ossman1a632f82007-07-30 15:15:30 +020095struct sdio_func_tuple;
Pierre Ossmane29a7d72007-05-26 13:48:18 +020096
97#define SDIO_MAX_FUNCS 7
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
99/*
100 * MMC device
101 */
102struct mmc_card {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 struct mmc_host *host; /* the host this device belongs to */
104 struct device dev; /* the device */
105 unsigned int rca; /* relative card address of device */
Pierre Ossman9c2c0af2006-12-26 15:25:58 +0100106 unsigned int type; /* card type */
107#define MMC_TYPE_MMC 0 /* MMC card */
108#define MMC_TYPE_SD 1 /* SD card */
Pierre Ossman5c4e6f12007-05-21 20:23:20 +0200109#define MMC_TYPE_SDIO 2 /* SDIO card */
Michal Miroslaw7310ece82010-08-10 18:01:40 -0700110#define MMC_TYPE_SD_COMBO 3 /* SD combo (IO+mem) card */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 unsigned int state; /* (our) card state */
112#define MMC_STATE_PRESENT (1<<0) /* present in sysfs */
Pierre Ossmanbd766312007-05-01 16:11:57 +0200113#define MMC_STATE_READONLY (1<<1) /* card is read-only */
114#define MMC_STATE_HIGHSPEED (1<<2) /* card is in high speed mode */
115#define MMC_STATE_BLOCKADDR (1<<3) /* card uses block-addressing */
Ohad Ben-Cohen7c979ec2009-09-22 16:45:18 -0700116 unsigned int quirks; /* card quirks */
117#define MMC_QUIRK_LENIENT_FN0 (1<<0) /* allow SDIO FN0 writes outside of the VS CCCR range */
Bing Zhao3fb7fb42010-03-05 13:43:25 -0800118#define MMC_QUIRK_BLKSZ_FOR_BYTE_MODE (1<<1) /* use func->cur_blksize */
119 /* for byte mode */
Grazvydas Ignotas6f51be32010-08-10 18:01:50 -0700120#define MMC_QUIRK_NONSTD_SDIO (1<<2) /* non-standard SDIO card attached */
121 /* (missing CIA registers) */
Pierre Ossmane29a7d72007-05-26 13:48:18 +0200122
Adrian Hunterdfe86cb2010-08-11 14:17:46 -0700123 unsigned int erase_size; /* erase size in sectors */
124 unsigned int erase_shift; /* if erase unit is power 2 */
125 unsigned int pref_erase; /* in sectors */
126 u8 erased_byte; /* value of erased bytes */
127
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 u32 raw_cid[4]; /* raw card CID */
129 u32 raw_csd[4]; /* raw card CSD */
Pierre Ossmanb57c43a2005-09-06 15:18:53 -0700130 u32 raw_scr[2]; /* raw card SCR */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 struct mmc_cid cid; /* card identification */
132 struct mmc_csd csd; /* card specific */
Philip Langdalebce40a32006-10-21 12:35:02 +0200133 struct mmc_ext_csd ext_csd; /* mmc v4 extended card specific */
Pierre Ossmanb57c43a2005-09-06 15:18:53 -0700134 struct sd_scr scr; /* extra SD information */
Adrian Hunterdfe86cb2010-08-11 14:17:46 -0700135 struct sd_ssr ssr; /* yet more SD information */
Pierre Ossman7ccd2662006-11-08 23:03:10 +0100136 struct sd_switch_caps sw_caps; /* switch (CMD6) caps */
Pierre Ossmane29a7d72007-05-26 13:48:18 +0200137
138 unsigned int sdio_funcs; /* number of SDIO functions */
Pierre Ossman35c66c12007-06-11 20:25:43 +0200139 struct sdio_cccr cccr; /* common card info */
Pierre Ossman1a632f82007-07-30 15:15:30 +0200140 struct sdio_cis cis; /* common tuple info */
Pierre Ossmane29a7d72007-05-26 13:48:18 +0200141 struct sdio_func *sdio_func[SDIO_MAX_FUNCS]; /* SDIO functions (devices) */
Pierre Ossman759bdc72007-09-19 18:42:16 +0200142 unsigned num_info; /* number of info strings */
143 const char **info; /* info strings */
Pierre Ossman1a632f82007-07-30 15:15:30 +0200144 struct sdio_func_tuple *tuples; /* unknown common tuples */
Haavard Skinnemoenf4b7f922008-07-24 14:18:58 +0200145
146 struct dentry *debugfs_root;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147};
148
Pierre Ossman9c2c0af2006-12-26 15:25:58 +0100149#define mmc_card_mmc(c) ((c)->type == MMC_TYPE_MMC)
150#define mmc_card_sd(c) ((c)->type == MMC_TYPE_SD)
Pierre Ossman5c4e6f12007-05-21 20:23:20 +0200151#define mmc_card_sdio(c) ((c)->type == MMC_TYPE_SDIO)
Pierre Ossman9c2c0af2006-12-26 15:25:58 +0100152
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153#define mmc_card_present(c) ((c)->state & MMC_STATE_PRESENT)
Pierre Ossmana00fc092005-09-06 15:18:52 -0700154#define mmc_card_readonly(c) ((c)->state & MMC_STATE_READONLY)
Philip Langdalebce40a32006-10-21 12:35:02 +0200155#define mmc_card_highspeed(c) ((c)->state & MMC_STATE_HIGHSPEED)
Philip Langdalefba68bd2007-01-04 06:57:32 -0800156#define mmc_card_blockaddr(c) ((c)->state & MMC_STATE_BLOCKADDR)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
158#define mmc_card_set_present(c) ((c)->state |= MMC_STATE_PRESENT)
Pierre Ossmana00fc092005-09-06 15:18:52 -0700159#define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY)
Philip Langdalebce40a32006-10-21 12:35:02 +0200160#define mmc_card_set_highspeed(c) ((c)->state |= MMC_STATE_HIGHSPEED)
Philip Langdalefba68bd2007-01-04 06:57:32 -0800161#define mmc_card_set_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
Ohad Ben-Cohen7c979ec2009-09-22 16:45:18 -0700163static inline int mmc_card_lenient_fn0(const struct mmc_card *c)
164{
165 return c->quirks & MMC_QUIRK_LENIENT_FN0;
166}
167
Bing Zhao3fb7fb42010-03-05 13:43:25 -0800168static inline int mmc_blksz_for_byte_mode(const struct mmc_card *c)
169{
170 return c->quirks & MMC_QUIRK_BLKSZ_FOR_BYTE_MODE;
171}
172
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173#define mmc_card_name(c) ((c)->cid.prod_name)
Kay Sieversd1b26862008-11-08 21:37:46 +0100174#define mmc_card_id(c) (dev_name(&(c)->dev))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
176#define mmc_list_to_card(l) container_of(l, struct mmc_card, node)
177#define mmc_get_drvdata(c) dev_get_drvdata(&(c)->dev)
178#define mmc_set_drvdata(c,d) dev_set_drvdata(&(c)->dev, d)
179
180/*
181 * MMC device driver (e.g., Flash card, I/O card...)
182 */
183struct mmc_driver {
184 struct device_driver drv;
185 int (*probe)(struct mmc_card *);
186 void (*remove)(struct mmc_card *);
187 int (*suspend)(struct mmc_card *, pm_message_t);
188 int (*resume)(struct mmc_card *);
189};
190
191extern int mmc_register_driver(struct mmc_driver *);
192extern void mmc_unregister_driver(struct mmc_driver *);
193
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194#endif