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