Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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/core.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 structure;
28 unsigned char mmca_vsn;
29 unsigned short cmdclass;
30 unsigned short tacc_clks;
31 unsigned int tacc_ns;
32 unsigned int r2w_factor;
33 unsigned int max_dtr;
34 unsigned int erase_size; /* In sectors */
35 unsigned int read_blkbits;
36 unsigned int write_blkbits;
37 unsigned int capacity;
38 unsigned int read_partial:1,
39 read_misalign:1,
40 write_partial:1,
41 write_misalign:1;
42};
43
44struct mmc_ext_csd {
45 u8 rev;
46 u8 erase_group_def;
47 u8 sec_feature_support;
48 unsigned int sa_timeout; /* Units: 100ns */
49 unsigned int hs_max_dtr;
50 unsigned int sectors;
51 unsigned int card_type;
52 unsigned int hc_erase_size; /* In sectors */
53 unsigned int hc_erase_timeout; /* In milliseconds */
54 unsigned int sec_trim_mult; /* Secure trim multiplier */
55 unsigned int sec_erase_mult; /* Secure erase multiplier */
56 unsigned int trim_timeout; /* In milliseconds */
57};
58
59struct sd_scr {
60 unsigned char sda_vsn;
61 unsigned char bus_widths;
62#define SD_SCR_BUS_WIDTH_1 (1<<0)
63#define SD_SCR_BUS_WIDTH_4 (1<<2)
64};
65
66struct sd_ssr {
67 unsigned int au; /* In sectors */
68 unsigned int erase_timeout; /* In milliseconds */
69 unsigned int erase_offset; /* In milliseconds */
70};
71
72struct sd_switch_caps {
73 unsigned int hs_max_dtr;
74};
75
76struct sdio_cccr {
77 unsigned int sdio_vsn;
78 unsigned int sd_vsn;
79 unsigned int multi_block:1,
80 low_speed:1,
81 wide_bus:1,
82 high_power:1,
83 high_speed:1,
84 disable_cd:1;
85};
86
87struct sdio_cis {
88 unsigned short vendor;
89 unsigned short device;
90 unsigned short blksize;
91 unsigned int max_dtr;
92};
93
94struct mmc_host;
95struct sdio_func;
96struct sdio_func_tuple;
97
98#define SDIO_MAX_FUNCS 7
99
100/*
101 * MMC device
102 */
103struct mmc_card {
104 struct mmc_host *host; /* the host this device belongs to */
105 struct device dev; /* the device */
106 unsigned int rca; /* relative card address of device */
107 unsigned int type; /* card type */
108#define MMC_TYPE_MMC 0 /* MMC card */
109#define MMC_TYPE_SD 1 /* SD card */
110#define MMC_TYPE_SDIO 2 /* SDIO card */
111#define MMC_TYPE_SD_COMBO 3 /* SD combo (IO+mem) card */
112 unsigned int state; /* (our) card state */
113#define MMC_STATE_PRESENT (1<<0) /* present in sysfs */
114#define MMC_STATE_READONLY (1<<1) /* card is read-only */
115#define MMC_STATE_HIGHSPEED (1<<2) /* card is in high speed mode */
116#define MMC_STATE_BLOCKADDR (1<<3) /* card uses block-addressing */
117#define MMC_STATE_HIGHSPEED_DDR (1<<4) /* card is in high speed mode */
118 unsigned int quirks; /* card quirks */
119#define MMC_QUIRK_LENIENT_FN0 (1<<0) /* allow SDIO FN0 writes outside of the VS CCCR range */
120#define MMC_QUIRK_BLKSZ_FOR_BYTE_MODE (1<<1) /* use func->cur_blksize */
121 /* for byte mode */
122#define MMC_QUIRK_NONSTD_SDIO (1<<2) /* non-standard SDIO card attached */
123 /* (missing CIA registers) */
124
125 unsigned int erase_size; /* erase size in sectors */
126 unsigned int erase_shift; /* if erase unit is power 2 */
127 unsigned int pref_erase; /* in sectors */
128 u8 erased_byte; /* value of erased bytes */
129
130 u32 raw_cid[4]; /* raw card CID */
131 u32 raw_csd[4]; /* raw card CSD */
132 u32 raw_scr[2]; /* raw card SCR */
133 struct mmc_cid cid; /* card identification */
134 struct mmc_csd csd; /* card specific */
135 struct mmc_ext_csd ext_csd; /* mmc v4 extended card specific */
136 struct sd_scr scr; /* extra SD information */
137 struct sd_ssr ssr; /* yet more SD information */
138 struct sd_switch_caps sw_caps; /* switch (CMD6) caps */
139
140 unsigned int sdio_funcs; /* number of SDIO functions */
141 struct sdio_cccr cccr; /* common card info */
142 struct sdio_cis cis; /* common tuple info */
143 struct sdio_func *sdio_func[SDIO_MAX_FUNCS]; /* SDIO functions (devices) */
144 unsigned num_info; /* number of info strings */
145 const char **info; /* info strings */
146 struct sdio_func_tuple *tuples; /* unknown common tuples */
147
148 struct dentry *debugfs_root;
149};
150
151#define mmc_card_mmc(c) ((c)->type == MMC_TYPE_MMC)
152#define mmc_card_sd(c) ((c)->type == MMC_TYPE_SD)
153#define mmc_card_sdio(c) ((c)->type == MMC_TYPE_SDIO)
154
155#define mmc_card_present(c) ((c)->state & MMC_STATE_PRESENT)
156#define mmc_card_readonly(c) ((c)->state & MMC_STATE_READONLY)
157#define mmc_card_highspeed(c) ((c)->state & MMC_STATE_HIGHSPEED)
158#define mmc_card_blockaddr(c) ((c)->state & MMC_STATE_BLOCKADDR)
159#define mmc_card_ddr_mode(c) ((c)->state & MMC_STATE_HIGHSPEED_DDR)
160
161#define mmc_card_set_present(c) ((c)->state |= MMC_STATE_PRESENT)
162#define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY)
163#define mmc_card_set_highspeed(c) ((c)->state |= MMC_STATE_HIGHSPEED)
164#define mmc_card_set_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR)
165#define mmc_card_set_ddr_mode(c) ((c)->state |= MMC_STATE_HIGHSPEED_DDR)
166
167static inline int mmc_card_lenient_fn0(const struct mmc_card *c)
168{
169 return c->quirks & MMC_QUIRK_LENIENT_FN0;
170}
171
172static inline int mmc_blksz_for_byte_mode(const struct mmc_card *c)
173{
174 return c->quirks & MMC_QUIRK_BLKSZ_FOR_BYTE_MODE;
175}
176
177#define mmc_card_name(c) ((c)->cid.prod_name)
178#define mmc_card_id(c) (dev_name(&(c)->dev))
179
180#define mmc_dev_to_card(d) container_of(d, struct mmc_card, dev)
181
182#define mmc_list_to_card(l) container_of(l, struct mmc_card, node)
183#define mmc_get_drvdata(c) dev_get_drvdata(&(c)->dev)
184#define mmc_set_drvdata(c,d) dev_set_drvdata(&(c)->dev, d)
185
186/*
187 * MMC device driver (e.g., Flash card, I/O card...)
188 */
189struct mmc_driver {
190 struct device_driver drv;
191 int (*probe)(struct mmc_card *);
192 void (*remove)(struct mmc_card *);
193 int (*suspend)(struct mmc_card *, pm_message_t);
194 int (*resume)(struct mmc_card *);
195};
196
197extern int mmc_register_driver(struct mmc_driver *);
198extern void mmc_unregister_driver(struct mmc_driver *);
199
200#endif