1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2014 Google, Inc
11 #include <dm/device-internal.h>
12 #include <dm/uclass-internal.h>
16 DECLARE_GLOBAL_DATA_PTR;
18 #define SPI_DEFAULT_SPEED_HZ 100000
20 static int spi_set_speed_mode(struct udevice *bus, int speed, int mode)
22 struct dm_spi_ops *ops;
25 ops = spi_get_ops(bus);
27 ret = ops->set_speed(bus, speed);
31 printf("Cannot set speed (err=%d)\n", ret);
36 ret = ops->set_mode(bus, mode);
40 printf("Cannot set mode (err=%d)\n", ret);
47 int dm_spi_claim_bus(struct udevice *dev)
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);
55 speed = slave->max_hz;
58 speed = min(speed, (int)spi->max_hz);
63 speed = SPI_DEFAULT_SPEED_HZ;
64 if (speed != slave->speed) {
65 int ret = spi_set_speed_mode(bus, speed, slave->mode);
72 return log_ret(ops->claim_bus ? ops->claim_bus(dev) : 0);
75 void dm_spi_release_bus(struct udevice *dev)
77 struct udevice *bus = dev->parent;
78 struct dm_spi_ops *ops = spi_get_ops(bus);
81 ops->release_bus(dev);
84 int dm_spi_xfer(struct udevice *dev, unsigned int bitlen,
85 const void *dout, void *din, unsigned long flags)
87 struct udevice *bus = dev->parent;
88 struct dm_spi_ops *ops = spi_get_ops(bus);
90 if (bus->uclass->uc_drv->id != UCLASS_SPI)
95 return ops->xfer(dev, bitlen, dout, din, flags);
98 int dm_spi_get_mmap(struct udevice *dev, ulong *map_basep, uint *map_sizep,
101 struct udevice *bus = dev->parent;
102 struct dm_spi_ops *ops = spi_get_ops(bus);
104 if (bus->uclass->uc_drv->id != UCLASS_SPI)
109 return ops->get_mmap(dev, map_basep, map_sizep, offsetp);
112 int spi_claim_bus(struct spi_slave *slave)
114 return log_ret(dm_spi_claim_bus(slave->dev));
117 void spi_release_bus(struct spi_slave *slave)
119 dm_spi_release_bus(slave->dev);
122 int spi_xfer(struct spi_slave *slave, unsigned int bitlen,
123 const void *dout, void *din, unsigned long flags)
125 return dm_spi_xfer(slave->dev, bitlen, dout, din, flags);
128 int spi_write_then_read(struct spi_slave *slave, const u8 *opcode,
129 size_t n_opcode, const u8 *txbuf, u8 *rxbuf,
132 unsigned long flags = SPI_XFER_BEGIN;
136 flags |= SPI_XFER_END;
138 ret = spi_xfer(slave, n_opcode * 8, opcode, NULL, flags);
140 debug("spi: failed to send command (%zu bytes): %d\n",
142 } else if (n_buf != 0) {
143 ret = spi_xfer(slave, n_buf * 8, txbuf, rxbuf, SPI_XFER_END);
145 debug("spi: failed to transfer %zu bytes of data: %d\n",
152 #if !CONFIG_IS_ENABLED(OF_PLATDATA)
153 static int spi_child_post_bind(struct udevice *dev)
155 struct dm_spi_slave_platdata *plat = dev_get_parent_platdata(dev);
157 if (!dev_of_valid(dev))
160 return spi_slave_ofdata_to_platdata(dev, plat);
164 static int spi_post_probe(struct udevice *bus)
166 #if !CONFIG_IS_ENABLED(OF_PLATDATA)
167 struct dm_spi_bus *spi = dev_get_uclass_priv(bus);
169 spi->max_hz = dev_read_u32_default(bus, "spi-max-frequency", 0);
171 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
172 struct dm_spi_ops *ops = spi_get_ops(bus);
173 static int reloc_done;
177 ops->claim_bus += gd->reloc_off;
178 if (ops->release_bus)
179 ops->release_bus += gd->reloc_off;
180 if (ops->set_wordlen)
181 ops->set_wordlen += gd->reloc_off;
183 ops->xfer += gd->reloc_off;
185 ops->set_speed += gd->reloc_off;
187 ops->set_mode += gd->reloc_off;
189 ops->cs_info += gd->reloc_off;
197 static int spi_child_pre_probe(struct udevice *dev)
199 struct dm_spi_slave_platdata *plat = dev_get_parent_platdata(dev);
200 struct spi_slave *slave = dev_get_parent_priv(dev);
203 * This is needed because we pass struct spi_slave around the place
204 * instead slave->dev (a struct udevice). So we have to have some
205 * way to access the slave udevice given struct spi_slave. Once we
206 * change the SPI API to use udevice instead of spi_slave, we can
211 slave->max_hz = plat->max_hz;
212 slave->mode = plat->mode;
213 slave->wordlen = SPI_DEFAULT_WORDLEN;
218 int spi_chip_select(struct udevice *dev)
220 struct dm_spi_slave_platdata *plat = dev_get_parent_platdata(dev);
222 return plat ? plat->cs : -ENOENT;
225 int spi_find_chip_select(struct udevice *bus, int cs, struct udevice **devp)
227 struct dm_spi_ops *ops;
228 struct spi_cs_info info;
233 * Ask the driver. For the moment we don't have CS info.
234 * When we do we could provide the driver with a helper function
235 * to figure out what chip selects are valid, or just handle the
238 ops = spi_get_ops(bus);
240 ret = ops->cs_info(bus, cs, &info);
243 * We could assume there is at least one valid chip select.
244 * The driver didn't care enough to tell us.
250 printf("Invalid cs %d (err=%d)\n", cs, ret);
254 for (device_find_first_child(bus, &dev); dev;
255 device_find_next_child(&dev)) {
256 struct dm_spi_slave_platdata *plat;
258 plat = dev_get_parent_platdata(dev);
259 debug("%s: plat=%p, cs=%d\n", __func__, plat, plat->cs);
260 if (plat->cs == cs) {
269 int spi_cs_is_valid(unsigned int busnum, unsigned int cs)
271 struct spi_cs_info info;
275 ret = uclass_find_device_by_seq(UCLASS_SPI, busnum, false, &bus);
277 debug("%s: No bus %d\n", __func__, busnum);
281 return spi_cs_info(bus, cs, &info);
284 int spi_cs_info(struct udevice *bus, uint cs, struct spi_cs_info *info)
286 struct spi_cs_info local_info;
292 /* If there is a device attached, return it */
294 ret = spi_find_chip_select(bus, cs, &info->dev);
295 return ret == -ENODEV ? 0 : ret;
298 int spi_find_bus_and_cs(int busnum, int cs, struct udevice **busp,
299 struct udevice **devp)
301 struct udevice *bus, *dev;
304 ret = uclass_find_device_by_seq(UCLASS_SPI, busnum, false, &bus);
306 debug("%s: No bus %d\n", __func__, busnum);
309 ret = spi_find_chip_select(bus, cs, &dev);
311 debug("%s: No cs %d\n", __func__, cs);
320 int spi_get_bus_and_cs(int busnum, int cs, int speed, int mode,
321 const char *drv_name, const char *dev_name,
322 struct udevice **busp, struct spi_slave **devp)
324 struct udevice *bus, *dev;
325 struct dm_spi_slave_platdata *plat;
326 struct spi_slave *slave;
327 bool created = false;
330 #if CONFIG_IS_ENABLED(OF_PLATDATA)
331 ret = uclass_first_device_err(UCLASS_SPI, &bus);
333 ret = uclass_get_device_by_seq(UCLASS_SPI, busnum, &bus);
336 printf("Invalid bus %d (err=%d)\n", busnum, ret);
339 ret = spi_find_chip_select(bus, cs, &dev);
342 * If there is no such device, create one automatically. This means
343 * that we don't need a device tree node or platform data for the
344 * SPI flash chip - we will bind to the correct driver.
346 if (ret == -ENODEV && drv_name) {
347 debug("%s: Binding new device '%s', busnum=%d, cs=%d, driver=%s\n",
348 __func__, dev_name, busnum, cs, drv_name);
349 ret = device_bind_driver(bus, drv_name, dev_name, &dev);
351 debug("%s: Unable to bind driver (ret=%d)\n", __func__,
355 plat = dev_get_parent_platdata(dev);
358 plat->max_hz = speed;
360 printf("Warning: SPI speed fallback to %u kHz\n",
361 SPI_DEFAULT_SPEED_HZ / 1000);
362 plat->max_hz = SPI_DEFAULT_SPEED_HZ;
367 printf("Invalid chip select %d:%d (err=%d)\n", busnum, cs,
372 if (!device_active(dev)) {
373 struct spi_slave *slave;
375 ret = device_probe(dev);
378 slave = dev_get_parent_priv(dev);
382 slave = dev_get_parent_priv(dev);
385 * In case the operation speed is not yet established by
386 * dm_spi_claim_bus() ensure the bus is configured properly.
389 ret = spi_claim_bus(slave);
396 debug("%s: bus=%p, slave=%p\n", __func__, bus, *devp);
401 debug("%s: Error path, created=%d, device '%s'\n", __func__,
404 device_remove(dev, DM_REMOVE_NORMAL);
411 /* Compatibility function - to be removed */
412 struct spi_slave *spi_setup_slave(unsigned int busnum, unsigned int cs,
413 unsigned int speed, unsigned int mode)
415 struct spi_slave *slave;
419 ret = spi_get_bus_and_cs(busnum, cs, speed, mode, NULL, 0, &dev,
427 void spi_free_slave(struct spi_slave *slave)
429 device_remove(slave->dev, DM_REMOVE_NORMAL);
433 int spi_slave_ofdata_to_platdata(struct udevice *dev,
434 struct dm_spi_slave_platdata *plat)
439 plat->cs = dev_read_u32_default(dev, "reg", -1);
440 plat->max_hz = dev_read_u32_default(dev, "spi-max-frequency",
441 SPI_DEFAULT_SPEED_HZ);
442 if (dev_read_bool(dev, "spi-cpol"))
444 if (dev_read_bool(dev, "spi-cpha"))
446 if (dev_read_bool(dev, "spi-cs-high"))
448 if (dev_read_bool(dev, "spi-3wire"))
450 if (dev_read_bool(dev, "spi-half-duplex"))
451 mode |= SPI_PREAMBLE;
453 /* Device DUAL/QUAD mode */
454 value = dev_read_u32_default(dev, "spi-tx-bus-width", 1);
465 mode |= SPI_TX_OCTAL;
468 warn_non_spl("spi-tx-bus-width %d not supported\n", value);
472 value = dev_read_u32_default(dev, "spi-rx-bus-width", 1);
483 mode |= SPI_RX_OCTAL;
486 warn_non_spl("spi-rx-bus-width %d not supported\n", value);
495 UCLASS_DRIVER(spi) = {
498 .flags = DM_UC_FLAG_SEQ_ALIAS,
499 #if !CONFIG_IS_ENABLED(OF_PLATDATA)
500 .post_bind = dm_scan_fdt_dev,
502 .post_probe = spi_post_probe,
503 .child_pre_probe = spi_child_pre_probe,
504 .per_device_auto_alloc_size = sizeof(struct dm_spi_bus),
505 .per_child_auto_alloc_size = sizeof(struct spi_slave),
506 .per_child_platdata_auto_alloc_size =
507 sizeof(struct dm_spi_slave_platdata),
508 #if !CONFIG_IS_ENABLED(OF_PLATDATA)
509 .child_post_bind = spi_child_post_bind,
513 UCLASS_DRIVER(spi_generic) = {
514 .id = UCLASS_SPI_GENERIC,
515 .name = "spi_generic",
518 U_BOOT_DRIVER(spi_generic_drv) = {
519 .name = "spi_generic_drv",
520 .id = UCLASS_SPI_GENERIC,