drivers/spi/spi-uclass.c

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