drivers/spi/spi-dw.c

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