1 // SPDX-License-Identifier: (GPL-2.0)
3 * Microchip CoreSPI SPI controller driver
5 * Copyright (c) 2018-2022 Microchip Technology Inc. and its subsidiaries
12 #include <linux/clk.h>
13 #include <linux/delay.h>
14 #include <linux/err.h>
15 #include <linux/init.h>
16 #include <linux/interrupt.h>
18 #include <linux/module.h>
20 #include <linux/platform_device.h>
21 #include <linux/spi/spi.h>
23 #define MAX_LEN (0xffff)
25 #define DEFAULT_FRAMESIZE (8)
26 #define FIFO_DEPTH (32)
27 #define CLK_GEN_MODE1_MAX (255)
28 #define CLK_GEN_MODE0_MAX (15)
29 #define CLK_GEN_MIN (0)
30 #define MODE_X_MASK_SHIFT (24)
32 #define CONTROL_ENABLE BIT(0)
33 #define CONTROL_MASTER BIT(1)
34 #define CONTROL_RX_DATA_INT BIT(4)
35 #define CONTROL_TX_DATA_INT BIT(5)
36 #define CONTROL_RX_OVER_INT BIT(6)
37 #define CONTROL_TX_UNDER_INT BIT(7)
38 #define CONTROL_SPO BIT(24)
39 #define CONTROL_SPH BIT(25)
40 #define CONTROL_SPS BIT(26)
41 #define CONTROL_FRAMEURUN BIT(27)
42 #define CONTROL_CLKMODE BIT(28)
43 #define CONTROL_BIGFIFO BIT(29)
44 #define CONTROL_OENOFF BIT(30)
45 #define CONTROL_RESET BIT(31)
47 #define CONTROL_MODE_MASK GENMASK(3, 2)
48 #define MOTOROLA_MODE (0)
49 #define CONTROL_FRAMECNT_MASK GENMASK(23, 8)
50 #define CONTROL_FRAMECNT_SHIFT (8)
52 #define STATUS_ACTIVE BIT(14)
53 #define STATUS_SSEL BIT(13)
54 #define STATUS_FRAMESTART BIT(12)
55 #define STATUS_TXFIFO_EMPTY_NEXT_READ BIT(11)
56 #define STATUS_TXFIFO_EMPTY BIT(10)
57 #define STATUS_TXFIFO_FULL_NEXT_WRITE BIT(9)
58 #define STATUS_TXFIFO_FULL BIT(8)
59 #define STATUS_RXFIFO_EMPTY_NEXT_READ BIT(7)
60 #define STATUS_RXFIFO_EMPTY BIT(6)
61 #define STATUS_RXFIFO_FULL_NEXT_WRITE BIT(5)
62 #define STATUS_RXFIFO_FULL BIT(4)
63 #define STATUS_TX_UNDERRUN BIT(3)
64 #define STATUS_RX_OVERFLOW BIT(2)
65 #define STATUS_RXDAT_RXED BIT(1)
66 #define STATUS_TXDAT_SENT BIT(0)
68 #define INT_TXDONE BIT(0)
69 #define INT_RXRDY BIT(1)
70 #define INT_RX_CHANNEL_OVERFLOW BIT(2)
71 #define INT_TX_CHANNEL_UNDERRUN BIT(3)
73 #define INT_ENABLE_MASK (CONTROL_RX_DATA_INT | CONTROL_TX_DATA_INT | \
74 CONTROL_RX_OVER_INT | CONTROL_TX_UNDER_INT)
76 #define REG_CONTROL (0x00)
77 #define REG_FRAME_SIZE (0x04)
78 #define REG_STATUS (0x08)
79 #define REG_INT_CLEAR (0x0c)
80 #define REG_RX_DATA (0x10)
81 #define REG_TX_DATA (0x14)
82 #define REG_CLK_GEN (0x18)
83 #define REG_SLAVE_SELECT (0x1c)
84 #define SSEL_MASK GENMASK(7, 0)
85 #define SSEL_DIRECT BIT(8)
86 #define SSELOUT_SHIFT 9
87 #define SSELOUT BIT(SSELOUT_SHIFT)
88 #define REG_MIS (0x20)
89 #define REG_RIS (0x24)
90 #define REG_CONTROL2 (0x28)
91 #define REG_COMMAND (0x2c)
92 #define REG_PKTSIZE (0x30)
93 #define REG_CMD_SIZE (0x34)
94 #define REG_HWSTATUS (0x38)
95 #define REG_STAT8 (0x3c)
96 #define REG_CTRL2 (0x48)
97 #define REG_FRAMESUP (0x50)
104 u32 clk_gen; /* divider for spi output clock generated by the controller */
112 static inline u32 mchp_corespi_read(struct mchp_corespi *spi, unsigned int reg)
114 return readl(spi->regs + reg);
117 static inline void mchp_corespi_write(struct mchp_corespi *spi, unsigned int reg, u32 val)
119 writel(val, spi->regs + reg);
122 static inline void mchp_corespi_disable(struct mchp_corespi *spi)
124 u32 control = mchp_corespi_read(spi, REG_CONTROL);
126 control &= ~CONTROL_ENABLE;
128 mchp_corespi_write(spi, REG_CONTROL, control);
131 static inline void mchp_corespi_read_fifo(struct mchp_corespi *spi)
136 fifo_max = min(spi->rx_len, FIFO_DEPTH);
138 while ((i < fifo_max) && !(mchp_corespi_read(spi, REG_STATUS) & STATUS_RXFIFO_EMPTY)) {
139 data = mchp_corespi_read(spi, REG_RX_DATA);
142 *spi->rx_buf++ = data;
149 static void mchp_corespi_enable_ints(struct mchp_corespi *spi)
151 u32 control, mask = INT_ENABLE_MASK;
153 mchp_corespi_disable(spi);
155 control = mchp_corespi_read(spi, REG_CONTROL);
158 mchp_corespi_write(spi, REG_CONTROL, control);
160 control |= CONTROL_ENABLE;
161 mchp_corespi_write(spi, REG_CONTROL, control);
164 static void mchp_corespi_disable_ints(struct mchp_corespi *spi)
166 u32 control, mask = INT_ENABLE_MASK;
168 mchp_corespi_disable(spi);
170 control = mchp_corespi_read(spi, REG_CONTROL);
172 mchp_corespi_write(spi, REG_CONTROL, control);
174 control |= CONTROL_ENABLE;
175 mchp_corespi_write(spi, REG_CONTROL, control);
178 static inline void mchp_corespi_set_xfer_size(struct mchp_corespi *spi, int len)
184 * Disable the SPI controller. Writes to transfer length have
185 * no effect when the controller is enabled.
187 mchp_corespi_disable(spi);
190 * The lower 16 bits of the frame count are stored in the control reg
191 * for legacy reasons, but the upper 16 written to a different register:
192 * FRAMESUP. While both the upper and lower bits can be *READ* from the
193 * FRAMESUP register, writing to the lower 16 bits is a NOP
195 lenpart = len & 0xffff;
197 control = mchp_corespi_read(spi, REG_CONTROL);
198 control &= ~CONTROL_FRAMECNT_MASK;
199 control |= lenpart << CONTROL_FRAMECNT_SHIFT;
200 mchp_corespi_write(spi, REG_CONTROL, control);
202 lenpart = len & 0xffff0000;
203 mchp_corespi_write(spi, REG_FRAMESUP, lenpart);
205 control |= CONTROL_ENABLE;
206 mchp_corespi_write(spi, REG_CONTROL, control);
209 static inline void mchp_corespi_write_fifo(struct mchp_corespi *spi)
214 fifo_max = min(spi->tx_len, FIFO_DEPTH);
215 mchp_corespi_set_xfer_size(spi, fifo_max);
217 while ((i < fifo_max) && !(mchp_corespi_read(spi, REG_STATUS) & STATUS_TXFIFO_FULL)) {
218 byte = spi->tx_buf ? *spi->tx_buf++ : 0xaa;
219 mchp_corespi_write(spi, REG_TX_DATA, byte);
227 static inline void mchp_corespi_set_framesize(struct mchp_corespi *spi, int bt)
232 * Disable the SPI controller. Writes to the frame size have
233 * no effect when the controller is enabled.
235 mchp_corespi_disable(spi);
237 mchp_corespi_write(spi, REG_FRAME_SIZE, bt);
239 control = mchp_corespi_read(spi, REG_CONTROL);
240 control |= CONTROL_ENABLE;
241 mchp_corespi_write(spi, REG_CONTROL, control);
244 static void mchp_corespi_set_cs(struct spi_device *spi, bool disable)
247 struct mchp_corespi *corespi = spi_controller_get_devdata(spi->controller);
249 reg = mchp_corespi_read(corespi, REG_SLAVE_SELECT);
250 reg &= ~BIT(spi_get_chipselect(spi, 0));
251 reg |= !disable << spi_get_chipselect(spi, 0);
253 mchp_corespi_write(corespi, REG_SLAVE_SELECT, reg);
256 static int mchp_corespi_setup(struct spi_device *spi)
258 struct mchp_corespi *corespi = spi_controller_get_devdata(spi->controller);
262 * Active high targets need to be specifically set to their inactive
263 * states during probe by adding them to the "control group" & thus
264 * driving their select line low.
266 if (spi->mode & SPI_CS_HIGH) {
267 reg = mchp_corespi_read(corespi, REG_SLAVE_SELECT);
268 reg |= BIT(spi_get_chipselect(spi, 0));
269 mchp_corespi_write(corespi, REG_SLAVE_SELECT, reg);
274 static void mchp_corespi_init(struct spi_controller *host, struct mchp_corespi *spi)
276 unsigned long clk_hz;
277 u32 control = mchp_corespi_read(spi, REG_CONTROL);
279 control |= CONTROL_MASTER;
281 control &= ~CONTROL_MODE_MASK;
282 control |= MOTOROLA_MODE;
284 mchp_corespi_set_framesize(spi, DEFAULT_FRAMESIZE);
286 /* max. possible spi clock rate is the apb clock rate */
287 clk_hz = clk_get_rate(spi->clk);
288 host->max_speed_hz = clk_hz;
291 * The controller must be configured so that it doesn't remove Chip
292 * Select until the entire message has been transferred, even if at
293 * some points TX FIFO becomes empty.
295 * BIGFIFO mode is also enabled, which sets the fifo depth to 32 frames
296 * for the 8 bit transfers that this driver uses.
298 control = mchp_corespi_read(spi, REG_CONTROL);
299 control |= CONTROL_SPS | CONTROL_BIGFIFO;
301 mchp_corespi_write(spi, REG_CONTROL, control);
303 mchp_corespi_enable_ints(spi);
306 * It is required to enable direct mode, otherwise control over the chip
307 * select is relinquished to the hardware. SSELOUT is enabled too so we
308 * can deal with active high targets.
310 mchp_corespi_write(spi, REG_SLAVE_SELECT, SSELOUT | SSEL_DIRECT);
312 control = mchp_corespi_read(spi, REG_CONTROL);
314 control &= ~CONTROL_RESET;
315 control |= CONTROL_ENABLE;
317 mchp_corespi_write(spi, REG_CONTROL, control);
320 static inline void mchp_corespi_set_clk_gen(struct mchp_corespi *spi)
324 mchp_corespi_disable(spi);
326 control = mchp_corespi_read(spi, REG_CONTROL);
328 control |= CONTROL_CLKMODE;
330 control &= ~CONTROL_CLKMODE;
332 mchp_corespi_write(spi, REG_CLK_GEN, spi->clk_gen);
333 mchp_corespi_write(spi, REG_CONTROL, control);
334 mchp_corespi_write(spi, REG_CONTROL, control | CONTROL_ENABLE);
337 static inline void mchp_corespi_set_mode(struct mchp_corespi *spi, unsigned int mode)
339 u32 control, mode_val;
341 switch (mode & SPI_MODE_X_MASK) {
346 mode_val = CONTROL_SPH;
349 mode_val = CONTROL_SPO;
352 mode_val = CONTROL_SPH | CONTROL_SPO;
357 * Disable the SPI controller. Writes to the frame size have
358 * no effect when the controller is enabled.
360 mchp_corespi_disable(spi);
362 control = mchp_corespi_read(spi, REG_CONTROL);
363 control &= ~(SPI_MODE_X_MASK << MODE_X_MASK_SHIFT);
366 mchp_corespi_write(spi, REG_CONTROL, control);
368 control |= CONTROL_ENABLE;
369 mchp_corespi_write(spi, REG_CONTROL, control);
372 static irqreturn_t mchp_corespi_interrupt(int irq, void *dev_id)
374 struct spi_controller *host = dev_id;
375 struct mchp_corespi *spi = spi_controller_get_devdata(host);
376 u32 intfield = mchp_corespi_read(spi, REG_MIS) & 0xf;
377 bool finalise = false;
379 /* Interrupt line may be shared and not for us at all */
383 if (intfield & INT_TXDONE) {
384 mchp_corespi_write(spi, REG_INT_CLEAR, INT_TXDONE);
387 mchp_corespi_read_fifo(spi);
390 mchp_corespi_write_fifo(spi);
396 if (intfield & INT_RXRDY)
397 mchp_corespi_write(spi, REG_INT_CLEAR, INT_RXRDY);
399 if (intfield & INT_RX_CHANNEL_OVERFLOW) {
400 mchp_corespi_write(spi, REG_INT_CLEAR, INT_RX_CHANNEL_OVERFLOW);
403 "%s: RX OVERFLOW: rxlen: %d, txlen: %d\n", __func__,
404 spi->rx_len, spi->tx_len);
407 if (intfield & INT_TX_CHANNEL_UNDERRUN) {
408 mchp_corespi_write(spi, REG_INT_CLEAR, INT_TX_CHANNEL_UNDERRUN);
411 "%s: TX UNDERFLOW: rxlen: %d, txlen: %d\n", __func__,
412 spi->rx_len, spi->tx_len);
416 spi_finalize_current_transfer(host);
421 static int mchp_corespi_calculate_clkgen(struct mchp_corespi *spi,
422 unsigned long target_hz)
424 unsigned long clk_hz, spi_hz, clk_gen;
426 clk_hz = clk_get_rate(spi->clk);
429 spi_hz = min(target_hz, clk_hz);
432 * There are two possible clock modes for the controller generated
433 * clock's division ratio:
434 * CLK_MODE = 0: 1 / (2^(CLK_GEN + 1)) where CLK_GEN = 0 to 15.
435 * CLK_MODE = 1: 1 / (2 * CLK_GEN + 1) where CLK_GEN = 0 to 255.
436 * First try mode 1, fall back to 0 and if we have tried both modes and
437 * we /still/ can't get a good setting, we then throw the toys out of
438 * the pram and give up
439 * clk_gen is the register name for the clock divider on MPFS.
441 clk_gen = DIV_ROUND_UP(clk_hz, 2 * spi_hz) - 1;
442 if (clk_gen > CLK_GEN_MODE1_MAX || clk_gen <= CLK_GEN_MIN) {
443 clk_gen = DIV_ROUND_UP(clk_hz, spi_hz);
444 clk_gen = fls(clk_gen) - 1;
446 if (clk_gen > CLK_GEN_MODE0_MAX)
454 spi->clk_gen = clk_gen;
458 static int mchp_corespi_transfer_one(struct spi_controller *host,
459 struct spi_device *spi_dev,
460 struct spi_transfer *xfer)
462 struct mchp_corespi *spi = spi_controller_get_devdata(host);
465 ret = mchp_corespi_calculate_clkgen(spi, (unsigned long)xfer->speed_hz);
467 dev_err(&host->dev, "failed to set clk_gen for target %u Hz\n", xfer->speed_hz);
471 mchp_corespi_set_clk_gen(spi);
473 spi->tx_buf = xfer->tx_buf;
474 spi->rx_buf = xfer->rx_buf;
475 spi->tx_len = xfer->len;
476 spi->rx_len = xfer->len;
479 mchp_corespi_set_xfer_size(spi, (spi->tx_len > FIFO_DEPTH)
480 ? FIFO_DEPTH : spi->tx_len);
483 mchp_corespi_write_fifo(spi);
487 static int mchp_corespi_prepare_message(struct spi_controller *host,
488 struct spi_message *msg)
490 struct spi_device *spi_dev = msg->spi;
491 struct mchp_corespi *spi = spi_controller_get_devdata(host);
493 mchp_corespi_set_framesize(spi, DEFAULT_FRAMESIZE);
494 mchp_corespi_set_mode(spi, spi_dev->mode);
499 static int mchp_corespi_probe(struct platform_device *pdev)
501 struct spi_controller *host;
502 struct mchp_corespi *spi;
503 struct resource *res;
507 host = devm_spi_alloc_host(&pdev->dev, sizeof(*spi));
509 return dev_err_probe(&pdev->dev, -ENOMEM,
510 "unable to allocate host for SPI controller\n");
512 platform_set_drvdata(pdev, host);
514 if (of_property_read_u32(pdev->dev.of_node, "num-cs", &num_cs))
517 host->num_chipselect = num_cs;
518 host->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH;
519 host->setup = mchp_corespi_setup;
520 host->bits_per_word_mask = SPI_BPW_MASK(8);
521 host->transfer_one = mchp_corespi_transfer_one;
522 host->prepare_message = mchp_corespi_prepare_message;
523 host->set_cs = mchp_corespi_set_cs;
524 host->dev.of_node = pdev->dev.of_node;
526 spi = spi_controller_get_devdata(host);
528 spi->regs = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
529 if (IS_ERR(spi->regs))
530 return PTR_ERR(spi->regs);
532 spi->irq = platform_get_irq(pdev, 0);
536 ret = devm_request_irq(&pdev->dev, spi->irq, mchp_corespi_interrupt,
537 IRQF_SHARED, dev_name(&pdev->dev), host);
539 return dev_err_probe(&pdev->dev, ret,
540 "could not request irq\n");
542 spi->clk = devm_clk_get_enabled(&pdev->dev, NULL);
543 if (IS_ERR(spi->clk))
544 return dev_err_probe(&pdev->dev, PTR_ERR(spi->clk),
545 "could not get clk\n");
547 mchp_corespi_init(host, spi);
549 ret = devm_spi_register_controller(&pdev->dev, host);
551 mchp_corespi_disable(spi);
552 return dev_err_probe(&pdev->dev, ret,
553 "unable to register host for SPI controller\n");
556 dev_info(&pdev->dev, "Registered SPI controller %d\n", host->bus_num);
561 static void mchp_corespi_remove(struct platform_device *pdev)
563 struct spi_controller *host = platform_get_drvdata(pdev);
564 struct mchp_corespi *spi = spi_controller_get_devdata(host);
566 mchp_corespi_disable_ints(spi);
567 mchp_corespi_disable(spi);
570 #define MICROCHIP_SPI_PM_OPS (NULL)
573 * Platform driver data structure
576 #if defined(CONFIG_OF)
577 static const struct of_device_id mchp_corespi_dt_ids[] = {
578 { .compatible = "microchip,mpfs-spi" },
581 MODULE_DEVICE_TABLE(of, mchp_corespi_dt_ids);
584 static struct platform_driver mchp_corespi_driver = {
585 .probe = mchp_corespi_probe,
587 .name = "microchip-corespi",
588 .pm = MICROCHIP_SPI_PM_OPS,
589 .of_match_table = of_match_ptr(mchp_corespi_dt_ids),
591 .remove_new = mchp_corespi_remove,
593 module_platform_driver(mchp_corespi_driver);
594 MODULE_DESCRIPTION("Microchip coreSPI SPI controller driver");
597 MODULE_LICENSE("GPL");