Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Marvell Orion SPI controller driver
4 *
5 * Author: Shadi Ammouri <shadi@marvell.com>
6 * Copyright (C) 2007-2008 Marvell Ltd.
7 */
8
9#include <linux/interrupt.h>
10#include <linux/delay.h>
11#include <linux/platform_device.h>
12#include <linux/err.h>
13#include <linux/io.h>
14#include <linux/spi/spi.h>
15#include <linux/module.h>
16#include <linux/pm_runtime.h>
17#include <linux/of.h>
18#include <linux/of_address.h>
19#include <linux/of_device.h>
20#include <linux/clk.h>
21#include <linux/sizes.h>
22#include <asm/unaligned.h>
23
24#define DRIVER_NAME "orion_spi"
25
26/* Runtime PM autosuspend timeout: PM is fairly light on this driver */
27#define SPI_AUTOSUSPEND_TIMEOUT 200
28
29/* Some SoCs using this driver support up to 8 chip selects.
30 * It is up to the implementer to only use the chip selects
31 * that are available.
32 */
33#define ORION_NUM_CHIPSELECTS 8
34
35#define ORION_SPI_WAIT_RDY_MAX_LOOP 2000 /* in usec */
36
37#define ORION_SPI_IF_CTRL_REG 0x00
38#define ORION_SPI_IF_CONFIG_REG 0x04
39#define ORION_SPI_IF_RXLSBF BIT(14)
40#define ORION_SPI_IF_TXLSBF BIT(13)
41#define ORION_SPI_DATA_OUT_REG 0x08
42#define ORION_SPI_DATA_IN_REG 0x0c
43#define ORION_SPI_INT_CAUSE_REG 0x10
44#define ORION_SPI_TIMING_PARAMS_REG 0x18
45
46/* Register for the "Direct Mode" */
47#define SPI_DIRECT_WRITE_CONFIG_REG 0x20
48
49#define ORION_SPI_TMISO_SAMPLE_MASK (0x3 << 6)
50#define ORION_SPI_TMISO_SAMPLE_1 (1 << 6)
51#define ORION_SPI_TMISO_SAMPLE_2 (2 << 6)
52
53#define ORION_SPI_MODE_CPOL (1 << 11)
54#define ORION_SPI_MODE_CPHA (1 << 12)
55#define ORION_SPI_IF_8_16_BIT_MODE (1 << 5)
56#define ORION_SPI_CLK_PRESCALE_MASK 0x1F
57#define ARMADA_SPI_CLK_PRESCALE_MASK 0xDF
58#define ORION_SPI_MODE_MASK (ORION_SPI_MODE_CPOL | \
59 ORION_SPI_MODE_CPHA)
60#define ORION_SPI_CS_MASK 0x1C
61#define ORION_SPI_CS_SHIFT 2
62#define ORION_SPI_CS(cs) ((cs << ORION_SPI_CS_SHIFT) & \
63 ORION_SPI_CS_MASK)
64
65enum orion_spi_type {
66 ORION_SPI,
67 ARMADA_SPI,
68};
69
70struct orion_spi_dev {
71 enum orion_spi_type typ;
72 /*
73 * min_divisor and max_hz should be exclusive, the only we can
74 * have both is for managing the armada-370-spi case with old
75 * device tree
76 */
77 unsigned long max_hz;
78 unsigned int min_divisor;
79 unsigned int max_divisor;
80 u32 prescale_mask;
81 bool is_errata_50mhz_ac;
82};
83
84struct orion_direct_acc {
85 void __iomem *vaddr;
86 u32 size;
87};
88
89struct orion_child_options {
90 struct orion_direct_acc direct_access;
91};
92
93struct orion_spi {
94 struct spi_master *master;
95 void __iomem *base;
96 struct clk *clk;
97 struct clk *axi_clk;
98 const struct orion_spi_dev *devdata;
99 struct device *dev;
100
101 struct orion_child_options child[ORION_NUM_CHIPSELECTS];
102};
103
104#ifdef CONFIG_PM
105static int orion_spi_runtime_suspend(struct device *dev);
106static int orion_spi_runtime_resume(struct device *dev);
107#endif
108
109static inline void __iomem *spi_reg(struct orion_spi *orion_spi, u32 reg)
110{
111 return orion_spi->base + reg;
112}
113
114static inline void
115orion_spi_setbits(struct orion_spi *orion_spi, u32 reg, u32 mask)
116{
117 void __iomem *reg_addr = spi_reg(orion_spi, reg);
118 u32 val;
119
120 val = readl(reg_addr);
121 val |= mask;
122 writel(val, reg_addr);
123}
124
125static inline void
126orion_spi_clrbits(struct orion_spi *orion_spi, u32 reg, u32 mask)
127{
128 void __iomem *reg_addr = spi_reg(orion_spi, reg);
129 u32 val;
130
131 val = readl(reg_addr);
132 val &= ~mask;
133 writel(val, reg_addr);
134}
135
136static int orion_spi_baudrate_set(struct spi_device *spi, unsigned int speed)
137{
138 u32 tclk_hz;
139 u32 rate;
140 u32 prescale;
141 u32 reg;
142 struct orion_spi *orion_spi;
143 const struct orion_spi_dev *devdata;
144
145 orion_spi = spi_master_get_devdata(spi->master);
146 devdata = orion_spi->devdata;
147
148 tclk_hz = clk_get_rate(orion_spi->clk);
149
150 if (devdata->typ == ARMADA_SPI) {
151 /*
152 * Given the core_clk (tclk_hz) and the target rate (speed) we
153 * determine the best values for SPR (in [0 .. 15]) and SPPR (in
154 * [0..7]) such that
155 *
156 * core_clk / (SPR * 2 ** SPPR)
157 *
158 * is as big as possible but not bigger than speed.
159 */
160
161 /* best integer divider: */
162 unsigned divider = DIV_ROUND_UP(tclk_hz, speed);
163 unsigned spr, sppr;
164
165 if (divider < 16) {
166 /* This is the easy case, divider is less than 16 */
167 spr = divider;
168 sppr = 0;
169
170 } else {
171 unsigned two_pow_sppr;
172 /*
173 * Find the highest bit set in divider. This and the
174 * three next bits define SPR (apart from rounding).
175 * SPPR is then the number of zero bits that must be
176 * appended:
177 */
178 sppr = fls(divider) - 4;
179
180 /*
181 * As SPR only has 4 bits, we have to round divider up
182 * to the next multiple of 2 ** sppr.
183 */
184 two_pow_sppr = 1 << sppr;
185 divider = (divider + two_pow_sppr - 1) & -two_pow_sppr;
186
187 /*
188 * recalculate sppr as rounding up divider might have
189 * increased it enough to change the position of the
190 * highest set bit. In this case the bit that now
191 * doesn't make it into SPR is 0, so there is no need to
192 * round again.
193 */
194 sppr = fls(divider) - 4;
195 spr = divider >> sppr;
196
197 /*
198 * Now do range checking. SPR is constructed to have a
199 * width of 4 bits, so this is fine for sure. So we
200 * still need to check for sppr to fit into 3 bits:
201 */
202 if (sppr > 7)
203 return -EINVAL;
204 }
205
206 prescale = ((sppr & 0x6) << 5) | ((sppr & 0x1) << 4) | spr;
207 } else {
208 /*
209 * the supported rates are: 4,6,8...30
210 * round up as we look for equal or less speed
211 */
212 rate = DIV_ROUND_UP(tclk_hz, speed);
213 rate = roundup(rate, 2);
214
215 /* check if requested speed is too small */
216 if (rate > 30)
217 return -EINVAL;
218
219 if (rate < 4)
220 rate = 4;
221
222 /* Convert the rate to SPI clock divisor value. */
223 prescale = 0x10 + rate/2;
224 }
225
226 reg = readl(spi_reg(orion_spi, ORION_SPI_IF_CONFIG_REG));
227 reg = ((reg & ~devdata->prescale_mask) | prescale);
228 writel(reg, spi_reg(orion_spi, ORION_SPI_IF_CONFIG_REG));
229
230 return 0;
231}
232
233static void
234orion_spi_mode_set(struct spi_device *spi)
235{
236 u32 reg;
237 struct orion_spi *orion_spi;
238
239 orion_spi = spi_master_get_devdata(spi->master);
240
241 reg = readl(spi_reg(orion_spi, ORION_SPI_IF_CONFIG_REG));
242 reg &= ~ORION_SPI_MODE_MASK;
243 if (spi->mode & SPI_CPOL)
244 reg |= ORION_SPI_MODE_CPOL;
245 if (spi->mode & SPI_CPHA)
246 reg |= ORION_SPI_MODE_CPHA;
247 if (spi->mode & SPI_LSB_FIRST)
248 reg |= ORION_SPI_IF_RXLSBF | ORION_SPI_IF_TXLSBF;
249 else
250 reg &= ~(ORION_SPI_IF_RXLSBF | ORION_SPI_IF_TXLSBF);
251
252 writel(reg, spi_reg(orion_spi, ORION_SPI_IF_CONFIG_REG));
253}
254
255static void
256orion_spi_50mhz_ac_timing_erratum(struct spi_device *spi, unsigned int speed)
257{
258 u32 reg;
259 struct orion_spi *orion_spi;
260
261 orion_spi = spi_master_get_devdata(spi->master);
262
263 /*
264 * Erratum description: (Erratum NO. FE-9144572) The device
265 * SPI interface supports frequencies of up to 50 MHz.
266 * However, due to this erratum, when the device core clock is
267 * 250 MHz and the SPI interfaces is configured for 50MHz SPI
268 * clock and CPOL=CPHA=1 there might occur data corruption on
269 * reads from the SPI device.
270 * Erratum Workaround:
271 * Work in one of the following configurations:
272 * 1. Set CPOL=CPHA=0 in "SPI Interface Configuration
273 * Register".
274 * 2. Set TMISO_SAMPLE value to 0x2 in "SPI Timing Parameters 1
275 * Register" before setting the interface.
276 */
277 reg = readl(spi_reg(orion_spi, ORION_SPI_TIMING_PARAMS_REG));
278 reg &= ~ORION_SPI_TMISO_SAMPLE_MASK;
279
280 if (clk_get_rate(orion_spi->clk) == 250000000 &&
281 speed == 50000000 && spi->mode & SPI_CPOL &&
282 spi->mode & SPI_CPHA)
283 reg |= ORION_SPI_TMISO_SAMPLE_2;
284 else
285 reg |= ORION_SPI_TMISO_SAMPLE_1; /* This is the default value */
286
287 writel(reg, spi_reg(orion_spi, ORION_SPI_TIMING_PARAMS_REG));
288}
289
290/*
291 * called only when no transfer is active on the bus
292 */
293static int
294orion_spi_setup_transfer(struct spi_device *spi, struct spi_transfer *t)
295{
296 struct orion_spi *orion_spi;
297 unsigned int speed = spi->max_speed_hz;
298 unsigned int bits_per_word = spi->bits_per_word;
299 int rc;
300
301 orion_spi = spi_master_get_devdata(spi->master);
302
303 if ((t != NULL) && t->speed_hz)
304 speed = t->speed_hz;
305
306 if ((t != NULL) && t->bits_per_word)
307 bits_per_word = t->bits_per_word;
308
309 orion_spi_mode_set(spi);
310
311 if (orion_spi->devdata->is_errata_50mhz_ac)
312 orion_spi_50mhz_ac_timing_erratum(spi, speed);
313
314 rc = orion_spi_baudrate_set(spi, speed);
315 if (rc)
316 return rc;
317
318 if (bits_per_word == 16)
319 orion_spi_setbits(orion_spi, ORION_SPI_IF_CONFIG_REG,
320 ORION_SPI_IF_8_16_BIT_MODE);
321 else
322 orion_spi_clrbits(orion_spi, ORION_SPI_IF_CONFIG_REG,
323 ORION_SPI_IF_8_16_BIT_MODE);
324
325 return 0;
326}
327
328static void orion_spi_set_cs(struct spi_device *spi, bool enable)
329{
330 struct orion_spi *orion_spi;
331 void __iomem *ctrl_reg;
332 u32 val;
333
334 orion_spi = spi_master_get_devdata(spi->master);
335 ctrl_reg = spi_reg(orion_spi, ORION_SPI_IF_CTRL_REG);
336
337 val = readl(ctrl_reg);
338
339 /* Clear existing chip-select and assertion state */
340 val &= ~(ORION_SPI_CS_MASK | 0x1);
341
342 /*
343 * If this line is using a GPIO to control chip select, this internal
344 * .set_cs() function will still be called, so we clear any previous
345 * chip select. The CS we activate will not have any elecrical effect,
346 * as it is handled by a GPIO, but that doesn't matter. What we need
347 * is to deassert the old chip select and assert some other chip select.
348 */
349 val |= ORION_SPI_CS(spi->chip_select);
350
351 /*
352 * Chip select logic is inverted from spi_set_cs(). For lines using a
353 * GPIO to do chip select SPI_CS_HIGH is enforced and inversion happens
354 * in the GPIO library, but we don't care about that, because in those
355 * cases we are dealing with an unused native CS anyways so the polarity
356 * doesn't matter.
357 */
358 if (!enable)
359 val |= 0x1;
360
361 /*
362 * To avoid toggling unwanted chip selects update the register
363 * with a single write.
364 */
365 writel(val, ctrl_reg);
366}
367
368static inline int orion_spi_wait_till_ready(struct orion_spi *orion_spi)
369{
370 int i;
371
372 for (i = 0; i < ORION_SPI_WAIT_RDY_MAX_LOOP; i++) {
373 if (readl(spi_reg(orion_spi, ORION_SPI_INT_CAUSE_REG)))
374 return 1;
375
376 udelay(1);
377 }
378
379 return -1;
380}
381
382static inline int
383orion_spi_write_read_8bit(struct spi_device *spi,
384 const u8 **tx_buf, u8 **rx_buf)
385{
386 void __iomem *tx_reg, *rx_reg, *int_reg;
387 struct orion_spi *orion_spi;
388 bool cs_single_byte;
389
390 cs_single_byte = spi->mode & SPI_CS_WORD;
391
392 orion_spi = spi_master_get_devdata(spi->master);
393
394 if (cs_single_byte)
395 orion_spi_set_cs(spi, 0);
396
397 tx_reg = spi_reg(orion_spi, ORION_SPI_DATA_OUT_REG);
398 rx_reg = spi_reg(orion_spi, ORION_SPI_DATA_IN_REG);
399 int_reg = spi_reg(orion_spi, ORION_SPI_INT_CAUSE_REG);
400
401 /* clear the interrupt cause register */
402 writel(0x0, int_reg);
403
404 if (tx_buf && *tx_buf)
405 writel(*(*tx_buf)++, tx_reg);
406 else
407 writel(0, tx_reg);
408
409 if (orion_spi_wait_till_ready(orion_spi) < 0) {
410 if (cs_single_byte) {
411 orion_spi_set_cs(spi, 1);
412 /* Satisfy some SLIC devices requirements */
413 udelay(4);
414 }
415 dev_err(&spi->dev, "TXS timed out\n");
416 return -1;
417 }
418
419 if (rx_buf && *rx_buf)
420 *(*rx_buf)++ = readl(rx_reg);
421
422 if (cs_single_byte) {
423 orion_spi_set_cs(spi, 1);
424 /* Satisfy some SLIC devices requirements */
425 udelay(4);
426 }
427
428 return 1;
429}
430
431static inline int
432orion_spi_write_read_16bit(struct spi_device *spi,
433 const u16 **tx_buf, u16 **rx_buf)
434{
435 void __iomem *tx_reg, *rx_reg, *int_reg;
436 struct orion_spi *orion_spi;
437
438 if (spi->mode & SPI_CS_WORD) {
439 dev_err(&spi->dev, "SPI_CS_WORD is only supported for 8 bit words\n");
440 return -1;
441 }
442
443 orion_spi = spi_master_get_devdata(spi->master);
444 tx_reg = spi_reg(orion_spi, ORION_SPI_DATA_OUT_REG);
445 rx_reg = spi_reg(orion_spi, ORION_SPI_DATA_IN_REG);
446 int_reg = spi_reg(orion_spi, ORION_SPI_INT_CAUSE_REG);
447
448 /* clear the interrupt cause register */
449 writel(0x0, int_reg);
450
451 if (tx_buf && *tx_buf)
452 writel(__cpu_to_le16(get_unaligned((*tx_buf)++)), tx_reg);
453 else
454 writel(0, tx_reg);
455
456 if (orion_spi_wait_till_ready(orion_spi) < 0) {
457 dev_err(&spi->dev, "TXS timed out\n");
458 return -1;
459 }
460
461 if (rx_buf && *rx_buf)
462 put_unaligned(__le16_to_cpu(readl(rx_reg)), (*rx_buf)++);
463
464 return 1;
465}
466
467static unsigned int
468orion_spi_write_read(struct spi_device *spi, struct spi_transfer *xfer)
469{
470 unsigned int count;
471 int word_len;
472 struct orion_spi *orion_spi;
473 int cs = spi->chip_select;
474 void __iomem *vaddr;
475
476 word_len = spi->bits_per_word;
477 count = xfer->len;
478
479 orion_spi = spi_master_get_devdata(spi->master);
480
481 /*
482 * Use SPI direct write mode if base address is available
483 * and SPI_CS_WORD flag is not set.
484 * Otherwise fall back to PIO mode for this transfer.
485 */
486 vaddr = orion_spi->child[cs].direct_access.vaddr;
487
488 if (vaddr && xfer->tx_buf && word_len == 8 && (spi->mode & SPI_CS_WORD) == 0) {
489 unsigned int cnt = count / 4;
490 unsigned int rem = count % 4;
491
492 /*
493 * Send the TX-data to the SPI device via the direct
494 * mapped address window
495 */
496 iowrite32_rep(vaddr, xfer->tx_buf, cnt);
497 if (rem) {
498 u32 *buf = (u32 *)xfer->tx_buf;
499
500 iowrite8_rep(vaddr, &buf[cnt], rem);
501 }
502
503 return count;
504 }
505
506 if (word_len == 8) {
507 const u8 *tx = xfer->tx_buf;
508 u8 *rx = xfer->rx_buf;
509
510 do {
511 if (orion_spi_write_read_8bit(spi, &tx, &rx) < 0)
512 goto out;
513 count--;
514 spi_delay_exec(&xfer->word_delay, xfer);
515 } while (count);
516 } else if (word_len == 16) {
517 const u16 *tx = xfer->tx_buf;
518 u16 *rx = xfer->rx_buf;
519
520 do {
521 if (orion_spi_write_read_16bit(spi, &tx, &rx) < 0)
522 goto out;
523 count -= 2;
524 spi_delay_exec(&xfer->word_delay, xfer);
525 } while (count);
526 }
527
528out:
529 return xfer->len - count;
530}
531
532static int orion_spi_transfer_one(struct spi_master *master,
533 struct spi_device *spi,
534 struct spi_transfer *t)
535{
536 int status = 0;
537
538 status = orion_spi_setup_transfer(spi, t);
539 if (status < 0)
540 return status;
541
542 if (t->len)
543 orion_spi_write_read(spi, t);
544
545 return status;
546}
547
548static int orion_spi_setup(struct spi_device *spi)
549{
550 int ret;
551#ifdef CONFIG_PM
552 struct orion_spi *orion_spi = spi_master_get_devdata(spi->master);
553 struct device *dev = orion_spi->dev;
554
555 orion_spi_runtime_resume(dev);
556#endif
557
558 ret = orion_spi_setup_transfer(spi, NULL);
559
560#ifdef CONFIG_PM
561 orion_spi_runtime_suspend(dev);
562#endif
563
564 return ret;
565}
566
567static int orion_spi_reset(struct orion_spi *orion_spi)
568{
569 /* Verify that the CS is deasserted */
570 orion_spi_clrbits(orion_spi, ORION_SPI_IF_CTRL_REG, 0x1);
571
572 /* Don't deassert CS between the direct mapped SPI transfers */
573 writel(0, spi_reg(orion_spi, SPI_DIRECT_WRITE_CONFIG_REG));
574
575 return 0;
576}
577
578static const struct orion_spi_dev orion_spi_dev_data = {
579 .typ = ORION_SPI,
580 .min_divisor = 4,
581 .max_divisor = 30,
582 .prescale_mask = ORION_SPI_CLK_PRESCALE_MASK,
583};
584
585static const struct orion_spi_dev armada_370_spi_dev_data = {
586 .typ = ARMADA_SPI,
587 .min_divisor = 4,
588 .max_divisor = 1920,
589 .max_hz = 50000000,
590 .prescale_mask = ARMADA_SPI_CLK_PRESCALE_MASK,
591};
592
593static const struct orion_spi_dev armada_xp_spi_dev_data = {
594 .typ = ARMADA_SPI,
595 .max_hz = 50000000,
596 .max_divisor = 1920,
597 .prescale_mask = ARMADA_SPI_CLK_PRESCALE_MASK,
598};
599
600static const struct orion_spi_dev armada_375_spi_dev_data = {
601 .typ = ARMADA_SPI,
602 .min_divisor = 15,
603 .max_divisor = 1920,
604 .prescale_mask = ARMADA_SPI_CLK_PRESCALE_MASK,
605};
606
607static const struct orion_spi_dev armada_380_spi_dev_data = {
608 .typ = ARMADA_SPI,
609 .max_hz = 50000000,
610 .max_divisor = 1920,
611 .prescale_mask = ARMADA_SPI_CLK_PRESCALE_MASK,
612 .is_errata_50mhz_ac = true,
613};
614
615static const struct of_device_id orion_spi_of_match_table[] = {
616 {
617 .compatible = "marvell,orion-spi",
618 .data = &orion_spi_dev_data,
619 },
620 {
621 .compatible = "marvell,armada-370-spi",
622 .data = &armada_370_spi_dev_data,
623 },
624 {
625 .compatible = "marvell,armada-375-spi",
626 .data = &armada_375_spi_dev_data,
627 },
628 {
629 .compatible = "marvell,armada-380-spi",
630 .data = &armada_380_spi_dev_data,
631 },
632 {
633 .compatible = "marvell,armada-390-spi",
634 .data = &armada_xp_spi_dev_data,
635 },
636 {
637 .compatible = "marvell,armada-xp-spi",
638 .data = &armada_xp_spi_dev_data,
639 },
640
641 {}
642};
643MODULE_DEVICE_TABLE(of, orion_spi_of_match_table);
644
645static int orion_spi_probe(struct platform_device *pdev)
646{
647 const struct orion_spi_dev *devdata;
648 struct spi_master *master;
649 struct orion_spi *spi;
650 struct resource *r;
651 unsigned long tclk_hz;
652 int status = 0;
653 struct device_node *np;
654
655 master = spi_alloc_master(&pdev->dev, sizeof(*spi));
656 if (master == NULL) {
657 dev_dbg(&pdev->dev, "master allocation failed\n");
658 return -ENOMEM;
659 }
660
661 if (pdev->id != -1)
662 master->bus_num = pdev->id;
663 if (pdev->dev.of_node) {
664 u32 cell_index;
665
666 if (!of_property_read_u32(pdev->dev.of_node, "cell-index",
667 &cell_index))
668 master->bus_num = cell_index;
669 }
670
671 /* we support all 4 SPI modes and LSB first option */
672 master->mode_bits = SPI_CPHA | SPI_CPOL | SPI_LSB_FIRST | SPI_CS_WORD;
673 master->set_cs = orion_spi_set_cs;
674 master->transfer_one = orion_spi_transfer_one;
675 master->num_chipselect = ORION_NUM_CHIPSELECTS;
676 master->setup = orion_spi_setup;
677 master->bits_per_word_mask = SPI_BPW_MASK(8) | SPI_BPW_MASK(16);
678 master->auto_runtime_pm = true;
679 master->use_gpio_descriptors = true;
680 master->flags = SPI_MASTER_GPIO_SS;
681
682 platform_set_drvdata(pdev, master);
683
684 spi = spi_master_get_devdata(master);
685 spi->master = master;
686 spi->dev = &pdev->dev;
687
688 devdata = device_get_match_data(&pdev->dev);
689 devdata = devdata ? devdata : &orion_spi_dev_data;
690 spi->devdata = devdata;
691
692 spi->clk = devm_clk_get(&pdev->dev, NULL);
693 if (IS_ERR(spi->clk)) {
694 status = PTR_ERR(spi->clk);
695 goto out;
696 }
697
698 status = clk_prepare_enable(spi->clk);
699 if (status)
700 goto out;
701
702 /* The following clock is only used by some SoCs */
703 spi->axi_clk = devm_clk_get(&pdev->dev, "axi");
704 if (PTR_ERR(spi->axi_clk) == -EPROBE_DEFER) {
705 status = -EPROBE_DEFER;
706 goto out_rel_clk;
707 }
708 if (!IS_ERR(spi->axi_clk))
709 clk_prepare_enable(spi->axi_clk);
710
711 tclk_hz = clk_get_rate(spi->clk);
712
713 /*
714 * With old device tree, armada-370-spi could be used with
715 * Armada XP, however for this SoC the maximum frequency is
716 * 50MHz instead of tclk/4. On Armada 370, tclk cannot be
717 * higher than 200MHz. So, in order to be able to handle both
718 * SoCs, we can take the minimum of 50MHz and tclk/4.
719 */
720 if (of_device_is_compatible(pdev->dev.of_node,
721 "marvell,armada-370-spi"))
722 master->max_speed_hz = min(devdata->max_hz,
723 DIV_ROUND_UP(tclk_hz, devdata->min_divisor));
724 else if (devdata->min_divisor)
725 master->max_speed_hz =
726 DIV_ROUND_UP(tclk_hz, devdata->min_divisor);
727 else
728 master->max_speed_hz = devdata->max_hz;
729 master->min_speed_hz = DIV_ROUND_UP(tclk_hz, devdata->max_divisor);
730
731 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
732 spi->base = devm_ioremap_resource(&pdev->dev, r);
733 if (IS_ERR(spi->base)) {
734 status = PTR_ERR(spi->base);
735 goto out_rel_axi_clk;
736 }
737
738 for_each_available_child_of_node(pdev->dev.of_node, np) {
739 struct orion_direct_acc *dir_acc;
740 u32 cs;
741
742 /* Get chip-select number from the "reg" property */
743 status = of_property_read_u32(np, "reg", &cs);
744 if (status) {
745 dev_err(&pdev->dev,
746 "%pOF has no valid 'reg' property (%d)\n",
747 np, status);
748 continue;
749 }
750
751 /*
752 * Check if an address is configured for this SPI device. If
753 * not, the MBus mapping via the 'ranges' property in the 'soc'
754 * node is not configured and this device should not use the
755 * direct mode. In this case, just continue with the next
756 * device.
757 */
758 status = of_address_to_resource(pdev->dev.of_node, cs + 1, r);
759 if (status)
760 continue;
761
762 /*
763 * Only map one page for direct access. This is enough for the
764 * simple TX transfer which only writes to the first word.
765 * This needs to get extended for the direct SPI NOR / SPI NAND
766 * support, once this gets implemented.
767 */
768 dir_acc = &spi->child[cs].direct_access;
769 dir_acc->vaddr = devm_ioremap(&pdev->dev, r->start, PAGE_SIZE);
770 if (!dir_acc->vaddr) {
771 status = -ENOMEM;
772 of_node_put(np);
773 goto out_rel_axi_clk;
774 }
775 dir_acc->size = PAGE_SIZE;
776
777 dev_info(&pdev->dev, "CS%d configured for direct access\n", cs);
778 }
779
780 pm_runtime_set_active(&pdev->dev);
781 pm_runtime_use_autosuspend(&pdev->dev);
782 pm_runtime_set_autosuspend_delay(&pdev->dev, SPI_AUTOSUSPEND_TIMEOUT);
783 pm_runtime_enable(&pdev->dev);
784
785 status = orion_spi_reset(spi);
786 if (status < 0)
787 goto out_rel_pm;
788
789 master->dev.of_node = pdev->dev.of_node;
790 status = spi_register_master(master);
791 if (status < 0)
792 goto out_rel_pm;
793
794 return status;
795
796out_rel_pm:
797 pm_runtime_disable(&pdev->dev);
798out_rel_axi_clk:
799 clk_disable_unprepare(spi->axi_clk);
800out_rel_clk:
801 clk_disable_unprepare(spi->clk);
802out:
803 spi_master_put(master);
804 return status;
805}
806
807
808static int orion_spi_remove(struct platform_device *pdev)
809{
810 struct spi_master *master = platform_get_drvdata(pdev);
811 struct orion_spi *spi = spi_master_get_devdata(master);
812
813 pm_runtime_get_sync(&pdev->dev);
814 clk_disable_unprepare(spi->axi_clk);
815 clk_disable_unprepare(spi->clk);
816
817 spi_unregister_master(master);
818 pm_runtime_disable(&pdev->dev);
819
820 return 0;
821}
822
823MODULE_ALIAS("platform:" DRIVER_NAME);
824
825#ifdef CONFIG_PM
826static int orion_spi_runtime_suspend(struct device *dev)
827{
828 struct spi_master *master = dev_get_drvdata(dev);
829 struct orion_spi *spi = spi_master_get_devdata(master);
830
831 clk_disable_unprepare(spi->axi_clk);
832 clk_disable_unprepare(spi->clk);
833 return 0;
834}
835
836static int orion_spi_runtime_resume(struct device *dev)
837{
838 struct spi_master *master = dev_get_drvdata(dev);
839 struct orion_spi *spi = spi_master_get_devdata(master);
840
841 if (!IS_ERR(spi->axi_clk))
842 clk_prepare_enable(spi->axi_clk);
843 return clk_prepare_enable(spi->clk);
844}
845#endif
846
847static const struct dev_pm_ops orion_spi_pm_ops = {
848 SET_RUNTIME_PM_OPS(orion_spi_runtime_suspend,
849 orion_spi_runtime_resume,
850 NULL)
851};
852
853static struct platform_driver orion_spi_driver = {
854 .driver = {
855 .name = DRIVER_NAME,
856 .pm = &orion_spi_pm_ops,
857 .of_match_table = of_match_ptr(orion_spi_of_match_table),
858 },
859 .probe = orion_spi_probe,
860 .remove = orion_spi_remove,
861};
862
863module_platform_driver(orion_spi_driver);
864
865MODULE_DESCRIPTION("Orion SPI driver");
866MODULE_AUTHOR("Shadi Ammouri <shadi@marvell.com>");
867MODULE_LICENSE("GPL");
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Marvell Orion SPI controller driver
4 *
5 * Author: Shadi Ammouri <shadi@marvell.com>
6 * Copyright (C) 2007-2008 Marvell Ltd.
7 */
8
9#include <linux/interrupt.h>
10#include <linux/delay.h>
11#include <linux/platform_device.h>
12#include <linux/err.h>
13#include <linux/io.h>
14#include <linux/spi/spi.h>
15#include <linux/module.h>
16#include <linux/pm_runtime.h>
17#include <linux/of.h>
18#include <linux/of_address.h>
19#include <linux/clk.h>
20#include <linux/sizes.h>
21#include <linux/unaligned.h>
22
23#define DRIVER_NAME "orion_spi"
24
25/* Runtime PM autosuspend timeout: PM is fairly light on this driver */
26#define SPI_AUTOSUSPEND_TIMEOUT 200
27
28/* Some SoCs using this driver support up to 8 chip selects.
29 * It is up to the implementer to only use the chip selects
30 * that are available.
31 */
32#define ORION_NUM_CHIPSELECTS 8
33
34#define ORION_SPI_WAIT_RDY_MAX_LOOP 2000 /* in usec */
35
36#define ORION_SPI_IF_CTRL_REG 0x00
37#define ORION_SPI_IF_CONFIG_REG 0x04
38#define ORION_SPI_IF_RXLSBF BIT(14)
39#define ORION_SPI_IF_TXLSBF BIT(13)
40#define ORION_SPI_DATA_OUT_REG 0x08
41#define ORION_SPI_DATA_IN_REG 0x0c
42#define ORION_SPI_INT_CAUSE_REG 0x10
43#define ORION_SPI_TIMING_PARAMS_REG 0x18
44
45/* Register for the "Direct Mode" */
46#define SPI_DIRECT_WRITE_CONFIG_REG 0x20
47
48#define ORION_SPI_TMISO_SAMPLE_MASK (0x3 << 6)
49#define ORION_SPI_TMISO_SAMPLE_1 (1 << 6)
50#define ORION_SPI_TMISO_SAMPLE_2 (2 << 6)
51
52#define ORION_SPI_MODE_CPOL (1 << 11)
53#define ORION_SPI_MODE_CPHA (1 << 12)
54#define ORION_SPI_IF_8_16_BIT_MODE (1 << 5)
55#define ORION_SPI_CLK_PRESCALE_MASK 0x1F
56#define ARMADA_SPI_CLK_PRESCALE_MASK 0xDF
57#define ORION_SPI_MODE_MASK (ORION_SPI_MODE_CPOL | \
58 ORION_SPI_MODE_CPHA)
59#define ORION_SPI_CS_MASK 0x1C
60#define ORION_SPI_CS_SHIFT 2
61#define ORION_SPI_CS(cs) ((cs << ORION_SPI_CS_SHIFT) & \
62 ORION_SPI_CS_MASK)
63
64enum orion_spi_type {
65 ORION_SPI,
66 ARMADA_SPI,
67};
68
69struct orion_spi_dev {
70 enum orion_spi_type typ;
71 /*
72 * min_divisor and max_hz should be exclusive, the only we can
73 * have both is for managing the armada-370-spi case with old
74 * device tree
75 */
76 unsigned long max_hz;
77 unsigned int min_divisor;
78 unsigned int max_divisor;
79 u32 prescale_mask;
80 bool is_errata_50mhz_ac;
81};
82
83struct orion_direct_acc {
84 void __iomem *vaddr;
85 u32 size;
86};
87
88struct orion_child_options {
89 struct orion_direct_acc direct_access;
90};
91
92struct orion_spi {
93 struct spi_controller *host;
94 void __iomem *base;
95 struct clk *clk;
96 struct clk *axi_clk;
97 const struct orion_spi_dev *devdata;
98 struct device *dev;
99
100 struct orion_child_options child[ORION_NUM_CHIPSELECTS];
101};
102
103#ifdef CONFIG_PM
104static int orion_spi_runtime_suspend(struct device *dev);
105static int orion_spi_runtime_resume(struct device *dev);
106#endif
107
108static inline void __iomem *spi_reg(struct orion_spi *orion_spi, u32 reg)
109{
110 return orion_spi->base + reg;
111}
112
113static inline void
114orion_spi_setbits(struct orion_spi *orion_spi, u32 reg, u32 mask)
115{
116 void __iomem *reg_addr = spi_reg(orion_spi, reg);
117 u32 val;
118
119 val = readl(reg_addr);
120 val |= mask;
121 writel(val, reg_addr);
122}
123
124static inline void
125orion_spi_clrbits(struct orion_spi *orion_spi, u32 reg, u32 mask)
126{
127 void __iomem *reg_addr = spi_reg(orion_spi, reg);
128 u32 val;
129
130 val = readl(reg_addr);
131 val &= ~mask;
132 writel(val, reg_addr);
133}
134
135static int orion_spi_baudrate_set(struct spi_device *spi, unsigned int speed)
136{
137 u32 tclk_hz;
138 u32 rate;
139 u32 prescale;
140 u32 reg;
141 struct orion_spi *orion_spi;
142 const struct orion_spi_dev *devdata;
143
144 orion_spi = spi_controller_get_devdata(spi->controller);
145 devdata = orion_spi->devdata;
146
147 tclk_hz = clk_get_rate(orion_spi->clk);
148
149 if (devdata->typ == ARMADA_SPI) {
150 /*
151 * Given the core_clk (tclk_hz) and the target rate (speed) we
152 * determine the best values for SPR (in [0 .. 15]) and SPPR (in
153 * [0..7]) such that
154 *
155 * core_clk / (SPR * 2 ** SPPR)
156 *
157 * is as big as possible but not bigger than speed.
158 */
159
160 /* best integer divider: */
161 unsigned divider = DIV_ROUND_UP(tclk_hz, speed);
162 unsigned spr, sppr;
163
164 if (divider < 16) {
165 /* This is the easy case, divider is less than 16 */
166 spr = divider;
167 sppr = 0;
168
169 } else {
170 unsigned two_pow_sppr;
171 /*
172 * Find the highest bit set in divider. This and the
173 * three next bits define SPR (apart from rounding).
174 * SPPR is then the number of zero bits that must be
175 * appended:
176 */
177 sppr = fls(divider) - 4;
178
179 /*
180 * As SPR only has 4 bits, we have to round divider up
181 * to the next multiple of 2 ** sppr.
182 */
183 two_pow_sppr = 1 << sppr;
184 divider = (divider + two_pow_sppr - 1) & -two_pow_sppr;
185
186 /*
187 * recalculate sppr as rounding up divider might have
188 * increased it enough to change the position of the
189 * highest set bit. In this case the bit that now
190 * doesn't make it into SPR is 0, so there is no need to
191 * round again.
192 */
193 sppr = fls(divider) - 4;
194 spr = divider >> sppr;
195
196 /*
197 * Now do range checking. SPR is constructed to have a
198 * width of 4 bits, so this is fine for sure. So we
199 * still need to check for sppr to fit into 3 bits:
200 */
201 if (sppr > 7)
202 return -EINVAL;
203 }
204
205 prescale = ((sppr & 0x6) << 5) | ((sppr & 0x1) << 4) | spr;
206 } else {
207 /*
208 * the supported rates are: 4,6,8...30
209 * round up as we look for equal or less speed
210 */
211 rate = DIV_ROUND_UP(tclk_hz, speed);
212 rate = roundup(rate, 2);
213
214 /* check if requested speed is too small */
215 if (rate > 30)
216 return -EINVAL;
217
218 if (rate < 4)
219 rate = 4;
220
221 /* Convert the rate to SPI clock divisor value. */
222 prescale = 0x10 + rate/2;
223 }
224
225 reg = readl(spi_reg(orion_spi, ORION_SPI_IF_CONFIG_REG));
226 reg = ((reg & ~devdata->prescale_mask) | prescale);
227 writel(reg, spi_reg(orion_spi, ORION_SPI_IF_CONFIG_REG));
228
229 return 0;
230}
231
232static void
233orion_spi_mode_set(struct spi_device *spi)
234{
235 u32 reg;
236 struct orion_spi *orion_spi;
237
238 orion_spi = spi_controller_get_devdata(spi->controller);
239
240 reg = readl(spi_reg(orion_spi, ORION_SPI_IF_CONFIG_REG));
241 reg &= ~ORION_SPI_MODE_MASK;
242 if (spi->mode & SPI_CPOL)
243 reg |= ORION_SPI_MODE_CPOL;
244 if (spi->mode & SPI_CPHA)
245 reg |= ORION_SPI_MODE_CPHA;
246 if (spi->mode & SPI_LSB_FIRST)
247 reg |= ORION_SPI_IF_RXLSBF | ORION_SPI_IF_TXLSBF;
248 else
249 reg &= ~(ORION_SPI_IF_RXLSBF | ORION_SPI_IF_TXLSBF);
250
251 writel(reg, spi_reg(orion_spi, ORION_SPI_IF_CONFIG_REG));
252}
253
254static void
255orion_spi_50mhz_ac_timing_erratum(struct spi_device *spi, unsigned int speed)
256{
257 u32 reg;
258 struct orion_spi *orion_spi;
259
260 orion_spi = spi_controller_get_devdata(spi->controller);
261
262 /*
263 * Erratum description: (Erratum NO. FE-9144572) The device
264 * SPI interface supports frequencies of up to 50 MHz.
265 * However, due to this erratum, when the device core clock is
266 * 250 MHz and the SPI interfaces is configured for 50MHz SPI
267 * clock and CPOL=CPHA=1 there might occur data corruption on
268 * reads from the SPI device.
269 * Erratum Workaround:
270 * Work in one of the following configurations:
271 * 1. Set CPOL=CPHA=0 in "SPI Interface Configuration
272 * Register".
273 * 2. Set TMISO_SAMPLE value to 0x2 in "SPI Timing Parameters 1
274 * Register" before setting the interface.
275 */
276 reg = readl(spi_reg(orion_spi, ORION_SPI_TIMING_PARAMS_REG));
277 reg &= ~ORION_SPI_TMISO_SAMPLE_MASK;
278
279 if (clk_get_rate(orion_spi->clk) == 250000000 &&
280 speed == 50000000 && spi->mode & SPI_CPOL &&
281 spi->mode & SPI_CPHA)
282 reg |= ORION_SPI_TMISO_SAMPLE_2;
283 else
284 reg |= ORION_SPI_TMISO_SAMPLE_1; /* This is the default value */
285
286 writel(reg, spi_reg(orion_spi, ORION_SPI_TIMING_PARAMS_REG));
287}
288
289/*
290 * called only when no transfer is active on the bus
291 */
292static int
293orion_spi_setup_transfer(struct spi_device *spi, struct spi_transfer *t)
294{
295 struct orion_spi *orion_spi;
296 unsigned int speed = spi->max_speed_hz;
297 unsigned int bits_per_word = spi->bits_per_word;
298 int rc;
299
300 orion_spi = spi_controller_get_devdata(spi->controller);
301
302 if ((t != NULL) && t->speed_hz)
303 speed = t->speed_hz;
304
305 if ((t != NULL) && t->bits_per_word)
306 bits_per_word = t->bits_per_word;
307
308 orion_spi_mode_set(spi);
309
310 if (orion_spi->devdata->is_errata_50mhz_ac)
311 orion_spi_50mhz_ac_timing_erratum(spi, speed);
312
313 rc = orion_spi_baudrate_set(spi, speed);
314 if (rc)
315 return rc;
316
317 if (bits_per_word == 16)
318 orion_spi_setbits(orion_spi, ORION_SPI_IF_CONFIG_REG,
319 ORION_SPI_IF_8_16_BIT_MODE);
320 else
321 orion_spi_clrbits(orion_spi, ORION_SPI_IF_CONFIG_REG,
322 ORION_SPI_IF_8_16_BIT_MODE);
323
324 return 0;
325}
326
327static void orion_spi_set_cs(struct spi_device *spi, bool enable)
328{
329 struct orion_spi *orion_spi;
330 void __iomem *ctrl_reg;
331 u32 val;
332
333 orion_spi = spi_controller_get_devdata(spi->controller);
334 ctrl_reg = spi_reg(orion_spi, ORION_SPI_IF_CTRL_REG);
335
336 val = readl(ctrl_reg);
337
338 /* Clear existing chip-select and assertion state */
339 val &= ~(ORION_SPI_CS_MASK | 0x1);
340
341 /*
342 * If this line is using a GPIO to control chip select, this internal
343 * .set_cs() function will still be called, so we clear any previous
344 * chip select. The CS we activate will not have any elecrical effect,
345 * as it is handled by a GPIO, but that doesn't matter. What we need
346 * is to deassert the old chip select and assert some other chip select.
347 */
348 val |= ORION_SPI_CS(spi_get_chipselect(spi, 0));
349
350 /*
351 * Chip select logic is inverted from spi_set_cs(). For lines using a
352 * GPIO to do chip select SPI_CS_HIGH is enforced and inversion happens
353 * in the GPIO library, but we don't care about that, because in those
354 * cases we are dealing with an unused native CS anyways so the polarity
355 * doesn't matter.
356 */
357 if (!enable)
358 val |= 0x1;
359
360 /*
361 * To avoid toggling unwanted chip selects update the register
362 * with a single write.
363 */
364 writel(val, ctrl_reg);
365}
366
367static inline int orion_spi_wait_till_ready(struct orion_spi *orion_spi)
368{
369 int i;
370
371 for (i = 0; i < ORION_SPI_WAIT_RDY_MAX_LOOP; i++) {
372 if (readl(spi_reg(orion_spi, ORION_SPI_INT_CAUSE_REG)))
373 return 1;
374
375 udelay(1);
376 }
377
378 return -1;
379}
380
381static inline int
382orion_spi_write_read_8bit(struct spi_device *spi,
383 const u8 **tx_buf, u8 **rx_buf)
384{
385 void __iomem *tx_reg, *rx_reg, *int_reg;
386 struct orion_spi *orion_spi;
387 bool cs_single_byte;
388
389 cs_single_byte = spi->mode & SPI_CS_WORD;
390
391 orion_spi = spi_controller_get_devdata(spi->controller);
392
393 if (cs_single_byte)
394 orion_spi_set_cs(spi, 0);
395
396 tx_reg = spi_reg(orion_spi, ORION_SPI_DATA_OUT_REG);
397 rx_reg = spi_reg(orion_spi, ORION_SPI_DATA_IN_REG);
398 int_reg = spi_reg(orion_spi, ORION_SPI_INT_CAUSE_REG);
399
400 /* clear the interrupt cause register */
401 writel(0x0, int_reg);
402
403 if (tx_buf && *tx_buf)
404 writel(*(*tx_buf)++, tx_reg);
405 else
406 writel(0, tx_reg);
407
408 if (orion_spi_wait_till_ready(orion_spi) < 0) {
409 if (cs_single_byte) {
410 orion_spi_set_cs(spi, 1);
411 /* Satisfy some SLIC devices requirements */
412 udelay(4);
413 }
414 dev_err(&spi->dev, "TXS timed out\n");
415 return -1;
416 }
417
418 if (rx_buf && *rx_buf)
419 *(*rx_buf)++ = readl(rx_reg);
420
421 if (cs_single_byte) {
422 orion_spi_set_cs(spi, 1);
423 /* Satisfy some SLIC devices requirements */
424 udelay(4);
425 }
426
427 return 1;
428}
429
430static inline int
431orion_spi_write_read_16bit(struct spi_device *spi,
432 const u16 **tx_buf, u16 **rx_buf)
433{
434 void __iomem *tx_reg, *rx_reg, *int_reg;
435 struct orion_spi *orion_spi;
436
437 if (spi->mode & SPI_CS_WORD) {
438 dev_err(&spi->dev, "SPI_CS_WORD is only supported for 8 bit words\n");
439 return -1;
440 }
441
442 orion_spi = spi_controller_get_devdata(spi->controller);
443 tx_reg = spi_reg(orion_spi, ORION_SPI_DATA_OUT_REG);
444 rx_reg = spi_reg(orion_spi, ORION_SPI_DATA_IN_REG);
445 int_reg = spi_reg(orion_spi, ORION_SPI_INT_CAUSE_REG);
446
447 /* clear the interrupt cause register */
448 writel(0x0, int_reg);
449
450 if (tx_buf && *tx_buf)
451 writel(__cpu_to_le16(get_unaligned((*tx_buf)++)), tx_reg);
452 else
453 writel(0, tx_reg);
454
455 if (orion_spi_wait_till_ready(orion_spi) < 0) {
456 dev_err(&spi->dev, "TXS timed out\n");
457 return -1;
458 }
459
460 if (rx_buf && *rx_buf)
461 put_unaligned(__le16_to_cpu(readl(rx_reg)), (*rx_buf)++);
462
463 return 1;
464}
465
466static unsigned int
467orion_spi_write_read(struct spi_device *spi, struct spi_transfer *xfer)
468{
469 unsigned int count;
470 int word_len;
471 struct orion_spi *orion_spi;
472 int cs = spi_get_chipselect(spi, 0);
473 void __iomem *vaddr;
474
475 word_len = spi->bits_per_word;
476 count = xfer->len;
477
478 orion_spi = spi_controller_get_devdata(spi->controller);
479
480 /*
481 * Use SPI direct write mode if base address is available
482 * and SPI_CS_WORD flag is not set.
483 * Otherwise fall back to PIO mode for this transfer.
484 */
485 vaddr = orion_spi->child[cs].direct_access.vaddr;
486
487 if (vaddr && xfer->tx_buf && word_len == 8 && (spi->mode & SPI_CS_WORD) == 0) {
488 unsigned int cnt = count / 4;
489 unsigned int rem = count % 4;
490
491 /*
492 * Send the TX-data to the SPI device via the direct
493 * mapped address window
494 */
495 iowrite32_rep(vaddr, xfer->tx_buf, cnt);
496 if (rem) {
497 u32 *buf = (u32 *)xfer->tx_buf;
498
499 iowrite8_rep(vaddr, &buf[cnt], rem);
500 }
501
502 return count;
503 }
504
505 if (word_len == 8) {
506 const u8 *tx = xfer->tx_buf;
507 u8 *rx = xfer->rx_buf;
508
509 do {
510 if (orion_spi_write_read_8bit(spi, &tx, &rx) < 0)
511 goto out;
512 count--;
513 spi_delay_exec(&xfer->word_delay, xfer);
514 } while (count);
515 } else if (word_len == 16) {
516 const u16 *tx = xfer->tx_buf;
517 u16 *rx = xfer->rx_buf;
518
519 do {
520 if (orion_spi_write_read_16bit(spi, &tx, &rx) < 0)
521 goto out;
522 count -= 2;
523 spi_delay_exec(&xfer->word_delay, xfer);
524 } while (count);
525 }
526
527out:
528 return xfer->len - count;
529}
530
531static int orion_spi_transfer_one(struct spi_controller *host,
532 struct spi_device *spi,
533 struct spi_transfer *t)
534{
535 int status = 0;
536
537 status = orion_spi_setup_transfer(spi, t);
538 if (status < 0)
539 return status;
540
541 if (t->len)
542 orion_spi_write_read(spi, t);
543
544 return status;
545}
546
547static int orion_spi_setup(struct spi_device *spi)
548{
549 int ret;
550#ifdef CONFIG_PM
551 struct orion_spi *orion_spi = spi_controller_get_devdata(spi->controller);
552 struct device *dev = orion_spi->dev;
553
554 orion_spi_runtime_resume(dev);
555#endif
556
557 ret = orion_spi_setup_transfer(spi, NULL);
558
559#ifdef CONFIG_PM
560 orion_spi_runtime_suspend(dev);
561#endif
562
563 return ret;
564}
565
566static int orion_spi_reset(struct orion_spi *orion_spi)
567{
568 /* Verify that the CS is deasserted */
569 orion_spi_clrbits(orion_spi, ORION_SPI_IF_CTRL_REG, 0x1);
570
571 /* Don't deassert CS between the direct mapped SPI transfers */
572 writel(0, spi_reg(orion_spi, SPI_DIRECT_WRITE_CONFIG_REG));
573
574 return 0;
575}
576
577static const struct orion_spi_dev orion_spi_dev_data = {
578 .typ = ORION_SPI,
579 .min_divisor = 4,
580 .max_divisor = 30,
581 .prescale_mask = ORION_SPI_CLK_PRESCALE_MASK,
582};
583
584static const struct orion_spi_dev armada_370_spi_dev_data = {
585 .typ = ARMADA_SPI,
586 .min_divisor = 4,
587 .max_divisor = 1920,
588 .max_hz = 50000000,
589 .prescale_mask = ARMADA_SPI_CLK_PRESCALE_MASK,
590};
591
592static const struct orion_spi_dev armada_xp_spi_dev_data = {
593 .typ = ARMADA_SPI,
594 .max_hz = 50000000,
595 .max_divisor = 1920,
596 .prescale_mask = ARMADA_SPI_CLK_PRESCALE_MASK,
597};
598
599static const struct orion_spi_dev armada_375_spi_dev_data = {
600 .typ = ARMADA_SPI,
601 .min_divisor = 15,
602 .max_divisor = 1920,
603 .prescale_mask = ARMADA_SPI_CLK_PRESCALE_MASK,
604};
605
606static const struct orion_spi_dev armada_380_spi_dev_data = {
607 .typ = ARMADA_SPI,
608 .max_hz = 50000000,
609 .max_divisor = 1920,
610 .prescale_mask = ARMADA_SPI_CLK_PRESCALE_MASK,
611 .is_errata_50mhz_ac = true,
612};
613
614static const struct of_device_id orion_spi_of_match_table[] = {
615 {
616 .compatible = "marvell,orion-spi",
617 .data = &orion_spi_dev_data,
618 },
619 {
620 .compatible = "marvell,armada-370-spi",
621 .data = &armada_370_spi_dev_data,
622 },
623 {
624 .compatible = "marvell,armada-375-spi",
625 .data = &armada_375_spi_dev_data,
626 },
627 {
628 .compatible = "marvell,armada-380-spi",
629 .data = &armada_380_spi_dev_data,
630 },
631 {
632 .compatible = "marvell,armada-390-spi",
633 .data = &armada_xp_spi_dev_data,
634 },
635 {
636 .compatible = "marvell,armada-xp-spi",
637 .data = &armada_xp_spi_dev_data,
638 },
639
640 {}
641};
642MODULE_DEVICE_TABLE(of, orion_spi_of_match_table);
643
644static int orion_spi_probe(struct platform_device *pdev)
645{
646 const struct orion_spi_dev *devdata;
647 struct spi_controller *host;
648 struct orion_spi *spi;
649 struct resource *r;
650 unsigned long tclk_hz;
651 int status = 0;
652 struct device_node *np;
653
654 host = spi_alloc_host(&pdev->dev, sizeof(*spi));
655 if (host == NULL) {
656 dev_dbg(&pdev->dev, "host allocation failed\n");
657 return -ENOMEM;
658 }
659
660 if (pdev->id != -1)
661 host->bus_num = pdev->id;
662 if (pdev->dev.of_node) {
663 u32 cell_index;
664
665 if (!of_property_read_u32(pdev->dev.of_node, "cell-index",
666 &cell_index))
667 host->bus_num = cell_index;
668 }
669
670 /* we support all 4 SPI modes and LSB first option */
671 host->mode_bits = SPI_CPHA | SPI_CPOL | SPI_LSB_FIRST | SPI_CS_WORD;
672 host->set_cs = orion_spi_set_cs;
673 host->transfer_one = orion_spi_transfer_one;
674 host->num_chipselect = ORION_NUM_CHIPSELECTS;
675 host->setup = orion_spi_setup;
676 host->bits_per_word_mask = SPI_BPW_MASK(8) | SPI_BPW_MASK(16);
677 host->auto_runtime_pm = true;
678 host->use_gpio_descriptors = true;
679 host->flags = SPI_CONTROLLER_GPIO_SS;
680
681 platform_set_drvdata(pdev, host);
682
683 spi = spi_controller_get_devdata(host);
684 spi->host = host;
685 spi->dev = &pdev->dev;
686
687 devdata = device_get_match_data(&pdev->dev);
688 devdata = devdata ? devdata : &orion_spi_dev_data;
689 spi->devdata = devdata;
690
691 spi->clk = devm_clk_get_enabled(&pdev->dev, NULL);
692 if (IS_ERR(spi->clk)) {
693 status = PTR_ERR(spi->clk);
694 goto out;
695 }
696
697 /* The following clock is only used by some SoCs */
698 spi->axi_clk = devm_clk_get(&pdev->dev, "axi");
699 if (PTR_ERR(spi->axi_clk) == -EPROBE_DEFER) {
700 status = -EPROBE_DEFER;
701 goto out;
702 }
703 if (!IS_ERR(spi->axi_clk))
704 clk_prepare_enable(spi->axi_clk);
705
706 tclk_hz = clk_get_rate(spi->clk);
707
708 /*
709 * With old device tree, armada-370-spi could be used with
710 * Armada XP, however for this SoC the maximum frequency is
711 * 50MHz instead of tclk/4. On Armada 370, tclk cannot be
712 * higher than 200MHz. So, in order to be able to handle both
713 * SoCs, we can take the minimum of 50MHz and tclk/4.
714 */
715 if (of_device_is_compatible(pdev->dev.of_node,
716 "marvell,armada-370-spi"))
717 host->max_speed_hz = min(devdata->max_hz,
718 DIV_ROUND_UP(tclk_hz, devdata->min_divisor));
719 else if (devdata->min_divisor)
720 host->max_speed_hz =
721 DIV_ROUND_UP(tclk_hz, devdata->min_divisor);
722 else
723 host->max_speed_hz = devdata->max_hz;
724 host->min_speed_hz = DIV_ROUND_UP(tclk_hz, devdata->max_divisor);
725
726 spi->base = devm_platform_get_and_ioremap_resource(pdev, 0, &r);
727 if (IS_ERR(spi->base)) {
728 status = PTR_ERR(spi->base);
729 goto out_rel_axi_clk;
730 }
731
732 for_each_available_child_of_node(pdev->dev.of_node, np) {
733 struct orion_direct_acc *dir_acc;
734 u32 cs;
735
736 /* Get chip-select number from the "reg" property */
737 status = of_property_read_u32(np, "reg", &cs);
738 if (status) {
739 dev_err(&pdev->dev,
740 "%pOF has no valid 'reg' property (%d)\n",
741 np, status);
742 continue;
743 }
744
745 /*
746 * Check if an address is configured for this SPI device. If
747 * not, the MBus mapping via the 'ranges' property in the 'soc'
748 * node is not configured and this device should not use the
749 * direct mode. In this case, just continue with the next
750 * device.
751 */
752 status = of_address_to_resource(pdev->dev.of_node, cs + 1, r);
753 if (status)
754 continue;
755
756 /*
757 * Only map one page for direct access. This is enough for the
758 * simple TX transfer which only writes to the first word.
759 * This needs to get extended for the direct SPI NOR / SPI NAND
760 * support, once this gets implemented.
761 */
762 dir_acc = &spi->child[cs].direct_access;
763 dir_acc->vaddr = devm_ioremap(&pdev->dev, r->start, PAGE_SIZE);
764 if (!dir_acc->vaddr) {
765 status = -ENOMEM;
766 of_node_put(np);
767 goto out_rel_axi_clk;
768 }
769 dir_acc->size = PAGE_SIZE;
770
771 dev_info(&pdev->dev, "CS%d configured for direct access\n", cs);
772 }
773
774 pm_runtime_set_active(&pdev->dev);
775 pm_runtime_use_autosuspend(&pdev->dev);
776 pm_runtime_set_autosuspend_delay(&pdev->dev, SPI_AUTOSUSPEND_TIMEOUT);
777 pm_runtime_enable(&pdev->dev);
778
779 status = orion_spi_reset(spi);
780 if (status < 0)
781 goto out_rel_pm;
782
783 host->dev.of_node = pdev->dev.of_node;
784 status = spi_register_controller(host);
785 if (status < 0)
786 goto out_rel_pm;
787
788 return status;
789
790out_rel_pm:
791 pm_runtime_disable(&pdev->dev);
792out_rel_axi_clk:
793 clk_disable_unprepare(spi->axi_clk);
794out:
795 spi_controller_put(host);
796 return status;
797}
798
799
800static void orion_spi_remove(struct platform_device *pdev)
801{
802 struct spi_controller *host = platform_get_drvdata(pdev);
803 struct orion_spi *spi = spi_controller_get_devdata(host);
804
805 pm_runtime_get_sync(&pdev->dev);
806 clk_disable_unprepare(spi->axi_clk);
807
808 spi_unregister_controller(host);
809 pm_runtime_disable(&pdev->dev);
810}
811
812MODULE_ALIAS("platform:" DRIVER_NAME);
813
814#ifdef CONFIG_PM
815static int orion_spi_runtime_suspend(struct device *dev)
816{
817 struct spi_controller *host = dev_get_drvdata(dev);
818 struct orion_spi *spi = spi_controller_get_devdata(host);
819
820 clk_disable_unprepare(spi->axi_clk);
821 clk_disable_unprepare(spi->clk);
822 return 0;
823}
824
825static int orion_spi_runtime_resume(struct device *dev)
826{
827 struct spi_controller *host = dev_get_drvdata(dev);
828 struct orion_spi *spi = spi_controller_get_devdata(host);
829
830 if (!IS_ERR(spi->axi_clk))
831 clk_prepare_enable(spi->axi_clk);
832 return clk_prepare_enable(spi->clk);
833}
834#endif
835
836static const struct dev_pm_ops orion_spi_pm_ops = {
837 SET_RUNTIME_PM_OPS(orion_spi_runtime_suspend,
838 orion_spi_runtime_resume,
839 NULL)
840};
841
842static struct platform_driver orion_spi_driver = {
843 .driver = {
844 .name = DRIVER_NAME,
845 .pm = &orion_spi_pm_ops,
846 .of_match_table = of_match_ptr(orion_spi_of_match_table),
847 },
848 .probe = orion_spi_probe,
849 .remove = orion_spi_remove,
850};
851
852module_platform_driver(orion_spi_driver);
853
854MODULE_DESCRIPTION("Orion SPI driver");
855MODULE_AUTHOR("Shadi Ammouri <shadi@marvell.com>");
856MODULE_LICENSE("GPL");