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