2 * Copyright (c) 2008-2014, The Linux foundation. All rights reserved.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License rev 2 and
6 * only rev 2 as published by the free Software foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or fITNESS fOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
14 #include <linux/clk.h>
15 #include <linux/delay.h>
16 #include <linux/err.h>
17 #include <linux/interrupt.h>
19 #include <linux/list.h>
20 #include <linux/module.h>
22 #include <linux/platform_device.h>
23 #include <linux/pm_runtime.h>
24 #include <linux/spi/spi.h>
25 #include <linux/dmaengine.h>
26 #include <linux/dma-mapping.h>
28 #define QUP_CONFIG 0x0000
29 #define QUP_STATE 0x0004
30 #define QUP_IO_M_MODES 0x0008
31 #define QUP_SW_RESET 0x000c
32 #define QUP_OPERATIONAL 0x0018
33 #define QUP_ERROR_FLAGS 0x001c
34 #define QUP_ERROR_FLAGS_EN 0x0020
35 #define QUP_OPERATIONAL_MASK 0x0028
36 #define QUP_HW_VERSION 0x0030
37 #define QUP_MX_OUTPUT_CNT 0x0100
38 #define QUP_OUTPUT_FIFO 0x0110
39 #define QUP_MX_WRITE_CNT 0x0150
40 #define QUP_MX_INPUT_CNT 0x0200
41 #define QUP_MX_READ_CNT 0x0208
42 #define QUP_INPUT_FIFO 0x0218
44 #define SPI_CONFIG 0x0300
45 #define SPI_IO_CONTROL 0x0304
46 #define SPI_ERROR_FLAGS 0x0308
47 #define SPI_ERROR_FLAGS_EN 0x030c
49 /* QUP_CONFIG fields */
50 #define QUP_CONFIG_SPI_MODE (1 << 8)
51 #define QUP_CONFIG_CLOCK_AUTO_GATE BIT(13)
52 #define QUP_CONFIG_NO_INPUT BIT(7)
53 #define QUP_CONFIG_NO_OUTPUT BIT(6)
54 #define QUP_CONFIG_N 0x001f
56 /* QUP_STATE fields */
57 #define QUP_STATE_VALID BIT(2)
58 #define QUP_STATE_RESET 0
59 #define QUP_STATE_RUN 1
60 #define QUP_STATE_PAUSE 3
61 #define QUP_STATE_MASK 3
62 #define QUP_STATE_CLEAR 2
64 #define QUP_HW_VERSION_2_1_1 0x20010001
66 /* QUP_IO_M_MODES fields */
67 #define QUP_IO_M_PACK_EN BIT(15)
68 #define QUP_IO_M_UNPACK_EN BIT(14)
69 #define QUP_IO_M_INPUT_MODE_MASK_SHIFT 12
70 #define QUP_IO_M_OUTPUT_MODE_MASK_SHIFT 10
71 #define QUP_IO_M_INPUT_MODE_MASK (3 << QUP_IO_M_INPUT_MODE_MASK_SHIFT)
72 #define QUP_IO_M_OUTPUT_MODE_MASK (3 << QUP_IO_M_OUTPUT_MODE_MASK_SHIFT)
74 #define QUP_IO_M_OUTPUT_BLOCK_SIZE(x) (((x) & (0x03 << 0)) >> 0)
75 #define QUP_IO_M_OUTPUT_FIFO_SIZE(x) (((x) & (0x07 << 2)) >> 2)
76 #define QUP_IO_M_INPUT_BLOCK_SIZE(x) (((x) & (0x03 << 5)) >> 5)
77 #define QUP_IO_M_INPUT_FIFO_SIZE(x) (((x) & (0x07 << 7)) >> 7)
79 #define QUP_IO_M_MODE_FIFO 0
80 #define QUP_IO_M_MODE_BLOCK 1
81 #define QUP_IO_M_MODE_DMOV 2
82 #define QUP_IO_M_MODE_BAM 3
84 /* QUP_OPERATIONAL fields */
85 #define QUP_OP_IN_BLOCK_READ_REQ BIT(13)
86 #define QUP_OP_OUT_BLOCK_WRITE_REQ BIT(12)
87 #define QUP_OP_MAX_INPUT_DONE_FLAG BIT(11)
88 #define QUP_OP_MAX_OUTPUT_DONE_FLAG BIT(10)
89 #define QUP_OP_IN_SERVICE_FLAG BIT(9)
90 #define QUP_OP_OUT_SERVICE_FLAG BIT(8)
91 #define QUP_OP_IN_FIFO_FULL BIT(7)
92 #define QUP_OP_OUT_FIFO_FULL BIT(6)
93 #define QUP_OP_IN_FIFO_NOT_EMPTY BIT(5)
94 #define QUP_OP_OUT_FIFO_NOT_EMPTY BIT(4)
96 /* QUP_ERROR_FLAGS and QUP_ERROR_FLAGS_EN fields */
97 #define QUP_ERROR_OUTPUT_OVER_RUN BIT(5)
98 #define QUP_ERROR_INPUT_UNDER_RUN BIT(4)
99 #define QUP_ERROR_OUTPUT_UNDER_RUN BIT(3)
100 #define QUP_ERROR_INPUT_OVER_RUN BIT(2)
102 /* SPI_CONFIG fields */
103 #define SPI_CONFIG_HS_MODE BIT(10)
104 #define SPI_CONFIG_INPUT_FIRST BIT(9)
105 #define SPI_CONFIG_LOOPBACK BIT(8)
107 /* SPI_IO_CONTROL fields */
108 #define SPI_IO_C_FORCE_CS BIT(11)
109 #define SPI_IO_C_CLK_IDLE_HIGH BIT(10)
110 #define SPI_IO_C_MX_CS_MODE BIT(8)
111 #define SPI_IO_C_CS_N_POLARITY_0 BIT(4)
112 #define SPI_IO_C_CS_SELECT(x) (((x) & 3) << 2)
113 #define SPI_IO_C_CS_SELECT_MASK 0x000c
114 #define SPI_IO_C_TRISTATE_CS BIT(1)
115 #define SPI_IO_C_NO_TRI_STATE BIT(0)
117 /* SPI_ERROR_FLAGS and SPI_ERROR_FLAGS_EN fields */
118 #define SPI_ERROR_CLK_OVER_RUN BIT(1)
119 #define SPI_ERROR_CLK_UNDER_RUN BIT(0)
121 #define SPI_NUM_CHIPSELECTS 4
123 #define SPI_MAX_DMA_XFER (SZ_64K - 64)
125 /* high speed mode is when bus rate is greater then 26MHz */
126 #define SPI_HS_MIN_RATE 26000000
127 #define SPI_MAX_RATE 50000000
129 #define SPI_DELAY_THRESHOLD 1
130 #define SPI_DELAY_RETRY 10
135 struct clk *cclk; /* core clock */
136 struct clk *iclk; /* interface clock */
145 struct spi_transfer *xfer;
146 struct completion done;
148 int w_size; /* bytes per SPI word */
155 struct dma_slave_config rx_conf;
156 struct dma_slave_config tx_conf;
159 static int spi_qup_io_config(struct spi_device *spi, struct spi_transfer *xfer);
161 static inline bool spi_qup_is_flag_set(struct spi_qup *controller, u32 flag)
163 u32 opflag = readl_relaxed(controller->base + QUP_OPERATIONAL);
165 return (opflag & flag) != 0;
168 static inline bool spi_qup_is_dma_xfer(int mode)
170 if (mode == QUP_IO_M_MODE_DMOV || mode == QUP_IO_M_MODE_BAM)
176 static inline bool spi_qup_is_valid_state(struct spi_qup *controller)
178 u32 opstate = readl_relaxed(controller->base + QUP_STATE);
180 return opstate & QUP_STATE_VALID;
183 static int spi_qup_set_state(struct spi_qup *controller, u32 state)
189 while (!spi_qup_is_valid_state(controller)) {
191 usleep_range(SPI_DELAY_THRESHOLD, SPI_DELAY_THRESHOLD * 2);
193 if (++loop > SPI_DELAY_RETRY)
198 dev_dbg(controller->dev, "invalid state for %ld,us %d\n",
201 cur_state = readl_relaxed(controller->base + QUP_STATE);
203 * Per spec: for PAUSE_STATE to RESET_STATE, two writes
204 * of (b10) are required
206 if (((cur_state & QUP_STATE_MASK) == QUP_STATE_PAUSE) &&
207 (state == QUP_STATE_RESET)) {
208 writel_relaxed(QUP_STATE_CLEAR, controller->base + QUP_STATE);
209 writel_relaxed(QUP_STATE_CLEAR, controller->base + QUP_STATE);
211 cur_state &= ~QUP_STATE_MASK;
213 writel_relaxed(cur_state, controller->base + QUP_STATE);
217 while (!spi_qup_is_valid_state(controller)) {
219 usleep_range(SPI_DELAY_THRESHOLD, SPI_DELAY_THRESHOLD * 2);
221 if (++loop > SPI_DELAY_RETRY)
228 static void spi_qup_read_from_fifo(struct spi_qup *controller,
229 struct spi_transfer *xfer, u32 num_words)
231 u8 *rx_buf = xfer->rx_buf;
232 int i, shift, num_bytes;
235 for (; num_words; num_words--) {
237 word = readl_relaxed(controller->base + QUP_INPUT_FIFO);
239 num_bytes = min_t(int, xfer->len - controller->rx_bytes,
243 controller->rx_bytes += num_bytes;
247 for (i = 0; i < num_bytes; i++, controller->rx_bytes++) {
249 * The data format depends on bytes per SPI word:
250 * 4 bytes: 0x12345678
251 * 2 bytes: 0x00001234
252 * 1 byte : 0x00000012
254 shift = BITS_PER_BYTE;
255 shift *= (controller->w_size - i - 1);
256 rx_buf[controller->rx_bytes] = word >> shift;
261 static void spi_qup_read(struct spi_qup *controller,
262 struct spi_transfer *xfer)
264 u32 remainder, words_per_block, num_words;
265 bool is_block_mode = controller->mode == QUP_IO_M_MODE_BLOCK;
267 remainder = DIV_ROUND_UP(xfer->len - controller->rx_bytes,
269 words_per_block = controller->in_blk_sz >> 2;
272 /* ACK by clearing service flag */
273 writel_relaxed(QUP_OP_IN_SERVICE_FLAG,
274 controller->base + QUP_OPERATIONAL);
277 num_words = (remainder > words_per_block) ?
278 words_per_block : remainder;
280 if (!spi_qup_is_flag_set(controller,
281 QUP_OP_IN_FIFO_NOT_EMPTY))
287 /* read up to the maximum transfer size available */
288 spi_qup_read_from_fifo(controller, xfer, num_words);
290 remainder -= num_words;
292 /* if block mode, check to see if next block is available */
293 if (is_block_mode && !spi_qup_is_flag_set(controller,
294 QUP_OP_IN_BLOCK_READ_REQ))
300 * Due to extra stickiness of the QUP_OP_IN_SERVICE_FLAG during block
301 * mode reads, it has to be cleared again at the very end
303 if (is_block_mode && spi_qup_is_flag_set(controller,
304 QUP_OP_MAX_INPUT_DONE_FLAG))
305 writel_relaxed(QUP_OP_IN_SERVICE_FLAG,
306 controller->base + QUP_OPERATIONAL);
310 static void spi_qup_write_to_fifo(struct spi_qup *controller,
311 struct spi_transfer *xfer, u32 num_words)
313 const u8 *tx_buf = xfer->tx_buf;
317 for (; num_words; num_words--) {
320 num_bytes = min_t(int, xfer->len - controller->tx_bytes,
323 for (i = 0; i < num_bytes; i++) {
324 data = tx_buf[controller->tx_bytes + i];
325 word |= data << (BITS_PER_BYTE * (3 - i));
328 controller->tx_bytes += num_bytes;
330 writel_relaxed(word, controller->base + QUP_OUTPUT_FIFO);
334 static void spi_qup_dma_done(void *data)
336 struct spi_qup *qup = data;
338 complete(&qup->done);
341 static void spi_qup_write(struct spi_qup *controller,
342 struct spi_transfer *xfer)
344 bool is_block_mode = controller->mode == QUP_IO_M_MODE_BLOCK;
345 u32 remainder, words_per_block, num_words;
347 remainder = DIV_ROUND_UP(xfer->len - controller->tx_bytes,
349 words_per_block = controller->out_blk_sz >> 2;
352 /* ACK by clearing service flag */
353 writel_relaxed(QUP_OP_OUT_SERVICE_FLAG,
354 controller->base + QUP_OPERATIONAL);
357 num_words = (remainder > words_per_block) ?
358 words_per_block : remainder;
360 if (spi_qup_is_flag_set(controller,
361 QUP_OP_OUT_FIFO_FULL))
367 spi_qup_write_to_fifo(controller, xfer, num_words);
369 remainder -= num_words;
371 /* if block mode, check to see if next block is available */
372 if (is_block_mode && !spi_qup_is_flag_set(controller,
373 QUP_OP_OUT_BLOCK_WRITE_REQ))
379 static int spi_qup_prep_sg(struct spi_master *master, struct spi_transfer *xfer,
380 enum dma_transfer_direction dir,
381 dma_async_tx_callback callback)
383 struct spi_qup *qup = spi_master_get_devdata(master);
384 unsigned long flags = DMA_PREP_INTERRUPT | DMA_PREP_FENCE;
385 struct dma_async_tx_descriptor *desc;
386 struct scatterlist *sgl;
387 struct dma_chan *chan;
391 if (dir == DMA_MEM_TO_DEV) {
392 chan = master->dma_tx;
393 nents = xfer->tx_sg.nents;
394 sgl = xfer->tx_sg.sgl;
396 chan = master->dma_rx;
397 nents = xfer->rx_sg.nents;
398 sgl = xfer->rx_sg.sgl;
401 desc = dmaengine_prep_slave_sg(chan, sgl, nents, dir, flags);
402 if (IS_ERR_OR_NULL(desc))
403 return desc ? PTR_ERR(desc) : -EINVAL;
405 desc->callback = callback;
406 desc->callback_param = qup;
408 cookie = dmaengine_submit(desc);
410 return dma_submit_error(cookie);
413 static void spi_qup_dma_terminate(struct spi_master *master,
414 struct spi_transfer *xfer)
417 dmaengine_terminate_all(master->dma_tx);
419 dmaengine_terminate_all(master->dma_rx);
422 static int spi_qup_do_dma(struct spi_device *spi, struct spi_transfer *xfer,
423 unsigned long timeout)
425 dma_async_tx_callback rx_done = NULL, tx_done = NULL;
426 struct spi_master *master = spi->master;
427 struct spi_qup *qup = spi_master_get_devdata(master);
431 rx_done = spi_qup_dma_done;
432 else if (xfer->tx_buf)
433 tx_done = spi_qup_dma_done;
435 ret = spi_qup_io_config(spi, xfer);
439 /* before issuing the descriptors, set the QUP to run */
440 ret = spi_qup_set_state(qup, QUP_STATE_RUN);
442 dev_warn(qup->dev, "%s(%d): cannot set RUN state\n",
448 ret = spi_qup_prep_sg(master, xfer, DMA_DEV_TO_MEM, rx_done);
452 dma_async_issue_pending(master->dma_rx);
456 ret = spi_qup_prep_sg(master, xfer, DMA_MEM_TO_DEV, tx_done);
460 dma_async_issue_pending(master->dma_tx);
463 if (!wait_for_completion_timeout(&qup->done, timeout))
469 static int spi_qup_do_pio(struct spi_device *spi, struct spi_transfer *xfer,
470 unsigned long timeout)
472 struct spi_master *master = spi->master;
473 struct spi_qup *qup = spi_master_get_devdata(master);
476 ret = spi_qup_io_config(spi, xfer);
480 ret = spi_qup_set_state(qup, QUP_STATE_RUN);
482 dev_warn(qup->dev, "cannot set RUN state\n");
486 ret = spi_qup_set_state(qup, QUP_STATE_PAUSE);
488 dev_warn(qup->dev, "cannot set PAUSE state\n");
492 if (qup->mode == QUP_IO_M_MODE_FIFO)
493 spi_qup_write(qup, xfer);
495 ret = spi_qup_set_state(qup, QUP_STATE_RUN);
497 dev_warn(qup->dev, "%s(%d): cannot set RUN state\n",
502 if (!wait_for_completion_timeout(&qup->done, timeout))
508 static irqreturn_t spi_qup_qup_irq(int irq, void *dev_id)
510 struct spi_qup *controller = dev_id;
511 struct spi_transfer *xfer = controller->xfer;
512 u32 opflags, qup_err, spi_err;
515 qup_err = readl_relaxed(controller->base + QUP_ERROR_FLAGS);
516 spi_err = readl_relaxed(controller->base + SPI_ERROR_FLAGS);
517 opflags = readl_relaxed(controller->base + QUP_OPERATIONAL);
519 writel_relaxed(qup_err, controller->base + QUP_ERROR_FLAGS);
520 writel_relaxed(spi_err, controller->base + SPI_ERROR_FLAGS);
523 if (qup_err & QUP_ERROR_OUTPUT_OVER_RUN)
524 dev_warn(controller->dev, "OUTPUT_OVER_RUN\n");
525 if (qup_err & QUP_ERROR_INPUT_UNDER_RUN)
526 dev_warn(controller->dev, "INPUT_UNDER_RUN\n");
527 if (qup_err & QUP_ERROR_OUTPUT_UNDER_RUN)
528 dev_warn(controller->dev, "OUTPUT_UNDER_RUN\n");
529 if (qup_err & QUP_ERROR_INPUT_OVER_RUN)
530 dev_warn(controller->dev, "INPUT_OVER_RUN\n");
536 if (spi_err & SPI_ERROR_CLK_OVER_RUN)
537 dev_warn(controller->dev, "CLK_OVER_RUN\n");
538 if (spi_err & SPI_ERROR_CLK_UNDER_RUN)
539 dev_warn(controller->dev, "CLK_UNDER_RUN\n");
544 if (spi_qup_is_dma_xfer(controller->mode)) {
545 writel_relaxed(opflags, controller->base + QUP_OPERATIONAL);
547 if (opflags & QUP_OP_IN_SERVICE_FLAG)
548 spi_qup_read(controller, xfer);
550 if (opflags & QUP_OP_OUT_SERVICE_FLAG)
551 spi_qup_write(controller, xfer);
554 if ((opflags & QUP_OP_MAX_INPUT_DONE_FLAG) || error)
555 complete(&controller->done);
560 /* set clock freq ... bits per word, determine mode */
561 static int spi_qup_io_prep(struct spi_device *spi, struct spi_transfer *xfer)
563 struct spi_qup *controller = spi_master_get_devdata(spi->master);
566 if (spi->mode & SPI_LOOP && xfer->len > controller->in_fifo_sz) {
567 dev_err(controller->dev, "too big size for loopback %d > %d\n",
568 xfer->len, controller->in_fifo_sz);
572 ret = clk_set_rate(controller->cclk, xfer->speed_hz);
574 dev_err(controller->dev, "fail to set frequency %d",
579 controller->w_size = DIV_ROUND_UP(xfer->bits_per_word, 8);
580 controller->n_words = xfer->len / controller->w_size;
582 if (controller->n_words <= (controller->in_fifo_sz / sizeof(u32)))
583 controller->mode = QUP_IO_M_MODE_FIFO;
584 else if (spi->master->can_dma &&
585 spi->master->can_dma(spi->master, spi, xfer) &&
586 spi->master->cur_msg_mapped)
587 controller->mode = QUP_IO_M_MODE_BAM;
589 controller->mode = QUP_IO_M_MODE_BLOCK;
594 /* prep qup for another spi transaction of specific type */
595 static int spi_qup_io_config(struct spi_device *spi, struct spi_transfer *xfer)
597 struct spi_qup *controller = spi_master_get_devdata(spi->master);
598 u32 config, iomode, control;
601 spin_lock_irqsave(&controller->lock, flags);
602 controller->xfer = xfer;
603 controller->error = 0;
604 controller->rx_bytes = 0;
605 controller->tx_bytes = 0;
606 spin_unlock_irqrestore(&controller->lock, flags);
609 if (spi_qup_set_state(controller, QUP_STATE_RESET)) {
610 dev_err(controller->dev, "cannot set RESET state\n");
614 switch (controller->mode) {
615 case QUP_IO_M_MODE_FIFO:
616 writel_relaxed(controller->n_words,
617 controller->base + QUP_MX_READ_CNT);
618 writel_relaxed(controller->n_words,
619 controller->base + QUP_MX_WRITE_CNT);
620 /* must be zero for FIFO */
621 writel_relaxed(0, controller->base + QUP_MX_INPUT_CNT);
622 writel_relaxed(0, controller->base + QUP_MX_OUTPUT_CNT);
624 case QUP_IO_M_MODE_BAM:
625 writel_relaxed(controller->n_words,
626 controller->base + QUP_MX_INPUT_CNT);
627 writel_relaxed(controller->n_words,
628 controller->base + QUP_MX_OUTPUT_CNT);
629 /* must be zero for BLOCK and BAM */
630 writel_relaxed(0, controller->base + QUP_MX_READ_CNT);
631 writel_relaxed(0, controller->base + QUP_MX_WRITE_CNT);
633 if (!controller->qup_v1) {
634 void __iomem *input_cnt;
636 input_cnt = controller->base + QUP_MX_INPUT_CNT;
638 * for DMA transfers, both QUP_MX_INPUT_CNT and
639 * QUP_MX_OUTPUT_CNT must be zero to all cases but one.
640 * That case is a non-balanced transfer when there is
644 writel_relaxed(0, input_cnt);
646 writel_relaxed(controller->n_words, input_cnt);
648 writel_relaxed(0, controller->base + QUP_MX_OUTPUT_CNT);
651 case QUP_IO_M_MODE_BLOCK:
652 reinit_completion(&controller->done);
653 writel_relaxed(controller->n_words,
654 controller->base + QUP_MX_INPUT_CNT);
655 writel_relaxed(controller->n_words,
656 controller->base + QUP_MX_OUTPUT_CNT);
657 /* must be zero for BLOCK and BAM */
658 writel_relaxed(0, controller->base + QUP_MX_READ_CNT);
659 writel_relaxed(0, controller->base + QUP_MX_WRITE_CNT);
662 dev_err(controller->dev, "unknown mode = %d\n",
667 iomode = readl_relaxed(controller->base + QUP_IO_M_MODES);
668 /* Set input and output transfer mode */
669 iomode &= ~(QUP_IO_M_INPUT_MODE_MASK | QUP_IO_M_OUTPUT_MODE_MASK);
671 if (!spi_qup_is_dma_xfer(controller->mode))
672 iomode &= ~(QUP_IO_M_PACK_EN | QUP_IO_M_UNPACK_EN);
674 iomode |= QUP_IO_M_PACK_EN | QUP_IO_M_UNPACK_EN;
676 iomode |= (controller->mode << QUP_IO_M_OUTPUT_MODE_MASK_SHIFT);
677 iomode |= (controller->mode << QUP_IO_M_INPUT_MODE_MASK_SHIFT);
679 writel_relaxed(iomode, controller->base + QUP_IO_M_MODES);
681 control = readl_relaxed(controller->base + SPI_IO_CONTROL);
683 if (spi->mode & SPI_CPOL)
684 control |= SPI_IO_C_CLK_IDLE_HIGH;
686 control &= ~SPI_IO_C_CLK_IDLE_HIGH;
688 writel_relaxed(control, controller->base + SPI_IO_CONTROL);
690 config = readl_relaxed(controller->base + SPI_CONFIG);
692 if (spi->mode & SPI_LOOP)
693 config |= SPI_CONFIG_LOOPBACK;
695 config &= ~SPI_CONFIG_LOOPBACK;
697 if (spi->mode & SPI_CPHA)
698 config &= ~SPI_CONFIG_INPUT_FIRST;
700 config |= SPI_CONFIG_INPUT_FIRST;
703 * HS_MODE improves signal stability for spi-clk high rates,
704 * but is invalid in loop back mode.
706 if ((xfer->speed_hz >= SPI_HS_MIN_RATE) && !(spi->mode & SPI_LOOP))
707 config |= SPI_CONFIG_HS_MODE;
709 config &= ~SPI_CONFIG_HS_MODE;
711 writel_relaxed(config, controller->base + SPI_CONFIG);
713 config = readl_relaxed(controller->base + QUP_CONFIG);
714 config &= ~(QUP_CONFIG_NO_INPUT | QUP_CONFIG_NO_OUTPUT | QUP_CONFIG_N);
715 config |= xfer->bits_per_word - 1;
716 config |= QUP_CONFIG_SPI_MODE;
718 if (spi_qup_is_dma_xfer(controller->mode)) {
720 config |= QUP_CONFIG_NO_OUTPUT;
722 config |= QUP_CONFIG_NO_INPUT;
725 writel_relaxed(config, controller->base + QUP_CONFIG);
727 /* only write to OPERATIONAL_MASK when register is present */
728 if (!controller->qup_v1) {
732 * mask INPUT and OUTPUT service flags to prevent IRQs on FIFO
733 * status change in BAM mode
736 if (spi_qup_is_dma_xfer(controller->mode))
737 mask = QUP_OP_IN_SERVICE_FLAG | QUP_OP_OUT_SERVICE_FLAG;
739 writel_relaxed(mask, controller->base + QUP_OPERATIONAL_MASK);
745 static int spi_qup_transfer_one(struct spi_master *master,
746 struct spi_device *spi,
747 struct spi_transfer *xfer)
749 struct spi_qup *controller = spi_master_get_devdata(master);
750 unsigned long timeout, flags;
753 ret = spi_qup_io_prep(spi, xfer);
757 timeout = DIV_ROUND_UP(xfer->speed_hz, MSEC_PER_SEC);
758 timeout = DIV_ROUND_UP(xfer->len * 8, timeout);
759 timeout = 100 * msecs_to_jiffies(timeout);
761 reinit_completion(&controller->done);
763 spin_lock_irqsave(&controller->lock, flags);
764 controller->xfer = xfer;
765 controller->error = 0;
766 controller->rx_bytes = 0;
767 controller->tx_bytes = 0;
768 spin_unlock_irqrestore(&controller->lock, flags);
770 if (spi_qup_is_dma_xfer(controller->mode))
771 ret = spi_qup_do_dma(spi, xfer, timeout);
773 ret = spi_qup_do_pio(spi, xfer, timeout);
779 spi_qup_set_state(controller, QUP_STATE_RESET);
780 spin_lock_irqsave(&controller->lock, flags);
782 ret = controller->error;
783 spin_unlock_irqrestore(&controller->lock, flags);
785 if (ret && spi_qup_is_dma_xfer(controller->mode))
786 spi_qup_dma_terminate(master, xfer);
791 static bool spi_qup_can_dma(struct spi_master *master, struct spi_device *spi,
792 struct spi_transfer *xfer)
794 struct spi_qup *qup = spi_master_get_devdata(master);
795 size_t dma_align = dma_get_cache_alignment();
799 if (!IS_ALIGNED((size_t)xfer->rx_buf, dma_align) ||
800 IS_ERR_OR_NULL(master->dma_rx))
802 if (qup->qup_v1 && (xfer->len % qup->in_blk_sz))
807 if (!IS_ALIGNED((size_t)xfer->tx_buf, dma_align) ||
808 IS_ERR_OR_NULL(master->dma_tx))
810 if (qup->qup_v1 && (xfer->len % qup->out_blk_sz))
814 n_words = xfer->len / DIV_ROUND_UP(xfer->bits_per_word, 8);
815 if (n_words <= (qup->in_fifo_sz / sizeof(u32)))
821 static void spi_qup_release_dma(struct spi_master *master)
823 if (!IS_ERR_OR_NULL(master->dma_rx))
824 dma_release_channel(master->dma_rx);
825 if (!IS_ERR_OR_NULL(master->dma_tx))
826 dma_release_channel(master->dma_tx);
829 static int spi_qup_init_dma(struct spi_master *master, resource_size_t base)
831 struct spi_qup *spi = spi_master_get_devdata(master);
832 struct dma_slave_config *rx_conf = &spi->rx_conf,
833 *tx_conf = &spi->tx_conf;
834 struct device *dev = spi->dev;
837 /* allocate dma resources, if available */
838 master->dma_rx = dma_request_slave_channel_reason(dev, "rx");
839 if (IS_ERR(master->dma_rx))
840 return PTR_ERR(master->dma_rx);
842 master->dma_tx = dma_request_slave_channel_reason(dev, "tx");
843 if (IS_ERR(master->dma_tx)) {
844 ret = PTR_ERR(master->dma_tx);
848 /* set DMA parameters */
849 rx_conf->direction = DMA_DEV_TO_MEM;
850 rx_conf->device_fc = 1;
851 rx_conf->src_addr = base + QUP_INPUT_FIFO;
852 rx_conf->src_maxburst = spi->in_blk_sz;
854 tx_conf->direction = DMA_MEM_TO_DEV;
855 tx_conf->device_fc = 1;
856 tx_conf->dst_addr = base + QUP_OUTPUT_FIFO;
857 tx_conf->dst_maxburst = spi->out_blk_sz;
859 ret = dmaengine_slave_config(master->dma_rx, rx_conf);
861 dev_err(dev, "failed to configure RX channel\n");
865 ret = dmaengine_slave_config(master->dma_tx, tx_conf);
867 dev_err(dev, "failed to configure TX channel\n");
874 dma_release_channel(master->dma_tx);
876 dma_release_channel(master->dma_rx);
880 static void spi_qup_set_cs(struct spi_device *spi, bool val)
882 struct spi_qup *controller;
886 controller = spi_master_get_devdata(spi->master);
887 spi_ioc = readl_relaxed(controller->base + SPI_IO_CONTROL);
888 spi_ioc_orig = spi_ioc;
890 spi_ioc |= SPI_IO_C_FORCE_CS;
892 spi_ioc &= ~SPI_IO_C_FORCE_CS;
894 if (spi_ioc != spi_ioc_orig)
895 writel_relaxed(spi_ioc, controller->base + SPI_IO_CONTROL);
898 static int spi_qup_probe(struct platform_device *pdev)
900 struct spi_master *master;
901 struct clk *iclk, *cclk;
902 struct spi_qup *controller;
903 struct resource *res;
906 u32 max_freq, iomode, num_cs;
910 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
911 base = devm_ioremap_resource(dev, res);
913 return PTR_ERR(base);
915 irq = platform_get_irq(pdev, 0);
919 cclk = devm_clk_get(dev, "core");
921 return PTR_ERR(cclk);
923 iclk = devm_clk_get(dev, "iface");
925 return PTR_ERR(iclk);
927 /* This is optional parameter */
928 if (of_property_read_u32(dev->of_node, "spi-max-frequency", &max_freq))
929 max_freq = SPI_MAX_RATE;
931 if (!max_freq || max_freq > SPI_MAX_RATE) {
932 dev_err(dev, "invalid clock frequency %d\n", max_freq);
936 ret = clk_prepare_enable(cclk);
938 dev_err(dev, "cannot enable core clock\n");
942 ret = clk_prepare_enable(iclk);
944 clk_disable_unprepare(cclk);
945 dev_err(dev, "cannot enable iface clock\n");
949 master = spi_alloc_master(dev, sizeof(struct spi_qup));
951 clk_disable_unprepare(cclk);
952 clk_disable_unprepare(iclk);
953 dev_err(dev, "cannot allocate master\n");
957 /* use num-cs unless not present or out of range */
958 if (of_property_read_u32(dev->of_node, "num-cs", &num_cs) ||
959 num_cs > SPI_NUM_CHIPSELECTS)
960 master->num_chipselect = SPI_NUM_CHIPSELECTS;
962 master->num_chipselect = num_cs;
964 master->bus_num = pdev->id;
965 master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH | SPI_LOOP;
966 master->bits_per_word_mask = SPI_BPW_RANGE_MASK(4, 32);
967 master->max_speed_hz = max_freq;
968 master->transfer_one = spi_qup_transfer_one;
969 master->dev.of_node = pdev->dev.of_node;
970 master->auto_runtime_pm = true;
971 master->dma_alignment = dma_get_cache_alignment();
972 master->max_dma_len = SPI_MAX_DMA_XFER;
974 platform_set_drvdata(pdev, master);
976 controller = spi_master_get_devdata(master);
978 controller->dev = dev;
979 controller->base = base;
980 controller->iclk = iclk;
981 controller->cclk = cclk;
982 controller->irq = irq;
984 ret = spi_qup_init_dma(master, res->start);
985 if (ret == -EPROBE_DEFER)
988 master->can_dma = spi_qup_can_dma;
990 /* set v1 flag if device is version 1 */
991 if (of_device_is_compatible(dev->of_node, "qcom,spi-qup-v1.1.1"))
992 controller->qup_v1 = 1;
994 if (!controller->qup_v1)
995 master->set_cs = spi_qup_set_cs;
997 spin_lock_init(&controller->lock);
998 init_completion(&controller->done);
1000 iomode = readl_relaxed(base + QUP_IO_M_MODES);
1002 size = QUP_IO_M_OUTPUT_BLOCK_SIZE(iomode);
1004 controller->out_blk_sz = size * 16;
1006 controller->out_blk_sz = 4;
1008 size = QUP_IO_M_INPUT_BLOCK_SIZE(iomode);
1010 controller->in_blk_sz = size * 16;
1012 controller->in_blk_sz = 4;
1014 size = QUP_IO_M_OUTPUT_FIFO_SIZE(iomode);
1015 controller->out_fifo_sz = controller->out_blk_sz * (2 << size);
1017 size = QUP_IO_M_INPUT_FIFO_SIZE(iomode);
1018 controller->in_fifo_sz = controller->in_blk_sz * (2 << size);
1020 dev_info(dev, "IN:block:%d, fifo:%d, OUT:block:%d, fifo:%d\n",
1021 controller->in_blk_sz, controller->in_fifo_sz,
1022 controller->out_blk_sz, controller->out_fifo_sz);
1024 writel_relaxed(1, base + QUP_SW_RESET);
1026 ret = spi_qup_set_state(controller, QUP_STATE_RESET);
1028 dev_err(dev, "cannot set RESET state\n");
1032 writel_relaxed(0, base + QUP_OPERATIONAL);
1033 writel_relaxed(0, base + QUP_IO_M_MODES);
1035 if (!controller->qup_v1)
1036 writel_relaxed(0, base + QUP_OPERATIONAL_MASK);
1038 writel_relaxed(SPI_ERROR_CLK_UNDER_RUN | SPI_ERROR_CLK_OVER_RUN,
1039 base + SPI_ERROR_FLAGS_EN);
1041 /* if earlier version of the QUP, disable INPUT_OVERRUN */
1042 if (controller->qup_v1)
1043 writel_relaxed(QUP_ERROR_OUTPUT_OVER_RUN |
1044 QUP_ERROR_INPUT_UNDER_RUN | QUP_ERROR_OUTPUT_UNDER_RUN,
1045 base + QUP_ERROR_FLAGS_EN);
1047 writel_relaxed(0, base + SPI_CONFIG);
1048 writel_relaxed(SPI_IO_C_NO_TRI_STATE, base + SPI_IO_CONTROL);
1050 ret = devm_request_irq(dev, irq, spi_qup_qup_irq,
1051 IRQF_TRIGGER_HIGH, pdev->name, controller);
1055 pm_runtime_set_autosuspend_delay(dev, MSEC_PER_SEC);
1056 pm_runtime_use_autosuspend(dev);
1057 pm_runtime_set_active(dev);
1058 pm_runtime_enable(dev);
1060 ret = devm_spi_register_master(dev, master);
1067 pm_runtime_disable(&pdev->dev);
1069 spi_qup_release_dma(master);
1071 clk_disable_unprepare(cclk);
1072 clk_disable_unprepare(iclk);
1073 spi_master_put(master);
1078 static int spi_qup_pm_suspend_runtime(struct device *device)
1080 struct spi_master *master = dev_get_drvdata(device);
1081 struct spi_qup *controller = spi_master_get_devdata(master);
1084 /* Enable clocks auto gaiting */
1085 config = readl(controller->base + QUP_CONFIG);
1086 config |= QUP_CONFIG_CLOCK_AUTO_GATE;
1087 writel_relaxed(config, controller->base + QUP_CONFIG);
1089 clk_disable_unprepare(controller->cclk);
1090 clk_disable_unprepare(controller->iclk);
1095 static int spi_qup_pm_resume_runtime(struct device *device)
1097 struct spi_master *master = dev_get_drvdata(device);
1098 struct spi_qup *controller = spi_master_get_devdata(master);
1102 ret = clk_prepare_enable(controller->iclk);
1106 ret = clk_prepare_enable(controller->cclk);
1110 /* Disable clocks auto gaiting */
1111 config = readl_relaxed(controller->base + QUP_CONFIG);
1112 config &= ~QUP_CONFIG_CLOCK_AUTO_GATE;
1113 writel_relaxed(config, controller->base + QUP_CONFIG);
1116 #endif /* CONFIG_PM */
1118 #ifdef CONFIG_PM_SLEEP
1119 static int spi_qup_suspend(struct device *device)
1121 struct spi_master *master = dev_get_drvdata(device);
1122 struct spi_qup *controller = spi_master_get_devdata(master);
1125 ret = spi_master_suspend(master);
1129 ret = spi_qup_set_state(controller, QUP_STATE_RESET);
1133 if (!pm_runtime_suspended(device)) {
1134 clk_disable_unprepare(controller->cclk);
1135 clk_disable_unprepare(controller->iclk);
1140 static int spi_qup_resume(struct device *device)
1142 struct spi_master *master = dev_get_drvdata(device);
1143 struct spi_qup *controller = spi_master_get_devdata(master);
1146 ret = clk_prepare_enable(controller->iclk);
1150 ret = clk_prepare_enable(controller->cclk);
1154 ret = spi_qup_set_state(controller, QUP_STATE_RESET);
1158 return spi_master_resume(master);
1160 #endif /* CONFIG_PM_SLEEP */
1162 static int spi_qup_remove(struct platform_device *pdev)
1164 struct spi_master *master = dev_get_drvdata(&pdev->dev);
1165 struct spi_qup *controller = spi_master_get_devdata(master);
1168 ret = pm_runtime_get_sync(&pdev->dev);
1172 ret = spi_qup_set_state(controller, QUP_STATE_RESET);
1176 spi_qup_release_dma(master);
1178 clk_disable_unprepare(controller->cclk);
1179 clk_disable_unprepare(controller->iclk);
1181 pm_runtime_put_noidle(&pdev->dev);
1182 pm_runtime_disable(&pdev->dev);
1187 static const struct of_device_id spi_qup_dt_match[] = {
1188 { .compatible = "qcom,spi-qup-v1.1.1", },
1189 { .compatible = "qcom,spi-qup-v2.1.1", },
1190 { .compatible = "qcom,spi-qup-v2.2.1", },
1193 MODULE_DEVICE_TABLE(of, spi_qup_dt_match);
1195 static const struct dev_pm_ops spi_qup_dev_pm_ops = {
1196 SET_SYSTEM_SLEEP_PM_OPS(spi_qup_suspend, spi_qup_resume)
1197 SET_RUNTIME_PM_OPS(spi_qup_pm_suspend_runtime,
1198 spi_qup_pm_resume_runtime,
1202 static struct platform_driver spi_qup_driver = {
1205 .pm = &spi_qup_dev_pm_ops,
1206 .of_match_table = spi_qup_dt_match,
1208 .probe = spi_qup_probe,
1209 .remove = spi_qup_remove,
1211 module_platform_driver(spi_qup_driver);
1213 MODULE_LICENSE("GPL v2");
1214 MODULE_ALIAS("platform:spi_qup");