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 /* Match against functions declared in device tree */ 63 const char *of_compatible; 64 65 void (*vendor_fixup)(struct mmc_card *card, int data); 66 int data; 67 }; 68 69 #define CID_MANFID_ANY (-1u) 70 #define CID_OEMID_ANY ((unsigned short) -1) 71 #define CID_NAME_ANY (NULL) 72 73 #define EXT_CSD_REV_ANY (-1u) 74 75 #define CID_MANFID_SANDISK 0x2 76 #define CID_MANFID_SANDISK_SD 0x3 77 #define CID_MANFID_ATP 0x9 78 #define CID_MANFID_TOSHIBA 0x11 79 #define CID_MANFID_MICRON 0x13 80 #define CID_MANFID_SAMSUNG 0x15 81 #define CID_MANFID_APACER 0x27 82 #define CID_MANFID_KINGSTON 0x70 83 #define CID_MANFID_HYNIX 0x90 84 #define CID_MANFID_NUMONYX 0xFE 85 86 #define END_FIXUP { NULL } 87 88 #define _FIXUP_EXT(_name, _manfid, _oemid, _rev_start, _rev_end, \ 89 _cis_vendor, _cis_device, \ 90 _fixup, _data, _ext_csd_rev) \ 91 { \ 92 .name = (_name), \ 93 .manfid = (_manfid), \ 94 .oemid = (_oemid), \ 95 .rev_start = (_rev_start), \ 96 .rev_end = (_rev_end), \ 97 .cis_vendor = (_cis_vendor), \ 98 .cis_device = (_cis_device), \ 99 .vendor_fixup = (_fixup), \ 100 .data = (_data), \ 101 .ext_csd_rev = (_ext_csd_rev), \ 102 } 103 104 #define MMC_FIXUP_REV(_name, _manfid, _oemid, _rev_start, _rev_end, \ 105 _fixup, _data, _ext_csd_rev) \ 106 _FIXUP_EXT(_name, _manfid, \ 107 _oemid, _rev_start, _rev_end, \ 108 SDIO_ANY_ID, SDIO_ANY_ID, \ 109 _fixup, _data, _ext_csd_rev) \ 110 111 #define MMC_FIXUP(_name, _manfid, _oemid, _fixup, _data) \ 112 MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data, \ 113 EXT_CSD_REV_ANY) 114 115 #define MMC_FIXUP_EXT_CSD_REV(_name, _manfid, _oemid, _fixup, _data, \ 116 _ext_csd_rev) \ 117 MMC_FIXUP_REV(_name, _manfid, _oemid, 0, -1ull, _fixup, _data, \ 118 _ext_csd_rev) 119 120 #define SDIO_FIXUP(_vendor, _device, _fixup, _data) \ 121 _FIXUP_EXT(CID_NAME_ANY, CID_MANFID_ANY, \ 122 CID_OEMID_ANY, 0, -1ull, \ 123 _vendor, _device, \ 124 _fixup, _data, EXT_CSD_REV_ANY) \ 125 126 #define SDIO_FIXUP_COMPATIBLE(_compatible, _fixup, _data) \ 127 { \ 128 .name = CID_NAME_ANY, \ 129 .manfid = CID_MANFID_ANY, \ 130 .oemid = CID_OEMID_ANY, \ 131 .rev_start = 0, \ 132 .rev_end = -1ull, \ 133 .cis_vendor = SDIO_ANY_ID, \ 134 .cis_device = SDIO_ANY_ID, \ 135 .vendor_fixup = (_fixup), \ 136 .data = (_data), \ 137 .ext_csd_rev = EXT_CSD_REV_ANY, \ 138 .of_compatible = _compatible, \ 139 } 140 141 #define cid_rev(hwrev, fwrev, year, month) \ 142 (((u64) hwrev) << 40 | \ 143 ((u64) fwrev) << 32 | \ 144 ((u64) year) << 16 | \ 145 ((u64) month)) 146 147 #define cid_rev_card(card) \ 148 cid_rev(card->cid.hwrev, \ 149 card->cid.fwrev, \ 150 card->cid.year, \ 151 card->cid.month) 152 153 /* 154 * Unconditionally quirk add/remove. 155 */ 156 static inline void __maybe_unused add_quirk(struct mmc_card *card, int data) 157 { 158 card->quirks |= data; 159 } 160 161 static inline void __maybe_unused remove_quirk(struct mmc_card *card, int data) 162 { 163 card->quirks &= ~data; 164 } 165 166 static inline void __maybe_unused add_limit_rate_quirk(struct mmc_card *card, 167 int data) 168 { 169 card->quirk_max_rate = data; 170 } 171 172 static inline void __maybe_unused wl1251_quirk(struct mmc_card *card, 173 int data) 174 { 175 /* 176 * We have TI wl1251 attached to this mmc. Pass this 177 * information to the SDIO core because it can't be 178 * probed by normal methods. 179 */ 180 181 dev_info(card->host->parent, "found wl1251\n"); 182 card->quirks |= MMC_QUIRK_NONSTD_SDIO; 183 card->cccr.wide_bus = 1; 184 card->cis.vendor = 0x104c; 185 card->cis.device = 0x9066; 186 card->cis.blksize = 512; 187 card->cis.max_dtr = 24000000; 188 } 189 190 /* 191 * Quirk add/remove for MMC products. 192 */ 193 static inline void __maybe_unused add_quirk_mmc(struct mmc_card *card, int data) 194 { 195 if (mmc_card_mmc(card)) 196 card->quirks |= data; 197 } 198 199 static inline void __maybe_unused remove_quirk_mmc(struct mmc_card *card, 200 int data) 201 { 202 if (mmc_card_mmc(card)) 203 card->quirks &= ~data; 204 } 205 206 /* 207 * Quirk add/remove for SD products. 208 */ 209 static inline void __maybe_unused add_quirk_sd(struct mmc_card *card, int data) 210 { 211 if (mmc_card_sd(card)) 212 card->quirks |= data; 213 } 214 215 static inline void __maybe_unused remove_quirk_sd(struct mmc_card *card, 216 int data) 217 { 218 if (mmc_card_sd(card)) 219 card->quirks &= ~data; 220 } 221 222 static inline int mmc_card_lenient_fn0(const struct mmc_card *c) 223 { 224 return c->quirks & MMC_QUIRK_LENIENT_FN0; 225 } 226 227 static inline int mmc_blksz_for_byte_mode(const struct mmc_card *c) 228 { 229 return c->quirks & MMC_QUIRK_BLKSZ_FOR_BYTE_MODE; 230 } 231 232 static inline int mmc_card_disable_cd(const struct mmc_card *c) 233 { 234 return c->quirks & MMC_QUIRK_DISABLE_CD; 235 } 236 237 static inline int mmc_card_nonstd_func_interface(const struct mmc_card *c) 238 { 239 return c->quirks & MMC_QUIRK_NONSTD_FUNC_IF; 240 } 241 242 static inline int mmc_card_broken_byte_mode_512(const struct mmc_card *c) 243 { 244 return c->quirks & MMC_QUIRK_BROKEN_BYTE_MODE_512; 245 } 246 247 static inline int mmc_card_long_read_time(const struct mmc_card *c) 248 { 249 return c->quirks & MMC_QUIRK_LONG_READ_TIME; 250 } 251 252 static inline int mmc_card_broken_irq_polling(const struct mmc_card *c) 253 { 254 return c->quirks & MMC_QUIRK_BROKEN_IRQ_POLLING; 255 } 256 257 static inline int mmc_card_broken_hpi(const struct mmc_card *c) 258 { 259 return c->quirks & MMC_QUIRK_BROKEN_HPI; 260 } 261 262 static inline int mmc_card_broken_sd_discard(const struct mmc_card *c) 263 { 264 return c->quirks & MMC_QUIRK_BROKEN_SD_DISCARD; 265 } 266 267 #endif 268