drivers/spi/spi-uclass.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (c) 2014 Google, Inc
   4  */
   5
   6 #define LOG_CATEGORY UCLASS_SPI
   7
   8 #include <common.h>
   9 #include <dm.h>
  10 #include <errno.h>
  11 #include <log.h>
  12 #include <malloc.h>
  13 #include <spi.h>
  14 #include <spi-mem.h>
  15 #include <dm/device_compat.h>
  16 #include <asm/global_data.h>
  17 #include <dm/device-internal.h>
  18 #include <dm/uclass-internal.h>
  19 #include <dm/lists.h>
  20 #include <dm/util.h>
  21
  22 DECLARE_GLOBAL_DATA_PTR;
  23
  24 #define SPI_DEFAULT_SPEED_HZ 100000
  25
  26 static int spi_set_speed_mode(struct udevice *bus, int speed, int mode)
  27 {
  28         struct dm_spi_ops *ops;
  29         int ret;
  30
  31         ops = spi_get_ops(bus);
  32         if (ops->set_speed)
  33                 ret = ops->set_speed(bus, speed);
  34         else
  35                 ret = -EINVAL;
  36         if (ret) {
  37                 dev_err(bus, "Cannot set speed (err=%d)\n", ret);
  38                 return ret;
  39         }
  40
  41         if (ops->set_mode)
  42                 ret = ops->set_mode(bus, mode);
  43         else
  44                 ret = -EINVAL;
  45         if (ret) {
  46                 dev_err(bus, "Cannot set mode (err=%d)\n", ret);
  47                 return ret;
  48         }
  49
  50         return 0;
  51 }
  52
  53 int dm_spi_claim_bus(struct udevice *dev)
  54 {
  55         struct udevice *bus = dev->parent;
  56         struct dm_spi_ops *ops = spi_get_ops(bus);
  57         struct dm_spi_bus *spi = dev_get_uclass_priv(bus);
  58         struct spi_slave *slave = dev_get_parent_priv(dev);
  59         uint speed, mode;
  60
  61         speed = slave->max_hz;
  62         mode = slave->mode;
  63
  64         if (spi->max_hz) {
  65                 if (speed)
  66                         speed = min(speed, spi->max_hz);
  67                 else
  68                         speed = spi->max_hz;
  69         }
  70         if (!speed)
  71                 speed = SPI_DEFAULT_SPEED_HZ;
  72
  73         if (speed != spi->speed || mode != spi->mode) {
  74                 int ret = spi_set_speed_mode(bus, speed, slave->mode);
  75
  76                 if (ret)
  77                         return log_ret(ret);
  78
  79                 spi->speed = speed;
  80                 spi->mode = mode;
  81         }
  82
  83         return log_ret(ops->claim_bus ? ops->claim_bus(dev) : 0);
  84 }
  85
  86 void dm_spi_release_bus(struct udevice *dev)
  87 {
  88         struct udevice *bus = dev->parent;
  89         struct dm_spi_ops *ops = spi_get_ops(bus);
  90
  91         if (ops->release_bus)
  92                 ops->release_bus(dev);
  93 }
  94
  95 int dm_spi_xfer(struct udevice *dev, unsigned int bitlen,
  96                 const void *dout, void *din, unsigned long flags)
  97 {
  98         struct udevice *bus = dev->parent;
  99         struct dm_spi_ops *ops = spi_get_ops(bus);
 100
 101         if (bus->uclass->uc_drv->id != UCLASS_SPI)
 102                 return -EOPNOTSUPP;
 103         if (!ops->xfer)
 104                 return -ENOSYS;
 105
 106         return ops->xfer(dev, bitlen, dout, din, flags);
 107 }
 108
 109 int dm_spi_get_mmap(struct udevice *dev, ulong *map_basep, uint *map_sizep,
 110                     uint *offsetp)
 111 {
 112         struct udevice *bus = dev->parent;
 113         struct dm_spi_ops *ops = spi_get_ops(bus);
 114
 115         if (bus->uclass->uc_drv->id != UCLASS_SPI)
 116                 return -EOPNOTSUPP;
 117         if (!ops->get_mmap)
 118                 return -ENOSYS;
 119
 120         return ops->get_mmap(dev, map_basep, map_sizep, offsetp);
 121 }
 122
 123 int spi_claim_bus(struct spi_slave *slave)
 124 {
 125         return log_ret(dm_spi_claim_bus(slave->dev));
 126 }
 127
 128 void spi_release_bus(struct spi_slave *slave)
 129 {
 130         dm_spi_release_bus(slave->dev);
 131 }
 132
 133 int spi_xfer(struct spi_slave *slave, unsigned int bitlen,
 134              const void *dout, void *din, unsigned long flags)
 135 {
 136         return dm_spi_xfer(slave->dev, bitlen, dout, din, flags);
 137 }
 138
 139 int spi_write_then_read(struct spi_slave *slave, const u8 *opcode,
 140                         size_t n_opcode, const u8 *txbuf, u8 *rxbuf,
 141                         size_t n_buf)
 142 {
 143         unsigned long flags = SPI_XFER_BEGIN;
 144         int ret;
 145
 146         if (n_buf == 0)
 147                 flags |= SPI_XFER_END;
 148
 149         ret = spi_xfer(slave, n_opcode * 8, opcode, NULL, flags);
 150         if (ret) {
 151                 dev_dbg(slave->dev,
 152                         "spi: failed to send command (%zu bytes): %d\n",
 153                         n_opcode, ret);
 154         } else if (n_buf != 0) {
 155                 ret = spi_xfer(slave, n_buf * 8, txbuf, rxbuf, SPI_XFER_END);
 156                 if (ret)
 157                         dev_dbg(slave->dev,
 158                                 "spi: failed to transfer %zu bytes of data: %d\n",
 159                                 n_buf, ret);
 160         }
 161
 162         return ret;
 163 }
 164
 165 #if CONFIG_IS_ENABLED(OF_REAL)
 166 static int spi_child_post_bind(struct udevice *dev)
 167 {
 168         struct dm_spi_slave_plat *plat = dev_get_parent_plat(dev);
 169
 170         if (!dev_has_ofnode(dev))
 171                 return 0;
 172
 173         return spi_slave_of_to_plat(dev, plat);
 174 }
 175 #endif
 176
 177 static int spi_post_probe(struct udevice *bus)
 178 {
 179         if (CONFIG_IS_ENABLED(OF_REAL)) {
 180                 struct dm_spi_bus *spi = dev_get_uclass_priv(bus);
 181
 182                 spi->max_hz = dev_read_u32_default(bus, "spi-max-frequency", 0);
 183         }
 184 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
 185         struct dm_spi_ops *ops = spi_get_ops(bus);
 186         static int reloc_done;
 187
 188         if (!reloc_done) {
 189                 if (ops->claim_bus)
 190                         ops->claim_bus += gd->reloc_off;
 191                 if (ops->release_bus)
 192                         ops->release_bus += gd->reloc_off;
 193                 if (ops->set_wordlen)
 194                         ops->set_wordlen += gd->reloc_off;
 195                 if (ops->xfer)
 196                         ops->xfer += gd->reloc_off;
 197                 if (ops->set_speed)
 198                         ops->set_speed += gd->reloc_off;
 199                 if (ops->set_mode)
 200                         ops->set_mode += gd->reloc_off;
 201                 if (ops->cs_info)
 202                         ops->cs_info += gd->reloc_off;
 203                 if (ops->mem_ops) {
 204                         struct spi_controller_mem_ops *mem_ops =
 205                                 (struct spi_controller_mem_ops *)ops->mem_ops;
 206                         if (mem_ops->adjust_op_size)
 207                                 mem_ops->adjust_op_size += gd->reloc_off;
 208                         if (mem_ops->supports_op)
 209                                 mem_ops->supports_op += gd->reloc_off;
 210                         if (mem_ops->exec_op)
 211                                 mem_ops->exec_op += gd->reloc_off;
 212                 }
 213                 reloc_done++;
 214         }
 215 #endif
 216
 217         return 0;
 218 }
 219
 220 static int spi_child_pre_probe(struct udevice *dev)
 221 {
 222         struct dm_spi_slave_plat *plat = dev_get_parent_plat(dev);
 223         struct spi_slave *slave = dev_get_parent_priv(dev);
 224
 225         /*
 226          * This is needed because we pass struct spi_slave around the place
 227          * instead slave->dev (a struct udevice). So we have to have some
 228          * way to access the slave udevice given struct spi_slave. Once we
 229          * change the SPI API to use udevice instead of spi_slave, we can
 230          * drop this.
 231          */
 232         slave->dev = dev;
 233
 234         slave->max_hz = plat->max_hz;
 235         slave->mode = plat->mode;
 236         slave->wordlen = SPI_DEFAULT_WORDLEN;
 237
 238         return 0;
 239 }
 240
 241 int spi_chip_select(struct udevice *dev)
 242 {
 243         struct dm_spi_slave_plat *plat = dev_get_parent_plat(dev);
 244
 245         return plat ? plat->cs : -ENOENT;
 246 }
 247
 248 int spi_find_chip_select(struct udevice *bus, int cs, struct udevice **devp)
 249 {
 250         struct dm_spi_ops *ops;
 251         struct spi_cs_info info;
 252         struct udevice *dev;
 253         int ret;
 254
 255         /*
 256          * Ask the driver. For the moment we don't have CS info.
 257          * When we do we could provide the driver with a helper function
 258          * to figure out what chip selects are valid, or just handle the
 259          * request.
 260          */
 261         ops = spi_get_ops(bus);
 262         if (ops->cs_info) {
 263                 ret = ops->cs_info(bus, cs, &info);
 264         } else {
 265                 /*
 266                  * We could assume there is at least one valid chip select.
 267                  * The driver didn't care enough to tell us.
 268                  */
 269                 ret = 0;
 270         }
 271
 272         if (ret) {
 273                 dev_err(bus, "Invalid cs %d (err=%d)\n", cs, ret);
 274                 return ret;
 275         }
 276
 277         for (device_find_first_child(bus, &dev); dev;
 278              device_find_next_child(&dev)) {
 279                 struct dm_spi_slave_plat *plat;
 280
 281                 plat = dev_get_parent_plat(dev);
 282                 dev_dbg(bus, "%s: plat=%p, cs=%d\n", __func__, plat, plat->cs);
 283                 if (plat->cs == cs) {
 284                         *devp = dev;
 285                         return 0;
 286                 }
 287         }
 288
 289         return -ENODEV;
 290 }
 291
 292 int spi_cs_is_valid(unsigned int busnum, unsigned int cs)
 293 {
 294         struct spi_cs_info info;
 295         struct udevice *bus;
 296         int ret;
 297
 298         ret = uclass_find_device_by_seq(UCLASS_SPI, busnum, &bus);
 299         if (ret) {
 300                 log_debug("%s: No bus %d\n", __func__, busnum);
 301                 return ret;
 302         }
 303
 304         return spi_cs_info(bus, cs, &info);
 305 }
 306
 307 int spi_cs_info(struct udevice *bus, uint cs, struct spi_cs_info *info)
 308 {
 309         struct spi_cs_info local_info;
 310         int ret;
 311
 312         if (!info)
 313                 info = &local_info;
 314
 315         /* If there is a device attached, return it */
 316         info->dev = NULL;
 317         ret = spi_find_chip_select(bus, cs, &info->dev);
 318         return ret == -ENODEV ? 0 : ret;
 319 }
 320
 321 int spi_find_bus_and_cs(int busnum, int cs, struct udevice **busp,
 322                         struct udevice **devp)
 323 {
 324         struct udevice *bus, *dev;
 325         int ret;
 326
 327         ret = uclass_find_device_by_seq(UCLASS_SPI, busnum, &bus);
 328         if (ret) {
 329                 log_debug("%s: No bus %d\n", __func__, busnum);
 330                 return ret;
 331         }
 332         ret = spi_find_chip_select(bus, cs, &dev);
 333         if (ret) {
 334                 dev_dbg(bus, "%s: No cs %d\n", __func__, cs);
 335                 return ret;
 336         }
 337         *busp = bus;
 338         *devp = dev;
 339
 340         return ret;
 341 }
 342
 343 int spi_get_bus_and_cs(int busnum, int cs, struct udevice **busp,
 344                        struct spi_slave **devp)
 345 {
 346         struct udevice *bus, *dev;
 347         struct dm_spi_bus *bus_data;
 348         struct spi_slave *slave;
 349         int ret;
 350
 351 #if CONFIG_IS_ENABLED(OF_PLATDATA)
 352         ret = uclass_first_device_err(UCLASS_SPI, &bus);
 353 #else
 354         ret = uclass_get_device_by_seq(UCLASS_SPI, busnum, &bus);
 355 #endif
 356         if (ret) {
 357                 log_err("Invalid bus %d (err=%d)\n", busnum, ret);
 358                 return ret;
 359         }
 360         ret = spi_find_chip_select(bus, cs, &dev);
 361         if (ret) {
 362                 dev_err(bus, "Invalid chip select %d:%d (err=%d)\n", busnum, cs, ret);
 363                 return ret;
 364         }
 365
 366         if (!device_active(dev)) {
 367                 struct spi_slave *slave;
 368
 369                 ret = device_probe(dev);
 370                 if (ret)
 371                         goto err;
 372                 slave = dev_get_parent_priv(dev);
 373                 slave->dev = dev;
 374         }
 375
 376         slave = dev_get_parent_priv(dev);
 377         bus_data = dev_get_uclass_priv(bus);
 378
 379         /*
 380          * In case the operation speed is not yet established by
 381          * dm_spi_claim_bus() ensure the bus is configured properly.
 382          */
 383         if (!bus_data->speed) {
 384                 ret = spi_claim_bus(slave);
 385                 if (ret)
 386                         goto err;
 387         }
 388         *busp = bus;
 389         *devp = slave;
 390
 391         return 0;
 392
 393 err:
 394         log_debug("%s: Error path, device '%s'\n", __func__, dev->name);
 395
 396         return ret;
 397 }
 398
 399 int _spi_get_bus_and_cs(int busnum, int cs, int speed, int mode,
 400                         const char *drv_name, const char *dev_name,
 401                         struct udevice **busp, struct spi_slave **devp)
 402 {
 403         struct udevice *bus, *dev;
 404         struct dm_spi_slave_plat *plat;
 405         struct dm_spi_bus *bus_data;
 406         struct spi_slave *slave;
 407         bool created = false;
 408         int ret;
 409
 410 #if CONFIG_IS_ENABLED(OF_PLATDATA)
 411         ret = uclass_first_device_err(UCLASS_SPI, &bus);
 412 #else
 413         ret = uclass_get_device_by_seq(UCLASS_SPI, busnum, &bus);
 414 #endif
 415         if (ret) {
 416                 log_err("Invalid bus %d (err=%d)\n", busnum, ret);
 417                 return ret;
 418         }
 419         ret = spi_find_chip_select(bus, cs, &dev);
 420
 421         /*
 422          * If there is no such device, create one automatically. This means
 423          * that we don't need a device tree node or platform data for the
 424          * SPI flash chip - we will bind to the correct driver.
 425          */
 426         if (ret == -ENODEV && drv_name) {
 427                 dev_dbg(bus, "%s: Binding new device '%s', busnum=%d, cs=%d, driver=%s\n",
 428                         __func__, dev_name, busnum, cs, drv_name);
 429                 ret = device_bind_driver(bus, drv_name, dev_name, &dev);
 430                 if (ret) {
 431                         dev_dbg(bus, "%s: Unable to bind driver (ret=%d)\n",
 432                                 __func__, ret);
 433                         return ret;
 434                 }
 435                 plat = dev_get_parent_plat(dev);
 436                 plat->cs = cs;
 437                 if (speed) {
 438                         plat->max_hz = speed;
 439                 } else {
 440                         dev_warn(bus,
 441                                  "Warning: SPI speed fallback to %u kHz\n",
 442                                  SPI_DEFAULT_SPEED_HZ / 1000);
 443                         plat->max_hz = SPI_DEFAULT_SPEED_HZ;
 444                 }
 445                 plat->mode = mode;
 446                 created = true;
 447         } else if (ret) {
 448                 dev_err(bus, "Invalid chip select %d:%d (err=%d)\n", busnum, cs, ret);
 449                 return ret;
 450         } else if (dev) {
 451                 plat = dev_get_parent_plat(dev);
 452         }
 453
 454         if (!device_active(dev)) {
 455                 struct spi_slave *slave;
 456
 457                 ret = device_probe(dev);
 458                 if (ret)
 459                         goto err;
 460                 slave = dev_get_parent_priv(dev);
 461                 slave->dev = dev;
 462         }
 463
 464         slave = dev_get_parent_priv(dev);
 465         bus_data = dev_get_uclass_priv(bus);
 466
 467         /*
 468          * In case the operation speed is not yet established by
 469          * dm_spi_claim_bus() ensure the bus is configured properly.
 470          */
 471         if (!bus_data->speed) {
 472                 ret = spi_claim_bus(slave);
 473                 if (ret)
 474                         goto err;
 475         }
 476
 477         /* In case bus frequency or mode changed, update it. */
 478         if ((speed && bus_data->speed && bus_data->speed != speed) ||
 479             (plat && plat->mode != mode)) {
 480                 ret = spi_set_speed_mode(bus, speed, mode);
 481                 if (ret)
 482                         goto err_speed_mode;
 483         }
 484
 485         *busp = bus;
 486         *devp = slave;
 487         log_debug("%s: bus=%p, slave=%p\n", __func__, bus, *devp);
 488
 489         return 0;
 490
 491 err_speed_mode:
 492         spi_release_bus(slave);
 493 err:
 494         log_debug("%s: Error path, created=%d, device '%s'\n", __func__,
 495                   created, dev->name);
 496         if (created) {
 497                 device_remove(dev, DM_REMOVE_NORMAL);
 498                 device_unbind(dev);
 499         }
 500
 501         return ret;
 502 }
 503
 504 /* Compatibility function - to be removed */
 505 struct spi_slave *spi_setup_slave(unsigned int busnum, unsigned int cs,
 506                                   unsigned int speed, unsigned int mode)
 507 {
 508         struct spi_slave *slave;
 509         struct udevice *dev;
 510         int ret;
 511
 512         ret = _spi_get_bus_and_cs(busnum, cs, speed, mode, NULL, 0, &dev,
 513                                   &slave);
 514         if (ret)
 515                 return NULL;
 516
 517         return slave;
 518 }
 519
 520 void spi_free_slave(struct spi_slave *slave)
 521 {
 522         device_remove(slave->dev, DM_REMOVE_NORMAL);
 523 }
 524
 525 int spi_slave_of_to_plat(struct udevice *dev, struct dm_spi_slave_plat *plat)
 526 {
 527         int mode = 0;
 528         int value;
 529
 530         plat->cs = dev_read_u32_default(dev, "reg", -1);
 531         plat->max_hz = dev_read_u32_default(dev, "spi-max-frequency",
 532                                             SPI_DEFAULT_SPEED_HZ);
 533         if (dev_read_bool(dev, "spi-cpol"))
 534                 mode |= SPI_CPOL;
 535         if (dev_read_bool(dev, "spi-cpha"))
 536                 mode |= SPI_CPHA;
 537         if (dev_read_bool(dev, "spi-cs-high"))
 538                 mode |= SPI_CS_HIGH;
 539         if (dev_read_bool(dev, "spi-3wire"))
 540                 mode |= SPI_3WIRE;
 541         if (dev_read_bool(dev, "spi-half-duplex"))
 542                 mode |= SPI_PREAMBLE;
 543
 544         /* Device DUAL/QUAD mode */
 545         value = dev_read_u32_default(dev, "spi-tx-bus-width", 1);
 546         switch (value) {
 547         case 1:
 548                 break;
 549         case 2:
 550                 mode |= SPI_TX_DUAL;
 551                 break;
 552         case 4:
 553                 mode |= SPI_TX_QUAD;
 554                 break;
 555         case 8:
 556                 mode |= SPI_TX_OCTAL;
 557                 break;
 558         default:
 559                 warn_non_spl("spi-tx-bus-width %d not supported\n", value);
 560                 break;
 561         }
 562
 563         value = dev_read_u32_default(dev, "spi-rx-bus-width", 1);
 564         switch (value) {
 565         case 1:
 566                 break;
 567         case 2:
 568                 mode |= SPI_RX_DUAL;
 569                 break;
 570         case 4:
 571                 mode |= SPI_RX_QUAD;
 572                 break;
 573         case 8:
 574                 mode |= SPI_RX_OCTAL;
 575                 break;
 576         default:
 577                 warn_non_spl("spi-rx-bus-width %d not supported\n", value);
 578                 break;
 579         }
 580
 581         plat->mode = mode;
 582
 583         return 0;
 584 }
 585
 586 UCLASS_DRIVER(spi) = {
 587         .id             = UCLASS_SPI,
 588         .name           = "spi",
 589         .flags          = DM_UC_FLAG_SEQ_ALIAS,
 590 #if CONFIG_IS_ENABLED(OF_REAL)
 591         .post_bind      = dm_scan_fdt_dev,
 592 #endif
 593         .post_probe     = spi_post_probe,
 594         .child_pre_probe = spi_child_pre_probe,
 595         .per_device_auto        = sizeof(struct dm_spi_bus),
 596         .per_child_auto = sizeof(struct spi_slave),
 597         .per_child_plat_auto    = sizeof(struct dm_spi_slave_plat),
 598 #if CONFIG_IS_ENABLED(OF_REAL)
 599         .child_post_bind = spi_child_post_bind,
 600 #endif
 601 };
 602
 603 UCLASS_DRIVER(spi_generic) = {
 604         .id             = UCLASS_SPI_GENERIC,
 605         .name           = "spi_generic",
 606 };
 607
 608 U_BOOT_DRIVER(spi_generic_drv) = {
 609         .name           = "spi_generic_drv",
 610         .id             = UCLASS_SPI_GENERIC,
 611 };