xref: /linux/drivers/mmc/core/quirks.h (revision 4ddd4f0651a710f33dfbb9dadd94f2bb0aa31aa8)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  *  This file contains work-arounds for many known SD/MMC
4  *  and SDIO hardware bugs.
5  *
6  *  Copyright (c) 2011 Andrei Warkentin <andreiw@motorola.com>
7  *  Copyright (c) 2011 Pierre Tardy <tardyp@gmail.com>
8  *  Inspired from pci fixup code:
9  *  Copyright (c) 1999 Martin Mares <mj@ucw.cz>
10  *
11  */
12 
13 #include <linux/of.h>
14 #include <linux/mmc/sdio_ids.h>
15 
16 #include "card.h"
17 
18 static const struct mmc_fixup __maybe_unused mmc_sd_fixups[] = {
19 	/*
20 	 * Kingston Canvas Go! Plus microSD cards never finish SD cache flush.
21 	 * This has so far only been observed on cards from 11/2019, while new
22 	 * cards from 2023/05 do not exhibit this behavior.
23 	 */
24 	_FIXUP_EXT("SD64G", CID_MANFID_KINGSTON_SD, 0x5449, 2019, 11,
25 		   0, -1ull, SDIO_ANY_ID, SDIO_ANY_ID, add_quirk_sd,
26 		   MMC_QUIRK_BROKEN_SD_CACHE, EXT_CSD_REV_ANY),
27 
28 	/*
29 	 * GIGASTONE Gaming Plus microSD cards manufactured on 02/2022 never
30 	 * clear Flush Cache bit and set Poweroff Notification Ready bit.
31 	 */
32 	_FIXUP_EXT("ASTC", CID_MANFID_GIGASTONE, 0x3456, 2022, 2,
33 		   0, -1ull, SDIO_ANY_ID, SDIO_ANY_ID, add_quirk_sd,
34 		   MMC_QUIRK_BROKEN_SD_CACHE | MMC_QUIRK_BROKEN_SD_POWEROFF_NOTIFY,
35 		   EXT_CSD_REV_ANY),
36 
37 	/*
38 	 * Swissbit series S46-u cards throw I/O errors during tuning requests
39 	 * after the initial tuning request expectedly times out. This has
40 	 * only been observed on cards manufactured on 01/2019 that are using
41 	 * Bay Trail host controllers.
42 	 */
43 	_FIXUP_EXT("0016G", CID_MANFID_SWISSBIT, 0x5342, 2019, 1,
44 		   0, -1ull, SDIO_ANY_ID, SDIO_ANY_ID, add_quirk_sd,
45 		   MMC_QUIRK_NO_UHS_DDR50_TUNING, EXT_CSD_REV_ANY),
46 
47 	/*
48 	 * Some SD cards reports discard support while they don't
49 	 */
50 	MMC_FIXUP(CID_NAME_ANY, CID_MANFID_SANDISK_SD, 0x5344, add_quirk_sd,
51 		  MMC_QUIRK_BROKEN_SD_DISCARD),
52 
53 	END_FIXUP
54 };
55 
56 static const struct mmc_fixup __maybe_unused mmc_blk_fixups[] = {
57 #define INAND_CMD38_ARG_EXT_CSD  113
58 #define INAND_CMD38_ARG_ERASE    0x00
59 #define INAND_CMD38_ARG_TRIM     0x01
60 #define INAND_CMD38_ARG_SECERASE 0x80
61 #define INAND_CMD38_ARG_SECTRIM1 0x81
62 #define INAND_CMD38_ARG_SECTRIM2 0x88
63 	/* CMD38 argument is passed through EXT_CSD[113] */
64 	MMC_FIXUP("SEM02G", CID_MANFID_SANDISK, 0x100, add_quirk,
65 		  MMC_QUIRK_INAND_CMD38),
66 	MMC_FIXUP("SEM04G", CID_MANFID_SANDISK, 0x100, add_quirk,
67 		  MMC_QUIRK_INAND_CMD38),
68 	MMC_FIXUP("SEM08G", CID_MANFID_SANDISK, 0x100, add_quirk,
69 		  MMC_QUIRK_INAND_CMD38),
70 	MMC_FIXUP("SEM16G", CID_MANFID_SANDISK, 0x100, add_quirk,
71 		  MMC_QUIRK_INAND_CMD38),
72 	MMC_FIXUP("SEM32G", CID_MANFID_SANDISK, 0x100, add_quirk,
73 		  MMC_QUIRK_INAND_CMD38),
74 
75 	/*
76 	 * Some MMC cards experience performance degradation with CMD23
77 	 * instead of CMD12-bounded multiblock transfers. For now we'll
78 	 * black list what's bad...
79 	 * - Certain Toshiba cards.
80 	 *
81 	 * N.B. This doesn't affect SD cards.
82 	 */
83 	MMC_FIXUP("SDMB-32", CID_MANFID_SANDISK, CID_OEMID_ANY, add_quirk_mmc,
84 		  MMC_QUIRK_BLK_NO_CMD23),
85 	MMC_FIXUP("SDM032", CID_MANFID_SANDISK, CID_OEMID_ANY, add_quirk_mmc,
86 		  MMC_QUIRK_BLK_NO_CMD23),
87 	MMC_FIXUP("MMC08G", CID_MANFID_TOSHIBA, CID_OEMID_ANY, add_quirk_mmc,
88 		  MMC_QUIRK_BLK_NO_CMD23),
89 	MMC_FIXUP("MMC16G", CID_MANFID_TOSHIBA, CID_OEMID_ANY, add_quirk_mmc,
90 		  MMC_QUIRK_BLK_NO_CMD23),
91 	MMC_FIXUP("MMC32G", CID_MANFID_TOSHIBA, CID_OEMID_ANY, add_quirk_mmc,
92 		  MMC_QUIRK_BLK_NO_CMD23),
93 
94 	/*
95 	 * Some SD cards lockup while using CMD23 multiblock transfers.
96 	 */
97 	MMC_FIXUP("AF SD", CID_MANFID_ATP, CID_OEMID_ANY, add_quirk_sd,
98 		  MMC_QUIRK_BLK_NO_CMD23),
99 	MMC_FIXUP("APUSD", CID_MANFID_APACER, 0x5048, add_quirk_sd,
100 		  MMC_QUIRK_BLK_NO_CMD23),
101 
102 	/*
103 	 * Some MMC cards need longer data read timeout than indicated in CSD.
104 	 */
105 	MMC_FIXUP(CID_NAME_ANY, CID_MANFID_MICRON, 0x200, add_quirk_mmc,
106 		  MMC_QUIRK_LONG_READ_TIME),
107 	MMC_FIXUP("008GE0", CID_MANFID_TOSHIBA, CID_OEMID_ANY, add_quirk_mmc,
108 		  MMC_QUIRK_LONG_READ_TIME),
109 
110 	/*
111 	 * On these Samsung MoviNAND parts, performing secure erase or
112 	 * secure trim can result in unrecoverable corruption due to a
113 	 * firmware bug.
114 	 */
115 	MMC_FIXUP("M8G2FA", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
116 		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
117 	MMC_FIXUP("MAG4FA", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
118 		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
119 	MMC_FIXUP("MBG8FA", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
120 		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
121 	MMC_FIXUP("MCGAFA", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
122 		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
123 	MMC_FIXUP("VAL00M", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
124 		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
125 	MMC_FIXUP("VYL00M", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
126 		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
127 	MMC_FIXUP("KYL00M", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
128 		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
129 	MMC_FIXUP("VZL00M", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
130 		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
131 
132 	/*
133 	 *  On Some Kingston eMMCs, performing trim can result in
134 	 *  unrecoverable data conrruption occasionally due to a firmware bug.
135 	 */
136 	MMC_FIXUP("V10008", CID_MANFID_KINGSTON, CID_OEMID_ANY, add_quirk_mmc,
137 		  MMC_QUIRK_TRIM_BROKEN),
138 	MMC_FIXUP("V10016", CID_MANFID_KINGSTON, CID_OEMID_ANY, add_quirk_mmc,
139 		  MMC_QUIRK_TRIM_BROKEN),
140 
141 	/*
142 	 * Micron MTFC4GACAJCN-1M supports TRIM but does not appear to support
143 	 * WRITE_ZEROES offloading. It also supports caching, but the cache can
144 	 * only be flushed after a write has occurred.
145 	 */
146 	MMC_FIXUP("Q2J54A", CID_MANFID_MICRON, 0x014e, add_quirk_mmc,
147 		  MMC_QUIRK_TRIM_BROKEN | MMC_QUIRK_BROKEN_CACHE_FLUSH),
148 
149 	/*
150 	 * Kingston EMMC04G-M627 advertises TRIM but it does not seems to
151 	 * support being used to offload WRITE_ZEROES.
152 	 */
153 	MMC_FIXUP("M62704", CID_MANFID_KINGSTON, 0x0100, add_quirk_mmc,
154 		  MMC_QUIRK_TRIM_BROKEN),
155 
156 	/*
157 	 * On Some Kingston eMMCs, secure erase/trim time is independent
158 	 * of erase size, fixed at approximately 2 seconds.
159 	 */
160 	MMC_FIXUP("IY2964", CID_MANFID_KINGSTON, 0x0100, add_quirk_mmc,
161 		  MMC_QUIRK_FIXED_SECURE_ERASE_TRIM_TIME),
162 	MMC_FIXUP("IB2932", CID_MANFID_KINGSTON, 0x0100, add_quirk_mmc,
163 		  MMC_QUIRK_FIXED_SECURE_ERASE_TRIM_TIME),
164 
165 	END_FIXUP
166 };
167 
168 static const struct mmc_fixup __maybe_unused mmc_ext_csd_fixups[] = {
169 	/*
170 	 * Certain Hynix eMMC 4.41 cards might get broken when HPI feature
171 	 * is used so disable the HPI feature for such buggy cards.
172 	 */
173 	MMC_FIXUP_EXT_CSD_REV(CID_NAME_ANY, CID_MANFID_HYNIX,
174 			      0x014a, add_quirk, MMC_QUIRK_BROKEN_HPI, 5),
175 	/*
176 	 * Certain Micron (Numonyx) eMMC 4.5 cards might get broken when HPI
177 	 * feature is used so disable the HPI feature for such buggy cards.
178 	 */
179 	MMC_FIXUP_EXT_CSD_REV(CID_NAME_ANY, CID_MANFID_NUMONYX,
180 			      0x014e, add_quirk, MMC_QUIRK_BROKEN_HPI, 6),
181 
182 	MMC_FIXUP(CID_NAME_ANY, CID_MANFID_SANDISK_MMC, CID_OEMID_ANY, add_quirk_mmc,
183 		  MMC_QUIRK_BROKEN_MDT),
184 
185 	END_FIXUP
186 };
187 
188 
189 static const struct mmc_fixup __maybe_unused sdio_fixup_methods[] = {
190 	SDIO_FIXUP(SDIO_VENDOR_ID_TI_WL1251, SDIO_DEVICE_ID_TI_WL1251,
191 		   add_quirk, MMC_QUIRK_NONSTD_FUNC_IF),
192 
193 	SDIO_FIXUP(SDIO_VENDOR_ID_TI_WL1251, SDIO_DEVICE_ID_TI_WL1251,
194 		   add_quirk, MMC_QUIRK_DISABLE_CD),
195 
196 	SDIO_FIXUP(SDIO_VENDOR_ID_TI, SDIO_DEVICE_ID_TI_WL1271,
197 		   add_quirk, MMC_QUIRK_NONSTD_FUNC_IF),
198 
199 	SDIO_FIXUP(SDIO_VENDOR_ID_TI, SDIO_DEVICE_ID_TI_WL1271,
200 		   add_quirk, MMC_QUIRK_DISABLE_CD),
201 
202 	SDIO_FIXUP(SDIO_VENDOR_ID_STE, SDIO_DEVICE_ID_STE_CW1200,
203 		   add_quirk, MMC_QUIRK_BROKEN_BYTE_MODE_512),
204 
205 	SDIO_FIXUP(SDIO_VENDOR_ID_MARVELL, SDIO_DEVICE_ID_MARVELL_8797_F0,
206 		   add_quirk, MMC_QUIRK_BROKEN_IRQ_POLLING),
207 
208 	SDIO_FIXUP(SDIO_VENDOR_ID_MARVELL, SDIO_DEVICE_ID_MARVELL_8887_F0,
209 		   add_limit_rate_quirk, 150000000),
210 
211 	END_FIXUP
212 };
213 
214 static const struct mmc_fixup __maybe_unused sdio_card_init_methods[] = {
215 	SDIO_FIXUP_COMPATIBLE("ti,wl1251", wl1251_quirk, 0),
216 
217 	SDIO_FIXUP_COMPATIBLE("silabs,wf200", add_quirk,
218 			      MMC_QUIRK_BROKEN_BYTE_MODE_512 |
219 			      MMC_QUIRK_LENIENT_FN0 |
220 			      MMC_QUIRK_BLKSZ_FOR_BYTE_MODE),
221 
222 	END_FIXUP
223 };
224 
225 static inline bool mmc_fixup_of_compatible_match(struct mmc_card *card,
226 						 const char *compatible)
227 {
228 	for_each_child_of_node_scoped(mmc_dev(card->host)->of_node, np)
229 		if (of_device_is_compatible(np, compatible))
230 			return true;
231 
232 	return false;
233 }
234 
235 static inline void mmc_fixup_device(struct mmc_card *card,
236 				    const struct mmc_fixup *table)
237 {
238 	const struct mmc_fixup *f;
239 	u64 rev = cid_rev_card(card);
240 
241 	for (f = table; f->vendor_fixup; f++) {
242 		if (f->manfid != CID_MANFID_ANY &&
243 		    f->manfid != card->cid.manfid)
244 			continue;
245 		if (f->oemid != CID_OEMID_ANY &&
246 		    f->oemid != card->cid.oemid)
247 			continue;
248 		if (f->name != CID_NAME_ANY &&
249 		    strncmp(f->name, card->cid.prod_name,
250 			    sizeof(card->cid.prod_name)))
251 			continue;
252 		if (f->cis_vendor != (u16)SDIO_ANY_ID &&
253 		    f->cis_vendor != card->cis.vendor)
254 			continue;
255 		if (f->cis_device != (u16)SDIO_ANY_ID &&
256 		    f->cis_device != card->cis.device)
257 			continue;
258 		if (f->ext_csd_rev != EXT_CSD_REV_ANY &&
259 		    f->ext_csd_rev != card->ext_csd.rev)
260 			continue;
261 		if (rev < f->rev_start || rev > f->rev_end)
262 			continue;
263 		if (f->of_compatible &&
264 		    !mmc_fixup_of_compatible_match(card, f->of_compatible))
265 			continue;
266 		if (f->year != CID_YEAR_ANY && f->year != card->cid.year)
267 			continue;
268 		if (f->month != CID_MONTH_ANY && f->month != card->cid.month)
269 			continue;
270 
271 		dev_dbg(&card->dev, "calling %ps\n", f->vendor_fixup);
272 		f->vendor_fixup(card, f->data);
273 	}
274 }
275