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_MX31)
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 #define MXC_CSPICTRL_CHIPSELECT(x) (((x) & 0x3) << 24)
52 #define MXC_CSPICTRL_BITCOUNT(x) (((x) & 0x1f) << 8)
53 #define MXC_CSPICTRL_TC BIT(8)
54 #define MXC_CSPICTRL_MAXBITS 0x1f
56 #else /* MX51 and newer is ECSPI */
69 #define MXC_CSPICTRL_EN BIT(0)
70 #define MXC_CSPICTRL_MODE BIT(1)
71 #define MXC_CSPICTRL_XCH BIT(2)
72 #define MXC_CSPICTRL_MODE_MASK (0xf << 4)
73 #define MXC_CSPICTRL_CHIPSELECT(x) (((x) & 0x3) << 12)
74 #define MXC_CSPICTRL_BITCOUNT(x) (((x) & 0xfff) << 20)
75 #define MXC_CSPICTRL_PREDIV(x) (((x) & 0xF) << 12)
76 #define MXC_CSPICTRL_POSTDIV(x) (((x) & 0xF) << 8)
77 #define MXC_CSPICTRL_SELCHAN(x) (((x) & 0x3) << 18)
78 #define MXC_CSPICTRL_MAXBITS 0xfff
79 #define MXC_CSPICTRL_TC BIT(7)
80 #define MXC_CSPICTRL_RXOVF BIT(6)
81 #define MXC_CSPIPERIOD_32KHZ BIT(15)
82 #define MAX_SPI_BYTES 32
84 /* Bit position inside CTRL register to be associated with SS */
85 #define MXC_CSPICTRL_CHAN 18
87 /* Bit position inside CON register to be associated with SS */
88 #define MXC_CSPICON_PHA 0 /* SCLK phase control */
89 #define MXC_CSPICON_POL 4 /* SCLK polarity */
90 #define MXC_CSPICON_SSPOL 12 /* SS polarity */
91 #define MXC_CSPICON_CTL 20 /* inactive state of SCLK */
94 __weak int board_spi_cs_gpio(unsigned bus, unsigned cs)
99 #define OUT MXC_GPIO_DIRECTION_OUT
101 #define reg_read readl
102 #define reg_write(a, v) writel(v, a)
104 #if !defined(CONFIG_SYS_SPI_MXC_WAIT)
105 #define CONFIG_SYS_SPI_MXC_WAIT (CONFIG_SYS_HZ/100) /* 10 ms */
108 #define MAX_CS_COUNT 4
110 struct mxc_spi_slave {
111 struct spi_slave slave;
114 #if defined(MXC_ECSPI)
122 struct gpio_desc cs_gpios[MAX_CS_COUNT];
126 static inline struct mxc_spi_slave *to_mxc_spi_slave(struct spi_slave *slave)
128 return container_of(slave, struct mxc_spi_slave, slave);
131 static void mxc_spi_cs_activate(struct mxc_spi_slave *mxcs)
133 #if CONFIG_IS_ENABLED(DM_SPI)
134 struct udevice *dev = mxcs->dev;
135 struct dm_spi_slave_plat *slave_plat = dev_get_parent_plat(dev);
137 u32 cs = slave_plat->cs;
139 if (!dm_gpio_is_valid(&mxcs->cs_gpios[cs]))
142 dm_gpio_set_value(&mxcs->cs_gpios[cs], 1);
145 gpio_set_value(mxcs->gpio, mxcs->ss_pol);
149 static void mxc_spi_cs_deactivate(struct mxc_spi_slave *mxcs)
151 #if CONFIG_IS_ENABLED(DM_SPI)
152 struct udevice *dev = mxcs->dev;
153 struct dm_spi_slave_plat *slave_plat = dev_get_parent_plat(dev);
155 u32 cs = slave_plat->cs;
157 if (!dm_gpio_is_valid(&mxcs->cs_gpios[cs]))
160 dm_gpio_set_value(&mxcs->cs_gpios[cs], 0);
163 gpio_set_value(mxcs->gpio, !(mxcs->ss_pol));
167 u32 get_cspi_div(u32 div)
171 for (i = 0; i < 8; i++) {
179 static s32 spi_cfg_mxc(struct mxc_spi_slave *mxcs, unsigned int cs)
181 unsigned int ctrl_reg;
184 unsigned int max_hz = mxcs->max_hz;
185 unsigned int mode = mxcs->mode;
187 clk_src = mxc_get_clock(MXC_CSPI_CLK);
189 div = DIV_ROUND_UP(clk_src, max_hz);
190 div = get_cspi_div(div);
192 debug("clk %d Hz, div %d, real clk %d Hz\n",
193 max_hz, div, clk_src / (4 << div));
195 ctrl_reg = MXC_CSPICTRL_CHIPSELECT(cs) |
196 MXC_CSPICTRL_BITCOUNT(MXC_CSPICTRL_MAXBITS) |
197 MXC_CSPICTRL_DATARATE(div) |
202 ctrl_reg |= MXC_CSPICTRL_PHA;
204 ctrl_reg |= MXC_CSPICTRL_POL;
205 if (mode & SPI_CS_HIGH)
206 ctrl_reg |= MXC_CSPICTRL_SSPOL;
207 mxcs->ctrl_reg = ctrl_reg;
214 static s32 spi_cfg_mxc(struct mxc_spi_slave *mxcs, unsigned int cs)
216 u32 clk_src = mxc_get_clock(MXC_CSPI_CLK);
217 s32 reg_ctrl, reg_config;
218 u32 ss_pol = 0, sclkpol = 0, sclkpha = 0, sclkctl = 0;
219 u32 pre_div = 0, post_div = 0;
220 struct cspi_regs *regs = (struct cspi_regs *)mxcs->base;
221 unsigned int max_hz = mxcs->max_hz;
222 unsigned int mode = mxcs->mode;
225 * Reset SPI and set all CSs to master mode, if toggling
226 * between slave and master mode we might see a glitch
229 reg_ctrl = MXC_CSPICTRL_MODE_MASK;
230 reg_write(®s->ctrl, reg_ctrl);
231 reg_ctrl |= MXC_CSPICTRL_EN;
232 reg_write(®s->ctrl, reg_ctrl);
234 if (clk_src > max_hz) {
235 pre_div = (clk_src - 1) / max_hz;
236 /* fls(1) = 1, fls(0x80000000) = 32, fls(16) = 5 */
237 post_div = fls(pre_div);
240 if (post_div >= 16) {
241 printf("Error: no divider for the freq: %d\n",
245 pre_div >>= post_div;
251 debug("pre_div = %d, post_div=%d\n", pre_div, post_div);
252 reg_ctrl = (reg_ctrl & ~MXC_CSPICTRL_SELCHAN(3)) |
253 MXC_CSPICTRL_SELCHAN(cs);
254 reg_ctrl = (reg_ctrl & ~MXC_CSPICTRL_PREDIV(0x0F)) |
255 MXC_CSPICTRL_PREDIV(pre_div);
256 reg_ctrl = (reg_ctrl & ~MXC_CSPICTRL_POSTDIV(0x0F)) |
257 MXC_CSPICTRL_POSTDIV(post_div);
259 if (mode & SPI_CS_HIGH)
262 if (mode & SPI_CPOL) {
270 reg_config = reg_read(®s->cfg);
273 * Configuration register setup
274 * The MX51 supports different setup for each SS
276 reg_config = (reg_config & ~(1 << (cs + MXC_CSPICON_SSPOL))) |
277 (ss_pol << (cs + MXC_CSPICON_SSPOL));
278 reg_config = (reg_config & ~(1 << (cs + MXC_CSPICON_POL))) |
279 (sclkpol << (cs + MXC_CSPICON_POL));
280 reg_config = (reg_config & ~(1 << (cs + MXC_CSPICON_CTL))) |
281 (sclkctl << (cs + MXC_CSPICON_CTL));
282 reg_config = (reg_config & ~(1 << (cs + MXC_CSPICON_PHA))) |
283 (sclkpha << (cs + MXC_CSPICON_PHA));
285 debug("reg_ctrl = 0x%x\n", reg_ctrl);
286 reg_write(®s->ctrl, reg_ctrl);
287 debug("reg_config = 0x%x\n", reg_config);
288 reg_write(®s->cfg, reg_config);
290 /* save config register and control register */
291 mxcs->ctrl_reg = reg_ctrl;
292 mxcs->cfg_reg = reg_config;
294 /* clear interrupt reg */
295 reg_write(®s->intr, 0);
296 reg_write(®s->stat, MXC_CSPICTRL_TC | MXC_CSPICTRL_RXOVF);
302 int spi_xchg_single(struct mxc_spi_slave *mxcs, unsigned int bitlen,
303 const u8 *dout, u8 *din, unsigned long flags)
305 int nbytes = DIV_ROUND_UP(bitlen, 8);
307 struct cspi_regs *regs = (struct cspi_regs *)mxcs->base;
311 debug("%s: bitlen %d dout 0x%lx din 0x%lx\n",
312 __func__, bitlen, (ulong)dout, (ulong)din);
314 mxcs->ctrl_reg = (mxcs->ctrl_reg &
315 ~MXC_CSPICTRL_BITCOUNT(MXC_CSPICTRL_MAXBITS)) |
316 MXC_CSPICTRL_BITCOUNT(bitlen - 1);
318 reg_write(®s->ctrl, mxcs->ctrl_reg | MXC_CSPICTRL_EN);
320 reg_write(®s->cfg, mxcs->cfg_reg);
323 /* Clear interrupt register */
324 reg_write(®s->stat, MXC_CSPICTRL_TC | MXC_CSPICTRL_RXOVF);
327 * The SPI controller works only with words,
328 * check if less than a word is sent.
329 * Access to the FIFO is only 32 bit
333 cnt = (bitlen % 32) / 8;
335 for (i = 0; i < cnt; i++) {
336 data = (data << 8) | (*dout++ & 0xFF);
339 debug("Sending SPI 0x%x\n", data);
341 reg_write(®s->txdata, data);
350 /* Buffer is not 32-bit aligned */
351 if ((unsigned long)dout & 0x03) {
353 for (i = 0; i < 4; i++)
354 data = (data << 8) | (*dout++ & 0xFF);
357 data = cpu_to_be32(data);
361 debug("Sending SPI 0x%x\n", data);
362 reg_write(®s->txdata, data);
366 /* FIFO is written, now starts the transfer setting the XCH bit */
367 reg_write(®s->ctrl, mxcs->ctrl_reg |
368 MXC_CSPICTRL_EN | MXC_CSPICTRL_XCH);
371 status = reg_read(®s->stat);
372 /* Wait until the TC (Transfer completed) bit is set */
373 while ((status & MXC_CSPICTRL_TC) == 0) {
374 if (get_timer(ts) > CONFIG_SYS_SPI_MXC_WAIT) {
375 printf("spi_xchg_single: Timeout!\n");
378 status = reg_read(®s->stat);
381 /* Transfer completed, clear any pending request */
382 reg_write(®s->stat, MXC_CSPICTRL_TC | MXC_CSPICTRL_RXOVF);
384 nbytes = DIV_ROUND_UP(bitlen, 8);
387 data = reg_read(®s->rxdata);
388 cnt = (bitlen % 32) / 8;
389 data = cpu_to_be32(data) >> ((sizeof(data) - cnt) * 8);
390 debug("SPI Rx unaligned: 0x%x\n", data);
392 memcpy(din, &data, cnt);
400 tmp = reg_read(®s->rxdata);
401 data = cpu_to_be32(tmp);
402 debug("SPI Rx: 0x%x 0x%x\n", tmp, data);
403 cnt = min_t(u32, nbytes, sizeof(data));
405 memcpy(din, &data, cnt);
415 static int mxc_spi_xfer_internal(struct mxc_spi_slave *mxcs,
416 unsigned int bitlen, const void *dout,
417 void *din, unsigned long flags)
419 int n_bytes = DIV_ROUND_UP(bitlen, 8);
423 u8 *p_outbuf = (u8 *)dout;
424 u8 *p_inbuf = (u8 *)din;
429 if (flags & SPI_XFER_BEGIN)
430 mxc_spi_cs_activate(mxcs);
432 while (n_bytes > 0) {
433 if (n_bytes < MAX_SPI_BYTES)
436 blk_size = MAX_SPI_BYTES;
438 n_bits = blk_size * 8;
440 ret = spi_xchg_single(mxcs, n_bits, p_outbuf, p_inbuf, 0);
445 p_outbuf += blk_size;
451 if (flags & SPI_XFER_END) {
452 mxc_spi_cs_deactivate(mxcs);
458 static int mxc_spi_claim_bus_internal(struct mxc_spi_slave *mxcs, int cs)
460 struct cspi_regs *regs = (struct cspi_regs *)mxcs->base;
463 reg_write(®s->rxdata, 1);
465 ret = spi_cfg_mxc(mxcs, cs);
467 printf("mxc_spi: cannot setup SPI controller\n");
470 reg_write(®s->period, MXC_CSPIPERIOD_32KHZ);
471 reg_write(®s->intr, 0);
476 #if !CONFIG_IS_ENABLED(DM_SPI)
477 int spi_xfer(struct spi_slave *slave, unsigned int bitlen, const void *dout,
478 void *din, unsigned long flags)
480 struct mxc_spi_slave *mxcs = to_mxc_spi_slave(slave);
482 return mxc_spi_xfer_internal(mxcs, bitlen, dout, din, flags);
486 * Some SPI devices require active chip-select over multiple
487 * transactions, we achieve this using a GPIO. Still, the SPI
488 * controller has to be configured to use one of its own chipselects.
489 * To use this feature you have to implement board_spi_cs_gpio() to assign
490 * a gpio value for each cs (-1 if cs doesn't need to use gpio).
491 * You must use some unused on this SPI controller cs between 0 and 3.
493 static int setup_cs_gpio(struct mxc_spi_slave *mxcs,
494 unsigned int bus, unsigned int cs)
498 mxcs->gpio = board_spi_cs_gpio(bus, cs);
499 if (mxcs->gpio == -1)
502 gpio_request(mxcs->gpio, "spi-cs");
503 ret = gpio_direction_output(mxcs->gpio, !(mxcs->ss_pol));
505 printf("mxc_spi: cannot setup gpio %d\n", mxcs->gpio);
512 static unsigned long spi_bases[] = {
513 MXC_SPI_BASE_ADDRESSES
516 struct spi_slave *spi_setup_slave(unsigned int bus, unsigned int cs,
517 unsigned int max_hz, unsigned int mode)
519 struct mxc_spi_slave *mxcs;
522 if (bus >= ARRAY_SIZE(spi_bases))
526 printf("Error: desired clock is 0\n");
530 mxcs = spi_alloc_slave(struct mxc_spi_slave, bus, cs);
532 puts("mxc_spi: SPI Slave not allocated !\n");
536 mxcs->ss_pol = (mode & SPI_CS_HIGH) ? 1 : 0;
538 ret = setup_cs_gpio(mxcs, bus, cs);
544 mxcs->base = spi_bases[bus];
545 mxcs->max_hz = max_hz;
551 void spi_free_slave(struct spi_slave *slave)
553 struct mxc_spi_slave *mxcs = to_mxc_spi_slave(slave);
558 int spi_claim_bus(struct spi_slave *slave)
560 struct mxc_spi_slave *mxcs = to_mxc_spi_slave(slave);
562 return mxc_spi_claim_bus_internal(mxcs, slave->cs);
565 void spi_release_bus(struct spi_slave *slave)
567 /* TODO: Shut the controller down */
571 static int mxc_spi_probe(struct udevice *bus)
573 struct mxc_spi_slave *mxcs = dev_get_plat(bus);
577 ret = gpio_request_list_by_name(bus, "cs-gpios", mxcs->cs_gpios,
578 ARRAY_SIZE(mxcs->cs_gpios), 0);
580 pr_err("Can't get %s gpios! Error: %d", bus->name, ret);
584 for (i = 0; i < ARRAY_SIZE(mxcs->cs_gpios); i++) {
585 if (!dm_gpio_is_valid(&mxcs->cs_gpios[i]))
588 ret = dm_gpio_set_dir_flags(&mxcs->cs_gpios[i],
589 GPIOD_IS_OUT | GPIOD_ACTIVE_LOW);
591 dev_err(bus, "Setting cs %d error\n", i);
596 mxcs->base = dev_read_addr(bus);
597 if (mxcs->base == FDT_ADDR_T_NONE)
600 #if CONFIG_IS_ENABLED(CLK)
602 ret = clk_get_by_index(bus, 0, &clk);
608 mxcs->max_hz = clk_get_rate(&clk);
610 int node = dev_of_offset(bus);
611 const void *blob = gd->fdt_blob;
612 mxcs->max_hz = fdtdec_get_int(blob, node, "spi-max-frequency",
619 static int mxc_spi_xfer(struct udevice *dev, unsigned int bitlen,
620 const void *dout, void *din, unsigned long flags)
622 struct mxc_spi_slave *mxcs = dev_get_plat(dev->parent);
625 return mxc_spi_xfer_internal(mxcs, bitlen, dout, din, flags);
628 static int mxc_spi_claim_bus(struct udevice *dev)
630 struct mxc_spi_slave *mxcs = dev_get_plat(dev->parent);
631 struct dm_spi_slave_plat *slave_plat = dev_get_parent_plat(dev);
635 return mxc_spi_claim_bus_internal(mxcs, slave_plat->cs);
638 static int mxc_spi_release_bus(struct udevice *dev)
643 static int mxc_spi_set_speed(struct udevice *bus, uint speed)
645 struct mxc_spi_slave *mxcs = dev_get_plat(bus);
647 mxcs->max_hz = speed;
652 static int mxc_spi_set_mode(struct udevice *bus, uint mode)
654 struct mxc_spi_slave *mxcs = dev_get_plat(bus);
657 mxcs->ss_pol = (mode & SPI_CS_HIGH) ? 1 : 0;
662 static const struct dm_spi_ops mxc_spi_ops = {
663 .claim_bus = mxc_spi_claim_bus,
664 .release_bus = mxc_spi_release_bus,
665 .xfer = mxc_spi_xfer,
666 .set_speed = mxc_spi_set_speed,
667 .set_mode = mxc_spi_set_mode,
670 static const struct udevice_id mxc_spi_ids[] = {
671 { .compatible = "fsl,imx51-ecspi" },
675 U_BOOT_DRIVER(mxc_spi) = {
678 .of_match = mxc_spi_ids,
680 .plat_auto = sizeof(struct mxc_spi_slave),
681 .probe = mxc_spi_probe,