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/of_device.h>
23 #include <linux/platform_device.h>
24 #include <linux/pm_runtime.h>
25 #include <linux/spi/spi.h>
26 #include <linux/dmaengine.h>
27 #include <linux/dma-mapping.h>
29 #define QUP_CONFIG 0x0000
30 #define QUP_STATE 0x0004
31 #define QUP_IO_M_MODES 0x0008
32 #define QUP_SW_RESET 0x000c
33 #define QUP_OPERATIONAL 0x0018
34 #define QUP_ERROR_FLAGS 0x001c
35 #define QUP_ERROR_FLAGS_EN 0x0020
36 #define QUP_OPERATIONAL_MASK 0x0028
37 #define QUP_HW_VERSION 0x0030
38 #define QUP_MX_OUTPUT_CNT 0x0100
39 #define QUP_OUTPUT_FIFO 0x0110
40 #define QUP_MX_WRITE_CNT 0x0150
41 #define QUP_MX_INPUT_CNT 0x0200
42 #define QUP_MX_READ_CNT 0x0208
43 #define QUP_INPUT_FIFO 0x0218
45 #define SPI_CONFIG 0x0300
46 #define SPI_IO_CONTROL 0x0304
47 #define SPI_ERROR_FLAGS 0x0308
48 #define SPI_ERROR_FLAGS_EN 0x030c
50 /* QUP_CONFIG fields */
51 #define QUP_CONFIG_SPI_MODE (1 << 8)
52 #define QUP_CONFIG_CLOCK_AUTO_GATE BIT(13)
53 #define QUP_CONFIG_NO_INPUT BIT(7)
54 #define QUP_CONFIG_NO_OUTPUT BIT(6)
55 #define QUP_CONFIG_N 0x001f
57 /* QUP_STATE fields */
58 #define QUP_STATE_VALID BIT(2)
59 #define QUP_STATE_RESET 0
60 #define QUP_STATE_RUN 1
61 #define QUP_STATE_PAUSE 3
62 #define QUP_STATE_MASK 3
63 #define QUP_STATE_CLEAR 2
65 #define QUP_HW_VERSION_2_1_1 0x20010001
67 /* QUP_IO_M_MODES fields */
68 #define QUP_IO_M_PACK_EN BIT(15)
69 #define QUP_IO_M_UNPACK_EN BIT(14)
70 #define QUP_IO_M_INPUT_MODE_MASK_SHIFT 12
71 #define QUP_IO_M_OUTPUT_MODE_MASK_SHIFT 10
72 #define QUP_IO_M_INPUT_MODE_MASK (3 << QUP_IO_M_INPUT_MODE_MASK_SHIFT)
73 #define QUP_IO_M_OUTPUT_MODE_MASK (3 << QUP_IO_M_OUTPUT_MODE_MASK_SHIFT)
75 #define QUP_IO_M_OUTPUT_BLOCK_SIZE(x) (((x) & (0x03 << 0)) >> 0)
76 #define QUP_IO_M_OUTPUT_FIFO_SIZE(x) (((x) & (0x07 << 2)) >> 2)
77 #define QUP_IO_M_INPUT_BLOCK_SIZE(x) (((x) & (0x03 << 5)) >> 5)
78 #define QUP_IO_M_INPUT_FIFO_SIZE(x) (((x) & (0x07 << 7)) >> 7)
80 #define QUP_IO_M_MODE_FIFO 0
81 #define QUP_IO_M_MODE_BLOCK 1
82 #define QUP_IO_M_MODE_DMOV 2
83 #define QUP_IO_M_MODE_BAM 3
85 /* QUP_OPERATIONAL fields */
86 #define QUP_OP_IN_BLOCK_READ_REQ BIT(13)
87 #define QUP_OP_OUT_BLOCK_WRITE_REQ BIT(12)
88 #define QUP_OP_MAX_INPUT_DONE_FLAG BIT(11)
89 #define QUP_OP_MAX_OUTPUT_DONE_FLAG BIT(10)
90 #define QUP_OP_IN_SERVICE_FLAG BIT(9)
91 #define QUP_OP_OUT_SERVICE_FLAG BIT(8)
92 #define QUP_OP_IN_FIFO_FULL BIT(7)
93 #define QUP_OP_OUT_FIFO_FULL BIT(6)
94 #define QUP_OP_IN_FIFO_NOT_EMPTY BIT(5)
95 #define QUP_OP_OUT_FIFO_NOT_EMPTY BIT(4)
97 /* QUP_ERROR_FLAGS and QUP_ERROR_FLAGS_EN fields */
98 #define QUP_ERROR_OUTPUT_OVER_RUN BIT(5)
99 #define QUP_ERROR_INPUT_UNDER_RUN BIT(4)
100 #define QUP_ERROR_OUTPUT_UNDER_RUN BIT(3)
101 #define QUP_ERROR_INPUT_OVER_RUN BIT(2)
103 /* SPI_CONFIG fields */
104 #define SPI_CONFIG_HS_MODE BIT(10)
105 #define SPI_CONFIG_INPUT_FIRST BIT(9)
106 #define SPI_CONFIG_LOOPBACK BIT(8)
108 /* SPI_IO_CONTROL fields */
109 #define SPI_IO_C_FORCE_CS BIT(11)
110 #define SPI_IO_C_CLK_IDLE_HIGH BIT(10)
111 #define SPI_IO_C_MX_CS_MODE BIT(8)
112 #define SPI_IO_C_CS_N_POLARITY_0 BIT(4)
113 #define SPI_IO_C_CS_SELECT(x) (((x) & 3) << 2)
114 #define SPI_IO_C_CS_SELECT_MASK 0x000c
115 #define SPI_IO_C_TRISTATE_CS BIT(1)
116 #define SPI_IO_C_NO_TRI_STATE BIT(0)
118 /* SPI_ERROR_FLAGS and SPI_ERROR_FLAGS_EN fields */
119 #define SPI_ERROR_CLK_OVER_RUN BIT(1)
120 #define SPI_ERROR_CLK_UNDER_RUN BIT(0)
122 #define SPI_NUM_CHIPSELECTS 4
124 #define SPI_MAX_XFER (SZ_64K - 64)
126 /* high speed mode is when bus rate is greater then 26MHz */
127 #define SPI_HS_MIN_RATE 26000000
128 #define SPI_MAX_RATE 50000000
130 #define SPI_DELAY_THRESHOLD 1
131 #define SPI_DELAY_RETRY 10
136 struct clk
*cclk
; /* core clock */
137 struct clk
*iclk
; /* interface clock */
146 struct spi_transfer
*xfer
;
147 struct completion done
;
149 int w_size
; /* bytes per SPI word */
158 struct dma_slave_config rx_conf
;
159 struct dma_slave_config tx_conf
;
162 static int spi_qup_io_config(struct spi_device
*spi
, struct spi_transfer
*xfer
);
164 static inline bool spi_qup_is_flag_set(struct spi_qup
*controller
, u32 flag
)
166 u32 opflag
= readl_relaxed(controller
->base
+ QUP_OPERATIONAL
);
168 return (opflag
& flag
) != 0;
171 static inline bool spi_qup_is_dma_xfer(int mode
)
173 if (mode
== QUP_IO_M_MODE_DMOV
|| mode
== QUP_IO_M_MODE_BAM
)
179 /* get's the transaction size length */
180 static inline unsigned int spi_qup_len(struct spi_qup
*controller
)
182 return controller
->n_words
* controller
->w_size
;
185 static inline bool spi_qup_is_valid_state(struct spi_qup
*controller
)
187 u32 opstate
= readl_relaxed(controller
->base
+ QUP_STATE
);
189 return opstate
& QUP_STATE_VALID
;
192 static int spi_qup_set_state(struct spi_qup
*controller
, u32 state
)
198 while (!spi_qup_is_valid_state(controller
)) {
200 usleep_range(SPI_DELAY_THRESHOLD
, SPI_DELAY_THRESHOLD
* 2);
202 if (++loop
> SPI_DELAY_RETRY
)
207 dev_dbg(controller
->dev
, "invalid state for %ld,us %d\n",
210 cur_state
= readl_relaxed(controller
->base
+ QUP_STATE
);
212 * Per spec: for PAUSE_STATE to RESET_STATE, two writes
213 * of (b10) are required
215 if (((cur_state
& QUP_STATE_MASK
) == QUP_STATE_PAUSE
) &&
216 (state
== QUP_STATE_RESET
)) {
217 writel_relaxed(QUP_STATE_CLEAR
, controller
->base
+ QUP_STATE
);
218 writel_relaxed(QUP_STATE_CLEAR
, controller
->base
+ QUP_STATE
);
220 cur_state
&= ~QUP_STATE_MASK
;
222 writel_relaxed(cur_state
, controller
->base
+ QUP_STATE
);
226 while (!spi_qup_is_valid_state(controller
)) {
228 usleep_range(SPI_DELAY_THRESHOLD
, SPI_DELAY_THRESHOLD
* 2);
230 if (++loop
> SPI_DELAY_RETRY
)
237 static void spi_qup_read_from_fifo(struct spi_qup
*controller
, u32 num_words
)
239 u8
*rx_buf
= controller
->rx_buf
;
240 int i
, shift
, num_bytes
;
243 for (; num_words
; num_words
--) {
245 word
= readl_relaxed(controller
->base
+ QUP_INPUT_FIFO
);
247 num_bytes
= min_t(int, spi_qup_len(controller
) -
248 controller
->rx_bytes
,
252 controller
->rx_bytes
+= num_bytes
;
256 for (i
= 0; i
< num_bytes
; i
++, controller
->rx_bytes
++) {
258 * The data format depends on bytes per SPI word:
259 * 4 bytes: 0x12345678
260 * 2 bytes: 0x00001234
261 * 1 byte : 0x00000012
263 shift
= BITS_PER_BYTE
;
264 shift
*= (controller
->w_size
- i
- 1);
265 rx_buf
[controller
->rx_bytes
] = word
>> shift
;
270 static void spi_qup_read(struct spi_qup
*controller
, u32
*opflags
)
272 u32 remainder
, words_per_block
, num_words
;
273 bool is_block_mode
= controller
->mode
== QUP_IO_M_MODE_BLOCK
;
275 remainder
= DIV_ROUND_UP(spi_qup_len(controller
) - controller
->rx_bytes
,
277 words_per_block
= controller
->in_blk_sz
>> 2;
280 /* ACK by clearing service flag */
281 writel_relaxed(QUP_OP_IN_SERVICE_FLAG
,
282 controller
->base
+ QUP_OPERATIONAL
);
285 num_words
= (remainder
> words_per_block
) ?
286 words_per_block
: remainder
;
288 if (!spi_qup_is_flag_set(controller
,
289 QUP_OP_IN_FIFO_NOT_EMPTY
))
295 /* read up to the maximum transfer size available */
296 spi_qup_read_from_fifo(controller
, num_words
);
298 remainder
-= num_words
;
300 /* if block mode, check to see if next block is available */
301 if (is_block_mode
&& !spi_qup_is_flag_set(controller
,
302 QUP_OP_IN_BLOCK_READ_REQ
))
308 * Due to extra stickiness of the QUP_OP_IN_SERVICE_FLAG during block
309 * reads, it has to be cleared again at the very end. However, be sure
310 * to refresh opflags value because MAX_INPUT_DONE_FLAG may now be
311 * present and this is used to determine if transaction is complete
313 *opflags
= readl_relaxed(controller
->base
+ QUP_OPERATIONAL
);
314 if (is_block_mode
&& *opflags
& QUP_OP_MAX_INPUT_DONE_FLAG
)
315 writel_relaxed(QUP_OP_IN_SERVICE_FLAG
,
316 controller
->base
+ QUP_OPERATIONAL
);
320 static void spi_qup_write_to_fifo(struct spi_qup
*controller
, u32 num_words
)
322 const u8
*tx_buf
= controller
->tx_buf
;
326 for (; num_words
; num_words
--) {
329 num_bytes
= min_t(int, spi_qup_len(controller
) -
330 controller
->tx_bytes
,
333 for (i
= 0; i
< num_bytes
; i
++) {
334 data
= tx_buf
[controller
->tx_bytes
+ i
];
335 word
|= data
<< (BITS_PER_BYTE
* (3 - i
));
338 controller
->tx_bytes
+= num_bytes
;
340 writel_relaxed(word
, controller
->base
+ QUP_OUTPUT_FIFO
);
344 static void spi_qup_dma_done(void *data
)
346 struct spi_qup
*qup
= data
;
348 complete(&qup
->done
);
351 static void spi_qup_write(struct spi_qup
*controller
)
353 bool is_block_mode
= controller
->mode
== QUP_IO_M_MODE_BLOCK
;
354 u32 remainder
, words_per_block
, num_words
;
356 remainder
= DIV_ROUND_UP(spi_qup_len(controller
) - controller
->tx_bytes
,
358 words_per_block
= controller
->out_blk_sz
>> 2;
361 /* ACK by clearing service flag */
362 writel_relaxed(QUP_OP_OUT_SERVICE_FLAG
,
363 controller
->base
+ QUP_OPERATIONAL
);
366 num_words
= (remainder
> words_per_block
) ?
367 words_per_block
: remainder
;
369 if (spi_qup_is_flag_set(controller
,
370 QUP_OP_OUT_FIFO_FULL
))
376 spi_qup_write_to_fifo(controller
, num_words
);
378 remainder
-= num_words
;
380 /* if block mode, check to see if next block is available */
381 if (is_block_mode
&& !spi_qup_is_flag_set(controller
,
382 QUP_OP_OUT_BLOCK_WRITE_REQ
))
388 static int spi_qup_prep_sg(struct spi_master
*master
, struct scatterlist
*sgl
,
389 unsigned int nents
, enum dma_transfer_direction dir
,
390 dma_async_tx_callback callback
)
392 struct spi_qup
*qup
= spi_master_get_devdata(master
);
393 unsigned long flags
= DMA_PREP_INTERRUPT
| DMA_PREP_FENCE
;
394 struct dma_async_tx_descriptor
*desc
;
395 struct dma_chan
*chan
;
398 if (dir
== DMA_MEM_TO_DEV
)
399 chan
= master
->dma_tx
;
401 chan
= master
->dma_rx
;
403 desc
= dmaengine_prep_slave_sg(chan
, sgl
, nents
, dir
, flags
);
404 if (IS_ERR_OR_NULL(desc
))
405 return desc
? PTR_ERR(desc
) : -EINVAL
;
407 desc
->callback
= callback
;
408 desc
->callback_param
= qup
;
410 cookie
= dmaengine_submit(desc
);
412 return dma_submit_error(cookie
);
415 static void spi_qup_dma_terminate(struct spi_master
*master
,
416 struct spi_transfer
*xfer
)
419 dmaengine_terminate_all(master
->dma_tx
);
421 dmaengine_terminate_all(master
->dma_rx
);
424 static u32
spi_qup_sgl_get_nents_len(struct scatterlist
*sgl
, u32 max
,
427 struct scatterlist
*sg
;
430 for (sg
= sgl
; sg
; sg
= sg_next(sg
)) {
431 unsigned int len
= sg_dma_len(sg
);
433 /* check for overflow as well as limit */
434 if (((total
+ len
) < total
) || ((total
+ len
) > max
))
444 static int spi_qup_do_dma(struct spi_device
*spi
, struct spi_transfer
*xfer
,
445 unsigned long timeout
)
447 dma_async_tx_callback rx_done
= NULL
, tx_done
= NULL
;
448 struct spi_master
*master
= spi
->master
;
449 struct spi_qup
*qup
= spi_master_get_devdata(master
);
450 struct scatterlist
*tx_sgl
, *rx_sgl
;
454 rx_done
= spi_qup_dma_done
;
455 else if (xfer
->tx_buf
)
456 tx_done
= spi_qup_dma_done
;
458 rx_sgl
= xfer
->rx_sg
.sgl
;
459 tx_sgl
= xfer
->tx_sg
.sgl
;
462 u32 rx_nents
= 0, tx_nents
= 0;
465 qup
->n_words
= spi_qup_sgl_get_nents_len(rx_sgl
,
466 SPI_MAX_XFER
, &rx_nents
) / qup
->w_size
;
468 qup
->n_words
= spi_qup_sgl_get_nents_len(tx_sgl
,
469 SPI_MAX_XFER
, &tx_nents
) / qup
->w_size
;
473 ret
= spi_qup_io_config(spi
, xfer
);
477 /* before issuing the descriptors, set the QUP to run */
478 ret
= spi_qup_set_state(qup
, QUP_STATE_RUN
);
480 dev_warn(qup
->dev
, "cannot set RUN state\n");
484 ret
= spi_qup_prep_sg(master
, rx_sgl
, rx_nents
,
485 DMA_DEV_TO_MEM
, rx_done
);
488 dma_async_issue_pending(master
->dma_rx
);
492 ret
= spi_qup_prep_sg(master
, tx_sgl
, tx_nents
,
493 DMA_MEM_TO_DEV
, tx_done
);
497 dma_async_issue_pending(master
->dma_tx
);
500 if (!wait_for_completion_timeout(&qup
->done
, timeout
))
503 for (; rx_sgl
&& rx_nents
--; rx_sgl
= sg_next(rx_sgl
))
505 for (; tx_sgl
&& tx_nents
--; tx_sgl
= sg_next(tx_sgl
))
508 } while (rx_sgl
|| tx_sgl
);
513 static int spi_qup_do_pio(struct spi_device
*spi
, struct spi_transfer
*xfer
,
514 unsigned long timeout
)
516 struct spi_master
*master
= spi
->master
;
517 struct spi_qup
*qup
= spi_master_get_devdata(master
);
518 int ret
, n_words
, iterations
, offset
= 0;
520 n_words
= qup
->n_words
;
521 iterations
= n_words
/ SPI_MAX_XFER
; /* round down */
522 qup
->rx_buf
= xfer
->rx_buf
;
523 qup
->tx_buf
= xfer
->tx_buf
;
527 qup
->n_words
= SPI_MAX_XFER
;
529 qup
->n_words
= n_words
% SPI_MAX_XFER
;
531 if (qup
->tx_buf
&& offset
)
532 qup
->tx_buf
= xfer
->tx_buf
+ offset
* SPI_MAX_XFER
;
534 if (qup
->rx_buf
&& offset
)
535 qup
->rx_buf
= xfer
->rx_buf
+ offset
* SPI_MAX_XFER
;
538 * if the transaction is small enough, we need
539 * to fallback to FIFO mode
541 if (qup
->n_words
<= (qup
->in_fifo_sz
/ sizeof(u32
)))
542 qup
->mode
= QUP_IO_M_MODE_FIFO
;
544 ret
= spi_qup_io_config(spi
, xfer
);
548 ret
= spi_qup_set_state(qup
, QUP_STATE_RUN
);
550 dev_warn(qup
->dev
, "cannot set RUN state\n");
554 ret
= spi_qup_set_state(qup
, QUP_STATE_PAUSE
);
556 dev_warn(qup
->dev
, "cannot set PAUSE state\n");
560 if (qup
->mode
== QUP_IO_M_MODE_FIFO
)
563 ret
= spi_qup_set_state(qup
, QUP_STATE_RUN
);
565 dev_warn(qup
->dev
, "cannot set RUN state\n");
569 if (!wait_for_completion_timeout(&qup
->done
, timeout
))
573 } while (iterations
--);
578 static irqreturn_t
spi_qup_qup_irq(int irq
, void *dev_id
)
580 struct spi_qup
*controller
= dev_id
;
581 u32 opflags
, qup_err
, spi_err
;
584 qup_err
= readl_relaxed(controller
->base
+ QUP_ERROR_FLAGS
);
585 spi_err
= readl_relaxed(controller
->base
+ SPI_ERROR_FLAGS
);
586 opflags
= readl_relaxed(controller
->base
+ QUP_OPERATIONAL
);
588 writel_relaxed(qup_err
, controller
->base
+ QUP_ERROR_FLAGS
);
589 writel_relaxed(spi_err
, controller
->base
+ SPI_ERROR_FLAGS
);
592 if (qup_err
& QUP_ERROR_OUTPUT_OVER_RUN
)
593 dev_warn(controller
->dev
, "OUTPUT_OVER_RUN\n");
594 if (qup_err
& QUP_ERROR_INPUT_UNDER_RUN
)
595 dev_warn(controller
->dev
, "INPUT_UNDER_RUN\n");
596 if (qup_err
& QUP_ERROR_OUTPUT_UNDER_RUN
)
597 dev_warn(controller
->dev
, "OUTPUT_UNDER_RUN\n");
598 if (qup_err
& QUP_ERROR_INPUT_OVER_RUN
)
599 dev_warn(controller
->dev
, "INPUT_OVER_RUN\n");
605 if (spi_err
& SPI_ERROR_CLK_OVER_RUN
)
606 dev_warn(controller
->dev
, "CLK_OVER_RUN\n");
607 if (spi_err
& SPI_ERROR_CLK_UNDER_RUN
)
608 dev_warn(controller
->dev
, "CLK_UNDER_RUN\n");
613 if (spi_qup_is_dma_xfer(controller
->mode
)) {
614 writel_relaxed(opflags
, controller
->base
+ QUP_OPERATIONAL
);
616 if (opflags
& QUP_OP_IN_SERVICE_FLAG
)
617 spi_qup_read(controller
, &opflags
);
619 if (opflags
& QUP_OP_OUT_SERVICE_FLAG
)
620 spi_qup_write(controller
);
623 if ((opflags
& QUP_OP_MAX_INPUT_DONE_FLAG
) || error
)
624 complete(&controller
->done
);
629 /* set clock freq ... bits per word, determine mode */
630 static int spi_qup_io_prep(struct spi_device
*spi
, struct spi_transfer
*xfer
)
632 struct spi_qup
*controller
= spi_master_get_devdata(spi
->master
);
635 if (spi
->mode
& SPI_LOOP
&& xfer
->len
> controller
->in_fifo_sz
) {
636 dev_err(controller
->dev
, "too big size for loopback %d > %d\n",
637 xfer
->len
, controller
->in_fifo_sz
);
641 ret
= clk_set_rate(controller
->cclk
, xfer
->speed_hz
);
643 dev_err(controller
->dev
, "fail to set frequency %d",
648 controller
->w_size
= DIV_ROUND_UP(xfer
->bits_per_word
, 8);
649 controller
->n_words
= xfer
->len
/ controller
->w_size
;
651 if (controller
->n_words
<= (controller
->in_fifo_sz
/ sizeof(u32
)))
652 controller
->mode
= QUP_IO_M_MODE_FIFO
;
653 else if (spi
->master
->can_dma
&&
654 spi
->master
->can_dma(spi
->master
, spi
, xfer
) &&
655 spi
->master
->cur_msg_mapped
)
656 controller
->mode
= QUP_IO_M_MODE_BAM
;
658 controller
->mode
= QUP_IO_M_MODE_BLOCK
;
663 /* prep qup for another spi transaction of specific type */
664 static int spi_qup_io_config(struct spi_device
*spi
, struct spi_transfer
*xfer
)
666 struct spi_qup
*controller
= spi_master_get_devdata(spi
->master
);
667 u32 config
, iomode
, control
;
670 spin_lock_irqsave(&controller
->lock
, flags
);
671 controller
->xfer
= xfer
;
672 controller
->error
= 0;
673 controller
->rx_bytes
= 0;
674 controller
->tx_bytes
= 0;
675 spin_unlock_irqrestore(&controller
->lock
, flags
);
678 if (spi_qup_set_state(controller
, QUP_STATE_RESET
)) {
679 dev_err(controller
->dev
, "cannot set RESET state\n");
683 switch (controller
->mode
) {
684 case QUP_IO_M_MODE_FIFO
:
685 writel_relaxed(controller
->n_words
,
686 controller
->base
+ QUP_MX_READ_CNT
);
687 writel_relaxed(controller
->n_words
,
688 controller
->base
+ QUP_MX_WRITE_CNT
);
689 /* must be zero for FIFO */
690 writel_relaxed(0, controller
->base
+ QUP_MX_INPUT_CNT
);
691 writel_relaxed(0, controller
->base
+ QUP_MX_OUTPUT_CNT
);
693 case QUP_IO_M_MODE_BAM
:
694 writel_relaxed(controller
->n_words
,
695 controller
->base
+ QUP_MX_INPUT_CNT
);
696 writel_relaxed(controller
->n_words
,
697 controller
->base
+ QUP_MX_OUTPUT_CNT
);
698 /* must be zero for BLOCK and BAM */
699 writel_relaxed(0, controller
->base
+ QUP_MX_READ_CNT
);
700 writel_relaxed(0, controller
->base
+ QUP_MX_WRITE_CNT
);
702 if (!controller
->qup_v1
) {
703 void __iomem
*input_cnt
;
705 input_cnt
= controller
->base
+ QUP_MX_INPUT_CNT
;
707 * for DMA transfers, both QUP_MX_INPUT_CNT and
708 * QUP_MX_OUTPUT_CNT must be zero to all cases but one.
709 * That case is a non-balanced transfer when there is
713 writel_relaxed(0, input_cnt
);
715 writel_relaxed(controller
->n_words
, input_cnt
);
717 writel_relaxed(0, controller
->base
+ QUP_MX_OUTPUT_CNT
);
720 case QUP_IO_M_MODE_BLOCK
:
721 reinit_completion(&controller
->done
);
722 writel_relaxed(controller
->n_words
,
723 controller
->base
+ QUP_MX_INPUT_CNT
);
724 writel_relaxed(controller
->n_words
,
725 controller
->base
+ QUP_MX_OUTPUT_CNT
);
726 /* must be zero for BLOCK and BAM */
727 writel_relaxed(0, controller
->base
+ QUP_MX_READ_CNT
);
728 writel_relaxed(0, controller
->base
+ QUP_MX_WRITE_CNT
);
731 dev_err(controller
->dev
, "unknown mode = %d\n",
736 iomode
= readl_relaxed(controller
->base
+ QUP_IO_M_MODES
);
737 /* Set input and output transfer mode */
738 iomode
&= ~(QUP_IO_M_INPUT_MODE_MASK
| QUP_IO_M_OUTPUT_MODE_MASK
);
740 if (!spi_qup_is_dma_xfer(controller
->mode
))
741 iomode
&= ~(QUP_IO_M_PACK_EN
| QUP_IO_M_UNPACK_EN
);
743 iomode
|= QUP_IO_M_PACK_EN
| QUP_IO_M_UNPACK_EN
;
745 iomode
|= (controller
->mode
<< QUP_IO_M_OUTPUT_MODE_MASK_SHIFT
);
746 iomode
|= (controller
->mode
<< QUP_IO_M_INPUT_MODE_MASK_SHIFT
);
748 writel_relaxed(iomode
, controller
->base
+ QUP_IO_M_MODES
);
750 control
= readl_relaxed(controller
->base
+ SPI_IO_CONTROL
);
752 if (spi
->mode
& SPI_CPOL
)
753 control
|= SPI_IO_C_CLK_IDLE_HIGH
;
755 control
&= ~SPI_IO_C_CLK_IDLE_HIGH
;
757 writel_relaxed(control
, controller
->base
+ SPI_IO_CONTROL
);
759 config
= readl_relaxed(controller
->base
+ SPI_CONFIG
);
761 if (spi
->mode
& SPI_LOOP
)
762 config
|= SPI_CONFIG_LOOPBACK
;
764 config
&= ~SPI_CONFIG_LOOPBACK
;
766 if (spi
->mode
& SPI_CPHA
)
767 config
&= ~SPI_CONFIG_INPUT_FIRST
;
769 config
|= SPI_CONFIG_INPUT_FIRST
;
772 * HS_MODE improves signal stability for spi-clk high rates,
773 * but is invalid in loop back mode.
775 if ((xfer
->speed_hz
>= SPI_HS_MIN_RATE
) && !(spi
->mode
& SPI_LOOP
))
776 config
|= SPI_CONFIG_HS_MODE
;
778 config
&= ~SPI_CONFIG_HS_MODE
;
780 writel_relaxed(config
, controller
->base
+ SPI_CONFIG
);
782 config
= readl_relaxed(controller
->base
+ QUP_CONFIG
);
783 config
&= ~(QUP_CONFIG_NO_INPUT
| QUP_CONFIG_NO_OUTPUT
| QUP_CONFIG_N
);
784 config
|= xfer
->bits_per_word
- 1;
785 config
|= QUP_CONFIG_SPI_MODE
;
787 if (spi_qup_is_dma_xfer(controller
->mode
)) {
789 config
|= QUP_CONFIG_NO_OUTPUT
;
791 config
|= QUP_CONFIG_NO_INPUT
;
794 writel_relaxed(config
, controller
->base
+ QUP_CONFIG
);
796 /* only write to OPERATIONAL_MASK when register is present */
797 if (!controller
->qup_v1
) {
801 * mask INPUT and OUTPUT service flags to prevent IRQs on FIFO
802 * status change in BAM mode
805 if (spi_qup_is_dma_xfer(controller
->mode
))
806 mask
= QUP_OP_IN_SERVICE_FLAG
| QUP_OP_OUT_SERVICE_FLAG
;
808 writel_relaxed(mask
, controller
->base
+ QUP_OPERATIONAL_MASK
);
814 static int spi_qup_transfer_one(struct spi_master
*master
,
815 struct spi_device
*spi
,
816 struct spi_transfer
*xfer
)
818 struct spi_qup
*controller
= spi_master_get_devdata(master
);
819 unsigned long timeout
, flags
;
822 ret
= spi_qup_io_prep(spi
, xfer
);
826 timeout
= DIV_ROUND_UP(xfer
->speed_hz
, MSEC_PER_SEC
);
827 timeout
= DIV_ROUND_UP(min_t(unsigned long, SPI_MAX_XFER
,
828 xfer
->len
) * 8, timeout
);
829 timeout
= 100 * msecs_to_jiffies(timeout
);
831 reinit_completion(&controller
->done
);
833 spin_lock_irqsave(&controller
->lock
, flags
);
834 controller
->xfer
= xfer
;
835 controller
->error
= 0;
836 controller
->rx_bytes
= 0;
837 controller
->tx_bytes
= 0;
838 spin_unlock_irqrestore(&controller
->lock
, flags
);
840 if (spi_qup_is_dma_xfer(controller
->mode
))
841 ret
= spi_qup_do_dma(spi
, xfer
, timeout
);
843 ret
= spi_qup_do_pio(spi
, xfer
, timeout
);
849 spi_qup_set_state(controller
, QUP_STATE_RESET
);
850 spin_lock_irqsave(&controller
->lock
, flags
);
852 ret
= controller
->error
;
853 spin_unlock_irqrestore(&controller
->lock
, flags
);
855 if (ret
&& spi_qup_is_dma_xfer(controller
->mode
))
856 spi_qup_dma_terminate(master
, xfer
);
861 static bool spi_qup_can_dma(struct spi_master
*master
, struct spi_device
*spi
,
862 struct spi_transfer
*xfer
)
864 struct spi_qup
*qup
= spi_master_get_devdata(master
);
865 size_t dma_align
= dma_get_cache_alignment();
869 if (!IS_ALIGNED((size_t)xfer
->rx_buf
, dma_align
) ||
870 IS_ERR_OR_NULL(master
->dma_rx
))
872 if (qup
->qup_v1
&& (xfer
->len
% qup
->in_blk_sz
))
877 if (!IS_ALIGNED((size_t)xfer
->tx_buf
, dma_align
) ||
878 IS_ERR_OR_NULL(master
->dma_tx
))
880 if (qup
->qup_v1
&& (xfer
->len
% qup
->out_blk_sz
))
884 n_words
= xfer
->len
/ DIV_ROUND_UP(xfer
->bits_per_word
, 8);
885 if (n_words
<= (qup
->in_fifo_sz
/ sizeof(u32
)))
891 static void spi_qup_release_dma(struct spi_master
*master
)
893 if (!IS_ERR_OR_NULL(master
->dma_rx
))
894 dma_release_channel(master
->dma_rx
);
895 if (!IS_ERR_OR_NULL(master
->dma_tx
))
896 dma_release_channel(master
->dma_tx
);
899 static int spi_qup_init_dma(struct spi_master
*master
, resource_size_t base
)
901 struct spi_qup
*spi
= spi_master_get_devdata(master
);
902 struct dma_slave_config
*rx_conf
= &spi
->rx_conf
,
903 *tx_conf
= &spi
->tx_conf
;
904 struct device
*dev
= spi
->dev
;
907 /* allocate dma resources, if available */
908 master
->dma_rx
= dma_request_slave_channel_reason(dev
, "rx");
909 if (IS_ERR(master
->dma_rx
))
910 return PTR_ERR(master
->dma_rx
);
912 master
->dma_tx
= dma_request_slave_channel_reason(dev
, "tx");
913 if (IS_ERR(master
->dma_tx
)) {
914 ret
= PTR_ERR(master
->dma_tx
);
918 /* set DMA parameters */
919 rx_conf
->direction
= DMA_DEV_TO_MEM
;
920 rx_conf
->device_fc
= 1;
921 rx_conf
->src_addr
= base
+ QUP_INPUT_FIFO
;
922 rx_conf
->src_maxburst
= spi
->in_blk_sz
;
924 tx_conf
->direction
= DMA_MEM_TO_DEV
;
925 tx_conf
->device_fc
= 1;
926 tx_conf
->dst_addr
= base
+ QUP_OUTPUT_FIFO
;
927 tx_conf
->dst_maxburst
= spi
->out_blk_sz
;
929 ret
= dmaengine_slave_config(master
->dma_rx
, rx_conf
);
931 dev_err(dev
, "failed to configure RX channel\n");
935 ret
= dmaengine_slave_config(master
->dma_tx
, tx_conf
);
937 dev_err(dev
, "failed to configure TX channel\n");
944 dma_release_channel(master
->dma_tx
);
946 dma_release_channel(master
->dma_rx
);
950 static void spi_qup_set_cs(struct spi_device
*spi
, bool val
)
952 struct spi_qup
*controller
;
956 controller
= spi_master_get_devdata(spi
->master
);
957 spi_ioc
= readl_relaxed(controller
->base
+ SPI_IO_CONTROL
);
958 spi_ioc_orig
= spi_ioc
;
960 spi_ioc
|= SPI_IO_C_FORCE_CS
;
962 spi_ioc
&= ~SPI_IO_C_FORCE_CS
;
964 if (spi_ioc
!= spi_ioc_orig
)
965 writel_relaxed(spi_ioc
, controller
->base
+ SPI_IO_CONTROL
);
968 static int spi_qup_probe(struct platform_device
*pdev
)
970 struct spi_master
*master
;
971 struct clk
*iclk
, *cclk
;
972 struct spi_qup
*controller
;
973 struct resource
*res
;
976 u32 max_freq
, iomode
, num_cs
;
980 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
981 base
= devm_ioremap_resource(dev
, res
);
983 return PTR_ERR(base
);
985 irq
= platform_get_irq(pdev
, 0);
989 cclk
= devm_clk_get(dev
, "core");
991 return PTR_ERR(cclk
);
993 iclk
= devm_clk_get(dev
, "iface");
995 return PTR_ERR(iclk
);
997 /* This is optional parameter */
998 if (of_property_read_u32(dev
->of_node
, "spi-max-frequency", &max_freq
))
999 max_freq
= SPI_MAX_RATE
;
1001 if (!max_freq
|| max_freq
> SPI_MAX_RATE
) {
1002 dev_err(dev
, "invalid clock frequency %d\n", max_freq
);
1006 ret
= clk_prepare_enable(cclk
);
1008 dev_err(dev
, "cannot enable core clock\n");
1012 ret
= clk_prepare_enable(iclk
);
1014 clk_disable_unprepare(cclk
);
1015 dev_err(dev
, "cannot enable iface clock\n");
1019 master
= spi_alloc_master(dev
, sizeof(struct spi_qup
));
1021 clk_disable_unprepare(cclk
);
1022 clk_disable_unprepare(iclk
);
1023 dev_err(dev
, "cannot allocate master\n");
1027 /* use num-cs unless not present or out of range */
1028 if (of_property_read_u32(dev
->of_node
, "num-cs", &num_cs
) ||
1029 num_cs
> SPI_NUM_CHIPSELECTS
)
1030 master
->num_chipselect
= SPI_NUM_CHIPSELECTS
;
1032 master
->num_chipselect
= num_cs
;
1034 master
->bus_num
= pdev
->id
;
1035 master
->mode_bits
= SPI_CPOL
| SPI_CPHA
| SPI_CS_HIGH
| SPI_LOOP
;
1036 master
->bits_per_word_mask
= SPI_BPW_RANGE_MASK(4, 32);
1037 master
->max_speed_hz
= max_freq
;
1038 master
->transfer_one
= spi_qup_transfer_one
;
1039 master
->dev
.of_node
= pdev
->dev
.of_node
;
1040 master
->auto_runtime_pm
= true;
1041 master
->dma_alignment
= dma_get_cache_alignment();
1042 master
->max_dma_len
= SPI_MAX_XFER
;
1044 platform_set_drvdata(pdev
, master
);
1046 controller
= spi_master_get_devdata(master
);
1048 controller
->dev
= dev
;
1049 controller
->base
= base
;
1050 controller
->iclk
= iclk
;
1051 controller
->cclk
= cclk
;
1052 controller
->irq
= irq
;
1054 ret
= spi_qup_init_dma(master
, res
->start
);
1055 if (ret
== -EPROBE_DEFER
)
1058 master
->can_dma
= spi_qup_can_dma
;
1060 controller
->qup_v1
= (uintptr_t)of_device_get_match_data(dev
);
1062 if (!controller
->qup_v1
)
1063 master
->set_cs
= spi_qup_set_cs
;
1065 spin_lock_init(&controller
->lock
);
1066 init_completion(&controller
->done
);
1068 iomode
= readl_relaxed(base
+ QUP_IO_M_MODES
);
1070 size
= QUP_IO_M_OUTPUT_BLOCK_SIZE(iomode
);
1072 controller
->out_blk_sz
= size
* 16;
1074 controller
->out_blk_sz
= 4;
1076 size
= QUP_IO_M_INPUT_BLOCK_SIZE(iomode
);
1078 controller
->in_blk_sz
= size
* 16;
1080 controller
->in_blk_sz
= 4;
1082 size
= QUP_IO_M_OUTPUT_FIFO_SIZE(iomode
);
1083 controller
->out_fifo_sz
= controller
->out_blk_sz
* (2 << size
);
1085 size
= QUP_IO_M_INPUT_FIFO_SIZE(iomode
);
1086 controller
->in_fifo_sz
= controller
->in_blk_sz
* (2 << size
);
1088 dev_info(dev
, "IN:block:%d, fifo:%d, OUT:block:%d, fifo:%d\n",
1089 controller
->in_blk_sz
, controller
->in_fifo_sz
,
1090 controller
->out_blk_sz
, controller
->out_fifo_sz
);
1092 writel_relaxed(1, base
+ QUP_SW_RESET
);
1094 ret
= spi_qup_set_state(controller
, QUP_STATE_RESET
);
1096 dev_err(dev
, "cannot set RESET state\n");
1100 writel_relaxed(0, base
+ QUP_OPERATIONAL
);
1101 writel_relaxed(0, base
+ QUP_IO_M_MODES
);
1103 if (!controller
->qup_v1
)
1104 writel_relaxed(0, base
+ QUP_OPERATIONAL_MASK
);
1106 writel_relaxed(SPI_ERROR_CLK_UNDER_RUN
| SPI_ERROR_CLK_OVER_RUN
,
1107 base
+ SPI_ERROR_FLAGS_EN
);
1109 /* if earlier version of the QUP, disable INPUT_OVERRUN */
1110 if (controller
->qup_v1
)
1111 writel_relaxed(QUP_ERROR_OUTPUT_OVER_RUN
|
1112 QUP_ERROR_INPUT_UNDER_RUN
| QUP_ERROR_OUTPUT_UNDER_RUN
,
1113 base
+ QUP_ERROR_FLAGS_EN
);
1115 writel_relaxed(0, base
+ SPI_CONFIG
);
1116 writel_relaxed(SPI_IO_C_NO_TRI_STATE
, base
+ SPI_IO_CONTROL
);
1118 ret
= devm_request_irq(dev
, irq
, spi_qup_qup_irq
,
1119 IRQF_TRIGGER_HIGH
, pdev
->name
, controller
);
1123 pm_runtime_set_autosuspend_delay(dev
, MSEC_PER_SEC
);
1124 pm_runtime_use_autosuspend(dev
);
1125 pm_runtime_set_active(dev
);
1126 pm_runtime_enable(dev
);
1128 ret
= devm_spi_register_master(dev
, master
);
1135 pm_runtime_disable(&pdev
->dev
);
1137 spi_qup_release_dma(master
);
1139 clk_disable_unprepare(cclk
);
1140 clk_disable_unprepare(iclk
);
1141 spi_master_put(master
);
1146 static int spi_qup_pm_suspend_runtime(struct device
*device
)
1148 struct spi_master
*master
= dev_get_drvdata(device
);
1149 struct spi_qup
*controller
= spi_master_get_devdata(master
);
1152 /* Enable clocks auto gaiting */
1153 config
= readl(controller
->base
+ QUP_CONFIG
);
1154 config
|= QUP_CONFIG_CLOCK_AUTO_GATE
;
1155 writel_relaxed(config
, controller
->base
+ QUP_CONFIG
);
1157 clk_disable_unprepare(controller
->cclk
);
1158 clk_disable_unprepare(controller
->iclk
);
1163 static int spi_qup_pm_resume_runtime(struct device
*device
)
1165 struct spi_master
*master
= dev_get_drvdata(device
);
1166 struct spi_qup
*controller
= spi_master_get_devdata(master
);
1170 ret
= clk_prepare_enable(controller
->iclk
);
1174 ret
= clk_prepare_enable(controller
->cclk
);
1178 /* Disable clocks auto gaiting */
1179 config
= readl_relaxed(controller
->base
+ QUP_CONFIG
);
1180 config
&= ~QUP_CONFIG_CLOCK_AUTO_GATE
;
1181 writel_relaxed(config
, controller
->base
+ QUP_CONFIG
);
1184 #endif /* CONFIG_PM */
1186 #ifdef CONFIG_PM_SLEEP
1187 static int spi_qup_suspend(struct device
*device
)
1189 struct spi_master
*master
= dev_get_drvdata(device
);
1190 struct spi_qup
*controller
= spi_master_get_devdata(master
);
1193 if (pm_runtime_suspended(device
)) {
1194 ret
= spi_qup_pm_resume_runtime(device
);
1198 ret
= spi_master_suspend(master
);
1202 ret
= spi_qup_set_state(controller
, QUP_STATE_RESET
);
1206 clk_disable_unprepare(controller
->cclk
);
1207 clk_disable_unprepare(controller
->iclk
);
1211 static int spi_qup_resume(struct device
*device
)
1213 struct spi_master
*master
= dev_get_drvdata(device
);
1214 struct spi_qup
*controller
= spi_master_get_devdata(master
);
1217 ret
= clk_prepare_enable(controller
->iclk
);
1221 ret
= clk_prepare_enable(controller
->cclk
);
1225 ret
= spi_qup_set_state(controller
, QUP_STATE_RESET
);
1229 return spi_master_resume(master
);
1231 #endif /* CONFIG_PM_SLEEP */
1233 static int spi_qup_remove(struct platform_device
*pdev
)
1235 struct spi_master
*master
= dev_get_drvdata(&pdev
->dev
);
1236 struct spi_qup
*controller
= spi_master_get_devdata(master
);
1239 ret
= pm_runtime_get_sync(&pdev
->dev
);
1243 ret
= spi_qup_set_state(controller
, QUP_STATE_RESET
);
1247 spi_qup_release_dma(master
);
1249 clk_disable_unprepare(controller
->cclk
);
1250 clk_disable_unprepare(controller
->iclk
);
1252 pm_runtime_put_noidle(&pdev
->dev
);
1253 pm_runtime_disable(&pdev
->dev
);
1258 static const struct of_device_id spi_qup_dt_match
[] = {
1259 { .compatible
= "qcom,spi-qup-v1.1.1", .data
= (void *)1, },
1260 { .compatible
= "qcom,spi-qup-v2.1.1", },
1261 { .compatible
= "qcom,spi-qup-v2.2.1", },
1264 MODULE_DEVICE_TABLE(of
, spi_qup_dt_match
);
1266 static const struct dev_pm_ops spi_qup_dev_pm_ops
= {
1267 SET_SYSTEM_SLEEP_PM_OPS(spi_qup_suspend
, spi_qup_resume
)
1268 SET_RUNTIME_PM_OPS(spi_qup_pm_suspend_runtime
,
1269 spi_qup_pm_resume_runtime
,
1273 static struct platform_driver spi_qup_driver
= {
1276 .pm
= &spi_qup_dev_pm_ops
,
1277 .of_match_table
= spi_qup_dt_match
,
1279 .probe
= spi_qup_probe
,
1280 .remove
= spi_qup_remove
,
1282 module_platform_driver(spi_qup_driver
);
1284 MODULE_LICENSE("GPL v2");
1285 MODULE_ALIAS("platform:spi_qup");