1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * Private header for the mmc subsystem
4 *
5 * Copyright (C) 2016 Linaro Ltd
6 *
7 * Author: Ulf Hansson <ulf.hansson@linaro.org>
8 */
9
10 #ifndef _MMC_CORE_CARD_H
11 #define _MMC_CORE_CARD_H
12
13 #include <linux/mmc/card.h>
14
15 #define mmc_card_name(c) ((c)->cid.prod_name)
16 #define mmc_card_id(c) (dev_name(&(c)->dev))
17 #define mmc_dev_to_card(d) container_of(d, struct mmc_card, dev)
18
19 /* Card states */
20 #define MMC_STATE_PRESENT (1<<0) /* present in sysfs */
21 #define MMC_STATE_READONLY (1<<1) /* card is read-only */
22 #define MMC_STATE_BLOCKADDR (1<<2) /* card uses block-addressing */
23 #define MMC_CARD_SDXC (1<<3) /* card is SDXC */
24 #define MMC_CARD_REMOVED (1<<4) /* card has been removed */
25 #define MMC_STATE_SUSPENDED (1<<5) /* card is suspended */
26
27 #define mmc_card_present(c) ((c)->state & MMC_STATE_PRESENT)
28 #define mmc_card_readonly(c) ((c)->state & MMC_STATE_READONLY)
29 #define mmc_card_blockaddr(c) ((c)->state & MMC_STATE_BLOCKADDR)
30 #define mmc_card_ext_capacity(c) ((c)->state & MMC_CARD_SDXC)
31 #define mmc_card_removed(c) ((c) && ((c)->state & MMC_CARD_REMOVED))
32 #define mmc_card_suspended(c) ((c)->state & MMC_STATE_SUSPENDED)
33
34 #define mmc_card_set_present(c) ((c)->state |= MMC_STATE_PRESENT)
35 #define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY)
36 #define mmc_card_set_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR)
37 #define mmc_card_set_ext_capacity(c) ((c)->state |= MMC_CARD_SDXC)
38 #define mmc_card_set_removed(c) ((c)->state |= MMC_CARD_REMOVED)
39 #define mmc_card_set_suspended(c) ((c)->state |= MMC_STATE_SUSPENDED)
40 #define mmc_card_clr_suspended(c) ((c)->state &= ~MMC_STATE_SUSPENDED)
41
42 /*
43 * The world is not perfect and supplies us with broken mmc/sdio devices.
44 * For at least some of these bugs we need a work-around.
45 */
46 struct mmc_fixup {
47 /* CID-specific fields. */
48 const char *name;
49
50 /* Valid revision range */
51 u64 rev_start, rev_end;
52
53 unsigned int manfid;
54 unsigned short oemid;
55
56 /* Manufacturing date */
57 unsigned short year;
58 unsigned char month;
59
60 /* SDIO-specific fields. You can use SDIO_ANY_ID here of course */
61 u16 cis_vendor, cis_device;
62
63 /* for MMC cards */
64 unsigned int ext_csd_rev;
65
66 /* Match against functions declared in device tree */
67 const char *of_compatible;
68
69 void (*vendor_fixup)(struct mmc_card *card, int data);
70 int data;
71 };
72
73 #define CID_MANFID_ANY (-1u)
74 #define CID_OEMID_ANY ((unsigned short) -1)
75 #define CID_YEAR_ANY ((unsigned short) -1)
76 #define CID_MONTH_ANY ((unsigned char) -1)
77 #define CID_NAME_ANY (NULL)
78
79 #define EXT_CSD_REV_ANY (-1u)
80
81 #define CID_MANFID_SANDISK 0x2
82 #define CID_MANFID_SANDISK_SD 0x3
83 #define CID_MANFID_ATP 0x9
84 #define CID_MANFID_TOSHIBA 0x11
85 #define CID_MANFID_GIGASTONE 0x12
86 #define CID_MANFID_MICRON 0x13
87 #define CID_MANFID_SAMSUNG 0x15
88 #define CID_MANFID_APACER 0x27
89 #define CID_MANFID_SWISSBIT 0x5D
90 #define CID_MANFID_KINGSTON 0x70
91 #define CID_MANFID_HYNIX 0x90
92 #define CID_MANFID_KINGSTON_SD 0x9F
93 #define CID_MANFID_NUMONYX 0xFE
94
95 #define END_FIXUP { NULL }
96
97 #define _FIXUP_EXT(_name, _manfid, _oemid, _year, _month, \
98 _rev_start, _rev_end, \
99 _cis_vendor, _cis_device, \
100 _fixup, _data, _ext_csd_rev) \
101 { \
102 .name = (_name), \
103 .manfid = (_manfid), \
104 .oemid = (_oemid), \
105 .year = (_year), \
106 .month = (_month), \
107 .rev_start = (_rev_start), \
108 .rev_end = (_rev_end), \
109 .cis_vendor = (_cis_vendor), \
110 .cis_device = (_cis_device), \
111 .vendor_fixup = (_fixup), \
112 .data = (_data), \
113 .ext_csd_rev = (_ext_csd_rev), \
114 }
115
116 #define MMC_FIXUP_REV(_name, _manfid, _oemid, _rev_start, _rev_end, \
117 _fixup, _data, _ext_csd_rev) \
118 _FIXUP_EXT(_name, _manfid, _oemid, CID_YEAR_ANY, CID_MONTH_ANY, \
119 _rev_start, _rev_end, \
120 SDIO_ANY_ID, SDIO_ANY_ID, \
121 _fixup, _data, _ext_csd_rev) \
122
123 #define MMC_FIXUP(_name, _manfid, _oemid, _fixup, _data) \
124 MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data, \
125 EXT_CSD_REV_ANY)
126
127 #define MMC_FIXUP_EXT_CSD_REV(_name, _manfid, _oemid, _fixup, _data, \
128 _ext_csd_rev) \
129 MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data, \
130 _ext_csd_rev)
131
132 #define SDIO_FIXUP(_vendor, _device, _fixup, _data) \
133 _FIXUP_EXT(CID_NAME_ANY, CID_MANFID_ANY, CID_OEMID_ANY, \
134 CID_YEAR_ANY, CID_MONTH_ANY, \
135 0, -1ull, \
136 _vendor, _device, \
137 _fixup, _data, EXT_CSD_REV_ANY) \
138
139 #define SDIO_FIXUP_COMPATIBLE(_compatible, _fixup, _data) \
140 { \
141 .name = CID_NAME_ANY, \
142 .manfid = CID_MANFID_ANY, \
143 .oemid = CID_OEMID_ANY, \
144 .rev_start = 0, \
145 .rev_end = -1ull, \
146 .cis_vendor = SDIO_ANY_ID, \
147 .cis_device = SDIO_ANY_ID, \
148 .vendor_fixup = (_fixup), \
149 .data = (_data), \
150 .ext_csd_rev = EXT_CSD_REV_ANY, \
151 .of_compatible = _compatible, \
152 }
153
154 #define cid_rev(hwrev, fwrev, year, month) \
155 (((u64) hwrev) << 40 | \
156 ((u64) fwrev) << 32 | \
157 ((u64) year) << 16 | \
158 ((u64) month))
159
160 #define cid_rev_card(card) \
161 cid_rev(card->cid.hwrev, \
162 card->cid.fwrev, \
163 card->cid.year, \
164 card->cid.month)
165
166 /*
167 * Unconditionally quirk add/remove.
168 */
add_quirk(struct mmc_card * card,int data)169 static inline void __maybe_unused add_quirk(struct mmc_card *card, int data)
170 {
171 card->quirks |= data;
172 }
173
remove_quirk(struct mmc_card * card,int data)174 static inline void __maybe_unused remove_quirk(struct mmc_card *card, int data)
175 {
176 card->quirks &= ~data;
177 }
178
add_limit_rate_quirk(struct mmc_card * card,int data)179 static inline void __maybe_unused add_limit_rate_quirk(struct mmc_card *card,
180 int data)
181 {
182 card->quirk_max_rate = data;
183 }
184
wl1251_quirk(struct mmc_card * card,int data)185 static inline void __maybe_unused wl1251_quirk(struct mmc_card *card,
186 int data)
187 {
188 /*
189 * We have TI wl1251 attached to this mmc. Pass this
190 * information to the SDIO core because it can't be
191 * probed by normal methods.
192 */
193
194 dev_info(card->host->parent, "found wl1251\n");
195 card->quirks |= MMC_QUIRK_NONSTD_SDIO;
196 card->cccr.wide_bus = 1;
197 card->cis.vendor = 0x104c;
198 card->cis.device = 0x9066;
199 card->cis.blksize = 512;
200 card->cis.max_dtr = 24000000;
201 }
202
203 /*
204 * Quirk add/remove for MMC products.
205 */
add_quirk_mmc(struct mmc_card * card,int data)206 static inline void __maybe_unused add_quirk_mmc(struct mmc_card *card, int data)
207 {
208 if (mmc_card_mmc(card))
209 card->quirks |= data;
210 }
211
remove_quirk_mmc(struct mmc_card * card,int data)212 static inline void __maybe_unused remove_quirk_mmc(struct mmc_card *card,
213 int data)
214 {
215 if (mmc_card_mmc(card))
216 card->quirks &= ~data;
217 }
218
219 /*
220 * Quirk add/remove for SD products.
221 */
add_quirk_sd(struct mmc_card * card,int data)222 static inline void __maybe_unused add_quirk_sd(struct mmc_card *card, int data)
223 {
224 if (mmc_card_sd(card))
225 card->quirks |= data;
226 }
227
remove_quirk_sd(struct mmc_card * card,int data)228 static inline void __maybe_unused remove_quirk_sd(struct mmc_card *card,
229 int data)
230 {
231 if (mmc_card_sd(card))
232 card->quirks &= ~data;
233 }
234
mmc_card_lenient_fn0(const struct mmc_card * c)235 static inline int mmc_card_lenient_fn0(const struct mmc_card *c)
236 {
237 return c->quirks & MMC_QUIRK_LENIENT_FN0;
238 }
239
mmc_blksz_for_byte_mode(const struct mmc_card * c)240 static inline int mmc_blksz_for_byte_mode(const struct mmc_card *c)
241 {
242 return c->quirks & MMC_QUIRK_BLKSZ_FOR_BYTE_MODE;
243 }
244
mmc_card_disable_cd(const struct mmc_card * c)245 static inline int mmc_card_disable_cd(const struct mmc_card *c)
246 {
247 return c->quirks & MMC_QUIRK_DISABLE_CD;
248 }
249
mmc_card_nonstd_func_interface(const struct mmc_card * c)250 static inline int mmc_card_nonstd_func_interface(const struct mmc_card *c)
251 {
252 return c->quirks & MMC_QUIRK_NONSTD_FUNC_IF;
253 }
254
mmc_card_broken_byte_mode_512(const struct mmc_card * c)255 static inline int mmc_card_broken_byte_mode_512(const struct mmc_card *c)
256 {
257 return c->quirks & MMC_QUIRK_BROKEN_BYTE_MODE_512;
258 }
259
mmc_card_long_read_time(const struct mmc_card * c)260 static inline int mmc_card_long_read_time(const struct mmc_card *c)
261 {
262 return c->quirks & MMC_QUIRK_LONG_READ_TIME;
263 }
264
mmc_card_broken_irq_polling(const struct mmc_card * c)265 static inline int mmc_card_broken_irq_polling(const struct mmc_card *c)
266 {
267 return c->quirks & MMC_QUIRK_BROKEN_IRQ_POLLING;
268 }
269
mmc_card_broken_hpi(const struct mmc_card * c)270 static inline int mmc_card_broken_hpi(const struct mmc_card *c)
271 {
272 return c->quirks & MMC_QUIRK_BROKEN_HPI;
273 }
274
mmc_card_broken_sd_discard(const struct mmc_card * c)275 static inline int mmc_card_broken_sd_discard(const struct mmc_card *c)
276 {
277 return c->quirks & MMC_QUIRK_BROKEN_SD_DISCARD;
278 }
279
mmc_card_broken_sd_cache(const struct mmc_card * c)280 static inline int mmc_card_broken_sd_cache(const struct mmc_card *c)
281 {
282 return c->quirks & MMC_QUIRK_BROKEN_SD_CACHE;
283 }
284
mmc_card_broken_cache_flush(const struct mmc_card * c)285 static inline int mmc_card_broken_cache_flush(const struct mmc_card *c)
286 {
287 return c->quirks & MMC_QUIRK_BROKEN_CACHE_FLUSH;
288 }
289
mmc_card_broken_sd_poweroff_notify(const struct mmc_card * c)290 static inline int mmc_card_broken_sd_poweroff_notify(const struct mmc_card *c)
291 {
292 return c->quirks & MMC_QUIRK_BROKEN_SD_POWEROFF_NOTIFY;
293 }
294
mmc_card_no_uhs_ddr50_tuning(const struct mmc_card * c)295 static inline int mmc_card_no_uhs_ddr50_tuning(const struct mmc_card *c)
296 {
297 return c->quirks & MMC_QUIRK_NO_UHS_DDR50_TUNING;
298 }
299
300 #endif
301