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