drivers/spi/mxc_spi.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (C) 2008, Guennadi Liakhovetski <lg@denx.de>
   4  */
   5
   6 #include <common.h>
   7 #include <dm.h>
   8 #include <malloc.h>
   9 #include <spi.h>
  10 #include <dm/device_compat.h>
  11 #include <linux/errno.h>
  12 #include <asm/io.h>
  13 #include <asm/gpio.h>
  14 #include <asm/arch/imx-regs.h>
  15 #include <asm/arch/clock.h>
  16 #include <asm/mach-imx/spi.h>
  17
  18 DECLARE_GLOBAL_DATA_PTR;
  19
  20 #ifdef CONFIG_MX27
  21 /* i.MX27 has a completely wrong register layout and register definitions in the
  22  * datasheet, the correct one is in the Freescale's Linux driver */
  23
  24 #error "i.MX27 CSPI not supported due to drastic differences in register definitions" \
  25 "See linux mxc_spi driver from Freescale for details."
  26 #endif
  27
  28 __weak int board_spi_cs_gpio(unsigned bus, unsigned cs)
  29 {
  30         return -1;
  31 }
  32
  33 #define OUT     MXC_GPIO_DIRECTION_OUT
  34
  35 #define reg_read readl
  36 #define reg_write(a, v) writel(v, a)
  37
  38 #if !defined(CONFIG_SYS_SPI_MXC_WAIT)
  39 #define CONFIG_SYS_SPI_MXC_WAIT         (CONFIG_SYS_HZ/100)     /* 10 ms */
  40 #endif
  41
  42 #define MAX_CS_COUNT    4
  43
  44 struct mxc_spi_slave {
  45         struct spi_slave slave;
  46         unsigned long   base;
  47         u32             ctrl_reg;
  48 #if defined(MXC_ECSPI)
  49         u32             cfg_reg;
  50 #endif
  51         int             gpio;
  52         int             ss_pol;
  53         unsigned int    max_hz;
  54         unsigned int    mode;
  55         struct gpio_desc ss;
  56         struct gpio_desc cs_gpios[MAX_CS_COUNT];
  57         struct udevice *dev;
  58 };
  59
  60 static inline struct mxc_spi_slave *to_mxc_spi_slave(struct spi_slave *slave)
  61 {
  62         return container_of(slave, struct mxc_spi_slave, slave);
  63 }
  64
  65 static void mxc_spi_cs_activate(struct mxc_spi_slave *mxcs)
  66 {
  67 #if defined(CONFIG_DM_SPI)
  68         struct udevice *dev = mxcs->dev;
  69         struct dm_spi_slave_platdata *slave_plat = dev_get_parent_platdata(dev);
  70
  71         u32 cs = slave_plat->cs;
  72
  73         if (!dm_gpio_is_valid(&mxcs->cs_gpios[cs]))
  74                 return;
  75
  76         dm_gpio_set_value(&mxcs->cs_gpios[cs], 1);
  77 #else
  78         if (mxcs->gpio > 0)
  79                 gpio_set_value(mxcs->gpio, mxcs->ss_pol);
  80 #endif
  81 }
  82
  83 static void mxc_spi_cs_deactivate(struct mxc_spi_slave *mxcs)
  84 {
  85 #if defined(CONFIG_DM_SPI)
  86         struct udevice *dev = mxcs->dev;
  87         struct dm_spi_slave_platdata *slave_plat = dev_get_parent_platdata(dev);
  88
  89         u32 cs = slave_plat->cs;
  90
  91         if (!dm_gpio_is_valid(&mxcs->cs_gpios[cs]))
  92                 return;
  93
  94         dm_gpio_set_value(&mxcs->cs_gpios[cs], 0);
  95 #else
  96         if (mxcs->gpio > 0)
  97                 gpio_set_value(mxcs->gpio, !(mxcs->ss_pol));
  98 #endif
  99 }
 100
 101 u32 get_cspi_div(u32 div)
 102 {
 103         int i;
 104
 105         for (i = 0; i < 8; i++) {
 106                 if (div <= (4 << i))
 107                         return i;
 108         }
 109         return i;
 110 }
 111
 112 #ifdef MXC_CSPI
 113 static s32 spi_cfg_mxc(struct mxc_spi_slave *mxcs, unsigned int cs)
 114 {
 115         unsigned int ctrl_reg;
 116         u32 clk_src;
 117         u32 div;
 118         unsigned int max_hz = mxcs->max_hz;
 119         unsigned int mode = mxcs->mode;
 120
 121         clk_src = mxc_get_clock(MXC_CSPI_CLK);
 122
 123         div = DIV_ROUND_UP(clk_src, max_hz);
 124         div = get_cspi_div(div);
 125
 126         debug("clk %d Hz, div %d, real clk %d Hz\n",
 127                 max_hz, div, clk_src / (4 << div));
 128
 129         ctrl_reg = MXC_CSPICTRL_CHIPSELECT(cs) |
 130                 MXC_CSPICTRL_BITCOUNT(MXC_CSPICTRL_MAXBITS) |
 131                 MXC_CSPICTRL_DATARATE(div) |
 132                 MXC_CSPICTRL_EN |
 133 #ifdef CONFIG_MX35
 134                 MXC_CSPICTRL_SSCTL |
 135 #endif
 136                 MXC_CSPICTRL_MODE;
 137
 138         if (mode & SPI_CPHA)
 139                 ctrl_reg |= MXC_CSPICTRL_PHA;
 140         if (mode & SPI_CPOL)
 141                 ctrl_reg |= MXC_CSPICTRL_POL;
 142         if (mode & SPI_CS_HIGH)
 143                 ctrl_reg |= MXC_CSPICTRL_SSPOL;
 144         mxcs->ctrl_reg = ctrl_reg;
 145
 146         return 0;
 147 }
 148 #endif
 149
 150 #ifdef MXC_ECSPI
 151 static s32 spi_cfg_mxc(struct mxc_spi_slave *mxcs, unsigned int cs)
 152 {
 153         u32 clk_src = mxc_get_clock(MXC_CSPI_CLK);
 154         s32 reg_ctrl, reg_config;
 155         u32 ss_pol = 0, sclkpol = 0, sclkpha = 0, sclkctl = 0;
 156         u32 pre_div = 0, post_div = 0;
 157         struct cspi_regs *regs = (struct cspi_regs *)mxcs->base;
 158         unsigned int max_hz = mxcs->max_hz;
 159         unsigned int mode = mxcs->mode;
 160
 161         /*
 162          * Reset SPI and set all CSs to master mode, if toggling
 163          * between slave and master mode we might see a glitch
 164          * on the clock line
 165          */
 166         reg_ctrl = MXC_CSPICTRL_MODE_MASK;
 167         reg_write(&regs->ctrl, reg_ctrl);
 168         reg_ctrl |=  MXC_CSPICTRL_EN;
 169         reg_write(&regs->ctrl, reg_ctrl);
 170
 171         if (clk_src > max_hz) {
 172                 pre_div = (clk_src - 1) / max_hz;
 173                 /* fls(1) = 1, fls(0x80000000) = 32, fls(16) = 5 */
 174                 post_div = fls(pre_div);
 175                 if (post_div > 4) {
 176                         post_div -= 4;
 177                         if (post_div >= 16) {
 178                                 printf("Error: no divider for the freq: %d\n",
 179                                         max_hz);
 180                                 return -1;
 181                         }
 182                         pre_div >>= post_div;
 183                 } else {
 184                         post_div = 0;
 185                 }
 186         }
 187
 188         debug("pre_div = %d, post_div=%d\n", pre_div, post_div);
 189         reg_ctrl = (reg_ctrl & ~MXC_CSPICTRL_SELCHAN(3)) |
 190                 MXC_CSPICTRL_SELCHAN(cs);
 191         reg_ctrl = (reg_ctrl & ~MXC_CSPICTRL_PREDIV(0x0F)) |
 192                 MXC_CSPICTRL_PREDIV(pre_div);
 193         reg_ctrl = (reg_ctrl & ~MXC_CSPICTRL_POSTDIV(0x0F)) |
 194                 MXC_CSPICTRL_POSTDIV(post_div);
 195
 196         if (mode & SPI_CS_HIGH)
 197                 ss_pol = 1;
 198
 199         if (mode & SPI_CPOL) {
 200                 sclkpol = 1;
 201                 sclkctl = 1;
 202         }
 203
 204         if (mode & SPI_CPHA)
 205                 sclkpha = 1;
 206
 207         reg_config = reg_read(&regs->cfg);
 208
 209         /*
 210          * Configuration register setup
 211          * The MX51 supports different setup for each SS
 212          */
 213         reg_config = (reg_config & ~(1 << (cs + MXC_CSPICON_SSPOL))) |
 214                 (ss_pol << (cs + MXC_CSPICON_SSPOL));
 215         reg_config = (reg_config & ~(1 << (cs + MXC_CSPICON_POL))) |
 216                 (sclkpol << (cs + MXC_CSPICON_POL));
 217         reg_config = (reg_config & ~(1 << (cs + MXC_CSPICON_CTL))) |
 218                 (sclkctl << (cs + MXC_CSPICON_CTL));
 219         reg_config = (reg_config & ~(1 << (cs + MXC_CSPICON_PHA))) |
 220                 (sclkpha << (cs + MXC_CSPICON_PHA));
 221
 222         debug("reg_ctrl = 0x%x\n", reg_ctrl);
 223         reg_write(&regs->ctrl, reg_ctrl);
 224         debug("reg_config = 0x%x\n", reg_config);
 225         reg_write(&regs->cfg, reg_config);
 226
 227         /* save config register and control register */
 228         mxcs->ctrl_reg = reg_ctrl;
 229         mxcs->cfg_reg = reg_config;
 230
 231         /* clear interrupt reg */
 232         reg_write(&regs->intr, 0);
 233         reg_write(&regs->stat, MXC_CSPICTRL_TC | MXC_CSPICTRL_RXOVF);
 234
 235         return 0;
 236 }
 237 #endif
 238
 239 int spi_xchg_single(struct mxc_spi_slave *mxcs, unsigned int bitlen,
 240         const u8 *dout, u8 *din, unsigned long flags)
 241 {
 242         int nbytes = DIV_ROUND_UP(bitlen, 8);
 243         u32 data, cnt, i;
 244         struct cspi_regs *regs = (struct cspi_regs *)mxcs->base;
 245         u32 ts;
 246         int status;
 247
 248         debug("%s: bitlen %d dout 0x%lx din 0x%lx\n",
 249                 __func__, bitlen, (ulong)dout, (ulong)din);
 250
 251         mxcs->ctrl_reg = (mxcs->ctrl_reg &
 252                 ~MXC_CSPICTRL_BITCOUNT(MXC_CSPICTRL_MAXBITS)) |
 253                 MXC_CSPICTRL_BITCOUNT(bitlen - 1);
 254
 255         reg_write(&regs->ctrl, mxcs->ctrl_reg | MXC_CSPICTRL_EN);
 256 #ifdef MXC_ECSPI
 257         reg_write(&regs->cfg, mxcs->cfg_reg);
 258 #endif
 259
 260         /* Clear interrupt register */
 261         reg_write(&regs->stat, MXC_CSPICTRL_TC | MXC_CSPICTRL_RXOVF);
 262
 263         /*
 264          * The SPI controller works only with words,
 265          * check if less than a word is sent.
 266          * Access to the FIFO is only 32 bit
 267          */
 268         if (bitlen % 32) {
 269                 data = 0;
 270                 cnt = (bitlen % 32) / 8;
 271                 if (dout) {
 272                         for (i = 0; i < cnt; i++) {
 273                                 data = (data << 8) | (*dout++ & 0xFF);
 274                         }
 275                 }
 276                 debug("Sending SPI 0x%x\n", data);
 277
 278                 reg_write(&regs->txdata, data);
 279                 nbytes -= cnt;
 280         }
 281
 282         data = 0;
 283
 284         while (nbytes > 0) {
 285                 data = 0;
 286                 if (dout) {
 287                         /* Buffer is not 32-bit aligned */
 288                         if ((unsigned long)dout & 0x03) {
 289                                 data = 0;
 290                                 for (i = 0; i < 4; i++)
 291                                         data = (data << 8) | (*dout++ & 0xFF);
 292                         } else {
 293                                 data = *(u32 *)dout;
 294                                 data = cpu_to_be32(data);
 295                                 dout += 4;
 296                         }
 297                 }
 298                 debug("Sending SPI 0x%x\n", data);
 299                 reg_write(&regs->txdata, data);
 300                 nbytes -= 4;
 301         }
 302
 303         /* FIFO is written, now starts the transfer setting the XCH bit */
 304         reg_write(&regs->ctrl, mxcs->ctrl_reg |
 305                 MXC_CSPICTRL_EN | MXC_CSPICTRL_XCH);
 306
 307         ts = get_timer(0);
 308         status = reg_read(&regs->stat);
 309         /* Wait until the TC (Transfer completed) bit is set */
 310         while ((status & MXC_CSPICTRL_TC) == 0) {
 311                 if (get_timer(ts) > CONFIG_SYS_SPI_MXC_WAIT) {
 312                         printf("spi_xchg_single: Timeout!\n");
 313                         return -1;
 314                 }
 315                 status = reg_read(&regs->stat);
 316         }
 317
 318         /* Transfer completed, clear any pending request */
 319         reg_write(&regs->stat, MXC_CSPICTRL_TC | MXC_CSPICTRL_RXOVF);
 320
 321         nbytes = DIV_ROUND_UP(bitlen, 8);
 322
 323         cnt = nbytes % 32;
 324
 325         if (bitlen % 32) {
 326                 data = reg_read(&regs->rxdata);
 327                 cnt = (bitlen % 32) / 8;
 328                 data = cpu_to_be32(data) >> ((sizeof(data) - cnt) * 8);
 329                 debug("SPI Rx unaligned: 0x%x\n", data);
 330                 if (din) {
 331                         memcpy(din, &data, cnt);
 332                         din += cnt;
 333                 }
 334                 nbytes -= cnt;
 335         }
 336
 337         while (nbytes > 0) {
 338                 u32 tmp;
 339                 tmp = reg_read(&regs->rxdata);
 340                 data = cpu_to_be32(tmp);
 341                 debug("SPI Rx: 0x%x 0x%x\n", tmp, data);
 342                 cnt = min_t(u32, nbytes, sizeof(data));
 343                 if (din) {
 344                         memcpy(din, &data, cnt);
 345                         din += cnt;
 346                 }
 347                 nbytes -= cnt;
 348         }
 349
 350         return 0;
 351
 352 }
 353
 354 static int mxc_spi_xfer_internal(struct mxc_spi_slave *mxcs,
 355                                  unsigned int bitlen, const void *dout,
 356                                  void *din, unsigned long flags)
 357 {
 358         int n_bytes = DIV_ROUND_UP(bitlen, 8);
 359         int n_bits;
 360         int ret;
 361         u32 blk_size;
 362         u8 *p_outbuf = (u8 *)dout;
 363         u8 *p_inbuf = (u8 *)din;
 364
 365         if (!mxcs)
 366                 return -EINVAL;
 367
 368         if (flags & SPI_XFER_BEGIN)
 369                 mxc_spi_cs_activate(mxcs);
 370
 371         while (n_bytes > 0) {
 372                 if (n_bytes < MAX_SPI_BYTES)
 373                         blk_size = n_bytes;
 374                 else
 375                         blk_size = MAX_SPI_BYTES;
 376
 377                 n_bits = blk_size * 8;
 378
 379                 ret = spi_xchg_single(mxcs, n_bits, p_outbuf, p_inbuf, 0);
 380
 381                 if (ret)
 382                         return ret;
 383                 if (dout)
 384                         p_outbuf += blk_size;
 385                 if (din)
 386                         p_inbuf += blk_size;
 387                 n_bytes -= blk_size;
 388         }
 389
 390         if (flags & SPI_XFER_END) {
 391                 mxc_spi_cs_deactivate(mxcs);
 392         }
 393
 394         return 0;
 395 }
 396
 397 static int mxc_spi_claim_bus_internal(struct mxc_spi_slave *mxcs, int cs)
 398 {
 399         struct cspi_regs *regs = (struct cspi_regs *)mxcs->base;
 400         int ret;
 401
 402         reg_write(&regs->rxdata, 1);
 403         udelay(1);
 404         ret = spi_cfg_mxc(mxcs, cs);
 405         if (ret) {
 406                 printf("mxc_spi: cannot setup SPI controller\n");
 407                 return ret;
 408         }
 409         reg_write(&regs->period, MXC_CSPIPERIOD_32KHZ);
 410         reg_write(&regs->intr, 0);
 411
 412         return 0;
 413 }
 414
 415 #ifndef CONFIG_DM_SPI
 416 int spi_xfer(struct spi_slave *slave, unsigned int bitlen, const void *dout,
 417                 void *din, unsigned long flags)
 418 {
 419         struct mxc_spi_slave *mxcs = to_mxc_spi_slave(slave);
 420
 421         return mxc_spi_xfer_internal(mxcs, bitlen, dout, din, flags);
 422 }
 423
 424 /*
 425  * Some SPI devices require active chip-select over multiple
 426  * transactions, we achieve this using a GPIO. Still, the SPI
 427  * controller has to be configured to use one of its own chipselects.
 428  * To use this feature you have to implement board_spi_cs_gpio() to assign
 429  * a gpio value for each cs (-1 if cs doesn't need to use gpio).
 430  * You must use some unused on this SPI controller cs between 0 and 3.
 431  */
 432 static int setup_cs_gpio(struct mxc_spi_slave *mxcs,
 433                          unsigned int bus, unsigned int cs)
 434 {
 435         int ret;
 436
 437         mxcs->gpio = board_spi_cs_gpio(bus, cs);
 438         if (mxcs->gpio == -1)
 439                 return 0;
 440
 441         gpio_request(mxcs->gpio, "spi-cs");
 442         ret = gpio_direction_output(mxcs->gpio, !(mxcs->ss_pol));
 443         if (ret) {
 444                 printf("mxc_spi: cannot setup gpio %d\n", mxcs->gpio);
 445                 return -EINVAL;
 446         }
 447
 448         return 0;
 449 }
 450
 451 static unsigned long spi_bases[] = {
 452         MXC_SPI_BASE_ADDRESSES
 453 };
 454
 455 struct spi_slave *spi_setup_slave(unsigned int bus, unsigned int cs,
 456                         unsigned int max_hz, unsigned int mode)
 457 {
 458         struct mxc_spi_slave *mxcs;
 459         int ret;
 460
 461         if (bus >= ARRAY_SIZE(spi_bases))
 462                 return NULL;
 463
 464         if (max_hz == 0) {
 465                 printf("Error: desired clock is 0\n");
 466                 return NULL;
 467         }
 468
 469         mxcs = spi_alloc_slave(struct mxc_spi_slave, bus, cs);
 470         if (!mxcs) {
 471                 puts("mxc_spi: SPI Slave not allocated !\n");
 472                 return NULL;
 473         }
 474
 475         mxcs->ss_pol = (mode & SPI_CS_HIGH) ? 1 : 0;
 476
 477         ret = setup_cs_gpio(mxcs, bus, cs);
 478         if (ret < 0) {
 479                 free(mxcs);
 480                 return NULL;
 481         }
 482
 483         mxcs->base = spi_bases[bus];
 484         mxcs->max_hz = max_hz;
 485         mxcs->mode = mode;
 486
 487         return &mxcs->slave;
 488 }
 489
 490 void spi_free_slave(struct spi_slave *slave)
 491 {
 492         struct mxc_spi_slave *mxcs = to_mxc_spi_slave(slave);
 493
 494         free(mxcs);
 495 }
 496
 497 int spi_claim_bus(struct spi_slave *slave)
 498 {
 499         struct mxc_spi_slave *mxcs = to_mxc_spi_slave(slave);
 500
 501         return mxc_spi_claim_bus_internal(mxcs, slave->cs);
 502 }
 503
 504 void spi_release_bus(struct spi_slave *slave)
 505 {
 506         /* TODO: Shut the controller down */
 507 }
 508 #else
 509
 510 static int mxc_spi_probe(struct udevice *bus)
 511 {
 512         struct mxc_spi_slave *mxcs = dev_get_platdata(bus);
 513         int node = dev_of_offset(bus);
 514         const void *blob = gd->fdt_blob;
 515         int ret;
 516         int i;
 517
 518         ret = gpio_request_list_by_name(bus, "cs-gpios", mxcs->cs_gpios,
 519                                         ARRAY_SIZE(mxcs->cs_gpios), 0);
 520         if (ret < 0) {
 521                 pr_err("Can't get %s gpios! Error: %d", bus->name, ret);
 522                 return ret;
 523         }
 524
 525         for (i = 0; i < ARRAY_SIZE(mxcs->cs_gpios); i++) {
 526                 if (!dm_gpio_is_valid(&mxcs->cs_gpios[i]))
 527                         continue;
 528
 529                 ret = dm_gpio_set_dir_flags(&mxcs->cs_gpios[i],
 530                                             GPIOD_IS_OUT | GPIOD_ACTIVE_LOW);
 531                 if (ret) {
 532                         dev_err(bus, "Setting cs %d error\n", i);
 533                         return ret;
 534                 }
 535         }
 536
 537         mxcs->base = devfdt_get_addr(bus);
 538         if (mxcs->base == FDT_ADDR_T_NONE)
 539                 return -ENODEV;
 540
 541         mxcs->max_hz = fdtdec_get_int(blob, node, "spi-max-frequency",
 542                                       20000000);
 543
 544         return 0;
 545 }
 546
 547 static int mxc_spi_xfer(struct udevice *dev, unsigned int bitlen,
 548                 const void *dout, void *din, unsigned long flags)
 549 {
 550         struct mxc_spi_slave *mxcs = dev_get_platdata(dev->parent);
 551
 552
 553         return mxc_spi_xfer_internal(mxcs, bitlen, dout, din, flags);
 554 }
 555
 556 static int mxc_spi_claim_bus(struct udevice *dev)
 557 {
 558         struct mxc_spi_slave *mxcs = dev_get_platdata(dev->parent);
 559         struct dm_spi_slave_platdata *slave_plat = dev_get_parent_platdata(dev);
 560
 561         mxcs->dev = dev;
 562
 563         return mxc_spi_claim_bus_internal(mxcs, slave_plat->cs);
 564 }
 565
 566 static int mxc_spi_release_bus(struct udevice *dev)
 567 {
 568         return 0;
 569 }
 570
 571 static int mxc_spi_set_speed(struct udevice *bus, uint speed)
 572 {
 573         /* Nothing to do */
 574         return 0;
 575 }
 576
 577 static int mxc_spi_set_mode(struct udevice *bus, uint mode)
 578 {
 579         struct mxc_spi_slave *mxcs = dev_get_platdata(bus);
 580
 581         mxcs->mode = mode;
 582         mxcs->ss_pol = (mode & SPI_CS_HIGH) ? 1 : 0;
 583
 584         return 0;
 585 }
 586
 587 static const struct dm_spi_ops mxc_spi_ops = {
 588         .claim_bus      = mxc_spi_claim_bus,
 589         .release_bus    = mxc_spi_release_bus,
 590         .xfer           = mxc_spi_xfer,
 591         .set_speed      = mxc_spi_set_speed,
 592         .set_mode       = mxc_spi_set_mode,
 593 };
 594
 595 static const struct udevice_id mxc_spi_ids[] = {
 596         { .compatible = "fsl,imx51-ecspi" },
 597         { }
 598 };
 599
 600 U_BOOT_DRIVER(mxc_spi) = {
 601         .name   = "mxc_spi",
 602         .id     = UCLASS_SPI,
 603         .of_match = mxc_spi_ids,
 604         .ops    = &mxc_spi_ops,
 605         .platdata_auto_alloc_size = sizeof(struct mxc_spi_slave),
 606         .probe  = mxc_spi_probe,
 607 };
 608 #endif