drivers/spi/spi-uclass.c

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