2 * Designware SPI core controller driver (refer pxa2xx_spi.c)
4 * Copyright (c) 2009, Intel Corporation.
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.
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
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
20 #include <linux/dma-mapping.h>
21 #include <linux/interrupt.h>
22 #include <linux/module.h>
23 #include <linux/highmem.h>
24 #include <linux/delay.h>
25 #include <linux/slab.h>
26 #include <linux/spi/spi.h>
30 #ifdef CONFIG_DEBUG_FS
31 #include <linux/debugfs.h>
34 #define START_STATE ((void *)0)
35 #define RUNNING_STATE ((void *)1)
36 #define DONE_STATE ((void *)2)
37 #define ERROR_STATE ((void *)-1)
39 #define MRST_SPI_DEASSERT 0
40 #define MRST_SPI_ASSERT 1
42 /* Slave spi_dev related */
45 u8 cs; /* chip select pin */
46 u8 n_bytes; /* current is a 1/2/4 byte op */
47 u8 tmode; /* TR/TO/RO/EEPROM */
48 u8 type; /* SPI/SSP/MicroWire */
50 u8 poll_mode; /* 1 means use poll mode */
57 u16 clk_div; /* baud rate divider */
58 u32 speed_hz; /* baud rate */
59 void (*cs_control)(u32 command);
62 #ifdef CONFIG_DEBUG_FS
63 #define SPI_REGS_BUFSIZE 1024
64 static ssize_t spi_show_regs(struct file *file, char __user *user_buf,
65 size_t count, loff_t *ppos)
72 dws = file->private_data;
74 buf = kzalloc(SPI_REGS_BUFSIZE, GFP_KERNEL);
78 len += snprintf(buf + len, SPI_REGS_BUFSIZE - len,
79 "MRST SPI0 registers:\n");
80 len += snprintf(buf + len, SPI_REGS_BUFSIZE - len,
81 "=================================\n");
82 len += snprintf(buf + len, SPI_REGS_BUFSIZE - len,
83 "CTRL0: \t\t0x%08x\n", dw_readl(dws, DW_SPI_CTRL0));
84 len += snprintf(buf + len, SPI_REGS_BUFSIZE - len,
85 "CTRL1: \t\t0x%08x\n", dw_readl(dws, DW_SPI_CTRL1));
86 len += snprintf(buf + len, SPI_REGS_BUFSIZE - len,
87 "SSIENR: \t0x%08x\n", dw_readl(dws, DW_SPI_SSIENR));
88 len += snprintf(buf + len, SPI_REGS_BUFSIZE - len,
89 "SER: \t\t0x%08x\n", dw_readl(dws, DW_SPI_SER));
90 len += snprintf(buf + len, SPI_REGS_BUFSIZE - len,
91 "BAUDR: \t\t0x%08x\n", dw_readl(dws, DW_SPI_BAUDR));
92 len += snprintf(buf + len, SPI_REGS_BUFSIZE - len,
93 "TXFTLR: \t0x%08x\n", dw_readl(dws, DW_SPI_TXFLTR));
94 len += snprintf(buf + len, SPI_REGS_BUFSIZE - len,
95 "RXFTLR: \t0x%08x\n", dw_readl(dws, DW_SPI_RXFLTR));
96 len += snprintf(buf + len, SPI_REGS_BUFSIZE - len,
97 "TXFLR: \t\t0x%08x\n", dw_readl(dws, DW_SPI_TXFLR));
98 len += snprintf(buf + len, SPI_REGS_BUFSIZE - len,
99 "RXFLR: \t\t0x%08x\n", dw_readl(dws, DW_SPI_RXFLR));
100 len += snprintf(buf + len, SPI_REGS_BUFSIZE - len,
101 "SR: \t\t0x%08x\n", dw_readl(dws, DW_SPI_SR));
102 len += snprintf(buf + len, SPI_REGS_BUFSIZE - len,
103 "IMR: \t\t0x%08x\n", dw_readl(dws, DW_SPI_IMR));
104 len += snprintf(buf + len, SPI_REGS_BUFSIZE - len,
105 "ISR: \t\t0x%08x\n", dw_readl(dws, DW_SPI_ISR));
106 len += snprintf(buf + len, SPI_REGS_BUFSIZE - len,
107 "DMACR: \t\t0x%08x\n", dw_readl(dws, DW_SPI_DMACR));
108 len += snprintf(buf + len, SPI_REGS_BUFSIZE - len,
109 "DMATDLR: \t0x%08x\n", dw_readl(dws, DW_SPI_DMATDLR));
110 len += snprintf(buf + len, SPI_REGS_BUFSIZE - len,
111 "DMARDLR: \t0x%08x\n", dw_readl(dws, DW_SPI_DMARDLR));
112 len += snprintf(buf + len, SPI_REGS_BUFSIZE - len,
113 "=================================\n");
115 ret = simple_read_from_buffer(user_buf, count, ppos, buf, len);
120 static const struct file_operations mrst_spi_regs_ops = {
121 .owner = THIS_MODULE,
123 .read = spi_show_regs,
124 .llseek = default_llseek,
127 static int mrst_spi_debugfs_init(struct dw_spi *dws)
129 dws->debugfs = debugfs_create_dir("mrst_spi", NULL);
133 debugfs_create_file("registers", S_IFREG | S_IRUGO,
134 dws->debugfs, (void *)dws, &mrst_spi_regs_ops);
138 static void mrst_spi_debugfs_remove(struct dw_spi *dws)
141 debugfs_remove_recursive(dws->debugfs);
145 static inline int mrst_spi_debugfs_init(struct dw_spi *dws)
150 static inline void mrst_spi_debugfs_remove(struct dw_spi *dws)
153 #endif /* CONFIG_DEBUG_FS */
155 /* Return the max entries we can fill into tx fifo */
156 static inline u32 tx_max(struct dw_spi *dws)
158 u32 tx_left, tx_room, rxtx_gap;
160 tx_left = (dws->tx_end - dws->tx) / dws->n_bytes;
161 tx_room = dws->fifo_len - dw_readw(dws, DW_SPI_TXFLR);
164 * Another concern is about the tx/rx mismatch, we
165 * though to use (dws->fifo_len - rxflr - txflr) as
166 * one maximum value for tx, but it doesn't cover the
167 * data which is out of tx/rx fifo and inside the
168 * shift registers. So a control from sw point of
171 rxtx_gap = ((dws->rx_end - dws->rx) - (dws->tx_end - dws->tx))
174 return min3(tx_left, tx_room, (u32) (dws->fifo_len - rxtx_gap));
177 /* Return the max entries we should read out of rx fifo */
178 static inline u32 rx_max(struct dw_spi *dws)
180 u32 rx_left = (dws->rx_end - dws->rx) / dws->n_bytes;
182 return min(rx_left, (u32)dw_readw(dws, DW_SPI_RXFLR));
185 static void dw_writer(struct dw_spi *dws)
187 u32 max = tx_max(dws);
191 /* Set the tx word if the transfer's original "tx" is not null */
192 if (dws->tx_end - dws->len) {
193 if (dws->n_bytes == 1)
194 txw = *(u8 *)(dws->tx);
196 txw = *(u16 *)(dws->tx);
198 dw_writew(dws, DW_SPI_DR, txw);
199 dws->tx += dws->n_bytes;
203 static void dw_reader(struct dw_spi *dws)
205 u32 max = rx_max(dws);
209 rxw = dw_readw(dws, DW_SPI_DR);
210 /* Care rx only if the transfer's original "rx" is not null */
211 if (dws->rx_end - dws->len) {
212 if (dws->n_bytes == 1)
213 *(u8 *)(dws->rx) = rxw;
215 *(u16 *)(dws->rx) = rxw;
217 dws->rx += dws->n_bytes;
221 static void *next_transfer(struct dw_spi *dws)
223 struct spi_message *msg = dws->cur_msg;
224 struct spi_transfer *trans = dws->cur_transfer;
226 /* Move to next transfer */
227 if (trans->transfer_list.next != &msg->transfers) {
229 list_entry(trans->transfer_list.next,
232 return RUNNING_STATE;
238 * Note: first step is the protocol driver prepares
239 * a dma-capable memory, and this func just need translate
240 * the virt addr to physical
242 static int map_dma_buffers(struct dw_spi *dws)
244 if (!dws->cur_msg->is_dma_mapped
246 || !dws->cur_chip->enable_dma
250 if (dws->cur_transfer->tx_dma)
251 dws->tx_dma = dws->cur_transfer->tx_dma;
253 if (dws->cur_transfer->rx_dma)
254 dws->rx_dma = dws->cur_transfer->rx_dma;
259 /* Caller already set message->status; dma and pio irqs are blocked */
260 static void giveback(struct dw_spi *dws)
262 struct spi_transfer *last_transfer;
263 struct spi_message *msg;
267 dws->cur_transfer = NULL;
268 dws->prev_chip = dws->cur_chip;
269 dws->cur_chip = NULL;
272 last_transfer = list_last_entry(&msg->transfers, struct spi_transfer,
275 if (!last_transfer->cs_change && dws->cs_control)
276 dws->cs_control(MRST_SPI_DEASSERT);
278 spi_finalize_current_message(dws->master);
281 static void int_error_stop(struct dw_spi *dws, const char *msg)
284 spi_enable_chip(dws, 0);
286 dev_err(&dws->master->dev, "%s\n", msg);
287 dws->cur_msg->state = ERROR_STATE;
288 tasklet_schedule(&dws->pump_transfers);
291 void dw_spi_xfer_done(struct dw_spi *dws)
293 /* Update total byte transferred return count actual bytes read */
294 dws->cur_msg->actual_length += dws->len;
296 /* Move to next transfer */
297 dws->cur_msg->state = next_transfer(dws);
299 /* Handle end of message */
300 if (dws->cur_msg->state == DONE_STATE) {
301 dws->cur_msg->status = 0;
304 tasklet_schedule(&dws->pump_transfers);
306 EXPORT_SYMBOL_GPL(dw_spi_xfer_done);
308 static irqreturn_t interrupt_transfer(struct dw_spi *dws)
310 u16 irq_status = dw_readw(dws, DW_SPI_ISR);
313 if (irq_status & (SPI_INT_TXOI | SPI_INT_RXOI | SPI_INT_RXUI)) {
314 dw_readw(dws, DW_SPI_TXOICR);
315 dw_readw(dws, DW_SPI_RXOICR);
316 dw_readw(dws, DW_SPI_RXUICR);
317 int_error_stop(dws, "interrupt_transfer: fifo overrun/underrun");
322 if (dws->rx_end == dws->rx) {
323 spi_mask_intr(dws, SPI_INT_TXEI);
324 dw_spi_xfer_done(dws);
327 if (irq_status & SPI_INT_TXEI) {
328 spi_mask_intr(dws, SPI_INT_TXEI);
330 /* Enable TX irq always, it will be disabled when RX finished */
331 spi_umask_intr(dws, SPI_INT_TXEI);
337 static irqreturn_t dw_spi_irq(int irq, void *dev_id)
339 struct dw_spi *dws = dev_id;
340 u16 irq_status = dw_readw(dws, DW_SPI_ISR) & 0x3f;
346 spi_mask_intr(dws, SPI_INT_TXEI);
350 return dws->transfer_handler(dws);
353 /* Must be called inside pump_transfers() */
354 static void poll_transfer(struct dw_spi *dws)
360 } while (dws->rx_end > dws->rx);
362 dw_spi_xfer_done(dws);
365 static void pump_transfers(unsigned long data)
367 struct dw_spi *dws = (struct dw_spi *)data;
368 struct spi_message *message = NULL;
369 struct spi_transfer *transfer = NULL;
370 struct spi_transfer *previous = NULL;
371 struct spi_device *spi = NULL;
372 struct chip_data *chip = NULL;
381 /* Get current state information */
382 message = dws->cur_msg;
383 transfer = dws->cur_transfer;
384 chip = dws->cur_chip;
387 if (unlikely(!chip->clk_div))
388 chip->clk_div = dws->max_freq / chip->speed_hz;
390 if (message->state == ERROR_STATE) {
391 message->status = -EIO;
395 /* Handle end of message */
396 if (message->state == DONE_STATE) {
401 /* Delay if requested at end of transfer*/
402 if (message->state == RUNNING_STATE) {
403 previous = list_entry(transfer->transfer_list.prev,
406 if (previous->delay_usecs)
407 udelay(previous->delay_usecs);
410 dws->n_bytes = chip->n_bytes;
411 dws->dma_width = chip->dma_width;
412 dws->cs_control = chip->cs_control;
414 dws->rx_dma = transfer->rx_dma;
415 dws->tx_dma = transfer->tx_dma;
416 dws->tx = (void *)transfer->tx_buf;
417 dws->tx_end = dws->tx + transfer->len;
418 dws->rx = transfer->rx_buf;
419 dws->rx_end = dws->rx + transfer->len;
420 dws->len = dws->cur_transfer->len;
421 if (chip != dws->prev_chip)
426 /* Handle per transfer options for bpw and speed */
427 if (transfer->speed_hz) {
428 speed = chip->speed_hz;
430 if (transfer->speed_hz != speed) {
431 speed = transfer->speed_hz;
433 /* clk_div doesn't support odd number */
434 clk_div = dws->max_freq / speed;
435 clk_div = (clk_div + 1) & 0xfffe;
437 chip->speed_hz = speed;
438 chip->clk_div = clk_div;
441 if (transfer->bits_per_word) {
442 bits = transfer->bits_per_word;
443 dws->n_bytes = dws->dma_width = bits >> 3;
445 | (chip->type << SPI_FRF_OFFSET)
446 | (spi->mode << SPI_MODE_OFFSET)
447 | (chip->tmode << SPI_TMOD_OFFSET);
449 message->state = RUNNING_STATE;
452 * Adjust transfer mode if necessary. Requires platform dependent
453 * chipselect mechanism.
455 if (dws->cs_control) {
456 if (dws->rx && dws->tx)
457 chip->tmode = SPI_TMOD_TR;
459 chip->tmode = SPI_TMOD_RO;
461 chip->tmode = SPI_TMOD_TO;
463 cr0 &= ~SPI_TMOD_MASK;
464 cr0 |= (chip->tmode << SPI_TMOD_OFFSET);
467 /* Check if current transfer is a DMA transaction */
468 dws->dma_mapped = map_dma_buffers(dws);
472 * we only need set the TXEI IRQ, as TX/RX always happen syncronizely
474 if (!dws->dma_mapped && !chip->poll_mode) {
475 int templen = dws->len / dws->n_bytes;
476 txint_level = dws->fifo_len / 2;
477 txint_level = (templen > txint_level) ? txint_level : templen;
479 imask |= SPI_INT_TXEI | SPI_INT_TXOI | SPI_INT_RXUI | SPI_INT_RXOI;
480 dws->transfer_handler = interrupt_transfer;
484 * Reprogram registers only if
485 * 1. chip select changes
486 * 2. clk_div is changed
487 * 3. control value changes
489 if (dw_readw(dws, DW_SPI_CTRL0) != cr0 || cs_change || clk_div || imask) {
490 spi_enable_chip(dws, 0);
492 if (dw_readw(dws, DW_SPI_CTRL0) != cr0)
493 dw_writew(dws, DW_SPI_CTRL0, cr0);
495 spi_set_clk(dws, clk_div ? clk_div : chip->clk_div);
496 spi_chip_sel(dws, spi->chip_select);
498 /* Set the interrupt mask, for poll mode just disable all int */
499 spi_mask_intr(dws, 0xff);
501 spi_umask_intr(dws, imask);
503 dw_writew(dws, DW_SPI_TXFLTR, txint_level);
505 spi_enable_chip(dws, 1);
507 dws->prev_chip = chip;
511 dws->dma_ops->dma_transfer(dws, cs_change);
523 static int dw_spi_transfer_one_message(struct spi_master *master,
524 struct spi_message *msg)
526 struct dw_spi *dws = spi_master_get_devdata(master);
529 /* Initial message state*/
530 dws->cur_msg->state = START_STATE;
531 dws->cur_transfer = list_entry(dws->cur_msg->transfers.next,
534 dws->cur_chip = spi_get_ctldata(dws->cur_msg->spi);
536 /* Launch transfers */
537 tasklet_schedule(&dws->pump_transfers);
542 /* This may be called twice for each spi dev */
543 static int dw_spi_setup(struct spi_device *spi)
545 struct dw_spi_chip *chip_info = NULL;
546 struct chip_data *chip;
548 /* Only alloc on first setup */
549 chip = spi_get_ctldata(spi);
551 chip = devm_kzalloc(&spi->dev, sizeof(struct chip_data),
555 spi_set_ctldata(spi, chip);
559 * Protocol drivers may change the chip settings, so...
560 * if chip_info exists, use it
562 chip_info = spi->controller_data;
564 /* chip_info doesn't always exist */
566 if (chip_info->cs_control)
567 chip->cs_control = chip_info->cs_control;
569 chip->poll_mode = chip_info->poll_mode;
570 chip->type = chip_info->type;
572 chip->rx_threshold = 0;
573 chip->tx_threshold = 0;
575 chip->enable_dma = chip_info->enable_dma;
578 if (spi->bits_per_word == 8) {
581 } else if (spi->bits_per_word == 16) {
585 chip->bits_per_word = spi->bits_per_word;
587 if (!spi->max_speed_hz) {
588 dev_err(&spi->dev, "No max speed HZ parameter\n");
591 chip->speed_hz = spi->max_speed_hz;
593 chip->tmode = 0; /* Tx & Rx */
594 /* Default SPI mode is SCPOL = 0, SCPH = 0 */
595 chip->cr0 = (chip->bits_per_word - 1)
596 | (chip->type << SPI_FRF_OFFSET)
597 | (spi->mode << SPI_MODE_OFFSET)
598 | (chip->tmode << SPI_TMOD_OFFSET);
603 static void dw_spi_cleanup(struct spi_device *spi)
605 struct chip_data *chip = spi_get_ctldata(spi);
609 /* Restart the controller, disable all interrupts, clean rx fifo */
610 static void spi_hw_init(struct dw_spi *dws)
612 spi_enable_chip(dws, 0);
613 spi_mask_intr(dws, 0xff);
614 spi_enable_chip(dws, 1);
617 * Try to detect the FIFO depth if not set by interface driver,
618 * the depth could be from 2 to 256 from HW spec
620 if (!dws->fifo_len) {
622 for (fifo = 2; fifo <= 257; fifo++) {
623 dw_writew(dws, DW_SPI_TXFLTR, fifo);
624 if (fifo != dw_readw(dws, DW_SPI_TXFLTR))
628 dws->fifo_len = (fifo == 257) ? 0 : fifo;
629 dw_writew(dws, DW_SPI_TXFLTR, 0);
633 int dw_spi_add_host(struct device *dev, struct dw_spi *dws)
635 struct spi_master *master;
640 master = spi_alloc_master(dev, 0);
644 dws->master = master;
645 dws->type = SSI_MOTO_SPI;
646 dws->prev_chip = NULL;
648 dws->dma_addr = (dma_addr_t)(dws->paddr + 0x60);
649 snprintf(dws->name, sizeof(dws->name), "dw_spi%d",
652 ret = devm_request_irq(dev, dws->irq, dw_spi_irq, IRQF_SHARED,
655 dev_err(&master->dev, "can not get IRQ\n");
656 goto err_free_master;
659 master->mode_bits = SPI_CPOL | SPI_CPHA;
660 master->bits_per_word_mask = SPI_BPW_MASK(8) | SPI_BPW_MASK(16);
661 master->bus_num = dws->bus_num;
662 master->num_chipselect = dws->num_cs;
663 master->setup = dw_spi_setup;
664 master->transfer_one_message = dw_spi_transfer_one_message;
665 master->max_speed_hz = dws->max_freq;
670 if (dws->dma_ops && dws->dma_ops->dma_init) {
671 ret = dws->dma_ops->dma_init(dws);
673 dev_warn(&master->dev, "DMA init failed\n");
678 tasklet_init(&dws->pump_transfers, pump_transfers, (unsigned long)dws);
680 spi_master_set_devdata(master, dws);
681 ret = devm_spi_register_master(dev, master);
683 dev_err(&master->dev, "problem registering spi master\n");
687 mrst_spi_debugfs_init(dws);
691 if (dws->dma_ops && dws->dma_ops->dma_exit)
692 dws->dma_ops->dma_exit(dws);
693 spi_enable_chip(dws, 0);
695 spi_master_put(master);
698 EXPORT_SYMBOL_GPL(dw_spi_add_host);
700 void dw_spi_remove_host(struct dw_spi *dws)
704 mrst_spi_debugfs_remove(dws);
706 if (dws->dma_ops && dws->dma_ops->dma_exit)
707 dws->dma_ops->dma_exit(dws);
708 spi_enable_chip(dws, 0);
712 EXPORT_SYMBOL_GPL(dw_spi_remove_host);
714 int dw_spi_suspend_host(struct dw_spi *dws)
718 ret = spi_master_suspend(dws->master);
721 spi_enable_chip(dws, 0);
725 EXPORT_SYMBOL_GPL(dw_spi_suspend_host);
727 int dw_spi_resume_host(struct dw_spi *dws)
732 ret = spi_master_resume(dws->master);
734 dev_err(&dws->master->dev, "fail to start queue (%d)\n", ret);
737 EXPORT_SYMBOL_GPL(dw_spi_resume_host);
739 MODULE_AUTHOR("Feng Tang <feng.tang@intel.com>");
740 MODULE_DESCRIPTION("Driver for DesignWare SPI controller core");
741 MODULE_LICENSE("GPL v2");