drivers/spi/exynos_spi.c

   1 /*
   2  * (C) Copyright 2012 SAMSUNG Electronics
   3  * Padmavathi Venna <padma.v@samsung.com>
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  */
   7
   8 #include <common.h>
   9 #include <malloc.h>
  10 #include <spi.h>
  11 #include <fdtdec.h>
  12 #include <asm/arch/clk.h>
  13 #include <asm/arch/clock.h>
  14 #include <asm/arch/cpu.h>
  15 #include <asm/arch/gpio.h>
  16 #include <asm/arch/pinmux.h>
  17 #include <asm/arch-exynos/spi.h>
  18 #include <asm/io.h>
  19
  20 DECLARE_GLOBAL_DATA_PTR;
  21
  22 /* Information about each SPI controller */
  23 struct spi_bus {
  24         enum periph_id periph_id;
  25         s32 frequency;          /* Default clock frequency, -1 for none */
  26         struct exynos_spi *regs;
  27         int inited;             /* 1 if this bus is ready for use */
  28         int node;
  29         uint deactivate_delay_us;       /* Delay to wait after deactivate */
  30 };
  31
  32 /* A list of spi buses that we know about */
  33 static struct spi_bus spi_bus[EXYNOS5_SPI_NUM_CONTROLLERS];
  34 static unsigned int bus_count;
  35
  36 struct exynos_spi_slave {
  37         struct spi_slave slave;
  38         struct exynos_spi *regs;
  39         unsigned int freq;              /* Default frequency */
  40         unsigned int mode;
  41         enum periph_id periph_id;       /* Peripheral ID for this device */
  42         unsigned int fifo_size;
  43         int skip_preamble;
  44         struct spi_bus *bus;            /* Pointer to our SPI bus info */
  45         ulong last_transaction_us;      /* Time of last transaction end */
  46 };
  47
  48 static struct spi_bus *spi_get_bus(unsigned dev_index)
  49 {
  50         if (dev_index < bus_count)
  51                 return &spi_bus[dev_index];
  52         debug("%s: invalid bus %d", __func__, dev_index);
  53
  54         return NULL;
  55 }
  56
  57 static inline struct exynos_spi_slave *to_exynos_spi(struct spi_slave *slave)
  58 {
  59         return container_of(slave, struct exynos_spi_slave, slave);
  60 }
  61
  62 /**
  63  * Setup the driver private data
  64  *
  65  * @param bus           ID of the bus that the slave is attached to
  66  * @param cs            ID of the chip select connected to the slave
  67  * @param max_hz        Required spi frequency
  68  * @param mode          Required spi mode (clk polarity, clk phase and
  69  *                      master or slave)
  70  * @return new device or NULL
  71  */
  72 struct spi_slave *spi_setup_slave(unsigned int busnum, unsigned int cs,
  73                         unsigned int max_hz, unsigned int mode)
  74 {
  75         struct exynos_spi_slave *spi_slave;
  76         struct spi_bus *bus;
  77
  78         if (!spi_cs_is_valid(busnum, cs)) {
  79                 debug("%s: Invalid bus/chip select %d, %d\n", __func__,
  80                       busnum, cs);
  81                 return NULL;
  82         }
  83
  84         spi_slave = spi_alloc_slave(struct exynos_spi_slave, busnum, cs);
  85         if (!spi_slave) {
  86                 debug("%s: Could not allocate spi_slave\n", __func__);
  87                 return NULL;
  88         }
  89
  90         bus = &spi_bus[busnum];
  91         spi_slave->bus = bus;
  92         spi_slave->regs = bus->regs;
  93         spi_slave->mode = mode;
  94         spi_slave->periph_id = bus->periph_id;
  95         if (bus->periph_id == PERIPH_ID_SPI1 ||
  96             bus->periph_id == PERIPH_ID_SPI2)
  97                 spi_slave->fifo_size = 64;
  98         else
  99                 spi_slave->fifo_size = 256;
 100
 101         spi_slave->skip_preamble = 0;
 102         spi_slave->last_transaction_us = timer_get_us();
 103
 104         spi_slave->freq = bus->frequency;
 105         if (max_hz)
 106                 spi_slave->freq = min(max_hz, spi_slave->freq);
 107
 108         return &spi_slave->slave;
 109 }
 110
 111 /**
 112  * Free spi controller
 113  *
 114  * @param slave Pointer to spi_slave to which controller has to
 115  *              communicate with
 116  */
 117 void spi_free_slave(struct spi_slave *slave)
 118 {
 119         struct exynos_spi_slave *spi_slave = to_exynos_spi(slave);
 120
 121         free(spi_slave);
 122 }
 123
 124 /**
 125  * Flush spi tx, rx fifos and reset the SPI controller
 126  *
 127  * @param slave Pointer to spi_slave to which controller has to
 128  *              communicate with
 129  */
 130 static void spi_flush_fifo(struct spi_slave *slave)
 131 {
 132         struct exynos_spi_slave *spi_slave = to_exynos_spi(slave);
 133         struct exynos_spi *regs = spi_slave->regs;
 134
 135         clrsetbits_le32(&regs->ch_cfg, SPI_CH_HS_EN, SPI_CH_RST);
 136         clrbits_le32(&regs->ch_cfg, SPI_CH_RST);
 137         setbits_le32(&regs->ch_cfg, SPI_TX_CH_ON | SPI_RX_CH_ON);
 138 }
 139
 140 /**
 141  * Initialize the spi base registers, set the required clock frequency and
 142  * initialize the gpios
 143  *
 144  * @param slave Pointer to spi_slave to which controller has to
 145  *              communicate with
 146  * @return zero on success else a negative value
 147  */
 148 int spi_claim_bus(struct spi_slave *slave)
 149 {
 150         struct exynos_spi_slave *spi_slave = to_exynos_spi(slave);
 151         struct exynos_spi *regs = spi_slave->regs;
 152         u32 reg = 0;
 153         int ret;
 154
 155         ret = set_spi_clk(spi_slave->periph_id,
 156                                         spi_slave->freq);
 157         if (ret < 0) {
 158                 debug("%s: Failed to setup spi clock\n", __func__);
 159                 return ret;
 160         }
 161
 162         exynos_pinmux_config(spi_slave->periph_id, PINMUX_FLAG_NONE);
 163
 164         spi_flush_fifo(slave);
 165
 166         reg = readl(&regs->ch_cfg);
 167         reg &= ~(SPI_CH_CPHA_B | SPI_CH_CPOL_L);
 168
 169         if (spi_slave->mode & SPI_CPHA)
 170                 reg |= SPI_CH_CPHA_B;
 171
 172         if (spi_slave->mode & SPI_CPOL)
 173                 reg |= SPI_CH_CPOL_L;
 174
 175         writel(reg, &regs->ch_cfg);
 176         writel(SPI_FB_DELAY_180, &regs->fb_clk);
 177
 178         return 0;
 179 }
 180
 181 /**
 182  * Reset the spi H/W and flush the tx and rx fifos
 183  *
 184  * @param slave Pointer to spi_slave to which controller has to
 185  *              communicate with
 186  */
 187 void spi_release_bus(struct spi_slave *slave)
 188 {
 189         spi_flush_fifo(slave);
 190 }
 191
 192 static void spi_get_fifo_levels(struct exynos_spi *regs,
 193         int *rx_lvl, int *tx_lvl)
 194 {
 195         uint32_t spi_sts = readl(&regs->spi_sts);
 196
 197         *rx_lvl = (spi_sts >> SPI_RX_LVL_OFFSET) & SPI_FIFO_LVL_MASK;
 198         *tx_lvl = (spi_sts >> SPI_TX_LVL_OFFSET) & SPI_FIFO_LVL_MASK;
 199 }
 200
 201 /**
 202  * If there's something to transfer, do a software reset and set a
 203  * transaction size.
 204  *
 205  * @param regs  SPI peripheral registers
 206  * @param count Number of bytes to transfer
 207  */
 208 static void spi_request_bytes(struct exynos_spi *regs, int count)
 209 {
 210         assert(count && count < (1 << 16));
 211         setbits_le32(&regs->ch_cfg, SPI_CH_RST);
 212         clrbits_le32(&regs->ch_cfg, SPI_CH_RST);
 213         writel(count | SPI_PACKET_CNT_EN, &regs->pkt_cnt);
 214 }
 215
 216 static int spi_rx_tx(struct exynos_spi_slave *spi_slave, int todo,
 217                         void **dinp, void const **doutp, unsigned long flags)
 218 {
 219         struct exynos_spi *regs = spi_slave->regs;
 220         uchar *rxp = *dinp;
 221         const uchar *txp = *doutp;
 222         int rx_lvl, tx_lvl;
 223         uint out_bytes, in_bytes;
 224         int toread;
 225         unsigned start = get_timer(0);
 226         int stopping;
 227
 228         out_bytes = in_bytes = todo;
 229
 230         stopping = spi_slave->skip_preamble && (flags & SPI_XFER_END) &&
 231                                         !(spi_slave->mode & SPI_SLAVE);
 232
 233         /*
 234          * If there's something to send, do a software reset and set a
 235          * transaction size.
 236          */
 237         spi_request_bytes(regs, todo);
 238
 239         /*
 240          * Bytes are transmitted/received in pairs. Wait to receive all the
 241          * data because then transmission will be done as well.
 242          */
 243         toread = in_bytes;
 244
 245         while (in_bytes) {
 246                 int temp;
 247
 248                 /* Keep the fifos full/empty. */
 249                 spi_get_fifo_levels(regs, &rx_lvl, &tx_lvl);
 250                 if (tx_lvl < spi_slave->fifo_size && out_bytes) {
 251                         temp = txp ? *txp++ : 0xff;
 252                         writel(temp, &regs->tx_data);
 253                         out_bytes--;
 254                 }
 255                 if (rx_lvl > 0) {
 256                         temp = readl(&regs->rx_data);
 257                         if (spi_slave->skip_preamble) {
 258                                 if (temp == SPI_PREAMBLE_END_BYTE) {
 259                                         spi_slave->skip_preamble = 0;
 260                                         stopping = 0;
 261                                 }
 262                         } else {
 263                                 if (rxp || stopping)
 264                                         *rxp++ = temp;
 265                                 in_bytes--;
 266                         }
 267                         toread--;
 268                 } else if (!toread) {
 269                         /*
 270                          * We have run out of input data, but haven't read
 271                          * enough bytes after the preamble yet. Read some more,
 272                          * and make sure that we transmit dummy bytes too, to
 273                          * keep things going.
 274                          */
 275                         assert(!out_bytes);
 276                         out_bytes = in_bytes;
 277                         toread = in_bytes;
 278                         txp = NULL;
 279                         spi_request_bytes(regs, toread);
 280                 }
 281                 if (spi_slave->skip_preamble && get_timer(start) > 100) {
 282                         printf("SPI timeout: in_bytes=%d, out_bytes=%d, ",
 283                                in_bytes, out_bytes);
 284                         return -1;
 285                 }
 286         }
 287
 288         *dinp = rxp;
 289         *doutp = txp;
 290
 291         return 0;
 292 }
 293
 294 /**
 295  * Transfer and receive data
 296  *
 297  * @param slave         Pointer to spi_slave to which controller has to
 298  *                      communicate with
 299  * @param bitlen        No of bits to tranfer or receive
 300  * @param dout          Pointer to transfer buffer
 301  * @param din           Pointer to receive buffer
 302  * @param flags         Flags for transfer begin and end
 303  * @return zero on success else a negative value
 304  */
 305 int spi_xfer(struct spi_slave *slave, unsigned int bitlen, const void *dout,
 306              void *din, unsigned long flags)
 307 {
 308         struct exynos_spi_slave *spi_slave = to_exynos_spi(slave);
 309         int upto, todo;
 310         int bytelen;
 311         int ret = 0;
 312
 313         /* spi core configured to do 8 bit transfers */
 314         if (bitlen % 8) {
 315                 debug("Non byte aligned SPI transfer.\n");
 316                 return -1;
 317         }
 318
 319         /* Start the transaction, if necessary. */
 320         if ((flags & SPI_XFER_BEGIN))
 321                 spi_cs_activate(slave);
 322
 323         /* Exynos SPI limits each transfer to 65535 bytes */
 324         bytelen =  bitlen / 8;
 325         for (upto = 0; !ret && upto < bytelen; upto += todo) {
 326                 todo = min(bytelen - upto, (1 << 16) - 1);
 327                 ret = spi_rx_tx(spi_slave, todo, &din, &dout, flags);
 328                 if (ret)
 329                         break;
 330         }
 331
 332         /* Stop the transaction, if necessary. */
 333         if ((flags & SPI_XFER_END) && !(spi_slave->mode & SPI_SLAVE)) {
 334                 spi_cs_deactivate(slave);
 335                 if (spi_slave->skip_preamble) {
 336                         assert(!spi_slave->skip_preamble);
 337                         debug("Failed to complete premable transaction\n");
 338                         ret = -1;
 339                 }
 340         }
 341
 342         return ret;
 343 }
 344
 345 /**
 346  * Validates the bus and chip select numbers
 347  *
 348  * @param bus   ID of the bus that the slave is attached to
 349  * @param cs    ID of the chip select connected to the slave
 350  * @return one on success else zero
 351  */
 352 int spi_cs_is_valid(unsigned int bus, unsigned int cs)
 353 {
 354         return spi_get_bus(bus) && cs == 0;
 355 }
 356
 357 /**
 358  * Activate the CS by driving it LOW
 359  *
 360  * @param slave Pointer to spi_slave to which controller has to
 361  *              communicate with
 362  */
 363 void spi_cs_activate(struct spi_slave *slave)
 364 {
 365         struct exynos_spi_slave *spi_slave = to_exynos_spi(slave);
 366
 367         /* If it's too soon to do another transaction, wait */
 368         if (spi_slave->bus->deactivate_delay_us &&
 369             spi_slave->last_transaction_us) {
 370                 ulong delay_us;         /* The delay completed so far */
 371                 delay_us = timer_get_us() - spi_slave->last_transaction_us;
 372                 if (delay_us < spi_slave->bus->deactivate_delay_us)
 373                         udelay(spi_slave->bus->deactivate_delay_us - delay_us);
 374         }
 375
 376         clrbits_le32(&spi_slave->regs->cs_reg, SPI_SLAVE_SIG_INACT);
 377         debug("Activate CS, bus %d\n", spi_slave->slave.bus);
 378         spi_slave->skip_preamble = spi_slave->mode & SPI_PREAMBLE;
 379
 380         /* Remember time of this transaction so we can honour the bus delay */
 381         if (spi_slave->bus->deactivate_delay_us)
 382                 spi_slave->last_transaction_us = timer_get_us();
 383 }
 384
 385 /**
 386  * Deactivate the CS by driving it HIGH
 387  *
 388  * @param slave Pointer to spi_slave to which controller has to
 389  *              communicate with
 390  */
 391 void spi_cs_deactivate(struct spi_slave *slave)
 392 {
 393         struct exynos_spi_slave *spi_slave = to_exynos_spi(slave);
 394
 395         setbits_le32(&spi_slave->regs->cs_reg, SPI_SLAVE_SIG_INACT);
 396         debug("Deactivate CS, bus %d\n", spi_slave->slave.bus);
 397 }
 398
 399 static inline struct exynos_spi *get_spi_base(int dev_index)
 400 {
 401         if (dev_index < 3)
 402                 return (struct exynos_spi *)samsung_get_base_spi() + dev_index;
 403         else
 404                 return (struct exynos_spi *)samsung_get_base_spi_isp() +
 405                                         (dev_index - 3);
 406 }
 407
 408 /*
 409  * Read the SPI config from the device tree node.
 410  *
 411  * @param blob  FDT blob to read from
 412  * @param node  Node offset to read from
 413  * @param bus   SPI bus structure to fill with information
 414  * @return 0 if ok, or -FDT_ERR_NOTFOUND if something was missing
 415  */
 416 #ifdef CONFIG_OF_CONTROL
 417 static int spi_get_config(const void *blob, int node, struct spi_bus *bus)
 418 {
 419         bus->node = node;
 420         bus->regs = (struct exynos_spi *)fdtdec_get_addr(blob, node, "reg");
 421         bus->periph_id = pinmux_decode_periph_id(blob, node);
 422
 423         if (bus->periph_id == PERIPH_ID_NONE) {
 424                 debug("%s: Invalid peripheral ID %d\n", __func__,
 425                         bus->periph_id);
 426                 return -FDT_ERR_NOTFOUND;
 427         }
 428
 429         /* Use 500KHz as a suitable default */
 430         bus->frequency = fdtdec_get_int(blob, node, "spi-max-frequency",
 431                                         500000);
 432         bus->deactivate_delay_us = fdtdec_get_int(blob, node,
 433                                         "spi-deactivate-delay", 0);
 434
 435         return 0;
 436 }
 437
 438 /*
 439  * Process a list of nodes, adding them to our list of SPI ports.
 440  *
 441  * @param blob          fdt blob
 442  * @param node_list     list of nodes to process (any <=0 are ignored)
 443  * @param count         number of nodes to process
 444  * @param is_dvc        1 if these are DVC ports, 0 if standard I2C
 445  * @return 0 if ok, -1 on error
 446  */
 447 static int process_nodes(const void *blob, int node_list[], int count)
 448 {
 449         int i;
 450
 451         /* build the i2c_controllers[] for each controller */
 452         for (i = 0; i < count; i++) {
 453                 int node = node_list[i];
 454                 struct spi_bus *bus;
 455
 456                 if (node <= 0)
 457                         continue;
 458
 459                 bus = &spi_bus[i];
 460                 if (spi_get_config(blob, node, bus)) {
 461                         printf("exynos spi_init: failed to decode bus %d\n",
 462                                 i);
 463                         return -1;
 464                 }
 465
 466                 debug("spi: controller bus %d at %p, periph_id %d\n",
 467                       i, bus->regs, bus->periph_id);
 468                 bus->inited = 1;
 469                 bus_count++;
 470         }
 471
 472         return 0;
 473 }
 474 #endif
 475
 476 /**
 477  * Set up a new SPI slave for an fdt node
 478  *
 479  * @param blob          Device tree blob
 480  * @param node          SPI peripheral node to use
 481  * @return 0 if ok, -1 on error
 482  */
 483 struct spi_slave *spi_setup_slave_fdt(const void *blob, int node,
 484                 unsigned int cs, unsigned int max_hz, unsigned int mode)
 485 {
 486         struct spi_bus *bus;
 487         unsigned int i;
 488
 489         for (i = 0, bus = spi_bus; i < bus_count; i++, bus++) {
 490                 if (bus->node == node)
 491                         return spi_setup_slave(i, cs, max_hz, mode);
 492         }
 493
 494         debug("%s: Failed to find bus node %d\n", __func__, node);
 495         return NULL;
 496 }
 497
 498 /* Sadly there is no error return from this function */
 499 void spi_init(void)
 500 {
 501         int count;
 502
 503 #ifdef CONFIG_OF_CONTROL
 504         int node_list[EXYNOS5_SPI_NUM_CONTROLLERS];
 505         const void *blob = gd->fdt_blob;
 506
 507         count = fdtdec_find_aliases_for_id(blob, "spi",
 508                         COMPAT_SAMSUNG_EXYNOS_SPI, node_list,
 509                         EXYNOS5_SPI_NUM_CONTROLLERS);
 510         if (process_nodes(blob, node_list, count))
 511                 return;
 512
 513 #else
 514         struct spi_bus *bus;
 515
 516         for (count = 0; count < EXYNOS5_SPI_NUM_CONTROLLERS; count++) {
 517                 bus = &spi_bus[count];
 518                 bus->regs = get_spi_base(count);
 519                 bus->periph_id = PERIPH_ID_SPI0 + count;
 520
 521                 /* Although Exynos5 supports upto 50Mhz speed,
 522                  * we are setting it to 10Mhz for safe side
 523                  */
 524                 bus->frequency = 10000000;
 525                 bus->inited = 1;
 526                 bus->node = 0;
 527                 bus_count = EXYNOS5_SPI_NUM_CONTROLLERS;
 528         }
 529 #endif
 530 }