1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (C) 2005 Stephen Street / StreetFire Sound Labs
4 * Copyright (C) 2013, 2021 Intel Corporation
7 #include <linux/acpi.h>
8 #include <linux/bitops.h>
10 #include <linux/delay.h>
11 #include <linux/device.h>
12 #include <linux/dmaengine.h>
13 #include <linux/err.h>
14 #include <linux/errno.h>
15 #include <linux/gpio/consumer.h>
16 #include <linux/gpio.h>
17 #include <linux/init.h>
18 #include <linux/interrupt.h>
19 #include <linux/ioport.h>
20 #include <linux/kernel.h>
21 #include <linux/module.h>
22 #include <linux/mod_devicetable.h>
24 #include <linux/pci.h>
25 #include <linux/platform_device.h>
26 #include <linux/pm_runtime.h>
27 #include <linux/property.h>
28 #include <linux/slab.h>
30 #include <linux/spi/pxa2xx_spi.h>
31 #include <linux/spi/spi.h>
33 #include "spi-pxa2xx.h"
35 MODULE_AUTHOR("Stephen Street");
36 MODULE_DESCRIPTION("PXA2xx SSP SPI Controller");
37 MODULE_LICENSE("GPL");
38 MODULE_ALIAS("platform:pxa2xx-spi");
40 #define TIMOUT_DFLT 1000
43 * For testing SSCR1 changes that require SSP restart, basically
44 * everything except the service and interrupt enables, the PXA270 developer
45 * manual says only SSCR1_SCFR, SSCR1_SPH, SSCR1_SPO need to be in this
46 * list, but the PXA255 developer manual says all bits without really meaning
47 * the service and interrupt enables.
49 #define SSCR1_CHANGE_MASK (SSCR1_TTELP | SSCR1_TTE | SSCR1_SCFR \
50 | SSCR1_ECRA | SSCR1_ECRB | SSCR1_SCLKDIR \
51 | SSCR1_SFRMDIR | SSCR1_RWOT | SSCR1_TRAIL \
52 | SSCR1_IFS | SSCR1_STRF | SSCR1_EFWR \
53 | SSCR1_RFT | SSCR1_TFT | SSCR1_MWDS \
54 | SSCR1_SPH | SSCR1_SPO | SSCR1_LBM)
56 #define QUARK_X1000_SSCR1_CHANGE_MASK (QUARK_X1000_SSCR1_STRF \
57 | QUARK_X1000_SSCR1_EFWR \
58 | QUARK_X1000_SSCR1_RFT \
59 | QUARK_X1000_SSCR1_TFT \
60 | SSCR1_SPH | SSCR1_SPO | SSCR1_LBM)
62 #define CE4100_SSCR1_CHANGE_MASK (SSCR1_TTELP | SSCR1_TTE | SSCR1_SCFR \
63 | SSCR1_ECRA | SSCR1_ECRB | SSCR1_SCLKDIR \
64 | SSCR1_SFRMDIR | SSCR1_RWOT | SSCR1_TRAIL \
65 | SSCR1_IFS | SSCR1_STRF | SSCR1_EFWR \
66 | CE4100_SSCR1_RFT | CE4100_SSCR1_TFT | SSCR1_MWDS \
67 | SSCR1_SPH | SSCR1_SPO | SSCR1_LBM)
69 #define LPSS_GENERAL_REG_RXTO_HOLDOFF_DISABLE BIT(24)
70 #define LPSS_CS_CONTROL_SW_MODE BIT(0)
71 #define LPSS_CS_CONTROL_CS_HIGH BIT(1)
72 #define LPSS_CAPS_CS_EN_SHIFT 9
73 #define LPSS_CAPS_CS_EN_MASK (0xf << LPSS_CAPS_CS_EN_SHIFT)
75 #define LPSS_PRIV_CLOCK_GATE 0x38
76 #define LPSS_PRIV_CLOCK_GATE_CLK_CTL_MASK 0x3
77 #define LPSS_PRIV_CLOCK_GATE_CLK_CTL_FORCE_ON 0x3
80 /* LPSS offset from drv_data->ioaddr */
82 /* Register offsets from drv_data->lpss_base or -1 */
91 /* Chip select control */
92 unsigned cs_sel_shift;
96 unsigned cs_clk_stays_gated : 1;
99 /* Keep these sorted with enum pxa_ssp_type */
100 static const struct lpss_config lpss_platforms[] = {
106 .reg_capabilities = -1,
108 .tx_threshold_lo = 160,
109 .tx_threshold_hi = 224,
116 .reg_capabilities = -1,
118 .tx_threshold_lo = 160,
119 .tx_threshold_hi = 224,
126 .reg_capabilities = -1,
128 .tx_threshold_lo = 160,
129 .tx_threshold_hi = 224,
131 .cs_sel_mask = 1 << 2,
139 .reg_capabilities = -1,
141 .tx_threshold_lo = 32,
142 .tx_threshold_hi = 56,
149 .reg_capabilities = 0xfc,
151 .tx_threshold_lo = 16,
152 .tx_threshold_hi = 48,
154 .cs_sel_mask = 3 << 8,
155 .cs_clk_stays_gated = true,
162 .reg_capabilities = 0xfc,
164 .tx_threshold_lo = 32,
165 .tx_threshold_hi = 56,
167 .cs_sel_mask = 3 << 8,
168 .cs_clk_stays_gated = true,
172 static inline const struct lpss_config
173 *lpss_get_config(const struct driver_data *drv_data)
175 return &lpss_platforms[drv_data->ssp_type - LPSS_LPT_SSP];
178 static bool is_lpss_ssp(const struct driver_data *drv_data)
180 switch (drv_data->ssp_type) {
193 static bool is_quark_x1000_ssp(const struct driver_data *drv_data)
195 return drv_data->ssp_type == QUARK_X1000_SSP;
198 static bool is_mmp2_ssp(const struct driver_data *drv_data)
200 return drv_data->ssp_type == MMP2_SSP;
203 static bool is_mrfld_ssp(const struct driver_data *drv_data)
205 return drv_data->ssp_type == MRFLD_SSP;
208 static void pxa2xx_spi_update(const struct driver_data *drv_data, u32 reg, u32 mask, u32 value)
210 if ((pxa2xx_spi_read(drv_data, reg) & mask) != value)
211 pxa2xx_spi_write(drv_data, reg, value & mask);
214 static u32 pxa2xx_spi_get_ssrc1_change_mask(const struct driver_data *drv_data)
216 switch (drv_data->ssp_type) {
217 case QUARK_X1000_SSP:
218 return QUARK_X1000_SSCR1_CHANGE_MASK;
220 return CE4100_SSCR1_CHANGE_MASK;
222 return SSCR1_CHANGE_MASK;
227 pxa2xx_spi_get_rx_default_thre(const struct driver_data *drv_data)
229 switch (drv_data->ssp_type) {
230 case QUARK_X1000_SSP:
231 return RX_THRESH_QUARK_X1000_DFLT;
233 return RX_THRESH_CE4100_DFLT;
235 return RX_THRESH_DFLT;
239 static bool pxa2xx_spi_txfifo_full(const struct driver_data *drv_data)
243 switch (drv_data->ssp_type) {
244 case QUARK_X1000_SSP:
245 mask = QUARK_X1000_SSSR_TFL_MASK;
248 mask = CE4100_SSSR_TFL_MASK;
251 mask = SSSR_TFL_MASK;
255 return read_SSSR_bits(drv_data, mask) == mask;
258 static void pxa2xx_spi_clear_rx_thre(const struct driver_data *drv_data,
263 switch (drv_data->ssp_type) {
264 case QUARK_X1000_SSP:
265 mask = QUARK_X1000_SSCR1_RFT;
268 mask = CE4100_SSCR1_RFT;
277 static void pxa2xx_spi_set_rx_thre(const struct driver_data *drv_data,
278 u32 *sccr1_reg, u32 threshold)
280 switch (drv_data->ssp_type) {
281 case QUARK_X1000_SSP:
282 *sccr1_reg |= QUARK_X1000_SSCR1_RxTresh(threshold);
285 *sccr1_reg |= CE4100_SSCR1_RxTresh(threshold);
288 *sccr1_reg |= SSCR1_RxTresh(threshold);
293 static u32 pxa2xx_configure_sscr0(const struct driver_data *drv_data,
294 u32 clk_div, u8 bits)
296 switch (drv_data->ssp_type) {
297 case QUARK_X1000_SSP:
299 | QUARK_X1000_SSCR0_Motorola
300 | QUARK_X1000_SSCR0_DataSize(bits > 32 ? 8 : bits);
304 | SSCR0_DataSize(bits > 16 ? bits - 16 : bits)
305 | (bits > 16 ? SSCR0_EDSS : 0);
310 * Read and write LPSS SSP private registers. Caller must first check that
311 * is_lpss_ssp() returns true before these can be called.
313 static u32 __lpss_ssp_read_priv(struct driver_data *drv_data, unsigned offset)
315 WARN_ON(!drv_data->lpss_base);
316 return readl(drv_data->lpss_base + offset);
319 static void __lpss_ssp_write_priv(struct driver_data *drv_data,
320 unsigned offset, u32 value)
322 WARN_ON(!drv_data->lpss_base);
323 writel(value, drv_data->lpss_base + offset);
327 * lpss_ssp_setup - perform LPSS SSP specific setup
328 * @drv_data: pointer to the driver private data
330 * Perform LPSS SSP specific setup. This function must be called first if
331 * one is going to use LPSS SSP private registers.
333 static void lpss_ssp_setup(struct driver_data *drv_data)
335 const struct lpss_config *config;
338 config = lpss_get_config(drv_data);
339 drv_data->lpss_base = drv_data->ssp->mmio_base + config->offset;
341 /* Enable software chip select control */
342 value = __lpss_ssp_read_priv(drv_data, config->reg_cs_ctrl);
343 value &= ~(LPSS_CS_CONTROL_SW_MODE | LPSS_CS_CONTROL_CS_HIGH);
344 value |= LPSS_CS_CONTROL_SW_MODE | LPSS_CS_CONTROL_CS_HIGH;
345 __lpss_ssp_write_priv(drv_data, config->reg_cs_ctrl, value);
347 /* Enable multiblock DMA transfers */
348 if (drv_data->controller_info->enable_dma) {
349 __lpss_ssp_write_priv(drv_data, config->reg_ssp, 1);
351 if (config->reg_general >= 0) {
352 value = __lpss_ssp_read_priv(drv_data,
353 config->reg_general);
354 value |= LPSS_GENERAL_REG_RXTO_HOLDOFF_DISABLE;
355 __lpss_ssp_write_priv(drv_data,
356 config->reg_general, value);
361 static void lpss_ssp_select_cs(struct spi_device *spi,
362 const struct lpss_config *config)
364 struct driver_data *drv_data =
365 spi_controller_get_devdata(spi->controller);
368 if (!config->cs_sel_mask)
371 value = __lpss_ssp_read_priv(drv_data, config->reg_cs_ctrl);
373 cs = spi->chip_select;
374 cs <<= config->cs_sel_shift;
375 if (cs != (value & config->cs_sel_mask)) {
377 * When switching another chip select output active the
378 * output must be selected first and wait 2 ssp_clk cycles
379 * before changing state to active. Otherwise a short
380 * glitch will occur on the previous chip select since
381 * output select is latched but state control is not.
383 value &= ~config->cs_sel_mask;
385 __lpss_ssp_write_priv(drv_data,
386 config->reg_cs_ctrl, value);
388 (drv_data->controller->max_speed_hz / 2));
392 static void lpss_ssp_cs_control(struct spi_device *spi, bool enable)
394 struct driver_data *drv_data =
395 spi_controller_get_devdata(spi->controller);
396 const struct lpss_config *config;
399 config = lpss_get_config(drv_data);
402 lpss_ssp_select_cs(spi, config);
404 value = __lpss_ssp_read_priv(drv_data, config->reg_cs_ctrl);
406 value &= ~LPSS_CS_CONTROL_CS_HIGH;
408 value |= LPSS_CS_CONTROL_CS_HIGH;
409 __lpss_ssp_write_priv(drv_data, config->reg_cs_ctrl, value);
410 if (config->cs_clk_stays_gated) {
414 * Changing CS alone when dynamic clock gating is on won't
415 * actually flip CS at that time. This ruins SPI transfers
416 * that specify delays, or have no data. Toggle the clock mode
417 * to force on briefly to poke the CS pin to move.
419 clkgate = __lpss_ssp_read_priv(drv_data, LPSS_PRIV_CLOCK_GATE);
420 value = (clkgate & ~LPSS_PRIV_CLOCK_GATE_CLK_CTL_MASK) |
421 LPSS_PRIV_CLOCK_GATE_CLK_CTL_FORCE_ON;
423 __lpss_ssp_write_priv(drv_data, LPSS_PRIV_CLOCK_GATE, value);
424 __lpss_ssp_write_priv(drv_data, LPSS_PRIV_CLOCK_GATE, clkgate);
428 static void cs_assert(struct spi_device *spi)
430 struct chip_data *chip = spi_get_ctldata(spi);
431 struct driver_data *drv_data =
432 spi_controller_get_devdata(spi->controller);
434 if (drv_data->ssp_type == CE4100_SSP) {
435 pxa2xx_spi_write(drv_data, SSSR, spi->chip_select);
439 if (chip->cs_control) {
440 chip->cs_control(PXA2XX_CS_ASSERT);
444 if (is_lpss_ssp(drv_data))
445 lpss_ssp_cs_control(spi, true);
448 static void cs_deassert(struct spi_device *spi)
450 struct chip_data *chip = spi_get_ctldata(spi);
451 struct driver_data *drv_data =
452 spi_controller_get_devdata(spi->controller);
453 unsigned long timeout;
455 if (drv_data->ssp_type == CE4100_SSP)
458 /* Wait until SSP becomes idle before deasserting the CS */
459 timeout = jiffies + msecs_to_jiffies(10);
460 while (pxa2xx_spi_read(drv_data, SSSR) & SSSR_BSY &&
461 !time_after(jiffies, timeout))
464 if (chip->cs_control) {
465 chip->cs_control(PXA2XX_CS_DEASSERT);
469 if (is_lpss_ssp(drv_data))
470 lpss_ssp_cs_control(spi, false);
473 static void pxa2xx_spi_set_cs(struct spi_device *spi, bool level)
481 int pxa2xx_spi_flush(struct driver_data *drv_data)
483 unsigned long limit = loops_per_jiffy << 1;
486 while (read_SSSR_bits(drv_data, SSSR_RNE))
487 pxa2xx_spi_read(drv_data, SSDR);
488 } while ((pxa2xx_spi_read(drv_data, SSSR) & SSSR_BSY) && --limit);
489 write_SSSR_CS(drv_data, SSSR_ROR);
494 static void pxa2xx_spi_off(struct driver_data *drv_data)
496 /* On MMP, disabling SSE seems to corrupt the Rx FIFO */
497 if (is_mmp2_ssp(drv_data))
500 pxa_ssp_disable(drv_data->ssp);
503 static int null_writer(struct driver_data *drv_data)
505 u8 n_bytes = drv_data->n_bytes;
507 if (pxa2xx_spi_txfifo_full(drv_data)
508 || (drv_data->tx == drv_data->tx_end))
511 pxa2xx_spi_write(drv_data, SSDR, 0);
512 drv_data->tx += n_bytes;
517 static int null_reader(struct driver_data *drv_data)
519 u8 n_bytes = drv_data->n_bytes;
521 while (read_SSSR_bits(drv_data, SSSR_RNE) && drv_data->rx < drv_data->rx_end) {
522 pxa2xx_spi_read(drv_data, SSDR);
523 drv_data->rx += n_bytes;
526 return drv_data->rx == drv_data->rx_end;
529 static int u8_writer(struct driver_data *drv_data)
531 if (pxa2xx_spi_txfifo_full(drv_data)
532 || (drv_data->tx == drv_data->tx_end))
535 pxa2xx_spi_write(drv_data, SSDR, *(u8 *)(drv_data->tx));
541 static int u8_reader(struct driver_data *drv_data)
543 while (read_SSSR_bits(drv_data, SSSR_RNE) && drv_data->rx < drv_data->rx_end) {
544 *(u8 *)(drv_data->rx) = pxa2xx_spi_read(drv_data, SSDR);
548 return drv_data->rx == drv_data->rx_end;
551 static int u16_writer(struct driver_data *drv_data)
553 if (pxa2xx_spi_txfifo_full(drv_data)
554 || (drv_data->tx == drv_data->tx_end))
557 pxa2xx_spi_write(drv_data, SSDR, *(u16 *)(drv_data->tx));
563 static int u16_reader(struct driver_data *drv_data)
565 while (read_SSSR_bits(drv_data, SSSR_RNE) && drv_data->rx < drv_data->rx_end) {
566 *(u16 *)(drv_data->rx) = pxa2xx_spi_read(drv_data, SSDR);
570 return drv_data->rx == drv_data->rx_end;
573 static int u32_writer(struct driver_data *drv_data)
575 if (pxa2xx_spi_txfifo_full(drv_data)
576 || (drv_data->tx == drv_data->tx_end))
579 pxa2xx_spi_write(drv_data, SSDR, *(u32 *)(drv_data->tx));
585 static int u32_reader(struct driver_data *drv_data)
587 while (read_SSSR_bits(drv_data, SSSR_RNE) && drv_data->rx < drv_data->rx_end) {
588 *(u32 *)(drv_data->rx) = pxa2xx_spi_read(drv_data, SSDR);
592 return drv_data->rx == drv_data->rx_end;
595 static void reset_sccr1(struct driver_data *drv_data)
597 u32 mask = drv_data->int_cr1 | drv_data->dma_cr1, threshold;
598 struct chip_data *chip;
600 if (drv_data->controller->cur_msg) {
601 chip = spi_get_ctldata(drv_data->controller->cur_msg->spi);
602 threshold = chip->threshold;
607 switch (drv_data->ssp_type) {
608 case QUARK_X1000_SSP:
609 mask |= QUARK_X1000_SSCR1_RFT;
612 mask |= CE4100_SSCR1_RFT;
619 pxa2xx_spi_update(drv_data, SSCR1, mask, threshold);
622 static void int_stop_and_reset(struct driver_data *drv_data)
624 /* Clear and disable interrupts */
625 write_SSSR_CS(drv_data, drv_data->clear_sr);
626 reset_sccr1(drv_data);
627 if (pxa25x_ssp_comp(drv_data))
630 pxa2xx_spi_write(drv_data, SSTO, 0);
633 static void int_error_stop(struct driver_data *drv_data, const char *msg, int err)
635 int_stop_and_reset(drv_data);
636 pxa2xx_spi_flush(drv_data);
637 pxa2xx_spi_off(drv_data);
639 dev_err(drv_data->ssp->dev, "%s\n", msg);
641 drv_data->controller->cur_msg->status = err;
642 spi_finalize_current_transfer(drv_data->controller);
645 static void int_transfer_complete(struct driver_data *drv_data)
647 int_stop_and_reset(drv_data);
649 spi_finalize_current_transfer(drv_data->controller);
652 static irqreturn_t interrupt_transfer(struct driver_data *drv_data)
656 irq_status = read_SSSR_bits(drv_data, drv_data->mask_sr);
657 if (!(pxa2xx_spi_read(drv_data, SSCR1) & SSCR1_TIE))
658 irq_status &= ~SSSR_TFS;
660 if (irq_status & SSSR_ROR) {
661 int_error_stop(drv_data, "interrupt_transfer: FIFO overrun", -EIO);
665 if (irq_status & SSSR_TUR) {
666 int_error_stop(drv_data, "interrupt_transfer: FIFO underrun", -EIO);
670 if (irq_status & SSSR_TINT) {
671 pxa2xx_spi_write(drv_data, SSSR, SSSR_TINT);
672 if (drv_data->read(drv_data)) {
673 int_transfer_complete(drv_data);
678 /* Drain Rx FIFO, Fill Tx FIFO and prevent overruns */
680 if (drv_data->read(drv_data)) {
681 int_transfer_complete(drv_data);
684 } while (drv_data->write(drv_data));
686 if (drv_data->read(drv_data)) {
687 int_transfer_complete(drv_data);
691 if (drv_data->tx == drv_data->tx_end) {
695 sccr1_reg = pxa2xx_spi_read(drv_data, SSCR1);
696 sccr1_reg &= ~SSCR1_TIE;
699 * PXA25x_SSP has no timeout, set up Rx threshold for
700 * the remaining Rx bytes.
702 if (pxa25x_ssp_comp(drv_data)) {
705 pxa2xx_spi_clear_rx_thre(drv_data, &sccr1_reg);
707 bytes_left = drv_data->rx_end - drv_data->rx;
708 switch (drv_data->n_bytes) {
717 rx_thre = pxa2xx_spi_get_rx_default_thre(drv_data);
718 if (rx_thre > bytes_left)
719 rx_thre = bytes_left;
721 pxa2xx_spi_set_rx_thre(drv_data, &sccr1_reg, rx_thre);
723 pxa2xx_spi_write(drv_data, SSCR1, sccr1_reg);
726 /* We did something */
730 static void handle_bad_msg(struct driver_data *drv_data)
732 int_stop_and_reset(drv_data);
733 pxa2xx_spi_off(drv_data);
735 dev_err(drv_data->ssp->dev, "bad message state in interrupt handler\n");
738 static irqreturn_t ssp_int(int irq, void *dev_id)
740 struct driver_data *drv_data = dev_id;
742 u32 mask = drv_data->mask_sr;
746 * The IRQ might be shared with other peripherals so we must first
747 * check that are we RPM suspended or not. If we are we assume that
748 * the IRQ was not for us (we shouldn't be RPM suspended when the
749 * interrupt is enabled).
751 if (pm_runtime_suspended(drv_data->ssp->dev))
755 * If the device is not yet in RPM suspended state and we get an
756 * interrupt that is meant for another device, check if status bits
757 * are all set to one. That means that the device is already
760 status = pxa2xx_spi_read(drv_data, SSSR);
764 sccr1_reg = pxa2xx_spi_read(drv_data, SSCR1);
766 /* Ignore possible writes if we don't need to write */
767 if (!(sccr1_reg & SSCR1_TIE))
770 /* Ignore RX timeout interrupt if it is disabled */
771 if (!(sccr1_reg & SSCR1_TINTE))
774 if (!(status & mask))
777 pxa2xx_spi_write(drv_data, SSCR1, sccr1_reg & ~drv_data->int_cr1);
778 pxa2xx_spi_write(drv_data, SSCR1, sccr1_reg);
780 if (!drv_data->controller->cur_msg) {
781 handle_bad_msg(drv_data);
786 return drv_data->transfer_handler(drv_data);
790 * The Quark SPI has an additional 24 bit register (DDS_CLK_RATE) to multiply
791 * input frequency by fractions of 2^24. It also has a divider by 5.
793 * There are formulas to get baud rate value for given input frequency and
794 * divider parameters, such as DDS_CLK_RATE and SCR:
798 * Fssp = Fsys * DDS_CLK_RATE / 2^24 (1)
799 * Baud rate = Fsclk = Fssp / (2 * (SCR + 1)) (2)
801 * DDS_CLK_RATE either 2^n or 2^n / 5.
802 * SCR is in range 0 .. 255
804 * Divisor = 5^i * 2^j * 2 * k
805 * i = [0, 1] i = 1 iff j = 0 or j > 3
806 * j = [0, 23] j = 0 iff i = 1
808 * Special case: j = 0, i = 1: Divisor = 2 / 5
810 * Accordingly to the specification the recommended values for DDS_CLK_RATE
812 * Case 1: 2^n, n = [0, 23]
813 * Case 2: 2^24 * 2 / 5 (0x666666)
814 * Case 3: less than or equal to 2^24 / 5 / 16 (0x33333)
816 * In all cases the lowest possible value is better.
818 * The function calculates parameters for all cases and chooses the one closest
819 * to the asked baud rate.
821 static unsigned int quark_x1000_get_clk_div(int rate, u32 *dds)
823 unsigned long xtal = 200000000;
824 unsigned long fref = xtal / 2; /* mandatory division by 2,
827 unsigned long fref1 = fref / 2; /* case 1 */
828 unsigned long fref2 = fref * 2 / 5; /* case 2 */
830 unsigned long q, q1, q2;
836 /* Set initial value for DDS_CLK_RATE */
837 mul = (1 << 24) >> 1;
839 /* Calculate initial quot */
840 q1 = DIV_ROUND_UP(fref1, rate);
842 /* Scale q1 if it's too big */
844 /* Scale q1 to range [1, 512] */
845 scale = fls_long(q1 - 1);
851 /* Round the result if we have a remainder */
855 /* Decrease DDS_CLK_RATE as much as we can without loss in precision */
860 /* Get the remainder */
861 r1 = abs(fref1 / (1 << (24 - fls_long(mul))) / q1 - rate);
865 q2 = DIV_ROUND_UP(fref2, rate);
866 r2 = abs(fref2 / q2 - rate);
869 * Choose the best between two: less remainder we have the better. We
870 * can't go case 2 if q2 is greater than 256 since SCR register can
871 * hold only values 0 .. 255.
873 if (r2 >= r1 || q2 > 256) {
874 /* case 1 is better */
878 /* case 2 is better */
881 mul = (1 << 24) * 2 / 5;
884 /* Check case 3 only if the divisor is big enough */
885 if (fref / rate >= 80) {
889 /* Calculate initial quot */
890 q1 = DIV_ROUND_UP(fref, rate);
893 /* Get the remainder */
894 fssp = (u64)fref * m;
895 do_div(fssp, 1 << 24);
896 r1 = abs(fssp - rate);
898 /* Choose this one if it suits better */
900 /* case 3 is better */
910 static unsigned int ssp_get_clk_div(struct driver_data *drv_data, int rate)
912 unsigned long ssp_clk = drv_data->controller->max_speed_hz;
913 const struct ssp_device *ssp = drv_data->ssp;
915 rate = min_t(int, ssp_clk, rate);
918 * Calculate the divisor for the SCR (Serial Clock Rate), avoiding
919 * that the SSP transmission rate can be greater than the device rate.
921 if (ssp->type == PXA25x_SSP || ssp->type == CE4100_SSP)
922 return (DIV_ROUND_UP(ssp_clk, 2 * rate) - 1) & 0xff;
924 return (DIV_ROUND_UP(ssp_clk, rate) - 1) & 0xfff;
927 static unsigned int pxa2xx_ssp_get_clk_div(struct driver_data *drv_data,
930 struct chip_data *chip =
931 spi_get_ctldata(drv_data->controller->cur_msg->spi);
932 unsigned int clk_div;
934 switch (drv_data->ssp_type) {
935 case QUARK_X1000_SSP:
936 clk_div = quark_x1000_get_clk_div(rate, &chip->dds_rate);
939 clk_div = ssp_get_clk_div(drv_data, rate);
945 static bool pxa2xx_spi_can_dma(struct spi_controller *controller,
946 struct spi_device *spi,
947 struct spi_transfer *xfer)
949 struct chip_data *chip = spi_get_ctldata(spi);
951 return chip->enable_dma &&
952 xfer->len <= MAX_DMA_LEN &&
953 xfer->len >= chip->dma_burst_size;
956 static int pxa2xx_spi_transfer_one(struct spi_controller *controller,
957 struct spi_device *spi,
958 struct spi_transfer *transfer)
960 struct driver_data *drv_data = spi_controller_get_devdata(controller);
961 struct spi_message *message = controller->cur_msg;
962 struct chip_data *chip = spi_get_ctldata(spi);
963 u32 dma_thresh = chip->dma_threshold;
964 u32 dma_burst = chip->dma_burst_size;
965 u32 change_mask = pxa2xx_spi_get_ssrc1_change_mask(drv_data);
974 /* Check if we can DMA this transfer */
975 if (transfer->len > MAX_DMA_LEN && chip->enable_dma) {
977 /* Reject already-mapped transfers; PIO won't always work */
978 if (message->is_dma_mapped
979 || transfer->rx_dma || transfer->tx_dma) {
981 "Mapped transfer length of %u is greater than %d\n",
982 transfer->len, MAX_DMA_LEN);
986 /* Warn ... we force this to PIO mode */
987 dev_warn_ratelimited(&spi->dev,
988 "DMA disabled for transfer length %u greater than %d\n",
989 transfer->len, MAX_DMA_LEN);
992 /* Setup the transfer state based on the type of transfer */
993 if (pxa2xx_spi_flush(drv_data) == 0) {
994 dev_err(&spi->dev, "Flush failed\n");
997 drv_data->n_bytes = chip->n_bytes;
998 drv_data->tx = (void *)transfer->tx_buf;
999 drv_data->tx_end = drv_data->tx + transfer->len;
1000 drv_data->rx = transfer->rx_buf;
1001 drv_data->rx_end = drv_data->rx + transfer->len;
1002 drv_data->write = drv_data->tx ? chip->write : null_writer;
1003 drv_data->read = drv_data->rx ? chip->read : null_reader;
1005 /* Change speed and bit per word on a per transfer */
1006 bits = transfer->bits_per_word;
1007 speed = transfer->speed_hz;
1009 clk_div = pxa2xx_ssp_get_clk_div(drv_data, speed);
1012 drv_data->n_bytes = 1;
1013 drv_data->read = drv_data->read != null_reader ?
1014 u8_reader : null_reader;
1015 drv_data->write = drv_data->write != null_writer ?
1016 u8_writer : null_writer;
1017 } else if (bits <= 16) {
1018 drv_data->n_bytes = 2;
1019 drv_data->read = drv_data->read != null_reader ?
1020 u16_reader : null_reader;
1021 drv_data->write = drv_data->write != null_writer ?
1022 u16_writer : null_writer;
1023 } else if (bits <= 32) {
1024 drv_data->n_bytes = 4;
1025 drv_data->read = drv_data->read != null_reader ?
1026 u32_reader : null_reader;
1027 drv_data->write = drv_data->write != null_writer ?
1028 u32_writer : null_writer;
1031 * If bits per word is changed in DMA mode, then must check
1032 * the thresholds and burst also.
1034 if (chip->enable_dma) {
1035 if (pxa2xx_spi_set_dma_burst_and_threshold(chip,
1039 dev_warn_ratelimited(&spi->dev,
1040 "DMA burst size reduced to match bits_per_word\n");
1043 dma_mapped = controller->can_dma &&
1044 controller->can_dma(controller, spi, transfer) &&
1045 controller->cur_msg_mapped;
1048 /* Ensure we have the correct interrupt handler */
1049 drv_data->transfer_handler = pxa2xx_spi_dma_transfer;
1051 err = pxa2xx_spi_dma_prepare(drv_data, transfer);
1055 /* Clear status and start DMA engine */
1056 cr1 = chip->cr1 | dma_thresh | drv_data->dma_cr1;
1057 pxa2xx_spi_write(drv_data, SSSR, drv_data->clear_sr);
1059 pxa2xx_spi_dma_start(drv_data);
1061 /* Ensure we have the correct interrupt handler */
1062 drv_data->transfer_handler = interrupt_transfer;
1065 cr1 = chip->cr1 | chip->threshold | drv_data->int_cr1;
1066 write_SSSR_CS(drv_data, drv_data->clear_sr);
1069 /* NOTE: PXA25x_SSP _could_ use external clocking ... */
1070 cr0 = pxa2xx_configure_sscr0(drv_data, clk_div, bits);
1071 if (!pxa25x_ssp_comp(drv_data))
1072 dev_dbg(&spi->dev, "%u Hz actual, %s\n",
1073 controller->max_speed_hz
1074 / (1 + ((cr0 & SSCR0_SCR(0xfff)) >> 8)),
1075 dma_mapped ? "DMA" : "PIO");
1077 dev_dbg(&spi->dev, "%u Hz actual, %s\n",
1078 controller->max_speed_hz / 2
1079 / (1 + ((cr0 & SSCR0_SCR(0x0ff)) >> 8)),
1080 dma_mapped ? "DMA" : "PIO");
1082 if (is_lpss_ssp(drv_data)) {
1083 pxa2xx_spi_update(drv_data, SSIRF, GENMASK(7, 0), chip->lpss_rx_threshold);
1084 pxa2xx_spi_update(drv_data, SSITF, GENMASK(15, 0), chip->lpss_tx_threshold);
1087 if (is_mrfld_ssp(drv_data)) {
1088 u32 mask = SFIFOTT_RFT | SFIFOTT_TFT;
1091 thresh |= SFIFOTT_RxThresh(chip->lpss_rx_threshold);
1092 thresh |= SFIFOTT_TxThresh(chip->lpss_tx_threshold);
1094 pxa2xx_spi_update(drv_data, SFIFOTT, mask, thresh);
1097 if (is_quark_x1000_ssp(drv_data))
1098 pxa2xx_spi_update(drv_data, DDS_RATE, GENMASK(23, 0), chip->dds_rate);
1101 if (!is_mmp2_ssp(drv_data))
1102 pxa_ssp_disable(drv_data->ssp);
1104 if (!pxa25x_ssp_comp(drv_data))
1105 pxa2xx_spi_write(drv_data, SSTO, chip->timeout);
1107 /* First set CR1 without interrupt and service enables */
1108 pxa2xx_spi_update(drv_data, SSCR1, change_mask, cr1);
1110 /* See if we need to reload the configuration registers */
1111 pxa2xx_spi_update(drv_data, SSCR0, GENMASK(31, 0), cr0);
1113 /* Restart the SSP */
1114 pxa_ssp_enable(drv_data->ssp);
1116 if (is_mmp2_ssp(drv_data)) {
1117 u8 tx_level = read_SSSR_bits(drv_data, SSSR_TFL_MASK) >> 8;
1120 /* On MMP2, flipping SSE doesn't to empty Tx FIFO. */
1121 dev_warn(&spi->dev, "%u bytes of garbage in Tx FIFO!\n", tx_level);
1122 if (tx_level > transfer->len)
1123 tx_level = transfer->len;
1124 drv_data->tx += tx_level;
1128 if (spi_controller_is_slave(controller)) {
1129 while (drv_data->write(drv_data))
1131 if (drv_data->gpiod_ready) {
1132 gpiod_set_value(drv_data->gpiod_ready, 1);
1134 gpiod_set_value(drv_data->gpiod_ready, 0);
1139 * Release the data by enabling service requests and interrupts,
1140 * without changing any mode bits.
1142 pxa2xx_spi_write(drv_data, SSCR1, cr1);
1147 static int pxa2xx_spi_slave_abort(struct spi_controller *controller)
1149 struct driver_data *drv_data = spi_controller_get_devdata(controller);
1151 int_error_stop(drv_data, "transfer aborted", -EINTR);
1156 static void pxa2xx_spi_handle_err(struct spi_controller *controller,
1157 struct spi_message *msg)
1159 struct driver_data *drv_data = spi_controller_get_devdata(controller);
1161 int_stop_and_reset(drv_data);
1163 /* Disable the SSP */
1164 pxa2xx_spi_off(drv_data);
1167 * Stop the DMA if running. Note DMA callback handler may have unset
1168 * the dma_running already, which is fine as stopping is not needed
1169 * then but we shouldn't rely this flag for anything else than
1170 * stopping. For instance to differentiate between PIO and DMA
1173 if (atomic_read(&drv_data->dma_running))
1174 pxa2xx_spi_dma_stop(drv_data);
1177 static int pxa2xx_spi_unprepare_transfer(struct spi_controller *controller)
1179 struct driver_data *drv_data = spi_controller_get_devdata(controller);
1181 /* Disable the SSP now */
1182 pxa2xx_spi_off(drv_data);
1187 static void cleanup_cs(struct spi_device *spi)
1189 if (!gpio_is_valid(spi->cs_gpio))
1192 gpio_free(spi->cs_gpio);
1193 spi->cs_gpio = -ENOENT;
1196 static int setup_cs(struct spi_device *spi, struct chip_data *chip,
1197 struct pxa2xx_spi_chip *chip_info)
1199 struct driver_data *drv_data = spi_controller_get_devdata(spi->controller);
1204 if (chip_info == NULL)
1207 if (drv_data->ssp_type == CE4100_SSP)
1211 * NOTE: setup() can be called multiple times, possibly with
1212 * different chip_info, release previously requested GPIO.
1216 /* If ->cs_control() is provided, ignore GPIO chip select */
1217 if (chip_info->cs_control) {
1218 chip->cs_control = chip_info->cs_control;
1222 if (gpio_is_valid(chip_info->gpio_cs)) {
1223 int gpio = chip_info->gpio_cs;
1226 err = gpio_request(gpio, "SPI_CS");
1228 dev_err(&spi->dev, "failed to request chip select GPIO%d\n", gpio);
1232 err = gpio_direction_output(gpio, !(spi->mode & SPI_CS_HIGH));
1238 spi->cs_gpio = gpio;
1244 static int setup(struct spi_device *spi)
1246 struct pxa2xx_spi_chip *chip_info;
1247 struct chip_data *chip;
1248 const struct lpss_config *config;
1249 struct driver_data *drv_data =
1250 spi_controller_get_devdata(spi->controller);
1251 uint tx_thres, tx_hi_thres, rx_thres;
1254 switch (drv_data->ssp_type) {
1255 case QUARK_X1000_SSP:
1256 tx_thres = TX_THRESH_QUARK_X1000_DFLT;
1258 rx_thres = RX_THRESH_QUARK_X1000_DFLT;
1261 tx_thres = TX_THRESH_MRFLD_DFLT;
1263 rx_thres = RX_THRESH_MRFLD_DFLT;
1266 tx_thres = TX_THRESH_CE4100_DFLT;
1268 rx_thres = RX_THRESH_CE4100_DFLT;
1276 config = lpss_get_config(drv_data);
1277 tx_thres = config->tx_threshold_lo;
1278 tx_hi_thres = config->tx_threshold_hi;
1279 rx_thres = config->rx_threshold;
1283 if (spi_controller_is_slave(drv_data->controller)) {
1287 tx_thres = TX_THRESH_DFLT;
1288 rx_thres = RX_THRESH_DFLT;
1293 /* Only allocate on the first setup */
1294 chip = spi_get_ctldata(spi);
1296 chip = kzalloc(sizeof(struct chip_data), GFP_KERNEL);
1300 if (drv_data->ssp_type == CE4100_SSP) {
1301 if (spi->chip_select > 4) {
1303 "failed setup: cs number must not be > 4.\n");
1308 chip->enable_dma = drv_data->controller_info->enable_dma;
1309 chip->timeout = TIMOUT_DFLT;
1313 * Protocol drivers may change the chip settings, so...
1314 * if chip_info exists, use it.
1316 chip_info = spi->controller_data;
1318 /* chip_info isn't always needed */
1321 if (chip_info->timeout)
1322 chip->timeout = chip_info->timeout;
1323 if (chip_info->tx_threshold)
1324 tx_thres = chip_info->tx_threshold;
1325 if (chip_info->tx_hi_threshold)
1326 tx_hi_thres = chip_info->tx_hi_threshold;
1327 if (chip_info->rx_threshold)
1328 rx_thres = chip_info->rx_threshold;
1329 chip->dma_threshold = 0;
1330 if (chip_info->enable_loopback)
1331 chip->cr1 = SSCR1_LBM;
1333 if (spi_controller_is_slave(drv_data->controller)) {
1334 chip->cr1 |= SSCR1_SCFR;
1335 chip->cr1 |= SSCR1_SCLKDIR;
1336 chip->cr1 |= SSCR1_SFRMDIR;
1337 chip->cr1 |= SSCR1_SPH;
1340 if (is_lpss_ssp(drv_data)) {
1341 chip->lpss_rx_threshold = SSIRF_RxThresh(rx_thres);
1342 chip->lpss_tx_threshold = SSITF_TxLoThresh(tx_thres) |
1343 SSITF_TxHiThresh(tx_hi_thres);
1346 if (is_mrfld_ssp(drv_data)) {
1347 chip->lpss_rx_threshold = rx_thres;
1348 chip->lpss_tx_threshold = tx_thres;
1352 * Set DMA burst and threshold outside of chip_info path so that if
1353 * chip_info goes away after setting chip->enable_dma, the burst and
1354 * threshold can still respond to changes in bits_per_word.
1356 if (chip->enable_dma) {
1357 /* Set up legal burst and threshold for DMA */
1358 if (pxa2xx_spi_set_dma_burst_and_threshold(chip, spi,
1360 &chip->dma_burst_size,
1361 &chip->dma_threshold)) {
1363 "in setup: DMA burst size reduced to match bits_per_word\n");
1366 "in setup: DMA burst size set to %u\n",
1367 chip->dma_burst_size);
1370 switch (drv_data->ssp_type) {
1371 case QUARK_X1000_SSP:
1372 chip->threshold = (QUARK_X1000_SSCR1_RxTresh(rx_thres)
1373 & QUARK_X1000_SSCR1_RFT)
1374 | (QUARK_X1000_SSCR1_TxTresh(tx_thres)
1375 & QUARK_X1000_SSCR1_TFT);
1378 chip->threshold = (CE4100_SSCR1_RxTresh(rx_thres) & CE4100_SSCR1_RFT) |
1379 (CE4100_SSCR1_TxTresh(tx_thres) & CE4100_SSCR1_TFT);
1382 chip->threshold = (SSCR1_RxTresh(rx_thres) & SSCR1_RFT) |
1383 (SSCR1_TxTresh(tx_thres) & SSCR1_TFT);
1387 chip->cr1 &= ~(SSCR1_SPO | SSCR1_SPH);
1388 chip->cr1 |= ((spi->mode & SPI_CPHA) ? SSCR1_SPH : 0) |
1389 ((spi->mode & SPI_CPOL) ? SSCR1_SPO : 0);
1391 if (spi->mode & SPI_LOOP)
1392 chip->cr1 |= SSCR1_LBM;
1394 if (spi->bits_per_word <= 8) {
1396 chip->read = u8_reader;
1397 chip->write = u8_writer;
1398 } else if (spi->bits_per_word <= 16) {
1400 chip->read = u16_reader;
1401 chip->write = u16_writer;
1402 } else if (spi->bits_per_word <= 32) {
1404 chip->read = u32_reader;
1405 chip->write = u32_writer;
1408 spi_set_ctldata(spi, chip);
1410 if (drv_data->ssp_type == CE4100_SSP)
1413 err = setup_cs(spi, chip, chip_info);
1420 static void cleanup(struct spi_device *spi)
1422 struct chip_data *chip = spi_get_ctldata(spi);
1429 static const struct acpi_device_id pxa2xx_spi_acpi_match[] = {
1430 { "INT33C0", LPSS_LPT_SSP },
1431 { "INT33C1", LPSS_LPT_SSP },
1432 { "INT3430", LPSS_LPT_SSP },
1433 { "INT3431", LPSS_LPT_SSP },
1434 { "80860F0E", LPSS_BYT_SSP },
1435 { "8086228E", LPSS_BSW_SSP },
1438 MODULE_DEVICE_TABLE(acpi, pxa2xx_spi_acpi_match);
1442 * PCI IDs of compound devices that integrate both host controller and private
1443 * integrated DMA engine. Please note these are not used in module
1444 * autoloading and probing in this module but matching the LPSS SSP type.
1446 static const struct pci_device_id pxa2xx_spi_pci_compound_match[] = {
1448 { PCI_VDEVICE(INTEL, 0x9d29), LPSS_SPT_SSP },
1449 { PCI_VDEVICE(INTEL, 0x9d2a), LPSS_SPT_SSP },
1451 { PCI_VDEVICE(INTEL, 0xa129), LPSS_SPT_SSP },
1452 { PCI_VDEVICE(INTEL, 0xa12a), LPSS_SPT_SSP },
1454 { PCI_VDEVICE(INTEL, 0xa2a9), LPSS_SPT_SSP },
1455 { PCI_VDEVICE(INTEL, 0xa2aa), LPSS_SPT_SSP },
1457 { PCI_VDEVICE(INTEL, 0xa3a9), LPSS_SPT_SSP },
1458 { PCI_VDEVICE(INTEL, 0xa3aa), LPSS_SPT_SSP },
1460 { PCI_VDEVICE(INTEL, 0x0ac2), LPSS_BXT_SSP },
1461 { PCI_VDEVICE(INTEL, 0x0ac4), LPSS_BXT_SSP },
1462 { PCI_VDEVICE(INTEL, 0x0ac6), LPSS_BXT_SSP },
1464 { PCI_VDEVICE(INTEL, 0x1ac2), LPSS_BXT_SSP },
1465 { PCI_VDEVICE(INTEL, 0x1ac4), LPSS_BXT_SSP },
1466 { PCI_VDEVICE(INTEL, 0x1ac6), LPSS_BXT_SSP },
1468 { PCI_VDEVICE(INTEL, 0x31c2), LPSS_BXT_SSP },
1469 { PCI_VDEVICE(INTEL, 0x31c4), LPSS_BXT_SSP },
1470 { PCI_VDEVICE(INTEL, 0x31c6), LPSS_BXT_SSP },
1472 { PCI_VDEVICE(INTEL, 0x34aa), LPSS_CNL_SSP },
1473 { PCI_VDEVICE(INTEL, 0x34ab), LPSS_CNL_SSP },
1474 { PCI_VDEVICE(INTEL, 0x34fb), LPSS_CNL_SSP },
1476 { PCI_VDEVICE(INTEL, 0x4b2a), LPSS_BXT_SSP },
1477 { PCI_VDEVICE(INTEL, 0x4b2b), LPSS_BXT_SSP },
1478 { PCI_VDEVICE(INTEL, 0x4b37), LPSS_BXT_SSP },
1480 { PCI_VDEVICE(INTEL, 0x4daa), LPSS_CNL_SSP },
1481 { PCI_VDEVICE(INTEL, 0x4dab), LPSS_CNL_SSP },
1482 { PCI_VDEVICE(INTEL, 0x4dfb), LPSS_CNL_SSP },
1484 { PCI_VDEVICE(INTEL, 0x43aa), LPSS_CNL_SSP },
1485 { PCI_VDEVICE(INTEL, 0x43ab), LPSS_CNL_SSP },
1486 { PCI_VDEVICE(INTEL, 0x43fb), LPSS_CNL_SSP },
1487 { PCI_VDEVICE(INTEL, 0x43fd), LPSS_CNL_SSP },
1489 { PCI_VDEVICE(INTEL, 0x51aa), LPSS_CNL_SSP },
1490 { PCI_VDEVICE(INTEL, 0x51ab), LPSS_CNL_SSP },
1491 { PCI_VDEVICE(INTEL, 0x51fb), LPSS_CNL_SSP },
1493 { PCI_VDEVICE(INTEL, 0x54aa), LPSS_CNL_SSP },
1494 { PCI_VDEVICE(INTEL, 0x54ab), LPSS_CNL_SSP },
1495 { PCI_VDEVICE(INTEL, 0x54fb), LPSS_CNL_SSP },
1497 { PCI_VDEVICE(INTEL, 0x5ac2), LPSS_BXT_SSP },
1498 { PCI_VDEVICE(INTEL, 0x5ac4), LPSS_BXT_SSP },
1499 { PCI_VDEVICE(INTEL, 0x5ac6), LPSS_BXT_SSP },
1501 { PCI_VDEVICE(INTEL, 0x7aaa), LPSS_CNL_SSP },
1502 { PCI_VDEVICE(INTEL, 0x7aab), LPSS_CNL_SSP },
1503 { PCI_VDEVICE(INTEL, 0x7af9), LPSS_CNL_SSP },
1504 { PCI_VDEVICE(INTEL, 0x7afb), LPSS_CNL_SSP },
1506 { PCI_VDEVICE(INTEL, 0x9daa), LPSS_CNL_SSP },
1507 { PCI_VDEVICE(INTEL, 0x9dab), LPSS_CNL_SSP },
1508 { PCI_VDEVICE(INTEL, 0x9dfb), LPSS_CNL_SSP },
1510 { PCI_VDEVICE(INTEL, 0xa32a), LPSS_CNL_SSP },
1511 { PCI_VDEVICE(INTEL, 0xa32b), LPSS_CNL_SSP },
1512 { PCI_VDEVICE(INTEL, 0xa37b), LPSS_CNL_SSP },
1514 { PCI_VDEVICE(INTEL, 0x02aa), LPSS_CNL_SSP },
1515 { PCI_VDEVICE(INTEL, 0x02ab), LPSS_CNL_SSP },
1516 { PCI_VDEVICE(INTEL, 0x02fb), LPSS_CNL_SSP },
1518 { PCI_VDEVICE(INTEL, 0x06aa), LPSS_CNL_SSP },
1519 { PCI_VDEVICE(INTEL, 0x06ab), LPSS_CNL_SSP },
1520 { PCI_VDEVICE(INTEL, 0x06fb), LPSS_CNL_SSP },
1522 { PCI_VDEVICE(INTEL, 0xa0aa), LPSS_CNL_SSP },
1523 { PCI_VDEVICE(INTEL, 0xa0ab), LPSS_CNL_SSP },
1524 { PCI_VDEVICE(INTEL, 0xa0de), LPSS_CNL_SSP },
1525 { PCI_VDEVICE(INTEL, 0xa0df), LPSS_CNL_SSP },
1526 { PCI_VDEVICE(INTEL, 0xa0fb), LPSS_CNL_SSP },
1527 { PCI_VDEVICE(INTEL, 0xa0fd), LPSS_CNL_SSP },
1528 { PCI_VDEVICE(INTEL, 0xa0fe), LPSS_CNL_SSP },
1532 static const struct of_device_id pxa2xx_spi_of_match[] = {
1533 { .compatible = "marvell,mmp2-ssp", .data = (void *)MMP2_SSP },
1536 MODULE_DEVICE_TABLE(of, pxa2xx_spi_of_match);
1540 static int pxa2xx_spi_get_port_id(struct device *dev)
1542 struct acpi_device *adev;
1546 adev = ACPI_COMPANION(dev);
1547 if (adev && adev->pnp.unique_id &&
1548 !kstrtouint(adev->pnp.unique_id, 0, &devid))
1553 #else /* !CONFIG_ACPI */
1555 static int pxa2xx_spi_get_port_id(struct device *dev)
1560 #endif /* CONFIG_ACPI */
1565 static bool pxa2xx_spi_idma_filter(struct dma_chan *chan, void *param)
1567 return param == chan->device->dev;
1570 #endif /* CONFIG_PCI */
1572 static struct pxa2xx_spi_controller *
1573 pxa2xx_spi_init_pdata(struct platform_device *pdev)
1575 struct pxa2xx_spi_controller *pdata;
1576 struct ssp_device *ssp;
1577 struct resource *res;
1578 struct device *parent = pdev->dev.parent;
1579 struct pci_dev *pcidev = dev_is_pci(parent) ? to_pci_dev(parent) : NULL;
1580 const struct pci_device_id *pcidev_id = NULL;
1581 enum pxa_ssp_type type;
1585 pcidev_id = pci_match_id(pxa2xx_spi_pci_compound_match, pcidev);
1587 match = device_get_match_data(&pdev->dev);
1589 type = (enum pxa_ssp_type)match;
1591 type = (enum pxa_ssp_type)pcidev_id->driver_data;
1593 return ERR_PTR(-EINVAL);
1595 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
1597 return ERR_PTR(-ENOMEM);
1601 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1602 ssp->mmio_base = devm_ioremap_resource(&pdev->dev, res);
1603 if (IS_ERR(ssp->mmio_base))
1604 return ERR_CAST(ssp->mmio_base);
1606 ssp->phys_base = res->start;
1610 pdata->tx_param = parent;
1611 pdata->rx_param = parent;
1612 pdata->dma_filter = pxa2xx_spi_idma_filter;
1616 ssp->clk = devm_clk_get(&pdev->dev, NULL);
1617 if (IS_ERR(ssp->clk))
1618 return ERR_CAST(ssp->clk);
1620 ssp->irq = platform_get_irq(pdev, 0);
1622 return ERR_PTR(ssp->irq);
1625 ssp->dev = &pdev->dev;
1626 ssp->port_id = pxa2xx_spi_get_port_id(&pdev->dev);
1628 pdata->is_slave = device_property_read_bool(&pdev->dev, "spi-slave");
1629 pdata->num_chipselect = 1;
1630 pdata->enable_dma = true;
1631 pdata->dma_burst_size = 1;
1636 static int pxa2xx_spi_fw_translate_cs(struct spi_controller *controller,
1639 struct driver_data *drv_data = spi_controller_get_devdata(controller);
1641 if (has_acpi_companion(drv_data->ssp->dev)) {
1642 switch (drv_data->ssp_type) {
1644 * For Atoms the ACPI DeviceSelection used by the Windows
1645 * driver starts from 1 instead of 0 so translate it here
1646 * to match what Linux expects.
1660 static size_t pxa2xx_spi_max_dma_transfer_size(struct spi_device *spi)
1665 static int pxa2xx_spi_probe(struct platform_device *pdev)
1667 struct device *dev = &pdev->dev;
1668 struct pxa2xx_spi_controller *platform_info;
1669 struct spi_controller *controller;
1670 struct driver_data *drv_data;
1671 struct ssp_device *ssp;
1672 const struct lpss_config *config;
1676 platform_info = dev_get_platdata(dev);
1677 if (!platform_info) {
1678 platform_info = pxa2xx_spi_init_pdata(pdev);
1679 if (IS_ERR(platform_info)) {
1680 dev_err(&pdev->dev, "missing platform data\n");
1681 return PTR_ERR(platform_info);
1685 ssp = pxa_ssp_request(pdev->id, pdev->name);
1687 ssp = &platform_info->ssp;
1689 if (!ssp->mmio_base) {
1690 dev_err(&pdev->dev, "failed to get SSP\n");
1694 if (platform_info->is_slave)
1695 controller = devm_spi_alloc_slave(dev, sizeof(*drv_data));
1697 controller = devm_spi_alloc_master(dev, sizeof(*drv_data));
1700 dev_err(&pdev->dev, "cannot alloc spi_controller\n");
1702 goto out_error_controller_alloc;
1704 drv_data = spi_controller_get_devdata(controller);
1705 drv_data->controller = controller;
1706 drv_data->controller_info = platform_info;
1707 drv_data->ssp = ssp;
1709 controller->dev.of_node = dev->of_node;
1710 controller->dev.fwnode = dev->fwnode;
1712 /* The spi->mode bits understood by this driver: */
1713 controller->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH | SPI_LOOP;
1715 controller->bus_num = ssp->port_id;
1716 controller->dma_alignment = DMA_ALIGNMENT;
1717 controller->cleanup = cleanup;
1718 controller->setup = setup;
1719 controller->set_cs = pxa2xx_spi_set_cs;
1720 controller->transfer_one = pxa2xx_spi_transfer_one;
1721 controller->slave_abort = pxa2xx_spi_slave_abort;
1722 controller->handle_err = pxa2xx_spi_handle_err;
1723 controller->unprepare_transfer_hardware = pxa2xx_spi_unprepare_transfer;
1724 controller->fw_translate_cs = pxa2xx_spi_fw_translate_cs;
1725 controller->auto_runtime_pm = true;
1726 controller->flags = SPI_CONTROLLER_MUST_RX | SPI_CONTROLLER_MUST_TX;
1728 drv_data->ssp_type = ssp->type;
1730 if (pxa25x_ssp_comp(drv_data)) {
1731 switch (drv_data->ssp_type) {
1732 case QUARK_X1000_SSP:
1733 controller->bits_per_word_mask = SPI_BPW_RANGE_MASK(4, 32);
1736 controller->bits_per_word_mask = SPI_BPW_RANGE_MASK(4, 16);
1740 drv_data->int_cr1 = SSCR1_TIE | SSCR1_RIE;
1741 drv_data->dma_cr1 = 0;
1742 drv_data->clear_sr = SSSR_ROR;
1743 drv_data->mask_sr = SSSR_RFS | SSSR_TFS | SSSR_ROR;
1745 controller->bits_per_word_mask = SPI_BPW_RANGE_MASK(4, 32);
1746 drv_data->int_cr1 = SSCR1_TIE | SSCR1_RIE | SSCR1_TINTE;
1747 drv_data->dma_cr1 = DEFAULT_DMA_CR1;
1748 drv_data->clear_sr = SSSR_ROR | SSSR_TINT;
1749 drv_data->mask_sr = SSSR_TINT | SSSR_RFS | SSSR_TFS
1750 | SSSR_ROR | SSSR_TUR;
1753 status = request_irq(ssp->irq, ssp_int, IRQF_SHARED, dev_name(dev),
1756 dev_err(&pdev->dev, "cannot get IRQ %d\n", ssp->irq);
1757 goto out_error_controller_alloc;
1760 /* Setup DMA if requested */
1761 if (platform_info->enable_dma) {
1762 status = pxa2xx_spi_dma_setup(drv_data);
1764 dev_warn(dev, "no DMA channels available, using PIO\n");
1765 platform_info->enable_dma = false;
1767 controller->can_dma = pxa2xx_spi_can_dma;
1768 controller->max_dma_len = MAX_DMA_LEN;
1769 controller->max_transfer_size =
1770 pxa2xx_spi_max_dma_transfer_size;
1774 /* Enable SOC clock */
1775 status = clk_prepare_enable(ssp->clk);
1777 goto out_error_dma_irq_alloc;
1779 controller->max_speed_hz = clk_get_rate(ssp->clk);
1781 * Set minimum speed for all other platforms than Intel Quark which is
1782 * able do under 1 Hz transfers.
1784 if (!pxa25x_ssp_comp(drv_data))
1785 controller->min_speed_hz =
1786 DIV_ROUND_UP(controller->max_speed_hz, 4096);
1787 else if (!is_quark_x1000_ssp(drv_data))
1788 controller->min_speed_hz =
1789 DIV_ROUND_UP(controller->max_speed_hz, 512);
1791 pxa_ssp_disable(ssp);
1793 /* Load default SSP configuration */
1794 switch (drv_data->ssp_type) {
1795 case QUARK_X1000_SSP:
1796 tmp = QUARK_X1000_SSCR1_RxTresh(RX_THRESH_QUARK_X1000_DFLT) |
1797 QUARK_X1000_SSCR1_TxTresh(TX_THRESH_QUARK_X1000_DFLT);
1798 pxa2xx_spi_write(drv_data, SSCR1, tmp);
1800 /* Using the Motorola SPI protocol and use 8 bit frame */
1801 tmp = QUARK_X1000_SSCR0_Motorola | QUARK_X1000_SSCR0_DataSize(8);
1802 pxa2xx_spi_write(drv_data, SSCR0, tmp);
1805 tmp = CE4100_SSCR1_RxTresh(RX_THRESH_CE4100_DFLT) |
1806 CE4100_SSCR1_TxTresh(TX_THRESH_CE4100_DFLT);
1807 pxa2xx_spi_write(drv_data, SSCR1, tmp);
1808 tmp = SSCR0_SCR(2) | SSCR0_Motorola | SSCR0_DataSize(8);
1809 pxa2xx_spi_write(drv_data, SSCR0, tmp);
1813 if (spi_controller_is_slave(controller)) {
1821 tmp = SSCR1_RxTresh(RX_THRESH_DFLT) |
1822 SSCR1_TxTresh(TX_THRESH_DFLT);
1824 pxa2xx_spi_write(drv_data, SSCR1, tmp);
1825 tmp = SSCR0_Motorola | SSCR0_DataSize(8);
1826 if (!spi_controller_is_slave(controller))
1827 tmp |= SSCR0_SCR(2);
1828 pxa2xx_spi_write(drv_data, SSCR0, tmp);
1832 if (!pxa25x_ssp_comp(drv_data))
1833 pxa2xx_spi_write(drv_data, SSTO, 0);
1835 if (!is_quark_x1000_ssp(drv_data))
1836 pxa2xx_spi_write(drv_data, SSPSP, 0);
1838 if (is_lpss_ssp(drv_data)) {
1839 lpss_ssp_setup(drv_data);
1840 config = lpss_get_config(drv_data);
1841 if (config->reg_capabilities >= 0) {
1842 tmp = __lpss_ssp_read_priv(drv_data,
1843 config->reg_capabilities);
1844 tmp &= LPSS_CAPS_CS_EN_MASK;
1845 tmp >>= LPSS_CAPS_CS_EN_SHIFT;
1846 platform_info->num_chipselect = ffz(tmp);
1847 } else if (config->cs_num) {
1848 platform_info->num_chipselect = config->cs_num;
1851 controller->num_chipselect = platform_info->num_chipselect;
1852 controller->use_gpio_descriptors = true;
1854 if (platform_info->is_slave) {
1855 drv_data->gpiod_ready = devm_gpiod_get_optional(dev,
1856 "ready", GPIOD_OUT_LOW);
1857 if (IS_ERR(drv_data->gpiod_ready)) {
1858 status = PTR_ERR(drv_data->gpiod_ready);
1859 goto out_error_clock_enabled;
1863 pm_runtime_set_autosuspend_delay(&pdev->dev, 50);
1864 pm_runtime_use_autosuspend(&pdev->dev);
1865 pm_runtime_set_active(&pdev->dev);
1866 pm_runtime_enable(&pdev->dev);
1868 /* Register with the SPI framework */
1869 platform_set_drvdata(pdev, drv_data);
1870 status = spi_register_controller(controller);
1872 dev_err(&pdev->dev, "problem registering SPI controller\n");
1873 goto out_error_pm_runtime_enabled;
1878 out_error_pm_runtime_enabled:
1879 pm_runtime_disable(&pdev->dev);
1881 out_error_clock_enabled:
1882 clk_disable_unprepare(ssp->clk);
1884 out_error_dma_irq_alloc:
1885 pxa2xx_spi_dma_release(drv_data);
1886 free_irq(ssp->irq, drv_data);
1888 out_error_controller_alloc:
1893 static int pxa2xx_spi_remove(struct platform_device *pdev)
1895 struct driver_data *drv_data = platform_get_drvdata(pdev);
1896 struct ssp_device *ssp = drv_data->ssp;
1898 pm_runtime_get_sync(&pdev->dev);
1900 spi_unregister_controller(drv_data->controller);
1902 /* Disable the SSP at the peripheral and SOC level */
1903 pxa_ssp_disable(ssp);
1904 clk_disable_unprepare(ssp->clk);
1907 if (drv_data->controller_info->enable_dma)
1908 pxa2xx_spi_dma_release(drv_data);
1910 pm_runtime_put_noidle(&pdev->dev);
1911 pm_runtime_disable(&pdev->dev);
1914 free_irq(ssp->irq, drv_data);
1922 #ifdef CONFIG_PM_SLEEP
1923 static int pxa2xx_spi_suspend(struct device *dev)
1925 struct driver_data *drv_data = dev_get_drvdata(dev);
1926 struct ssp_device *ssp = drv_data->ssp;
1929 status = spi_controller_suspend(drv_data->controller);
1933 pxa_ssp_disable(ssp);
1935 if (!pm_runtime_suspended(dev))
1936 clk_disable_unprepare(ssp->clk);
1941 static int pxa2xx_spi_resume(struct device *dev)
1943 struct driver_data *drv_data = dev_get_drvdata(dev);
1944 struct ssp_device *ssp = drv_data->ssp;
1947 /* Enable the SSP clock */
1948 if (!pm_runtime_suspended(dev)) {
1949 status = clk_prepare_enable(ssp->clk);
1954 /* Start the queue running */
1955 return spi_controller_resume(drv_data->controller);
1960 static int pxa2xx_spi_runtime_suspend(struct device *dev)
1962 struct driver_data *drv_data = dev_get_drvdata(dev);
1964 clk_disable_unprepare(drv_data->ssp->clk);
1968 static int pxa2xx_spi_runtime_resume(struct device *dev)
1970 struct driver_data *drv_data = dev_get_drvdata(dev);
1973 status = clk_prepare_enable(drv_data->ssp->clk);
1978 static const struct dev_pm_ops pxa2xx_spi_pm_ops = {
1979 SET_SYSTEM_SLEEP_PM_OPS(pxa2xx_spi_suspend, pxa2xx_spi_resume)
1980 SET_RUNTIME_PM_OPS(pxa2xx_spi_runtime_suspend,
1981 pxa2xx_spi_runtime_resume, NULL)
1984 static struct platform_driver driver = {
1986 .name = "pxa2xx-spi",
1987 .pm = &pxa2xx_spi_pm_ops,
1988 .acpi_match_table = ACPI_PTR(pxa2xx_spi_acpi_match),
1989 .of_match_table = of_match_ptr(pxa2xx_spi_of_match),
1991 .probe = pxa2xx_spi_probe,
1992 .remove = pxa2xx_spi_remove,
1995 static int __init pxa2xx_spi_init(void)
1997 return platform_driver_register(&driver);
1999 subsys_initcall(pxa2xx_spi_init);
2001 static void __exit pxa2xx_spi_exit(void)
2003 platform_driver_unregister(&driver);
2005 module_exit(pxa2xx_spi_exit);
2007 MODULE_SOFTDEP("pre: dw_dmac");