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 */ 49 struct 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_SANDISK_MMC 0x45 93 #define CID_MANFID_SWISSBIT 0x5D 94 #define CID_MANFID_KINGSTON 0x70 95 #define CID_MANFID_HYNIX 0x90 96 #define CID_MANFID_KINGSTON_SD 0x9F 97 #define CID_MANFID_NUMONYX 0xFE 98 99 #define END_FIXUP { NULL } 100 101 #define _FIXUP_EXT(_name, _manfid, _oemid, _year, _month, \ 102 _rev_start, _rev_end, \ 103 _cis_vendor, _cis_device, \ 104 _fixup, _data, _ext_csd_rev) \ 105 { \ 106 .name = (_name), \ 107 .manfid = (_manfid), \ 108 .oemid = (_oemid), \ 109 .year = (_year), \ 110 .month = (_month), \ 111 .rev_start = (_rev_start), \ 112 .rev_end = (_rev_end), \ 113 .cis_vendor = (_cis_vendor), \ 114 .cis_device = (_cis_device), \ 115 .vendor_fixup = (_fixup), \ 116 .data = (_data), \ 117 .ext_csd_rev = (_ext_csd_rev), \ 118 } 119 120 #define MMC_FIXUP_REV(_name, _manfid, _oemid, _rev_start, _rev_end, \ 121 _fixup, _data, _ext_csd_rev) \ 122 _FIXUP_EXT(_name, _manfid, _oemid, CID_YEAR_ANY, CID_MONTH_ANY, \ 123 _rev_start, _rev_end, \ 124 SDIO_ANY_ID, SDIO_ANY_ID, \ 125 _fixup, _data, _ext_csd_rev) \ 126 127 #define MMC_FIXUP(_name, _manfid, _oemid, _fixup, _data) \ 128 MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data, \ 129 EXT_CSD_REV_ANY) 130 131 #define MMC_FIXUP_EXT_CSD_REV(_name, _manfid, _oemid, _fixup, _data, \ 132 _ext_csd_rev) \ 133 MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data, \ 134 _ext_csd_rev) 135 136 #define SDIO_FIXUP(_vendor, _device, _fixup, _data) \ 137 _FIXUP_EXT(CID_NAME_ANY, CID_MANFID_ANY, CID_OEMID_ANY, \ 138 CID_YEAR_ANY, CID_MONTH_ANY, \ 139 0, -1ull, \ 140 _vendor, _device, \ 141 _fixup, _data, EXT_CSD_REV_ANY) \ 142 143 #define SDIO_FIXUP_COMPATIBLE(_compatible, _fixup, _data) \ 144 { \ 145 .name = CID_NAME_ANY, \ 146 .manfid = CID_MANFID_ANY, \ 147 .oemid = CID_OEMID_ANY, \ 148 .rev_start = 0, \ 149 .rev_end = -1ull, \ 150 .cis_vendor = SDIO_ANY_ID, \ 151 .cis_device = SDIO_ANY_ID, \ 152 .vendor_fixup = (_fixup), \ 153 .data = (_data), \ 154 .ext_csd_rev = EXT_CSD_REV_ANY, \ 155 .of_compatible = _compatible, \ 156 } 157 158 #define cid_rev(hwrev, fwrev, year, month) \ 159 (((u64) hwrev) << 40 | \ 160 ((u64) fwrev) << 32 | \ 161 ((u64) year) << 16 | \ 162 ((u64) month)) 163 164 #define cid_rev_card(card) \ 165 cid_rev(card->cid.hwrev, \ 166 card->cid.fwrev, \ 167 card->cid.year, \ 168 card->cid.month) 169 170 /* 171 * Unconditionally quirk add/remove. 172 */ 173 static inline void __maybe_unused add_quirk(struct mmc_card *card, int data) 174 { 175 card->quirks |= data; 176 } 177 178 static inline void __maybe_unused remove_quirk(struct mmc_card *card, int data) 179 { 180 card->quirks &= ~data; 181 } 182 183 static inline void __maybe_unused add_limit_rate_quirk(struct mmc_card *card, 184 int data) 185 { 186 card->quirk_max_rate = data; 187 } 188 189 static inline void __maybe_unused wl1251_quirk(struct mmc_card *card, 190 int data) 191 { 192 /* 193 * We have TI wl1251 attached to this mmc. Pass this 194 * information to the SDIO core because it can't be 195 * probed by normal methods. 196 */ 197 198 dev_info(card->host->parent, "found wl1251\n"); 199 card->quirks |= MMC_QUIRK_NONSTD_SDIO; 200 card->cccr.wide_bus = 1; 201 card->cis.vendor = 0x104c; 202 card->cis.device = 0x9066; 203 card->cis.blksize = 512; 204 card->cis.max_dtr = 24000000; 205 } 206 207 /* 208 * Quirk add/remove for MMC products. 209 */ 210 static inline void __maybe_unused add_quirk_mmc(struct mmc_card *card, int data) 211 { 212 if (mmc_card_mmc(card)) 213 card->quirks |= data; 214 } 215 216 static inline void __maybe_unused remove_quirk_mmc(struct mmc_card *card, 217 int data) 218 { 219 if (mmc_card_mmc(card)) 220 card->quirks &= ~data; 221 } 222 223 /* 224 * Quirk add/remove for SD products. 225 */ 226 static inline void __maybe_unused add_quirk_sd(struct mmc_card *card, int data) 227 { 228 if (mmc_card_sd(card)) 229 card->quirks |= data; 230 } 231 232 static inline void __maybe_unused remove_quirk_sd(struct mmc_card *card, 233 int data) 234 { 235 if (mmc_card_sd(card)) 236 card->quirks &= ~data; 237 } 238 239 static inline int mmc_card_lenient_fn0(const struct mmc_card *c) 240 { 241 return c->quirks & MMC_QUIRK_LENIENT_FN0; 242 } 243 244 static inline int mmc_blksz_for_byte_mode(const struct mmc_card *c) 245 { 246 return c->quirks & MMC_QUIRK_BLKSZ_FOR_BYTE_MODE; 247 } 248 249 static inline int mmc_card_nonstd_func_interface(const struct mmc_card *c) 250 { 251 return c->quirks & MMC_QUIRK_NONSTD_FUNC_IF; 252 } 253 254 static inline int mmc_card_disable_cd(const struct mmc_card *c) 255 { 256 return c->quirks & MMC_QUIRK_DISABLE_CD; 257 } 258 259 static inline int mmc_card_blk_no_cmd23(const struct mmc_card *c) 260 { 261 return c->quirks & MMC_QUIRK_BLK_NO_CMD23; 262 } 263 264 static inline int mmc_card_broken_byte_mode_512(const struct mmc_card *c) 265 { 266 return c->quirks & MMC_QUIRK_BROKEN_BYTE_MODE_512; 267 } 268 269 static inline int mmc_card_long_read_time(const struct mmc_card *c) 270 { 271 return c->quirks & MMC_QUIRK_LONG_READ_TIME; 272 } 273 274 static inline int mmc_card_broken_irq_polling(const struct mmc_card *c) 275 { 276 return c->quirks & MMC_QUIRK_BROKEN_IRQ_POLLING; 277 } 278 279 static inline int mmc_card_broken_hpi(const struct mmc_card *c) 280 { 281 return c->quirks & MMC_QUIRK_BROKEN_HPI; 282 } 283 284 static inline int mmc_card_broken_sd_discard(const struct mmc_card *c) 285 { 286 return c->quirks & MMC_QUIRK_BROKEN_SD_DISCARD; 287 } 288 289 static inline int mmc_card_broken_sd_cache(const struct mmc_card *c) 290 { 291 return c->quirks & MMC_QUIRK_BROKEN_SD_CACHE; 292 } 293 294 static inline int mmc_card_broken_cache_flush(const struct mmc_card *c) 295 { 296 return c->quirks & MMC_QUIRK_BROKEN_CACHE_FLUSH; 297 } 298 299 static inline int mmc_card_broken_sd_poweroff_notify(const struct mmc_card *c) 300 { 301 return c->quirks & MMC_QUIRK_BROKEN_SD_POWEROFF_NOTIFY; 302 } 303 304 static inline int mmc_card_no_uhs_ddr50_tuning(const struct mmc_card *c) 305 { 306 return c->quirks & MMC_QUIRK_NO_UHS_DDR50_TUNING; 307 } 308 309 static inline int mmc_card_broken_mdt(const struct mmc_card *c) 310 { 311 return c->quirks & MMC_QUIRK_BROKEN_MDT; 312 } 313 314 static inline int mmc_card_fixed_secure_erase_trim_time(const struct mmc_card *c) 315 { 316 return c->quirks & MMC_QUIRK_FIXED_SECURE_ERASE_TRIM_TIME; 317 } 318 319 #endif 320