1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2008, Guennadi Liakhovetski <lg@denx.de>
12 #include <asm/global_data.h>
13 #include <dm/device_compat.h>
14 #include <linux/bitops.h>
15 #include <linux/delay.h>
16 #include <linux/errno.h>
19 #include <asm/arch/imx-regs.h>
20 #include <asm/arch/clock.h>
21 #include <asm/mach-imx/spi.h>
23 DECLARE_GLOBAL_DATA_PTR;
25 /* MX35 and older is CSPI */
26 #if defined(CONFIG_MX25) || defined(CONFIG_MX31) || defined(CONFIG_MX35)
39 #define MXC_CSPICTRL_EN BIT(0)
40 #define MXC_CSPICTRL_MODE BIT(1)
41 #define MXC_CSPICTRL_XCH BIT(2)
42 #define MXC_CSPICTRL_SMC BIT(3)
43 #define MXC_CSPICTRL_POL BIT(4)
44 #define MXC_CSPICTRL_PHA BIT(5)
45 #define MXC_CSPICTRL_SSCTL BIT(6)
46 #define MXC_CSPICTRL_SSPOL BIT(7)
47 #define MXC_CSPICTRL_DATARATE(x) (((x) & 0x7) << 16)
48 #define MXC_CSPICTRL_RXOVF BIT(6)
49 #define MXC_CSPIPERIOD_32KHZ BIT(15)
50 #define MAX_SPI_BYTES 4
51 #if defined(CONFIG_MX25) || defined(CONFIG_MX35)
52 #define MXC_CSPICTRL_CHIPSELECT(x) (((x) & 0x3) << 12)
53 #define MXC_CSPICTRL_BITCOUNT(x) (((x) & 0xfff) << 20)
54 #define MXC_CSPICTRL_TC BIT(7)
55 #define MXC_CSPICTRL_MAXBITS 0xfff
57 #define MXC_CSPICTRL_CHIPSELECT(x) (((x) & 0x3) << 24)
58 #define MXC_CSPICTRL_BITCOUNT(x) (((x) & 0x1f) << 8)
59 #define MXC_CSPICTRL_TC BIT(8)
60 #define MXC_CSPICTRL_MAXBITS 0x1f
63 #else /* MX51 and newer is ECSPI */
76 #define MXC_CSPICTRL_EN BIT(0)
77 #define MXC_CSPICTRL_MODE BIT(1)
78 #define MXC_CSPICTRL_XCH BIT(2)
79 #define MXC_CSPICTRL_MODE_MASK (0xf << 4)
80 #define MXC_CSPICTRL_CHIPSELECT(x) (((x) & 0x3) << 12)
81 #define MXC_CSPICTRL_BITCOUNT(x) (((x) & 0xfff) << 20)
82 #define MXC_CSPICTRL_PREDIV(x) (((x) & 0xF) << 12)
83 #define MXC_CSPICTRL_POSTDIV(x) (((x) & 0xF) << 8)
84 #define MXC_CSPICTRL_SELCHAN(x) (((x) & 0x3) << 18)
85 #define MXC_CSPICTRL_MAXBITS 0xfff
86 #define MXC_CSPICTRL_TC BIT(7)
87 #define MXC_CSPICTRL_RXOVF BIT(6)
88 #define MXC_CSPIPERIOD_32KHZ BIT(15)
89 #define MAX_SPI_BYTES 32
91 /* Bit position inside CTRL register to be associated with SS */
92 #define MXC_CSPICTRL_CHAN 18
94 /* Bit position inside CON register to be associated with SS */
95 #define MXC_CSPICON_PHA 0 /* SCLK phase control */
96 #define MXC_CSPICON_POL 4 /* SCLK polarity */
97 #define MXC_CSPICON_SSPOL 12 /* SS polarity */
98 #define MXC_CSPICON_CTL 20 /* inactive state of SCLK */
102 /* i.MX27 has a completely wrong register layout and register definitions in the
103 * datasheet, the correct one is in the Freescale's Linux driver */
105 #error "i.MX27 CSPI not supported due to drastic differences in register definitions" \
106 "See linux mxc_spi driver from Freescale for details."
109 __weak int board_spi_cs_gpio(unsigned bus, unsigned cs)
114 #define OUT MXC_GPIO_DIRECTION_OUT
116 #define reg_read readl
117 #define reg_write(a, v) writel(v, a)
119 #if !defined(CONFIG_SYS_SPI_MXC_WAIT)
120 #define CONFIG_SYS_SPI_MXC_WAIT (CONFIG_SYS_HZ/100) /* 10 ms */
123 #define MAX_CS_COUNT 4
125 struct mxc_spi_slave {
126 struct spi_slave slave;
129 #if defined(MXC_ECSPI)
137 struct gpio_desc cs_gpios[MAX_CS_COUNT];
141 static inline struct mxc_spi_slave *to_mxc_spi_slave(struct spi_slave *slave)
143 return container_of(slave, struct mxc_spi_slave, slave);
146 static void mxc_spi_cs_activate(struct mxc_spi_slave *mxcs)
148 #if CONFIG_IS_ENABLED(DM_SPI)
149 struct udevice *dev = mxcs->dev;
150 struct dm_spi_slave_plat *slave_plat = dev_get_parent_plat(dev);
152 u32 cs = slave_plat->cs;
154 if (!dm_gpio_is_valid(&mxcs->cs_gpios[cs]))
157 dm_gpio_set_value(&mxcs->cs_gpios[cs], 1);
160 gpio_set_value(mxcs->gpio, mxcs->ss_pol);
164 static void mxc_spi_cs_deactivate(struct mxc_spi_slave *mxcs)
166 #if CONFIG_IS_ENABLED(DM_SPI)
167 struct udevice *dev = mxcs->dev;
168 struct dm_spi_slave_plat *slave_plat = dev_get_parent_plat(dev);
170 u32 cs = slave_plat->cs;
172 if (!dm_gpio_is_valid(&mxcs->cs_gpios[cs]))
175 dm_gpio_set_value(&mxcs->cs_gpios[cs], 0);
178 gpio_set_value(mxcs->gpio, !(mxcs->ss_pol));
182 u32 get_cspi_div(u32 div)
186 for (i = 0; i < 8; i++) {
194 static s32 spi_cfg_mxc(struct mxc_spi_slave *mxcs, unsigned int cs)
196 unsigned int ctrl_reg;
199 unsigned int max_hz = mxcs->max_hz;
200 unsigned int mode = mxcs->mode;
202 clk_src = mxc_get_clock(MXC_CSPI_CLK);
204 div = DIV_ROUND_UP(clk_src, max_hz);
205 div = get_cspi_div(div);
207 debug("clk %d Hz, div %d, real clk %d Hz\n",
208 max_hz, div, clk_src / (4 << div));
210 ctrl_reg = MXC_CSPICTRL_CHIPSELECT(cs) |
211 MXC_CSPICTRL_BITCOUNT(MXC_CSPICTRL_MAXBITS) |
212 MXC_CSPICTRL_DATARATE(div) |
220 ctrl_reg |= MXC_CSPICTRL_PHA;
222 ctrl_reg |= MXC_CSPICTRL_POL;
223 if (mode & SPI_CS_HIGH)
224 ctrl_reg |= MXC_CSPICTRL_SSPOL;
225 mxcs->ctrl_reg = ctrl_reg;
232 static s32 spi_cfg_mxc(struct mxc_spi_slave *mxcs, unsigned int cs)
234 u32 clk_src = mxc_get_clock(MXC_CSPI_CLK);
235 s32 reg_ctrl, reg_config;
236 u32 ss_pol = 0, sclkpol = 0, sclkpha = 0, sclkctl = 0;
237 u32 pre_div = 0, post_div = 0;
238 struct cspi_regs *regs = (struct cspi_regs *)mxcs->base;
239 unsigned int max_hz = mxcs->max_hz;
240 unsigned int mode = mxcs->mode;
243 * Reset SPI and set all CSs to master mode, if toggling
244 * between slave and master mode we might see a glitch
247 reg_ctrl = MXC_CSPICTRL_MODE_MASK;
248 reg_write(®s->ctrl, reg_ctrl);
249 reg_ctrl |= MXC_CSPICTRL_EN;
250 reg_write(®s->ctrl, reg_ctrl);
252 if (clk_src > max_hz) {
253 pre_div = (clk_src - 1) / max_hz;
254 /* fls(1) = 1, fls(0x80000000) = 32, fls(16) = 5 */
255 post_div = fls(pre_div);
258 if (post_div >= 16) {
259 printf("Error: no divider for the freq: %d\n",
263 pre_div >>= post_div;
269 debug("pre_div = %d, post_div=%d\n", pre_div, post_div);
270 reg_ctrl = (reg_ctrl & ~MXC_CSPICTRL_SELCHAN(3)) |
271 MXC_CSPICTRL_SELCHAN(cs);
272 reg_ctrl = (reg_ctrl & ~MXC_CSPICTRL_PREDIV(0x0F)) |
273 MXC_CSPICTRL_PREDIV(pre_div);
274 reg_ctrl = (reg_ctrl & ~MXC_CSPICTRL_POSTDIV(0x0F)) |
275 MXC_CSPICTRL_POSTDIV(post_div);
277 if (mode & SPI_CS_HIGH)
280 if (mode & SPI_CPOL) {
288 reg_config = reg_read(®s->cfg);
291 * Configuration register setup
292 * The MX51 supports different setup for each SS
294 reg_config = (reg_config & ~(1 << (cs + MXC_CSPICON_SSPOL))) |
295 (ss_pol << (cs + MXC_CSPICON_SSPOL));
296 reg_config = (reg_config & ~(1 << (cs + MXC_CSPICON_POL))) |
297 (sclkpol << (cs + MXC_CSPICON_POL));
298 reg_config = (reg_config & ~(1 << (cs + MXC_CSPICON_CTL))) |
299 (sclkctl << (cs + MXC_CSPICON_CTL));
300 reg_config = (reg_config & ~(1 << (cs + MXC_CSPICON_PHA))) |
301 (sclkpha << (cs + MXC_CSPICON_PHA));
303 debug("reg_ctrl = 0x%x\n", reg_ctrl);
304 reg_write(®s->ctrl, reg_ctrl);
305 debug("reg_config = 0x%x\n", reg_config);
306 reg_write(®s->cfg, reg_config);
308 /* save config register and control register */
309 mxcs->ctrl_reg = reg_ctrl;
310 mxcs->cfg_reg = reg_config;
312 /* clear interrupt reg */
313 reg_write(®s->intr, 0);
314 reg_write(®s->stat, MXC_CSPICTRL_TC | MXC_CSPICTRL_RXOVF);
320 int spi_xchg_single(struct mxc_spi_slave *mxcs, unsigned int bitlen,
321 const u8 *dout, u8 *din, unsigned long flags)
323 int nbytes = DIV_ROUND_UP(bitlen, 8);
325 struct cspi_regs *regs = (struct cspi_regs *)mxcs->base;
329 debug("%s: bitlen %d dout 0x%lx din 0x%lx\n",
330 __func__, bitlen, (ulong)dout, (ulong)din);
332 mxcs->ctrl_reg = (mxcs->ctrl_reg &
333 ~MXC_CSPICTRL_BITCOUNT(MXC_CSPICTRL_MAXBITS)) |
334 MXC_CSPICTRL_BITCOUNT(bitlen - 1);
336 reg_write(®s->ctrl, mxcs->ctrl_reg | MXC_CSPICTRL_EN);
338 reg_write(®s->cfg, mxcs->cfg_reg);
341 /* Clear interrupt register */
342 reg_write(®s->stat, MXC_CSPICTRL_TC | MXC_CSPICTRL_RXOVF);
345 * The SPI controller works only with words,
346 * check if less than a word is sent.
347 * Access to the FIFO is only 32 bit
351 cnt = (bitlen % 32) / 8;
353 for (i = 0; i < cnt; i++) {
354 data = (data << 8) | (*dout++ & 0xFF);
357 debug("Sending SPI 0x%x\n", data);
359 reg_write(®s->txdata, data);
368 /* Buffer is not 32-bit aligned */
369 if ((unsigned long)dout & 0x03) {
371 for (i = 0; i < 4; i++)
372 data = (data << 8) | (*dout++ & 0xFF);
375 data = cpu_to_be32(data);
379 debug("Sending SPI 0x%x\n", data);
380 reg_write(®s->txdata, data);
384 /* FIFO is written, now starts the transfer setting the XCH bit */
385 reg_write(®s->ctrl, mxcs->ctrl_reg |
386 MXC_CSPICTRL_EN | MXC_CSPICTRL_XCH);
389 status = reg_read(®s->stat);
390 /* Wait until the TC (Transfer completed) bit is set */
391 while ((status & MXC_CSPICTRL_TC) == 0) {
392 if (get_timer(ts) > CONFIG_SYS_SPI_MXC_WAIT) {
393 printf("spi_xchg_single: Timeout!\n");
396 status = reg_read(®s->stat);
399 /* Transfer completed, clear any pending request */
400 reg_write(®s->stat, MXC_CSPICTRL_TC | MXC_CSPICTRL_RXOVF);
402 nbytes = DIV_ROUND_UP(bitlen, 8);
407 data = reg_read(®s->rxdata);
408 cnt = (bitlen % 32) / 8;
409 data = cpu_to_be32(data) >> ((sizeof(data) - cnt) * 8);
410 debug("SPI Rx unaligned: 0x%x\n", data);
412 memcpy(din, &data, cnt);
420 tmp = reg_read(®s->rxdata);
421 data = cpu_to_be32(tmp);
422 debug("SPI Rx: 0x%x 0x%x\n", tmp, data);
423 cnt = min_t(u32, nbytes, sizeof(data));
425 memcpy(din, &data, cnt);
435 static int mxc_spi_xfer_internal(struct mxc_spi_slave *mxcs,
436 unsigned int bitlen, const void *dout,
437 void *din, unsigned long flags)
439 int n_bytes = DIV_ROUND_UP(bitlen, 8);
443 u8 *p_outbuf = (u8 *)dout;
444 u8 *p_inbuf = (u8 *)din;
449 if (flags & SPI_XFER_BEGIN)
450 mxc_spi_cs_activate(mxcs);
452 while (n_bytes > 0) {
453 if (n_bytes < MAX_SPI_BYTES)
456 blk_size = MAX_SPI_BYTES;
458 n_bits = blk_size * 8;
460 ret = spi_xchg_single(mxcs, n_bits, p_outbuf, p_inbuf, 0);
465 p_outbuf += blk_size;
471 if (flags & SPI_XFER_END) {
472 mxc_spi_cs_deactivate(mxcs);
478 static int mxc_spi_claim_bus_internal(struct mxc_spi_slave *mxcs, int cs)
480 struct cspi_regs *regs = (struct cspi_regs *)mxcs->base;
483 reg_write(®s->rxdata, 1);
485 ret = spi_cfg_mxc(mxcs, cs);
487 printf("mxc_spi: cannot setup SPI controller\n");
490 reg_write(®s->period, MXC_CSPIPERIOD_32KHZ);
491 reg_write(®s->intr, 0);
496 #if !CONFIG_IS_ENABLED(DM_SPI)
497 int spi_xfer(struct spi_slave *slave, unsigned int bitlen, const void *dout,
498 void *din, unsigned long flags)
500 struct mxc_spi_slave *mxcs = to_mxc_spi_slave(slave);
502 return mxc_spi_xfer_internal(mxcs, bitlen, dout, din, flags);
506 * Some SPI devices require active chip-select over multiple
507 * transactions, we achieve this using a GPIO. Still, the SPI
508 * controller has to be configured to use one of its own chipselects.
509 * To use this feature you have to implement board_spi_cs_gpio() to assign
510 * a gpio value for each cs (-1 if cs doesn't need to use gpio).
511 * You must use some unused on this SPI controller cs between 0 and 3.
513 static int setup_cs_gpio(struct mxc_spi_slave *mxcs,
514 unsigned int bus, unsigned int cs)
518 mxcs->gpio = board_spi_cs_gpio(bus, cs);
519 if (mxcs->gpio == -1)
522 gpio_request(mxcs->gpio, "spi-cs");
523 ret = gpio_direction_output(mxcs->gpio, !(mxcs->ss_pol));
525 printf("mxc_spi: cannot setup gpio %d\n", mxcs->gpio);
532 static unsigned long spi_bases[] = {
533 MXC_SPI_BASE_ADDRESSES
536 struct spi_slave *spi_setup_slave(unsigned int bus, unsigned int cs,
537 unsigned int max_hz, unsigned int mode)
539 struct mxc_spi_slave *mxcs;
542 if (bus >= ARRAY_SIZE(spi_bases))
546 printf("Error: desired clock is 0\n");
550 mxcs = spi_alloc_slave(struct mxc_spi_slave, bus, cs);
552 puts("mxc_spi: SPI Slave not allocated !\n");
556 mxcs->ss_pol = (mode & SPI_CS_HIGH) ? 1 : 0;
558 ret = setup_cs_gpio(mxcs, bus, cs);
564 mxcs->base = spi_bases[bus];
565 mxcs->max_hz = max_hz;
571 void spi_free_slave(struct spi_slave *slave)
573 struct mxc_spi_slave *mxcs = to_mxc_spi_slave(slave);
578 int spi_claim_bus(struct spi_slave *slave)
580 struct mxc_spi_slave *mxcs = to_mxc_spi_slave(slave);
582 return mxc_spi_claim_bus_internal(mxcs, slave->cs);
585 void spi_release_bus(struct spi_slave *slave)
587 /* TODO: Shut the controller down */
591 static int mxc_spi_probe(struct udevice *bus)
593 struct mxc_spi_slave *mxcs = dev_get_plat(bus);
594 int node = dev_of_offset(bus);
595 const void *blob = gd->fdt_blob;
599 ret = gpio_request_list_by_name(bus, "cs-gpios", mxcs->cs_gpios,
600 ARRAY_SIZE(mxcs->cs_gpios), 0);
602 pr_err("Can't get %s gpios! Error: %d", bus->name, ret);
606 for (i = 0; i < ARRAY_SIZE(mxcs->cs_gpios); i++) {
607 if (!dm_gpio_is_valid(&mxcs->cs_gpios[i]))
610 ret = dm_gpio_set_dir_flags(&mxcs->cs_gpios[i],
611 GPIOD_IS_OUT | GPIOD_ACTIVE_LOW);
613 dev_err(bus, "Setting cs %d error\n", i);
618 mxcs->base = dev_read_addr(bus);
619 if (mxcs->base == FDT_ADDR_T_NONE)
622 #if CONFIG_IS_ENABLED(CLK)
624 ret = clk_get_by_index(bus, 0, &clk);
630 mxcs->max_hz = clk_get_rate(&clk);
632 mxcs->max_hz = fdtdec_get_int(blob, node, "spi-max-frequency",
639 static int mxc_spi_xfer(struct udevice *dev, unsigned int bitlen,
640 const void *dout, void *din, unsigned long flags)
642 struct mxc_spi_slave *mxcs = dev_get_plat(dev->parent);
645 return mxc_spi_xfer_internal(mxcs, bitlen, dout, din, flags);
648 static int mxc_spi_claim_bus(struct udevice *dev)
650 struct mxc_spi_slave *mxcs = dev_get_plat(dev->parent);
651 struct dm_spi_slave_plat *slave_plat = dev_get_parent_plat(dev);
655 return mxc_spi_claim_bus_internal(mxcs, slave_plat->cs);
658 static int mxc_spi_release_bus(struct udevice *dev)
663 static int mxc_spi_set_speed(struct udevice *bus, uint speed)
669 static int mxc_spi_set_mode(struct udevice *bus, uint mode)
671 struct mxc_spi_slave *mxcs = dev_get_plat(bus);
674 mxcs->ss_pol = (mode & SPI_CS_HIGH) ? 1 : 0;
679 static const struct dm_spi_ops mxc_spi_ops = {
680 .claim_bus = mxc_spi_claim_bus,
681 .release_bus = mxc_spi_release_bus,
682 .xfer = mxc_spi_xfer,
683 .set_speed = mxc_spi_set_speed,
684 .set_mode = mxc_spi_set_mode,
687 static const struct udevice_id mxc_spi_ids[] = {
688 { .compatible = "fsl,imx51-ecspi" },
692 U_BOOT_DRIVER(mxc_spi) = {
695 .of_match = mxc_spi_ids,
697 .plat_auto = sizeof(struct mxc_spi_slave),
698 .probe = mxc_spi_probe,