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