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
27 #define mmc_card_present(c) ((c)->state & MMC_STATE_PRESENT)
28 #define mmc_card_readonly(c) ((c)->state & MMC_STATE_READONLY)
29 #define mmc_card_blockaddr(c) ((c)->state & MMC_STATE_BLOCKADDR)
30 #define mmc_card_ext_capacity(c) ((c)->state & MMC_CARD_SDXC)
31 #define mmc_card_removed(c) ((c) && ((c)->state & MMC_CARD_REMOVED))
32 #define mmc_card_suspended(c) ((c)->state & MMC_STATE_SUSPENDED)
33
34 #define mmc_card_set_present(c) ((c)->state |= MMC_STATE_PRESENT)
35 #define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY)
36 #define mmc_card_set_blockaddr(c) ((c)->state |= MMC_STATE_BLOCKADDR)
37 #define mmc_card_set_ext_capacity(c) ((c)->state |= MMC_CARD_SDXC)
38 #define mmc_card_set_removed(c) ((c)->state |= MMC_CARD_REMOVED)
39 #define mmc_card_set_suspended(c) ((c)->state |= MMC_STATE_SUSPENDED)
40 #define mmc_card_clr_suspended(c) ((c)->state &= ~MMC_STATE_SUSPENDED)
41
42 /*
43 * The world is not perfect and supplies us with broken mmc/sdio devices.
44 * For at least some of these bugs we need a work-around.
45 */
46 struct mmc_fixup {
47 /* CID-specific fields. */
48 const char *name;
49
50 /* Valid revision range */
51 u64 rev_start, rev_end;
52
53 unsigned int manfid;
54 unsigned short oemid;
55
56 /* SDIO-specific fields. You can use SDIO_ANY_ID here of course */
57 u16 cis_vendor, cis_device;
58
59 /* for MMC cards */
60 unsigned int ext_csd_rev;
61
62 void (*vendor_fixup)(struct mmc_card *card, int data);
63 int data;
64 };
65
66 #define CID_MANFID_ANY (-1u)
67 #define CID_OEMID_ANY ((unsigned short) -1)
68 #define CID_NAME_ANY (NULL)
69
70 #define EXT_CSD_REV_ANY (-1u)
71
72 #define CID_MANFID_SANDISK 0x2
73 #define CID_MANFID_SANDISK_SD 0x3
74 #define CID_MANFID_ATP 0x9
75 #define CID_MANFID_TOSHIBA 0x11
76 #define CID_MANFID_MICRON 0x13
77 #define CID_MANFID_SAMSUNG 0x15
78 #define CID_MANFID_APACER 0x27
79 #define CID_MANFID_KINGSTON 0x70
80 #define CID_MANFID_HYNIX 0x90
81 #define CID_MANFID_DH 0xAD
82 #define CID_MANFID_NUMONYX 0xFE
83
84 #define END_FIXUP { NULL }
85
86 #define _FIXUP_EXT(_name, _manfid, _oemid, _rev_start, _rev_end, \
87 _cis_vendor, _cis_device, \
88 _fixup, _data, _ext_csd_rev) \
89 { \
90 .name = (_name), \
91 .manfid = (_manfid), \
92 .oemid = (_oemid), \
93 .rev_start = (_rev_start), \
94 .rev_end = (_rev_end), \
95 .cis_vendor = (_cis_vendor), \
96 .cis_device = (_cis_device), \
97 .vendor_fixup = (_fixup), \
98 .data = (_data), \
99 .ext_csd_rev = (_ext_csd_rev), \
100 }
101
102 #define MMC_FIXUP_REV(_name, _manfid, _oemid, _rev_start, _rev_end, \
103 _fixup, _data, _ext_csd_rev) \
104 _FIXUP_EXT(_name, _manfid, \
105 _oemid, _rev_start, _rev_end, \
106 SDIO_ANY_ID, SDIO_ANY_ID, \
107 _fixup, _data, _ext_csd_rev) \
108
109 #define MMC_FIXUP(_name, _manfid, _oemid, _fixup, _data) \
110 MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data, \
111 EXT_CSD_REV_ANY)
112
113 #define MMC_FIXUP_EXT_CSD_REV(_name, _manfid, _oemid, _fixup, _data, \
114 _ext_csd_rev) \
115 MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data, \
116 _ext_csd_rev)
117
118 #define SDIO_FIXUP(_vendor, _device, _fixup, _data) \
119 _FIXUP_EXT(CID_NAME_ANY, CID_MANFID_ANY, \
120 CID_OEMID_ANY, 0, -1ull, \
121 _vendor, _device, \
122 _fixup, _data, EXT_CSD_REV_ANY) \
123
124 #define cid_rev(hwrev, fwrev, year, month) \
125 (((u64) hwrev) << 40 | \
126 ((u64) fwrev) << 32 | \
127 ((u64) year) << 16 | \
128 ((u64) month))
129
130 #define cid_rev_card(card) \
131 cid_rev(card->cid.hwrev, \
132 card->cid.fwrev, \
133 card->cid.year, \
134 card->cid.month)
135
136 /*
137 * Unconditionally quirk add/remove.
138 */
add_quirk(struct mmc_card * card,int data)139 static inline void __maybe_unused add_quirk(struct mmc_card *card, int data)
140 {
141 card->quirks |= data;
142 }
143
remove_quirk(struct mmc_card * card,int data)144 static inline void __maybe_unused remove_quirk(struct mmc_card *card, int data)
145 {
146 card->quirks &= ~data;
147 }
148
add_limit_rate_quirk(struct mmc_card * card,int data)149 static inline void __maybe_unused add_limit_rate_quirk(struct mmc_card *card,
150 int data)
151 {
152 card->quirk_max_rate = data;
153 }
154
155 /*
156 * Quirk add/remove for MMC products.
157 */
add_quirk_mmc(struct mmc_card * card,int data)158 static inline void __maybe_unused add_quirk_mmc(struct mmc_card *card, int data)
159 {
160 if (mmc_card_mmc(card))
161 card->quirks |= data;
162 }
163
remove_quirk_mmc(struct mmc_card * card,int data)164 static inline void __maybe_unused remove_quirk_mmc(struct mmc_card *card,
165 int data)
166 {
167 if (mmc_card_mmc(card))
168 card->quirks &= ~data;
169 }
170
171 /*
172 * Quirk add/remove for SD products.
173 */
add_quirk_sd(struct mmc_card * card,int data)174 static inline void __maybe_unused add_quirk_sd(struct mmc_card *card, int data)
175 {
176 if (mmc_card_sd(card))
177 card->quirks |= data;
178 }
179
remove_quirk_sd(struct mmc_card * card,int data)180 static inline void __maybe_unused remove_quirk_sd(struct mmc_card *card,
181 int data)
182 {
183 if (mmc_card_sd(card))
184 card->quirks &= ~data;
185 }
186
mmc_card_lenient_fn0(const struct mmc_card * c)187 static inline int mmc_card_lenient_fn0(const struct mmc_card *c)
188 {
189 return c->quirks & MMC_QUIRK_LENIENT_FN0;
190 }
191
mmc_blksz_for_byte_mode(const struct mmc_card * c)192 static inline int mmc_blksz_for_byte_mode(const struct mmc_card *c)
193 {
194 return c->quirks & MMC_QUIRK_BLKSZ_FOR_BYTE_MODE;
195 }
196
mmc_card_disable_cd(const struct mmc_card * c)197 static inline int mmc_card_disable_cd(const struct mmc_card *c)
198 {
199 return c->quirks & MMC_QUIRK_DISABLE_CD;
200 }
201
mmc_card_nonstd_func_interface(const struct mmc_card * c)202 static inline int mmc_card_nonstd_func_interface(const struct mmc_card *c)
203 {
204 return c->quirks & MMC_QUIRK_NONSTD_FUNC_IF;
205 }
206
mmc_card_broken_byte_mode_512(const struct mmc_card * c)207 static inline int mmc_card_broken_byte_mode_512(const struct mmc_card *c)
208 {
209 return c->quirks & MMC_QUIRK_BROKEN_BYTE_MODE_512;
210 }
211
mmc_card_long_read_time(const struct mmc_card * c)212 static inline int mmc_card_long_read_time(const struct mmc_card *c)
213 {
214 return c->quirks & MMC_QUIRK_LONG_READ_TIME;
215 }
216
mmc_card_broken_irq_polling(const struct mmc_card * c)217 static inline int mmc_card_broken_irq_polling(const struct mmc_card *c)
218 {
219 return c->quirks & MMC_QUIRK_BROKEN_IRQ_POLLING;
220 }
221
mmc_card_broken_hpi(const struct mmc_card * c)222 static inline int mmc_card_broken_hpi(const struct mmc_card *c)
223 {
224 return c->quirks & MMC_QUIRK_BROKEN_HPI;
225 }
226
mmc_card_broken_sd_discard(const struct mmc_card * c)227 static inline int mmc_card_broken_sd_discard(const struct mmc_card *c)
228 {
229 return c->quirks & MMC_QUIRK_BROKEN_SD_DISCARD;
230 }
231
232 #endif
233