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 	END_FIXUP
48 };
49 
50 static const struct mmc_fixup __maybe_unused mmc_blk_fixups[] = {
51 #define INAND_CMD38_ARG_EXT_CSD  113
52 #define INAND_CMD38_ARG_ERASE    0x00
53 #define INAND_CMD38_ARG_TRIM     0x01
54 #define INAND_CMD38_ARG_SECERASE 0x80
55 #define INAND_CMD38_ARG_SECTRIM1 0x81
56 #define INAND_CMD38_ARG_SECTRIM2 0x88
57 	/* CMD38 argument is passed through EXT_CSD[113] */
58 	MMC_FIXUP("SEM02G", CID_MANFID_SANDISK, 0x100, add_quirk,
59 		  MMC_QUIRK_INAND_CMD38),
60 	MMC_FIXUP("SEM04G", CID_MANFID_SANDISK, 0x100, add_quirk,
61 		  MMC_QUIRK_INAND_CMD38),
62 	MMC_FIXUP("SEM08G", CID_MANFID_SANDISK, 0x100, add_quirk,
63 		  MMC_QUIRK_INAND_CMD38),
64 	MMC_FIXUP("SEM16G", CID_MANFID_SANDISK, 0x100, add_quirk,
65 		  MMC_QUIRK_INAND_CMD38),
66 	MMC_FIXUP("SEM32G", CID_MANFID_SANDISK, 0x100, add_quirk,
67 		  MMC_QUIRK_INAND_CMD38),
68 
69 	/*
70 	 * Some MMC cards experience performance degradation with CMD23
71 	 * instead of CMD12-bounded multiblock transfers. For now we'll
72 	 * black list what's bad...
73 	 * - Certain Toshiba cards.
74 	 *
75 	 * N.B. This doesn't affect SD cards.
76 	 */
77 	MMC_FIXUP("SDMB-32", CID_MANFID_SANDISK, CID_OEMID_ANY, add_quirk_mmc,
78 		  MMC_QUIRK_BLK_NO_CMD23),
79 	MMC_FIXUP("SDM032", CID_MANFID_SANDISK, CID_OEMID_ANY, add_quirk_mmc,
80 		  MMC_QUIRK_BLK_NO_CMD23),
81 	MMC_FIXUP("MMC08G", CID_MANFID_TOSHIBA, CID_OEMID_ANY, add_quirk_mmc,
82 		  MMC_QUIRK_BLK_NO_CMD23),
83 	MMC_FIXUP("MMC16G", CID_MANFID_TOSHIBA, CID_OEMID_ANY, add_quirk_mmc,
84 		  MMC_QUIRK_BLK_NO_CMD23),
85 	MMC_FIXUP("MMC32G", CID_MANFID_TOSHIBA, CID_OEMID_ANY, add_quirk_mmc,
86 		  MMC_QUIRK_BLK_NO_CMD23),
87 
88 	/*
89 	 * Some SD cards lockup while using CMD23 multiblock transfers.
90 	 */
91 	MMC_FIXUP("AF SD", CID_MANFID_ATP, CID_OEMID_ANY, add_quirk_sd,
92 		  MMC_QUIRK_BLK_NO_CMD23),
93 	MMC_FIXUP("APUSD", CID_MANFID_APACER, 0x5048, add_quirk_sd,
94 		  MMC_QUIRK_BLK_NO_CMD23),
95 
96 	/*
97 	 * Some MMC cards need longer data read timeout than indicated in CSD.
98 	 */
99 	MMC_FIXUP(CID_NAME_ANY, CID_MANFID_MICRON, 0x200, add_quirk_mmc,
100 		  MMC_QUIRK_LONG_READ_TIME),
101 	MMC_FIXUP("008GE0", CID_MANFID_TOSHIBA, CID_OEMID_ANY, add_quirk_mmc,
102 		  MMC_QUIRK_LONG_READ_TIME),
103 
104 	/*
105 	 * On these Samsung MoviNAND parts, performing secure erase or
106 	 * secure trim can result in unrecoverable corruption due to a
107 	 * firmware bug.
108 	 */
109 	MMC_FIXUP("M8G2FA", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
110 		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
111 	MMC_FIXUP("MAG4FA", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
112 		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
113 	MMC_FIXUP("MBG8FA", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
114 		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
115 	MMC_FIXUP("MCGAFA", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
116 		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
117 	MMC_FIXUP("VAL00M", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
118 		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
119 	MMC_FIXUP("VYL00M", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
120 		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
121 	MMC_FIXUP("KYL00M", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
122 		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
123 	MMC_FIXUP("VZL00M", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
124 		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
125 
126 	/*
127 	 *  On Some Kingston eMMCs, performing trim can result in
128 	 *  unrecoverable data conrruption occasionally due to a firmware bug.
129 	 */
130 	MMC_FIXUP("V10008", CID_MANFID_KINGSTON, CID_OEMID_ANY, add_quirk_mmc,
131 		  MMC_QUIRK_TRIM_BROKEN),
132 	MMC_FIXUP("V10016", CID_MANFID_KINGSTON, CID_OEMID_ANY, add_quirk_mmc,
133 		  MMC_QUIRK_TRIM_BROKEN),
134 
135 	/*
136 	 * Micron MTFC4GACAJCN-1M supports TRIM but does not appear to support
137 	 * WRITE_ZEROES offloading. It also supports caching, but the cache can
138 	 * only be flushed after a write has occurred.
139 	 */
140 	MMC_FIXUP("Q2J54A", CID_MANFID_MICRON, 0x014e, add_quirk_mmc,
141 		  MMC_QUIRK_TRIM_BROKEN | MMC_QUIRK_BROKEN_CACHE_FLUSH),
142 
143 	/*
144 	 * Kingston EMMC04G-M627 advertises TRIM but it does not seems to
145 	 * support being used to offload WRITE_ZEROES.
146 	 */
147 	MMC_FIXUP("M62704", CID_MANFID_KINGSTON, 0x0100, add_quirk_mmc,
148 		  MMC_QUIRK_TRIM_BROKEN),
149 
150 	/*
151 	 * Some SD cards reports discard support while they don't
152 	 */
153 	MMC_FIXUP(CID_NAME_ANY, CID_MANFID_SANDISK_SD, 0x5344, add_quirk_sd,
154 		  MMC_QUIRK_BROKEN_SD_DISCARD),
155 
156 	END_FIXUP
157 };
158 
159 static const struct mmc_fixup __maybe_unused mmc_ext_csd_fixups[] = {
160 	/*
161 	 * Certain Hynix eMMC 4.41 cards might get broken when HPI feature
162 	 * is used so disable the HPI feature for such buggy cards.
163 	 */
164 	MMC_FIXUP_EXT_CSD_REV(CID_NAME_ANY, CID_MANFID_HYNIX,
165 			      0x014a, add_quirk, MMC_QUIRK_BROKEN_HPI, 5),
166 	/*
167 	 * Certain Micron (Numonyx) eMMC 4.5 cards might get broken when HPI
168 	 * feature is used so disable the HPI feature for such buggy cards.
169 	 */
170 	MMC_FIXUP_EXT_CSD_REV(CID_NAME_ANY, CID_MANFID_NUMONYX,
171 			      0x014e, add_quirk, MMC_QUIRK_BROKEN_HPI, 6),
172 
173 	END_FIXUP
174 };
175 
176 
177 static const struct mmc_fixup __maybe_unused sdio_fixup_methods[] = {
178 	SDIO_FIXUP(SDIO_VENDOR_ID_TI_WL1251, SDIO_DEVICE_ID_TI_WL1251,
179 		   add_quirk, MMC_QUIRK_NONSTD_FUNC_IF),
180 
181 	SDIO_FIXUP(SDIO_VENDOR_ID_TI_WL1251, SDIO_DEVICE_ID_TI_WL1251,
182 		   add_quirk, MMC_QUIRK_DISABLE_CD),
183 
184 	SDIO_FIXUP(SDIO_VENDOR_ID_TI, SDIO_DEVICE_ID_TI_WL1271,
185 		   add_quirk, MMC_QUIRK_NONSTD_FUNC_IF),
186 
187 	SDIO_FIXUP(SDIO_VENDOR_ID_TI, SDIO_DEVICE_ID_TI_WL1271,
188 		   add_quirk, MMC_QUIRK_DISABLE_CD),
189 
190 	SDIO_FIXUP(SDIO_VENDOR_ID_STE, SDIO_DEVICE_ID_STE_CW1200,
191 		   add_quirk, MMC_QUIRK_BROKEN_BYTE_MODE_512),
192 
193 	SDIO_FIXUP(SDIO_VENDOR_ID_MARVELL, SDIO_DEVICE_ID_MARVELL_8797_F0,
194 		   add_quirk, MMC_QUIRK_BROKEN_IRQ_POLLING),
195 
196 	SDIO_FIXUP(SDIO_VENDOR_ID_MARVELL, SDIO_DEVICE_ID_MARVELL_8887_F0,
197 		   add_limit_rate_quirk, 150000000),
198 
199 	END_FIXUP
200 };
201 
202 static const struct mmc_fixup __maybe_unused sdio_card_init_methods[] = {
203 	SDIO_FIXUP_COMPATIBLE("ti,wl1251", wl1251_quirk, 0),
204 
205 	SDIO_FIXUP_COMPATIBLE("silabs,wf200", add_quirk,
206 			      MMC_QUIRK_BROKEN_BYTE_MODE_512 |
207 			      MMC_QUIRK_LENIENT_FN0 |
208 			      MMC_QUIRK_BLKSZ_FOR_BYTE_MODE),
209 
210 	END_FIXUP
211 };
212 
213 static inline bool mmc_fixup_of_compatible_match(struct mmc_card *card,
214 						 const char *compatible)
215 {
216 	struct device_node *np;
217 
218 	for_each_child_of_node(mmc_dev(card->host)->of_node, np) {
219 		if (of_device_is_compatible(np, compatible)) {
220 			of_node_put(np);
221 			return true;
222 		}
223 	}
224 
225 	return false;
226 }
227 
228 static inline void mmc_fixup_device(struct mmc_card *card,
229 				    const struct mmc_fixup *table)
230 {
231 	const struct mmc_fixup *f;
232 	u64 rev = cid_rev_card(card);
233 
234 	for (f = table; f->vendor_fixup; f++) {
235 		if (f->manfid != CID_MANFID_ANY &&
236 		    f->manfid != card->cid.manfid)
237 			continue;
238 		if (f->oemid != CID_OEMID_ANY &&
239 		    f->oemid != card->cid.oemid)
240 			continue;
241 		if (f->name != CID_NAME_ANY &&
242 		    strncmp(f->name, card->cid.prod_name,
243 			    sizeof(card->cid.prod_name)))
244 			continue;
245 		if (f->cis_vendor != (u16)SDIO_ANY_ID &&
246 		    f->cis_vendor != card->cis.vendor)
247 			continue;
248 		if (f->cis_device != (u16)SDIO_ANY_ID &&
249 		    f->cis_device != card->cis.device)
250 			continue;
251 		if (f->ext_csd_rev != EXT_CSD_REV_ANY &&
252 		    f->ext_csd_rev != card->ext_csd.rev)
253 			continue;
254 		if (rev < f->rev_start || rev > f->rev_end)
255 			continue;
256 		if (f->of_compatible &&
257 		    !mmc_fixup_of_compatible_match(card, f->of_compatible))
258 			continue;
259 		if (f->year != CID_YEAR_ANY && f->year != card->cid.year)
260 			continue;
261 		if (f->month != CID_MONTH_ANY && f->month != card->cid.month)
262 			continue;
263 
264 		dev_dbg(&card->dev, "calling %ps\n", f->vendor_fixup);
265 		f->vendor_fixup(card, f->data);
266 	}
267 }
268