1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2008-2014, The Linux foundation. All rights reserved.
7 #include <linux/delay.h>
9 #include <linux/interrupt.h>
11 #include <linux/list.h>
12 #include <linux/module.h>
14 #include <linux/of_device.h>
15 #include <linux/platform_device.h>
16 #include <linux/pm_runtime.h>
17 #include <linux/spi/spi.h>
18 #include <linux/dmaengine.h>
19 #include <linux/dma-mapping.h>
21 #define QUP_CONFIG 0x0000
22 #define QUP_STATE 0x0004
23 #define QUP_IO_M_MODES 0x0008
24 #define QUP_SW_RESET 0x000c
25 #define QUP_OPERATIONAL 0x0018
26 #define QUP_ERROR_FLAGS 0x001c
27 #define QUP_ERROR_FLAGS_EN 0x0020
28 #define QUP_OPERATIONAL_MASK 0x0028
29 #define QUP_HW_VERSION 0x0030
30 #define QUP_MX_OUTPUT_CNT 0x0100
31 #define QUP_OUTPUT_FIFO 0x0110
32 #define QUP_MX_WRITE_CNT 0x0150
33 #define QUP_MX_INPUT_CNT 0x0200
34 #define QUP_MX_READ_CNT 0x0208
35 #define QUP_INPUT_FIFO 0x0218
37 #define SPI_CONFIG 0x0300
38 #define SPI_IO_CONTROL 0x0304
39 #define SPI_ERROR_FLAGS 0x0308
40 #define SPI_ERROR_FLAGS_EN 0x030c
42 /* QUP_CONFIG fields */
43 #define QUP_CONFIG_SPI_MODE (1 << 8)
44 #define QUP_CONFIG_CLOCK_AUTO_GATE BIT(13)
45 #define QUP_CONFIG_NO_INPUT BIT(7)
46 #define QUP_CONFIG_NO_OUTPUT BIT(6)
47 #define QUP_CONFIG_N 0x001f
49 /* QUP_STATE fields */
50 #define QUP_STATE_VALID BIT(2)
51 #define QUP_STATE_RESET 0
52 #define QUP_STATE_RUN 1
53 #define QUP_STATE_PAUSE 3
54 #define QUP_STATE_MASK 3
55 #define QUP_STATE_CLEAR 2
57 #define QUP_HW_VERSION_2_1_1 0x20010001
59 /* QUP_IO_M_MODES fields */
60 #define QUP_IO_M_PACK_EN BIT(15)
61 #define QUP_IO_M_UNPACK_EN BIT(14)
62 #define QUP_IO_M_INPUT_MODE_MASK_SHIFT 12
63 #define QUP_IO_M_OUTPUT_MODE_MASK_SHIFT 10
64 #define QUP_IO_M_INPUT_MODE_MASK (3 << QUP_IO_M_INPUT_MODE_MASK_SHIFT)
65 #define QUP_IO_M_OUTPUT_MODE_MASK (3 << QUP_IO_M_OUTPUT_MODE_MASK_SHIFT)
67 #define QUP_IO_M_OUTPUT_BLOCK_SIZE(x) (((x) & (0x03 << 0)) >> 0)
68 #define QUP_IO_M_OUTPUT_FIFO_SIZE(x) (((x) & (0x07 << 2)) >> 2)
69 #define QUP_IO_M_INPUT_BLOCK_SIZE(x) (((x) & (0x03 << 5)) >> 5)
70 #define QUP_IO_M_INPUT_FIFO_SIZE(x) (((x) & (0x07 << 7)) >> 7)
72 #define QUP_IO_M_MODE_FIFO 0
73 #define QUP_IO_M_MODE_BLOCK 1
74 #define QUP_IO_M_MODE_DMOV 2
75 #define QUP_IO_M_MODE_BAM 3
77 /* QUP_OPERATIONAL fields */
78 #define QUP_OP_IN_BLOCK_READ_REQ BIT(13)
79 #define QUP_OP_OUT_BLOCK_WRITE_REQ BIT(12)
80 #define QUP_OP_MAX_INPUT_DONE_FLAG BIT(11)
81 #define QUP_OP_MAX_OUTPUT_DONE_FLAG BIT(10)
82 #define QUP_OP_IN_SERVICE_FLAG BIT(9)
83 #define QUP_OP_OUT_SERVICE_FLAG BIT(8)
84 #define QUP_OP_IN_FIFO_FULL BIT(7)
85 #define QUP_OP_OUT_FIFO_FULL BIT(6)
86 #define QUP_OP_IN_FIFO_NOT_EMPTY BIT(5)
87 #define QUP_OP_OUT_FIFO_NOT_EMPTY BIT(4)
89 /* QUP_ERROR_FLAGS and QUP_ERROR_FLAGS_EN fields */
90 #define QUP_ERROR_OUTPUT_OVER_RUN BIT(5)
91 #define QUP_ERROR_INPUT_UNDER_RUN BIT(4)
92 #define QUP_ERROR_OUTPUT_UNDER_RUN BIT(3)
93 #define QUP_ERROR_INPUT_OVER_RUN BIT(2)
95 /* SPI_CONFIG fields */
96 #define SPI_CONFIG_HS_MODE BIT(10)
97 #define SPI_CONFIG_INPUT_FIRST BIT(9)
98 #define SPI_CONFIG_LOOPBACK BIT(8)
100 /* SPI_IO_CONTROL fields */
101 #define SPI_IO_C_FORCE_CS BIT(11)
102 #define SPI_IO_C_CLK_IDLE_HIGH BIT(10)
103 #define SPI_IO_C_MX_CS_MODE BIT(8)
104 #define SPI_IO_C_CS_N_POLARITY_0 BIT(4)
105 #define SPI_IO_C_CS_SELECT(x) (((x) & 3) << 2)
106 #define SPI_IO_C_CS_SELECT_MASK 0x000c
107 #define SPI_IO_C_TRISTATE_CS BIT(1)
108 #define SPI_IO_C_NO_TRI_STATE BIT(0)
110 /* SPI_ERROR_FLAGS and SPI_ERROR_FLAGS_EN fields */
111 #define SPI_ERROR_CLK_OVER_RUN BIT(1)
112 #define SPI_ERROR_CLK_UNDER_RUN BIT(0)
114 #define SPI_NUM_CHIPSELECTS 4
116 #define SPI_MAX_XFER (SZ_64K - 64)
118 /* high speed mode is when bus rate is greater then 26MHz */
119 #define SPI_HS_MIN_RATE 26000000
120 #define SPI_MAX_RATE 50000000
122 #define SPI_DELAY_THRESHOLD 1
123 #define SPI_DELAY_RETRY 10
128 struct clk *cclk; /* core clock */
129 struct clk *iclk; /* interface clock */
138 struct spi_transfer *xfer;
139 struct completion done;
141 int w_size; /* bytes per SPI word */
150 struct dma_slave_config rx_conf;
151 struct dma_slave_config tx_conf;
154 static int spi_qup_io_config(struct spi_device *spi, struct spi_transfer *xfer);
156 static inline bool spi_qup_is_flag_set(struct spi_qup *controller, u32 flag)
158 u32 opflag = readl_relaxed(controller->base + QUP_OPERATIONAL);
160 return (opflag & flag) != 0;
163 static inline bool spi_qup_is_dma_xfer(int mode)
165 if (mode == QUP_IO_M_MODE_DMOV || mode == QUP_IO_M_MODE_BAM)
171 /* get's the transaction size length */
172 static inline unsigned int spi_qup_len(struct spi_qup *controller)
174 return controller->n_words * controller->w_size;
177 static inline bool spi_qup_is_valid_state(struct spi_qup *controller)
179 u32 opstate = readl_relaxed(controller->base + QUP_STATE);
181 return opstate & QUP_STATE_VALID;
184 static int spi_qup_set_state(struct spi_qup *controller, u32 state)
190 while (!spi_qup_is_valid_state(controller)) {
192 usleep_range(SPI_DELAY_THRESHOLD, SPI_DELAY_THRESHOLD * 2);
194 if (++loop > SPI_DELAY_RETRY)
199 dev_dbg(controller->dev, "invalid state for %ld,us %d\n",
202 cur_state = readl_relaxed(controller->base + QUP_STATE);
204 * Per spec: for PAUSE_STATE to RESET_STATE, two writes
205 * of (b10) are required
207 if (((cur_state & QUP_STATE_MASK) == QUP_STATE_PAUSE) &&
208 (state == QUP_STATE_RESET)) {
209 writel_relaxed(QUP_STATE_CLEAR, controller->base + QUP_STATE);
210 writel_relaxed(QUP_STATE_CLEAR, controller->base + QUP_STATE);
212 cur_state &= ~QUP_STATE_MASK;
214 writel_relaxed(cur_state, controller->base + QUP_STATE);
218 while (!spi_qup_is_valid_state(controller)) {
220 usleep_range(SPI_DELAY_THRESHOLD, SPI_DELAY_THRESHOLD * 2);
222 if (++loop > SPI_DELAY_RETRY)
229 static void spi_qup_read_from_fifo(struct spi_qup *controller, u32 num_words)
231 u8 *rx_buf = controller->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, spi_qup_len(controller) -
240 controller->rx_bytes,
244 controller->rx_bytes += num_bytes;
248 for (i = 0; i < num_bytes; i++, controller->rx_bytes++) {
250 * The data format depends on bytes per SPI word:
251 * 4 bytes: 0x12345678
252 * 2 bytes: 0x00001234
253 * 1 byte : 0x00000012
255 shift = BITS_PER_BYTE;
256 shift *= (controller->w_size - i - 1);
257 rx_buf[controller->rx_bytes] = word >> shift;
262 static void spi_qup_read(struct spi_qup *controller, u32 *opflags)
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(spi_qup_len(controller) - 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);
280 num_words = (remainder > words_per_block) ?
281 words_per_block : remainder;
283 if (!spi_qup_is_flag_set(controller,
284 QUP_OP_IN_FIFO_NOT_EMPTY))
290 /* read up to the maximum transfer size available */
291 spi_qup_read_from_fifo(controller, num_words);
293 remainder -= num_words;
295 /* if block mode, check to see if next block is available */
296 if (is_block_mode && !spi_qup_is_flag_set(controller,
297 QUP_OP_IN_BLOCK_READ_REQ))
303 * Due to extra stickiness of the QUP_OP_IN_SERVICE_FLAG during block
304 * reads, it has to be cleared again at the very end. However, be sure
305 * to refresh opflags value because MAX_INPUT_DONE_FLAG may now be
306 * present and this is used to determine if transaction is complete
310 *opflags = readl_relaxed(controller->base + QUP_OPERATIONAL);
311 if (is_block_mode && *opflags & QUP_OP_MAX_INPUT_DONE_FLAG)
312 writel_relaxed(QUP_OP_IN_SERVICE_FLAG,
313 controller->base + QUP_OPERATIONAL);
317 static void spi_qup_write_to_fifo(struct spi_qup *controller, u32 num_words)
319 const u8 *tx_buf = controller->tx_buf;
323 for (; num_words; num_words--) {
326 num_bytes = min_t(int, spi_qup_len(controller) -
327 controller->tx_bytes,
330 for (i = 0; i < num_bytes; i++) {
331 data = tx_buf[controller->tx_bytes + i];
332 word |= data << (BITS_PER_BYTE * (3 - i));
335 controller->tx_bytes += num_bytes;
337 writel_relaxed(word, controller->base + QUP_OUTPUT_FIFO);
341 static void spi_qup_dma_done(void *data)
343 struct spi_qup *qup = data;
345 complete(&qup->done);
348 static void spi_qup_write(struct spi_qup *controller)
350 bool is_block_mode = controller->mode == QUP_IO_M_MODE_BLOCK;
351 u32 remainder, words_per_block, num_words;
353 remainder = DIV_ROUND_UP(spi_qup_len(controller) - controller->tx_bytes,
355 words_per_block = controller->out_blk_sz >> 2;
358 /* ACK by clearing service flag */
359 writel_relaxed(QUP_OP_OUT_SERVICE_FLAG,
360 controller->base + QUP_OPERATIONAL);
362 /* make sure the interrupt is valid */
367 num_words = (remainder > words_per_block) ?
368 words_per_block : remainder;
370 if (spi_qup_is_flag_set(controller,
371 QUP_OP_OUT_FIFO_FULL))
377 spi_qup_write_to_fifo(controller, num_words);
379 remainder -= num_words;
381 /* if block mode, check to see if next block is available */
382 if (is_block_mode && !spi_qup_is_flag_set(controller,
383 QUP_OP_OUT_BLOCK_WRITE_REQ))
389 static int spi_qup_prep_sg(struct spi_master *master, struct scatterlist *sgl,
390 unsigned int nents, enum dma_transfer_direction dir,
391 dma_async_tx_callback callback)
393 struct spi_qup *qup = spi_master_get_devdata(master);
394 unsigned long flags = DMA_PREP_INTERRUPT | DMA_PREP_FENCE;
395 struct dma_async_tx_descriptor *desc;
396 struct dma_chan *chan;
399 if (dir == DMA_MEM_TO_DEV)
400 chan = master->dma_tx;
402 chan = master->dma_rx;
404 desc = dmaengine_prep_slave_sg(chan, sgl, nents, dir, flags);
405 if (IS_ERR_OR_NULL(desc))
406 return desc ? PTR_ERR(desc) : -EINVAL;
408 desc->callback = callback;
409 desc->callback_param = qup;
411 cookie = dmaengine_submit(desc);
413 return dma_submit_error(cookie);
416 static void spi_qup_dma_terminate(struct spi_master *master,
417 struct spi_transfer *xfer)
420 dmaengine_terminate_all(master->dma_tx);
422 dmaengine_terminate_all(master->dma_rx);
425 static u32 spi_qup_sgl_get_nents_len(struct scatterlist *sgl, u32 max,
428 struct scatterlist *sg;
431 for (sg = sgl; sg; sg = sg_next(sg)) {
432 unsigned int len = sg_dma_len(sg);
434 /* check for overflow as well as limit */
435 if (((total + len) < total) || ((total + len) > max))
445 static int spi_qup_do_dma(struct spi_device *spi, struct spi_transfer *xfer,
446 unsigned long timeout)
448 dma_async_tx_callback rx_done = NULL, tx_done = NULL;
449 struct spi_master *master = spi->master;
450 struct spi_qup *qup = spi_master_get_devdata(master);
451 struct scatterlist *tx_sgl, *rx_sgl;
455 rx_done = spi_qup_dma_done;
456 else if (xfer->tx_buf)
457 tx_done = spi_qup_dma_done;
459 rx_sgl = xfer->rx_sg.sgl;
460 tx_sgl = xfer->tx_sg.sgl;
463 u32 rx_nents = 0, tx_nents = 0;
466 qup->n_words = spi_qup_sgl_get_nents_len(rx_sgl,
467 SPI_MAX_XFER, &rx_nents) / qup->w_size;
469 qup->n_words = spi_qup_sgl_get_nents_len(tx_sgl,
470 SPI_MAX_XFER, &tx_nents) / qup->w_size;
474 ret = spi_qup_io_config(spi, xfer);
478 /* before issuing the descriptors, set the QUP to run */
479 ret = spi_qup_set_state(qup, QUP_STATE_RUN);
481 dev_warn(qup->dev, "cannot set RUN state\n");
485 ret = spi_qup_prep_sg(master, rx_sgl, rx_nents,
486 DMA_DEV_TO_MEM, rx_done);
489 dma_async_issue_pending(master->dma_rx);
493 ret = spi_qup_prep_sg(master, tx_sgl, tx_nents,
494 DMA_MEM_TO_DEV, tx_done);
498 dma_async_issue_pending(master->dma_tx);
501 if (!wait_for_completion_timeout(&qup->done, timeout))
504 for (; rx_sgl && rx_nents--; rx_sgl = sg_next(rx_sgl))
506 for (; tx_sgl && tx_nents--; tx_sgl = sg_next(tx_sgl))
509 } while (rx_sgl || tx_sgl);
514 static int spi_qup_do_pio(struct spi_device *spi, struct spi_transfer *xfer,
515 unsigned long timeout)
517 struct spi_master *master = spi->master;
518 struct spi_qup *qup = spi_master_get_devdata(master);
519 int ret, n_words, iterations, offset = 0;
521 n_words = qup->n_words;
522 iterations = n_words / SPI_MAX_XFER; /* round down */
523 qup->rx_buf = xfer->rx_buf;
524 qup->tx_buf = xfer->tx_buf;
528 qup->n_words = SPI_MAX_XFER;
530 qup->n_words = n_words % SPI_MAX_XFER;
532 if (qup->tx_buf && offset)
533 qup->tx_buf = xfer->tx_buf + offset * SPI_MAX_XFER;
535 if (qup->rx_buf && offset)
536 qup->rx_buf = xfer->rx_buf + offset * SPI_MAX_XFER;
539 * if the transaction is small enough, we need
540 * to fallback to FIFO mode
542 if (qup->n_words <= (qup->in_fifo_sz / sizeof(u32)))
543 qup->mode = QUP_IO_M_MODE_FIFO;
545 ret = spi_qup_io_config(spi, xfer);
549 ret = spi_qup_set_state(qup, QUP_STATE_RUN);
551 dev_warn(qup->dev, "cannot set RUN state\n");
555 ret = spi_qup_set_state(qup, QUP_STATE_PAUSE);
557 dev_warn(qup->dev, "cannot set PAUSE state\n");
561 if (qup->mode == QUP_IO_M_MODE_FIFO)
564 ret = spi_qup_set_state(qup, QUP_STATE_RUN);
566 dev_warn(qup->dev, "cannot set RUN state\n");
570 if (!wait_for_completion_timeout(&qup->done, timeout))
574 } while (iterations--);
579 static bool spi_qup_data_pending(struct spi_qup *controller)
581 unsigned int remainder_tx, remainder_rx;
583 remainder_tx = DIV_ROUND_UP(spi_qup_len(controller) -
584 controller->tx_bytes, controller->w_size);
586 remainder_rx = DIV_ROUND_UP(spi_qup_len(controller) -
587 controller->rx_bytes, controller->w_size);
589 return remainder_tx || remainder_rx;
592 static irqreturn_t spi_qup_qup_irq(int irq, void *dev_id)
594 struct spi_qup *controller = dev_id;
595 u32 opflags, qup_err, spi_err;
598 qup_err = readl_relaxed(controller->base + QUP_ERROR_FLAGS);
599 spi_err = readl_relaxed(controller->base + SPI_ERROR_FLAGS);
600 opflags = readl_relaxed(controller->base + QUP_OPERATIONAL);
602 writel_relaxed(qup_err, controller->base + QUP_ERROR_FLAGS);
603 writel_relaxed(spi_err, controller->base + SPI_ERROR_FLAGS);
606 if (qup_err & QUP_ERROR_OUTPUT_OVER_RUN)
607 dev_warn(controller->dev, "OUTPUT_OVER_RUN\n");
608 if (qup_err & QUP_ERROR_INPUT_UNDER_RUN)
609 dev_warn(controller->dev, "INPUT_UNDER_RUN\n");
610 if (qup_err & QUP_ERROR_OUTPUT_UNDER_RUN)
611 dev_warn(controller->dev, "OUTPUT_UNDER_RUN\n");
612 if (qup_err & QUP_ERROR_INPUT_OVER_RUN)
613 dev_warn(controller->dev, "INPUT_OVER_RUN\n");
619 if (spi_err & SPI_ERROR_CLK_OVER_RUN)
620 dev_warn(controller->dev, "CLK_OVER_RUN\n");
621 if (spi_err & SPI_ERROR_CLK_UNDER_RUN)
622 dev_warn(controller->dev, "CLK_UNDER_RUN\n");
627 spin_lock(&controller->lock);
628 if (!controller->error)
629 controller->error = error;
630 spin_unlock(&controller->lock);
632 if (spi_qup_is_dma_xfer(controller->mode)) {
633 writel_relaxed(opflags, controller->base + QUP_OPERATIONAL);
635 if (opflags & QUP_OP_IN_SERVICE_FLAG)
636 spi_qup_read(controller, &opflags);
638 if (opflags & QUP_OP_OUT_SERVICE_FLAG)
639 spi_qup_write(controller);
641 if (!spi_qup_data_pending(controller))
642 complete(&controller->done);
646 complete(&controller->done);
648 if (opflags & QUP_OP_MAX_INPUT_DONE_FLAG) {
649 if (!spi_qup_is_dma_xfer(controller->mode)) {
650 if (spi_qup_data_pending(controller))
653 complete(&controller->done);
659 /* set clock freq ... bits per word, determine mode */
660 static int spi_qup_io_prep(struct spi_device *spi, struct spi_transfer *xfer)
662 struct spi_qup *controller = spi_master_get_devdata(spi->master);
665 if (spi->mode & SPI_LOOP && xfer->len > controller->in_fifo_sz) {
666 dev_err(controller->dev, "too big size for loopback %d > %d\n",
667 xfer->len, controller->in_fifo_sz);
671 ret = clk_set_rate(controller->cclk, xfer->speed_hz);
673 dev_err(controller->dev, "fail to set frequency %d",
678 controller->w_size = DIV_ROUND_UP(xfer->bits_per_word, 8);
679 controller->n_words = xfer->len / controller->w_size;
681 if (controller->n_words <= (controller->in_fifo_sz / sizeof(u32)))
682 controller->mode = QUP_IO_M_MODE_FIFO;
683 else if (spi->master->can_dma &&
684 spi->master->can_dma(spi->master, spi, xfer) &&
685 spi->master->cur_msg_mapped)
686 controller->mode = QUP_IO_M_MODE_BAM;
688 controller->mode = QUP_IO_M_MODE_BLOCK;
693 /* prep qup for another spi transaction of specific type */
694 static int spi_qup_io_config(struct spi_device *spi, struct spi_transfer *xfer)
696 struct spi_qup *controller = spi_master_get_devdata(spi->master);
697 u32 config, iomode, control;
700 spin_lock_irqsave(&controller->lock, flags);
701 controller->xfer = xfer;
702 controller->error = 0;
703 controller->rx_bytes = 0;
704 controller->tx_bytes = 0;
705 spin_unlock_irqrestore(&controller->lock, flags);
708 if (spi_qup_set_state(controller, QUP_STATE_RESET)) {
709 dev_err(controller->dev, "cannot set RESET state\n");
713 switch (controller->mode) {
714 case QUP_IO_M_MODE_FIFO:
715 writel_relaxed(controller->n_words,
716 controller->base + QUP_MX_READ_CNT);
717 writel_relaxed(controller->n_words,
718 controller->base + QUP_MX_WRITE_CNT);
719 /* must be zero for FIFO */
720 writel_relaxed(0, controller->base + QUP_MX_INPUT_CNT);
721 writel_relaxed(0, controller->base + QUP_MX_OUTPUT_CNT);
723 case QUP_IO_M_MODE_BAM:
724 writel_relaxed(controller->n_words,
725 controller->base + QUP_MX_INPUT_CNT);
726 writel_relaxed(controller->n_words,
727 controller->base + QUP_MX_OUTPUT_CNT);
728 /* must be zero for BLOCK and BAM */
729 writel_relaxed(0, controller->base + QUP_MX_READ_CNT);
730 writel_relaxed(0, controller->base + QUP_MX_WRITE_CNT);
732 if (!controller->qup_v1) {
733 void __iomem *input_cnt;
735 input_cnt = controller->base + QUP_MX_INPUT_CNT;
737 * for DMA transfers, both QUP_MX_INPUT_CNT and
738 * QUP_MX_OUTPUT_CNT must be zero to all cases but one.
739 * That case is a non-balanced transfer when there is
743 writel_relaxed(0, input_cnt);
745 writel_relaxed(controller->n_words, input_cnt);
747 writel_relaxed(0, controller->base + QUP_MX_OUTPUT_CNT);
750 case QUP_IO_M_MODE_BLOCK:
751 reinit_completion(&controller->done);
752 writel_relaxed(controller->n_words,
753 controller->base + QUP_MX_INPUT_CNT);
754 writel_relaxed(controller->n_words,
755 controller->base + QUP_MX_OUTPUT_CNT);
756 /* must be zero for BLOCK and BAM */
757 writel_relaxed(0, controller->base + QUP_MX_READ_CNT);
758 writel_relaxed(0, controller->base + QUP_MX_WRITE_CNT);
761 dev_err(controller->dev, "unknown mode = %d\n",
766 iomode = readl_relaxed(controller->base + QUP_IO_M_MODES);
767 /* Set input and output transfer mode */
768 iomode &= ~(QUP_IO_M_INPUT_MODE_MASK | QUP_IO_M_OUTPUT_MODE_MASK);
770 if (!spi_qup_is_dma_xfer(controller->mode))
771 iomode &= ~(QUP_IO_M_PACK_EN | QUP_IO_M_UNPACK_EN);
773 iomode |= QUP_IO_M_PACK_EN | QUP_IO_M_UNPACK_EN;
775 iomode |= (controller->mode << QUP_IO_M_OUTPUT_MODE_MASK_SHIFT);
776 iomode |= (controller->mode << QUP_IO_M_INPUT_MODE_MASK_SHIFT);
778 writel_relaxed(iomode, controller->base + QUP_IO_M_MODES);
780 control = readl_relaxed(controller->base + SPI_IO_CONTROL);
782 if (spi->mode & SPI_CPOL)
783 control |= SPI_IO_C_CLK_IDLE_HIGH;
785 control &= ~SPI_IO_C_CLK_IDLE_HIGH;
787 writel_relaxed(control, controller->base + SPI_IO_CONTROL);
789 config = readl_relaxed(controller->base + SPI_CONFIG);
791 if (spi->mode & SPI_LOOP)
792 config |= SPI_CONFIG_LOOPBACK;
794 config &= ~SPI_CONFIG_LOOPBACK;
796 if (spi->mode & SPI_CPHA)
797 config &= ~SPI_CONFIG_INPUT_FIRST;
799 config |= SPI_CONFIG_INPUT_FIRST;
802 * HS_MODE improves signal stability for spi-clk high rates,
803 * but is invalid in loop back mode.
805 if ((xfer->speed_hz >= SPI_HS_MIN_RATE) && !(spi->mode & SPI_LOOP))
806 config |= SPI_CONFIG_HS_MODE;
808 config &= ~SPI_CONFIG_HS_MODE;
810 writel_relaxed(config, controller->base + SPI_CONFIG);
812 config = readl_relaxed(controller->base + QUP_CONFIG);
813 config &= ~(QUP_CONFIG_NO_INPUT | QUP_CONFIG_NO_OUTPUT | QUP_CONFIG_N);
814 config |= xfer->bits_per_word - 1;
815 config |= QUP_CONFIG_SPI_MODE;
817 if (spi_qup_is_dma_xfer(controller->mode)) {
819 config |= QUP_CONFIG_NO_OUTPUT;
821 config |= QUP_CONFIG_NO_INPUT;
824 writel_relaxed(config, controller->base + QUP_CONFIG);
826 /* only write to OPERATIONAL_MASK when register is present */
827 if (!controller->qup_v1) {
831 * mask INPUT and OUTPUT service flags to prevent IRQs on FIFO
832 * status change in BAM mode
835 if (spi_qup_is_dma_xfer(controller->mode))
836 mask = QUP_OP_IN_SERVICE_FLAG | QUP_OP_OUT_SERVICE_FLAG;
838 writel_relaxed(mask, controller->base + QUP_OPERATIONAL_MASK);
844 static int spi_qup_transfer_one(struct spi_master *master,
845 struct spi_device *spi,
846 struct spi_transfer *xfer)
848 struct spi_qup *controller = spi_master_get_devdata(master);
849 unsigned long timeout, flags;
852 ret = spi_qup_io_prep(spi, xfer);
856 timeout = DIV_ROUND_UP(xfer->speed_hz, MSEC_PER_SEC);
857 timeout = DIV_ROUND_UP(min_t(unsigned long, SPI_MAX_XFER,
858 xfer->len) * 8, timeout);
859 timeout = 100 * msecs_to_jiffies(timeout);
861 reinit_completion(&controller->done);
863 spin_lock_irqsave(&controller->lock, flags);
864 controller->xfer = xfer;
865 controller->error = 0;
866 controller->rx_bytes = 0;
867 controller->tx_bytes = 0;
868 spin_unlock_irqrestore(&controller->lock, flags);
870 if (spi_qup_is_dma_xfer(controller->mode))
871 ret = spi_qup_do_dma(spi, xfer, timeout);
873 ret = spi_qup_do_pio(spi, xfer, timeout);
875 spi_qup_set_state(controller, QUP_STATE_RESET);
876 spin_lock_irqsave(&controller->lock, flags);
878 ret = controller->error;
879 spin_unlock_irqrestore(&controller->lock, flags);
881 if (ret && spi_qup_is_dma_xfer(controller->mode))
882 spi_qup_dma_terminate(master, xfer);
887 static bool spi_qup_can_dma(struct spi_master *master, struct spi_device *spi,
888 struct spi_transfer *xfer)
890 struct spi_qup *qup = spi_master_get_devdata(master);
891 size_t dma_align = dma_get_cache_alignment();
895 if (!IS_ALIGNED((size_t)xfer->rx_buf, dma_align) ||
896 IS_ERR_OR_NULL(master->dma_rx))
898 if (qup->qup_v1 && (xfer->len % qup->in_blk_sz))
903 if (!IS_ALIGNED((size_t)xfer->tx_buf, dma_align) ||
904 IS_ERR_OR_NULL(master->dma_tx))
906 if (qup->qup_v1 && (xfer->len % qup->out_blk_sz))
910 n_words = xfer->len / DIV_ROUND_UP(xfer->bits_per_word, 8);
911 if (n_words <= (qup->in_fifo_sz / sizeof(u32)))
917 static void spi_qup_release_dma(struct spi_master *master)
919 if (!IS_ERR_OR_NULL(master->dma_rx))
920 dma_release_channel(master->dma_rx);
921 if (!IS_ERR_OR_NULL(master->dma_tx))
922 dma_release_channel(master->dma_tx);
925 static int spi_qup_init_dma(struct spi_master *master, resource_size_t base)
927 struct spi_qup *spi = spi_master_get_devdata(master);
928 struct dma_slave_config *rx_conf = &spi->rx_conf,
929 *tx_conf = &spi->tx_conf;
930 struct device *dev = spi->dev;
933 /* allocate dma resources, if available */
934 master->dma_rx = dma_request_chan(dev, "rx");
935 if (IS_ERR(master->dma_rx))
936 return PTR_ERR(master->dma_rx);
938 master->dma_tx = dma_request_chan(dev, "tx");
939 if (IS_ERR(master->dma_tx)) {
940 ret = PTR_ERR(master->dma_tx);
944 /* set DMA parameters */
945 rx_conf->direction = DMA_DEV_TO_MEM;
946 rx_conf->device_fc = 1;
947 rx_conf->src_addr = base + QUP_INPUT_FIFO;
948 rx_conf->src_maxburst = spi->in_blk_sz;
950 tx_conf->direction = DMA_MEM_TO_DEV;
951 tx_conf->device_fc = 1;
952 tx_conf->dst_addr = base + QUP_OUTPUT_FIFO;
953 tx_conf->dst_maxburst = spi->out_blk_sz;
955 ret = dmaengine_slave_config(master->dma_rx, rx_conf);
957 dev_err(dev, "failed to configure RX channel\n");
961 ret = dmaengine_slave_config(master->dma_tx, tx_conf);
963 dev_err(dev, "failed to configure TX channel\n");
970 dma_release_channel(master->dma_tx);
972 dma_release_channel(master->dma_rx);
976 static void spi_qup_set_cs(struct spi_device *spi, bool val)
978 struct spi_qup *controller;
982 controller = spi_master_get_devdata(spi->master);
983 spi_ioc = readl_relaxed(controller->base + SPI_IO_CONTROL);
984 spi_ioc_orig = spi_ioc;
986 spi_ioc |= SPI_IO_C_FORCE_CS;
988 spi_ioc &= ~SPI_IO_C_FORCE_CS;
990 if (spi_ioc != spi_ioc_orig)
991 writel_relaxed(spi_ioc, controller->base + SPI_IO_CONTROL);
994 static int spi_qup_probe(struct platform_device *pdev)
996 struct spi_master *master;
997 struct clk *iclk, *cclk;
998 struct spi_qup *controller;
999 struct resource *res;
1002 u32 max_freq, iomode, num_cs;
1006 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1007 base = devm_ioremap_resource(dev, res);
1009 return PTR_ERR(base);
1011 irq = platform_get_irq(pdev, 0);
1015 cclk = devm_clk_get(dev, "core");
1017 return PTR_ERR(cclk);
1019 iclk = devm_clk_get(dev, "iface");
1021 return PTR_ERR(iclk);
1023 /* This is optional parameter */
1024 if (of_property_read_u32(dev->of_node, "spi-max-frequency", &max_freq))
1025 max_freq = SPI_MAX_RATE;
1027 if (!max_freq || max_freq > SPI_MAX_RATE) {
1028 dev_err(dev, "invalid clock frequency %d\n", max_freq);
1032 ret = clk_prepare_enable(cclk);
1034 dev_err(dev, "cannot enable core clock\n");
1038 ret = clk_prepare_enable(iclk);
1040 clk_disable_unprepare(cclk);
1041 dev_err(dev, "cannot enable iface clock\n");
1045 master = spi_alloc_master(dev, sizeof(struct spi_qup));
1047 clk_disable_unprepare(cclk);
1048 clk_disable_unprepare(iclk);
1049 dev_err(dev, "cannot allocate master\n");
1053 /* use num-cs unless not present or out of range */
1054 if (of_property_read_u32(dev->of_node, "num-cs", &num_cs) ||
1055 num_cs > SPI_NUM_CHIPSELECTS)
1056 master->num_chipselect = SPI_NUM_CHIPSELECTS;
1058 master->num_chipselect = num_cs;
1060 master->use_gpio_descriptors = true;
1061 master->max_native_cs = SPI_NUM_CHIPSELECTS;
1062 master->bus_num = pdev->id;
1063 master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH | SPI_LOOP;
1064 master->bits_per_word_mask = SPI_BPW_RANGE_MASK(4, 32);
1065 master->max_speed_hz = max_freq;
1066 master->transfer_one = spi_qup_transfer_one;
1067 master->dev.of_node = pdev->dev.of_node;
1068 master->auto_runtime_pm = true;
1069 master->dma_alignment = dma_get_cache_alignment();
1070 master->max_dma_len = SPI_MAX_XFER;
1072 platform_set_drvdata(pdev, master);
1074 controller = spi_master_get_devdata(master);
1076 controller->dev = dev;
1077 controller->base = base;
1078 controller->iclk = iclk;
1079 controller->cclk = cclk;
1080 controller->irq = irq;
1082 ret = spi_qup_init_dma(master, res->start);
1083 if (ret == -EPROBE_DEFER)
1086 master->can_dma = spi_qup_can_dma;
1088 controller->qup_v1 = (uintptr_t)of_device_get_match_data(dev);
1090 if (!controller->qup_v1)
1091 master->set_cs = spi_qup_set_cs;
1093 spin_lock_init(&controller->lock);
1094 init_completion(&controller->done);
1096 iomode = readl_relaxed(base + QUP_IO_M_MODES);
1098 size = QUP_IO_M_OUTPUT_BLOCK_SIZE(iomode);
1100 controller->out_blk_sz = size * 16;
1102 controller->out_blk_sz = 4;
1104 size = QUP_IO_M_INPUT_BLOCK_SIZE(iomode);
1106 controller->in_blk_sz = size * 16;
1108 controller->in_blk_sz = 4;
1110 size = QUP_IO_M_OUTPUT_FIFO_SIZE(iomode);
1111 controller->out_fifo_sz = controller->out_blk_sz * (2 << size);
1113 size = QUP_IO_M_INPUT_FIFO_SIZE(iomode);
1114 controller->in_fifo_sz = controller->in_blk_sz * (2 << size);
1116 dev_info(dev, "IN:block:%d, fifo:%d, OUT:block:%d, fifo:%d\n",
1117 controller->in_blk_sz, controller->in_fifo_sz,
1118 controller->out_blk_sz, controller->out_fifo_sz);
1120 writel_relaxed(1, base + QUP_SW_RESET);
1122 ret = spi_qup_set_state(controller, QUP_STATE_RESET);
1124 dev_err(dev, "cannot set RESET state\n");
1128 writel_relaxed(0, base + QUP_OPERATIONAL);
1129 writel_relaxed(0, base + QUP_IO_M_MODES);
1131 if (!controller->qup_v1)
1132 writel_relaxed(0, base + QUP_OPERATIONAL_MASK);
1134 writel_relaxed(SPI_ERROR_CLK_UNDER_RUN | SPI_ERROR_CLK_OVER_RUN,
1135 base + SPI_ERROR_FLAGS_EN);
1137 /* if earlier version of the QUP, disable INPUT_OVERRUN */
1138 if (controller->qup_v1)
1139 writel_relaxed(QUP_ERROR_OUTPUT_OVER_RUN |
1140 QUP_ERROR_INPUT_UNDER_RUN | QUP_ERROR_OUTPUT_UNDER_RUN,
1141 base + QUP_ERROR_FLAGS_EN);
1143 writel_relaxed(0, base + SPI_CONFIG);
1144 writel_relaxed(SPI_IO_C_NO_TRI_STATE, base + SPI_IO_CONTROL);
1146 ret = devm_request_irq(dev, irq, spi_qup_qup_irq,
1147 IRQF_TRIGGER_HIGH, pdev->name, controller);
1151 pm_runtime_set_autosuspend_delay(dev, MSEC_PER_SEC);
1152 pm_runtime_use_autosuspend(dev);
1153 pm_runtime_set_active(dev);
1154 pm_runtime_enable(dev);
1156 ret = devm_spi_register_master(dev, master);
1163 pm_runtime_disable(&pdev->dev);
1165 spi_qup_release_dma(master);
1167 clk_disable_unprepare(cclk);
1168 clk_disable_unprepare(iclk);
1169 spi_master_put(master);
1174 static int spi_qup_pm_suspend_runtime(struct device *device)
1176 struct spi_master *master = dev_get_drvdata(device);
1177 struct spi_qup *controller = spi_master_get_devdata(master);
1180 /* Enable clocks auto gaiting */
1181 config = readl(controller->base + QUP_CONFIG);
1182 config |= QUP_CONFIG_CLOCK_AUTO_GATE;
1183 writel_relaxed(config, controller->base + QUP_CONFIG);
1185 clk_disable_unprepare(controller->cclk);
1186 clk_disable_unprepare(controller->iclk);
1191 static int spi_qup_pm_resume_runtime(struct device *device)
1193 struct spi_master *master = dev_get_drvdata(device);
1194 struct spi_qup *controller = spi_master_get_devdata(master);
1198 ret = clk_prepare_enable(controller->iclk);
1202 ret = clk_prepare_enable(controller->cclk);
1204 clk_disable_unprepare(controller->iclk);
1208 /* Disable clocks auto gaiting */
1209 config = readl_relaxed(controller->base + QUP_CONFIG);
1210 config &= ~QUP_CONFIG_CLOCK_AUTO_GATE;
1211 writel_relaxed(config, controller->base + QUP_CONFIG);
1214 #endif /* CONFIG_PM */
1216 #ifdef CONFIG_PM_SLEEP
1217 static int spi_qup_suspend(struct device *device)
1219 struct spi_master *master = dev_get_drvdata(device);
1220 struct spi_qup *controller = spi_master_get_devdata(master);
1223 if (pm_runtime_suspended(device)) {
1224 ret = spi_qup_pm_resume_runtime(device);
1228 ret = spi_master_suspend(master);
1232 ret = spi_qup_set_state(controller, QUP_STATE_RESET);
1236 clk_disable_unprepare(controller->cclk);
1237 clk_disable_unprepare(controller->iclk);
1241 static int spi_qup_resume(struct device *device)
1243 struct spi_master *master = dev_get_drvdata(device);
1244 struct spi_qup *controller = spi_master_get_devdata(master);
1247 ret = clk_prepare_enable(controller->iclk);
1251 ret = clk_prepare_enable(controller->cclk);
1253 clk_disable_unprepare(controller->iclk);
1257 ret = spi_qup_set_state(controller, QUP_STATE_RESET);
1261 ret = spi_master_resume(master);
1268 clk_disable_unprepare(controller->cclk);
1269 clk_disable_unprepare(controller->iclk);
1272 #endif /* CONFIG_PM_SLEEP */
1274 static int spi_qup_remove(struct platform_device *pdev)
1276 struct spi_master *master = dev_get_drvdata(&pdev->dev);
1277 struct spi_qup *controller = spi_master_get_devdata(master);
1280 ret = pm_runtime_resume_and_get(&pdev->dev);
1284 ret = spi_qup_set_state(controller, QUP_STATE_RESET);
1288 spi_qup_release_dma(master);
1290 clk_disable_unprepare(controller->cclk);
1291 clk_disable_unprepare(controller->iclk);
1293 pm_runtime_put_noidle(&pdev->dev);
1294 pm_runtime_disable(&pdev->dev);
1299 static const struct of_device_id spi_qup_dt_match[] = {
1300 { .compatible = "qcom,spi-qup-v1.1.1", .data = (void *)1, },
1301 { .compatible = "qcom,spi-qup-v2.1.1", },
1302 { .compatible = "qcom,spi-qup-v2.2.1", },
1305 MODULE_DEVICE_TABLE(of, spi_qup_dt_match);
1307 static const struct dev_pm_ops spi_qup_dev_pm_ops = {
1308 SET_SYSTEM_SLEEP_PM_OPS(spi_qup_suspend, spi_qup_resume)
1309 SET_RUNTIME_PM_OPS(spi_qup_pm_suspend_runtime,
1310 spi_qup_pm_resume_runtime,
1314 static struct platform_driver spi_qup_driver = {
1317 .pm = &spi_qup_dev_pm_ops,
1318 .of_match_table = spi_qup_dt_match,
1320 .probe = spi_qup_probe,
1321 .remove = spi_qup_remove,
1323 module_platform_driver(spi_qup_driver);
1325 MODULE_LICENSE("GPL v2");
1326 MODULE_ALIAS("platform:spi_qup");