1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (C) 2005 Stephen Street / StreetFire Sound Labs
4 * Copyright (C) 2013, 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/err.h>
13 #include <linux/errno.h>
14 #include <linux/gpio/consumer.h>
15 #include <linux/gpio.h>
16 #include <linux/init.h>
17 #include <linux/interrupt.h>
18 #include <linux/ioport.h>
19 #include <linux/kernel.h>
20 #include <linux/module.h>
21 #include <linux/mod_devicetable.h>
23 #include <linux/pci.h>
24 #include <linux/platform_device.h>
25 #include <linux/pm_runtime.h>
26 #include <linux/property.h>
27 #include <linux/slab.h>
28 #include <linux/spi/pxa2xx_spi.h>
29 #include <linux/spi/spi.h>
31 #include "spi-pxa2xx.h"
33 MODULE_AUTHOR("Stephen Street");
34 MODULE_DESCRIPTION("PXA2xx SSP SPI Controller");
35 MODULE_LICENSE("GPL");
36 MODULE_ALIAS("platform:pxa2xx-spi");
38 #define TIMOUT_DFLT 1000
41 * for testing SSCR1 changes that require SSP restart, basically
42 * everything except the service and interrupt enables, the pxa270 developer
43 * manual says only SSCR1_SCFR, SSCR1_SPH, SSCR1_SPO need to be in this
44 * list, but the PXA255 dev man says all bits without really meaning the
45 * service and interrupt enables
47 #define SSCR1_CHANGE_MASK (SSCR1_TTELP | SSCR1_TTE | SSCR1_SCFR \
48 | SSCR1_ECRA | SSCR1_ECRB | SSCR1_SCLKDIR \
49 | SSCR1_SFRMDIR | SSCR1_RWOT | SSCR1_TRAIL \
50 | SSCR1_IFS | SSCR1_STRF | SSCR1_EFWR \
51 | SSCR1_RFT | SSCR1_TFT | SSCR1_MWDS \
52 | SSCR1_SPH | SSCR1_SPO | SSCR1_LBM)
54 #define QUARK_X1000_SSCR1_CHANGE_MASK (QUARK_X1000_SSCR1_STRF \
55 | QUARK_X1000_SSCR1_EFWR \
56 | QUARK_X1000_SSCR1_RFT \
57 | QUARK_X1000_SSCR1_TFT \
58 | SSCR1_SPH | SSCR1_SPO | SSCR1_LBM)
60 #define CE4100_SSCR1_CHANGE_MASK (SSCR1_TTELP | SSCR1_TTE | SSCR1_SCFR \
61 | SSCR1_ECRA | SSCR1_ECRB | SSCR1_SCLKDIR \
62 | SSCR1_SFRMDIR | SSCR1_RWOT | SSCR1_TRAIL \
63 | SSCR1_IFS | SSCR1_STRF | SSCR1_EFWR \
64 | CE4100_SSCR1_RFT | CE4100_SSCR1_TFT | SSCR1_MWDS \
65 | SSCR1_SPH | SSCR1_SPO | SSCR1_LBM)
67 #define LPSS_GENERAL_REG_RXTO_HOLDOFF_DISABLE BIT(24)
68 #define LPSS_CS_CONTROL_SW_MODE BIT(0)
69 #define LPSS_CS_CONTROL_CS_HIGH BIT(1)
70 #define LPSS_CAPS_CS_EN_SHIFT 9
71 #define LPSS_CAPS_CS_EN_MASK (0xf << LPSS_CAPS_CS_EN_SHIFT)
74 /* LPSS offset from drv_data->ioaddr */
76 /* Register offsets from drv_data->lpss_base or -1 */
85 /* Chip select control */
86 unsigned cs_sel_shift;
91 /* Keep these sorted with enum pxa_ssp_type */
92 static const struct lpss_config lpss_platforms[] = {
98 .reg_capabilities = -1,
100 .tx_threshold_lo = 160,
101 .tx_threshold_hi = 224,
108 .reg_capabilities = -1,
110 .tx_threshold_lo = 160,
111 .tx_threshold_hi = 224,
118 .reg_capabilities = -1,
120 .tx_threshold_lo = 160,
121 .tx_threshold_hi = 224,
123 .cs_sel_mask = 1 << 2,
131 .reg_capabilities = -1,
133 .tx_threshold_lo = 32,
134 .tx_threshold_hi = 56,
141 .reg_capabilities = 0xfc,
143 .tx_threshold_lo = 16,
144 .tx_threshold_hi = 48,
146 .cs_sel_mask = 3 << 8,
153 .reg_capabilities = 0xfc,
155 .tx_threshold_lo = 32,
156 .tx_threshold_hi = 56,
158 .cs_sel_mask = 3 << 8,
162 static inline const struct lpss_config
163 *lpss_get_config(const struct driver_data *drv_data)
165 return &lpss_platforms[drv_data->ssp_type - LPSS_LPT_SSP];
168 static bool is_lpss_ssp(const struct driver_data *drv_data)
170 switch (drv_data->ssp_type) {
183 static bool is_quark_x1000_ssp(const struct driver_data *drv_data)
185 return drv_data->ssp_type == QUARK_X1000_SSP;
188 static u32 pxa2xx_spi_get_ssrc1_change_mask(const struct driver_data *drv_data)
190 switch (drv_data->ssp_type) {
191 case QUARK_X1000_SSP:
192 return QUARK_X1000_SSCR1_CHANGE_MASK;
194 return CE4100_SSCR1_CHANGE_MASK;
196 return SSCR1_CHANGE_MASK;
201 pxa2xx_spi_get_rx_default_thre(const struct driver_data *drv_data)
203 switch (drv_data->ssp_type) {
204 case QUARK_X1000_SSP:
205 return RX_THRESH_QUARK_X1000_DFLT;
207 return RX_THRESH_CE4100_DFLT;
209 return RX_THRESH_DFLT;
213 static bool pxa2xx_spi_txfifo_full(const struct driver_data *drv_data)
217 switch (drv_data->ssp_type) {
218 case QUARK_X1000_SSP:
219 mask = QUARK_X1000_SSSR_TFL_MASK;
222 mask = CE4100_SSSR_TFL_MASK;
225 mask = SSSR_TFL_MASK;
229 return (pxa2xx_spi_read(drv_data, SSSR) & mask) == mask;
232 static void pxa2xx_spi_clear_rx_thre(const struct driver_data *drv_data,
237 switch (drv_data->ssp_type) {
238 case QUARK_X1000_SSP:
239 mask = QUARK_X1000_SSCR1_RFT;
242 mask = CE4100_SSCR1_RFT;
251 static void pxa2xx_spi_set_rx_thre(const struct driver_data *drv_data,
252 u32 *sccr1_reg, u32 threshold)
254 switch (drv_data->ssp_type) {
255 case QUARK_X1000_SSP:
256 *sccr1_reg |= QUARK_X1000_SSCR1_RxTresh(threshold);
259 *sccr1_reg |= CE4100_SSCR1_RxTresh(threshold);
262 *sccr1_reg |= SSCR1_RxTresh(threshold);
267 static u32 pxa2xx_configure_sscr0(const struct driver_data *drv_data,
268 u32 clk_div, u8 bits)
270 switch (drv_data->ssp_type) {
271 case QUARK_X1000_SSP:
273 | QUARK_X1000_SSCR0_Motorola
274 | QUARK_X1000_SSCR0_DataSize(bits > 32 ? 8 : bits)
279 | SSCR0_DataSize(bits > 16 ? bits - 16 : bits)
281 | (bits > 16 ? SSCR0_EDSS : 0);
286 * Read and write LPSS SSP private registers. Caller must first check that
287 * is_lpss_ssp() returns true before these can be called.
289 static u32 __lpss_ssp_read_priv(struct driver_data *drv_data, unsigned offset)
291 WARN_ON(!drv_data->lpss_base);
292 return readl(drv_data->lpss_base + offset);
295 static void __lpss_ssp_write_priv(struct driver_data *drv_data,
296 unsigned offset, u32 value)
298 WARN_ON(!drv_data->lpss_base);
299 writel(value, drv_data->lpss_base + offset);
303 * lpss_ssp_setup - perform LPSS SSP specific setup
304 * @drv_data: pointer to the driver private data
306 * Perform LPSS SSP specific setup. This function must be called first if
307 * one is going to use LPSS SSP private registers.
309 static void lpss_ssp_setup(struct driver_data *drv_data)
311 const struct lpss_config *config;
314 config = lpss_get_config(drv_data);
315 drv_data->lpss_base = drv_data->ioaddr + config->offset;
317 /* Enable software chip select control */
318 value = __lpss_ssp_read_priv(drv_data, config->reg_cs_ctrl);
319 value &= ~(LPSS_CS_CONTROL_SW_MODE | LPSS_CS_CONTROL_CS_HIGH);
320 value |= LPSS_CS_CONTROL_SW_MODE | LPSS_CS_CONTROL_CS_HIGH;
321 __lpss_ssp_write_priv(drv_data, config->reg_cs_ctrl, value);
323 /* Enable multiblock DMA transfers */
324 if (drv_data->controller_info->enable_dma) {
325 __lpss_ssp_write_priv(drv_data, config->reg_ssp, 1);
327 if (config->reg_general >= 0) {
328 value = __lpss_ssp_read_priv(drv_data,
329 config->reg_general);
330 value |= LPSS_GENERAL_REG_RXTO_HOLDOFF_DISABLE;
331 __lpss_ssp_write_priv(drv_data,
332 config->reg_general, value);
337 static void lpss_ssp_select_cs(struct spi_device *spi,
338 const struct lpss_config *config)
340 struct driver_data *drv_data =
341 spi_controller_get_devdata(spi->controller);
344 if (!config->cs_sel_mask)
347 value = __lpss_ssp_read_priv(drv_data, config->reg_cs_ctrl);
349 cs = spi->chip_select;
350 cs <<= config->cs_sel_shift;
351 if (cs != (value & config->cs_sel_mask)) {
353 * When switching another chip select output active the
354 * output must be selected first and wait 2 ssp_clk cycles
355 * before changing state to active. Otherwise a short
356 * glitch will occur on the previous chip select since
357 * output select is latched but state control is not.
359 value &= ~config->cs_sel_mask;
361 __lpss_ssp_write_priv(drv_data,
362 config->reg_cs_ctrl, value);
364 (drv_data->controller->max_speed_hz / 2));
368 static void lpss_ssp_cs_control(struct spi_device *spi, bool enable)
370 struct driver_data *drv_data =
371 spi_controller_get_devdata(spi->controller);
372 const struct lpss_config *config;
375 config = lpss_get_config(drv_data);
378 lpss_ssp_select_cs(spi, config);
380 value = __lpss_ssp_read_priv(drv_data, config->reg_cs_ctrl);
382 value &= ~LPSS_CS_CONTROL_CS_HIGH;
384 value |= LPSS_CS_CONTROL_CS_HIGH;
385 __lpss_ssp_write_priv(drv_data, config->reg_cs_ctrl, value);
388 static void cs_assert(struct spi_device *spi)
390 struct chip_data *chip = spi_get_ctldata(spi);
391 struct driver_data *drv_data =
392 spi_controller_get_devdata(spi->controller);
394 if (drv_data->ssp_type == CE4100_SSP) {
395 pxa2xx_spi_write(drv_data, SSSR, chip->frm);
399 if (chip->cs_control) {
400 chip->cs_control(PXA2XX_CS_ASSERT);
404 if (chip->gpiod_cs) {
405 gpiod_set_value(chip->gpiod_cs, chip->gpio_cs_inverted);
409 if (is_lpss_ssp(drv_data))
410 lpss_ssp_cs_control(spi, true);
413 static void cs_deassert(struct spi_device *spi)
415 struct chip_data *chip = spi_get_ctldata(spi);
416 struct driver_data *drv_data =
417 spi_controller_get_devdata(spi->controller);
418 unsigned long timeout;
420 if (drv_data->ssp_type == CE4100_SSP)
423 /* Wait until SSP becomes idle before deasserting the CS */
424 timeout = jiffies + msecs_to_jiffies(10);
425 while (pxa2xx_spi_read(drv_data, SSSR) & SSSR_BSY &&
426 !time_after(jiffies, timeout))
429 if (chip->cs_control) {
430 chip->cs_control(PXA2XX_CS_DEASSERT);
434 if (chip->gpiod_cs) {
435 gpiod_set_value(chip->gpiod_cs, !chip->gpio_cs_inverted);
439 if (is_lpss_ssp(drv_data))
440 lpss_ssp_cs_control(spi, false);
443 static void pxa2xx_spi_set_cs(struct spi_device *spi, bool level)
451 int pxa2xx_spi_flush(struct driver_data *drv_data)
453 unsigned long limit = loops_per_jiffy << 1;
456 while (pxa2xx_spi_read(drv_data, SSSR) & SSSR_RNE)
457 pxa2xx_spi_read(drv_data, SSDR);
458 } while ((pxa2xx_spi_read(drv_data, SSSR) & SSSR_BSY) && --limit);
459 write_SSSR_CS(drv_data, SSSR_ROR);
464 static int null_writer(struct driver_data *drv_data)
466 u8 n_bytes = drv_data->n_bytes;
468 if (pxa2xx_spi_txfifo_full(drv_data)
469 || (drv_data->tx == drv_data->tx_end))
472 pxa2xx_spi_write(drv_data, SSDR, 0);
473 drv_data->tx += n_bytes;
478 static int null_reader(struct driver_data *drv_data)
480 u8 n_bytes = drv_data->n_bytes;
482 while ((pxa2xx_spi_read(drv_data, SSSR) & SSSR_RNE)
483 && (drv_data->rx < drv_data->rx_end)) {
484 pxa2xx_spi_read(drv_data, SSDR);
485 drv_data->rx += n_bytes;
488 return drv_data->rx == drv_data->rx_end;
491 static int u8_writer(struct driver_data *drv_data)
493 if (pxa2xx_spi_txfifo_full(drv_data)
494 || (drv_data->tx == drv_data->tx_end))
497 pxa2xx_spi_write(drv_data, SSDR, *(u8 *)(drv_data->tx));
503 static int u8_reader(struct driver_data *drv_data)
505 while ((pxa2xx_spi_read(drv_data, SSSR) & SSSR_RNE)
506 && (drv_data->rx < drv_data->rx_end)) {
507 *(u8 *)(drv_data->rx) = pxa2xx_spi_read(drv_data, SSDR);
511 return drv_data->rx == drv_data->rx_end;
514 static int u16_writer(struct driver_data *drv_data)
516 if (pxa2xx_spi_txfifo_full(drv_data)
517 || (drv_data->tx == drv_data->tx_end))
520 pxa2xx_spi_write(drv_data, SSDR, *(u16 *)(drv_data->tx));
526 static int u16_reader(struct driver_data *drv_data)
528 while ((pxa2xx_spi_read(drv_data, SSSR) & SSSR_RNE)
529 && (drv_data->rx < drv_data->rx_end)) {
530 *(u16 *)(drv_data->rx) = pxa2xx_spi_read(drv_data, SSDR);
534 return drv_data->rx == drv_data->rx_end;
537 static int u32_writer(struct driver_data *drv_data)
539 if (pxa2xx_spi_txfifo_full(drv_data)
540 || (drv_data->tx == drv_data->tx_end))
543 pxa2xx_spi_write(drv_data, SSDR, *(u32 *)(drv_data->tx));
549 static int u32_reader(struct driver_data *drv_data)
551 while ((pxa2xx_spi_read(drv_data, SSSR) & SSSR_RNE)
552 && (drv_data->rx < drv_data->rx_end)) {
553 *(u32 *)(drv_data->rx) = pxa2xx_spi_read(drv_data, SSDR);
557 return drv_data->rx == drv_data->rx_end;
560 static void reset_sccr1(struct driver_data *drv_data)
562 struct chip_data *chip =
563 spi_get_ctldata(drv_data->controller->cur_msg->spi);
566 sccr1_reg = pxa2xx_spi_read(drv_data, SSCR1) & ~drv_data->int_cr1;
567 switch (drv_data->ssp_type) {
568 case QUARK_X1000_SSP:
569 sccr1_reg &= ~QUARK_X1000_SSCR1_RFT;
572 sccr1_reg &= ~CE4100_SSCR1_RFT;
575 sccr1_reg &= ~SSCR1_RFT;
578 sccr1_reg |= chip->threshold;
579 pxa2xx_spi_write(drv_data, SSCR1, sccr1_reg);
582 static void int_error_stop(struct driver_data *drv_data, const char* msg)
584 /* Stop and reset SSP */
585 write_SSSR_CS(drv_data, drv_data->clear_sr);
586 reset_sccr1(drv_data);
587 if (!pxa25x_ssp_comp(drv_data))
588 pxa2xx_spi_write(drv_data, SSTO, 0);
589 pxa2xx_spi_flush(drv_data);
590 pxa2xx_spi_write(drv_data, SSCR0,
591 pxa2xx_spi_read(drv_data, SSCR0) & ~SSCR0_SSE);
593 dev_err(&drv_data->pdev->dev, "%s\n", msg);
595 drv_data->controller->cur_msg->status = -EIO;
596 spi_finalize_current_transfer(drv_data->controller);
599 static void int_transfer_complete(struct driver_data *drv_data)
601 /* Clear and disable interrupts */
602 write_SSSR_CS(drv_data, drv_data->clear_sr);
603 reset_sccr1(drv_data);
604 if (!pxa25x_ssp_comp(drv_data))
605 pxa2xx_spi_write(drv_data, SSTO, 0);
607 spi_finalize_current_transfer(drv_data->controller);
610 static irqreturn_t interrupt_transfer(struct driver_data *drv_data)
612 u32 irq_mask = (pxa2xx_spi_read(drv_data, SSCR1) & SSCR1_TIE) ?
613 drv_data->mask_sr : drv_data->mask_sr & ~SSSR_TFS;
615 u32 irq_status = pxa2xx_spi_read(drv_data, SSSR) & irq_mask;
617 if (irq_status & SSSR_ROR) {
618 int_error_stop(drv_data, "interrupt_transfer: fifo overrun");
622 if (irq_status & SSSR_TUR) {
623 int_error_stop(drv_data, "interrupt_transfer: fifo underrun");
627 if (irq_status & SSSR_TINT) {
628 pxa2xx_spi_write(drv_data, SSSR, SSSR_TINT);
629 if (drv_data->read(drv_data)) {
630 int_transfer_complete(drv_data);
635 /* Drain rx fifo, Fill tx fifo and prevent overruns */
637 if (drv_data->read(drv_data)) {
638 int_transfer_complete(drv_data);
641 } while (drv_data->write(drv_data));
643 if (drv_data->read(drv_data)) {
644 int_transfer_complete(drv_data);
648 if (drv_data->tx == drv_data->tx_end) {
652 sccr1_reg = pxa2xx_spi_read(drv_data, SSCR1);
653 sccr1_reg &= ~SSCR1_TIE;
656 * PXA25x_SSP has no timeout, set up rx threshould for the
657 * remaining RX bytes.
659 if (pxa25x_ssp_comp(drv_data)) {
662 pxa2xx_spi_clear_rx_thre(drv_data, &sccr1_reg);
664 bytes_left = drv_data->rx_end - drv_data->rx;
665 switch (drv_data->n_bytes) {
674 rx_thre = pxa2xx_spi_get_rx_default_thre(drv_data);
675 if (rx_thre > bytes_left)
676 rx_thre = bytes_left;
678 pxa2xx_spi_set_rx_thre(drv_data, &sccr1_reg, rx_thre);
680 pxa2xx_spi_write(drv_data, SSCR1, sccr1_reg);
683 /* We did something */
687 static void handle_bad_msg(struct driver_data *drv_data)
689 pxa2xx_spi_write(drv_data, SSCR0,
690 pxa2xx_spi_read(drv_data, SSCR0) & ~SSCR0_SSE);
691 pxa2xx_spi_write(drv_data, SSCR1,
692 pxa2xx_spi_read(drv_data, SSCR1) & ~drv_data->int_cr1);
693 if (!pxa25x_ssp_comp(drv_data))
694 pxa2xx_spi_write(drv_data, SSTO, 0);
695 write_SSSR_CS(drv_data, drv_data->clear_sr);
697 dev_err(&drv_data->pdev->dev,
698 "bad message state in interrupt handler\n");
701 static irqreturn_t ssp_int(int irq, void *dev_id)
703 struct driver_data *drv_data = dev_id;
705 u32 mask = drv_data->mask_sr;
709 * The IRQ might be shared with other peripherals so we must first
710 * check that are we RPM suspended or not. If we are we assume that
711 * the IRQ was not for us (we shouldn't be RPM suspended when the
712 * interrupt is enabled).
714 if (pm_runtime_suspended(&drv_data->pdev->dev))
718 * If the device is not yet in RPM suspended state and we get an
719 * interrupt that is meant for another device, check if status bits
720 * are all set to one. That means that the device is already
723 status = pxa2xx_spi_read(drv_data, SSSR);
727 sccr1_reg = pxa2xx_spi_read(drv_data, SSCR1);
729 /* Ignore possible writes if we don't need to write */
730 if (!(sccr1_reg & SSCR1_TIE))
733 /* Ignore RX timeout interrupt if it is disabled */
734 if (!(sccr1_reg & SSCR1_TINTE))
737 if (!(status & mask))
740 pxa2xx_spi_write(drv_data, SSCR1, sccr1_reg & ~drv_data->int_cr1);
741 pxa2xx_spi_write(drv_data, SSCR1, sccr1_reg);
743 if (!drv_data->controller->cur_msg) {
744 handle_bad_msg(drv_data);
749 return drv_data->transfer_handler(drv_data);
753 * The Quark SPI has an additional 24 bit register (DDS_CLK_RATE) to multiply
754 * input frequency by fractions of 2^24. It also has a divider by 5.
756 * There are formulas to get baud rate value for given input frequency and
757 * divider parameters, such as DDS_CLK_RATE and SCR:
761 * Fssp = Fsys * DDS_CLK_RATE / 2^24 (1)
762 * Baud rate = Fsclk = Fssp / (2 * (SCR + 1)) (2)
764 * DDS_CLK_RATE either 2^n or 2^n / 5.
765 * SCR is in range 0 .. 255
767 * Divisor = 5^i * 2^j * 2 * k
768 * i = [0, 1] i = 1 iff j = 0 or j > 3
769 * j = [0, 23] j = 0 iff i = 1
771 * Special case: j = 0, i = 1: Divisor = 2 / 5
773 * Accordingly to the specification the recommended values for DDS_CLK_RATE
775 * Case 1: 2^n, n = [0, 23]
776 * Case 2: 2^24 * 2 / 5 (0x666666)
777 * Case 3: less than or equal to 2^24 / 5 / 16 (0x33333)
779 * In all cases the lowest possible value is better.
781 * The function calculates parameters for all cases and chooses the one closest
782 * to the asked baud rate.
784 static unsigned int quark_x1000_get_clk_div(int rate, u32 *dds)
786 unsigned long xtal = 200000000;
787 unsigned long fref = xtal / 2; /* mandatory division by 2,
790 unsigned long fref1 = fref / 2; /* case 1 */
791 unsigned long fref2 = fref * 2 / 5; /* case 2 */
793 unsigned long q, q1, q2;
799 /* Set initial value for DDS_CLK_RATE */
800 mul = (1 << 24) >> 1;
802 /* Calculate initial quot */
803 q1 = DIV_ROUND_UP(fref1, rate);
805 /* Scale q1 if it's too big */
807 /* Scale q1 to range [1, 512] */
808 scale = fls_long(q1 - 1);
814 /* Round the result if we have a remainder */
818 /* Decrease DDS_CLK_RATE as much as we can without loss in precision */
823 /* Get the remainder */
824 r1 = abs(fref1 / (1 << (24 - fls_long(mul))) / q1 - rate);
828 q2 = DIV_ROUND_UP(fref2, rate);
829 r2 = abs(fref2 / q2 - rate);
832 * Choose the best between two: less remainder we have the better. We
833 * can't go case 2 if q2 is greater than 256 since SCR register can
834 * hold only values 0 .. 255.
836 if (r2 >= r1 || q2 > 256) {
837 /* case 1 is better */
841 /* case 2 is better */
844 mul = (1 << 24) * 2 / 5;
847 /* Check case 3 only if the divisor is big enough */
848 if (fref / rate >= 80) {
852 /* Calculate initial quot */
853 q1 = DIV_ROUND_UP(fref, rate);
856 /* Get the remainder */
857 fssp = (u64)fref * m;
858 do_div(fssp, 1 << 24);
859 r1 = abs(fssp - rate);
861 /* Choose this one if it suits better */
863 /* case 3 is better */
873 static unsigned int ssp_get_clk_div(struct driver_data *drv_data, int rate)
875 unsigned long ssp_clk = drv_data->controller->max_speed_hz;
876 const struct ssp_device *ssp = drv_data->ssp;
878 rate = min_t(int, ssp_clk, rate);
881 * Calculate the divisor for the SCR (Serial Clock Rate), avoiding
882 * that the SSP transmission rate can be greater than the device rate
884 if (ssp->type == PXA25x_SSP || ssp->type == CE4100_SSP)
885 return (DIV_ROUND_UP(ssp_clk, 2 * rate) - 1) & 0xff;
887 return (DIV_ROUND_UP(ssp_clk, rate) - 1) & 0xfff;
890 static unsigned int pxa2xx_ssp_get_clk_div(struct driver_data *drv_data,
893 struct chip_data *chip =
894 spi_get_ctldata(drv_data->controller->cur_msg->spi);
895 unsigned int clk_div;
897 switch (drv_data->ssp_type) {
898 case QUARK_X1000_SSP:
899 clk_div = quark_x1000_get_clk_div(rate, &chip->dds_rate);
902 clk_div = ssp_get_clk_div(drv_data, rate);
908 static bool pxa2xx_spi_can_dma(struct spi_controller *controller,
909 struct spi_device *spi,
910 struct spi_transfer *xfer)
912 struct chip_data *chip = spi_get_ctldata(spi);
914 return chip->enable_dma &&
915 xfer->len <= MAX_DMA_LEN &&
916 xfer->len >= chip->dma_burst_size;
919 static int pxa2xx_spi_transfer_one(struct spi_controller *controller,
920 struct spi_device *spi,
921 struct spi_transfer *transfer)
923 struct driver_data *drv_data = spi_controller_get_devdata(controller);
924 struct spi_message *message = controller->cur_msg;
925 struct chip_data *chip = spi_get_ctldata(spi);
926 u32 dma_thresh = chip->dma_threshold;
927 u32 dma_burst = chip->dma_burst_size;
928 u32 change_mask = pxa2xx_spi_get_ssrc1_change_mask(drv_data);
937 /* Check if we can DMA this transfer */
938 if (transfer->len > MAX_DMA_LEN && chip->enable_dma) {
940 /* reject already-mapped transfers; PIO won't always work */
941 if (message->is_dma_mapped
942 || transfer->rx_dma || transfer->tx_dma) {
944 "Mapped transfer length of %u is greater than %d\n",
945 transfer->len, MAX_DMA_LEN);
949 /* warn ... we force this to PIO mode */
950 dev_warn_ratelimited(&spi->dev,
951 "DMA disabled for transfer length %ld greater than %d\n",
952 (long)transfer->len, MAX_DMA_LEN);
955 /* Setup the transfer state based on the type of transfer */
956 if (pxa2xx_spi_flush(drv_data) == 0) {
957 dev_err(&spi->dev, "Flush failed\n");
960 drv_data->n_bytes = chip->n_bytes;
961 drv_data->tx = (void *)transfer->tx_buf;
962 drv_data->tx_end = drv_data->tx + transfer->len;
963 drv_data->rx = transfer->rx_buf;
964 drv_data->rx_end = drv_data->rx + transfer->len;
965 drv_data->write = drv_data->tx ? chip->write : null_writer;
966 drv_data->read = drv_data->rx ? chip->read : null_reader;
968 /* Change speed and bit per word on a per transfer */
969 bits = transfer->bits_per_word;
970 speed = transfer->speed_hz;
972 clk_div = pxa2xx_ssp_get_clk_div(drv_data, speed);
975 drv_data->n_bytes = 1;
976 drv_data->read = drv_data->read != null_reader ?
977 u8_reader : null_reader;
978 drv_data->write = drv_data->write != null_writer ?
979 u8_writer : null_writer;
980 } else if (bits <= 16) {
981 drv_data->n_bytes = 2;
982 drv_data->read = drv_data->read != null_reader ?
983 u16_reader : null_reader;
984 drv_data->write = drv_data->write != null_writer ?
985 u16_writer : null_writer;
986 } else if (bits <= 32) {
987 drv_data->n_bytes = 4;
988 drv_data->read = drv_data->read != null_reader ?
989 u32_reader : null_reader;
990 drv_data->write = drv_data->write != null_writer ?
991 u32_writer : null_writer;
994 * if bits/word is changed in dma mode, then must check the
995 * thresholds and burst also
997 if (chip->enable_dma) {
998 if (pxa2xx_spi_set_dma_burst_and_threshold(chip,
1002 dev_warn_ratelimited(&spi->dev,
1003 "DMA burst size reduced to match bits_per_word\n");
1006 dma_mapped = controller->can_dma &&
1007 controller->can_dma(controller, spi, transfer) &&
1008 controller->cur_msg_mapped;
1011 /* Ensure we have the correct interrupt handler */
1012 drv_data->transfer_handler = pxa2xx_spi_dma_transfer;
1014 err = pxa2xx_spi_dma_prepare(drv_data, transfer);
1018 /* Clear status and start DMA engine */
1019 cr1 = chip->cr1 | dma_thresh | drv_data->dma_cr1;
1020 pxa2xx_spi_write(drv_data, SSSR, drv_data->clear_sr);
1022 pxa2xx_spi_dma_start(drv_data);
1024 /* Ensure we have the correct interrupt handler */
1025 drv_data->transfer_handler = interrupt_transfer;
1028 cr1 = chip->cr1 | chip->threshold | drv_data->int_cr1;
1029 write_SSSR_CS(drv_data, drv_data->clear_sr);
1032 /* NOTE: PXA25x_SSP _could_ use external clocking ... */
1033 cr0 = pxa2xx_configure_sscr0(drv_data, clk_div, bits);
1034 if (!pxa25x_ssp_comp(drv_data))
1035 dev_dbg(&spi->dev, "%u Hz actual, %s\n",
1036 controller->max_speed_hz
1037 / (1 + ((cr0 & SSCR0_SCR(0xfff)) >> 8)),
1038 dma_mapped ? "DMA" : "PIO");
1040 dev_dbg(&spi->dev, "%u Hz actual, %s\n",
1041 controller->max_speed_hz / 2
1042 / (1 + ((cr0 & SSCR0_SCR(0x0ff)) >> 8)),
1043 dma_mapped ? "DMA" : "PIO");
1045 if (is_lpss_ssp(drv_data)) {
1046 if ((pxa2xx_spi_read(drv_data, SSIRF) & 0xff)
1047 != chip->lpss_rx_threshold)
1048 pxa2xx_spi_write(drv_data, SSIRF,
1049 chip->lpss_rx_threshold);
1050 if ((pxa2xx_spi_read(drv_data, SSITF) & 0xffff)
1051 != chip->lpss_tx_threshold)
1052 pxa2xx_spi_write(drv_data, SSITF,
1053 chip->lpss_tx_threshold);
1056 if (is_quark_x1000_ssp(drv_data) &&
1057 (pxa2xx_spi_read(drv_data, DDS_RATE) != chip->dds_rate))
1058 pxa2xx_spi_write(drv_data, DDS_RATE, chip->dds_rate);
1060 /* see if we need to reload the config registers */
1061 if ((pxa2xx_spi_read(drv_data, SSCR0) != cr0)
1062 || (pxa2xx_spi_read(drv_data, SSCR1) & change_mask)
1063 != (cr1 & change_mask)) {
1064 /* stop the SSP, and update the other bits */
1065 pxa2xx_spi_write(drv_data, SSCR0, cr0 & ~SSCR0_SSE);
1066 if (!pxa25x_ssp_comp(drv_data))
1067 pxa2xx_spi_write(drv_data, SSTO, chip->timeout);
1068 /* first set CR1 without interrupt and service enables */
1069 pxa2xx_spi_write(drv_data, SSCR1, cr1 & change_mask);
1070 /* restart the SSP */
1071 pxa2xx_spi_write(drv_data, SSCR0, cr0);
1074 if (!pxa25x_ssp_comp(drv_data))
1075 pxa2xx_spi_write(drv_data, SSTO, chip->timeout);
1078 if (drv_data->ssp_type == MMP2_SSP) {
1079 u8 tx_level = (pxa2xx_spi_read(drv_data, SSSR)
1080 & SSSR_TFL_MASK) >> 8;
1083 /* On MMP2, flipping SSE doesn't to empty TXFIFO. */
1084 dev_warn(&spi->dev, "%d bytes of garbage in TXFIFO!\n",
1086 if (tx_level > transfer->len)
1087 tx_level = transfer->len;
1088 drv_data->tx += tx_level;
1092 if (spi_controller_is_slave(controller)) {
1093 while (drv_data->write(drv_data))
1095 if (drv_data->gpiod_ready) {
1096 gpiod_set_value(drv_data->gpiod_ready, 1);
1098 gpiod_set_value(drv_data->gpiod_ready, 0);
1103 * Release the data by enabling service requests and interrupts,
1104 * without changing any mode bits
1106 pxa2xx_spi_write(drv_data, SSCR1, cr1);
1111 static int pxa2xx_spi_slave_abort(struct spi_controller *controller)
1113 struct driver_data *drv_data = spi_controller_get_devdata(controller);
1115 /* Stop and reset SSP */
1116 write_SSSR_CS(drv_data, drv_data->clear_sr);
1117 reset_sccr1(drv_data);
1118 if (!pxa25x_ssp_comp(drv_data))
1119 pxa2xx_spi_write(drv_data, SSTO, 0);
1120 pxa2xx_spi_flush(drv_data);
1121 pxa2xx_spi_write(drv_data, SSCR0,
1122 pxa2xx_spi_read(drv_data, SSCR0) & ~SSCR0_SSE);
1124 dev_dbg(&drv_data->pdev->dev, "transfer aborted\n");
1126 drv_data->controller->cur_msg->status = -EINTR;
1127 spi_finalize_current_transfer(drv_data->controller);
1132 static void pxa2xx_spi_handle_err(struct spi_controller *controller,
1133 struct spi_message *msg)
1135 struct driver_data *drv_data = spi_controller_get_devdata(controller);
1137 /* Disable the SSP */
1138 pxa2xx_spi_write(drv_data, SSCR0,
1139 pxa2xx_spi_read(drv_data, SSCR0) & ~SSCR0_SSE);
1140 /* Clear and disable interrupts and service requests */
1141 write_SSSR_CS(drv_data, drv_data->clear_sr);
1142 pxa2xx_spi_write(drv_data, SSCR1,
1143 pxa2xx_spi_read(drv_data, SSCR1)
1144 & ~(drv_data->int_cr1 | drv_data->dma_cr1));
1145 if (!pxa25x_ssp_comp(drv_data))
1146 pxa2xx_spi_write(drv_data, SSTO, 0);
1149 * Stop the DMA if running. Note DMA callback handler may have unset
1150 * the dma_running already, which is fine as stopping is not needed
1151 * then but we shouldn't rely this flag for anything else than
1152 * stopping. For instance to differentiate between PIO and DMA
1155 if (atomic_read(&drv_data->dma_running))
1156 pxa2xx_spi_dma_stop(drv_data);
1159 static int pxa2xx_spi_unprepare_transfer(struct spi_controller *controller)
1161 struct driver_data *drv_data = spi_controller_get_devdata(controller);
1163 /* Disable the SSP now */
1164 pxa2xx_spi_write(drv_data, SSCR0,
1165 pxa2xx_spi_read(drv_data, SSCR0) & ~SSCR0_SSE);
1170 static int setup_cs(struct spi_device *spi, struct chip_data *chip,
1171 struct pxa2xx_spi_chip *chip_info)
1173 struct driver_data *drv_data =
1174 spi_controller_get_devdata(spi->controller);
1175 struct gpio_desc *gpiod;
1181 if (drv_data->cs_gpiods) {
1182 gpiod = drv_data->cs_gpiods[spi->chip_select];
1184 chip->gpiod_cs = gpiod;
1185 chip->gpio_cs_inverted = spi->mode & SPI_CS_HIGH;
1186 gpiod_set_value(gpiod, chip->gpio_cs_inverted);
1192 if (chip_info == NULL)
1195 /* NOTE: setup() can be called multiple times, possibly with
1196 * different chip_info, release previously requested GPIO
1198 if (chip->gpiod_cs) {
1199 gpiod_put(chip->gpiod_cs);
1200 chip->gpiod_cs = NULL;
1203 /* If (*cs_control) is provided, ignore GPIO chip select */
1204 if (chip_info->cs_control) {
1205 chip->cs_control = chip_info->cs_control;
1209 if (gpio_is_valid(chip_info->gpio_cs)) {
1210 err = gpio_request(chip_info->gpio_cs, "SPI_CS");
1212 dev_err(&spi->dev, "failed to request chip select GPIO%d\n",
1213 chip_info->gpio_cs);
1217 gpiod = gpio_to_desc(chip_info->gpio_cs);
1218 chip->gpiod_cs = gpiod;
1219 chip->gpio_cs_inverted = spi->mode & SPI_CS_HIGH;
1221 err = gpiod_direction_output(gpiod, !chip->gpio_cs_inverted);
1227 static int setup(struct spi_device *spi)
1229 struct pxa2xx_spi_chip *chip_info;
1230 struct chip_data *chip;
1231 const struct lpss_config *config;
1232 struct driver_data *drv_data =
1233 spi_controller_get_devdata(spi->controller);
1234 uint tx_thres, tx_hi_thres, rx_thres;
1236 switch (drv_data->ssp_type) {
1237 case QUARK_X1000_SSP:
1238 tx_thres = TX_THRESH_QUARK_X1000_DFLT;
1240 rx_thres = RX_THRESH_QUARK_X1000_DFLT;
1243 tx_thres = TX_THRESH_CE4100_DFLT;
1245 rx_thres = RX_THRESH_CE4100_DFLT;
1253 config = lpss_get_config(drv_data);
1254 tx_thres = config->tx_threshold_lo;
1255 tx_hi_thres = config->tx_threshold_hi;
1256 rx_thres = config->rx_threshold;
1260 if (spi_controller_is_slave(drv_data->controller)) {
1264 tx_thres = TX_THRESH_DFLT;
1265 rx_thres = RX_THRESH_DFLT;
1270 /* Only alloc on first setup */
1271 chip = spi_get_ctldata(spi);
1273 chip = kzalloc(sizeof(struct chip_data), GFP_KERNEL);
1277 if (drv_data->ssp_type == CE4100_SSP) {
1278 if (spi->chip_select > 4) {
1280 "failed setup: cs number must not be > 4.\n");
1285 chip->frm = spi->chip_select;
1287 chip->enable_dma = drv_data->controller_info->enable_dma;
1288 chip->timeout = TIMOUT_DFLT;
1291 /* protocol drivers may change the chip settings, so...
1292 * if chip_info exists, use it */
1293 chip_info = spi->controller_data;
1295 /* chip_info isn't always needed */
1298 if (chip_info->timeout)
1299 chip->timeout = chip_info->timeout;
1300 if (chip_info->tx_threshold)
1301 tx_thres = chip_info->tx_threshold;
1302 if (chip_info->tx_hi_threshold)
1303 tx_hi_thres = chip_info->tx_hi_threshold;
1304 if (chip_info->rx_threshold)
1305 rx_thres = chip_info->rx_threshold;
1306 chip->dma_threshold = 0;
1307 if (chip_info->enable_loopback)
1308 chip->cr1 = SSCR1_LBM;
1310 if (spi_controller_is_slave(drv_data->controller)) {
1311 chip->cr1 |= SSCR1_SCFR;
1312 chip->cr1 |= SSCR1_SCLKDIR;
1313 chip->cr1 |= SSCR1_SFRMDIR;
1314 chip->cr1 |= SSCR1_SPH;
1317 chip->lpss_rx_threshold = SSIRF_RxThresh(rx_thres);
1318 chip->lpss_tx_threshold = SSITF_TxLoThresh(tx_thres)
1319 | SSITF_TxHiThresh(tx_hi_thres);
1321 /* set dma burst and threshold outside of chip_info path so that if
1322 * chip_info goes away after setting chip->enable_dma, the
1323 * burst and threshold can still respond to changes in bits_per_word */
1324 if (chip->enable_dma) {
1325 /* set up legal burst and threshold for dma */
1326 if (pxa2xx_spi_set_dma_burst_and_threshold(chip, spi,
1328 &chip->dma_burst_size,
1329 &chip->dma_threshold)) {
1331 "in setup: DMA burst size reduced to match bits_per_word\n");
1334 "in setup: DMA burst size set to %u\n",
1335 chip->dma_burst_size);
1338 switch (drv_data->ssp_type) {
1339 case QUARK_X1000_SSP:
1340 chip->threshold = (QUARK_X1000_SSCR1_RxTresh(rx_thres)
1341 & QUARK_X1000_SSCR1_RFT)
1342 | (QUARK_X1000_SSCR1_TxTresh(tx_thres)
1343 & QUARK_X1000_SSCR1_TFT);
1346 chip->threshold = (CE4100_SSCR1_RxTresh(rx_thres) & CE4100_SSCR1_RFT) |
1347 (CE4100_SSCR1_TxTresh(tx_thres) & CE4100_SSCR1_TFT);
1350 chip->threshold = (SSCR1_RxTresh(rx_thres) & SSCR1_RFT) |
1351 (SSCR1_TxTresh(tx_thres) & SSCR1_TFT);
1355 chip->cr1 &= ~(SSCR1_SPO | SSCR1_SPH);
1356 chip->cr1 |= (((spi->mode & SPI_CPHA) != 0) ? SSCR1_SPH : 0)
1357 | (((spi->mode & SPI_CPOL) != 0) ? SSCR1_SPO : 0);
1359 if (spi->mode & SPI_LOOP)
1360 chip->cr1 |= SSCR1_LBM;
1362 if (spi->bits_per_word <= 8) {
1364 chip->read = u8_reader;
1365 chip->write = u8_writer;
1366 } else if (spi->bits_per_word <= 16) {
1368 chip->read = u16_reader;
1369 chip->write = u16_writer;
1370 } else if (spi->bits_per_word <= 32) {
1372 chip->read = u32_reader;
1373 chip->write = u32_writer;
1376 spi_set_ctldata(spi, chip);
1378 if (drv_data->ssp_type == CE4100_SSP)
1381 return setup_cs(spi, chip, chip_info);
1384 static void cleanup(struct spi_device *spi)
1386 struct chip_data *chip = spi_get_ctldata(spi);
1387 struct driver_data *drv_data =
1388 spi_controller_get_devdata(spi->controller);
1393 if (drv_data->ssp_type != CE4100_SSP && !drv_data->cs_gpiods &&
1395 gpiod_put(chip->gpiod_cs);
1400 static const struct acpi_device_id pxa2xx_spi_acpi_match[] = {
1401 { "INT33C0", LPSS_LPT_SSP },
1402 { "INT33C1", LPSS_LPT_SSP },
1403 { "INT3430", LPSS_LPT_SSP },
1404 { "INT3431", LPSS_LPT_SSP },
1405 { "80860F0E", LPSS_BYT_SSP },
1406 { "8086228E", LPSS_BSW_SSP },
1409 MODULE_DEVICE_TABLE(acpi, pxa2xx_spi_acpi_match);
1412 * PCI IDs of compound devices that integrate both host controller and private
1413 * integrated DMA engine. Please note these are not used in module
1414 * autoloading and probing in this module but matching the LPSS SSP type.
1416 static const struct pci_device_id pxa2xx_spi_pci_compound_match[] = {
1418 { PCI_VDEVICE(INTEL, 0x9d29), LPSS_SPT_SSP },
1419 { PCI_VDEVICE(INTEL, 0x9d2a), LPSS_SPT_SSP },
1421 { PCI_VDEVICE(INTEL, 0xa129), LPSS_SPT_SSP },
1422 { PCI_VDEVICE(INTEL, 0xa12a), LPSS_SPT_SSP },
1424 { PCI_VDEVICE(INTEL, 0xa2a9), LPSS_SPT_SSP },
1425 { PCI_VDEVICE(INTEL, 0xa2aa), LPSS_SPT_SSP },
1427 { PCI_VDEVICE(INTEL, 0x0ac2), LPSS_BXT_SSP },
1428 { PCI_VDEVICE(INTEL, 0x0ac4), LPSS_BXT_SSP },
1429 { PCI_VDEVICE(INTEL, 0x0ac6), LPSS_BXT_SSP },
1431 { PCI_VDEVICE(INTEL, 0x1ac2), LPSS_BXT_SSP },
1432 { PCI_VDEVICE(INTEL, 0x1ac4), LPSS_BXT_SSP },
1433 { PCI_VDEVICE(INTEL, 0x1ac6), LPSS_BXT_SSP },
1435 { PCI_VDEVICE(INTEL, 0x31c2), LPSS_BXT_SSP },
1436 { PCI_VDEVICE(INTEL, 0x31c4), LPSS_BXT_SSP },
1437 { PCI_VDEVICE(INTEL, 0x31c6), LPSS_BXT_SSP },
1439 { PCI_VDEVICE(INTEL, 0x34aa), LPSS_CNL_SSP },
1440 { PCI_VDEVICE(INTEL, 0x34ab), LPSS_CNL_SSP },
1441 { PCI_VDEVICE(INTEL, 0x34fb), LPSS_CNL_SSP },
1443 { PCI_VDEVICE(INTEL, 0x4b2a), LPSS_BXT_SSP },
1444 { PCI_VDEVICE(INTEL, 0x4b2b), LPSS_BXT_SSP },
1445 { PCI_VDEVICE(INTEL, 0x4b37), LPSS_BXT_SSP },
1447 { PCI_VDEVICE(INTEL, 0x5ac2), LPSS_BXT_SSP },
1448 { PCI_VDEVICE(INTEL, 0x5ac4), LPSS_BXT_SSP },
1449 { PCI_VDEVICE(INTEL, 0x5ac6), LPSS_BXT_SSP },
1451 { PCI_VDEVICE(INTEL, 0x9daa), LPSS_CNL_SSP },
1452 { PCI_VDEVICE(INTEL, 0x9dab), LPSS_CNL_SSP },
1453 { PCI_VDEVICE(INTEL, 0x9dfb), LPSS_CNL_SSP },
1455 { PCI_VDEVICE(INTEL, 0xa32a), LPSS_CNL_SSP },
1456 { PCI_VDEVICE(INTEL, 0xa32b), LPSS_CNL_SSP },
1457 { PCI_VDEVICE(INTEL, 0xa37b), LPSS_CNL_SSP },
1459 { PCI_VDEVICE(INTEL, 0x02aa), LPSS_CNL_SSP },
1460 { PCI_VDEVICE(INTEL, 0x02ab), LPSS_CNL_SSP },
1461 { PCI_VDEVICE(INTEL, 0x02fb), LPSS_CNL_SSP },
1463 { PCI_VDEVICE(INTEL, 0x06aa), LPSS_CNL_SSP },
1464 { PCI_VDEVICE(INTEL, 0x06ab), LPSS_CNL_SSP },
1465 { PCI_VDEVICE(INTEL, 0x06fb), LPSS_CNL_SSP },
1467 { PCI_VDEVICE(INTEL, 0xa0aa), LPSS_CNL_SSP },
1468 { PCI_VDEVICE(INTEL, 0xa0ab), LPSS_CNL_SSP },
1469 { PCI_VDEVICE(INTEL, 0xa0de), LPSS_CNL_SSP },
1470 { PCI_VDEVICE(INTEL, 0xa0df), LPSS_CNL_SSP },
1471 { PCI_VDEVICE(INTEL, 0xa0fb), LPSS_CNL_SSP },
1472 { PCI_VDEVICE(INTEL, 0xa0fd), LPSS_CNL_SSP },
1473 { PCI_VDEVICE(INTEL, 0xa0fe), LPSS_CNL_SSP },
1477 static const struct of_device_id pxa2xx_spi_of_match[] = {
1478 { .compatible = "marvell,mmp2-ssp", .data = (void *)MMP2_SSP },
1481 MODULE_DEVICE_TABLE(of, pxa2xx_spi_of_match);
1485 static int pxa2xx_spi_get_port_id(struct device *dev)
1487 struct acpi_device *adev;
1491 adev = ACPI_COMPANION(dev);
1492 if (adev && adev->pnp.unique_id &&
1493 !kstrtouint(adev->pnp.unique_id, 0, &devid))
1498 #else /* !CONFIG_ACPI */
1500 static int pxa2xx_spi_get_port_id(struct device *dev)
1505 #endif /* CONFIG_ACPI */
1510 static bool pxa2xx_spi_idma_filter(struct dma_chan *chan, void *param)
1512 return param == chan->device->dev;
1515 #endif /* CONFIG_PCI */
1517 static struct pxa2xx_spi_controller *
1518 pxa2xx_spi_init_pdata(struct platform_device *pdev)
1520 struct pxa2xx_spi_controller *pdata;
1521 struct ssp_device *ssp;
1522 struct resource *res;
1523 struct device *parent = pdev->dev.parent;
1524 struct pci_dev *pcidev = dev_is_pci(parent) ? to_pci_dev(parent) : NULL;
1525 const struct pci_device_id *pcidev_id = NULL;
1526 enum pxa_ssp_type type;
1530 pcidev_id = pci_match_id(pxa2xx_spi_pci_compound_match, pcidev);
1532 match = device_get_match_data(&pdev->dev);
1534 type = (enum pxa_ssp_type)match;
1536 type = (enum pxa_ssp_type)pcidev_id->driver_data;
1540 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
1546 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1547 ssp->mmio_base = devm_ioremap_resource(&pdev->dev, res);
1548 if (IS_ERR(ssp->mmio_base))
1551 ssp->phys_base = res->start;
1555 pdata->tx_param = parent;
1556 pdata->rx_param = parent;
1557 pdata->dma_filter = pxa2xx_spi_idma_filter;
1561 ssp->clk = devm_clk_get(&pdev->dev, NULL);
1562 if (IS_ERR(ssp->clk))
1565 ssp->irq = platform_get_irq(pdev, 0);
1570 ssp->dev = &pdev->dev;
1571 ssp->port_id = pxa2xx_spi_get_port_id(&pdev->dev);
1573 pdata->is_slave = device_property_read_bool(&pdev->dev, "spi-slave");
1574 pdata->num_chipselect = 1;
1575 pdata->enable_dma = true;
1576 pdata->dma_burst_size = 1;
1581 static int pxa2xx_spi_fw_translate_cs(struct spi_controller *controller,
1584 struct driver_data *drv_data = spi_controller_get_devdata(controller);
1586 if (has_acpi_companion(&drv_data->pdev->dev)) {
1587 switch (drv_data->ssp_type) {
1589 * For Atoms the ACPI DeviceSelection used by the Windows
1590 * driver starts from 1 instead of 0 so translate it here
1591 * to match what Linux expects.
1605 static size_t pxa2xx_spi_max_dma_transfer_size(struct spi_device *spi)
1610 static int pxa2xx_spi_probe(struct platform_device *pdev)
1612 struct device *dev = &pdev->dev;
1613 struct pxa2xx_spi_controller *platform_info;
1614 struct spi_controller *controller;
1615 struct driver_data *drv_data;
1616 struct ssp_device *ssp;
1617 const struct lpss_config *config;
1621 platform_info = dev_get_platdata(dev);
1622 if (!platform_info) {
1623 platform_info = pxa2xx_spi_init_pdata(pdev);
1624 if (!platform_info) {
1625 dev_err(&pdev->dev, "missing platform data\n");
1630 ssp = pxa_ssp_request(pdev->id, pdev->name);
1632 ssp = &platform_info->ssp;
1634 if (!ssp->mmio_base) {
1635 dev_err(&pdev->dev, "failed to get ssp\n");
1639 if (platform_info->is_slave)
1640 controller = spi_alloc_slave(dev, sizeof(struct driver_data));
1642 controller = spi_alloc_master(dev, sizeof(struct driver_data));
1645 dev_err(&pdev->dev, "cannot alloc spi_controller\n");
1649 drv_data = spi_controller_get_devdata(controller);
1650 drv_data->controller = controller;
1651 drv_data->controller_info = platform_info;
1652 drv_data->pdev = pdev;
1653 drv_data->ssp = ssp;
1655 controller->dev.of_node = pdev->dev.of_node;
1656 /* the spi->mode bits understood by this driver: */
1657 controller->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH | SPI_LOOP;
1659 controller->bus_num = ssp->port_id;
1660 controller->dma_alignment = DMA_ALIGNMENT;
1661 controller->cleanup = cleanup;
1662 controller->setup = setup;
1663 controller->set_cs = pxa2xx_spi_set_cs;
1664 controller->transfer_one = pxa2xx_spi_transfer_one;
1665 controller->slave_abort = pxa2xx_spi_slave_abort;
1666 controller->handle_err = pxa2xx_spi_handle_err;
1667 controller->unprepare_transfer_hardware = pxa2xx_spi_unprepare_transfer;
1668 controller->fw_translate_cs = pxa2xx_spi_fw_translate_cs;
1669 controller->auto_runtime_pm = true;
1670 controller->flags = SPI_CONTROLLER_MUST_RX | SPI_CONTROLLER_MUST_TX;
1672 drv_data->ssp_type = ssp->type;
1674 drv_data->ioaddr = ssp->mmio_base;
1675 drv_data->ssdr_physical = ssp->phys_base + SSDR;
1676 if (pxa25x_ssp_comp(drv_data)) {
1677 switch (drv_data->ssp_type) {
1678 case QUARK_X1000_SSP:
1679 controller->bits_per_word_mask = SPI_BPW_RANGE_MASK(4, 32);
1682 controller->bits_per_word_mask = SPI_BPW_RANGE_MASK(4, 16);
1686 drv_data->int_cr1 = SSCR1_TIE | SSCR1_RIE;
1687 drv_data->dma_cr1 = 0;
1688 drv_data->clear_sr = SSSR_ROR;
1689 drv_data->mask_sr = SSSR_RFS | SSSR_TFS | SSSR_ROR;
1691 controller->bits_per_word_mask = SPI_BPW_RANGE_MASK(4, 32);
1692 drv_data->int_cr1 = SSCR1_TIE | SSCR1_RIE | SSCR1_TINTE;
1693 drv_data->dma_cr1 = DEFAULT_DMA_CR1;
1694 drv_data->clear_sr = SSSR_ROR | SSSR_TINT;
1695 drv_data->mask_sr = SSSR_TINT | SSSR_RFS | SSSR_TFS
1696 | SSSR_ROR | SSSR_TUR;
1699 status = request_irq(ssp->irq, ssp_int, IRQF_SHARED, dev_name(dev),
1702 dev_err(&pdev->dev, "cannot get IRQ %d\n", ssp->irq);
1703 goto out_error_controller_alloc;
1706 /* Setup DMA if requested */
1707 if (platform_info->enable_dma) {
1708 status = pxa2xx_spi_dma_setup(drv_data);
1710 dev_warn(dev, "no DMA channels available, using PIO\n");
1711 platform_info->enable_dma = false;
1713 controller->can_dma = pxa2xx_spi_can_dma;
1714 controller->max_dma_len = MAX_DMA_LEN;
1715 controller->max_transfer_size =
1716 pxa2xx_spi_max_dma_transfer_size;
1720 /* Enable SOC clock */
1721 status = clk_prepare_enable(ssp->clk);
1723 goto out_error_dma_irq_alloc;
1725 controller->max_speed_hz = clk_get_rate(ssp->clk);
1727 * Set minimum speed for all other platforms than Intel Quark which is
1728 * able do under 1 Hz transfers.
1730 if (!pxa25x_ssp_comp(drv_data))
1731 controller->min_speed_hz =
1732 DIV_ROUND_UP(controller->max_speed_hz, 4096);
1733 else if (!is_quark_x1000_ssp(drv_data))
1734 controller->min_speed_hz =
1735 DIV_ROUND_UP(controller->max_speed_hz, 512);
1737 /* Load default SSP configuration */
1738 pxa2xx_spi_write(drv_data, SSCR0, 0);
1739 switch (drv_data->ssp_type) {
1740 case QUARK_X1000_SSP:
1741 tmp = QUARK_X1000_SSCR1_RxTresh(RX_THRESH_QUARK_X1000_DFLT) |
1742 QUARK_X1000_SSCR1_TxTresh(TX_THRESH_QUARK_X1000_DFLT);
1743 pxa2xx_spi_write(drv_data, SSCR1, tmp);
1745 /* using the Motorola SPI protocol and use 8 bit frame */
1746 tmp = QUARK_X1000_SSCR0_Motorola | QUARK_X1000_SSCR0_DataSize(8);
1747 pxa2xx_spi_write(drv_data, SSCR0, tmp);
1750 tmp = CE4100_SSCR1_RxTresh(RX_THRESH_CE4100_DFLT) |
1751 CE4100_SSCR1_TxTresh(TX_THRESH_CE4100_DFLT);
1752 pxa2xx_spi_write(drv_data, SSCR1, tmp);
1753 tmp = SSCR0_SCR(2) | SSCR0_Motorola | SSCR0_DataSize(8);
1754 pxa2xx_spi_write(drv_data, SSCR0, tmp);
1758 if (spi_controller_is_slave(controller)) {
1766 tmp = SSCR1_RxTresh(RX_THRESH_DFLT) |
1767 SSCR1_TxTresh(TX_THRESH_DFLT);
1769 pxa2xx_spi_write(drv_data, SSCR1, tmp);
1770 tmp = SSCR0_Motorola | SSCR0_DataSize(8);
1771 if (!spi_controller_is_slave(controller))
1772 tmp |= SSCR0_SCR(2);
1773 pxa2xx_spi_write(drv_data, SSCR0, tmp);
1777 if (!pxa25x_ssp_comp(drv_data))
1778 pxa2xx_spi_write(drv_data, SSTO, 0);
1780 if (!is_quark_x1000_ssp(drv_data))
1781 pxa2xx_spi_write(drv_data, SSPSP, 0);
1783 if (is_lpss_ssp(drv_data)) {
1784 lpss_ssp_setup(drv_data);
1785 config = lpss_get_config(drv_data);
1786 if (config->reg_capabilities >= 0) {
1787 tmp = __lpss_ssp_read_priv(drv_data,
1788 config->reg_capabilities);
1789 tmp &= LPSS_CAPS_CS_EN_MASK;
1790 tmp >>= LPSS_CAPS_CS_EN_SHIFT;
1791 platform_info->num_chipselect = ffz(tmp);
1792 } else if (config->cs_num) {
1793 platform_info->num_chipselect = config->cs_num;
1796 controller->num_chipselect = platform_info->num_chipselect;
1798 count = gpiod_count(&pdev->dev, "cs");
1802 controller->num_chipselect = max_t(int, count,
1803 controller->num_chipselect);
1805 drv_data->cs_gpiods = devm_kcalloc(&pdev->dev,
1806 controller->num_chipselect, sizeof(struct gpio_desc *),
1808 if (!drv_data->cs_gpiods) {
1810 goto out_error_clock_enabled;
1813 for (i = 0; i < controller->num_chipselect; i++) {
1814 struct gpio_desc *gpiod;
1816 gpiod = devm_gpiod_get_index(dev, "cs", i, GPIOD_ASIS);
1817 if (IS_ERR(gpiod)) {
1818 /* Means use native chip select */
1819 if (PTR_ERR(gpiod) == -ENOENT)
1822 status = PTR_ERR(gpiod);
1823 goto out_error_clock_enabled;
1825 drv_data->cs_gpiods[i] = gpiod;
1830 if (platform_info->is_slave) {
1831 drv_data->gpiod_ready = devm_gpiod_get_optional(dev,
1832 "ready", GPIOD_OUT_LOW);
1833 if (IS_ERR(drv_data->gpiod_ready)) {
1834 status = PTR_ERR(drv_data->gpiod_ready);
1835 goto out_error_clock_enabled;
1839 pm_runtime_set_autosuspend_delay(&pdev->dev, 50);
1840 pm_runtime_use_autosuspend(&pdev->dev);
1841 pm_runtime_set_active(&pdev->dev);
1842 pm_runtime_enable(&pdev->dev);
1844 /* Register with the SPI framework */
1845 platform_set_drvdata(pdev, drv_data);
1846 status = devm_spi_register_controller(&pdev->dev, controller);
1848 dev_err(&pdev->dev, "problem registering spi controller\n");
1849 goto out_error_pm_runtime_enabled;
1854 out_error_pm_runtime_enabled:
1855 pm_runtime_put_noidle(&pdev->dev);
1856 pm_runtime_disable(&pdev->dev);
1858 out_error_clock_enabled:
1859 clk_disable_unprepare(ssp->clk);
1861 out_error_dma_irq_alloc:
1862 pxa2xx_spi_dma_release(drv_data);
1863 free_irq(ssp->irq, drv_data);
1865 out_error_controller_alloc:
1866 spi_controller_put(controller);
1871 static int pxa2xx_spi_remove(struct platform_device *pdev)
1873 struct driver_data *drv_data = platform_get_drvdata(pdev);
1874 struct ssp_device *ssp;
1878 ssp = drv_data->ssp;
1880 pm_runtime_get_sync(&pdev->dev);
1882 /* Disable the SSP at the peripheral and SOC level */
1883 pxa2xx_spi_write(drv_data, SSCR0, 0);
1884 clk_disable_unprepare(ssp->clk);
1887 if (drv_data->controller_info->enable_dma)
1888 pxa2xx_spi_dma_release(drv_data);
1890 pm_runtime_put_noidle(&pdev->dev);
1891 pm_runtime_disable(&pdev->dev);
1894 free_irq(ssp->irq, drv_data);
1902 #ifdef CONFIG_PM_SLEEP
1903 static int pxa2xx_spi_suspend(struct device *dev)
1905 struct driver_data *drv_data = dev_get_drvdata(dev);
1906 struct ssp_device *ssp = drv_data->ssp;
1909 status = spi_controller_suspend(drv_data->controller);
1912 pxa2xx_spi_write(drv_data, SSCR0, 0);
1914 if (!pm_runtime_suspended(dev))
1915 clk_disable_unprepare(ssp->clk);
1920 static int pxa2xx_spi_resume(struct device *dev)
1922 struct driver_data *drv_data = dev_get_drvdata(dev);
1923 struct ssp_device *ssp = drv_data->ssp;
1926 /* Enable the SSP clock */
1927 if (!pm_runtime_suspended(dev)) {
1928 status = clk_prepare_enable(ssp->clk);
1933 /* Start the queue running */
1934 return spi_controller_resume(drv_data->controller);
1939 static int pxa2xx_spi_runtime_suspend(struct device *dev)
1941 struct driver_data *drv_data = dev_get_drvdata(dev);
1943 clk_disable_unprepare(drv_data->ssp->clk);
1947 static int pxa2xx_spi_runtime_resume(struct device *dev)
1949 struct driver_data *drv_data = dev_get_drvdata(dev);
1952 status = clk_prepare_enable(drv_data->ssp->clk);
1957 static const struct dev_pm_ops pxa2xx_spi_pm_ops = {
1958 SET_SYSTEM_SLEEP_PM_OPS(pxa2xx_spi_suspend, pxa2xx_spi_resume)
1959 SET_RUNTIME_PM_OPS(pxa2xx_spi_runtime_suspend,
1960 pxa2xx_spi_runtime_resume, NULL)
1963 static struct platform_driver driver = {
1965 .name = "pxa2xx-spi",
1966 .pm = &pxa2xx_spi_pm_ops,
1967 .acpi_match_table = ACPI_PTR(pxa2xx_spi_acpi_match),
1968 .of_match_table = of_match_ptr(pxa2xx_spi_of_match),
1970 .probe = pxa2xx_spi_probe,
1971 .remove = pxa2xx_spi_remove,
1974 static int __init pxa2xx_spi_init(void)
1976 return platform_driver_register(&driver);
1978 subsys_initcall(pxa2xx_spi_init);
1980 static void __exit pxa2xx_spi_exit(void)
1982 platform_driver_unregister(&driver);
1984 module_exit(pxa2xx_spi_exit);
1986 MODULE_SOFTDEP("pre: dw_dmac");