drivers/mmc/host/cqhci.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /* Copyright (c) 2015, The Linux Foundation. All rights reserved.
   3  */
   4 #ifndef LINUX_MMC_CQHCI_H
   5 #define LINUX_MMC_CQHCI_H
   6
   7 #include <linux/compiler.h>
   8 #include <linux/bitfield.h>
   9 #include <linux/bitops.h>
  10 #include <linux/spinlock_types.h>
  11 #include <linux/types.h>
  12 #include <linux/completion.h>
  13 #include <linux/wait.h>
  14 #include <linux/irqreturn.h>
  15 #include <asm/io.h>
  16
  17 /* registers */
  18 /* version */
  19 #define CQHCI_VER                       0x00
  20 #define CQHCI_VER_MAJOR(x)              (((x) & GENMASK(11, 8)) >> 8)
  21 #define CQHCI_VER_MINOR1(x)             (((x) & GENMASK(7, 4)) >> 4)
  22 #define CQHCI_VER_MINOR2(x)             ((x) & GENMASK(3, 0))
  23
  24 /* capabilities */
  25 #define CQHCI_CAP                       0x04
  26 #define CQHCI_CAP_CS                    0x10000000 /* Crypto Support */
  27 #define CQHCI_CAP_ITCFMUL               GENMASK(15, 12)
  28 #define CQHCI_ITCFMUL(x)                FIELD_GET(CQHCI_CAP_ITCFMUL, (x))
  29
  30 /* configuration */
  31 #define CQHCI_CFG                       0x08
  32 #define CQHCI_DCMD                      0x00001000
  33 #define CQHCI_TASK_DESC_SZ              0x00000100
  34 #define CQHCI_CRYPTO_GENERAL_ENABLE     0x00000002
  35 #define CQHCI_ENABLE                    0x00000001
  36
  37 /* control */
  38 #define CQHCI_CTL                       0x0C
  39 #define CQHCI_CLEAR_ALL_TASKS           0x00000100
  40 #define CQHCI_HALT                      0x00000001
  41
  42 /* interrupt status */
  43 #define CQHCI_IS                        0x10
  44 #define CQHCI_IS_HAC                    BIT(0)
  45 #define CQHCI_IS_TCC                    BIT(1)
  46 #define CQHCI_IS_RED                    BIT(2)
  47 #define CQHCI_IS_TCL                    BIT(3)
  48 #define CQHCI_IS_GCE                    BIT(4) /* General Crypto Error */
  49 #define CQHCI_IS_ICCE                   BIT(5) /* Invalid Crypto Config Error */
  50
  51 #define CQHCI_IS_MASK (CQHCI_IS_TCC | CQHCI_IS_RED | \
  52                        CQHCI_IS_GCE | CQHCI_IS_ICCE)
  53
  54 /* interrupt status enable */
  55 #define CQHCI_ISTE                      0x14
  56
  57 /* interrupt signal enable */
  58 #define CQHCI_ISGE                      0x18
  59
  60 /* interrupt coalescing */
  61 #define CQHCI_IC                        0x1C
  62 #define CQHCI_IC_ENABLE                 BIT(31)
  63 #define CQHCI_IC_RESET                  BIT(16)
  64 #define CQHCI_IC_ICCTHWEN               BIT(15)
  65 #define CQHCI_IC_ICCTH(x)               (((x) & 0x1F) << 8)
  66 #define CQHCI_IC_ICTOVALWEN             BIT(7)
  67 #define CQHCI_IC_ICTOVAL(x)             ((x) & 0x7F)
  68
  69 /* task list base address */
  70 #define CQHCI_TDLBA                     0x20
  71
  72 /* task list base address upper */
  73 #define CQHCI_TDLBAU                    0x24
  74
  75 /* door-bell */
  76 #define CQHCI_TDBR                      0x28
  77
  78 /* task completion notification */
  79 #define CQHCI_TCN                       0x2C
  80
  81 /* device queue status */
  82 #define CQHCI_DQS                       0x30
  83
  84 /* device pending tasks */
  85 #define CQHCI_DPT                       0x34
  86
  87 /* task clear */
  88 #define CQHCI_TCLR                      0x38
  89
  90 /* task descriptor processing error */
  91 #define CQHCI_TDPE                      0x3c
  92
  93 /* send status config 1 */
  94 #define CQHCI_SSC1                      0x40
  95 #define CQHCI_SSC1_CBC_MASK             GENMASK(19, 16)
  96
  97 /* send status config 2 */
  98 #define CQHCI_SSC2                      0x44
  99
 100 /* response for dcmd */
 101 #define CQHCI_CRDCT                     0x48
 102
 103 /* response mode error mask */
 104 #define CQHCI_RMEM                      0x50
 105
 106 /* task error info */
 107 #define CQHCI_TERRI                     0x54
 108
 109 #define CQHCI_TERRI_C_INDEX(x)          ((x) & GENMASK(5, 0))
 110 #define CQHCI_TERRI_C_TASK(x)           (((x) & GENMASK(12, 8)) >> 8)
 111 #define CQHCI_TERRI_C_VALID(x)          ((x) & BIT(15))
 112 #define CQHCI_TERRI_D_INDEX(x)          (((x) & GENMASK(21, 16)) >> 16)
 113 #define CQHCI_TERRI_D_TASK(x)           (((x) & GENMASK(28, 24)) >> 24)
 114 #define CQHCI_TERRI_D_VALID(x)          ((x) & BIT(31))
 115
 116 /* command response index */
 117 #define CQHCI_CRI                       0x58
 118
 119 /* command response argument */
 120 #define CQHCI_CRA                       0x5C
 121
 122 /* crypto capabilities */
 123 #define CQHCI_CCAP                      0x100
 124 #define CQHCI_CRYPTOCAP                 0x104
 125
 126 #define CQHCI_INT_ALL                   0xF
 127 #define CQHCI_IC_DEFAULT_ICCTH          31
 128 #define CQHCI_IC_DEFAULT_ICTOVAL        1
 129
 130 /* attribute fields */
 131 #define CQHCI_VALID(x)                  (((x) & 1) << 0)
 132 #define CQHCI_END(x)                    (((x) & 1) << 1)
 133 #define CQHCI_INT(x)                    (((x) & 1) << 2)
 134 #define CQHCI_ACT(x)                    (((x) & 0x7) << 3)
 135
 136 /* data command task descriptor fields */
 137 #define CQHCI_FORCED_PROG(x)            (((x) & 1) << 6)
 138 #define CQHCI_CONTEXT(x)                (((x) & 0xF) << 7)
 139 #define CQHCI_DATA_TAG(x)               (((x) & 1) << 11)
 140 #define CQHCI_DATA_DIR(x)               (((x) & 1) << 12)
 141 #define CQHCI_PRIORITY(x)               (((x) & 1) << 13)
 142 #define CQHCI_QBAR(x)                   (((x) & 1) << 14)
 143 #define CQHCI_REL_WRITE(x)              (((x) & 1) << 15)
 144 #define CQHCI_BLK_COUNT(x)              (((x) & 0xFFFF) << 16)
 145 #define CQHCI_BLK_ADDR(x)               (((x) & 0xFFFFFFFF) << 32)
 146
 147 /* direct command task descriptor fields */
 148 #define CQHCI_CMD_INDEX(x)              (((x) & 0x3F) << 16)
 149 #define CQHCI_CMD_TIMING(x)             (((x) & 1) << 22)
 150 #define CQHCI_RESP_TYPE(x)              (((x) & 0x3) << 23)
 151
 152 /* crypto task descriptor fields (for bits 64-127 of task descriptor) */
 153 #define CQHCI_CRYPTO_ENABLE_BIT         (1ULL << 47)
 154 #define CQHCI_CRYPTO_KEYSLOT(x)         ((u64)(x) << 32)
 155
 156 /* transfer descriptor fields */
 157 #define CQHCI_DAT_LENGTH(x)             (((x) & 0xFFFF) << 16)
 158 #define CQHCI_DAT_ADDR_LO(x)            (((x) & 0xFFFFFFFF) << 32)
 159 #define CQHCI_DAT_ADDR_HI(x)            (((x) & 0xFFFFFFFF) << 0)
 160
 161 /* CCAP - Crypto Capability 100h */
 162 union cqhci_crypto_capabilities {
 163         __le32 reg_val;
 164         struct {
 165                 u8 num_crypto_cap;
 166                 u8 config_count;
 167                 u8 reserved;
 168                 u8 config_array_ptr;
 169         };
 170 };
 171
 172 enum cqhci_crypto_key_size {
 173         CQHCI_CRYPTO_KEY_SIZE_INVALID   = 0,
 174         CQHCI_CRYPTO_KEY_SIZE_128       = 1,
 175         CQHCI_CRYPTO_KEY_SIZE_192       = 2,
 176         CQHCI_CRYPTO_KEY_SIZE_256       = 3,
 177         CQHCI_CRYPTO_KEY_SIZE_512       = 4,
 178 };
 179
 180 enum cqhci_crypto_alg {
 181         CQHCI_CRYPTO_ALG_AES_XTS                = 0,
 182         CQHCI_CRYPTO_ALG_BITLOCKER_AES_CBC      = 1,
 183         CQHCI_CRYPTO_ALG_AES_ECB                = 2,
 184         CQHCI_CRYPTO_ALG_ESSIV_AES_CBC          = 3,
 185 };
 186
 187 /* x-CRYPTOCAP - Crypto Capability X */
 188 union cqhci_crypto_cap_entry {
 189         __le32 reg_val;
 190         struct {
 191                 u8 algorithm_id;
 192                 u8 sdus_mask; /* Supported data unit size mask */
 193                 u8 key_size;
 194                 u8 reserved;
 195         };
 196 };
 197
 198 #define CQHCI_CRYPTO_CONFIGURATION_ENABLE (1 << 7)
 199 #define CQHCI_CRYPTO_KEY_MAX_SIZE 64
 200 /* x-CRYPTOCFG - Crypto Configuration X */
 201 union cqhci_crypto_cfg_entry {
 202         __le32 reg_val[32];
 203         struct {
 204                 u8 crypto_key[CQHCI_CRYPTO_KEY_MAX_SIZE];
 205                 u8 data_unit_size;
 206                 u8 crypto_cap_idx;
 207                 u8 reserved_1;
 208                 u8 config_enable;
 209                 u8 reserved_multi_host;
 210                 u8 reserved_2;
 211                 u8 vsb[2];
 212                 u8 reserved_3[56];
 213         };
 214 };
 215
 216 struct cqhci_host_ops;
 217 struct mmc_host;
 218 struct mmc_request;
 219 struct cqhci_slot;
 220
 221 struct cqhci_host {
 222         const struct cqhci_host_ops *ops;
 223         void __iomem *mmio;
 224         struct mmc_host *mmc;
 225
 226         spinlock_t lock;
 227
 228         /* relative card address of device */
 229         unsigned int rca;
 230
 231         /* 64 bit DMA */
 232         bool dma64;
 233         int num_slots;
 234         int qcnt;
 235
 236         u32 dcmd_slot;
 237         u32 caps;
 238 #define CQHCI_TASK_DESC_SZ_128          0x1
 239
 240         u32 quirks;
 241 #define CQHCI_QUIRK_SHORT_TXFR_DESC_SZ  0x1
 242
 243         bool enabled;
 244         bool halted;
 245         bool init_done;
 246         bool activated;
 247         bool waiting_for_idle;
 248         bool recovery_halt;
 249
 250         size_t desc_size;
 251         size_t data_size;
 252
 253         u8 *desc_base;
 254
 255         /* total descriptor size */
 256         u8 slot_sz;
 257
 258         /* 64/128 bit depends on CQHCI_CFG */
 259         u8 task_desc_len;
 260
 261         /* 64 bit on 32-bit arch, 128 bit on 64-bit */
 262         u8 link_desc_len;
 263
 264         u8 *trans_desc_base;
 265         /* same length as transfer descriptor */
 266         u8 trans_desc_len;
 267
 268         dma_addr_t desc_dma_base;
 269         dma_addr_t trans_desc_dma_base;
 270
 271         struct completion halt_comp;
 272         wait_queue_head_t wait_queue;
 273         struct cqhci_slot *slot;
 274
 275 #ifdef CONFIG_MMC_CRYPTO
 276         union cqhci_crypto_capabilities crypto_capabilities;
 277         union cqhci_crypto_cap_entry *crypto_cap_array;
 278         u32 crypto_cfg_register;
 279 #endif
 280 };
 281
 282 struct cqhci_host_ops {
 283         void (*dumpregs)(struct mmc_host *mmc);
 284         void (*write_l)(struct cqhci_host *host, u32 val, int reg);
 285         u32 (*read_l)(struct cqhci_host *host, int reg);
 286         void (*enable)(struct mmc_host *mmc);
 287         void (*disable)(struct mmc_host *mmc, bool recovery);
 288         void (*update_dcmd_desc)(struct mmc_host *mmc, struct mmc_request *mrq,
 289                                  u64 *data);
 290         void (*pre_enable)(struct mmc_host *mmc);
 291         void (*post_disable)(struct mmc_host *mmc);
 292 #ifdef CONFIG_MMC_CRYPTO
 293         int (*program_key)(struct cqhci_host *cq_host,
 294                            const union cqhci_crypto_cfg_entry *cfg, int slot);
 295 #endif
 296 };
 297
 298 static inline void cqhci_writel(struct cqhci_host *host, u32 val, int reg)
 299 {
 300         if (unlikely(host->ops->write_l))
 301                 host->ops->write_l(host, val, reg);
 302         else
 303                 writel_relaxed(val, host->mmio + reg);
 304 }
 305
 306 static inline u32 cqhci_readl(struct cqhci_host *host, int reg)
 307 {
 308         if (unlikely(host->ops->read_l))
 309                 return host->ops->read_l(host, reg);
 310         else
 311                 return readl_relaxed(host->mmio + reg);
 312 }
 313
 314 struct platform_device;
 315
 316 irqreturn_t cqhci_irq(struct mmc_host *mmc, u32 intmask, int cmd_error,
 317                       int data_error);
 318 int cqhci_init(struct cqhci_host *cq_host, struct mmc_host *mmc, bool dma64);
 319 struct cqhci_host *cqhci_pltfm_init(struct platform_device *pdev);
 320 int cqhci_deactivate(struct mmc_host *mmc);
 321 static inline int cqhci_suspend(struct mmc_host *mmc)
 322 {
 323         return cqhci_deactivate(mmc);
 324 }
 325 int cqhci_resume(struct mmc_host *mmc);
 326
 327 #endif