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