drivers/spi/spi-dw.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * Designware SPI core controller driver (refer pxa2xx_spi.c)
   4  *
   5  * Copyright (c) 2009, Intel Corporation.
   6  */
   7
   8 #include <linux/dma-mapping.h>
   9 #include <linux/interrupt.h>
  10 #include <linux/module.h>
  11 #include <linux/highmem.h>
  12 #include <linux/delay.h>
  13 #include <linux/slab.h>
  14 #include <linux/spi/spi.h>
  15
  16 #include "spi-dw.h"
  17
  18 #ifdef CONFIG_DEBUG_FS
  19 #include <linux/debugfs.h>
  20 #endif
  21
  22 /* Slave spi_dev related */
  23 struct chip_data {
  24         u8 tmode;               /* TR/TO/RO/EEPROM */
  25         u8 type;                /* SPI/SSP/MicroWire */
  26
  27         u8 poll_mode;           /* 1 means use poll mode */
  28
  29         u16 clk_div;            /* baud rate divider */
  30         u32 speed_hz;           /* baud rate */
  31         void (*cs_control)(u32 command);
  32 };
  33
  34 #ifdef CONFIG_DEBUG_FS
  35 #define SPI_REGS_BUFSIZE        1024
  36 static ssize_t dw_spi_show_regs(struct file *file, char __user *user_buf,
  37                 size_t count, loff_t *ppos)
  38 {
  39         struct dw_spi *dws = file->private_data;
  40         char *buf;
  41         u32 len = 0;
  42         ssize_t ret;
  43
  44         buf = kzalloc(SPI_REGS_BUFSIZE, GFP_KERNEL);
  45         if (!buf)
  46                 return 0;
  47
  48         len += scnprintf(buf + len, SPI_REGS_BUFSIZE - len,
  49                         "%s registers:\n", dev_name(&dws->master->dev));
  50         len += scnprintf(buf + len, SPI_REGS_BUFSIZE - len,
  51                         "=================================\n");
  52         len += scnprintf(buf + len, SPI_REGS_BUFSIZE - len,
  53                         "CTRL0: \t\t0x%08x\n", dw_readl(dws, DW_SPI_CTRL0));
  54         len += scnprintf(buf + len, SPI_REGS_BUFSIZE - len,
  55                         "CTRL1: \t\t0x%08x\n", dw_readl(dws, DW_SPI_CTRL1));
  56         len += scnprintf(buf + len, SPI_REGS_BUFSIZE - len,
  57                         "SSIENR: \t0x%08x\n", dw_readl(dws, DW_SPI_SSIENR));
  58         len += scnprintf(buf + len, SPI_REGS_BUFSIZE - len,
  59                         "SER: \t\t0x%08x\n", dw_readl(dws, DW_SPI_SER));
  60         len += scnprintf(buf + len, SPI_REGS_BUFSIZE - len,
  61                         "BAUDR: \t\t0x%08x\n", dw_readl(dws, DW_SPI_BAUDR));
  62         len += scnprintf(buf + len, SPI_REGS_BUFSIZE - len,
  63                         "TXFTLR: \t0x%08x\n", dw_readl(dws, DW_SPI_TXFLTR));
  64         len += scnprintf(buf + len, SPI_REGS_BUFSIZE - len,
  65                         "RXFTLR: \t0x%08x\n", dw_readl(dws, DW_SPI_RXFLTR));
  66         len += scnprintf(buf + len, SPI_REGS_BUFSIZE - len,
  67                         "TXFLR: \t\t0x%08x\n", dw_readl(dws, DW_SPI_TXFLR));
  68         len += scnprintf(buf + len, SPI_REGS_BUFSIZE - len,
  69                         "RXFLR: \t\t0x%08x\n", dw_readl(dws, DW_SPI_RXFLR));
  70         len += scnprintf(buf + len, SPI_REGS_BUFSIZE - len,
  71                         "SR: \t\t0x%08x\n", dw_readl(dws, DW_SPI_SR));
  72         len += scnprintf(buf + len, SPI_REGS_BUFSIZE - len,
  73                         "IMR: \t\t0x%08x\n", dw_readl(dws, DW_SPI_IMR));
  74         len += scnprintf(buf + len, SPI_REGS_BUFSIZE - len,
  75                         "ISR: \t\t0x%08x\n", dw_readl(dws, DW_SPI_ISR));
  76         len += scnprintf(buf + len, SPI_REGS_BUFSIZE - len,
  77                         "DMACR: \t\t0x%08x\n", dw_readl(dws, DW_SPI_DMACR));
  78         len += scnprintf(buf + len, SPI_REGS_BUFSIZE - len,
  79                         "DMATDLR: \t0x%08x\n", dw_readl(dws, DW_SPI_DMATDLR));
  80         len += scnprintf(buf + len, SPI_REGS_BUFSIZE - len,
  81                         "DMARDLR: \t0x%08x\n", dw_readl(dws, DW_SPI_DMARDLR));
  82         len += scnprintf(buf + len, SPI_REGS_BUFSIZE - len,
  83                         "=================================\n");
  84
  85         ret = simple_read_from_buffer(user_buf, count, ppos, buf, len);
  86         kfree(buf);
  87         return ret;
  88 }
  89
  90 static const struct file_operations dw_spi_regs_ops = {
  91         .owner          = THIS_MODULE,
  92         .open           = simple_open,
  93         .read           = dw_spi_show_regs,
  94         .llseek         = default_llseek,
  95 };
  96
  97 static int dw_spi_debugfs_init(struct dw_spi *dws)
  98 {
  99         char name[32];
 100
 101         snprintf(name, 32, "dw_spi%d", dws->master->bus_num);
 102         dws->debugfs = debugfs_create_dir(name, NULL);
 103         if (!dws->debugfs)
 104                 return -ENOMEM;
 105
 106         debugfs_create_file("registers", S_IFREG | S_IRUGO,
 107                 dws->debugfs, (void *)dws, &dw_spi_regs_ops);
 108         return 0;
 109 }
 110
 111 static void dw_spi_debugfs_remove(struct dw_spi *dws)
 112 {
 113         debugfs_remove_recursive(dws->debugfs);
 114 }
 115
 116 #else
 117 static inline int dw_spi_debugfs_init(struct dw_spi *dws)
 118 {
 119         return 0;
 120 }
 121
 122 static inline void dw_spi_debugfs_remove(struct dw_spi *dws)
 123 {
 124 }
 125 #endif /* CONFIG_DEBUG_FS */
 126
 127 void dw_spi_set_cs(struct spi_device *spi, bool enable)
 128 {
 129         struct dw_spi *dws = spi_controller_get_devdata(spi->controller);
 130         struct chip_data *chip = spi_get_ctldata(spi);
 131
 132         /* Chip select logic is inverted from spi_set_cs() */
 133         if (chip && chip->cs_control)
 134                 chip->cs_control(!enable);
 135
 136         if (!enable)
 137                 dw_writel(dws, DW_SPI_SER, BIT(spi->chip_select));
 138         else if (dws->cs_override)
 139                 dw_writel(dws, DW_SPI_SER, 0);
 140 }
 141 EXPORT_SYMBOL_GPL(dw_spi_set_cs);
 142
 143 /* Return the max entries we can fill into tx fifo */
 144 static inline u32 tx_max(struct dw_spi *dws)
 145 {
 146         u32 tx_left, tx_room, rxtx_gap;
 147
 148         tx_left = (dws->tx_end - dws->tx) / dws->n_bytes;
 149         tx_room = dws->fifo_len - dw_readl(dws, DW_SPI_TXFLR);
 150
 151         /*
 152          * Another concern is about the tx/rx mismatch, we
 153          * though to use (dws->fifo_len - rxflr - txflr) as
 154          * one maximum value for tx, but it doesn't cover the
 155          * data which is out of tx/rx fifo and inside the
 156          * shift registers. So a control from sw point of
 157          * view is taken.
 158          */
 159         rxtx_gap =  ((dws->rx_end - dws->rx) - (dws->tx_end - dws->tx))
 160                         / dws->n_bytes;
 161
 162         return min3(tx_left, tx_room, (u32) (dws->fifo_len - rxtx_gap));
 163 }
 164
 165 /* Return the max entries we should read out of rx fifo */
 166 static inline u32 rx_max(struct dw_spi *dws)
 167 {
 168         u32 rx_left = (dws->rx_end - dws->rx) / dws->n_bytes;
 169
 170         return min_t(u32, rx_left, dw_readl(dws, DW_SPI_RXFLR));
 171 }
 172
 173 static void dw_writer(struct dw_spi *dws)
 174 {
 175         u32 max;
 176         u16 txw = 0;
 177
 178         spin_lock(&dws->buf_lock);
 179         max = tx_max(dws);
 180         while (max--) {
 181                 /* Set the tx word if the transfer's original "tx" is not null */
 182                 if (dws->tx_end - dws->len) {
 183                         if (dws->n_bytes == 1)
 184                                 txw = *(u8 *)(dws->tx);
 185                         else
 186                                 txw = *(u16 *)(dws->tx);
 187                 }
 188                 dw_write_io_reg(dws, DW_SPI_DR, txw);
 189                 dws->tx += dws->n_bytes;
 190         }
 191         spin_unlock(&dws->buf_lock);
 192 }
 193
 194 static void dw_reader(struct dw_spi *dws)
 195 {
 196         u32 max;
 197         u16 rxw;
 198
 199         spin_lock(&dws->buf_lock);
 200         max = rx_max(dws);
 201         while (max--) {
 202                 rxw = dw_read_io_reg(dws, DW_SPI_DR);
 203                 /* Care rx only if the transfer's original "rx" is not null */
 204                 if (dws->rx_end - dws->len) {
 205                         if (dws->n_bytes == 1)
 206                                 *(u8 *)(dws->rx) = rxw;
 207                         else
 208                                 *(u16 *)(dws->rx) = rxw;
 209                 }
 210                 dws->rx += dws->n_bytes;
 211         }
 212         spin_unlock(&dws->buf_lock);
 213 }
 214
 215 static void int_error_stop(struct dw_spi *dws, const char *msg)
 216 {
 217         spi_reset_chip(dws);
 218
 219         dev_err(&dws->master->dev, "%s\n", msg);
 220         dws->master->cur_msg->status = -EIO;
 221         spi_finalize_current_transfer(dws->master);
 222 }
 223
 224 static irqreturn_t interrupt_transfer(struct dw_spi *dws)
 225 {
 226         u16 irq_status = dw_readl(dws, DW_SPI_ISR);
 227
 228         /* Error handling */
 229         if (irq_status & (SPI_INT_TXOI | SPI_INT_RXOI | SPI_INT_RXUI)) {
 230                 dw_readl(dws, DW_SPI_ICR);
 231                 int_error_stop(dws, "interrupt_transfer: fifo overrun/underrun");
 232                 return IRQ_HANDLED;
 233         }
 234
 235         dw_reader(dws);
 236         if (dws->rx_end == dws->rx) {
 237                 spi_mask_intr(dws, SPI_INT_TXEI);
 238                 spi_finalize_current_transfer(dws->master);
 239                 return IRQ_HANDLED;
 240         }
 241         if (irq_status & SPI_INT_TXEI) {
 242                 spi_mask_intr(dws, SPI_INT_TXEI);
 243                 dw_writer(dws);
 244                 /* Enable TX irq always, it will be disabled when RX finished */
 245                 spi_umask_intr(dws, SPI_INT_TXEI);
 246         }
 247
 248         return IRQ_HANDLED;
 249 }
 250
 251 static irqreturn_t dw_spi_irq(int irq, void *dev_id)
 252 {
 253         struct spi_controller *master = dev_id;
 254         struct dw_spi *dws = spi_controller_get_devdata(master);
 255         u16 irq_status = dw_readl(dws, DW_SPI_ISR) & 0x3f;
 256
 257         if (!irq_status)
 258                 return IRQ_NONE;
 259
 260         if (!master->cur_msg) {
 261                 spi_mask_intr(dws, SPI_INT_TXEI);
 262                 return IRQ_HANDLED;
 263         }
 264
 265         return dws->transfer_handler(dws);
 266 }
 267
 268 /* Must be called inside pump_transfers() */
 269 static int poll_transfer(struct dw_spi *dws)
 270 {
 271         do {
 272                 dw_writer(dws);
 273                 dw_reader(dws);
 274                 cpu_relax();
 275         } while (dws->rx_end > dws->rx);
 276
 277         return 0;
 278 }
 279
 280 static int dw_spi_transfer_one(struct spi_controller *master,
 281                 struct spi_device *spi, struct spi_transfer *transfer)
 282 {
 283         struct dw_spi *dws = spi_controller_get_devdata(master);
 284         struct chip_data *chip = spi_get_ctldata(spi);
 285         unsigned long flags;
 286         u8 imask = 0;
 287         u16 txlevel = 0;
 288         u32 cr0;
 289         int ret;
 290
 291         dws->dma_mapped = 0;
 292         spin_lock_irqsave(&dws->buf_lock, flags);
 293         dws->tx = (void *)transfer->tx_buf;
 294         dws->tx_end = dws->tx + transfer->len;
 295         dws->rx = transfer->rx_buf;
 296         dws->rx_end = dws->rx + transfer->len;
 297         dws->len = transfer->len;
 298         spin_unlock_irqrestore(&dws->buf_lock, flags);
 299
 300         spi_enable_chip(dws, 0);
 301
 302         /* Handle per transfer options for bpw and speed */
 303         if (transfer->speed_hz != dws->current_freq) {
 304                 if (transfer->speed_hz != chip->speed_hz) {
 305                         /* clk_div doesn't support odd number */
 306                         chip->clk_div = (DIV_ROUND_UP(dws->max_freq, transfer->speed_hz) + 1) & 0xfffe;
 307                         chip->speed_hz = transfer->speed_hz;
 308                 }
 309                 dws->current_freq = transfer->speed_hz;
 310                 spi_set_clk(dws, chip->clk_div);
 311         }
 312
 313         dws->n_bytes = DIV_ROUND_UP(transfer->bits_per_word, BITS_PER_BYTE);
 314         dws->dma_width = DIV_ROUND_UP(transfer->bits_per_word, BITS_PER_BYTE);
 315
 316         /* Default SPI mode is SCPOL = 0, SCPH = 0 */
 317         cr0 = (transfer->bits_per_word - 1)
 318                 | (chip->type << SPI_FRF_OFFSET)
 319                 | ((((spi->mode & SPI_CPOL) ? 1 : 0) << SPI_SCOL_OFFSET) |
 320                         (((spi->mode & SPI_CPHA) ? 1 : 0) << SPI_SCPH_OFFSET) |
 321                         (((spi->mode & SPI_LOOP) ? 1 : 0) << SPI_SRL_OFFSET))
 322                 | (chip->tmode << SPI_TMOD_OFFSET);
 323
 324         /*
 325          * Adjust transfer mode if necessary. Requires platform dependent
 326          * chipselect mechanism.
 327          */
 328         if (chip->cs_control) {
 329                 if (dws->rx && dws->tx)
 330                         chip->tmode = SPI_TMOD_TR;
 331                 else if (dws->rx)
 332                         chip->tmode = SPI_TMOD_RO;
 333                 else
 334                         chip->tmode = SPI_TMOD_TO;
 335
 336                 cr0 &= ~SPI_TMOD_MASK;
 337                 cr0 |= (chip->tmode << SPI_TMOD_OFFSET);
 338         }
 339
 340         dw_writel(dws, DW_SPI_CTRL0, cr0);
 341
 342         /* Check if current transfer is a DMA transaction */
 343         if (master->can_dma && master->can_dma(master, spi, transfer))
 344                 dws->dma_mapped = master->cur_msg_mapped;
 345
 346         /* For poll mode just disable all interrupts */
 347         spi_mask_intr(dws, 0xff);
 348
 349         /*
 350          * Interrupt mode
 351          * we only need set the TXEI IRQ, as TX/RX always happen syncronizely
 352          */
 353         if (dws->dma_mapped) {
 354                 ret = dws->dma_ops->dma_setup(dws, transfer);
 355                 if (ret < 0) {
 356                         spi_enable_chip(dws, 1);
 357                         return ret;
 358                 }
 359         } else if (!chip->poll_mode) {
 360                 txlevel = min_t(u16, dws->fifo_len / 2, dws->len / dws->n_bytes);
 361                 dw_writel(dws, DW_SPI_TXFLTR, txlevel);
 362
 363                 /* Set the interrupt mask */
 364                 imask |= SPI_INT_TXEI | SPI_INT_TXOI |
 365                          SPI_INT_RXUI | SPI_INT_RXOI;
 366                 spi_umask_intr(dws, imask);
 367
 368                 dws->transfer_handler = interrupt_transfer;
 369         }
 370
 371         spi_enable_chip(dws, 1);
 372
 373         if (dws->dma_mapped) {
 374                 ret = dws->dma_ops->dma_transfer(dws, transfer);
 375                 if (ret < 0)
 376                         return ret;
 377         }
 378
 379         if (chip->poll_mode)
 380                 return poll_transfer(dws);
 381
 382         return 1;
 383 }
 384
 385 static void dw_spi_handle_err(struct spi_controller *master,
 386                 struct spi_message *msg)
 387 {
 388         struct dw_spi *dws = spi_controller_get_devdata(master);
 389
 390         if (dws->dma_mapped)
 391                 dws->dma_ops->dma_stop(dws);
 392
 393         spi_reset_chip(dws);
 394 }
 395
 396 /* This may be called twice for each spi dev */
 397 static int dw_spi_setup(struct spi_device *spi)
 398 {
 399         struct dw_spi_chip *chip_info = NULL;
 400         struct chip_data *chip;
 401
 402         /* Only alloc on first setup */
 403         chip = spi_get_ctldata(spi);
 404         if (!chip) {
 405                 chip = kzalloc(sizeof(struct chip_data), GFP_KERNEL);
 406                 if (!chip)
 407                         return -ENOMEM;
 408                 spi_set_ctldata(spi, chip);
 409         }
 410
 411         /*
 412          * Protocol drivers may change the chip settings, so...
 413          * if chip_info exists, use it
 414          */
 415         chip_info = spi->controller_data;
 416
 417         /* chip_info doesn't always exist */
 418         if (chip_info) {
 419                 if (chip_info->cs_control)
 420                         chip->cs_control = chip_info->cs_control;
 421
 422                 chip->poll_mode = chip_info->poll_mode;
 423                 chip->type = chip_info->type;
 424         }
 425
 426         chip->tmode = SPI_TMOD_TR;
 427
 428         return 0;
 429 }
 430
 431 static void dw_spi_cleanup(struct spi_device *spi)
 432 {
 433         struct chip_data *chip = spi_get_ctldata(spi);
 434
 435         kfree(chip);
 436         spi_set_ctldata(spi, NULL);
 437 }
 438
 439 /* Restart the controller, disable all interrupts, clean rx fifo */
 440 static void spi_hw_init(struct device *dev, struct dw_spi *dws)
 441 {
 442         spi_reset_chip(dws);
 443
 444         /*
 445          * Try to detect the FIFO depth if not set by interface driver,
 446          * the depth could be from 2 to 256 from HW spec
 447          */
 448         if (!dws->fifo_len) {
 449                 u32 fifo;
 450
 451                 for (fifo = 1; fifo < 256; fifo++) {
 452                         dw_writel(dws, DW_SPI_TXFLTR, fifo);
 453                         if (fifo != dw_readl(dws, DW_SPI_TXFLTR))
 454                                 break;
 455                 }
 456                 dw_writel(dws, DW_SPI_TXFLTR, 0);
 457
 458                 dws->fifo_len = (fifo == 1) ? 0 : fifo;
 459                 dev_dbg(dev, "Detected FIFO size: %u bytes\n", dws->fifo_len);
 460         }
 461
 462         /* enable HW fixup for explicit CS deselect for Amazon's alpine chip */
 463         if (dws->cs_override)
 464                 dw_writel(dws, DW_SPI_CS_OVERRIDE, 0xF);
 465 }
 466
 467 int dw_spi_add_host(struct device *dev, struct dw_spi *dws)
 468 {
 469         struct spi_controller *master;
 470         int ret;
 471
 472         BUG_ON(dws == NULL);
 473
 474         master = spi_alloc_master(dev, 0);
 475         if (!master)
 476                 return -ENOMEM;
 477
 478         dws->master = master;
 479         dws->type = SSI_MOTO_SPI;
 480         dws->dma_inited = 0;
 481         dws->dma_addr = (dma_addr_t)(dws->paddr + DW_SPI_DR);
 482         spin_lock_init(&dws->buf_lock);
 483
 484         spi_controller_set_devdata(master, dws);
 485
 486         ret = request_irq(dws->irq, dw_spi_irq, IRQF_SHARED, dev_name(dev),
 487                           master);
 488         if (ret < 0) {
 489                 dev_err(dev, "can not get IRQ\n");
 490                 goto err_free_master;
 491         }
 492
 493         master->use_gpio_descriptors = true;
 494         master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_LOOP;
 495         master->bits_per_word_mask =  SPI_BPW_RANGE_MASK(4, 16);
 496         master->bus_num = dws->bus_num;
 497         master->num_chipselect = dws->num_cs;
 498         master->setup = dw_spi_setup;
 499         master->cleanup = dw_spi_cleanup;
 500         master->set_cs = dw_spi_set_cs;
 501         master->transfer_one = dw_spi_transfer_one;
 502         master->handle_err = dw_spi_handle_err;
 503         master->max_speed_hz = dws->max_freq;
 504         master->dev.of_node = dev->of_node;
 505         master->dev.fwnode = dev->fwnode;
 506         master->flags = SPI_MASTER_GPIO_SS;
 507         master->auto_runtime_pm = true;
 508
 509         if (dws->set_cs)
 510                 master->set_cs = dws->set_cs;
 511
 512         /* Basic HW init */
 513         spi_hw_init(dev, dws);
 514
 515         if (dws->dma_ops && dws->dma_ops->dma_init) {
 516                 ret = dws->dma_ops->dma_init(dws);
 517                 if (ret) {
 518                         dev_warn(dev, "DMA init failed\n");
 519                         dws->dma_inited = 0;
 520                 } else {
 521                         master->can_dma = dws->dma_ops->can_dma;
 522                 }
 523         }
 524
 525         ret = devm_spi_register_controller(dev, master);
 526         if (ret) {
 527                 dev_err(&master->dev, "problem registering spi master\n");
 528                 goto err_dma_exit;
 529         }
 530
 531         dw_spi_debugfs_init(dws);
 532         return 0;
 533
 534 err_dma_exit:
 535         if (dws->dma_ops && dws->dma_ops->dma_exit)
 536                 dws->dma_ops->dma_exit(dws);
 537         spi_enable_chip(dws, 0);
 538         free_irq(dws->irq, master);
 539 err_free_master:
 540         spi_controller_put(master);
 541         return ret;
 542 }
 543 EXPORT_SYMBOL_GPL(dw_spi_add_host);
 544
 545 void dw_spi_remove_host(struct dw_spi *dws)
 546 {
 547         dw_spi_debugfs_remove(dws);
 548
 549         if (dws->dma_ops && dws->dma_ops->dma_exit)
 550                 dws->dma_ops->dma_exit(dws);
 551
 552         spi_shutdown_chip(dws);
 553
 554         free_irq(dws->irq, dws->master);
 555 }
 556 EXPORT_SYMBOL_GPL(dw_spi_remove_host);
 557
 558 int dw_spi_suspend_host(struct dw_spi *dws)
 559 {
 560         int ret;
 561
 562         ret = spi_controller_suspend(dws->master);
 563         if (ret)
 564                 return ret;
 565
 566         spi_shutdown_chip(dws);
 567         return 0;
 568 }
 569 EXPORT_SYMBOL_GPL(dw_spi_suspend_host);
 570
 571 int dw_spi_resume_host(struct dw_spi *dws)
 572 {
 573         spi_hw_init(&dws->master->dev, dws);
 574         return spi_controller_resume(dws->master);
 575 }
 576 EXPORT_SYMBOL_GPL(dw_spi_resume_host);
 577
 578 MODULE_AUTHOR("Feng Tang <feng.tang@intel.com>");
 579 MODULE_DESCRIPTION("Driver for DesignWare SPI controller core");
 580 MODULE_LICENSE("GPL v2");