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 dm_spi_ops *ops;
 228         struct spi_cs_info info;
 229         struct udevice *dev;
 230         int ret;
 231
 232         /*
 233          * Ask the driver. For the moment we don't have CS info.
 234          * When we do we could provide the driver with a helper function
 235          * to figure out what chip selects are valid, or just handle the
 236          * request.
 237          */
 238         ops = spi_get_ops(bus);
 239         if (ops->cs_info) {
 240                 ret = ops->cs_info(bus, cs, &info);
 241         } else {
 242                 /*
 243                  * We could assume there is at least one valid chip select.
 244                  * The driver didn't care enough to tell us.
 245                  */
 246                 ret = 0;
 247         }
 248
 249         if (ret) {
 250                 printf("Invalid cs %d (err=%d)\n", cs, ret);
 251                 return ret;
 252         }
 253
 254         for (device_find_first_child(bus, &dev); dev;
 255              device_find_next_child(&dev)) {
 256                 struct dm_spi_slave_platdata *plat;
 257
 258                 plat = dev_get_parent_platdata(dev);
 259                 debug("%s: plat=%p, cs=%d\n", __func__, plat, plat->cs);
 260                 if (plat->cs == cs) {
 261                         *devp = dev;
 262                         return 0;
 263                 }
 264         }
 265
 266         return -ENODEV;
 267 }
 268
 269 int spi_cs_is_valid(unsigned int busnum, unsigned int cs)
 270 {
 271         struct spi_cs_info info;
 272         struct udevice *bus;
 273         int ret;
 274
 275         ret = uclass_find_device_by_seq(UCLASS_SPI, busnum, false, &bus);
 276         if (ret) {
 277                 debug("%s: No bus %d\n", __func__, busnum);
 278                 return ret;
 279         }
 280
 281         return spi_cs_info(bus, cs, &info);
 282 }
 283
 284 int spi_cs_info(struct udevice *bus, uint cs, struct spi_cs_info *info)
 285 {
 286         struct spi_cs_info local_info;
 287         int ret;
 288
 289         if (!info)
 290                 info = &local_info;
 291
 292         /* If there is a device attached, return it */
 293         info->dev = NULL;
 294         ret = spi_find_chip_select(bus, cs, &info->dev);
 295         return ret == -ENODEV ? 0 : ret;
 296 }
 297
 298 int spi_find_bus_and_cs(int busnum, int cs, struct udevice **busp,
 299                         struct udevice **devp)
 300 {
 301         struct udevice *bus, *dev;
 302         int ret;
 303
 304         ret = uclass_find_device_by_seq(UCLASS_SPI, busnum, false, &bus);
 305         if (ret) {
 306                 debug("%s: No bus %d\n", __func__, busnum);
 307                 return ret;
 308         }
 309         ret = spi_find_chip_select(bus, cs, &dev);
 310         if (ret) {
 311                 debug("%s: No cs %d\n", __func__, cs);
 312                 return ret;
 313         }
 314         *busp = bus;
 315         *devp = dev;
 316
 317         return ret;
 318 }
 319
 320 int spi_get_bus_and_cs(int busnum, int cs, int speed, int mode,
 321                        const char *drv_name, const char *dev_name,
 322                        struct udevice **busp, struct spi_slave **devp)
 323 {
 324         struct udevice *bus, *dev;
 325         struct dm_spi_slave_platdata *plat;
 326         struct spi_slave *slave;
 327         bool created = false;
 328         int ret;
 329
 330 #if CONFIG_IS_ENABLED(OF_PLATDATA)
 331         ret = uclass_first_device_err(UCLASS_SPI, &bus);
 332 #else
 333         ret = uclass_get_device_by_seq(UCLASS_SPI, busnum, &bus);
 334 #endif
 335         if (ret) {
 336                 printf("Invalid bus %d (err=%d)\n", busnum, ret);
 337                 return ret;
 338         }
 339         ret = spi_find_chip_select(bus, cs, &dev);
 340
 341         /*
 342          * If there is no such device, create one automatically. This means
 343          * that we don't need a device tree node or platform data for the
 344          * SPI flash chip - we will bind to the correct driver.
 345          */
 346         if (ret == -ENODEV && drv_name) {
 347                 debug("%s: Binding new device '%s', busnum=%d, cs=%d, driver=%s\n",
 348                       __func__, dev_name, busnum, cs, drv_name);
 349                 ret = device_bind_driver(bus, drv_name, dev_name, &dev);
 350                 if (ret) {
 351                         debug("%s: Unable to bind driver (ret=%d)\n", __func__,
 352                               ret);
 353                         return ret;
 354                 }
 355                 plat = dev_get_parent_platdata(dev);
 356                 plat->cs = cs;
 357                 if (speed) {
 358                         plat->max_hz = speed;
 359                 } else {
 360                         printf("Warning: SPI speed fallback to %u kHz\n",
 361                                SPI_DEFAULT_SPEED_HZ / 1000);
 362                         plat->max_hz = SPI_DEFAULT_SPEED_HZ;
 363                 }
 364                 plat->mode = mode;
 365                 created = true;
 366         } else if (ret) {
 367                 printf("Invalid chip select %d:%d (err=%d)\n", busnum, cs,
 368                        ret);
 369                 return ret;
 370         }
 371
 372         if (!device_active(dev)) {
 373                 struct spi_slave *slave;
 374
 375                 ret = device_probe(dev);
 376                 if (ret)
 377                         goto err;
 378                 slave = dev_get_parent_priv(dev);
 379                 slave->dev = dev;
 380         }
 381
 382         slave = dev_get_parent_priv(dev);
 383
 384         /*
 385          * In case the operation speed is not yet established by
 386          * dm_spi_claim_bus() ensure the bus is configured properly.
 387          */
 388         if (!slave->speed) {
 389                 ret = spi_claim_bus(slave);
 390                 if (ret)
 391                         goto err;
 392         }
 393
 394         *busp = bus;
 395         *devp = slave;
 396         debug("%s: bus=%p, slave=%p\n", __func__, bus, *devp);
 397
 398         return 0;
 399
 400 err:
 401         debug("%s: Error path, created=%d, device '%s'\n", __func__,
 402               created, dev->name);
 403         if (created) {
 404                 device_remove(dev, DM_REMOVE_NORMAL);
 405                 device_unbind(dev);
 406         }
 407
 408         return ret;
 409 }
 410
 411 /* Compatibility function - to be removed */
 412 struct spi_slave *spi_setup_slave(unsigned int busnum, unsigned int cs,
 413                                   unsigned int speed, unsigned int mode)
 414 {
 415         struct spi_slave *slave;
 416         struct udevice *dev;
 417         int ret;
 418
 419         ret = spi_get_bus_and_cs(busnum, cs, speed, mode, NULL, 0, &dev,
 420                                  &slave);
 421         if (ret)
 422                 return NULL;
 423
 424         return slave;
 425 }
 426
 427 void spi_free_slave(struct spi_slave *slave)
 428 {
 429         device_remove(slave->dev, DM_REMOVE_NORMAL);
 430         slave->dev = NULL;
 431 }
 432
 433 int spi_slave_ofdata_to_platdata(struct udevice *dev,
 434                                  struct dm_spi_slave_platdata *plat)
 435 {
 436         int mode = 0;
 437         int value;
 438
 439         plat->cs = dev_read_u32_default(dev, "reg", -1);
 440         plat->max_hz = dev_read_u32_default(dev, "spi-max-frequency",
 441                                             SPI_DEFAULT_SPEED_HZ);
 442         if (dev_read_bool(dev, "spi-cpol"))
 443                 mode |= SPI_CPOL;
 444         if (dev_read_bool(dev, "spi-cpha"))
 445                 mode |= SPI_CPHA;
 446         if (dev_read_bool(dev, "spi-cs-high"))
 447                 mode |= SPI_CS_HIGH;
 448         if (dev_read_bool(dev, "spi-3wire"))
 449                 mode |= SPI_3WIRE;
 450         if (dev_read_bool(dev, "spi-half-duplex"))
 451                 mode |= SPI_PREAMBLE;
 452
 453         /* Device DUAL/QUAD mode */
 454         value = dev_read_u32_default(dev, "spi-tx-bus-width", 1);
 455         switch (value) {
 456         case 1:
 457                 break;
 458         case 2:
 459                 mode |= SPI_TX_DUAL;
 460                 break;
 461         case 4:
 462                 mode |= SPI_TX_QUAD;
 463                 break;
 464         case 8:
 465                 mode |= SPI_TX_OCTAL;
 466                 break;
 467         default:
 468                 warn_non_spl("spi-tx-bus-width %d not supported\n", value);
 469                 break;
 470         }
 471
 472         value = dev_read_u32_default(dev, "spi-rx-bus-width", 1);
 473         switch (value) {
 474         case 1:
 475                 break;
 476         case 2:
 477                 mode |= SPI_RX_DUAL;
 478                 break;
 479         case 4:
 480                 mode |= SPI_RX_QUAD;
 481                 break;
 482         case 8:
 483                 mode |= SPI_RX_OCTAL;
 484                 break;
 485         default:
 486                 warn_non_spl("spi-rx-bus-width %d not supported\n", value);
 487                 break;
 488         }
 489
 490         plat->mode = mode;
 491
 492         return 0;
 493 }
 494
 495 UCLASS_DRIVER(spi) = {
 496         .id             = UCLASS_SPI,
 497         .name           = "spi",
 498         .flags          = DM_UC_FLAG_SEQ_ALIAS,
 499 #if !CONFIG_IS_ENABLED(OF_PLATDATA)
 500         .post_bind      = dm_scan_fdt_dev,
 501 #endif
 502         .post_probe     = spi_post_probe,
 503         .child_pre_probe = spi_child_pre_probe,
 504         .per_device_auto_alloc_size = sizeof(struct dm_spi_bus),
 505         .per_child_auto_alloc_size = sizeof(struct spi_slave),
 506         .per_child_platdata_auto_alloc_size =
 507                         sizeof(struct dm_spi_slave_platdata),
 508 #if !CONFIG_IS_ENABLED(OF_PLATDATA)
 509         .child_post_bind = spi_child_post_bind,
 510 #endif
 511 };
 512
 513 UCLASS_DRIVER(spi_generic) = {
 514         .id             = UCLASS_SPI_GENERIC,
 515         .name           = "spi_generic",
 516 };
 517
 518 U_BOOT_DRIVER(spi_generic_drv) = {
 519         .name           = "spi_generic_drv",
 520         .id             = UCLASS_SPI_GENERIC,
 521 };