blob: 4b6dd73b80da0f034976e5781dd34089377e408c [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;
Greg Ungererdf59fa72014-09-28 23:24:04 +100097 const struct orion_spi_dev *devdata;
Stefan Roeseb3c195b2016-05-19 09:07:05 +020098
99 struct orion_direct_acc direct_access[ORION_NUM_CHIPSELECTS];
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700100};
101
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700102static inline void __iomem *spi_reg(struct orion_spi *orion_spi, u32 reg)
103{
104 return orion_spi->base + reg;
105}
106
107static inline void
108orion_spi_setbits(struct orion_spi *orion_spi, u32 reg, u32 mask)
109{
110 void __iomem *reg_addr = spi_reg(orion_spi, reg);
111 u32 val;
112
113 val = readl(reg_addr);
114 val |= mask;
115 writel(val, reg_addr);
116}
117
118static inline void
119orion_spi_clrbits(struct orion_spi *orion_spi, u32 reg, u32 mask)
120{
121 void __iomem *reg_addr = spi_reg(orion_spi, reg);
122 u32 val;
123
124 val = readl(reg_addr);
125 val &= ~mask;
126 writel(val, reg_addr);
127}
128
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700129static int orion_spi_baudrate_set(struct spi_device *spi, unsigned int speed)
130{
131 u32 tclk_hz;
132 u32 rate;
133 u32 prescale;
134 u32 reg;
135 struct orion_spi *orion_spi;
Greg Ungererdf59fa72014-09-28 23:24:04 +1000136 const struct orion_spi_dev *devdata;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700137
138 orion_spi = spi_master_get_devdata(spi->master);
Greg Ungererdf59fa72014-09-28 23:24:04 +1000139 devdata = orion_spi->devdata;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700140
Andrew Lunn4574b882012-04-06 17:17:26 +0200141 tclk_hz = clk_get_rate(orion_spi->clk);
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700142
Greg Ungererdf59fa72014-09-28 23:24:04 +1000143 if (devdata->typ == ARMADA_SPI) {
Uwe Kleine-König7243e0b2016-12-08 17:37:08 +0100144 /*
145 * Given the core_clk (tclk_hz) and the target rate (speed) we
146 * determine the best values for SPR (in [0 .. 15]) and SPPR (in
147 * [0..7]) such that
148 *
149 * core_clk / (SPR * 2 ** SPPR)
150 *
151 * is as big as possible but not bigger than speed.
152 */
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700153
Uwe Kleine-König7243e0b2016-12-08 17:37:08 +0100154 /* best integer divider: */
155 unsigned divider = DIV_ROUND_UP(tclk_hz, speed);
156 unsigned spr, sppr;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700157
Uwe Kleine-König7243e0b2016-12-08 17:37:08 +0100158 if (divider < 16) {
159 /* This is the easy case, divider is less than 16 */
160 spr = divider;
161 sppr = 0;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700162
Uwe Kleine-König7243e0b2016-12-08 17:37:08 +0100163 } else {
164 unsigned two_pow_sppr;
165 /*
166 * Find the highest bit set in divider. This and the
167 * three next bits define SPR (apart from rounding).
168 * SPPR is then the number of zero bits that must be
169 * appended:
170 */
171 sppr = fls(divider) - 4;
Greg Ungererdf59fa72014-09-28 23:24:04 +1000172
Uwe Kleine-König7243e0b2016-12-08 17:37:08 +0100173 /*
174 * As SPR only has 4 bits, we have to round divider up
175 * to the next multiple of 2 ** sppr.
176 */
177 two_pow_sppr = 1 << sppr;
178 divider = (divider + two_pow_sppr - 1) & -two_pow_sppr;
Greg Ungererdf59fa72014-09-28 23:24:04 +1000179
Uwe Kleine-König7243e0b2016-12-08 17:37:08 +0100180 /*
181 * recalculate sppr as rounding up divider might have
182 * increased it enough to change the position of the
183 * highest set bit. In this case the bit that now
184 * doesn't make it into SPR is 0, so there is no need to
185 * round again.
186 */
187 sppr = fls(divider) - 4;
188 spr = divider >> sppr;
189
190 /*
191 * Now do range checking. SPR is constructed to have a
192 * width of 4 bits, so this is fine for sure. So we
193 * still need to check for sppr to fit into 3 bits:
194 */
195 if (sppr > 7)
196 return -EINVAL;
Greg Ungererdf59fa72014-09-28 23:24:04 +1000197 }
198
Uwe Kleine-König7243e0b2016-12-08 17:37:08 +0100199 prescale = ((sppr & 0x6) << 5) | ((sppr & 0x1) << 4) | spr;
Greg Ungererdf59fa72014-09-28 23:24:04 +1000200 } else {
201 /*
202 * the supported rates are: 4,6,8...30
203 * round up as we look for equal or less speed
204 */
205 rate = DIV_ROUND_UP(tclk_hz, speed);
206 rate = roundup(rate, 2);
207
208 /* check if requested speed is too small */
209 if (rate > 30)
210 return -EINVAL;
211
212 if (rate < 4)
213 rate = 4;
214
215 /* Convert the rate to SPI clock divisor value. */
216 prescale = 0x10 + rate/2;
217 }
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700218
219 reg = readl(spi_reg(orion_spi, ORION_SPI_IF_CONFIG_REG));
Greg Ungererdf59fa72014-09-28 23:24:04 +1000220 reg = ((reg & ~devdata->prescale_mask) | prescale);
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700221 writel(reg, spi_reg(orion_spi, ORION_SPI_IF_CONFIG_REG));
222
223 return 0;
224}
225
Jason Gunthorpeb15d5d72012-11-21 12:23:35 -0700226static void
227orion_spi_mode_set(struct spi_device *spi)
228{
229 u32 reg;
230 struct orion_spi *orion_spi;
231
232 orion_spi = spi_master_get_devdata(spi->master);
233
234 reg = readl(spi_reg(orion_spi, ORION_SPI_IF_CONFIG_REG));
235 reg &= ~ORION_SPI_MODE_MASK;
236 if (spi->mode & SPI_CPOL)
237 reg |= ORION_SPI_MODE_CPOL;
238 if (spi->mode & SPI_CPHA)
239 reg |= ORION_SPI_MODE_CPHA;
Bastian Stender1017f422017-04-07 15:52:33 +0200240 if (spi->mode & SPI_LSB_FIRST)
241 reg |= ORION_SPI_IF_RXLSBF | ORION_SPI_IF_TXLSBF;
242 else
243 reg &= ~(ORION_SPI_IF_RXLSBF | ORION_SPI_IF_TXLSBF);
244
Jason Gunthorpeb15d5d72012-11-21 12:23:35 -0700245 writel(reg, spi_reg(orion_spi, ORION_SPI_IF_CONFIG_REG));
246}
247
Nadav Haklai38d62112015-08-11 11:58:47 +0200248static void
249orion_spi_50mhz_ac_timing_erratum(struct spi_device *spi, unsigned int speed)
250{
251 u32 reg;
252 struct orion_spi *orion_spi;
253
254 orion_spi = spi_master_get_devdata(spi->master);
255
256 /*
257 * Erratum description: (Erratum NO. FE-9144572) The device
258 * SPI interface supports frequencies of up to 50 MHz.
259 * However, due to this erratum, when the device core clock is
260 * 250 MHz and the SPI interfaces is configured for 50MHz SPI
261 * clock and CPOL=CPHA=1 there might occur data corruption on
262 * reads from the SPI device.
263 * Erratum Workaround:
264 * Work in one of the following configurations:
265 * 1. Set CPOL=CPHA=0 in "SPI Interface Configuration
266 * Register".
267 * 2. Set TMISO_SAMPLE value to 0x2 in "SPI Timing Parameters 1
268 * Register" before setting the interface.
269 */
270 reg = readl(spi_reg(orion_spi, ORION_SPI_TIMING_PARAMS_REG));
271 reg &= ~ORION_SPI_TMISO_SAMPLE_MASK;
272
273 if (clk_get_rate(orion_spi->clk) == 250000000 &&
274 speed == 50000000 && spi->mode & SPI_CPOL &&
275 spi->mode & SPI_CPHA)
276 reg |= ORION_SPI_TMISO_SAMPLE_2;
277 else
278 reg |= ORION_SPI_TMISO_SAMPLE_1; /* This is the default value */
279
280 writel(reg, spi_reg(orion_spi, ORION_SPI_TIMING_PARAMS_REG));
281}
282
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700283/*
284 * called only when no transfer is active on the bus
285 */
286static int
287orion_spi_setup_transfer(struct spi_device *spi, struct spi_transfer *t)
288{
289 struct orion_spi *orion_spi;
290 unsigned int speed = spi->max_speed_hz;
291 unsigned int bits_per_word = spi->bits_per_word;
292 int rc;
293
294 orion_spi = spi_master_get_devdata(spi->master);
295
296 if ((t != NULL) && t->speed_hz)
297 speed = t->speed_hz;
298
299 if ((t != NULL) && t->bits_per_word)
300 bits_per_word = t->bits_per_word;
301
Jason Gunthorpeb15d5d72012-11-21 12:23:35 -0700302 orion_spi_mode_set(spi);
303
Nadav Haklai38d62112015-08-11 11:58:47 +0200304 if (orion_spi->devdata->is_errata_50mhz_ac)
305 orion_spi_50mhz_ac_timing_erratum(spi, speed);
306
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700307 rc = orion_spi_baudrate_set(spi, speed);
308 if (rc)
309 return rc;
310
Axel Lin495b3352014-02-11 20:51:36 +0800311 if (bits_per_word == 16)
312 orion_spi_setbits(orion_spi, ORION_SPI_IF_CONFIG_REG,
313 ORION_SPI_IF_8_16_BIT_MODE);
314 else
315 orion_spi_clrbits(orion_spi, ORION_SPI_IF_CONFIG_REG,
316 ORION_SPI_IF_8_16_BIT_MODE);
317
318 return 0;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700319}
320
Ken Wilson75872eb2015-01-12 13:13:59 +1000321static void orion_spi_set_cs(struct spi_device *spi, bool enable)
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700322{
Ken Wilson75872eb2015-01-12 13:13:59 +1000323 struct orion_spi *orion_spi;
Chris Packhamb28b9142017-05-23 16:03:21 +1200324 int cs;
325
326 if (gpio_is_valid(spi->cs_gpio))
327 cs = 0;
328 else
329 cs = spi->chip_select;
Ken Wilson75872eb2015-01-12 13:13:59 +1000330
331 orion_spi = spi_master_get_devdata(spi->master);
332
Ken Wilson23244402015-01-16 13:10:47 +1000333 orion_spi_clrbits(orion_spi, ORION_SPI_IF_CTRL_REG, ORION_SPI_CS_MASK);
334 orion_spi_setbits(orion_spi, ORION_SPI_IF_CTRL_REG,
Chris Packhamb28b9142017-05-23 16:03:21 +1200335 ORION_SPI_CS(cs));
Ken Wilson23244402015-01-16 13:10:47 +1000336
Ken Wilson75872eb2015-01-12 13:13:59 +1000337 /* Chip select logic is inverted from spi_set_cs */
338 if (!enable)
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700339 orion_spi_setbits(orion_spi, ORION_SPI_IF_CTRL_REG, 0x1);
340 else
341 orion_spi_clrbits(orion_spi, ORION_SPI_IF_CTRL_REG, 0x1);
342}
343
344static inline int orion_spi_wait_till_ready(struct orion_spi *orion_spi)
345{
346 int i;
347
348 for (i = 0; i < ORION_SPI_WAIT_RDY_MAX_LOOP; i++) {
349 if (readl(spi_reg(orion_spi, ORION_SPI_INT_CAUSE_REG)))
350 return 1;
Jingoo Hanb8434042014-09-02 11:51:39 +0900351
352 udelay(1);
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700353 }
354
355 return -1;
356}
357
358static inline int
359orion_spi_write_read_8bit(struct spi_device *spi,
360 const u8 **tx_buf, u8 **rx_buf)
361{
362 void __iomem *tx_reg, *rx_reg, *int_reg;
363 struct orion_spi *orion_spi;
364
365 orion_spi = spi_master_get_devdata(spi->master);
366 tx_reg = spi_reg(orion_spi, ORION_SPI_DATA_OUT_REG);
367 rx_reg = spi_reg(orion_spi, ORION_SPI_DATA_IN_REG);
368 int_reg = spi_reg(orion_spi, ORION_SPI_INT_CAUSE_REG);
369
370 /* clear the interrupt cause register */
371 writel(0x0, int_reg);
372
373 if (tx_buf && *tx_buf)
374 writel(*(*tx_buf)++, tx_reg);
375 else
376 writel(0, tx_reg);
377
378 if (orion_spi_wait_till_ready(orion_spi) < 0) {
379 dev_err(&spi->dev, "TXS timed out\n");
380 return -1;
381 }
382
383 if (rx_buf && *rx_buf)
384 *(*rx_buf)++ = readl(rx_reg);
385
386 return 1;
387}
388
389static inline int
390orion_spi_write_read_16bit(struct spi_device *spi,
391 const u16 **tx_buf, u16 **rx_buf)
392{
393 void __iomem *tx_reg, *rx_reg, *int_reg;
394 struct orion_spi *orion_spi;
395
396 orion_spi = spi_master_get_devdata(spi->master);
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(__cpu_to_le16(get_unaligned((*tx_buf)++)), tx_reg);
406 else
407 writel(0, tx_reg);
408
409 if (orion_spi_wait_till_ready(orion_spi) < 0) {
410 dev_err(&spi->dev, "TXS timed out\n");
411 return -1;
412 }
413
414 if (rx_buf && *rx_buf)
415 put_unaligned(__le16_to_cpu(readl(rx_reg)), (*rx_buf)++);
416
417 return 1;
418}
419
420static unsigned int
421orion_spi_write_read(struct spi_device *spi, struct spi_transfer *xfer)
422{
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700423 unsigned int count;
424 int word_len;
Stefan Roeseb3c195b2016-05-19 09:07:05 +0200425 struct orion_spi *orion_spi;
426 int cs = spi->chip_select;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700427
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700428 word_len = spi->bits_per_word;
429 count = xfer->len;
430
Stefan Roeseb3c195b2016-05-19 09:07:05 +0200431 orion_spi = spi_master_get_devdata(spi->master);
432
433 /*
434 * Use SPI direct write mode if base address is available. Otherwise
435 * fall back to PIO mode for this transfer.
436 */
437 if ((orion_spi->direct_access[cs].vaddr) && (xfer->tx_buf) &&
438 (word_len == 8)) {
439 unsigned int cnt = count / 4;
440 unsigned int rem = count % 4;
441
442 /*
443 * Send the TX-data to the SPI device via the direct
444 * mapped address window
445 */
446 iowrite32_rep(orion_spi->direct_access[cs].vaddr,
447 xfer->tx_buf, cnt);
448 if (rem) {
449 u32 *buf = (u32 *)xfer->tx_buf;
450
451 iowrite8_rep(orion_spi->direct_access[cs].vaddr,
452 &buf[cnt], rem);
453 }
454
455 return count;
456 }
457
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700458 if (word_len == 8) {
459 const u8 *tx = xfer->tx_buf;
460 u8 *rx = xfer->rx_buf;
461
462 do {
463 if (orion_spi_write_read_8bit(spi, &tx, &rx) < 0)
464 goto out;
465 count--;
466 } while (count);
467 } else if (word_len == 16) {
468 const u16 *tx = xfer->tx_buf;
469 u16 *rx = xfer->rx_buf;
470
471 do {
472 if (orion_spi_write_read_16bit(spi, &tx, &rx) < 0)
473 goto out;
474 count -= 2;
475 } while (count);
476 }
477
478out:
479 return xfer->len - count;
480}
481
Ken Wilson75872eb2015-01-12 13:13:59 +1000482static int orion_spi_transfer_one(struct spi_master *master,
483 struct spi_device *spi,
484 struct spi_transfer *t)
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700485{
Andrew Lunnba59a802012-07-23 13:16:55 +0200486 int status = 0;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700487
Ken Wilson75872eb2015-01-12 13:13:59 +1000488 status = orion_spi_setup_transfer(spi, t);
Andrew Lunnba59a802012-07-23 13:16:55 +0200489 if (status < 0)
Ken Wilson75872eb2015-01-12 13:13:59 +1000490 return status;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700491
Ken Wilson75872eb2015-01-12 13:13:59 +1000492 if (t->len)
493 orion_spi_write_read(spi, t);
Andrew Lunnba59a802012-07-23 13:16:55 +0200494
Ken Wilson75872eb2015-01-12 13:13:59 +1000495 return status;
496}
Andrew Lunnba59a802012-07-23 13:16:55 +0200497
Ken Wilson75872eb2015-01-12 13:13:59 +1000498static int orion_spi_setup(struct spi_device *spi)
499{
500 return orion_spi_setup_transfer(spi, NULL);
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700501}
502
Grant Likely2deff8d2013-02-05 13:27:35 +0000503static int orion_spi_reset(struct orion_spi *orion_spi)
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700504{
505 /* Verify that the CS is deasserted */
Ken Wilson75872eb2015-01-12 13:13:59 +1000506 orion_spi_clrbits(orion_spi, ORION_SPI_IF_CTRL_REG, 0x1);
Stefan Roeseb3c195b2016-05-19 09:07:05 +0200507
508 /* Don't deassert CS between the direct mapped SPI transfers */
509 writel(0, spi_reg(orion_spi, SPI_DIRECT_WRITE_CONFIG_REG));
510
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700511 return 0;
512}
513
Greg Ungererdf59fa72014-09-28 23:24:04 +1000514static const struct orion_spi_dev orion_spi_dev_data = {
515 .typ = ORION_SPI,
516 .min_divisor = 4,
517 .max_divisor = 30,
518 .prescale_mask = ORION_SPI_CLK_PRESCALE_MASK,
519};
520
Gregory CLEMENT4dacccf2015-05-26 11:44:43 +0200521static const struct orion_spi_dev armada_370_spi_dev_data = {
Greg Ungererdf59fa72014-09-28 23:24:04 +1000522 .typ = ARMADA_SPI,
Gregory CLEMENTce2f6ea2015-05-26 11:44:42 +0200523 .min_divisor = 4,
Greg Ungererdf59fa72014-09-28 23:24:04 +1000524 .max_divisor = 1920,
Gregory CLEMENTce2f6ea2015-05-26 11:44:42 +0200525 .max_hz = 50000000,
Greg Ungererdf59fa72014-09-28 23:24:04 +1000526 .prescale_mask = ARMADA_SPI_CLK_PRESCALE_MASK,
527};
528
Gregory CLEMENT4dacccf2015-05-26 11:44:43 +0200529static const struct orion_spi_dev armada_xp_spi_dev_data = {
530 .typ = ARMADA_SPI,
531 .max_hz = 50000000,
532 .max_divisor = 1920,
533 .prescale_mask = ARMADA_SPI_CLK_PRESCALE_MASK,
534};
535
536static const struct orion_spi_dev armada_375_spi_dev_data = {
537 .typ = ARMADA_SPI,
538 .min_divisor = 15,
539 .max_divisor = 1920,
540 .prescale_mask = ARMADA_SPI_CLK_PRESCALE_MASK,
541};
542
Nadav Haklai38d62112015-08-11 11:58:47 +0200543static const struct orion_spi_dev armada_380_spi_dev_data = {
544 .typ = ARMADA_SPI,
545 .max_hz = 50000000,
546 .max_divisor = 1920,
547 .prescale_mask = ARMADA_SPI_CLK_PRESCALE_MASK,
548 .is_errata_50mhz_ac = true,
549};
550
Greg Ungererdf59fa72014-09-28 23:24:04 +1000551static const struct of_device_id orion_spi_of_match_table[] = {
Gregory CLEMENT4dacccf2015-05-26 11:44:43 +0200552 {
553 .compatible = "marvell,orion-spi",
554 .data = &orion_spi_dev_data,
555 },
556 {
557 .compatible = "marvell,armada-370-spi",
558 .data = &armada_370_spi_dev_data,
559 },
560 {
561 .compatible = "marvell,armada-375-spi",
562 .data = &armada_375_spi_dev_data,
563 },
564 {
565 .compatible = "marvell,armada-380-spi",
Nadav Haklai38d62112015-08-11 11:58:47 +0200566 .data = &armada_380_spi_dev_data,
Gregory CLEMENT4dacccf2015-05-26 11:44:43 +0200567 },
568 {
569 .compatible = "marvell,armada-390-spi",
570 .data = &armada_xp_spi_dev_data,
571 },
572 {
573 .compatible = "marvell,armada-xp-spi",
574 .data = &armada_xp_spi_dev_data,
575 },
576
Greg Ungererdf59fa72014-09-28 23:24:04 +1000577 {}
578};
579MODULE_DEVICE_TABLE(of, orion_spi_of_match_table);
580
Grant Likely2deff8d2013-02-05 13:27:35 +0000581static int orion_spi_probe(struct platform_device *pdev)
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700582{
Greg Ungererdf59fa72014-09-28 23:24:04 +1000583 const struct of_device_id *of_id;
584 const struct orion_spi_dev *devdata;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700585 struct spi_master *master;
586 struct orion_spi *spi;
587 struct resource *r;
Andrew Lunn4574b882012-04-06 17:17:26 +0200588 unsigned long tclk_hz;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700589 int status = 0;
Stefan Roeseb3c195b2016-05-19 09:07:05 +0200590 struct device_node *np;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700591
Jingoo Han3fed8062013-10-14 10:35:08 +0900592 master = spi_alloc_master(&pdev->dev, sizeof(*spi));
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700593 if (master == NULL) {
594 dev_dbg(&pdev->dev, "master allocation failed\n");
595 return -ENOMEM;
596 }
597
598 if (pdev->id != -1)
599 master->bus_num = pdev->id;
Andrew Lunnf814f9a2012-07-23 12:08:09 +0200600 if (pdev->dev.of_node) {
Thomas Petazzonie06871c2014-07-27 23:53:19 +0200601 u32 cell_index;
Jingoo Hanb8434042014-09-02 11:51:39 +0900602
Thomas Petazzonie06871c2014-07-27 23:53:19 +0200603 if (!of_property_read_u32(pdev->dev.of_node, "cell-index",
604 &cell_index))
605 master->bus_num = cell_index;
Andrew Lunnf814f9a2012-07-23 12:08:09 +0200606 }
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700607
Bastian Stender1017f422017-04-07 15:52:33 +0200608 /* we support all 4 SPI modes and LSB first option */
609 master->mode_bits = SPI_CPHA | SPI_CPOL | SPI_LSB_FIRST;
Ken Wilson75872eb2015-01-12 13:13:59 +1000610 master->set_cs = orion_spi_set_cs;
611 master->transfer_one = orion_spi_transfer_one;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700612 master->num_chipselect = ORION_NUM_CHIPSELECTS;
Ken Wilson75872eb2015-01-12 13:13:59 +1000613 master->setup = orion_spi_setup;
Axel Lin495b3352014-02-11 20:51:36 +0800614 master->bits_per_word_mask = SPI_BPW_MASK(8) | SPI_BPW_MASK(16);
Russell King5c678692014-06-21 12:22:37 +0100615 master->auto_runtime_pm = true;
Chris Packhamb28b9142017-05-23 16:03:21 +1200616 master->flags = SPI_MASTER_GPIO_SS;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700617
Jingoo Han24b5a822013-05-23 19:20:40 +0900618 platform_set_drvdata(pdev, master);
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700619
620 spi = spi_master_get_devdata(master);
621 spi->master = master;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700622
Greg Ungererdf59fa72014-09-28 23:24:04 +1000623 of_id = of_match_device(orion_spi_of_match_table, &pdev->dev);
Greg Ungerer9a2d3632014-10-21 15:57:48 +1000624 devdata = (of_id) ? of_id->data : &orion_spi_dev_data;
Greg Ungererdf59fa72014-09-28 23:24:04 +1000625 spi->devdata = devdata;
626
Jingoo Hanbb489842013-12-09 19:21:22 +0900627 spi->clk = devm_clk_get(&pdev->dev, NULL);
Andrew Lunn4574b882012-04-06 17:17:26 +0200628 if (IS_ERR(spi->clk)) {
629 status = PTR_ERR(spi->clk);
630 goto out;
631 }
632
Russell Kingc85012a2014-06-21 11:32:23 +0100633 status = clk_prepare_enable(spi->clk);
634 if (status)
635 goto out;
636
Andrew Lunn4574b882012-04-06 17:17:26 +0200637 tclk_hz = clk_get_rate(spi->clk);
Gregory CLEMENTce2f6ea2015-05-26 11:44:42 +0200638
639 /*
640 * With old device tree, armada-370-spi could be used with
641 * Armada XP, however for this SoC the maximum frequency is
642 * 50MHz instead of tclk/4. On Armada 370, tclk cannot be
643 * higher than 200MHz. So, in order to be able to handle both
644 * SoCs, we can take the minimum of 50MHz and tclk/4.
645 */
646 if (of_device_is_compatible(pdev->dev.of_node,
647 "marvell,armada-370-spi"))
648 master->max_speed_hz = min(devdata->max_hz,
649 DIV_ROUND_UP(tclk_hz, devdata->min_divisor));
Gregory CLEMENT4dacccf2015-05-26 11:44:43 +0200650 else if (devdata->min_divisor)
Gregory CLEMENTce2f6ea2015-05-26 11:44:42 +0200651 master->max_speed_hz =
652 DIV_ROUND_UP(tclk_hz, devdata->min_divisor);
Gregory CLEMENT4dacccf2015-05-26 11:44:43 +0200653 else
654 master->max_speed_hz = devdata->max_hz;
Greg Ungererdf59fa72014-09-28 23:24:04 +1000655 master->min_speed_hz = DIV_ROUND_UP(tclk_hz, devdata->max_divisor);
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700656
657 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
Mark Brown1729ce32013-07-28 14:38:06 +0100658 spi->base = devm_ioremap_resource(&pdev->dev, r);
659 if (IS_ERR(spi->base)) {
660 status = PTR_ERR(spi->base);
Andrew Lunn4574b882012-04-06 17:17:26 +0200661 goto out_rel_clk;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700662 }
663
Stefan Roeseb3c195b2016-05-19 09:07:05 +0200664 /* Scan all SPI devices of this controller for direct mapped devices */
665 for_each_available_child_of_node(pdev->dev.of_node, np) {
666 u32 cs;
667
668 /* Get chip-select number from the "reg" property */
669 status = of_property_read_u32(np, "reg", &cs);
670 if (status) {
671 dev_err(&pdev->dev,
Rob Herring25c56c82017-07-18 16:43:31 -0500672 "%pOF has no valid 'reg' property (%d)\n",
673 np, status);
Stefan Roeseb3c195b2016-05-19 09:07:05 +0200674 status = 0;
675 continue;
676 }
677
678 /*
679 * Check if an address is configured for this SPI device. If
680 * not, the MBus mapping via the 'ranges' property in the 'soc'
681 * node is not configured and this device should not use the
682 * direct mode. In this case, just continue with the next
683 * device.
684 */
685 status = of_address_to_resource(pdev->dev.of_node, cs + 1, r);
686 if (status)
687 continue;
688
689 /*
690 * Only map one page for direct access. This is enough for the
691 * simple TX transfer which only writes to the first word.
692 * This needs to get extended for the direct SPI-NOR / SPI-NAND
693 * support, once this gets implemented.
694 */
695 spi->direct_access[cs].vaddr = devm_ioremap(&pdev->dev,
696 r->start,
697 PAGE_SIZE);
Wei Yongjun57c624a2016-06-13 14:32:23 +0000698 if (!spi->direct_access[cs].vaddr) {
699 status = -ENOMEM;
Stefan Roeseb3c195b2016-05-19 09:07:05 +0200700 goto out_rel_clk;
701 }
702 spi->direct_access[cs].size = PAGE_SIZE;
703
704 dev_info(&pdev->dev, "CS%d configured for direct access\n", cs);
705 }
706
Russell King5c678692014-06-21 12:22:37 +0100707 pm_runtime_set_active(&pdev->dev);
708 pm_runtime_use_autosuspend(&pdev->dev);
709 pm_runtime_set_autosuspend_delay(&pdev->dev, SPI_AUTOSUSPEND_TIMEOUT);
710 pm_runtime_enable(&pdev->dev);
711
Wei Yongjun14033812014-07-20 22:03:14 +0800712 status = orion_spi_reset(spi);
713 if (status < 0)
Russell King5c678692014-06-21 12:22:37 +0100714 goto out_rel_pm;
715
716 pm_runtime_mark_last_busy(&pdev->dev);
717 pm_runtime_put_autosuspend(&pdev->dev);
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700718
Andrew Lunnf814f9a2012-07-23 12:08:09 +0200719 master->dev.of_node = pdev->dev.of_node;
Russell King5c678692014-06-21 12:22:37 +0100720 status = spi_register_master(master);
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700721 if (status < 0)
Russell King5c678692014-06-21 12:22:37 +0100722 goto out_rel_pm;
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700723
724 return status;
725
Russell King5c678692014-06-21 12:22:37 +0100726out_rel_pm:
727 pm_runtime_disable(&pdev->dev);
Andrew Lunn4574b882012-04-06 17:17:26 +0200728out_rel_clk:
729 clk_disable_unprepare(spi->clk);
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700730out:
731 spi_master_put(master);
732 return status;
733}
734
735
Grant Likely2deff8d2013-02-05 13:27:35 +0000736static int orion_spi_remove(struct platform_device *pdev)
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700737{
Russell King5c678692014-06-21 12:22:37 +0100738 struct spi_master *master = platform_get_drvdata(pdev);
739 struct orion_spi *spi = spi_master_get_devdata(master);
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700740
Russell King5c678692014-06-21 12:22:37 +0100741 pm_runtime_get_sync(&pdev->dev);
Andrew Lunn4574b882012-04-06 17:17:26 +0200742 clk_disable_unprepare(spi->clk);
Andrew Lunn4574b882012-04-06 17:17:26 +0200743
Russell King5c678692014-06-21 12:22:37 +0100744 spi_unregister_master(master);
745 pm_runtime_disable(&pdev->dev);
746
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700747 return 0;
748}
749
750MODULE_ALIAS("platform:" DRIVER_NAME);
751
Rafael J. Wysockiec833052014-12-13 00:41:15 +0100752#ifdef CONFIG_PM
Russell King5c678692014-06-21 12:22:37 +0100753static int orion_spi_runtime_suspend(struct device *dev)
754{
755 struct spi_master *master = dev_get_drvdata(dev);
756 struct orion_spi *spi = spi_master_get_devdata(master);
757
758 clk_disable_unprepare(spi->clk);
759 return 0;
760}
761
762static int orion_spi_runtime_resume(struct device *dev)
763{
764 struct spi_master *master = dev_get_drvdata(dev);
765 struct orion_spi *spi = spi_master_get_devdata(master);
766
767 return clk_prepare_enable(spi->clk);
768}
769#endif
770
771static const struct dev_pm_ops orion_spi_pm_ops = {
772 SET_RUNTIME_PM_OPS(orion_spi_runtime_suspend,
773 orion_spi_runtime_resume,
774 NULL)
775};
776
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700777static struct platform_driver orion_spi_driver = {
778 .driver = {
779 .name = DRIVER_NAME,
Russell King5c678692014-06-21 12:22:37 +0100780 .pm = &orion_spi_pm_ops,
Andrew Lunnf814f9a2012-07-23 12:08:09 +0200781 .of_match_table = of_match_ptr(orion_spi_of_match_table),
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700782 },
Ezequiel Garcia41ab7242013-02-04 09:26:26 -0300783 .probe = orion_spi_probe,
Grant Likely2deff8d2013-02-05 13:27:35 +0000784 .remove = orion_spi_remove,
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700785};
786
Ezequiel Garcia41ab7242013-02-04 09:26:26 -0300787module_platform_driver(orion_spi_driver);
Shadi Ammouri60cadec2008-08-05 13:01:09 -0700788
789MODULE_DESCRIPTION("Orion SPI driver");
790MODULE_AUTHOR("Shadi Ammouri <shadi@marvell.com>");
791MODULE_LICENSE("GPL");