[mirror_ubuntu-bionic-kernel.git] / drivers / mmc / core / quirks.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 *  This file contains work-arounds for many known SD/MMC
 *  and SDIO hardware bugs.
 *
 *  Copyright (c) 2011 Andrei Warkentin <andreiw@motorola.com>
 *  Copyright (c) 2011 Pierre Tardy <tardyp@gmail.com>
 *  Inspired from pci fixup code:
 *  Copyright (c) 1999 Martin Mares <mj@ucw.cz>
 *
 */

#include <linux/mmc/sdio_ids.h>

#include "card.h"

static const struct mmc_fixup mmc_blk_fixups[] = {
#define INAND_CMD38_ARG_EXT_CSD  113
#define INAND_CMD38_ARG_ERASE    0x00
#define INAND_CMD38_ARG_TRIM     0x01
#define INAND_CMD38_ARG_SECERASE 0x80
#define INAND_CMD38_ARG_SECTRIM1 0x81
#define INAND_CMD38_ARG_SECTRIM2 0x88
	/* CMD38 argument is passed through EXT_CSD[113] */
	MMC_FIXUP("SEM02G", CID_MANFID_SANDISK, 0x100, add_quirk,
		  MMC_QUIRK_INAND_CMD38),
	MMC_FIXUP("SEM04G", CID_MANFID_SANDISK, 0x100, add_quirk,
		  MMC_QUIRK_INAND_CMD38),
	MMC_FIXUP("SEM08G", CID_MANFID_SANDISK, 0x100, add_quirk,
		  MMC_QUIRK_INAND_CMD38),
	MMC_FIXUP("SEM16G", CID_MANFID_SANDISK, 0x100, add_quirk,
		  MMC_QUIRK_INAND_CMD38),
	MMC_FIXUP("SEM32G", CID_MANFID_SANDISK, 0x100, add_quirk,
		  MMC_QUIRK_INAND_CMD38),

	/*
	 * Some MMC cards experience performance degradation with CMD23
	 * instead of CMD12-bounded multiblock transfers. For now we'll
	 * black list what's bad...
	 * - Certain Toshiba cards.
	 *
	 * N.B. This doesn't affect SD cards.
	 */
	MMC_FIXUP("SDMB-32", CID_MANFID_SANDISK, CID_OEMID_ANY, add_quirk_mmc,
		  MMC_QUIRK_BLK_NO_CMD23),
	MMC_FIXUP("SDM032", CID_MANFID_SANDISK, CID_OEMID_ANY, add_quirk_mmc,
		  MMC_QUIRK_BLK_NO_CMD23),
	MMC_FIXUP("MMC08G", CID_MANFID_TOSHIBA, CID_OEMID_ANY, add_quirk_mmc,
		  MMC_QUIRK_BLK_NO_CMD23),
	MMC_FIXUP("MMC16G", CID_MANFID_TOSHIBA, CID_OEMID_ANY, add_quirk_mmc,
		  MMC_QUIRK_BLK_NO_CMD23),
	MMC_FIXUP("MMC32G", CID_MANFID_TOSHIBA, CID_OEMID_ANY, add_quirk_mmc,
		  MMC_QUIRK_BLK_NO_CMD23),

	/*
	 * Some MMC cards need longer data read timeout than indicated in CSD.
	 */
	MMC_FIXUP(CID_NAME_ANY, CID_MANFID_MICRON, 0x200, add_quirk_mmc,
		  MMC_QUIRK_LONG_READ_TIME),
	MMC_FIXUP("008GE0", CID_MANFID_TOSHIBA, CID_OEMID_ANY, add_quirk_mmc,
		  MMC_QUIRK_LONG_READ_TIME),

	/*
	 * On these Samsung MoviNAND parts, performing secure erase or
	 * secure trim can result in unrecoverable corruption due to a
	 * firmware bug.
	 */
	MMC_FIXUP("M8G2FA", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
	MMC_FIXUP("MAG4FA", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
	MMC_FIXUP("MBG8FA", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
	MMC_FIXUP("MCGAFA", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
	MMC_FIXUP("VAL00M", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
	MMC_FIXUP("VYL00M", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
	MMC_FIXUP("KYL00M", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
	MMC_FIXUP("VZL00M", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
		  MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),

	/*
	 *  On Some Kingston eMMCs, performing trim can result in
	 *  unrecoverable data conrruption occasionally due to a firmware bug.
	 */
	MMC_FIXUP("V10008", CID_MANFID_KINGSTON, CID_OEMID_ANY, add_quirk_mmc,
		  MMC_QUIRK_TRIM_BROKEN),
	MMC_FIXUP("V10016", CID_MANFID_KINGSTON, CID_OEMID_ANY, add_quirk_mmc,
		  MMC_QUIRK_TRIM_BROKEN),

	END_FIXUP
};

static const struct mmc_fixup mmc_ext_csd_fixups[] = {
	/*
	 * Certain Hynix eMMC 4.41 cards might get broken when HPI feature
	 * is used so disable the HPI feature for such buggy cards.
	 */
	MMC_FIXUP_EXT_CSD_REV(CID_NAME_ANY, CID_MANFID_HYNIX,
			      0x014a, add_quirk, MMC_QUIRK_BROKEN_HPI, 5),

	END_FIXUP
};

static const struct mmc_fixup sdio_fixup_methods[] = {
	SDIO_FIXUP(SDIO_VENDOR_ID_TI, SDIO_DEVICE_ID_TI_WL1271,
		   add_quirk, MMC_QUIRK_NONSTD_FUNC_IF),

	SDIO_FIXUP(SDIO_VENDOR_ID_TI, SDIO_DEVICE_ID_TI_WL1271,
		   add_quirk, MMC_QUIRK_DISABLE_CD),

	SDIO_FIXUP(SDIO_VENDOR_ID_STE, SDIO_DEVICE_ID_STE_CW1200,
		   add_quirk, MMC_QUIRK_BROKEN_BYTE_MODE_512),

	SDIO_FIXUP(SDIO_VENDOR_ID_MARVELL, SDIO_DEVICE_ID_MARVELL_8797_F0,
		   add_quirk, MMC_QUIRK_BROKEN_IRQ_POLLING),

	END_FIXUP
};

static inline void mmc_fixup_device(struct mmc_card *card,
				    const struct mmc_fixup *table)
{
	const struct mmc_fixup *f;
	u64 rev = cid_rev_card(card);

	for (f = table; f->vendor_fixup; f++) {
		if ((f->manfid == CID_MANFID_ANY ||
		     f->manfid == card->cid.manfid) &&
		    (f->oemid == CID_OEMID_ANY ||
		     f->oemid == card->cid.oemid) &&
		    (f->name == CID_NAME_ANY ||
		     !strncmp(f->name, card->cid.prod_name,
			      sizeof(card->cid.prod_name))) &&
		    (f->cis_vendor == card->cis.vendor ||
		     f->cis_vendor == (u16) SDIO_ANY_ID) &&
		    (f->cis_device == card->cis.device ||
		     f->cis_device == (u16) SDIO_ANY_ID) &&
		    (f->ext_csd_rev == EXT_CSD_REV_ANY ||
		     f->ext_csd_rev == card->ext_csd.rev) &&
		    rev >= f->rev_start && rev <= f->rev_end) {
			dev_dbg(&card->dev, "calling %pf\n", f->vendor_fixup);
			f->vendor_fixup(card, f->data);
		}
	}
}
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
57f0adc7	2	/*
32780cd1 AW	3	* This file contains work-arounds for many known SD/MMC
32780cd1 AW	4	* and SDIO hardware bugs.
57f0adc7	5	*
32780cd1	6	* Copyright (c) 2011 Andrei Warkentin <andreiw@motorola.com>
57f0adc7 PT	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
e5624054	13	#include <linux/mmc/sdio_ids.h>
57f0adc7	14
4facdde1 UH	15	#include "card.h"
4facdde1 UH	16
8c7cdbf9	17	static const struct mmc_fixup mmc_blk_fixups[] = {
0e9cfcf4 SL	18	#define INAND_CMD38_ARG_EXT_CSD 113
	19	#define INAND_CMD38_ARG_ERASE 0x00
	20	#define INAND_CMD38_ARG_TRIM 0x01
	21	#define INAND_CMD38_ARG_SECERASE 0x80
	22	#define INAND_CMD38_ARG_SECTRIM1 0x81
	23	#define INAND_CMD38_ARG_SECTRIM2 0x88
	24	/* CMD38 argument is passed through EXT_CSD[113] */
	25	MMC_FIXUP("SEM02G", CID_MANFID_SANDISK, 0x100, add_quirk,
	26	MMC_QUIRK_INAND_CMD38),
	27	MMC_FIXUP("SEM04G", CID_MANFID_SANDISK, 0x100, add_quirk,
	28	MMC_QUIRK_INAND_CMD38),
	29	MMC_FIXUP("SEM08G", CID_MANFID_SANDISK, 0x100, add_quirk,
	30	MMC_QUIRK_INAND_CMD38),
	31	MMC_FIXUP("SEM16G", CID_MANFID_SANDISK, 0x100, add_quirk,
	32	MMC_QUIRK_INAND_CMD38),
	33	MMC_FIXUP("SEM32G", CID_MANFID_SANDISK, 0x100, add_quirk,
	34	MMC_QUIRK_INAND_CMD38),
	35
	36	/*
	37	* Some MMC cards experience performance degradation with CMD23
	38	* instead of CMD12-bounded multiblock transfers. For now we'll
	39	* black list what's bad...
	40	* - Certain Toshiba cards.
	41	*
	42	* N.B. This doesn't affect SD cards.
	43	*/
	44	MMC_FIXUP("SDMB-32", CID_MANFID_SANDISK, CID_OEMID_ANY, add_quirk_mmc,
	45	MMC_QUIRK_BLK_NO_CMD23),
	46	MMC_FIXUP("SDM032", CID_MANFID_SANDISK, CID_OEMID_ANY, add_quirk_mmc,
	47	MMC_QUIRK_BLK_NO_CMD23),
	48	MMC_FIXUP("MMC08G", CID_MANFID_TOSHIBA, CID_OEMID_ANY, add_quirk_mmc,
	49	MMC_QUIRK_BLK_NO_CMD23),
	50	MMC_FIXUP("MMC16G", CID_MANFID_TOSHIBA, CID_OEMID_ANY, add_quirk_mmc,
	51	MMC_QUIRK_BLK_NO_CMD23),
	52	MMC_FIXUP("MMC32G", CID_MANFID_TOSHIBA, CID_OEMID_ANY, add_quirk_mmc,
	53	MMC_QUIRK_BLK_NO_CMD23),
	54
	55	/*
	56	* Some MMC cards need longer data read timeout than indicated in CSD.
	57	*/
	58	MMC_FIXUP(CID_NAME_ANY, CID_MANFID_MICRON, 0x200, add_quirk_mmc,
	59	MMC_QUIRK_LONG_READ_TIME),
	60	MMC_FIXUP("008GE0", CID_MANFID_TOSHIBA, CID_OEMID_ANY, add_quirk_mmc,
	61	MMC_QUIRK_LONG_READ_TIME),
	62
	63	/*
	64	* On these Samsung MoviNAND parts, performing secure erase or
	65	* secure trim can result in unrecoverable corruption due to a
	66	* firmware bug.
	67	*/
	68	MMC_FIXUP("M8G2FA", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
	69	MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
	70	MMC_FIXUP("MAG4FA", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
	71	MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
	72	MMC_FIXUP("MBG8FA", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
	73	MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
	74	MMC_FIXUP("MCGAFA", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
	75	MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
	76	MMC_FIXUP("VAL00M", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
	77	MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
	78	MMC_FIXUP("VYL00M", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
	79	MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
	80	MMC_FIXUP("KYL00M", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
	81	MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
82	MMC_FIXUP("VZL00M", CID_MANFID_SAMSUNG, CID_OEMID_ANY, add_quirk_mmc,
83	MMC_QUIRK_SEC_ERASE_TRIM_BROKEN),
84
85	/*
86	* On Some Kingston eMMCs, performing trim can result in
87	* unrecoverable data conrruption occasionally due to a firmware bug.
88	*/
89	MMC_FIXUP("V10008", CID_MANFID_KINGSTON, CID_OEMID_ANY, add_quirk_mmc,
90	MMC_QUIRK_TRIM_BROKEN),
91	MMC_FIXUP("V10016", CID_MANFID_KINGSTON, CID_OEMID_ANY, add_quirk_mmc,
92	MMC_QUIRK_TRIM_BROKEN),
93
94	END_FIXUP
95	};
96
97	static const struct mmc_fixup mmc_ext_csd_fixups[] = {
98	/*
99	* Certain Hynix eMMC 4.41 cards might get broken when HPI feature
100	* is used so disable the HPI feature for such buggy cards.
101	*/
102	MMC_FIXUP_EXT_CSD_REV(CID_NAME_ANY, CID_MANFID_HYNIX,
103	0x014a, add_quirk, MMC_QUIRK_BROKEN_HPI, 5),
104
105	END_FIXUP
106	};
107
1144c1e4	108	static const struct mmc_fixup sdio_fixup_methods[] = {
32780cd1 AW	109	SDIO_FIXUP(SDIO_VENDOR_ID_TI, SDIO_DEVICE_ID_TI_WL1271,
	110	add_quirk, MMC_QUIRK_NONSTD_FUNC_IF),
	111
	112	SDIO_FIXUP(SDIO_VENDOR_ID_TI, SDIO_DEVICE_ID_TI_WL1271,
	113	add_quirk, MMC_QUIRK_DISABLE_CD),
	114
9a0da648 SNX	115	SDIO_FIXUP(SDIO_VENDOR_ID_STE, SDIO_DEVICE_ID_STE_CW1200,
	116	add_quirk, MMC_QUIRK_BROKEN_BYTE_MODE_512),
	117
e5624054 BZ	118	SDIO_FIXUP(SDIO_VENDOR_ID_MARVELL, SDIO_DEVICE_ID_MARVELL_8797_F0,
	119	add_quirk, MMC_QUIRK_BROKEN_IRQ_POLLING),
	120
32780cd1	121	END_FIXUP
57f0adc7 PT	122	};
57f0adc7 PT	123
28fc64af SL	124	static inline void mmc_fixup_device(struct mmc_card *card,
28fc64af SL	125	const struct mmc_fixup *table)
57f0adc7 PT	126	{
57f0adc7 PT	127	const struct mmc_fixup *f;
32780cd1 AW	128	u64 rev = cid_rev_card(card);
32780cd1 AW	129
32780cd1 AW	130	for (f = table; f->vendor_fixup; f++) {
	131	if ((f->manfid == CID_MANFID_ANY \|\|
	132	f->manfid == card->cid.manfid) &&
	133	(f->oemid == CID_OEMID_ANY \|\|
	134	f->oemid == card->cid.oemid) &&
	135	(f->name == CID_NAME_ANY \|\|
	136	!strncmp(f->name, card->cid.prod_name,
	137	sizeof(card->cid.prod_name))) &&
	138	(f->cis_vendor == card->cis.vendor \|\|
	139	f->cis_vendor == (u16) SDIO_ANY_ID) &&
	140	(f->cis_device == card->cis.device \|\|
	141	f->cis_device == (u16) SDIO_ANY_ID) &&
5320226a P	142	(f->ext_csd_rev == EXT_CSD_REV_ANY \|\|
5320226a P	143	f->ext_csd_rev == card->ext_csd.rev) &&
32780cd1	144	rev >= f->rev_start && rev <= f->rev_end) {
be19c405	145	dev_dbg(&card->dev, "calling %pf\n", f->vendor_fixup);
57f0adc7 PT	146	f->vendor_fixup(card, f->data);
	147	}
	148	}
	149	}