uboot/drivers/spi/ti_qspi.c
<<
>>
Prefs
   1// SPDX-License-Identifier: GPL-2.0+
   2/*
   3 * TI QSPI driver
   4 *
   5 * Copyright (C) 2013, Texas Instruments, Incorporated
   6 */
   7
   8#include <common.h>
   9#include <cpu_func.h>
  10#include <log.h>
  11#include <asm/cache.h>
  12#include <asm/global_data.h>
  13#include <asm/io.h>
  14#include <asm/arch/omap.h>
  15#include <malloc.h>
  16#include <spi.h>
  17#include <spi-mem.h>
  18#include <dm.h>
  19#include <asm/gpio.h>
  20#include <asm/omap_gpio.h>
  21#include <asm/omap_common.h>
  22#include <asm/ti-common/ti-edma3.h>
  23#include <linux/bitops.h>
  24#include <linux/err.h>
  25#include <linux/kernel.h>
  26#include <regmap.h>
  27#include <syscon.h>
  28
  29DECLARE_GLOBAL_DATA_PTR;
  30
  31/* ti qpsi register bit masks */
  32#define QSPI_TIMEOUT                    2000000
  33/* AM4372: QSPI gets SPI_GCLK from PRCM unit as PER_CLKOUTM2 divided by 4. */
  34#define QSPI_FCLK                       (192000000 / 4)
  35#define QSPI_DRA7XX_FCLK                76800000
  36#define QSPI_WLEN_MAX_BITS              128
  37#define QSPI_WLEN_MAX_BYTES             (QSPI_WLEN_MAX_BITS >> 3)
  38#define QSPI_WLEN_MASK                  QSPI_WLEN(QSPI_WLEN_MAX_BITS)
  39/* clock control */
  40#define QSPI_CLK_EN                     BIT(31)
  41#define QSPI_CLK_DIV_MAX                0xffff
  42/* command */
  43#define QSPI_EN_CS(n)                   (n << 28)
  44#define QSPI_WLEN(n)                    ((n-1) << 19)
  45#define QSPI_3_PIN                      BIT(18)
  46#define QSPI_RD_SNGL                    BIT(16)
  47#define QSPI_WR_SNGL                    (2 << 16)
  48#define QSPI_INVAL                      (4 << 16)
  49#define QSPI_RD_QUAD                    (7 << 16)
  50/* device control */
  51#define QSPI_CKPHA(n)                   (1 << (2 + n*8))
  52#define QSPI_CSPOL(n)                   (1 << (1 + n*8))
  53#define QSPI_CKPOL(n)                   (1 << (n*8))
  54/* status */
  55#define QSPI_WC                         BIT(1)
  56#define QSPI_BUSY                       BIT(0)
  57#define QSPI_WC_BUSY                    (QSPI_WC | QSPI_BUSY)
  58#define QSPI_XFER_DONE                  QSPI_WC
  59#define MM_SWITCH                       0x01
  60#define MEM_CS(cs)                      ((cs + 1) << 8)
  61#define MEM_CS_UNSELECT                 0xfffff8ff
  62
  63#define QSPI_SETUP0_READ_NORMAL         (0x0 << 12)
  64#define QSPI_SETUP0_READ_DUAL           (0x1 << 12)
  65#define QSPI_SETUP0_READ_QUAD           (0x3 << 12)
  66#define QSPI_SETUP0_ADDR_SHIFT          (8)
  67#define QSPI_SETUP0_DBITS_SHIFT         (10)
  68
  69#define TI_QSPI_SETUP_REG(priv, cs)     (&(priv)->base->setup0 + (cs))
  70
  71/* ti qspi register set */
  72struct ti_qspi_regs {
  73        u32 pid;
  74        u32 pad0[3];
  75        u32 sysconfig;
  76        u32 pad1[3];
  77        u32 int_stat_raw;
  78        u32 int_stat_en;
  79        u32 int_en_set;
  80        u32 int_en_ctlr;
  81        u32 intc_eoi;
  82        u32 pad2[3];
  83        u32 clk_ctrl;
  84        u32 dc;
  85        u32 cmd;
  86        u32 status;
  87        u32 data;
  88        u32 setup0;
  89        u32 setup1;
  90        u32 setup2;
  91        u32 setup3;
  92        u32 memswitch;
  93        u32 data1;
  94        u32 data2;
  95        u32 data3;
  96};
  97
  98/* ti qspi priv */
  99struct ti_qspi_priv {
 100        void *memory_map;
 101        size_t mmap_size;
 102        uint max_hz;
 103        u32 num_cs;
 104        struct ti_qspi_regs *base;
 105        void *ctrl_mod_mmap;
 106        ulong fclk;
 107        unsigned int mode;
 108        u32 cmd;
 109        u32 dc;
 110};
 111
 112static int ti_qspi_set_speed(struct udevice *bus, uint hz)
 113{
 114        struct ti_qspi_priv *priv = dev_get_priv(bus);
 115        uint clk_div;
 116
 117        if (!hz)
 118                clk_div = 0;
 119        else
 120                clk_div = DIV_ROUND_UP(priv->fclk, hz) - 1;
 121
 122        /* truncate clk_div value to QSPI_CLK_DIV_MAX */
 123        if (clk_div > QSPI_CLK_DIV_MAX)
 124                clk_div = QSPI_CLK_DIV_MAX;
 125
 126        debug("ti_spi_set_speed: hz: %d, clock divider %d\n", hz, clk_div);
 127
 128        /* disable SCLK */
 129        writel(readl(&priv->base->clk_ctrl) & ~QSPI_CLK_EN,
 130               &priv->base->clk_ctrl);
 131        /* enable SCLK and program the clk divider */
 132        writel(QSPI_CLK_EN | clk_div, &priv->base->clk_ctrl);
 133
 134        return 0;
 135}
 136
 137static void ti_qspi_cs_deactivate(struct ti_qspi_priv *priv)
 138{
 139        writel(priv->cmd | QSPI_INVAL, &priv->base->cmd);
 140        /* dummy readl to ensure bus sync */
 141        readl(&priv->base->cmd);
 142}
 143
 144static void ti_qspi_ctrl_mode_mmap(void *ctrl_mod_mmap, int cs, bool enable)
 145{
 146        u32 val;
 147
 148        val = readl(ctrl_mod_mmap);
 149        if (enable)
 150                val |= MEM_CS(cs);
 151        else
 152                val &= MEM_CS_UNSELECT;
 153        writel(val, ctrl_mod_mmap);
 154}
 155
 156static int ti_qspi_xfer(struct udevice *dev, unsigned int bitlen,
 157                        const void *dout, void *din, unsigned long flags)
 158{
 159        struct dm_spi_slave_plat *slave = dev_get_parent_plat(dev);
 160        struct ti_qspi_priv *priv;
 161        struct udevice *bus;
 162        uint words = bitlen >> 3; /* fixed 8-bit word length */
 163        const uchar *txp = dout;
 164        uchar *rxp = din;
 165        uint status;
 166        int timeout;
 167        unsigned int cs = slave->cs;
 168
 169        bus = dev->parent;
 170        priv = dev_get_priv(bus);
 171
 172        if (cs > priv->num_cs) {
 173                debug("invalid qspi chip select\n");
 174                return -EINVAL;
 175        }
 176
 177        if (bitlen == 0)
 178                return -1;
 179
 180        if (bitlen % 8) {
 181                debug("spi_xfer: Non byte aligned SPI transfer\n");
 182                return -1;
 183        }
 184
 185        /* Setup command reg */
 186        priv->cmd = 0;
 187        priv->cmd |= QSPI_WLEN(8);
 188        priv->cmd |= QSPI_EN_CS(cs);
 189        if (priv->mode & SPI_3WIRE)
 190                priv->cmd |= QSPI_3_PIN;
 191        priv->cmd |= 0xfff;
 192
 193        while (words) {
 194                u8 xfer_len = 0;
 195
 196                if (txp) {
 197                        u32 cmd = priv->cmd;
 198
 199                        if (words >= QSPI_WLEN_MAX_BYTES) {
 200                                u32 *txbuf = (u32 *)txp;
 201                                u32 data;
 202
 203                                data = cpu_to_be32(*txbuf++);
 204                                writel(data, &priv->base->data3);
 205                                data = cpu_to_be32(*txbuf++);
 206                                writel(data, &priv->base->data2);
 207                                data = cpu_to_be32(*txbuf++);
 208                                writel(data, &priv->base->data1);
 209                                data = cpu_to_be32(*txbuf++);
 210                                writel(data, &priv->base->data);
 211                                cmd &= ~QSPI_WLEN_MASK;
 212                                cmd |= QSPI_WLEN(QSPI_WLEN_MAX_BITS);
 213                                xfer_len = QSPI_WLEN_MAX_BYTES;
 214                        } else {
 215                                writeb(*txp, &priv->base->data);
 216                                xfer_len = 1;
 217                        }
 218                        debug("tx cmd %08x dc %08x\n",
 219                              cmd | QSPI_WR_SNGL, priv->dc);
 220                        writel(cmd | QSPI_WR_SNGL, &priv->base->cmd);
 221                        status = readl(&priv->base->status);
 222                        timeout = QSPI_TIMEOUT;
 223                        while ((status & QSPI_WC_BUSY) != QSPI_XFER_DONE) {
 224                                if (--timeout < 0) {
 225                                        printf("spi_xfer: TX timeout!\n");
 226                                        return -1;
 227                                }
 228                                status = readl(&priv->base->status);
 229                        }
 230                        txp += xfer_len;
 231                        debug("tx done, status %08x\n", status);
 232                }
 233                if (rxp) {
 234                        debug("rx cmd %08x dc %08x\n",
 235                              ((u32)(priv->cmd | QSPI_RD_SNGL)), priv->dc);
 236                        writel(priv->cmd | QSPI_RD_SNGL, &priv->base->cmd);
 237                        status = readl(&priv->base->status);
 238                        timeout = QSPI_TIMEOUT;
 239                        while ((status & QSPI_WC_BUSY) != QSPI_XFER_DONE) {
 240                                if (--timeout < 0) {
 241                                        printf("spi_xfer: RX timeout!\n");
 242                                        return -1;
 243                                }
 244                                status = readl(&priv->base->status);
 245                        }
 246                        *rxp++ = readl(&priv->base->data);
 247                        xfer_len = 1;
 248                        debug("rx done, status %08x, read %02x\n",
 249                              status, *(rxp-1));
 250                }
 251                words -= xfer_len;
 252        }
 253
 254        /* Terminate frame */
 255        if (flags & SPI_XFER_END)
 256                ti_qspi_cs_deactivate(priv);
 257
 258        return 0;
 259}
 260
 261/* TODO: control from sf layer to here through dm-spi */
 262static void ti_qspi_copy_mmap(void *data, void *offset, size_t len)
 263{
 264#if defined(CONFIG_TI_EDMA3) && !defined(CONFIG_DMA)
 265        unsigned int                    addr = (unsigned int) (data);
 266        unsigned int                    edma_slot_num = 1;
 267
 268        /* Invalidate the area, so no writeback into the RAM races with DMA */
 269        invalidate_dcache_range(addr, addr + roundup(len, ARCH_DMA_MINALIGN));
 270
 271        /* enable edma3 clocks */
 272        enable_edma3_clocks();
 273
 274        /* Call edma3 api to do actual DMA transfer     */
 275        edma3_transfer(EDMA3_BASE, edma_slot_num, data, offset, len);
 276
 277        /* disable edma3 clocks */
 278        disable_edma3_clocks();
 279#else
 280        memcpy_fromio(data, offset, len);
 281#endif
 282
 283        *((unsigned int *)offset) += len;
 284}
 285
 286static void ti_qspi_setup_mmap_read(struct ti_qspi_priv *priv, int cs,
 287                                    u8 opcode, u8 data_nbits, u8 addr_width,
 288                                    u8 dummy_bytes)
 289{
 290        u32 memval = opcode;
 291
 292        switch (data_nbits) {
 293        case 4:
 294                memval |= QSPI_SETUP0_READ_QUAD;
 295                break;
 296        case 2:
 297                memval |= QSPI_SETUP0_READ_DUAL;
 298                break;
 299        default:
 300                memval |= QSPI_SETUP0_READ_NORMAL;
 301                break;
 302        }
 303
 304        memval |= ((addr_width - 1) << QSPI_SETUP0_ADDR_SHIFT |
 305                   dummy_bytes << QSPI_SETUP0_DBITS_SHIFT);
 306
 307        writel(memval, TI_QSPI_SETUP_REG(priv, cs));
 308}
 309
 310static int ti_qspi_set_mode(struct udevice *bus, uint mode)
 311{
 312        struct ti_qspi_priv *priv = dev_get_priv(bus);
 313
 314        priv->dc = 0;
 315        if (mode & SPI_CPHA)
 316                priv->dc |= QSPI_CKPHA(0);
 317        if (mode & SPI_CPOL)
 318                priv->dc |= QSPI_CKPOL(0);
 319        if (mode & SPI_CS_HIGH)
 320                priv->dc |= QSPI_CSPOL(0);
 321
 322        return 0;
 323}
 324
 325static int ti_qspi_exec_mem_op(struct spi_slave *slave,
 326                               const struct spi_mem_op *op)
 327{
 328        struct dm_spi_slave_plat *slave_plat;
 329        struct ti_qspi_priv *priv;
 330        struct udevice *bus;
 331        u32 from = 0;
 332        int ret = 0;
 333
 334        bus = slave->dev->parent;
 335        priv = dev_get_priv(bus);
 336        slave_plat = dev_get_parent_plat(slave->dev);
 337
 338        /* Only optimize read path. */
 339        if (!op->data.nbytes || op->data.dir != SPI_MEM_DATA_IN ||
 340            !op->addr.nbytes || op->addr.nbytes > 4)
 341                return -ENOTSUPP;
 342
 343        /* Address exceeds MMIO window size, fall back to regular mode. */
 344        from = op->addr.val;
 345        if (from + op->data.nbytes > priv->mmap_size)
 346                return -ENOTSUPP;
 347
 348        ti_qspi_setup_mmap_read(priv, slave_plat->cs, op->cmd.opcode,
 349                                op->data.buswidth, op->addr.nbytes,
 350                                op->dummy.nbytes);
 351
 352        ti_qspi_copy_mmap((void *)op->data.buf.in,
 353                          (void *)priv->memory_map + from, op->data.nbytes);
 354
 355        return ret;
 356}
 357
 358static int ti_qspi_claim_bus(struct udevice *dev)
 359{
 360        struct dm_spi_slave_plat *slave_plat = dev_get_parent_plat(dev);
 361        struct ti_qspi_priv *priv;
 362        struct udevice *bus;
 363
 364        bus = dev->parent;
 365        priv = dev_get_priv(bus);
 366
 367        if (slave_plat->cs > priv->num_cs) {
 368                debug("invalid qspi chip select\n");
 369                return -EINVAL;
 370        }
 371
 372        writel(MM_SWITCH, &priv->base->memswitch);
 373        if (priv->ctrl_mod_mmap)
 374                ti_qspi_ctrl_mode_mmap(priv->ctrl_mod_mmap,
 375                                       slave_plat->cs, true);
 376
 377        writel(priv->dc, &priv->base->dc);
 378        writel(0, &priv->base->cmd);
 379        writel(0, &priv->base->data);
 380
 381        priv->dc <<= slave_plat->cs * 8;
 382        writel(priv->dc, &priv->base->dc);
 383
 384        return 0;
 385}
 386
 387static int ti_qspi_release_bus(struct udevice *dev)
 388{
 389        struct dm_spi_slave_plat *slave_plat = dev_get_parent_plat(dev);
 390        struct ti_qspi_priv *priv;
 391        struct udevice *bus;
 392
 393        bus = dev->parent;
 394        priv = dev_get_priv(bus);
 395
 396        writel(~MM_SWITCH, &priv->base->memswitch);
 397        if (priv->ctrl_mod_mmap)
 398                ti_qspi_ctrl_mode_mmap(priv->ctrl_mod_mmap,
 399                                       slave_plat->cs, false);
 400
 401        writel(0, &priv->base->dc);
 402        writel(0, &priv->base->cmd);
 403        writel(0, &priv->base->data);
 404        writel(0, TI_QSPI_SETUP_REG(priv, slave_plat->cs));
 405
 406        return 0;
 407}
 408
 409static int ti_qspi_probe(struct udevice *bus)
 410{
 411        struct ti_qspi_priv *priv = dev_get_priv(bus);
 412
 413        priv->fclk = dev_get_driver_data(bus);
 414
 415        return 0;
 416}
 417
 418static void *map_syscon_chipselects(struct udevice *bus)
 419{
 420#if CONFIG_IS_ENABLED(SYSCON)
 421        struct udevice *syscon;
 422        struct regmap *regmap;
 423        const fdt32_t *cell;
 424        int len, err;
 425
 426        err = uclass_get_device_by_phandle(UCLASS_SYSCON, bus,
 427                                           "syscon-chipselects", &syscon);
 428        if (err) {
 429                debug("%s: unable to find syscon device (%d)\n", __func__,
 430                      err);
 431                return NULL;
 432        }
 433
 434        regmap = syscon_get_regmap(syscon);
 435        if (IS_ERR(regmap)) {
 436                debug("%s: unable to find regmap (%ld)\n", __func__,
 437                      PTR_ERR(regmap));
 438                return NULL;
 439        }
 440
 441        cell = fdt_getprop(gd->fdt_blob, dev_of_offset(bus),
 442                           "syscon-chipselects", &len);
 443        if (len < 2*sizeof(fdt32_t)) {
 444                debug("%s: offset not available\n", __func__);
 445                return NULL;
 446        }
 447
 448        return fdtdec_get_number(cell + 1, 1) + regmap_get_range(regmap, 0);
 449#else
 450        fdt_addr_t addr;
 451        addr = devfdt_get_addr_index(bus, 2);
 452        return (addr == FDT_ADDR_T_NONE) ? NULL :
 453                map_physmem(addr, 0, MAP_NOCACHE);
 454#endif
 455}
 456
 457static int ti_qspi_of_to_plat(struct udevice *bus)
 458{
 459        struct ti_qspi_priv *priv = dev_get_priv(bus);
 460        const void *blob = gd->fdt_blob;
 461        int node = dev_of_offset(bus);
 462        fdt_addr_t mmap_addr;
 463        fdt_addr_t mmap_size;
 464
 465        priv->ctrl_mod_mmap = map_syscon_chipselects(bus);
 466        priv->base = map_physmem(dev_read_addr(bus),
 467                                 sizeof(struct ti_qspi_regs), MAP_NOCACHE);
 468        mmap_addr = devfdt_get_addr_size_index(bus, 1, &mmap_size);
 469        priv->memory_map = map_physmem(mmap_addr, mmap_size, MAP_NOCACHE);
 470        priv->mmap_size = mmap_size;
 471
 472        priv->max_hz = dev_read_u32_default(bus, "spi-max-frequency", 0);
 473        if (!priv->max_hz) {
 474                debug("Error: Max frequency missing\n");
 475                return -ENODEV;
 476        }
 477        priv->num_cs = fdtdec_get_int(blob, node, "num-cs", 4);
 478
 479        debug("%s: regs=<0x%x>, max-frequency=%d\n", __func__,
 480              (int)priv->base, priv->max_hz);
 481
 482        return 0;
 483}
 484
 485static const struct spi_controller_mem_ops ti_qspi_mem_ops = {
 486        .exec_op = ti_qspi_exec_mem_op,
 487};
 488
 489static const struct dm_spi_ops ti_qspi_ops = {
 490        .claim_bus      = ti_qspi_claim_bus,
 491        .release_bus    = ti_qspi_release_bus,
 492        .xfer           = ti_qspi_xfer,
 493        .set_speed      = ti_qspi_set_speed,
 494        .set_mode       = ti_qspi_set_mode,
 495        .mem_ops        = &ti_qspi_mem_ops,
 496};
 497
 498static const struct udevice_id ti_qspi_ids[] = {
 499        { .compatible = "ti,dra7xxx-qspi",      .data = QSPI_DRA7XX_FCLK},
 500        { .compatible = "ti,am4372-qspi",       .data = QSPI_FCLK},
 501        { }
 502};
 503
 504U_BOOT_DRIVER(ti_qspi) = {
 505        .name   = "ti_qspi",
 506        .id     = UCLASS_SPI,
 507        .of_match = ti_qspi_ids,
 508        .ops    = &ti_qspi_ops,
 509        .of_to_plat = ti_qspi_of_to_plat,
 510        .priv_auto      = sizeof(struct ti_qspi_priv),
 511        .probe  = ti_qspi_probe,
 512};
 513