include/dwmmc.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * (C) Copyright 2012 SAMSUNG Electronics
   4  * Jaehoon Chung <jh80.chung@samsung.com>
   5  */
   6
   7 #ifndef __DWMMC_HW_H
   8 #define __DWMMC_HW_H
   9
  10 #include <asm/cache.h>
  11 #include <asm/io.h>
  12 #include <mmc.h>
  13 #include <linux/bitops.h>
  14
  15 #define DWMCI_CTRL              0x000
  16 #define DWMCI_PWREN             0x004
  17 #define DWMCI_CLKDIV            0x008
  18 #define DWMCI_CLKSRC            0x00C
  19 #define DWMCI_CLKENA            0x010
  20 #define DWMCI_TMOUT             0x014
  21 #define DWMCI_CTYPE             0x018
  22 #define DWMCI_BLKSIZ            0x01C
  23 #define DWMCI_BYTCNT            0x020
  24 #define DWMCI_INTMASK           0x024
  25 #define DWMCI_CMDARG            0x028
  26 #define DWMCI_CMD               0x02C
  27 #define DWMCI_RESP0             0x030
  28 #define DWMCI_RESP1             0x034
  29 #define DWMCI_RESP2             0x038
  30 #define DWMCI_RESP3             0x03C
  31 #define DWMCI_MINTSTS           0x040
  32 #define DWMCI_RINTSTS           0x044
  33 #define DWMCI_STATUS            0x048
  34 #define DWMCI_FIFOTH            0x04C
  35 #define DWMCI_CDETECT           0x050
  36 #define DWMCI_WRTPRT            0x054
  37 #define DWMCI_GPIO              0x058
  38 #define DWMCI_TCMCNT            0x05C
  39 #define DWMCI_TBBCNT            0x060
  40 #define DWMCI_DEBNCE            0x064
  41 #define DWMCI_USRID             0x068
  42 #define DWMCI_VERID             0x06C
  43 #define DWMCI_HCON              0x070
  44 #define DWMCI_UHS_REG           0x074
  45 #define DWMCI_BMOD              0x080
  46 #define DWMCI_PLDMND            0x084
  47 #define DWMCI_DBADDR            0x088
  48 #define DWMCI_IDSTS             0x08C
  49 #define DWMCI_IDINTEN           0x090
  50 #define DWMCI_DSCADDR           0x094
  51 #define DWMCI_BUFADDR           0x098
  52 #define DWMCI_DATA              0x200
  53
  54 /* Interrupt Mask register */
  55 #define DWMCI_INTMSK_ALL        0xffffffff
  56 #define DWMCI_INTMSK_RE         (1 << 1)
  57 #define DWMCI_INTMSK_CDONE      (1 << 2)
  58 #define DWMCI_INTMSK_DTO        (1 << 3)
  59 #define DWMCI_INTMSK_TXDR       (1 << 4)
  60 #define DWMCI_INTMSK_RXDR       (1 << 5)
  61 #define DWMCI_INTMSK_RCRC       (1 << 6)
  62 #define DWMCI_INTMSK_DCRC       (1 << 7)
  63 #define DWMCI_INTMSK_RTO        (1 << 8)
  64 #define DWMCI_INTMSK_DRTO       (1 << 9)
  65 #define DWMCI_INTMSK_HTO        (1 << 10)
  66 #define DWMCI_INTMSK_FRUN       (1 << 11)
  67 #define DWMCI_INTMSK_HLE        (1 << 12)
  68 #define DWMCI_INTMSK_SBE        (1 << 13)
  69 #define DWMCI_INTMSK_ACD        (1 << 14)
  70 #define DWMCI_INTMSK_EBE        (1 << 15)
  71
  72 /* Raw interrupt Regsiter */
  73 #define DWMCI_DATA_ERR  (DWMCI_INTMSK_EBE | DWMCI_INTMSK_SBE | DWMCI_INTMSK_HLE |\
  74                         DWMCI_INTMSK_FRUN | DWMCI_INTMSK_EBE | DWMCI_INTMSK_DCRC)
  75 #define DWMCI_DATA_TOUT (DWMCI_INTMSK_HTO | DWMCI_INTMSK_DRTO)
  76 /* CTRL register */
  77 #define DWMCI_CTRL_RESET        (1 << 0)
  78 #define DWMCI_CTRL_FIFO_RESET   (1 << 1)
  79 #define DWMCI_CTRL_DMA_RESET    (1 << 2)
  80 #define DWMCI_DMA_EN            (1 << 5)
  81 #define DWMCI_CTRL_SEND_AS_CCSD (1 << 10)
  82 #define DWMCI_IDMAC_EN          (1 << 25)
  83 #define DWMCI_RESET_ALL         (DWMCI_CTRL_RESET | DWMCI_CTRL_FIFO_RESET |\
  84                                 DWMCI_CTRL_DMA_RESET)
  85
  86 /* CMD register */
  87 #define DWMCI_CMD_RESP_EXP      (1 << 6)
  88 #define DWMCI_CMD_RESP_LENGTH   (1 << 7)
  89 #define DWMCI_CMD_CHECK_CRC     (1 << 8)
  90 #define DWMCI_CMD_DATA_EXP      (1 << 9)
  91 #define DWMCI_CMD_RW            (1 << 10)
  92 #define DWMCI_CMD_SEND_STOP     (1 << 12)
  93 #define DWMCI_CMD_ABORT_STOP    (1 << 14)
  94 #define DWMCI_CMD_PRV_DAT_WAIT  (1 << 13)
  95 #define DWMCI_CMD_UPD_CLK       (1 << 21)
  96 #define DWMCI_CMD_USE_HOLD_REG  (1 << 29)
  97 #define DWMCI_CMD_START         (1 << 31)
  98
  99 /* CLKENA register */
 100 #define DWMCI_CLKEN_ENABLE      (1 << 0)
 101 #define DWMCI_CLKEN_LOW_PWR     (1 << 16)
 102
 103 /* Card-type registe */
 104 #define DWMCI_CTYPE_1BIT        0
 105 #define DWMCI_CTYPE_4BIT        (1 << 0)
 106 #define DWMCI_CTYPE_8BIT        (1 << 16)
 107
 108 /* Status Register */
 109 #define DWMCI_FIFO_EMPTY        (1 << 2)
 110 #define DWMCI_FIFO_FULL         (1 << 3)
 111 #define DWMCI_BUSY              (1 << 9)
 112 #define DWMCI_FIFO_MASK         0x1fff
 113 #define DWMCI_FIFO_SHIFT        17
 114
 115 /* FIFOTH Register */
 116 #define MSIZE(x)                ((x) << 28)
 117 #define RX_WMARK(x)             ((x) << 16)
 118 #define TX_WMARK(x)             (x)
 119 #define RX_WMARK_SHIFT          16
 120 #define RX_WMARK_MASK           (0xfff << RX_WMARK_SHIFT)
 121
 122 #define DWMCI_IDMAC_OWN         (1 << 31)
 123 #define DWMCI_IDMAC_CH          (1 << 4)
 124 #define DWMCI_IDMAC_FS          (1 << 3)
 125 #define DWMCI_IDMAC_LD          (1 << 2)
 126
 127 /*  Bus Mode Register */
 128 #define DWMCI_BMOD_IDMAC_RESET  (1 << 0)
 129 #define DWMCI_BMOD_IDMAC_FB     (1 << 1)
 130 #define DWMCI_BMOD_IDMAC_EN     (1 << 7)
 131
 132 /* UHS register */
 133 #define DWMCI_DDR_MODE  (1 << 16)
 134
 135 /* Internal IDMAC interrupt defines */
 136 #define DWMCI_IDINTEN_RI                BIT(1)
 137 #define DWMCI_IDINTEN_TI                BIT(0)
 138
 139 #define DWMCI_IDINTEN_MASK      (DWMCI_IDINTEN_TI | \
 140                                  DWMCI_IDINTEN_RI)
 141
 142 /* quirks */
 143 #define DWMCI_QUIRK_DISABLE_SMU         (1 << 0)
 144
 145 #define DWMCI_GET_ADDR_CONFIG(x) (((x)>>27) & 0x1)
 146 /**
 147  * struct dwmci_host - Information about a designware MMC host
 148  *
 149  * @name:       Device name
 150  * @ioaddr:     Base I/O address of controller
 151  * @quirks:     Quick flags - see DWMCI_QUIRK_...
 152  * @caps:       Capabilities - see MMC_MODE_...
 153  * @bus_hz:     Bus speed in Hz, if @get_mmc_clk() is NULL
 154  * @div:        Arbitrary clock divider value for use by controller
 155  * @dev_index:  Arbitrary device index for use by controller
 156  * @dev_id:     Arbitrary device ID for use by controller
 157  * @buswidth:   Bus width in bits (8 or 4)
 158  * @fifoth_val: Value for FIFOTH register (or 0 to leave unset)
 159  * @dma_64bit_address:  True only for devices supporting 64 bit DMA
 160  * @mmc:        Pointer to generic MMC structure for this device
 161  * @priv:       Private pointer for use by controller
 162  */
 163 struct dwmci_host {
 164         const char *name;
 165         void *ioaddr;
 166         unsigned int quirks;
 167         unsigned int caps;
 168         unsigned int version;
 169         unsigned int clock;
 170         unsigned int bus_hz;
 171         unsigned int div;
 172         int dev_index;
 173         int dev_id;
 174         int buswidth;
 175         u32 fifoth_val;
 176         int dma_64bit_address;
 177         struct mmc *mmc;
 178         void *priv;
 179
 180         void (*clksel)(struct dwmci_host *host);
 181         void (*board_init)(struct dwmci_host *host);
 182
 183         /**
 184          * Get / set a particular MMC clock frequency
 185          *
 186          * This is used to request the current clock frequency of the clock
 187          * that drives the DWMMC peripheral. The caller will then use this
 188          * information to work out the divider it needs to achieve the
 189          * required MMC bus clock frequency. If you want to handle the
 190          * clock external to DWMMC, use @freq to select the frequency and
 191          * return that value too. Then DWMMC will put itself in bypass mode.
 192          *
 193          * @host:       DWMMC host
 194          * @freq:       Frequency the host is trying to achieve
 195          */
 196         unsigned int (*get_mmc_clk)(struct dwmci_host *host, uint freq);
 197 #ifndef CONFIG_BLK
 198         struct mmc_config cfg;
 199 #endif
 200
 201         /* use fifo mode to read and write data */
 202         bool fifo_mode;
 203 };
 204
 205 struct dwmci_idmac {
 206         u32 flags;
 207         u32 cnt;
 208         u32 addr;
 209         u32 next_addr;
 210 } __aligned(ARCH_DMA_MINALIGN);
 211
 212 struct dwmci_idmac_64addr {
 213         u32 des0;       /* Control Descriptor */
 214         u32 des1;       /* Reserved */
 215         u32 des2;       /* Buffer sizes */
 216         u32 des3;       /* Reserved */
 217         u32 des4;       /* Lower 32-bits of Buffer Address Pointer 1*/
 218         u32 des5;       /* Upper 32-bits of Buffer Address Pointer 1*/
 219         u32 des6;       /* Lower 32-bits of Next Descriptor Address */
 220         u32 des7;       /* Upper 32-bits of Next Descriptor Address */
 221 };
 222
 223 static inline void dwmci_writel(struct dwmci_host *host, int reg, u32 val)
 224 {
 225         writel(val, host->ioaddr + reg);
 226 }
 227
 228 static inline void dwmci_writew(struct dwmci_host *host, int reg, u16 val)
 229 {
 230         writew(val, host->ioaddr + reg);
 231 }
 232
 233 static inline void dwmci_writeb(struct dwmci_host *host, int reg, u8 val)
 234 {
 235         writeb(val, host->ioaddr + reg);
 236 }
 237 static inline u32 dwmci_readl(struct dwmci_host *host, int reg)
 238 {
 239         return readl(host->ioaddr + reg);
 240 }
 241
 242 static inline u16 dwmci_readw(struct dwmci_host *host, int reg)
 243 {
 244         return readw(host->ioaddr + reg);
 245 }
 246
 247 static inline u8 dwmci_readb(struct dwmci_host *host, int reg)
 248 {
 249         return readb(host->ioaddr + reg);
 250 }
 251
 252 #ifdef CONFIG_BLK
 253 /**
 254  * dwmci_setup_cfg() - Set up the configuration for DWMMC
 255  *
 256  * This is used to set up a DWMMC device when you are using CONFIG_BLK.
 257  *
 258  * This should be called from your MMC driver's probe() method once you have
 259  * the information required.
 260  *
 261  * Generally your driver will have a platform data structure which holds both
 262  * the configuration (struct mmc_config) and the MMC device info (struct mmc).
 263  * For example:
 264  *
 265  * struct rockchip_mmc_plat {
 266  *      struct mmc_config cfg;
 267  *      struct mmc mmc;
 268  * };
 269  *
 270  * ...
 271  *
 272  * Inside U_BOOT_DRIVER():
 273  *      .platdata_auto_alloc_size = sizeof(struct rockchip_mmc_plat),
 274  *
 275  * To access platform data:
 276  *      struct rockchip_mmc_plat *plat = dev_get_platdata(dev);
 277  *
 278  * See rockchip_dw_mmc.c for an example.
 279  *
 280  * @cfg:        Configuration structure to fill in (generally &plat->mmc)
 281  * @host:       DWMMC host
 282  * @max_clk:    Maximum supported clock speed in HZ (e.g. 150000000)
 283  * @min_clk:    Minimum supported clock speed in HZ (e.g. 400000)
 284  */
 285 void dwmci_setup_cfg(struct mmc_config *cfg, struct dwmci_host *host,
 286                 u32 max_clk, u32 min_clk);
 287
 288 /**
 289  * dwmci_bind() - Set up a new MMC block device
 290  *
 291  * This is used to set up a DWMMC block device when you are using CONFIG_BLK.
 292  * It should be called from your driver's bind() method.
 293  *
 294  * See rockchip_dw_mmc.c for an example.
 295  *
 296  * @dev:        Device to set up
 297  * @mmc:        Pointer to mmc structure (normally &plat->mmc)
 298  * @cfg:        Empty configuration structure (generally &plat->cfg). This is
 299  *              normally all zeroes at this point. The only purpose of passing
 300  *              this in is to set mmc->cfg to it.
 301  * @return 0 if OK, -ve if the block device could not be created
 302  */
 303 int dwmci_bind(struct udevice *dev, struct mmc *mmc, struct mmc_config *cfg);
 304
 305 #else
 306 /**
 307  * add_dwmci() - Add a new DWMMC interface
 308  *
 309  * This is used when you are not using CONFIG_BLK. Convert your driver over!
 310  *
 311  * @host:       DWMMC host structure
 312  * @max_clk:    Maximum supported clock speed in HZ (e.g. 150000000)
 313  * @min_clk:    Minimum supported clock speed in HZ (e.g. 400000)
 314  * @return 0 if OK, -ve on error
 315  */
 316 int add_dwmci(struct dwmci_host *host, u32 max_clk, u32 min_clk);
 317 #endif /* !CONFIG_BLK */
 318
 319 #ifdef CONFIG_DM_MMC
 320 /* Export the operations to drivers */
 321 int dwmci_probe(struct udevice *dev);
 322 extern const struct dm_mmc_ops dm_dwmci_ops;
 323 #endif
 324
 325 #endif  /* __DWMMC_HW_H */