card.h

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