1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2000-2003
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
6 * Copyright (C) 2004-2009, 2015 Freescale Semiconductor, Inc.
7 * TsiChung Liew (Tsi-Chung.Liew@freescale.com)
8 * Chao Fu (B44548@freescale.com)
9 * Haikun Wang (B53464@freescale.com)
22 #include <asm/arch/clock.h>
25 #include <linux/delay.h>
27 DECLARE_GLOBAL_DATA_PTR;
29 /* fsl_dspi_platdata flags */
30 #define DSPI_FLAG_REGMAP_ENDIAN_BIG BIT(0)
33 #define DSPI_IDLE_VAL 0x0
35 /* max chipselect signals number */
36 #define FSL_DSPI_MAX_CHIPSELECT 6
38 /* default SCK frequency, unit: HZ */
39 #define FSL_DSPI_DEFAULT_SCK_FREQ 10000000
41 /* tx/rx data wait timeout value, unit: us */
42 #define DSPI_TXRX_WAIT_TIMEOUT 1000000
44 /* CTAR register pre-configure value */
45 #define DSPI_CTAR_DEFAULT_VALUE (DSPI_CTAR_TRSZ(7) | \
46 DSPI_CTAR_PCSSCK_1CLK | \
49 DSPI_CTAR_CSSCK(0) | \
53 /* CTAR register pre-configure mask */
54 #define DSPI_CTAR_SET_MODE_MASK (DSPI_CTAR_TRSZ(15) | \
55 DSPI_CTAR_PCSSCK(3) | \
58 DSPI_CTAR_CSSCK(15) | \
63 * struct fsl_dspi_platdata - platform data for Freescale DSPI
65 * @flags: Flags for DSPI DSPI_FLAG_...
66 * @speed_hz: Default SCK frequency
67 * @num_chipselect: Number of DSPI chipselect signals
68 * @regs_addr: Base address of DSPI registers
70 struct fsl_dspi_platdata {
78 * struct fsl_dspi_priv - private data for Freescale DSPI
80 * @flags: Flags for DSPI DSPI_FLAG_...
81 * @mode: SPI mode to use for slave device (see SPI mode flags)
82 * @mcr_val: MCR register configure value
83 * @bus_clk: DSPI input clk frequency
84 * @speed_hz: Default SCK frequency
85 * @charbit: How many bits in every transfer
86 * @num_chipselect: Number of DSPI chipselect signals
87 * @ctar_val: CTAR register configure value of per chipselect slave device
88 * @regs: Point to DSPI register structure for I/O access
90 struct fsl_dspi_priv {
98 uint ctar_val[FSL_DSPI_MAX_CHIPSELECT];
102 #ifndef CONFIG_DM_SPI
104 struct spi_slave slave;
105 struct fsl_dspi_priv priv;
109 __weak void cpu_dspi_port_conf(void)
113 __weak int cpu_dspi_claim_bus(uint bus, uint cs)
118 __weak void cpu_dspi_release_bus(uint bus, uint cs)
122 static uint dspi_read32(uint flags, uint *addr)
124 return flags & DSPI_FLAG_REGMAP_ENDIAN_BIG ?
125 in_be32(addr) : in_le32(addr);
128 static void dspi_write32(uint flags, uint *addr, uint val)
130 flags & DSPI_FLAG_REGMAP_ENDIAN_BIG ?
131 out_be32(addr, val) : out_le32(addr, val);
134 static void dspi_halt(struct fsl_dspi_priv *priv, u8 halt)
138 mcr_val = dspi_read32(priv->flags, &priv->regs->mcr);
141 mcr_val |= DSPI_MCR_HALT;
143 mcr_val &= ~DSPI_MCR_HALT;
145 dspi_write32(priv->flags, &priv->regs->mcr, mcr_val);
148 static void fsl_dspi_init_mcr(struct fsl_dspi_priv *priv, uint cfg_val)
150 /* halt DSPI module */
153 dspi_write32(priv->flags, &priv->regs->mcr, cfg_val);
158 priv->mcr_val = cfg_val;
161 static void fsl_dspi_cfg_cs_active_state(struct fsl_dspi_priv *priv,
168 mcr_val = dspi_read32(priv->flags, &priv->regs->mcr);
169 if (state & SPI_CS_HIGH)
170 /* CSx inactive state is low */
171 mcr_val &= ~DSPI_MCR_PCSIS(cs);
173 /* CSx inactive state is high */
174 mcr_val |= DSPI_MCR_PCSIS(cs);
175 dspi_write32(priv->flags, &priv->regs->mcr, mcr_val);
180 static int fsl_dspi_cfg_ctar_mode(struct fsl_dspi_priv *priv,
185 bus_setup = dspi_read32(priv->flags, &priv->regs->ctar[0]);
187 bus_setup &= ~DSPI_CTAR_SET_MODE_MASK;
188 bus_setup |= priv->ctar_val[cs];
189 bus_setup &= ~(DSPI_CTAR_CPOL | DSPI_CTAR_CPHA | DSPI_CTAR_LSBFE);
192 bus_setup |= DSPI_CTAR_CPOL;
194 bus_setup |= DSPI_CTAR_CPHA;
195 if (mode & SPI_LSB_FIRST)
196 bus_setup |= DSPI_CTAR_LSBFE;
198 dspi_write32(priv->flags, &priv->regs->ctar[0], bus_setup);
201 ((dspi_read32(priv->flags, &priv->regs->ctar[0]) &
202 DSPI_CTAR_TRSZ(15)) == DSPI_CTAR_TRSZ(15)) ? 16 : 8;
207 static void fsl_dspi_clr_fifo(struct fsl_dspi_priv *priv)
212 mcr_val = dspi_read32(priv->flags, &priv->regs->mcr);
213 /* flush RX and TX FIFO */
214 mcr_val |= (DSPI_MCR_CTXF | DSPI_MCR_CRXF);
215 dspi_write32(priv->flags, &priv->regs->mcr, mcr_val);
219 static void dspi_tx(struct fsl_dspi_priv *priv, u32 ctrl, u16 data)
221 int timeout = DSPI_TXRX_WAIT_TIMEOUT;
223 /* wait for empty entries in TXFIFO or timeout */
224 while (DSPI_SR_TXCTR(dspi_read32(priv->flags, &priv->regs->sr)) >= 4 &&
229 dspi_write32(priv->flags, &priv->regs->tfr, (ctrl | data));
231 debug("dspi_tx: waiting timeout!\n");
234 static u16 dspi_rx(struct fsl_dspi_priv *priv)
236 int timeout = DSPI_TXRX_WAIT_TIMEOUT;
238 /* wait for valid entries in RXFIFO or timeout */
239 while (DSPI_SR_RXCTR(dspi_read32(priv->flags, &priv->regs->sr)) == 0 &&
244 return (u16)DSPI_RFR_RXDATA(
245 dspi_read32(priv->flags, &priv->regs->rfr));
247 debug("dspi_rx: waiting timeout!\n");
252 static int dspi_xfer(struct fsl_dspi_priv *priv, uint cs, unsigned int bitlen,
253 const void *dout, void *din, unsigned long flags)
255 u16 *spi_rd16 = NULL, *spi_wr16 = NULL;
256 u8 *spi_rd = NULL, *spi_wr = NULL;
258 uint len = bitlen >> 3;
260 if (priv->charbit == 16) {
262 spi_wr16 = (u16 *)dout;
263 spi_rd16 = (u16 *)din;
269 if ((flags & SPI_XFER_BEGIN) == SPI_XFER_BEGIN)
270 ctrl |= DSPI_TFR_CONT;
272 ctrl = ctrl & DSPI_TFR_CONT;
273 ctrl = ctrl | DSPI_TFR_CTAS(0) | DSPI_TFR_PCS(cs);
276 int tmp_len = len - 1;
278 if ((dout != NULL) && (din != NULL)) {
279 if (priv->charbit == 16) {
280 dspi_tx(priv, ctrl, *spi_wr16++);
281 *spi_rd16++ = dspi_rx(priv);
284 dspi_tx(priv, ctrl, *spi_wr++);
285 *spi_rd++ = dspi_rx(priv);
289 else if (dout != NULL) {
290 if (priv->charbit == 16)
291 dspi_tx(priv, ctrl, *spi_wr16++);
293 dspi_tx(priv, ctrl, *spi_wr++);
297 else if (din != NULL) {
298 dspi_tx(priv, ctrl, DSPI_IDLE_VAL);
299 if (priv->charbit == 16)
300 *spi_rd16++ = dspi_rx(priv);
302 *spi_rd++ = dspi_rx(priv);
306 len = 1; /* remaining byte */
309 if ((flags & SPI_XFER_END) == SPI_XFER_END)
310 ctrl &= ~DSPI_TFR_CONT;
313 if ((dout != NULL) && (din != NULL)) {
314 if (priv->charbit == 16) {
315 dspi_tx(priv, ctrl, *spi_wr16++);
316 *spi_rd16++ = dspi_rx(priv);
319 dspi_tx(priv, ctrl, *spi_wr++);
320 *spi_rd++ = dspi_rx(priv);
324 else if (dout != NULL) {
325 if (priv->charbit == 16)
326 dspi_tx(priv, ctrl, *spi_wr16);
328 dspi_tx(priv, ctrl, *spi_wr);
332 else if (din != NULL) {
333 dspi_tx(priv, ctrl, DSPI_IDLE_VAL);
334 if (priv->charbit == 16)
335 *spi_rd16 = dspi_rx(priv);
337 *spi_rd = dspi_rx(priv);
341 dspi_tx(priv, ctrl, DSPI_IDLE_VAL);
349 * Calculate the divide value between input clk frequency and expected SCK frequency
350 * Formula: SCK = (clkrate/pbr) x ((1+dbr)/br)
351 * Dbr: use default value 0
353 * @pbr: return Baud Rate Prescaler value
354 * @br: return Baud Rate Scaler value
355 * @speed_hz: expected SCK frequency
356 * @clkrate: input clk frequency
358 static int fsl_dspi_hz_to_spi_baud(int *pbr, int *br,
359 int speed_hz, uint clkrate)
361 /* Valid baud rate pre-scaler values */
362 int pbr_tbl[4] = {2, 3, 5, 7};
363 int brs[16] = {2, 4, 6, 8,
365 256, 512, 1024, 2048,
366 4096, 8192, 16384, 32768};
367 int temp, i = 0, j = 0;
369 temp = clkrate / speed_hz;
371 for (i = 0; i < ARRAY_SIZE(pbr_tbl); i++)
372 for (j = 0; j < ARRAY_SIZE(brs); j++) {
373 if (pbr_tbl[i] * brs[j] >= temp) {
380 debug("Can not find valid baud rate,speed_hz is %d, ", speed_hz);
381 debug("clkrate is %d, we use the max prescaler value.\n", clkrate);
383 *pbr = ARRAY_SIZE(pbr_tbl) - 1;
384 *br = ARRAY_SIZE(brs) - 1;
388 static int fsl_dspi_cfg_speed(struct fsl_dspi_priv *priv, uint speed)
392 int best_i, best_j, bus_clk;
394 bus_clk = priv->bus_clk;
396 debug("DSPI set_speed: expected SCK speed %u, bus_clk %u.\n",
399 bus_setup = dspi_read32(priv->flags, &priv->regs->ctar[0]);
400 bus_setup &= ~(DSPI_CTAR_DBR | DSPI_CTAR_PBR(0x3) | DSPI_CTAR_BR(0xf));
402 ret = fsl_dspi_hz_to_spi_baud(&best_i, &best_j, speed, bus_clk);
404 speed = priv->speed_hz;
405 debug("DSPI set_speed use default SCK rate %u.\n", speed);
406 fsl_dspi_hz_to_spi_baud(&best_i, &best_j, speed, bus_clk);
409 bus_setup |= (DSPI_CTAR_PBR(best_i) | DSPI_CTAR_BR(best_j));
410 dspi_write32(priv->flags, &priv->regs->ctar[0], bus_setup);
412 priv->speed_hz = speed;
416 #ifndef CONFIG_DM_SPI
417 int spi_cs_is_valid(unsigned int bus, unsigned int cs)
419 if (((cs >= 0) && (cs < 8)) && ((bus >= 0) && (bus < 8)))
425 struct spi_slave *spi_setup_slave(unsigned int bus, unsigned int cs,
426 unsigned int max_hz, unsigned int mode)
428 struct fsl_dspi *dspi;
431 dspi = spi_alloc_slave(struct fsl_dspi, bus, cs);
435 cpu_dspi_port_conf();
437 #ifdef CONFIG_SYS_FSL_DSPI_BE
438 dspi->priv.flags |= DSPI_FLAG_REGMAP_ENDIAN_BIG;
441 dspi->priv.regs = (struct dspi *)MMAP_DSPI;
444 dspi->priv.bus_clk = gd->bus_clk;
446 dspi->priv.bus_clk = mxc_get_clock(MXC_DSPI_CLK);
448 dspi->priv.speed_hz = FSL_DSPI_DEFAULT_SCK_FREQ;
450 /* default: all CS signals inactive state is high */
451 mcr_cfg_val = DSPI_MCR_MSTR | DSPI_MCR_PCSIS_MASK |
452 DSPI_MCR_CRXF | DSPI_MCR_CTXF;
453 fsl_dspi_init_mcr(&dspi->priv, mcr_cfg_val);
455 for (i = 0; i < FSL_DSPI_MAX_CHIPSELECT; i++)
456 dspi->priv.ctar_val[i] = DSPI_CTAR_DEFAULT_VALUE;
458 #ifdef CONFIG_SYS_DSPI_CTAR0
459 if (FSL_DSPI_MAX_CHIPSELECT > 0)
460 dspi->priv.ctar_val[0] = CONFIG_SYS_DSPI_CTAR0;
462 #ifdef CONFIG_SYS_DSPI_CTAR1
463 if (FSL_DSPI_MAX_CHIPSELECT > 1)
464 dspi->priv.ctar_val[1] = CONFIG_SYS_DSPI_CTAR1;
466 #ifdef CONFIG_SYS_DSPI_CTAR2
467 if (FSL_DSPI_MAX_CHIPSELECT > 2)
468 dspi->priv.ctar_val[2] = CONFIG_SYS_DSPI_CTAR2;
470 #ifdef CONFIG_SYS_DSPI_CTAR3
471 if (FSL_DSPI_MAX_CHIPSELECT > 3)
472 dspi->priv.ctar_val[3] = CONFIG_SYS_DSPI_CTAR3;
474 #ifdef CONFIG_SYS_DSPI_CTAR4
475 if (FSL_DSPI_MAX_CHIPSELECT > 4)
476 dspi->priv.ctar_val[4] = CONFIG_SYS_DSPI_CTAR4;
478 #ifdef CONFIG_SYS_DSPI_CTAR5
479 if (FSL_DSPI_MAX_CHIPSELECT > 5)
480 dspi->priv.ctar_val[5] = CONFIG_SYS_DSPI_CTAR5;
482 #ifdef CONFIG_SYS_DSPI_CTAR6
483 if (FSL_DSPI_MAX_CHIPSELECT > 6)
484 dspi->priv.ctar_val[6] = CONFIG_SYS_DSPI_CTAR6;
486 #ifdef CONFIG_SYS_DSPI_CTAR7
487 if (FSL_DSPI_MAX_CHIPSELECT > 7)
488 dspi->priv.ctar_val[7] = CONFIG_SYS_DSPI_CTAR7;
491 fsl_dspi_cfg_speed(&dspi->priv, max_hz);
493 /* configure transfer mode */
494 fsl_dspi_cfg_ctar_mode(&dspi->priv, cs, mode);
496 /* configure active state of CSX */
497 fsl_dspi_cfg_cs_active_state(&dspi->priv, cs, mode);
502 void spi_free_slave(struct spi_slave *slave)
507 int spi_claim_bus(struct spi_slave *slave)
510 struct fsl_dspi *dspi = (struct fsl_dspi *)slave;
512 cpu_dspi_claim_bus(slave->bus, slave->cs);
514 fsl_dspi_clr_fifo(&dspi->priv);
516 /* check module TX and RX status */
517 sr_val = dspi_read32(dspi->priv.flags, &dspi->priv.regs->sr);
518 if ((sr_val & DSPI_SR_TXRXS) != DSPI_SR_TXRXS) {
519 debug("DSPI RX/TX not ready!\n");
526 void spi_release_bus(struct spi_slave *slave)
528 struct fsl_dspi *dspi = (struct fsl_dspi *)slave;
530 dspi_halt(&dspi->priv, 1);
531 cpu_dspi_release_bus(slave->bus.slave->cs);
534 int spi_xfer(struct spi_slave *slave, unsigned int bitlen, const void *dout,
535 void *din, unsigned long flags)
537 struct fsl_dspi *dspi = (struct fsl_dspi *)slave;
538 return dspi_xfer(&dspi->priv, slave->cs, bitlen, dout, din, flags);
541 static int fsl_dspi_child_pre_probe(struct udevice *dev)
543 struct dm_spi_slave_platdata *slave_plat = dev_get_parent_platdata(dev);
544 struct fsl_dspi_priv *priv = dev_get_priv(dev->parent);
546 if (slave_plat->cs >= priv->num_chipselect) {
547 debug("DSPI invalid chipselect number %d(max %d)!\n",
548 slave_plat->cs, priv->num_chipselect - 1);
552 priv->ctar_val[slave_plat->cs] = DSPI_CTAR_DEFAULT_VALUE;
554 debug("DSPI pre_probe slave device on CS %u, max_hz %u, mode 0x%x.\n",
555 slave_plat->cs, slave_plat->max_hz, slave_plat->mode);
560 static int fsl_dspi_probe(struct udevice *bus)
562 struct fsl_dspi_platdata *plat = dev_get_platdata(bus);
563 struct fsl_dspi_priv *priv = dev_get_priv(bus);
564 struct dm_spi_bus *dm_spi_bus;
567 dm_spi_bus = bus->uclass_priv;
569 /* cpu speical pin muxing configure */
570 cpu_dspi_port_conf();
572 /* get input clk frequency */
573 priv->regs = (struct dspi *)plat->regs_addr;
574 priv->flags = plat->flags;
576 priv->bus_clk = gd->bus_clk;
578 priv->bus_clk = mxc_get_clock(MXC_DSPI_CLK);
580 priv->num_chipselect = plat->num_chipselect;
581 priv->speed_hz = plat->speed_hz;
582 /* frame data length in bits, default 8bits */
585 dm_spi_bus->max_hz = plat->speed_hz;
587 /* default: all CS signals inactive state is high */
588 mcr_cfg_val = DSPI_MCR_MSTR | DSPI_MCR_PCSIS_MASK |
589 DSPI_MCR_CRXF | DSPI_MCR_CTXF;
590 fsl_dspi_init_mcr(priv, mcr_cfg_val);
592 debug("%s probe done, bus-num %d.\n", bus->name, bus->seq);
597 static int fsl_dspi_claim_bus(struct udevice *dev)
600 struct fsl_dspi_priv *priv;
601 struct udevice *bus = dev->parent;
602 struct dm_spi_slave_platdata *slave_plat =
603 dev_get_parent_platdata(dev);
605 priv = dev_get_priv(bus);
607 /* processor special preparation work */
608 cpu_dspi_claim_bus(bus->seq, slave_plat->cs);
610 /* configure transfer mode */
611 fsl_dspi_cfg_ctar_mode(priv, slave_plat->cs, priv->mode);
613 /* configure active state of CSX */
614 fsl_dspi_cfg_cs_active_state(priv, slave_plat->cs,
617 fsl_dspi_clr_fifo(priv);
619 /* check module TX and RX status */
620 sr_val = dspi_read32(priv->flags, &priv->regs->sr);
621 if ((sr_val & DSPI_SR_TXRXS) != DSPI_SR_TXRXS) {
622 debug("DSPI RX/TX not ready!\n");
629 static int fsl_dspi_release_bus(struct udevice *dev)
631 struct udevice *bus = dev->parent;
632 struct fsl_dspi_priv *priv = dev_get_priv(bus);
633 struct dm_spi_slave_platdata *slave_plat =
634 dev_get_parent_platdata(dev);
639 /* processor special release work */
640 cpu_dspi_release_bus(bus->seq, slave_plat->cs);
646 * This function doesn't do anything except help with debugging
648 static int fsl_dspi_bind(struct udevice *bus)
650 debug("%s assigned req_seq %d.\n", bus->name, bus->req_seq);
654 static int fsl_dspi_ofdata_to_platdata(struct udevice *bus)
657 struct fsl_dspi_platdata *plat = bus->platdata;
658 const void *blob = gd->fdt_blob;
659 int node = dev_of_offset(bus);
661 if (fdtdec_get_bool(blob, node, "big-endian"))
662 plat->flags |= DSPI_FLAG_REGMAP_ENDIAN_BIG;
664 plat->num_chipselect =
665 fdtdec_get_int(blob, node, "num-cs", FSL_DSPI_MAX_CHIPSELECT);
667 addr = devfdt_get_addr(bus);
668 if (addr == FDT_ADDR_T_NONE) {
669 debug("DSPI: Can't get base address or size\n");
672 plat->regs_addr = addr;
674 plat->speed_hz = fdtdec_get_int(blob,
675 node, "spi-max-frequency", FSL_DSPI_DEFAULT_SCK_FREQ);
677 debug("DSPI: regs=%pa, max-frequency=%d, endianess=%s, num-cs=%d\n",
678 &plat->regs_addr, plat->speed_hz,
679 plat->flags & DSPI_FLAG_REGMAP_ENDIAN_BIG ? "be" : "le",
680 plat->num_chipselect);
685 static int fsl_dspi_xfer(struct udevice *dev, unsigned int bitlen,
686 const void *dout, void *din, unsigned long flags)
688 struct fsl_dspi_priv *priv;
689 struct dm_spi_slave_platdata *slave_plat = dev_get_parent_platdata(dev);
693 priv = dev_get_priv(bus);
695 return dspi_xfer(priv, slave_plat->cs, bitlen, dout, din, flags);
698 static int fsl_dspi_set_speed(struct udevice *bus, uint speed)
700 struct fsl_dspi_priv *priv = dev_get_priv(bus);
702 return fsl_dspi_cfg_speed(priv, speed);
705 static int fsl_dspi_set_mode(struct udevice *bus, uint mode)
707 struct fsl_dspi_priv *priv = dev_get_priv(bus);
709 debug("DSPI set_mode: mode 0x%x.\n", mode);
712 * We store some chipselect special configure value in priv->ctar_val,
713 * and we can't get the correct chipselect number here,
714 * so just store mode value.
715 * Do really configuration when claim_bus.
722 static const struct dm_spi_ops fsl_dspi_ops = {
723 .claim_bus = fsl_dspi_claim_bus,
724 .release_bus = fsl_dspi_release_bus,
725 .xfer = fsl_dspi_xfer,
726 .set_speed = fsl_dspi_set_speed,
727 .set_mode = fsl_dspi_set_mode,
730 static const struct udevice_id fsl_dspi_ids[] = {
731 { .compatible = "fsl,vf610-dspi" },
735 U_BOOT_DRIVER(fsl_dspi) = {
738 .of_match = fsl_dspi_ids,
739 .ops = &fsl_dspi_ops,
740 .ofdata_to_platdata = fsl_dspi_ofdata_to_platdata,
741 .platdata_auto_alloc_size = sizeof(struct fsl_dspi_platdata),
742 .priv_auto_alloc_size = sizeof(struct fsl_dspi_priv),
743 .probe = fsl_dspi_probe,
744 .child_pre_probe = fsl_dspi_child_pre_probe,
745 .bind = fsl_dspi_bind,