blob: deca63e82ff6884a52b405fabc208379ea107009 [file] [log] [blame]
Shadi Ammouri60cadec2008-08-05 13:01:09 -07001/*
Grant Likelyca632f52011-06-06 01:16:30 -06002 * Marvell Orion SPI controller driver
Shadi Ammouri60cadec2008-08-05 13:01:09 -07003 *
4 * Author: Shadi Ammouri <shadi@marvell.com>
5 * Copyright (C) 2007-2008 Marvell Ltd.
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
10 */
11
Shadi Ammouri60cadec2008-08-05 13:01:09 -070012#include <linux/interrupt.h>
13#include <linux/delay.h>
14#include <linux/platform_device.h>
15#include <linux/err.h>
16#include <linux/io.h>
17#include <linux/spi/spi.h>
Paul Gortmakerd7614de2011-07-03 15:44:29 -040018#include <linux/module.h>
Russell King5c678692014-06-21 12:22:37 +010019#include <linux/pm_runtime.h>
Andrew Lunnf814f9a2012-07-23 12:08:09 +020020#include <linux/of.h>
Stefan Roeseb3c195b2016-05-19 09:07:05 +020021#include <linux/of_address.h>
Greg Ungererdf59fa72014-09-28 23:24:04 +100022#include <linux/of_device.h>
Andrew Lunn4574b882012-04-06 17:17:26 +020023#include <linux/clk.h>
Mark Brown895248f2013-07-29 05:10:21 +010024#include <linux/sizes.h>
Chris Packhamb28b9142017-05-23 16:03:21 +120025#include <linux/gpio.h>
Shadi Ammouri60cadec2008-08-05 13:01:09 -070026#include <asm/unaligned.h>
27
28#define DRIVER_NAME "orion_spi"
29
Russell King5c678692014-06-21 12:22:37 +010030/* Runtime PM autosuspend timeout: PM is fairly light on this driver */
31#define SPI_AUTOSUSPEND_TIMEOUT 200
32
Ken Wilson23244402015-01-16 13:10:47 +100033/* Some SoCs using this driver support up to 8 chip selects.
34 * It is up to the implementer to only use the chip selects
35 * that are available.
36 */
37#define ORION_NUM_CHIPSELECTS 8
38
Shadi Ammouri60cadec2008-08-05 13:01:09 -070039#define ORION_SPI_WAIT_RDY_MAX_LOOP 2000 /* in usec */
40
41#define ORION_SPI_IF_CTRL_REG 0x00
42#define ORION_SPI_IF_CONFIG_REG 0x04
Bastian Stender1017f422017-04-07 15:52:33 +020043#define ORION_SPI_IF_RXLSBF BIT(14)
44#define ORION_SPI_IF_TXLSBF BIT(13)
Shadi Ammouri60cadec2008-08-05 13:01:09 -070045#define ORION_SPI_DATA_OUT_REG 0x08
46#define ORION_SPI_DATA_IN_REG 0x0c
47#define ORION_SPI_INT_CAUSE_REG 0x10
Nadav Haklai38d62112015-08-11 11:58:47 +020048#define ORION_SPI_TIMING_PARAMS_REG 0x18
49
Stefan Roeseb3c195b2016-05-19 09:07:05 +020050/* Register for the "Direct Mode" */
51#define SPI_DIRECT_WRITE_CONFIG_REG 0x20
52
Nadav Haklai38d62112015-08-11 11:58:47 +020053#define ORION_SPI_TMISO_SAMPLE_MASK (0x3 << 6)
54#define ORION_SPI_TMISO_SAMPLE_1 (1 << 6)
55#define ORION_SPI_TMISO_SAMPLE_2 (2 << 6)
Shadi Ammouri60cadec2008-08-05 13:01:09 -070056
Jason Gunthorpeb15d5d72012-11-21 12:23:35 -070057#define ORION_SPI_MODE_CPOL (1 << 11)
58#define ORION_SPI_MODE_CPHA (1 << 12)
Shadi Ammouri60cadec2008-08-05 13:01:09 -070059#define ORION_SPI_IF_8_16_BIT_MODE (1 << 5)
60#define ORION_SPI_CLK_PRESCALE_MASK 0x1F
Greg Ungererdf59fa72014-09-28 23:24:04 +100061#define ARMADA_SPI_CLK_PRESCALE_MASK 0xDF
Jason Gunthorpeb15d5d72012-11-21 12:23:35 -070062#define ORION_SPI_MODE_MASK (ORION_SPI_MODE_CPOL | \
63 ORION_SPI_MODE_CPHA)
Ken Wilson23244402015-01-16 13:10:47 +100064#define ORION_SPI_CS_MASK 0x1C
65#define ORION_SPI_CS_SHIFT 2
66#define ORION_SPI_CS(cs) ((cs << ORION_SPI_CS_SHIFT) & \
67 ORION_SPI_CS_MASK)
Shadi Ammouri60cadec2008-08-05 13:01:09 -070068
Greg Ungererdf59fa72014-09-28 23:24:04 +100069enum orion_spi_type {
70 ORION_SPI,
71 ARMADA_SPI,
72};
73
74struct orion_spi_dev {
75 enum orion_spi_type typ;
Gregory CLEMENTce2f6ea2015-05-26 11:44:42 +020076 /*
77 * min_divisor and max_hz should be exclusive, the only we can
78 * have both is for managing the armada-370-spi case with old
79 * device tree
80 */
81 unsigned long max_hz;
Greg Ungererdf59fa72014-09-28 23:24:04 +100082 unsigned int min_divisor;
83 unsigned int max_divisor;
84 u32 prescale_mask;
Nadav Haklai38d62112015-08-11 11:58:47 +020085 bool is_errata_50mhz_ac;
Greg Ungererdf59fa72014-09-28 23:24:04 +100086};
87
Stefan Roeseb3c195b2016-05-19 09:07:05 +020088struct orion_direct_acc {
89 void __iomem *vaddr;
90 u32 size;
91};
92
Shadi Ammouri60cadec2008-08-05 13:01:09 -070093struct orion_spi {
Shadi Ammouri60cadec2008-08-05 13:01:09 -070094 struct spi_master *master;
95 void __iomem *base;
Andrew Lunn4574b882012-04-06 17:17:26 +020096 struct clk *clk;
Gregory CLEMENT92ae1122018-01-12 11:42:33 +010097 struct clk *axi_clk;
Greg Ungererdf59fa72014-09-28 23:24:04 +100098 const struct orion_spi_dev *devdata;
Stefan Roeseb3c195b2016-05-19 09:07:05 +020099
100 struct orion_direct_acc direct_access[ORION_NUM_CHIPSELECTS];
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700101};
102
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700103static inline void __iomem *spi_reg(struct orion_spi *orion_spi, u32 reg)
104{
105 return orion_spi->base + reg;
106}
107
108static inline void
109orion_spi_setbits(struct orion_spi *orion_spi, u32 reg, u32 mask)
110{
111 void __iomem *reg_addr = spi_reg(orion_spi, reg);
112 u32 val;
113
114 val = readl(reg_addr);
115 val |= mask;
116 writel(val, reg_addr);
117}
118
119static inline void
120orion_spi_clrbits(struct orion_spi *orion_spi, u32 reg, u32 mask)
121{
122 void __iomem *reg_addr = spi_reg(orion_spi, reg);
123 u32 val;
124
125 val = readl(reg_addr);
126 val &= ~mask;
127 writel(val, reg_addr);
128}
129
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700130static int orion_spi_baudrate_set(struct spi_device *spi, unsigned int speed)
131{
132 u32 tclk_hz;
133 u32 rate;
134 u32 prescale;
135 u32 reg;
136 struct orion_spi *orion_spi;
Greg Ungererdf59fa72014-09-28 23:24:04 +1000137 const struct orion_spi_dev *devdata;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700138
139 orion_spi = spi_master_get_devdata(spi->master);
Greg Ungererdf59fa72014-09-28 23:24:04 +1000140 devdata = orion_spi->devdata;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700141
Andrew Lunn4574b882012-04-06 17:17:26 +0200142 tclk_hz = clk_get_rate(orion_spi->clk);
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700143
Greg Ungererdf59fa72014-09-28 23:24:04 +1000144 if (devdata->typ == ARMADA_SPI) {
Uwe Kleine-König7243e0b2016-12-08 17:37:08 +0100145 /*
146 * Given the core_clk (tclk_hz) and the target rate (speed) we
147 * determine the best values for SPR (in [0 .. 15]) and SPPR (in
148 * [0..7]) such that
149 *
150 * core_clk / (SPR * 2 ** SPPR)
151 *
152 * is as big as possible but not bigger than speed.
153 */
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700154
Uwe Kleine-König7243e0b2016-12-08 17:37:08 +0100155 /* best integer divider: */
156 unsigned divider = DIV_ROUND_UP(tclk_hz, speed);
157 unsigned spr, sppr;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700158
Uwe Kleine-König7243e0b2016-12-08 17:37:08 +0100159 if (divider < 16) {
160 /* This is the easy case, divider is less than 16 */
161 spr = divider;
162 sppr = 0;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700163
Uwe Kleine-König7243e0b2016-12-08 17:37:08 +0100164 } else {
165 unsigned two_pow_sppr;
166 /*
167 * Find the highest bit set in divider. This and the
168 * three next bits define SPR (apart from rounding).
169 * SPPR is then the number of zero bits that must be
170 * appended:
171 */
172 sppr = fls(divider) - 4;
Greg Ungererdf59fa72014-09-28 23:24:04 +1000173
Uwe Kleine-König7243e0b2016-12-08 17:37:08 +0100174 /*
175 * As SPR only has 4 bits, we have to round divider up
176 * to the next multiple of 2 ** sppr.
177 */
178 two_pow_sppr = 1 << sppr;
179 divider = (divider + two_pow_sppr - 1) & -two_pow_sppr;
Greg Ungererdf59fa72014-09-28 23:24:04 +1000180
Uwe Kleine-König7243e0b2016-12-08 17:37:08 +0100181 /*
182 * recalculate sppr as rounding up divider might have
183 * increased it enough to change the position of the
184 * highest set bit. In this case the bit that now
185 * doesn't make it into SPR is 0, so there is no need to
186 * round again.
187 */
188 sppr = fls(divider) - 4;
189 spr = divider >> sppr;
190
191 /*
192 * Now do range checking. SPR is constructed to have a
193 * width of 4 bits, so this is fine for sure. So we
194 * still need to check for sppr to fit into 3 bits:
195 */
196 if (sppr > 7)
197 return -EINVAL;
Greg Ungererdf59fa72014-09-28 23:24:04 +1000198 }
199
Uwe Kleine-König7243e0b2016-12-08 17:37:08 +0100200 prescale = ((sppr & 0x6) << 5) | ((sppr & 0x1) << 4) | spr;
Greg Ungererdf59fa72014-09-28 23:24:04 +1000201 } else {
202 /*
203 * the supported rates are: 4,6,8...30
204 * round up as we look for equal or less speed
205 */
206 rate = DIV_ROUND_UP(tclk_hz, speed);
207 rate = roundup(rate, 2);
208
209 /* check if requested speed is too small */
210 if (rate > 30)
211 return -EINVAL;
212
213 if (rate < 4)
214 rate = 4;
215
216 /* Convert the rate to SPI clock divisor value. */
217 prescale = 0x10 + rate/2;
218 }
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700219
220 reg = readl(spi_reg(orion_spi, ORION_SPI_IF_CONFIG_REG));
Greg Ungererdf59fa72014-09-28 23:24:04 +1000221 reg = ((reg & ~devdata->prescale_mask) | prescale);
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700222 writel(reg, spi_reg(orion_spi, ORION_SPI_IF_CONFIG_REG));
223
224 return 0;
225}
226
Jason Gunthorpeb15d5d72012-11-21 12:23:35 -0700227static void
228orion_spi_mode_set(struct spi_device *spi)
229{
230 u32 reg;
231 struct orion_spi *orion_spi;
232
233 orion_spi = spi_master_get_devdata(spi->master);
234
235 reg = readl(spi_reg(orion_spi, ORION_SPI_IF_CONFIG_REG));
236 reg &= ~ORION_SPI_MODE_MASK;
237 if (spi->mode & SPI_CPOL)
238 reg |= ORION_SPI_MODE_CPOL;
239 if (spi->mode & SPI_CPHA)
240 reg |= ORION_SPI_MODE_CPHA;
Bastian Stender1017f422017-04-07 15:52:33 +0200241 if (spi->mode & SPI_LSB_FIRST)
242 reg |= ORION_SPI_IF_RXLSBF | ORION_SPI_IF_TXLSBF;
243 else
244 reg &= ~(ORION_SPI_IF_RXLSBF | ORION_SPI_IF_TXLSBF);
245
Jason Gunthorpeb15d5d72012-11-21 12:23:35 -0700246 writel(reg, spi_reg(orion_spi, ORION_SPI_IF_CONFIG_REG));
247}
248
Nadav Haklai38d62112015-08-11 11:58:47 +0200249static void
250orion_spi_50mhz_ac_timing_erratum(struct spi_device *spi, unsigned int speed)
251{
252 u32 reg;
253 struct orion_spi *orion_spi;
254
255 orion_spi = spi_master_get_devdata(spi->master);
256
257 /*
258 * Erratum description: (Erratum NO. FE-9144572) The device
259 * SPI interface supports frequencies of up to 50 MHz.
260 * However, due to this erratum, when the device core clock is
261 * 250 MHz and the SPI interfaces is configured for 50MHz SPI
262 * clock and CPOL=CPHA=1 there might occur data corruption on
263 * reads from the SPI device.
264 * Erratum Workaround:
265 * Work in one of the following configurations:
266 * 1. Set CPOL=CPHA=0 in "SPI Interface Configuration
267 * Register".
268 * 2. Set TMISO_SAMPLE value to 0x2 in "SPI Timing Parameters 1
269 * Register" before setting the interface.
270 */
271 reg = readl(spi_reg(orion_spi, ORION_SPI_TIMING_PARAMS_REG));
272 reg &= ~ORION_SPI_TMISO_SAMPLE_MASK;
273
274 if (clk_get_rate(orion_spi->clk) == 250000000 &&
275 speed == 50000000 && spi->mode & SPI_CPOL &&
276 spi->mode & SPI_CPHA)
277 reg |= ORION_SPI_TMISO_SAMPLE_2;
278 else
279 reg |= ORION_SPI_TMISO_SAMPLE_1; /* This is the default value */
280
281 writel(reg, spi_reg(orion_spi, ORION_SPI_TIMING_PARAMS_REG));
282}
283
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700284/*
285 * called only when no transfer is active on the bus
286 */
287static int
288orion_spi_setup_transfer(struct spi_device *spi, struct spi_transfer *t)
289{
290 struct orion_spi *orion_spi;
291 unsigned int speed = spi->max_speed_hz;
292 unsigned int bits_per_word = spi->bits_per_word;
293 int rc;
294
295 orion_spi = spi_master_get_devdata(spi->master);
296
297 if ((t != NULL) && t->speed_hz)
298 speed = t->speed_hz;
299
300 if ((t != NULL) && t->bits_per_word)
301 bits_per_word = t->bits_per_word;
302
Jason Gunthorpeb15d5d72012-11-21 12:23:35 -0700303 orion_spi_mode_set(spi);
304
Nadav Haklai38d62112015-08-11 11:58:47 +0200305 if (orion_spi->devdata->is_errata_50mhz_ac)
306 orion_spi_50mhz_ac_timing_erratum(spi, speed);
307
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700308 rc = orion_spi_baudrate_set(spi, speed);
309 if (rc)
310 return rc;
311
Axel Lin495b3352014-02-11 20:51:36 +0800312 if (bits_per_word == 16)
313 orion_spi_setbits(orion_spi, ORION_SPI_IF_CONFIG_REG,
314 ORION_SPI_IF_8_16_BIT_MODE);
315 else
316 orion_spi_clrbits(orion_spi, ORION_SPI_IF_CONFIG_REG,
317 ORION_SPI_IF_8_16_BIT_MODE);
318
319 return 0;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700320}
321
Ken Wilson75872eb2015-01-12 13:13:59 +1000322static void orion_spi_set_cs(struct spi_device *spi, bool enable)
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700323{
Ken Wilson75872eb2015-01-12 13:13:59 +1000324 struct orion_spi *orion_spi;
Chris Packhamb28b9142017-05-23 16:03:21 +1200325 int cs;
326
327 if (gpio_is_valid(spi->cs_gpio))
328 cs = 0;
329 else
330 cs = spi->chip_select;
Ken Wilson75872eb2015-01-12 13:13:59 +1000331
332 orion_spi = spi_master_get_devdata(spi->master);
333
Ken Wilson23244402015-01-16 13:10:47 +1000334 orion_spi_clrbits(orion_spi, ORION_SPI_IF_CTRL_REG, ORION_SPI_CS_MASK);
335 orion_spi_setbits(orion_spi, ORION_SPI_IF_CTRL_REG,
Chris Packhamb28b9142017-05-23 16:03:21 +1200336 ORION_SPI_CS(cs));
Ken Wilson23244402015-01-16 13:10:47 +1000337
Ken Wilson75872eb2015-01-12 13:13:59 +1000338 /* Chip select logic is inverted from spi_set_cs */
339 if (!enable)
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700340 orion_spi_setbits(orion_spi, ORION_SPI_IF_CTRL_REG, 0x1);
341 else
342 orion_spi_clrbits(orion_spi, ORION_SPI_IF_CTRL_REG, 0x1);
343}
344
345static inline int orion_spi_wait_till_ready(struct orion_spi *orion_spi)
346{
347 int i;
348
349 for (i = 0; i < ORION_SPI_WAIT_RDY_MAX_LOOP; i++) {
350 if (readl(spi_reg(orion_spi, ORION_SPI_INT_CAUSE_REG)))
351 return 1;
Jingoo Hanb8434042014-09-02 11:51:39 +0900352
353 udelay(1);
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700354 }
355
356 return -1;
357}
358
359static inline int
360orion_spi_write_read_8bit(struct spi_device *spi,
361 const u8 **tx_buf, u8 **rx_buf)
362{
363 void __iomem *tx_reg, *rx_reg, *int_reg;
364 struct orion_spi *orion_spi;
365
366 orion_spi = spi_master_get_devdata(spi->master);
367 tx_reg = spi_reg(orion_spi, ORION_SPI_DATA_OUT_REG);
368 rx_reg = spi_reg(orion_spi, ORION_SPI_DATA_IN_REG);
369 int_reg = spi_reg(orion_spi, ORION_SPI_INT_CAUSE_REG);
370
371 /* clear the interrupt cause register */
372 writel(0x0, int_reg);
373
374 if (tx_buf && *tx_buf)
375 writel(*(*tx_buf)++, tx_reg);
376 else
377 writel(0, tx_reg);
378
379 if (orion_spi_wait_till_ready(orion_spi) < 0) {
380 dev_err(&spi->dev, "TXS timed out\n");
381 return -1;
382 }
383
384 if (rx_buf && *rx_buf)
385 *(*rx_buf)++ = readl(rx_reg);
386
387 return 1;
388}
389
390static inline int
391orion_spi_write_read_16bit(struct spi_device *spi,
392 const u16 **tx_buf, u16 **rx_buf)
393{
394 void __iomem *tx_reg, *rx_reg, *int_reg;
395 struct orion_spi *orion_spi;
396
397 orion_spi = spi_master_get_devdata(spi->master);
398 tx_reg = spi_reg(orion_spi, ORION_SPI_DATA_OUT_REG);
399 rx_reg = spi_reg(orion_spi, ORION_SPI_DATA_IN_REG);
400 int_reg = spi_reg(orion_spi, ORION_SPI_INT_CAUSE_REG);
401
402 /* clear the interrupt cause register */
403 writel(0x0, int_reg);
404
405 if (tx_buf && *tx_buf)
406 writel(__cpu_to_le16(get_unaligned((*tx_buf)++)), tx_reg);
407 else
408 writel(0, tx_reg);
409
410 if (orion_spi_wait_till_ready(orion_spi) < 0) {
411 dev_err(&spi->dev, "TXS timed out\n");
412 return -1;
413 }
414
415 if (rx_buf && *rx_buf)
416 put_unaligned(__le16_to_cpu(readl(rx_reg)), (*rx_buf)++);
417
418 return 1;
419}
420
421static unsigned int
422orion_spi_write_read(struct spi_device *spi, struct spi_transfer *xfer)
423{
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700424 unsigned int count;
425 int word_len;
Stefan Roeseb3c195b2016-05-19 09:07:05 +0200426 struct orion_spi *orion_spi;
427 int cs = spi->chip_select;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700428
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700429 word_len = spi->bits_per_word;
430 count = xfer->len;
431
Stefan Roeseb3c195b2016-05-19 09:07:05 +0200432 orion_spi = spi_master_get_devdata(spi->master);
433
434 /*
435 * Use SPI direct write mode if base address is available. Otherwise
436 * fall back to PIO mode for this transfer.
437 */
438 if ((orion_spi->direct_access[cs].vaddr) && (xfer->tx_buf) &&
439 (word_len == 8)) {
440 unsigned int cnt = count / 4;
441 unsigned int rem = count % 4;
442
443 /*
444 * Send the TX-data to the SPI device via the direct
445 * mapped address window
446 */
447 iowrite32_rep(orion_spi->direct_access[cs].vaddr,
448 xfer->tx_buf, cnt);
449 if (rem) {
450 u32 *buf = (u32 *)xfer->tx_buf;
451
452 iowrite8_rep(orion_spi->direct_access[cs].vaddr,
453 &buf[cnt], rem);
454 }
455
456 return count;
457 }
458
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700459 if (word_len == 8) {
460 const u8 *tx = xfer->tx_buf;
461 u8 *rx = xfer->rx_buf;
462
463 do {
464 if (orion_spi_write_read_8bit(spi, &tx, &rx) < 0)
465 goto out;
466 count--;
467 } while (count);
468 } else if (word_len == 16) {
469 const u16 *tx = xfer->tx_buf;
470 u16 *rx = xfer->rx_buf;
471
472 do {
473 if (orion_spi_write_read_16bit(spi, &tx, &rx) < 0)
474 goto out;
475 count -= 2;
476 } while (count);
477 }
478
479out:
480 return xfer->len - count;
481}
482
Ken Wilson75872eb2015-01-12 13:13:59 +1000483static int orion_spi_transfer_one(struct spi_master *master,
484 struct spi_device *spi,
485 struct spi_transfer *t)
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700486{
Andrew Lunnba59a802012-07-23 13:16:55 +0200487 int status = 0;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700488
Ken Wilson75872eb2015-01-12 13:13:59 +1000489 status = orion_spi_setup_transfer(spi, t);
Andrew Lunnba59a802012-07-23 13:16:55 +0200490 if (status < 0)
Ken Wilson75872eb2015-01-12 13:13:59 +1000491 return status;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700492
Ken Wilson75872eb2015-01-12 13:13:59 +1000493 if (t->len)
494 orion_spi_write_read(spi, t);
Andrew Lunnba59a802012-07-23 13:16:55 +0200495
Ken Wilson75872eb2015-01-12 13:13:59 +1000496 return status;
497}
Andrew Lunnba59a802012-07-23 13:16:55 +0200498
Ken Wilson75872eb2015-01-12 13:13:59 +1000499static int orion_spi_setup(struct spi_device *spi)
500{
501 return orion_spi_setup_transfer(spi, NULL);
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700502}
503
Grant Likely2deff8d2013-02-05 13:27:35 +0000504static int orion_spi_reset(struct orion_spi *orion_spi)
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700505{
506 /* Verify that the CS is deasserted */
Ken Wilson75872eb2015-01-12 13:13:59 +1000507 orion_spi_clrbits(orion_spi, ORION_SPI_IF_CTRL_REG, 0x1);
Stefan Roeseb3c195b2016-05-19 09:07:05 +0200508
509 /* Don't deassert CS between the direct mapped SPI transfers */
510 writel(0, spi_reg(orion_spi, SPI_DIRECT_WRITE_CONFIG_REG));
511
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700512 return 0;
513}
514
Greg Ungererdf59fa72014-09-28 23:24:04 +1000515static const struct orion_spi_dev orion_spi_dev_data = {
516 .typ = ORION_SPI,
517 .min_divisor = 4,
518 .max_divisor = 30,
519 .prescale_mask = ORION_SPI_CLK_PRESCALE_MASK,
520};
521
Gregory CLEMENT4dacccf2015-05-26 11:44:43 +0200522static const struct orion_spi_dev armada_370_spi_dev_data = {
Greg Ungererdf59fa72014-09-28 23:24:04 +1000523 .typ = ARMADA_SPI,
Gregory CLEMENTce2f6ea2015-05-26 11:44:42 +0200524 .min_divisor = 4,
Greg Ungererdf59fa72014-09-28 23:24:04 +1000525 .max_divisor = 1920,
Gregory CLEMENTce2f6ea2015-05-26 11:44:42 +0200526 .max_hz = 50000000,
Greg Ungererdf59fa72014-09-28 23:24:04 +1000527 .prescale_mask = ARMADA_SPI_CLK_PRESCALE_MASK,
528};
529
Gregory CLEMENT4dacccf2015-05-26 11:44:43 +0200530static const struct orion_spi_dev armada_xp_spi_dev_data = {
531 .typ = ARMADA_SPI,
532 .max_hz = 50000000,
533 .max_divisor = 1920,
534 .prescale_mask = ARMADA_SPI_CLK_PRESCALE_MASK,
535};
536
537static const struct orion_spi_dev armada_375_spi_dev_data = {
538 .typ = ARMADA_SPI,
539 .min_divisor = 15,
540 .max_divisor = 1920,
541 .prescale_mask = ARMADA_SPI_CLK_PRESCALE_MASK,
542};
543
Nadav Haklai38d62112015-08-11 11:58:47 +0200544static const struct orion_spi_dev armada_380_spi_dev_data = {
545 .typ = ARMADA_SPI,
546 .max_hz = 50000000,
547 .max_divisor = 1920,
548 .prescale_mask = ARMADA_SPI_CLK_PRESCALE_MASK,
549 .is_errata_50mhz_ac = true,
550};
551
Greg Ungererdf59fa72014-09-28 23:24:04 +1000552static const struct of_device_id orion_spi_of_match_table[] = {
Gregory CLEMENT4dacccf2015-05-26 11:44:43 +0200553 {
554 .compatible = "marvell,orion-spi",
555 .data = &orion_spi_dev_data,
556 },
557 {
558 .compatible = "marvell,armada-370-spi",
559 .data = &armada_370_spi_dev_data,
560 },
561 {
562 .compatible = "marvell,armada-375-spi",
563 .data = &armada_375_spi_dev_data,
564 },
565 {
566 .compatible = "marvell,armada-380-spi",
Nadav Haklai38d62112015-08-11 11:58:47 +0200567 .data = &armada_380_spi_dev_data,
Gregory CLEMENT4dacccf2015-05-26 11:44:43 +0200568 },
569 {
570 .compatible = "marvell,armada-390-spi",
571 .data = &armada_xp_spi_dev_data,
572 },
573 {
574 .compatible = "marvell,armada-xp-spi",
575 .data = &armada_xp_spi_dev_data,
576 },
577
Greg Ungererdf59fa72014-09-28 23:24:04 +1000578 {}
579};
580MODULE_DEVICE_TABLE(of, orion_spi_of_match_table);
581
Grant Likely2deff8d2013-02-05 13:27:35 +0000582static int orion_spi_probe(struct platform_device *pdev)
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700583{
Greg Ungererdf59fa72014-09-28 23:24:04 +1000584 const struct of_device_id *of_id;
585 const struct orion_spi_dev *devdata;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700586 struct spi_master *master;
587 struct orion_spi *spi;
588 struct resource *r;
Andrew Lunn4574b882012-04-06 17:17:26 +0200589 unsigned long tclk_hz;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700590 int status = 0;
Stefan Roeseb3c195b2016-05-19 09:07:05 +0200591 struct device_node *np;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700592
Jingoo Han3fed8062013-10-14 10:35:08 +0900593 master = spi_alloc_master(&pdev->dev, sizeof(*spi));
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700594 if (master == NULL) {
595 dev_dbg(&pdev->dev, "master allocation failed\n");
596 return -ENOMEM;
597 }
598
599 if (pdev->id != -1)
600 master->bus_num = pdev->id;
Andrew Lunnf814f9a2012-07-23 12:08:09 +0200601 if (pdev->dev.of_node) {
Thomas Petazzonie06871c2014-07-27 23:53:19 +0200602 u32 cell_index;
Jingoo Hanb8434042014-09-02 11:51:39 +0900603
Thomas Petazzonie06871c2014-07-27 23:53:19 +0200604 if (!of_property_read_u32(pdev->dev.of_node, "cell-index",
605 &cell_index))
606 master->bus_num = cell_index;
Andrew Lunnf814f9a2012-07-23 12:08:09 +0200607 }
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700608
Bastian Stender1017f422017-04-07 15:52:33 +0200609 /* we support all 4 SPI modes and LSB first option */
610 master->mode_bits = SPI_CPHA | SPI_CPOL | SPI_LSB_FIRST;
Ken Wilson75872eb2015-01-12 13:13:59 +1000611 master->set_cs = orion_spi_set_cs;
612 master->transfer_one = orion_spi_transfer_one;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700613 master->num_chipselect = ORION_NUM_CHIPSELECTS;
Ken Wilson75872eb2015-01-12 13:13:59 +1000614 master->setup = orion_spi_setup;
Axel Lin495b3352014-02-11 20:51:36 +0800615 master->bits_per_word_mask = SPI_BPW_MASK(8) | SPI_BPW_MASK(16);
Russell King5c678692014-06-21 12:22:37 +0100616 master->auto_runtime_pm = true;
Chris Packhamb28b9142017-05-23 16:03:21 +1200617 master->flags = SPI_MASTER_GPIO_SS;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700618
Jingoo Han24b5a822013-05-23 19:20:40 +0900619 platform_set_drvdata(pdev, master);
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700620
621 spi = spi_master_get_devdata(master);
622 spi->master = master;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700623
Greg Ungererdf59fa72014-09-28 23:24:04 +1000624 of_id = of_match_device(orion_spi_of_match_table, &pdev->dev);
Greg Ungerer9a2d3632014-10-21 15:57:48 +1000625 devdata = (of_id) ? of_id->data : &orion_spi_dev_data;
Greg Ungererdf59fa72014-09-28 23:24:04 +1000626 spi->devdata = devdata;
627
Jingoo Hanbb489842013-12-09 19:21:22 +0900628 spi->clk = devm_clk_get(&pdev->dev, NULL);
Andrew Lunn4574b882012-04-06 17:17:26 +0200629 if (IS_ERR(spi->clk)) {
630 status = PTR_ERR(spi->clk);
631 goto out;
632 }
633
Russell Kingc85012a2014-06-21 11:32:23 +0100634 status = clk_prepare_enable(spi->clk);
635 if (status)
636 goto out;
637
Gregory CLEMENT92ae1122018-01-12 11:42:33 +0100638 /* The following clock is only used by some SoCs */
639 spi->axi_clk = devm_clk_get(&pdev->dev, "axi");
640 if (IS_ERR(spi->axi_clk) &&
Christophe Jaillet479c03a2018-01-25 21:16:17 +0100641 PTR_ERR(spi->axi_clk) == -EPROBE_DEFER) {
642 status = -EPROBE_DEFER;
643 goto out_rel_clk;
644 }
Gregory CLEMENT92ae1122018-01-12 11:42:33 +0100645 if (!IS_ERR(spi->axi_clk))
646 clk_prepare_enable(spi->axi_clk);
647
Andrew Lunn4574b882012-04-06 17:17:26 +0200648 tclk_hz = clk_get_rate(spi->clk);
Gregory CLEMENTce2f6ea2015-05-26 11:44:42 +0200649
650 /*
651 * With old device tree, armada-370-spi could be used with
652 * Armada XP, however for this SoC the maximum frequency is
653 * 50MHz instead of tclk/4. On Armada 370, tclk cannot be
654 * higher than 200MHz. So, in order to be able to handle both
655 * SoCs, we can take the minimum of 50MHz and tclk/4.
656 */
657 if (of_device_is_compatible(pdev->dev.of_node,
658 "marvell,armada-370-spi"))
659 master->max_speed_hz = min(devdata->max_hz,
660 DIV_ROUND_UP(tclk_hz, devdata->min_divisor));
Gregory CLEMENT4dacccf2015-05-26 11:44:43 +0200661 else if (devdata->min_divisor)
Gregory CLEMENTce2f6ea2015-05-26 11:44:42 +0200662 master->max_speed_hz =
663 DIV_ROUND_UP(tclk_hz, devdata->min_divisor);
Gregory CLEMENT4dacccf2015-05-26 11:44:43 +0200664 else
665 master->max_speed_hz = devdata->max_hz;
Greg Ungererdf59fa72014-09-28 23:24:04 +1000666 master->min_speed_hz = DIV_ROUND_UP(tclk_hz, devdata->max_divisor);
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700667
668 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
Mark Brown1729ce32013-07-28 14:38:06 +0100669 spi->base = devm_ioremap_resource(&pdev->dev, r);
670 if (IS_ERR(spi->base)) {
671 status = PTR_ERR(spi->base);
Christophe Jaillet479c03a2018-01-25 21:16:17 +0100672 goto out_rel_axi_clk;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700673 }
674
Stefan Roeseb3c195b2016-05-19 09:07:05 +0200675 /* Scan all SPI devices of this controller for direct mapped devices */
676 for_each_available_child_of_node(pdev->dev.of_node, np) {
677 u32 cs;
678
679 /* Get chip-select number from the "reg" property */
680 status = of_property_read_u32(np, "reg", &cs);
681 if (status) {
682 dev_err(&pdev->dev,
Rob Herring25c56c82017-07-18 16:43:31 -0500683 "%pOF has no valid 'reg' property (%d)\n",
684 np, status);
Stefan Roeseb3c195b2016-05-19 09:07:05 +0200685 continue;
686 }
687
688 /*
689 * Check if an address is configured for this SPI device. If
690 * not, the MBus mapping via the 'ranges' property in the 'soc'
691 * node is not configured and this device should not use the
692 * direct mode. In this case, just continue with the next
693 * device.
694 */
695 status = of_address_to_resource(pdev->dev.of_node, cs + 1, r);
696 if (status)
697 continue;
698
699 /*
700 * Only map one page for direct access. This is enough for the
701 * simple TX transfer which only writes to the first word.
702 * This needs to get extended for the direct SPI-NOR / SPI-NAND
703 * support, once this gets implemented.
704 */
705 spi->direct_access[cs].vaddr = devm_ioremap(&pdev->dev,
706 r->start,
707 PAGE_SIZE);
Wei Yongjun57c624a2016-06-13 14:32:23 +0000708 if (!spi->direct_access[cs].vaddr) {
709 status = -ENOMEM;
Christophe Jaillet479c03a2018-01-25 21:16:17 +0100710 goto out_rel_axi_clk;
Stefan Roeseb3c195b2016-05-19 09:07:05 +0200711 }
712 spi->direct_access[cs].size = PAGE_SIZE;
713
714 dev_info(&pdev->dev, "CS%d configured for direct access\n", cs);
715 }
716
Russell King5c678692014-06-21 12:22:37 +0100717 pm_runtime_set_active(&pdev->dev);
718 pm_runtime_use_autosuspend(&pdev->dev);
719 pm_runtime_set_autosuspend_delay(&pdev->dev, SPI_AUTOSUSPEND_TIMEOUT);
720 pm_runtime_enable(&pdev->dev);
721
Wei Yongjun14033812014-07-20 22:03:14 +0800722 status = orion_spi_reset(spi);
723 if (status < 0)
Russell King5c678692014-06-21 12:22:37 +0100724 goto out_rel_pm;
725
726 pm_runtime_mark_last_busy(&pdev->dev);
727 pm_runtime_put_autosuspend(&pdev->dev);
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700728
Andrew Lunnf814f9a2012-07-23 12:08:09 +0200729 master->dev.of_node = pdev->dev.of_node;
Russell King5c678692014-06-21 12:22:37 +0100730 status = spi_register_master(master);
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700731 if (status < 0)
Russell King5c678692014-06-21 12:22:37 +0100732 goto out_rel_pm;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700733
734 return status;
735
Russell King5c678692014-06-21 12:22:37 +0100736out_rel_pm:
737 pm_runtime_disable(&pdev->dev);
Christophe Jaillet479c03a2018-01-25 21:16:17 +0100738out_rel_axi_clk:
Gregory CLEMENT92ae1122018-01-12 11:42:33 +0100739 clk_disable_unprepare(spi->axi_clk);
Christophe Jaillet479c03a2018-01-25 21:16:17 +0100740out_rel_clk:
Andrew Lunn4574b882012-04-06 17:17:26 +0200741 clk_disable_unprepare(spi->clk);
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700742out:
743 spi_master_put(master);
744 return status;
745}
746
747
Grant Likely2deff8d2013-02-05 13:27:35 +0000748static int orion_spi_remove(struct platform_device *pdev)
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700749{
Russell King5c678692014-06-21 12:22:37 +0100750 struct spi_master *master = platform_get_drvdata(pdev);
751 struct orion_spi *spi = spi_master_get_devdata(master);
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700752
Russell King5c678692014-06-21 12:22:37 +0100753 pm_runtime_get_sync(&pdev->dev);
Gregory CLEMENT92ae1122018-01-12 11:42:33 +0100754 clk_disable_unprepare(spi->axi_clk);
Andrew Lunn4574b882012-04-06 17:17:26 +0200755 clk_disable_unprepare(spi->clk);
Andrew Lunn4574b882012-04-06 17:17:26 +0200756
Russell King5c678692014-06-21 12:22:37 +0100757 spi_unregister_master(master);
758 pm_runtime_disable(&pdev->dev);
759
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700760 return 0;
761}
762
763MODULE_ALIAS("platform:" DRIVER_NAME);
764
Rafael J. Wysockiec833052014-12-13 00:41:15 +0100765#ifdef CONFIG_PM
Russell King5c678692014-06-21 12:22:37 +0100766static int orion_spi_runtime_suspend(struct device *dev)
767{
768 struct spi_master *master = dev_get_drvdata(dev);
769 struct orion_spi *spi = spi_master_get_devdata(master);
770
Gregory CLEMENT92ae1122018-01-12 11:42:33 +0100771 clk_disable_unprepare(spi->axi_clk);
Russell King5c678692014-06-21 12:22:37 +0100772 clk_disable_unprepare(spi->clk);
773 return 0;
774}
775
776static int orion_spi_runtime_resume(struct device *dev)
777{
778 struct spi_master *master = dev_get_drvdata(dev);
779 struct orion_spi *spi = spi_master_get_devdata(master);
780
Gregory CLEMENT92ae1122018-01-12 11:42:33 +0100781 if (!IS_ERR(spi->axi_clk))
782 clk_prepare_enable(spi->axi_clk);
Russell King5c678692014-06-21 12:22:37 +0100783 return clk_prepare_enable(spi->clk);
784}
785#endif
786
787static const struct dev_pm_ops orion_spi_pm_ops = {
788 SET_RUNTIME_PM_OPS(orion_spi_runtime_suspend,
789 orion_spi_runtime_resume,
790 NULL)
791};
792
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700793static struct platform_driver orion_spi_driver = {
794 .driver = {
795 .name = DRIVER_NAME,
Russell King5c678692014-06-21 12:22:37 +0100796 .pm = &orion_spi_pm_ops,
Andrew Lunnf814f9a2012-07-23 12:08:09 +0200797 .of_match_table = of_match_ptr(orion_spi_of_match_table),
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700798 },
Ezequiel Garcia41ab7242013-02-04 09:26:26 -0300799 .probe = orion_spi_probe,
Grant Likely2deff8d2013-02-05 13:27:35 +0000800 .remove = orion_spi_remove,
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700801};
802
Ezequiel Garcia41ab7242013-02-04 09:26:26 -0300803module_platform_driver(orion_spi_driver);
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700804
805MODULE_DESCRIPTION("Orion SPI driver");
806MODULE_AUTHOR("Shadi Ammouri <shadi@marvell.com>");
807MODULE_LICENSE("GPL");