drivers/spi/tegra114_spi.c

   1 /*
   2  * NVIDIA Tegra SPI controller (T114 and later)
   3  *
   4  * Copyright (c) 2010-2013 NVIDIA Corporation
   5  *
   6  * SPDX-License-Identifier:     GPL-2.0
   7  */
   8
   9 #include <common.h>
  10 #include <dm.h>
  11 #include <asm/io.h>
  12 #include <asm/arch/clock.h>
  13 #include <asm/arch-tegra/clk_rst.h>
  14 #include <spi.h>
  15 #include <fdtdec.h>
  16 #include "tegra_spi.h"
  17
  18 DECLARE_GLOBAL_DATA_PTR;
  19
  20 /* COMMAND1 */
  21 #define SPI_CMD1_GO                     BIT(31)
  22 #define SPI_CMD1_M_S                    BIT(30)
  23 #define SPI_CMD1_MODE_MASK              GENMASK(1, 0)
  24 #define SPI_CMD1_MODE_SHIFT             28
  25 #define SPI_CMD1_CS_SEL_MASK            GENMASK(1, 0)
  26 #define SPI_CMD1_CS_SEL_SHIFT           26
  27 #define SPI_CMD1_CS_POL_INACTIVE3       BIT(25)
  28 #define SPI_CMD1_CS_POL_INACTIVE2       BIT(24)
  29 #define SPI_CMD1_CS_POL_INACTIVE1       BIT(23)
  30 #define SPI_CMD1_CS_POL_INACTIVE0       BIT(22)
  31 #define SPI_CMD1_CS_SW_HW               BIT(21)
  32 #define SPI_CMD1_CS_SW_VAL              BIT(20)
  33 #define SPI_CMD1_IDLE_SDA_MASK          GENMASK(1, 0)
  34 #define SPI_CMD1_IDLE_SDA_SHIFT         18
  35 #define SPI_CMD1_BIDIR                  BIT(17)
  36 #define SPI_CMD1_LSBI_FE                BIT(16)
  37 #define SPI_CMD1_LSBY_FE                BIT(15)
  38 #define SPI_CMD1_BOTH_EN_BIT            BIT(14)
  39 #define SPI_CMD1_BOTH_EN_BYTE           BIT(13)
  40 #define SPI_CMD1_RX_EN                  BIT(12)
  41 #define SPI_CMD1_TX_EN                  BIT(11)
  42 #define SPI_CMD1_PACKED                 BIT(5)
  43 #define SPI_CMD1_BIT_LEN_MASK           GENMASK(4, 0)
  44 #define SPI_CMD1_BIT_LEN_SHIFT          0
  45
  46 /* COMMAND2 */
  47 #define SPI_CMD2_TX_CLK_TAP_DELAY       BIT(6)
  48 #define SPI_CMD2_TX_CLK_TAP_DELAY_MASK  GENMASK(11, 6)
  49 #define SPI_CMD2_RX_CLK_TAP_DELAY       BIT(0)
  50 #define SPI_CMD2_RX_CLK_TAP_DELAY_MASK  GENMASK(5, 0)
  51
  52 /* TRANSFER STATUS */
  53 #define SPI_XFER_STS_RDY                BIT(30)
  54
  55 /* FIFO STATUS */
  56 #define SPI_FIFO_STS_CS_INACTIVE        BIT(31)
  57 #define SPI_FIFO_STS_FRAME_END          BIT(30)
  58 #define SPI_FIFO_STS_RX_FIFO_FLUSH      BIT(15)
  59 #define SPI_FIFO_STS_TX_FIFO_FLUSH      BIT(14)
  60 #define SPI_FIFO_STS_ERR                BIT(8)
  61 #define SPI_FIFO_STS_TX_FIFO_OVF        BIT(7)
  62 #define SPI_FIFO_STS_TX_FIFO_UNR        BIT(6)
  63 #define SPI_FIFO_STS_RX_FIFO_OVF        BIT(5)
  64 #define SPI_FIFO_STS_RX_FIFO_UNR        BIT(4)
  65 #define SPI_FIFO_STS_TX_FIFO_FULL       BIT(3)
  66 #define SPI_FIFO_STS_TX_FIFO_EMPTY      BIT(2)
  67 #define SPI_FIFO_STS_RX_FIFO_FULL       BIT(1)
  68 #define SPI_FIFO_STS_RX_FIFO_EMPTY      BIT(0)
  69
  70 #define SPI_TIMEOUT             1000
  71 #define TEGRA_SPI_MAX_FREQ      52000000
  72
  73 struct spi_regs {
  74         u32 command1;   /* 000:SPI_COMMAND1 register */
  75         u32 command2;   /* 004:SPI_COMMAND2 register */
  76         u32 timing1;    /* 008:SPI_CS_TIM1 register */
  77         u32 timing2;    /* 00c:SPI_CS_TIM2 register */
  78         u32 xfer_status;/* 010:SPI_TRANS_STATUS register */
  79         u32 fifo_status;/* 014:SPI_FIFO_STATUS register */
  80         u32 tx_data;    /* 018:SPI_TX_DATA register */
  81         u32 rx_data;    /* 01c:SPI_RX_DATA register */
  82         u32 dma_ctl;    /* 020:SPI_DMA_CTL register */
  83         u32 dma_blk;    /* 024:SPI_DMA_BLK register */
  84         u32 rsvd[56];   /* 028-107 reserved */
  85         u32 tx_fifo;    /* 108:SPI_FIFO1 register */
  86         u32 rsvd2[31];  /* 10c-187 reserved */
  87         u32 rx_fifo;    /* 188:SPI_FIFO2 register */
  88         u32 spare_ctl;  /* 18c:SPI_SPARE_CTRL register */
  89 };
  90
  91 struct tegra114_spi_priv {
  92         struct spi_regs *regs;
  93         unsigned int freq;
  94         unsigned int mode;
  95         int periph_id;
  96         int valid;
  97         int last_transaction_us;
  98 };
  99
 100 static int tegra114_spi_ofdata_to_platdata(struct udevice *bus)
 101 {
 102         struct tegra_spi_platdata *plat = bus->platdata;
 103         const void *blob = gd->fdt_blob;
 104         int node = dev_of_offset(bus);
 105
 106         plat->base = devfdt_get_addr(bus);
 107         plat->periph_id = clock_decode_periph_id(bus);
 108
 109         if (plat->periph_id == PERIPH_ID_NONE) {
 110                 debug("%s: could not decode periph id %d\n", __func__,
 111                       plat->periph_id);
 112                 return -FDT_ERR_NOTFOUND;
 113         }
 114
 115         /* Use 500KHz as a suitable default */
 116         plat->frequency = fdtdec_get_int(blob, node, "spi-max-frequency",
 117                                         500000);
 118         plat->deactivate_delay_us = fdtdec_get_int(blob, node,
 119                                         "spi-deactivate-delay", 0);
 120         debug("%s: base=%#08lx, periph_id=%d, max-frequency=%d, deactivate_delay=%d\n",
 121               __func__, plat->base, plat->periph_id, plat->frequency,
 122               plat->deactivate_delay_us);
 123
 124         return 0;
 125 }
 126
 127 static int tegra114_spi_probe(struct udevice *bus)
 128 {
 129         struct tegra_spi_platdata *plat = dev_get_platdata(bus);
 130         struct tegra114_spi_priv *priv = dev_get_priv(bus);
 131         struct spi_regs *regs;
 132         ulong rate;
 133
 134         priv->regs = (struct spi_regs *)plat->base;
 135         regs = priv->regs;
 136
 137         priv->last_transaction_us = timer_get_us();
 138         priv->freq = plat->frequency;
 139         priv->periph_id = plat->periph_id;
 140
 141         /*
 142          * Change SPI clock to correct frequency, PLLP_OUT0 source, falling
 143          * back to the oscillator if that is too fast.
 144          */
 145         rate = clock_start_periph_pll(priv->periph_id, CLOCK_ID_PERIPH,
 146                                       priv->freq);
 147         if (rate > priv->freq + 100000) {
 148                 rate = clock_start_periph_pll(priv->periph_id, CLOCK_ID_OSC,
 149                                               priv->freq);
 150                 if (rate != priv->freq) {
 151                         printf("Warning: SPI '%s' requested clock %u, actual clock %lu\n",
 152                                bus->name, priv->freq, rate);
 153                 }
 154         }
 155         udelay(plat->deactivate_delay_us);
 156
 157         /* Clear stale status here */
 158         setbits_le32(&regs->fifo_status,
 159                      SPI_FIFO_STS_ERR           |
 160                      SPI_FIFO_STS_TX_FIFO_OVF   |
 161                      SPI_FIFO_STS_TX_FIFO_UNR   |
 162                      SPI_FIFO_STS_RX_FIFO_OVF   |
 163                      SPI_FIFO_STS_RX_FIFO_UNR   |
 164                      SPI_FIFO_STS_TX_FIFO_FULL  |
 165                      SPI_FIFO_STS_TX_FIFO_EMPTY |
 166                      SPI_FIFO_STS_RX_FIFO_FULL  |
 167                      SPI_FIFO_STS_RX_FIFO_EMPTY);
 168         debug("%s: FIFO STATUS = %08x\n", __func__, readl(&regs->fifo_status));
 169
 170         setbits_le32(&priv->regs->command1, SPI_CMD1_M_S | SPI_CMD1_CS_SW_HW |
 171                      (priv->mode << SPI_CMD1_MODE_SHIFT) | SPI_CMD1_CS_SW_VAL);
 172         debug("%s: COMMAND1 = %08x\n", __func__, readl(&regs->command1));
 173
 174         return 0;
 175 }
 176
 177 /**
 178  * Activate the CS by driving it LOW
 179  *
 180  * @param slave Pointer to spi_slave to which controller has to
 181  *              communicate with
 182  */
 183 static void spi_cs_activate(struct udevice *dev)
 184 {
 185         struct udevice *bus = dev->parent;
 186         struct tegra_spi_platdata *pdata = dev_get_platdata(bus);
 187         struct tegra114_spi_priv *priv = dev_get_priv(bus);
 188
 189         /* If it's too soon to do another transaction, wait */
 190         if (pdata->deactivate_delay_us &&
 191             priv->last_transaction_us) {
 192                 ulong delay_us;         /* The delay completed so far */
 193                 delay_us = timer_get_us() - priv->last_transaction_us;
 194                 if (delay_us < pdata->deactivate_delay_us)
 195                         udelay(pdata->deactivate_delay_us - delay_us);
 196         }
 197
 198         clrbits_le32(&priv->regs->command1, SPI_CMD1_CS_SW_VAL);
 199 }
 200
 201 /**
 202  * Deactivate the CS by driving it HIGH
 203  *
 204  * @param slave Pointer to spi_slave to which controller has to
 205  *              communicate with
 206  */
 207 static void spi_cs_deactivate(struct udevice *dev)
 208 {
 209         struct udevice *bus = dev->parent;
 210         struct tegra_spi_platdata *pdata = dev_get_platdata(bus);
 211         struct tegra114_spi_priv *priv = dev_get_priv(bus);
 212
 213         setbits_le32(&priv->regs->command1, SPI_CMD1_CS_SW_VAL);
 214
 215         /* Remember time of this transaction so we can honour the bus delay */
 216         if (pdata->deactivate_delay_us)
 217                 priv->last_transaction_us = timer_get_us();
 218
 219         debug("Deactivate CS, bus '%s'\n", bus->name);
 220 }
 221
 222 static int tegra114_spi_xfer(struct udevice *dev, unsigned int bitlen,
 223                              const void *data_out, void *data_in,
 224                              unsigned long flags)
 225 {
 226         struct udevice *bus = dev->parent;
 227         struct tegra114_spi_priv *priv = dev_get_priv(bus);
 228         struct spi_regs *regs = priv->regs;
 229         u32 reg, tmpdout, tmpdin = 0;
 230         const u8 *dout = data_out;
 231         u8 *din = data_in;
 232         int num_bytes;
 233         int ret;
 234
 235         debug("%s: slave %u:%u dout %p din %p bitlen %u\n",
 236               __func__, bus->seq, spi_chip_select(dev), dout, din, bitlen);
 237         if (bitlen % 8)
 238                 return -1;
 239         num_bytes = bitlen / 8;
 240
 241         ret = 0;
 242
 243         if (flags & SPI_XFER_BEGIN)
 244                 spi_cs_activate(dev);
 245
 246         /* clear all error status bits */
 247         reg = readl(&regs->fifo_status);
 248         writel(reg, &regs->fifo_status);
 249
 250         clrsetbits_le32(&regs->command1, SPI_CMD1_CS_SW_VAL,
 251                         SPI_CMD1_RX_EN | SPI_CMD1_TX_EN | SPI_CMD1_LSBY_FE |
 252                         (spi_chip_select(dev) << SPI_CMD1_CS_SEL_SHIFT));
 253
 254         /* set xfer size to 1 block (32 bits) */
 255         writel(0, &regs->dma_blk);
 256
 257         /* handle data in 32-bit chunks */
 258         while (num_bytes > 0) {
 259                 int bytes;
 260                 int tm, i;
 261
 262                 tmpdout = 0;
 263                 bytes = (num_bytes > 4) ?  4 : num_bytes;
 264
 265                 if (dout != NULL) {
 266                         for (i = 0; i < bytes; ++i)
 267                                 tmpdout = (tmpdout << 8) | dout[i];
 268                         dout += bytes;
 269                 }
 270
 271                 num_bytes -= bytes;
 272
 273                 /* clear ready bit */
 274                 setbits_le32(&regs->xfer_status, SPI_XFER_STS_RDY);
 275
 276                 clrsetbits_le32(&regs->command1,
 277                                 SPI_CMD1_BIT_LEN_MASK << SPI_CMD1_BIT_LEN_SHIFT,
 278                                 (bytes * 8 - 1) << SPI_CMD1_BIT_LEN_SHIFT);
 279                 writel(tmpdout, &regs->tx_fifo);
 280                 setbits_le32(&regs->command1, SPI_CMD1_GO);
 281
 282                 /*
 283                  * Wait for SPI transmit FIFO to empty, or to time out.
 284                  * The RX FIFO status will be read and cleared last
 285                  */
 286                 for (tm = 0; tm < SPI_TIMEOUT; ++tm) {
 287                         u32 fifo_status, xfer_status;
 288
 289                         xfer_status = readl(&regs->xfer_status);
 290                         if (!(xfer_status & SPI_XFER_STS_RDY))
 291                                 continue;
 292
 293                         fifo_status = readl(&regs->fifo_status);
 294                         if (fifo_status & SPI_FIFO_STS_ERR) {
 295                                 debug("%s: got a fifo error: ", __func__);
 296                                 if (fifo_status & SPI_FIFO_STS_TX_FIFO_OVF)
 297                                         debug("tx FIFO overflow ");
 298                                 if (fifo_status & SPI_FIFO_STS_TX_FIFO_UNR)
 299                                         debug("tx FIFO underrun ");
 300                                 if (fifo_status & SPI_FIFO_STS_RX_FIFO_OVF)
 301                                         debug("rx FIFO overflow ");
 302                                 if (fifo_status & SPI_FIFO_STS_RX_FIFO_UNR)
 303                                         debug("rx FIFO underrun ");
 304                                 if (fifo_status & SPI_FIFO_STS_TX_FIFO_FULL)
 305                                         debug("tx FIFO full ");
 306                                 if (fifo_status & SPI_FIFO_STS_TX_FIFO_EMPTY)
 307                                         debug("tx FIFO empty ");
 308                                 if (fifo_status & SPI_FIFO_STS_RX_FIFO_FULL)
 309                                         debug("rx FIFO full ");
 310                                 if (fifo_status & SPI_FIFO_STS_RX_FIFO_EMPTY)
 311                                         debug("rx FIFO empty ");
 312                                 debug("\n");
 313                                 break;
 314                         }
 315
 316                         if (!(fifo_status & SPI_FIFO_STS_RX_FIFO_EMPTY)) {
 317                                 tmpdin = readl(&regs->rx_fifo);
 318
 319                                 /* swap bytes read in */
 320                                 if (din != NULL) {
 321                                         for (i = bytes - 1; i >= 0; --i) {
 322                                                 din[i] = tmpdin & 0xff;
 323                                                 tmpdin >>= 8;
 324                                         }
 325                                         din += bytes;
 326                                 }
 327
 328                                 /* We can exit when we've had both RX and TX */
 329                                 break;
 330                         }
 331                 }
 332
 333                 if (tm >= SPI_TIMEOUT)
 334                         ret = tm;
 335
 336                 /* clear ACK RDY, etc. bits */
 337                 writel(readl(&regs->fifo_status), &regs->fifo_status);
 338         }
 339
 340         if (flags & SPI_XFER_END)
 341                 spi_cs_deactivate(dev);
 342
 343         debug("%s: transfer ended. Value=%08x, fifo_status = %08x\n",
 344               __func__, tmpdin, readl(&regs->fifo_status));
 345
 346         if (ret) {
 347                 printf("%s: timeout during SPI transfer, tm %d\n",
 348                        __func__, ret);
 349                 return -1;
 350         }
 351
 352         return ret;
 353 }
 354
 355 static int tegra114_spi_set_speed(struct udevice *bus, uint speed)
 356 {
 357         struct tegra_spi_platdata *plat = bus->platdata;
 358         struct tegra114_spi_priv *priv = dev_get_priv(bus);
 359
 360         if (speed > plat->frequency)
 361                 speed = plat->frequency;
 362         priv->freq = speed;
 363         debug("%s: regs=%p, speed=%d\n", __func__, priv->regs, priv->freq);
 364
 365         return 0;
 366 }
 367
 368 static int tegra114_spi_set_mode(struct udevice *bus, uint mode)
 369 {
 370         struct tegra114_spi_priv *priv = dev_get_priv(bus);
 371
 372         priv->mode = mode;
 373         debug("%s: regs=%p, mode=%d\n", __func__, priv->regs, priv->mode);
 374
 375         return 0;
 376 }
 377
 378 static const struct dm_spi_ops tegra114_spi_ops = {
 379         .xfer           = tegra114_spi_xfer,
 380         .set_speed      = tegra114_spi_set_speed,
 381         .set_mode       = tegra114_spi_set_mode,
 382         /*
 383          * cs_info is not needed, since we require all chip selects to be
 384          * in the device tree explicitly
 385          */
 386 };
 387
 388 static const struct udevice_id tegra114_spi_ids[] = {
 389         { .compatible = "nvidia,tegra114-spi" },
 390         { }
 391 };
 392
 393 U_BOOT_DRIVER(tegra114_spi) = {
 394         .name   = "tegra114_spi",
 395         .id     = UCLASS_SPI,
 396         .of_match = tegra114_spi_ids,
 397         .ops    = &tegra114_spi_ops,
 398         .ofdata_to_platdata = tegra114_spi_ofdata_to_platdata,
 399         .platdata_auto_alloc_size = sizeof(struct tegra_spi_platdata),
 400         .priv_auto_alloc_size = sizeof(struct tegra114_spi_priv),
 401         .probe  = tegra114_spi_probe,
 402 };