drivers/mtd/renesas_rpc_hf.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Renesas RCar Gen3 RPC Hyperflash driver
   4  *
   5  * Copyright (C) 2016 Renesas Electronics Corporation
   6  * Copyright (C) 2016 Cogent Embedded, Inc.
   7  * Copyright (C) 2017 Marek Vasut <marek.vasut@gmail.com>
   8  */
   9
  10 #include <common.h>
  11 #include <malloc.h>
  12 #include <asm/io.h>
  13 #include <clk.h>
  14 #include <dm.h>
  15 #include <dm/device_compat.h>
  16 #include <dm/of_access.h>
  17 #include <errno.h>
  18 #include <fdt_support.h>
  19 #include <flash.h>
  20 #include <mtd.h>
  21 #include <wait_bit.h>
  22 #include <linux/bitops.h>
  23 #include <mtd/cfi_flash.h>
  24
  25 #define RPC_CMNCR               0x0000  /* R/W */
  26 #define RPC_CMNCR_MD            BIT(31)
  27 #define RPC_CMNCR_MOIIO0(val)   (((val) & 0x3) << 16)
  28 #define RPC_CMNCR_MOIIO1(val)   (((val) & 0x3) << 18)
  29 #define RPC_CMNCR_MOIIO2(val)   (((val) & 0x3) << 20)
  30 #define RPC_CMNCR_MOIIO3(val)   (((val) & 0x3) << 22)
  31 #define RPC_CMNCR_MOIIO_HIZ     (RPC_CMNCR_MOIIO0(3) | RPC_CMNCR_MOIIO1(3) | \
  32                                  RPC_CMNCR_MOIIO2(3) | RPC_CMNCR_MOIIO3(3))
  33 #define RPC_CMNCR_IO0FV(val)    (((val) & 0x3) << 8)
  34 #define RPC_CMNCR_IO2FV(val)    (((val) & 0x3) << 12)
  35 #define RPC_CMNCR_IO3FV(val)    (((val) & 0x3) << 14)
  36 #define RPC_CMNCR_IOFV_HIZ      (RPC_CMNCR_IO0FV(3) | RPC_CMNCR_IO2FV(3) | \
  37                                  RPC_CMNCR_IO3FV(3))
  38 #define RPC_CMNCR_BSZ(val)      (((val) & 0x3) << 0)
  39
  40 #define RPC_SSLDR               0x0004  /* R/W */
  41 #define RPC_SSLDR_SPNDL(d)      (((d) & 0x7) << 16)
  42 #define RPC_SSLDR_SLNDL(d)      (((d) & 0x7) << 8)
  43 #define RPC_SSLDR_SCKDL(d)      (((d) & 0x7) << 0)
  44
  45 #define RPC_DRCR                0x000C  /* R/W */
  46 #define RPC_DRCR_SSLN           BIT(24)
  47 #define RPC_DRCR_RBURST(v)      (((v) & 0x1F) << 16)
  48 #define RPC_DRCR_RCF            BIT(9)
  49 #define RPC_DRCR_RBE            BIT(8)
  50 #define RPC_DRCR_SSLE           BIT(0)
  51
  52 #define RPC_DRCMR               0x0010  /* R/W */
  53 #define RPC_DRCMR_CMD(c)        (((c) & 0xFF) << 16)
  54 #define RPC_DRCMR_OCMD(c)       (((c) & 0xFF) << 0)
  55
  56 #define RPC_DREAR               0x0014  /* R/W */
  57 #define RPC_DREAR_EAV(v)        (((v) & 0xFF) << 16)
  58 #define RPC_DREAR_EAC(v)        (((v) & 0x7) << 0)
  59
  60 #define RPC_DROPR               0x0018  /* R/W */
  61 #define RPC_DROPR_OPD3(o)       (((o) & 0xFF) << 24)
  62 #define RPC_DROPR_OPD2(o)       (((o) & 0xFF) << 16)
  63 #define RPC_DROPR_OPD1(o)       (((o) & 0xFF) << 8)
  64 #define RPC_DROPR_OPD0(o)       (((o) & 0xFF) << 0)
  65
  66 #define RPC_DRENR               0x001C  /* R/W */
  67 #define RPC_DRENR_CDB(o)        (u32)((((o) & 0x3) << 30))
  68 #define RPC_DRENR_OCDB(o)       (((o) & 0x3) << 28)
  69 #define RPC_DRENR_ADB(o)        (((o) & 0x3) << 24)
  70 #define RPC_DRENR_OPDB(o)       (((o) & 0x3) << 20)
  71 #define RPC_DRENR_SPIDB(o)      (((o) & 0x3) << 16)
  72 #define RPC_DRENR_DME           BIT(15)
  73 #define RPC_DRENR_CDE           BIT(14)
  74 #define RPC_DRENR_OCDE          BIT(12)
  75 #define RPC_DRENR_ADE(v)        (((v) & 0xF) << 8)
  76 #define RPC_DRENR_OPDE(v)       (((v) & 0xF) << 4)
  77
  78 #define RPC_SMCR                0x0020  /* R/W */
  79 #define RPC_SMCR_SSLKP          BIT(8)
  80 #define RPC_SMCR_SPIRE          BIT(2)
  81 #define RPC_SMCR_SPIWE          BIT(1)
  82 #define RPC_SMCR_SPIE           BIT(0)
  83
  84 #define RPC_SMCMR               0x0024  /* R/W */
  85 #define RPC_SMCMR_CMD(c)        (((c) & 0xFF) << 16)
  86 #define RPC_SMCMR_OCMD(c)       (((c) & 0xFF) << 0)
  87
  88 #define RPC_SMADR               0x0028  /* R/W */
  89 #define RPC_SMOPR               0x002C  /* R/W */
  90 #define RPC_SMOPR_OPD0(o)       (((o) & 0xFF) << 0)
  91 #define RPC_SMOPR_OPD1(o)       (((o) & 0xFF) << 8)
  92 #define RPC_SMOPR_OPD2(o)       (((o) & 0xFF) << 16)
  93 #define RPC_SMOPR_OPD3(o)       (((o) & 0xFF) << 24)
  94
  95 #define RPC_SMENR               0x0030  /* R/W */
  96 #define RPC_SMENR_CDB(o)        (((o) & 0x3) << 30)
  97 #define RPC_SMENR_OCDB(o)       (((o) & 0x3) << 28)
  98 #define RPC_SMENR_ADB(o)        (((o) & 0x3) << 24)
  99 #define RPC_SMENR_OPDB(o)       (((o) & 0x3) << 20)
 100 #define RPC_SMENR_SPIDB(o)      (((o) & 0x3) << 16)
 101 #define RPC_SMENR_DME           BIT(15)
 102 #define RPC_SMENR_CDE           BIT(14)
 103 #define RPC_SMENR_OCDE          BIT(12)
 104 #define RPC_SMENR_ADE(v)        (((v) & 0xF) << 8)
 105 #define RPC_SMENR_OPDE(v)       (((v) & 0xF) << 4)
 106 #define RPC_SMENR_SPIDE(v)      (((v) & 0xF) << 0)
 107
 108 #define RPC_SMRDR0              0x0038  /* R */
 109 #define RPC_SMRDR1              0x003C  /* R */
 110 #define RPC_SMWDR0              0x0040  /* R/W */
 111 #define RPC_SMWDR1              0x0044  /* R/W */
 112 #define RPC_CMNSR               0x0048  /* R */
 113 #define RPC_CMNSR_SSLF          BIT(1)
 114 #define RPC_CMNSR_TEND          BIT(0)
 115
 116 #define RPC_DRDMCR              0x0058  /* R/W */
 117 #define RPC_DRDMCR_DMCYC(v)     (((v) & 0xF) << 0)
 118
 119 #define RPC_DRDRENR             0x005C  /* R/W */
 120 #define RPC_DRDRENR_HYPE        (0x5 << 12)
 121 #define RPC_DRDRENR_ADDRE       BIT(8)
 122 #define RPC_DRDRENR_OPDRE       BIT(4)
 123 #define RPC_DRDRENR_DRDRE       BIT(0)
 124
 125 #define RPC_SMDMCR              0x0060  /* R/W */
 126 #define RPC_SMDMCR_DMCYC(v)     (((v) & 0xF) << 0)
 127
 128 #define RPC_SMDRENR             0x0064  /* R/W */
 129 #define RPC_SMDRENR_HYPE        (0x5 << 12)
 130 #define RPC_SMDRENR_ADDRE       BIT(8)
 131 #define RPC_SMDRENR_OPDRE       BIT(4)
 132 #define RPC_SMDRENR_SPIDRE      BIT(0)
 133
 134 #define RPC_PHYCNT              0x007C  /* R/W */
 135 #define RPC_PHYCNT_CAL          BIT(31)
 136 #define PRC_PHYCNT_OCTA_AA      BIT(22)
 137 #define PRC_PHYCNT_OCTA_SA      BIT(23)
 138 #define PRC_PHYCNT_EXDS         BIT(21)
 139 #define RPC_PHYCNT_OCT          BIT(20)
 140 #define RPC_PHYCNT_WBUF2        BIT(4)
 141 #define RPC_PHYCNT_WBUF         BIT(2)
 142 #define RPC_PHYCNT_MEM(v)       (((v) & 0x3) << 0)
 143
 144 #define RPC_PHYINT              0x0088  /* R/W */
 145 #define RPC_PHYINT_RSTEN        BIT(18)
 146 #define RPC_PHYINT_WPEN         BIT(17)
 147 #define RPC_PHYINT_INTEN        BIT(16)
 148 #define RPC_PHYINT_RST          BIT(2)
 149 #define RPC_PHYINT_WP           BIT(1)
 150 #define RPC_PHYINT_INT          BIT(0)
 151
 152 #define RPC_WBUF                0x8000  /* R/W size=4/8/16/32/64Bytes */
 153 #define RPC_WBUF_SIZE           0x100
 154
 155 static phys_addr_t rpc_base;
 156
 157 enum rpc_hf_size {
 158         RPC_HF_SIZE_16BIT = RPC_SMENR_SPIDE(0x8),
 159         RPC_HF_SIZE_32BIT = RPC_SMENR_SPIDE(0xC),
 160         RPC_HF_SIZE_64BIT = RPC_SMENR_SPIDE(0xF),
 161 };
 162
 163 static int rpc_hf_wait_tend(void)
 164 {
 165         void __iomem *reg = (void __iomem *)rpc_base + RPC_CMNSR;
 166         return wait_for_bit_le32(reg, RPC_CMNSR_TEND, true, 1000, 0);
 167 }
 168
 169 static int rpc_hf_mode(bool man)
 170 {
 171         int ret;
 172
 173         ret = rpc_hf_wait_tend();
 174         if (ret)
 175                 return ret;
 176
 177         clrsetbits_le32(rpc_base + RPC_PHYCNT,
 178                  RPC_PHYCNT_WBUF | RPC_PHYCNT_WBUF2 |
 179                  RPC_PHYCNT_CAL | RPC_PHYCNT_MEM(3),
 180                  RPC_PHYCNT_CAL | RPC_PHYCNT_MEM(3));
 181
 182         clrsetbits_le32(rpc_base + RPC_CMNCR,
 183                  RPC_CMNCR_MD | RPC_CMNCR_BSZ(3),
 184                  RPC_CMNCR_MOIIO_HIZ | RPC_CMNCR_IOFV_HIZ |
 185                  (man ? RPC_CMNCR_MD : 0) | RPC_CMNCR_BSZ(1));
 186
 187         if (man)
 188                 return 0;
 189
 190         writel(RPC_DRCR_RBURST(0x1F) | RPC_DRCR_RCF | RPC_DRCR_RBE,
 191                rpc_base + RPC_DRCR);
 192
 193         writel(RPC_DRCMR_CMD(0xA0), rpc_base + RPC_DRCMR);
 194         writel(RPC_DRENR_CDB(2) | RPC_DRENR_OCDB(2) | RPC_DRENR_ADB(2) |
 195                RPC_DRENR_SPIDB(2) | RPC_DRENR_CDE | RPC_DRENR_OCDE |
 196                RPC_DRENR_ADE(4), rpc_base + RPC_DRENR);
 197         writel(RPC_DRDMCR_DMCYC(0xE), rpc_base + RPC_DRDMCR);
 198         writel(RPC_DRDRENR_HYPE | RPC_DRDRENR_ADDRE | RPC_DRDRENR_DRDRE,
 199                rpc_base + RPC_DRDRENR);
 200
 201         /* Dummy read */
 202         readl(rpc_base + RPC_DRCR);
 203
 204         return 0;
 205 }
 206
 207 static int rpc_hf_xfer(void *addr, u64 wdata, u64 *rdata,
 208                        enum rpc_hf_size size, bool write)
 209 {
 210         int ret;
 211         u32 val;
 212
 213         ret = rpc_hf_mode(1);
 214         if (ret)
 215                 return ret;
 216
 217         /* Submit HF address, SMCMR CMD[7] ~= CA Bit# 47 (R/nW) */
 218         writel(write ? 0 : RPC_SMCMR_CMD(0x80), rpc_base + RPC_SMCMR);
 219         writel((uintptr_t)addr >> 1, rpc_base + RPC_SMADR);
 220         writel(0x0, rpc_base + RPC_SMOPR);
 221
 222         writel(RPC_SMDRENR_HYPE | RPC_SMDRENR_ADDRE | RPC_SMDRENR_SPIDRE,
 223                rpc_base + RPC_SMDRENR);
 224
 225         val = RPC_SMENR_CDB(2) | RPC_SMENR_OCDB(2) |
 226               RPC_SMENR_ADB(2) | RPC_SMENR_SPIDB(2) |
 227               RPC_SMENR_CDE | RPC_SMENR_OCDE | RPC_SMENR_ADE(4) | size;
 228
 229         if (write) {
 230                 writel(val, rpc_base + RPC_SMENR);
 231
 232                 if (size == RPC_HF_SIZE_64BIT)
 233                         writeq(cpu_to_be64(wdata), rpc_base + RPC_SMWDR0);
 234                 else
 235                         writel(cpu_to_be32(wdata), rpc_base + RPC_SMWDR0);
 236
 237                 writel(RPC_SMCR_SPIWE | RPC_SMCR_SPIE, rpc_base + RPC_SMCR);
 238         } else {
 239                 val |= RPC_SMENR_DME;
 240
 241                 writel(RPC_SMDMCR_DMCYC(0xE), rpc_base + RPC_SMDMCR);
 242
 243                 writel(val, rpc_base + RPC_SMENR);
 244
 245                 writel(RPC_SMCR_SPIRE | RPC_SMCR_SPIE, rpc_base + RPC_SMCR);
 246
 247                 ret = rpc_hf_wait_tend();
 248                 if (ret)
 249                         return ret;
 250
 251                 if (size == RPC_HF_SIZE_64BIT)
 252                         *rdata = be64_to_cpu(readq(rpc_base + RPC_SMRDR0));
 253                 else
 254                         *rdata = be32_to_cpu(readl(rpc_base + RPC_SMRDR0));
 255         }
 256
 257         return rpc_hf_mode(0);
 258 }
 259
 260 static void rpc_hf_write_cmd(void *addr, u64 wdata, enum rpc_hf_size size)
 261 {
 262         int ret;
 263
 264         ret = rpc_hf_xfer(addr, wdata, NULL, size, 1);
 265         if (ret)
 266                 printf("RPC: Write failed, ret=%i\n", ret);
 267 }
 268
 269 static u64 rpc_hf_read_reg(void *addr, enum rpc_hf_size size)
 270 {
 271         u64 rdata = 0;
 272         int ret;
 273
 274         ret = rpc_hf_xfer(addr, 0, &rdata, size, 0);
 275         if (ret)
 276                 printf("RPC: Read failed, ret=%i\n", ret);
 277
 278         return rdata;
 279 }
 280
 281 void flash_write8(u8 value, void *addr)
 282 {
 283         rpc_hf_write_cmd(addr, value, RPC_HF_SIZE_16BIT);
 284 }
 285
 286 void flash_write16(u16 value, void *addr)
 287 {
 288         rpc_hf_write_cmd(addr, value, RPC_HF_SIZE_16BIT);
 289 }
 290
 291 void flash_write32(u32 value, void *addr)
 292 {
 293         rpc_hf_write_cmd(addr, value, RPC_HF_SIZE_32BIT);
 294 }
 295
 296 void flash_write64(u64 value, void *addr)
 297 {
 298         rpc_hf_write_cmd(addr, value, RPC_HF_SIZE_64BIT);
 299 }
 300
 301 u8 flash_read8(void *addr)
 302 {
 303         return rpc_hf_read_reg(addr, RPC_HF_SIZE_16BIT);
 304 }
 305
 306 u16 flash_read16(void *addr)
 307 {
 308         return rpc_hf_read_reg(addr, RPC_HF_SIZE_16BIT);
 309 }
 310
 311 u32 flash_read32(void *addr)
 312 {
 313         return rpc_hf_read_reg(addr, RPC_HF_SIZE_32BIT);
 314 }
 315
 316 u64 flash_read64(void *addr)
 317 {
 318         return rpc_hf_read_reg(addr, RPC_HF_SIZE_64BIT);
 319 }
 320
 321 static int rpc_hf_bind(struct udevice *parent)
 322 {
 323         const void *fdt = gd->fdt_blob;
 324         ofnode node;
 325         int ret, off;
 326
 327         /*
 328          * Check if there are any SPI NOR child nodes, if so, do NOT bind
 329          * as this controller will be operated by the QSPI driver instead.
 330          */
 331         dev_for_each_subnode(node, parent) {
 332                 off = ofnode_to_offset(node);
 333
 334                 ret = fdt_node_check_compatible(fdt, off, "spi-flash");
 335                 if (!ret)
 336                         return -ENODEV;
 337
 338                 ret = fdt_node_check_compatible(fdt, off, "jedec,spi-nor");
 339                 if (!ret)
 340                         return -ENODEV;
 341         }
 342
 343         return 0;
 344 }
 345
 346 static int rpc_hf_probe(struct udevice *dev)
 347 {
 348         void *blob = (void *)gd->fdt_blob;
 349         const fdt32_t *cell;
 350         int node = dev_of_offset(dev);
 351         int parent, addrc, sizec, len, ret;
 352         struct clk clk;
 353         phys_addr_t flash_base;
 354
 355         parent = fdt_parent_offset(blob, node);
 356         fdt_support_default_count_cells(blob, parent, &addrc, &sizec);
 357         cell = fdt_getprop(blob, node, "reg", &len);
 358         if (!cell)
 359                 return -ENOENT;
 360
 361         if (addrc != 2 || sizec != 2)
 362                 return -EINVAL;
 363
 364
 365         ret = clk_get_by_index(dev, 0, &clk);
 366         if (ret < 0) {
 367                 dev_err(dev, "Failed to get RPC clock\n");
 368                 return ret;
 369         }
 370
 371         ret = clk_enable(&clk);
 372         clk_free(&clk);
 373         if (ret) {
 374                 dev_err(dev, "Failed to enable RPC clock\n");
 375                 return ret;
 376         }
 377
 378         rpc_base = fdt_translate_address(blob, node, cell);
 379         flash_base = fdt_translate_address(blob, node, cell + addrc + sizec);
 380
 381         flash_info[0].dev = dev;
 382         flash_info[0].base = flash_base;
 383         cfi_flash_num_flash_banks = 1;
 384         gd->bd->bi_flashstart = flash_base;
 385
 386         return 0;
 387 }
 388
 389 static const struct udevice_id rpc_hf_ids[] = {
 390         { .compatible = "renesas,rpc" },
 391         {}
 392 };
 393
 394 U_BOOT_DRIVER(rpc_hf) = {
 395         .name           = "rpc_hf",
 396         .id             = UCLASS_MTD,
 397         .of_match       = rpc_hf_ids,
 398         .bind           = rpc_hf_bind,
 399         .probe          = rpc_hf_probe,
 400 };