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