1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2014 Google, Inc
12 #include <dm/device-internal.h>
13 #include <dm/uclass-internal.h>
17 DECLARE_GLOBAL_DATA_PTR;
19 #define SPI_DEFAULT_SPEED_HZ 100000
21 static int spi_set_speed_mode(struct udevice *bus, int speed, int mode)
23 struct dm_spi_ops *ops;
26 ops = spi_get_ops(bus);
28 ret = ops->set_speed(bus, speed);
32 printf("Cannot set speed (err=%d)\n", ret);
37 ret = ops->set_mode(bus, mode);
41 printf("Cannot set mode (err=%d)\n", ret);
48 int dm_spi_claim_bus(struct udevice *dev)
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);
56 speed = slave->max_hz;
59 speed = min(speed, (int)spi->max_hz);
64 speed = SPI_DEFAULT_SPEED_HZ;
65 if (speed != slave->speed) {
66 int ret = spi_set_speed_mode(bus, speed, slave->mode);
73 return log_ret(ops->claim_bus ? ops->claim_bus(dev) : 0);
76 void dm_spi_release_bus(struct udevice *dev)
78 struct udevice *bus = dev->parent;
79 struct dm_spi_ops *ops = spi_get_ops(bus);
82 ops->release_bus(dev);
85 int dm_spi_xfer(struct udevice *dev, unsigned int bitlen,
86 const void *dout, void *din, unsigned long flags)
88 struct udevice *bus = dev->parent;
89 struct dm_spi_ops *ops = spi_get_ops(bus);
91 if (bus->uclass->uc_drv->id != UCLASS_SPI)
96 return ops->xfer(dev, bitlen, dout, din, flags);
99 int dm_spi_get_mmap(struct udevice *dev, ulong *map_basep, uint *map_sizep,
102 struct udevice *bus = dev->parent;
103 struct dm_spi_ops *ops = spi_get_ops(bus);
105 if (bus->uclass->uc_drv->id != UCLASS_SPI)
110 return ops->get_mmap(dev, map_basep, map_sizep, offsetp);
113 int spi_claim_bus(struct spi_slave *slave)
115 return log_ret(dm_spi_claim_bus(slave->dev));
118 void spi_release_bus(struct spi_slave *slave)
120 dm_spi_release_bus(slave->dev);
123 int spi_xfer(struct spi_slave *slave, unsigned int bitlen,
124 const void *dout, void *din, unsigned long flags)
126 return dm_spi_xfer(slave->dev, bitlen, dout, din, flags);
129 int spi_write_then_read(struct spi_slave *slave, const u8 *opcode,
130 size_t n_opcode, const u8 *txbuf, u8 *rxbuf,
133 unsigned long flags = SPI_XFER_BEGIN;
137 flags |= SPI_XFER_END;
139 ret = spi_xfer(slave, n_opcode * 8, opcode, NULL, flags);
141 debug("spi: failed to send command (%zu bytes): %d\n",
143 } else if (n_buf != 0) {
144 ret = spi_xfer(slave, n_buf * 8, txbuf, rxbuf, SPI_XFER_END);
146 debug("spi: failed to transfer %zu bytes of data: %d\n",
153 #if !CONFIG_IS_ENABLED(OF_PLATDATA)
154 static int spi_child_post_bind(struct udevice *dev)
156 struct dm_spi_slave_platdata *plat = dev_get_parent_plat(dev);
158 if (!dev_of_valid(dev))
161 return spi_slave_ofdata_to_platdata(dev, plat);
165 static int spi_post_probe(struct udevice *bus)
167 #if !CONFIG_IS_ENABLED(OF_PLATDATA)
168 struct dm_spi_bus *spi = dev_get_uclass_priv(bus);
170 spi->max_hz = dev_read_u32_default(bus, "spi-max-frequency", 0);
172 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
173 struct dm_spi_ops *ops = spi_get_ops(bus);
174 static int reloc_done;
178 ops->claim_bus += gd->reloc_off;
179 if (ops->release_bus)
180 ops->release_bus += gd->reloc_off;
181 if (ops->set_wordlen)
182 ops->set_wordlen += gd->reloc_off;
184 ops->xfer += gd->reloc_off;
186 ops->set_speed += gd->reloc_off;
188 ops->set_mode += gd->reloc_off;
190 ops->cs_info += gd->reloc_off;
198 static int spi_child_pre_probe(struct udevice *dev)
200 struct dm_spi_slave_platdata *plat = dev_get_parent_plat(dev);
201 struct spi_slave *slave = dev_get_parent_priv(dev);
204 * This is needed because we pass struct spi_slave around the place
205 * instead slave->dev (a struct udevice). So we have to have some
206 * way to access the slave udevice given struct spi_slave. Once we
207 * change the SPI API to use udevice instead of spi_slave, we can
212 slave->max_hz = plat->max_hz;
213 slave->mode = plat->mode;
214 slave->wordlen = SPI_DEFAULT_WORDLEN;
219 int spi_chip_select(struct udevice *dev)
221 struct dm_spi_slave_platdata *plat = dev_get_parent_plat(dev);
223 return plat ? plat->cs : -ENOENT;
226 int spi_find_chip_select(struct udevice *bus, int cs, struct udevice **devp)
228 struct dm_spi_ops *ops;
229 struct spi_cs_info info;
234 * Ask the driver. For the moment we don't have CS info.
235 * When we do we could provide the driver with a helper function
236 * to figure out what chip selects are valid, or just handle the
239 ops = spi_get_ops(bus);
241 ret = ops->cs_info(bus, cs, &info);
244 * We could assume there is at least one valid chip select.
245 * The driver didn't care enough to tell us.
251 printf("Invalid cs %d (err=%d)\n", cs, ret);
255 for (device_find_first_child(bus, &dev); dev;
256 device_find_next_child(&dev)) {
257 struct dm_spi_slave_platdata *plat;
259 plat = dev_get_parent_plat(dev);
260 debug("%s: plat=%p, cs=%d\n", __func__, plat, plat->cs);
261 if (plat->cs == cs) {
270 int spi_cs_is_valid(unsigned int busnum, unsigned int cs)
272 struct spi_cs_info info;
276 ret = uclass_find_device_by_seq(UCLASS_SPI, busnum, false, &bus);
278 debug("%s: No bus %d\n", __func__, busnum);
282 return spi_cs_info(bus, cs, &info);
285 int spi_cs_info(struct udevice *bus, uint cs, struct spi_cs_info *info)
287 struct spi_cs_info local_info;
293 /* If there is a device attached, return it */
295 ret = spi_find_chip_select(bus, cs, &info->dev);
296 return ret == -ENODEV ? 0 : ret;
299 int spi_find_bus_and_cs(int busnum, int cs, struct udevice **busp,
300 struct udevice **devp)
302 struct udevice *bus, *dev;
305 ret = uclass_find_device_by_seq(UCLASS_SPI, busnum, false, &bus);
307 debug("%s: No bus %d\n", __func__, busnum);
310 ret = spi_find_chip_select(bus, cs, &dev);
312 debug("%s: No cs %d\n", __func__, cs);
321 int spi_get_bus_and_cs(int busnum, int cs, int speed, int mode,
322 const char *drv_name, const char *dev_name,
323 struct udevice **busp, struct spi_slave **devp)
325 struct udevice *bus, *dev;
326 struct dm_spi_slave_platdata *plat;
327 struct spi_slave *slave;
328 bool created = false;
331 #if CONFIG_IS_ENABLED(OF_PLATDATA)
332 ret = uclass_first_device_err(UCLASS_SPI, &bus);
334 ret = uclass_get_device_by_seq(UCLASS_SPI, busnum, &bus);
337 printf("Invalid bus %d (err=%d)\n", busnum, ret);
340 ret = spi_find_chip_select(bus, cs, &dev);
343 * If there is no such device, create one automatically. This means
344 * that we don't need a device tree node or platform data for the
345 * SPI flash chip - we will bind to the correct driver.
347 if (ret == -ENODEV && drv_name) {
348 debug("%s: Binding new device '%s', busnum=%d, cs=%d, driver=%s\n",
349 __func__, dev_name, busnum, cs, drv_name);
350 ret = device_bind_driver(bus, drv_name, dev_name, &dev);
352 debug("%s: Unable to bind driver (ret=%d)\n", __func__,
356 plat = dev_get_parent_plat(dev);
359 plat->max_hz = speed;
361 printf("Warning: SPI speed fallback to %u kHz\n",
362 SPI_DEFAULT_SPEED_HZ / 1000);
363 plat->max_hz = SPI_DEFAULT_SPEED_HZ;
368 printf("Invalid chip select %d:%d (err=%d)\n", busnum, cs,
373 if (!device_active(dev)) {
374 struct spi_slave *slave;
376 ret = device_probe(dev);
379 slave = dev_get_parent_priv(dev);
383 slave = dev_get_parent_priv(dev);
386 * In case the operation speed is not yet established by
387 * dm_spi_claim_bus() ensure the bus is configured properly.
390 ret = spi_claim_bus(slave);
397 debug("%s: bus=%p, slave=%p\n", __func__, bus, *devp);
402 debug("%s: Error path, created=%d, device '%s'\n", __func__,
405 device_remove(dev, DM_REMOVE_NORMAL);
412 /* Compatibility function - to be removed */
413 struct spi_slave *spi_setup_slave(unsigned int busnum, unsigned int cs,
414 unsigned int speed, unsigned int mode)
416 struct spi_slave *slave;
420 ret = spi_get_bus_and_cs(busnum, cs, speed, mode, NULL, 0, &dev,
428 void spi_free_slave(struct spi_slave *slave)
430 device_remove(slave->dev, DM_REMOVE_NORMAL);
434 int spi_slave_ofdata_to_platdata(struct udevice *dev,
435 struct dm_spi_slave_platdata *plat)
440 plat->cs = dev_read_u32_default(dev, "reg", -1);
441 plat->max_hz = dev_read_u32_default(dev, "spi-max-frequency",
442 SPI_DEFAULT_SPEED_HZ);
443 if (dev_read_bool(dev, "spi-cpol"))
445 if (dev_read_bool(dev, "spi-cpha"))
447 if (dev_read_bool(dev, "spi-cs-high"))
449 if (dev_read_bool(dev, "spi-3wire"))
451 if (dev_read_bool(dev, "spi-half-duplex"))
452 mode |= SPI_PREAMBLE;
454 /* Device DUAL/QUAD mode */
455 value = dev_read_u32_default(dev, "spi-tx-bus-width", 1);
466 mode |= SPI_TX_OCTAL;
469 warn_non_spl("spi-tx-bus-width %d not supported\n", value);
473 value = dev_read_u32_default(dev, "spi-rx-bus-width", 1);
484 mode |= SPI_RX_OCTAL;
487 warn_non_spl("spi-rx-bus-width %d not supported\n", value);
496 UCLASS_DRIVER(spi) = {
499 .flags = DM_UC_FLAG_SEQ_ALIAS,
500 #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
501 .post_bind = dm_scan_fdt_dev,
503 .post_probe = spi_post_probe,
504 .child_pre_probe = spi_child_pre_probe,
505 .per_device_auto = sizeof(struct dm_spi_bus),
506 .per_child_auto = sizeof(struct spi_slave),
507 .per_child_plat_auto =
508 sizeof(struct dm_spi_slave_platdata),
509 #if !CONFIG_IS_ENABLED(OF_PLATDATA)
510 .child_post_bind = spi_child_post_bind,
514 UCLASS_DRIVER(spi_generic) = {
515 .id = UCLASS_SPI_GENERIC,
516 .name = "spi_generic",
519 U_BOOT_DRIVER(spi_generic_drv) = {
520 .name = "spi_generic_drv",
521 .id = UCLASS_SPI_GENERIC,