1 // SPDX-License-Identifier: GPL-2.0-or-later
4 // Copyright (C) 2005 David Brownell
5 // Copyright (C) 2008 Secret Lab Technologies Ltd.
7 #include <linux/kernel.h>
8 #include <linux/device.h>
9 #include <linux/init.h>
10 #include <linux/cache.h>
11 #include <linux/dma-mapping.h>
12 #include <linux/dmaengine.h>
13 #include <linux/mutex.h>
14 #include <linux/of_device.h>
15 #include <linux/of_irq.h>
16 #include <linux/clk/clk-conf.h>
17 #include <linux/slab.h>
18 #include <linux/mod_devicetable.h>
19 #include <linux/spi/spi.h>
20 #include <linux/spi/spi-mem.h>
21 #include <linux/of_gpio.h>
22 #include <linux/gpio/consumer.h>
23 #include <linux/pm_runtime.h>
24 #include <linux/pm_domain.h>
25 #include <linux/property.h>
26 #include <linux/export.h>
27 #include <linux/sched/rt.h>
28 #include <uapi/linux/sched/types.h>
29 #include <linux/delay.h>
30 #include <linux/kthread.h>
31 #include <linux/ioport.h>
32 #include <linux/acpi.h>
33 #include <linux/highmem.h>
34 #include <linux/idr.h>
35 #include <linux/platform_data/x86/apple.h>
37 #define CREATE_TRACE_POINTS
38 #include <trace/events/spi.h>
39 EXPORT_TRACEPOINT_SYMBOL(spi_transfer_start);
40 EXPORT_TRACEPOINT_SYMBOL(spi_transfer_stop);
42 #include "internals.h"
44 static DEFINE_IDR(spi_master_idr);
46 static void spidev_release(struct device *dev)
48 struct spi_device *spi = to_spi_device(dev);
50 spi_controller_put(spi->controller);
51 kfree(spi->driver_override);
56 modalias_show(struct device *dev, struct device_attribute *a, char *buf)
58 const struct spi_device *spi = to_spi_device(dev);
61 len = acpi_device_modalias(dev, buf, PAGE_SIZE - 1);
65 return sprintf(buf, "%s%s\n", SPI_MODULE_PREFIX, spi->modalias);
67 static DEVICE_ATTR_RO(modalias);
69 static ssize_t driver_override_store(struct device *dev,
70 struct device_attribute *a,
71 const char *buf, size_t count)
73 struct spi_device *spi = to_spi_device(dev);
74 const char *end = memchr(buf, '\n', count);
75 const size_t len = end ? end - buf : count;
76 const char *driver_override, *old;
78 /* We need to keep extra room for a newline when displaying value */
79 if (len >= (PAGE_SIZE - 1))
82 driver_override = kstrndup(buf, len, GFP_KERNEL);
87 old = spi->driver_override;
89 spi->driver_override = driver_override;
91 /* Empty string, disable driver override */
92 spi->driver_override = NULL;
93 kfree(driver_override);
101 static ssize_t driver_override_show(struct device *dev,
102 struct device_attribute *a, char *buf)
104 const struct spi_device *spi = to_spi_device(dev);
108 len = snprintf(buf, PAGE_SIZE, "%s\n", spi->driver_override ? : "");
112 static DEVICE_ATTR_RW(driver_override);
114 #define SPI_STATISTICS_ATTRS(field, file) \
115 static ssize_t spi_controller_##field##_show(struct device *dev, \
116 struct device_attribute *attr, \
119 struct spi_controller *ctlr = container_of(dev, \
120 struct spi_controller, dev); \
121 return spi_statistics_##field##_show(&ctlr->statistics, buf); \
123 static struct device_attribute dev_attr_spi_controller_##field = { \
124 .attr = { .name = file, .mode = 0444 }, \
125 .show = spi_controller_##field##_show, \
127 static ssize_t spi_device_##field##_show(struct device *dev, \
128 struct device_attribute *attr, \
131 struct spi_device *spi = to_spi_device(dev); \
132 return spi_statistics_##field##_show(&spi->statistics, buf); \
134 static struct device_attribute dev_attr_spi_device_##field = { \
135 .attr = { .name = file, .mode = 0444 }, \
136 .show = spi_device_##field##_show, \
139 #define SPI_STATISTICS_SHOW_NAME(name, file, field, format_string) \
140 static ssize_t spi_statistics_##name##_show(struct spi_statistics *stat, \
143 unsigned long flags; \
145 spin_lock_irqsave(&stat->lock, flags); \
146 len = sprintf(buf, format_string, stat->field); \
147 spin_unlock_irqrestore(&stat->lock, flags); \
150 SPI_STATISTICS_ATTRS(name, file)
152 #define SPI_STATISTICS_SHOW(field, format_string) \
153 SPI_STATISTICS_SHOW_NAME(field, __stringify(field), \
154 field, format_string)
156 SPI_STATISTICS_SHOW(messages, "%lu");
157 SPI_STATISTICS_SHOW(transfers, "%lu");
158 SPI_STATISTICS_SHOW(errors, "%lu");
159 SPI_STATISTICS_SHOW(timedout, "%lu");
161 SPI_STATISTICS_SHOW(spi_sync, "%lu");
162 SPI_STATISTICS_SHOW(spi_sync_immediate, "%lu");
163 SPI_STATISTICS_SHOW(spi_async, "%lu");
165 SPI_STATISTICS_SHOW(bytes, "%llu");
166 SPI_STATISTICS_SHOW(bytes_rx, "%llu");
167 SPI_STATISTICS_SHOW(bytes_tx, "%llu");
169 #define SPI_STATISTICS_TRANSFER_BYTES_HISTO(index, number) \
170 SPI_STATISTICS_SHOW_NAME(transfer_bytes_histo##index, \
171 "transfer_bytes_histo_" number, \
172 transfer_bytes_histo[index], "%lu")
173 SPI_STATISTICS_TRANSFER_BYTES_HISTO(0, "0-1");
174 SPI_STATISTICS_TRANSFER_BYTES_HISTO(1, "2-3");
175 SPI_STATISTICS_TRANSFER_BYTES_HISTO(2, "4-7");
176 SPI_STATISTICS_TRANSFER_BYTES_HISTO(3, "8-15");
177 SPI_STATISTICS_TRANSFER_BYTES_HISTO(4, "16-31");
178 SPI_STATISTICS_TRANSFER_BYTES_HISTO(5, "32-63");
179 SPI_STATISTICS_TRANSFER_BYTES_HISTO(6, "64-127");
180 SPI_STATISTICS_TRANSFER_BYTES_HISTO(7, "128-255");
181 SPI_STATISTICS_TRANSFER_BYTES_HISTO(8, "256-511");
182 SPI_STATISTICS_TRANSFER_BYTES_HISTO(9, "512-1023");
183 SPI_STATISTICS_TRANSFER_BYTES_HISTO(10, "1024-2047");
184 SPI_STATISTICS_TRANSFER_BYTES_HISTO(11, "2048-4095");
185 SPI_STATISTICS_TRANSFER_BYTES_HISTO(12, "4096-8191");
186 SPI_STATISTICS_TRANSFER_BYTES_HISTO(13, "8192-16383");
187 SPI_STATISTICS_TRANSFER_BYTES_HISTO(14, "16384-32767");
188 SPI_STATISTICS_TRANSFER_BYTES_HISTO(15, "32768-65535");
189 SPI_STATISTICS_TRANSFER_BYTES_HISTO(16, "65536+");
191 SPI_STATISTICS_SHOW(transfers_split_maxsize, "%lu");
193 static struct attribute *spi_dev_attrs[] = {
194 &dev_attr_modalias.attr,
195 &dev_attr_driver_override.attr,
199 static const struct attribute_group spi_dev_group = {
200 .attrs = spi_dev_attrs,
203 static struct attribute *spi_device_statistics_attrs[] = {
204 &dev_attr_spi_device_messages.attr,
205 &dev_attr_spi_device_transfers.attr,
206 &dev_attr_spi_device_errors.attr,
207 &dev_attr_spi_device_timedout.attr,
208 &dev_attr_spi_device_spi_sync.attr,
209 &dev_attr_spi_device_spi_sync_immediate.attr,
210 &dev_attr_spi_device_spi_async.attr,
211 &dev_attr_spi_device_bytes.attr,
212 &dev_attr_spi_device_bytes_rx.attr,
213 &dev_attr_spi_device_bytes_tx.attr,
214 &dev_attr_spi_device_transfer_bytes_histo0.attr,
215 &dev_attr_spi_device_transfer_bytes_histo1.attr,
216 &dev_attr_spi_device_transfer_bytes_histo2.attr,
217 &dev_attr_spi_device_transfer_bytes_histo3.attr,
218 &dev_attr_spi_device_transfer_bytes_histo4.attr,
219 &dev_attr_spi_device_transfer_bytes_histo5.attr,
220 &dev_attr_spi_device_transfer_bytes_histo6.attr,
221 &dev_attr_spi_device_transfer_bytes_histo7.attr,
222 &dev_attr_spi_device_transfer_bytes_histo8.attr,
223 &dev_attr_spi_device_transfer_bytes_histo9.attr,
224 &dev_attr_spi_device_transfer_bytes_histo10.attr,
225 &dev_attr_spi_device_transfer_bytes_histo11.attr,
226 &dev_attr_spi_device_transfer_bytes_histo12.attr,
227 &dev_attr_spi_device_transfer_bytes_histo13.attr,
228 &dev_attr_spi_device_transfer_bytes_histo14.attr,
229 &dev_attr_spi_device_transfer_bytes_histo15.attr,
230 &dev_attr_spi_device_transfer_bytes_histo16.attr,
231 &dev_attr_spi_device_transfers_split_maxsize.attr,
235 static const struct attribute_group spi_device_statistics_group = {
236 .name = "statistics",
237 .attrs = spi_device_statistics_attrs,
240 static const struct attribute_group *spi_dev_groups[] = {
242 &spi_device_statistics_group,
246 static struct attribute *spi_controller_statistics_attrs[] = {
247 &dev_attr_spi_controller_messages.attr,
248 &dev_attr_spi_controller_transfers.attr,
249 &dev_attr_spi_controller_errors.attr,
250 &dev_attr_spi_controller_timedout.attr,
251 &dev_attr_spi_controller_spi_sync.attr,
252 &dev_attr_spi_controller_spi_sync_immediate.attr,
253 &dev_attr_spi_controller_spi_async.attr,
254 &dev_attr_spi_controller_bytes.attr,
255 &dev_attr_spi_controller_bytes_rx.attr,
256 &dev_attr_spi_controller_bytes_tx.attr,
257 &dev_attr_spi_controller_transfer_bytes_histo0.attr,
258 &dev_attr_spi_controller_transfer_bytes_histo1.attr,
259 &dev_attr_spi_controller_transfer_bytes_histo2.attr,
260 &dev_attr_spi_controller_transfer_bytes_histo3.attr,
261 &dev_attr_spi_controller_transfer_bytes_histo4.attr,
262 &dev_attr_spi_controller_transfer_bytes_histo5.attr,
263 &dev_attr_spi_controller_transfer_bytes_histo6.attr,
264 &dev_attr_spi_controller_transfer_bytes_histo7.attr,
265 &dev_attr_spi_controller_transfer_bytes_histo8.attr,
266 &dev_attr_spi_controller_transfer_bytes_histo9.attr,
267 &dev_attr_spi_controller_transfer_bytes_histo10.attr,
268 &dev_attr_spi_controller_transfer_bytes_histo11.attr,
269 &dev_attr_spi_controller_transfer_bytes_histo12.attr,
270 &dev_attr_spi_controller_transfer_bytes_histo13.attr,
271 &dev_attr_spi_controller_transfer_bytes_histo14.attr,
272 &dev_attr_spi_controller_transfer_bytes_histo15.attr,
273 &dev_attr_spi_controller_transfer_bytes_histo16.attr,
274 &dev_attr_spi_controller_transfers_split_maxsize.attr,
278 static const struct attribute_group spi_controller_statistics_group = {
279 .name = "statistics",
280 .attrs = spi_controller_statistics_attrs,
283 static const struct attribute_group *spi_master_groups[] = {
284 &spi_controller_statistics_group,
288 void spi_statistics_add_transfer_stats(struct spi_statistics *stats,
289 struct spi_transfer *xfer,
290 struct spi_controller *ctlr)
293 int l2len = min(fls(xfer->len), SPI_STATISTICS_HISTO_SIZE) - 1;
298 spin_lock_irqsave(&stats->lock, flags);
301 stats->transfer_bytes_histo[l2len]++;
303 stats->bytes += xfer->len;
304 if ((xfer->tx_buf) &&
305 (xfer->tx_buf != ctlr->dummy_tx))
306 stats->bytes_tx += xfer->len;
307 if ((xfer->rx_buf) &&
308 (xfer->rx_buf != ctlr->dummy_rx))
309 stats->bytes_rx += xfer->len;
311 spin_unlock_irqrestore(&stats->lock, flags);
313 EXPORT_SYMBOL_GPL(spi_statistics_add_transfer_stats);
315 /* modalias support makes "modprobe $MODALIAS" new-style hotplug work,
316 * and the sysfs version makes coldplug work too.
319 static const struct spi_device_id *spi_match_id(const struct spi_device_id *id,
320 const struct spi_device *sdev)
322 while (id->name[0]) {
323 if (!strcmp(sdev->modalias, id->name))
330 const struct spi_device_id *spi_get_device_id(const struct spi_device *sdev)
332 const struct spi_driver *sdrv = to_spi_driver(sdev->dev.driver);
334 return spi_match_id(sdrv->id_table, sdev);
336 EXPORT_SYMBOL_GPL(spi_get_device_id);
338 static int spi_match_device(struct device *dev, struct device_driver *drv)
340 const struct spi_device *spi = to_spi_device(dev);
341 const struct spi_driver *sdrv = to_spi_driver(drv);
343 /* Check override first, and if set, only use the named driver */
344 if (spi->driver_override)
345 return strcmp(spi->driver_override, drv->name) == 0;
347 /* Attempt an OF style match */
348 if (of_driver_match_device(dev, drv))
352 if (acpi_driver_match_device(dev, drv))
356 return !!spi_match_id(sdrv->id_table, spi);
358 return strcmp(spi->modalias, drv->name) == 0;
361 static int spi_uevent(struct device *dev, struct kobj_uevent_env *env)
363 const struct spi_device *spi = to_spi_device(dev);
366 rc = acpi_device_uevent_modalias(dev, env);
370 return add_uevent_var(env, "MODALIAS=%s%s", SPI_MODULE_PREFIX, spi->modalias);
373 static int spi_probe(struct device *dev)
375 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
376 struct spi_device *spi = to_spi_device(dev);
379 ret = of_clk_set_defaults(dev->of_node, false);
384 spi->irq = of_irq_get(dev->of_node, 0);
385 if (spi->irq == -EPROBE_DEFER)
386 return -EPROBE_DEFER;
391 ret = dev_pm_domain_attach(dev, true);
396 ret = sdrv->probe(spi);
398 dev_pm_domain_detach(dev, true);
404 static void spi_remove(struct device *dev)
406 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
411 ret = sdrv->remove(to_spi_device(dev));
414 "Failed to unbind driver (%pe), ignoring\n",
418 dev_pm_domain_detach(dev, true);
421 static void spi_shutdown(struct device *dev)
424 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
427 sdrv->shutdown(to_spi_device(dev));
431 struct bus_type spi_bus_type = {
433 .dev_groups = spi_dev_groups,
434 .match = spi_match_device,
435 .uevent = spi_uevent,
437 .remove = spi_remove,
438 .shutdown = spi_shutdown,
440 EXPORT_SYMBOL_GPL(spi_bus_type);
443 * __spi_register_driver - register a SPI driver
444 * @owner: owner module of the driver to register
445 * @sdrv: the driver to register
448 * Return: zero on success, else a negative error code.
450 int __spi_register_driver(struct module *owner, struct spi_driver *sdrv)
452 sdrv->driver.owner = owner;
453 sdrv->driver.bus = &spi_bus_type;
456 * For Really Good Reasons we use spi: modaliases not of:
457 * modaliases for DT so module autoloading won't work if we
458 * don't have a spi_device_id as well as a compatible string.
460 if (sdrv->driver.of_match_table) {
461 const struct of_device_id *of_id;
463 for (of_id = sdrv->driver.of_match_table; of_id->compatible[0];
467 /* Strip off any vendor prefix */
468 of_name = strnchr(of_id->compatible,
469 sizeof(of_id->compatible), ',');
473 of_name = of_id->compatible;
475 if (sdrv->id_table) {
476 const struct spi_device_id *spi_id;
478 for (spi_id = sdrv->id_table; spi_id->name[0];
480 if (strcmp(spi_id->name, of_name) == 0)
486 if (strcmp(sdrv->driver.name, of_name) == 0)
490 pr_warn("SPI driver %s has no spi_device_id for %s\n",
491 sdrv->driver.name, of_id->compatible);
495 return driver_register(&sdrv->driver);
497 EXPORT_SYMBOL_GPL(__spi_register_driver);
499 /*-------------------------------------------------------------------------*/
501 /* SPI devices should normally not be created by SPI device drivers; that
502 * would make them board-specific. Similarly with SPI controller drivers.
503 * Device registration normally goes into like arch/.../mach.../board-YYY.c
504 * with other readonly (flashable) information about mainboard devices.
508 struct list_head list;
509 struct spi_board_info board_info;
512 static LIST_HEAD(board_list);
513 static LIST_HEAD(spi_controller_list);
516 * Used to protect add/del operation for board_info list and
517 * spi_controller list, and their matching process
518 * also used to protect object of type struct idr
520 static DEFINE_MUTEX(board_lock);
523 * spi_alloc_device - Allocate a new SPI device
524 * @ctlr: Controller to which device is connected
527 * Allows a driver to allocate and initialize a spi_device without
528 * registering it immediately. This allows a driver to directly
529 * fill the spi_device with device parameters before calling
530 * spi_add_device() on it.
532 * Caller is responsible to call spi_add_device() on the returned
533 * spi_device structure to add it to the SPI controller. If the caller
534 * needs to discard the spi_device without adding it, then it should
535 * call spi_dev_put() on it.
537 * Return: a pointer to the new device, or NULL.
539 struct spi_device *spi_alloc_device(struct spi_controller *ctlr)
541 struct spi_device *spi;
543 if (!spi_controller_get(ctlr))
546 spi = kzalloc(sizeof(*spi), GFP_KERNEL);
548 spi_controller_put(ctlr);
552 spi->master = spi->controller = ctlr;
553 spi->dev.parent = &ctlr->dev;
554 spi->dev.bus = &spi_bus_type;
555 spi->dev.release = spidev_release;
556 spi->cs_gpio = -ENOENT;
557 spi->mode = ctlr->buswidth_override_bits;
559 spin_lock_init(&spi->statistics.lock);
561 device_initialize(&spi->dev);
564 EXPORT_SYMBOL_GPL(spi_alloc_device);
566 static void spi_dev_set_name(struct spi_device *spi)
568 struct acpi_device *adev = ACPI_COMPANION(&spi->dev);
571 dev_set_name(&spi->dev, "spi-%s", acpi_dev_name(adev));
575 dev_set_name(&spi->dev, "%s.%u", dev_name(&spi->controller->dev),
579 static int spi_dev_check(struct device *dev, void *data)
581 struct spi_device *spi = to_spi_device(dev);
582 struct spi_device *new_spi = data;
584 if (spi->controller == new_spi->controller &&
585 spi->chip_select == new_spi->chip_select)
590 static void spi_cleanup(struct spi_device *spi)
592 if (spi->controller->cleanup)
593 spi->controller->cleanup(spi);
596 static int __spi_add_device(struct spi_device *spi)
598 struct spi_controller *ctlr = spi->controller;
599 struct device *dev = ctlr->dev.parent;
602 status = bus_for_each_dev(&spi_bus_type, NULL, spi, spi_dev_check);
604 dev_err(dev, "chipselect %d already in use\n",
609 /* Controller may unregister concurrently */
610 if (IS_ENABLED(CONFIG_SPI_DYNAMIC) &&
611 !device_is_registered(&ctlr->dev)) {
615 /* Descriptors take precedence */
617 spi->cs_gpiod = ctlr->cs_gpiods[spi->chip_select];
618 else if (ctlr->cs_gpios)
619 spi->cs_gpio = ctlr->cs_gpios[spi->chip_select];
621 /* Drivers may modify this initial i/o setup, but will
622 * normally rely on the device being setup. Devices
623 * using SPI_CS_HIGH can't coexist well otherwise...
625 status = spi_setup(spi);
627 dev_err(dev, "can't setup %s, status %d\n",
628 dev_name(&spi->dev), status);
632 /* Device may be bound to an active driver when this returns */
633 status = device_add(&spi->dev);
635 dev_err(dev, "can't add %s, status %d\n",
636 dev_name(&spi->dev), status);
639 dev_dbg(dev, "registered child %s\n", dev_name(&spi->dev));
646 * spi_add_device - Add spi_device allocated with spi_alloc_device
647 * @spi: spi_device to register
649 * Companion function to spi_alloc_device. Devices allocated with
650 * spi_alloc_device can be added onto the spi bus with this function.
652 * Return: 0 on success; negative errno on failure
654 int spi_add_device(struct spi_device *spi)
656 struct spi_controller *ctlr = spi->controller;
657 struct device *dev = ctlr->dev.parent;
660 /* Chipselects are numbered 0..max; validate. */
661 if (spi->chip_select >= ctlr->num_chipselect) {
662 dev_err(dev, "cs%d >= max %d\n", spi->chip_select,
663 ctlr->num_chipselect);
667 /* Set the bus ID string */
668 spi_dev_set_name(spi);
670 /* We need to make sure there's no other device with this
671 * chipselect **BEFORE** we call setup(), else we'll trash
672 * its configuration. Lock against concurrent add() calls.
674 mutex_lock(&ctlr->add_lock);
675 status = __spi_add_device(spi);
676 mutex_unlock(&ctlr->add_lock);
679 EXPORT_SYMBOL_GPL(spi_add_device);
681 static int spi_add_device_locked(struct spi_device *spi)
683 struct spi_controller *ctlr = spi->controller;
684 struct device *dev = ctlr->dev.parent;
686 /* Chipselects are numbered 0..max; validate. */
687 if (spi->chip_select >= ctlr->num_chipselect) {
688 dev_err(dev, "cs%d >= max %d\n", spi->chip_select,
689 ctlr->num_chipselect);
693 /* Set the bus ID string */
694 spi_dev_set_name(spi);
696 WARN_ON(!mutex_is_locked(&ctlr->add_lock));
697 return __spi_add_device(spi);
701 * spi_new_device - instantiate one new SPI device
702 * @ctlr: Controller to which device is connected
703 * @chip: Describes the SPI device
706 * On typical mainboards, this is purely internal; and it's not needed
707 * after board init creates the hard-wired devices. Some development
708 * platforms may not be able to use spi_register_board_info though, and
709 * this is exported so that for example a USB or parport based adapter
710 * driver could add devices (which it would learn about out-of-band).
712 * Return: the new device, or NULL.
714 struct spi_device *spi_new_device(struct spi_controller *ctlr,
715 struct spi_board_info *chip)
717 struct spi_device *proxy;
720 /* NOTE: caller did any chip->bus_num checks necessary.
722 * Also, unless we change the return value convention to use
723 * error-or-pointer (not NULL-or-pointer), troubleshootability
724 * suggests syslogged diagnostics are best here (ugh).
727 proxy = spi_alloc_device(ctlr);
731 WARN_ON(strlen(chip->modalias) >= sizeof(proxy->modalias));
733 proxy->chip_select = chip->chip_select;
734 proxy->max_speed_hz = chip->max_speed_hz;
735 proxy->mode = chip->mode;
736 proxy->irq = chip->irq;
737 strlcpy(proxy->modalias, chip->modalias, sizeof(proxy->modalias));
738 proxy->dev.platform_data = (void *) chip->platform_data;
739 proxy->controller_data = chip->controller_data;
740 proxy->controller_state = NULL;
743 status = device_add_software_node(&proxy->dev, chip->swnode);
745 dev_err(&ctlr->dev, "failed to add software node to '%s': %d\n",
746 chip->modalias, status);
751 status = spi_add_device(proxy);
758 device_remove_software_node(&proxy->dev);
762 EXPORT_SYMBOL_GPL(spi_new_device);
765 * spi_unregister_device - unregister a single SPI device
766 * @spi: spi_device to unregister
768 * Start making the passed SPI device vanish. Normally this would be handled
769 * by spi_unregister_controller().
771 void spi_unregister_device(struct spi_device *spi)
776 if (spi->dev.of_node) {
777 of_node_clear_flag(spi->dev.of_node, OF_POPULATED);
778 of_node_put(spi->dev.of_node);
780 if (ACPI_COMPANION(&spi->dev))
781 acpi_device_clear_enumerated(ACPI_COMPANION(&spi->dev));
782 device_remove_software_node(&spi->dev);
783 device_del(&spi->dev);
785 put_device(&spi->dev);
787 EXPORT_SYMBOL_GPL(spi_unregister_device);
789 static void spi_match_controller_to_boardinfo(struct spi_controller *ctlr,
790 struct spi_board_info *bi)
792 struct spi_device *dev;
794 if (ctlr->bus_num != bi->bus_num)
797 dev = spi_new_device(ctlr, bi);
799 dev_err(ctlr->dev.parent, "can't create new device for %s\n",
804 * spi_register_board_info - register SPI devices for a given board
805 * @info: array of chip descriptors
806 * @n: how many descriptors are provided
809 * Board-specific early init code calls this (probably during arch_initcall)
810 * with segments of the SPI device table. Any device nodes are created later,
811 * after the relevant parent SPI controller (bus_num) is defined. We keep
812 * this table of devices forever, so that reloading a controller driver will
813 * not make Linux forget about these hard-wired devices.
815 * Other code can also call this, e.g. a particular add-on board might provide
816 * SPI devices through its expansion connector, so code initializing that board
817 * would naturally declare its SPI devices.
819 * The board info passed can safely be __initdata ... but be careful of
820 * any embedded pointers (platform_data, etc), they're copied as-is.
822 * Return: zero on success, else a negative error code.
824 int spi_register_board_info(struct spi_board_info const *info, unsigned n)
826 struct boardinfo *bi;
832 bi = kcalloc(n, sizeof(*bi), GFP_KERNEL);
836 for (i = 0; i < n; i++, bi++, info++) {
837 struct spi_controller *ctlr;
839 memcpy(&bi->board_info, info, sizeof(*info));
841 mutex_lock(&board_lock);
842 list_add_tail(&bi->list, &board_list);
843 list_for_each_entry(ctlr, &spi_controller_list, list)
844 spi_match_controller_to_boardinfo(ctlr,
846 mutex_unlock(&board_lock);
852 /*-------------------------------------------------------------------------*/
854 static void spi_set_cs(struct spi_device *spi, bool enable, bool force)
856 bool activate = enable;
859 * Avoid calling into the driver (or doing delays) if the chip select
860 * isn't actually changing from the last time this was called.
862 if (!force && (spi->controller->last_cs_enable == enable) &&
863 (spi->controller->last_cs_mode_high == (spi->mode & SPI_CS_HIGH)))
866 trace_spi_set_cs(spi, activate);
868 spi->controller->last_cs_enable = enable;
869 spi->controller->last_cs_mode_high = spi->mode & SPI_CS_HIGH;
871 if ((spi->cs_gpiod || gpio_is_valid(spi->cs_gpio) ||
872 !spi->controller->set_cs_timing) && !activate) {
873 spi_delay_exec(&spi->cs_hold, NULL);
876 if (spi->mode & SPI_CS_HIGH)
879 if (spi->cs_gpiod || gpio_is_valid(spi->cs_gpio)) {
880 if (!(spi->mode & SPI_NO_CS)) {
883 * Historically ACPI has no means of the GPIO polarity and
884 * thus the SPISerialBus() resource defines it on the per-chip
885 * basis. In order to avoid a chain of negations, the GPIO
886 * polarity is considered being Active High. Even for the cases
887 * when _DSD() is involved (in the updated versions of ACPI)
888 * the GPIO CS polarity must be defined Active High to avoid
889 * ambiguity. That's why we use enable, that takes SPI_CS_HIGH
892 if (has_acpi_companion(&spi->dev))
893 gpiod_set_value_cansleep(spi->cs_gpiod, !enable);
895 /* Polarity handled by GPIO library */
896 gpiod_set_value_cansleep(spi->cs_gpiod, activate);
899 * invert the enable line, as active low is
902 gpio_set_value_cansleep(spi->cs_gpio, !enable);
905 /* Some SPI masters need both GPIO CS & slave_select */
906 if ((spi->controller->flags & SPI_MASTER_GPIO_SS) &&
907 spi->controller->set_cs)
908 spi->controller->set_cs(spi, !enable);
909 } else if (spi->controller->set_cs) {
910 spi->controller->set_cs(spi, !enable);
913 if (spi->cs_gpiod || gpio_is_valid(spi->cs_gpio) ||
914 !spi->controller->set_cs_timing) {
916 spi_delay_exec(&spi->cs_setup, NULL);
918 spi_delay_exec(&spi->cs_inactive, NULL);
922 #ifdef CONFIG_HAS_DMA
923 int spi_map_buf(struct spi_controller *ctlr, struct device *dev,
924 struct sg_table *sgt, void *buf, size_t len,
925 enum dma_data_direction dir)
927 const bool vmalloced_buf = is_vmalloc_addr(buf);
928 unsigned int max_seg_size = dma_get_max_seg_size(dev);
929 #ifdef CONFIG_HIGHMEM
930 const bool kmap_buf = ((unsigned long)buf >= PKMAP_BASE &&
931 (unsigned long)buf < (PKMAP_BASE +
932 (LAST_PKMAP * PAGE_SIZE)));
934 const bool kmap_buf = false;
938 struct page *vm_page;
939 struct scatterlist *sg;
944 if (vmalloced_buf || kmap_buf) {
945 desc_len = min_t(int, max_seg_size, PAGE_SIZE);
946 sgs = DIV_ROUND_UP(len + offset_in_page(buf), desc_len);
947 } else if (virt_addr_valid(buf)) {
948 desc_len = min_t(int, max_seg_size, ctlr->max_dma_len);
949 sgs = DIV_ROUND_UP(len, desc_len);
954 ret = sg_alloc_table(sgt, sgs, GFP_KERNEL);
959 for (i = 0; i < sgs; i++) {
961 if (vmalloced_buf || kmap_buf) {
963 * Next scatterlist entry size is the minimum between
964 * the desc_len and the remaining buffer length that
967 min = min_t(size_t, desc_len,
969 PAGE_SIZE - offset_in_page(buf)));
971 vm_page = vmalloc_to_page(buf);
973 vm_page = kmap_to_page(buf);
978 sg_set_page(sg, vm_page,
979 min, offset_in_page(buf));
981 min = min_t(size_t, len, desc_len);
983 sg_set_buf(sg, sg_buf, min);
991 ret = dma_map_sg(dev, sgt->sgl, sgt->nents, dir);
1004 void spi_unmap_buf(struct spi_controller *ctlr, struct device *dev,
1005 struct sg_table *sgt, enum dma_data_direction dir)
1007 if (sgt->orig_nents) {
1008 dma_unmap_sg(dev, sgt->sgl, sgt->orig_nents, dir);
1013 static int __spi_map_msg(struct spi_controller *ctlr, struct spi_message *msg)
1015 struct device *tx_dev, *rx_dev;
1016 struct spi_transfer *xfer;
1023 tx_dev = ctlr->dma_tx->device->dev;
1024 else if (ctlr->dma_map_dev)
1025 tx_dev = ctlr->dma_map_dev;
1027 tx_dev = ctlr->dev.parent;
1030 rx_dev = ctlr->dma_rx->device->dev;
1031 else if (ctlr->dma_map_dev)
1032 rx_dev = ctlr->dma_map_dev;
1034 rx_dev = ctlr->dev.parent;
1036 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
1037 if (!ctlr->can_dma(ctlr, msg->spi, xfer))
1040 if (xfer->tx_buf != NULL) {
1041 ret = spi_map_buf(ctlr, tx_dev, &xfer->tx_sg,
1042 (void *)xfer->tx_buf, xfer->len,
1048 if (xfer->rx_buf != NULL) {
1049 ret = spi_map_buf(ctlr, rx_dev, &xfer->rx_sg,
1050 xfer->rx_buf, xfer->len,
1053 spi_unmap_buf(ctlr, tx_dev, &xfer->tx_sg,
1060 ctlr->cur_msg_mapped = true;
1065 static int __spi_unmap_msg(struct spi_controller *ctlr, struct spi_message *msg)
1067 struct spi_transfer *xfer;
1068 struct device *tx_dev, *rx_dev;
1070 if (!ctlr->cur_msg_mapped || !ctlr->can_dma)
1074 tx_dev = ctlr->dma_tx->device->dev;
1076 tx_dev = ctlr->dev.parent;
1079 rx_dev = ctlr->dma_rx->device->dev;
1081 rx_dev = ctlr->dev.parent;
1083 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
1084 if (!ctlr->can_dma(ctlr, msg->spi, xfer))
1087 spi_unmap_buf(ctlr, rx_dev, &xfer->rx_sg, DMA_FROM_DEVICE);
1088 spi_unmap_buf(ctlr, tx_dev, &xfer->tx_sg, DMA_TO_DEVICE);
1091 ctlr->cur_msg_mapped = false;
1095 #else /* !CONFIG_HAS_DMA */
1096 static inline int __spi_map_msg(struct spi_controller *ctlr,
1097 struct spi_message *msg)
1102 static inline int __spi_unmap_msg(struct spi_controller *ctlr,
1103 struct spi_message *msg)
1107 #endif /* !CONFIG_HAS_DMA */
1109 static inline int spi_unmap_msg(struct spi_controller *ctlr,
1110 struct spi_message *msg)
1112 struct spi_transfer *xfer;
1114 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
1116 * Restore the original value of tx_buf or rx_buf if they are
1119 if (xfer->tx_buf == ctlr->dummy_tx)
1120 xfer->tx_buf = NULL;
1121 if (xfer->rx_buf == ctlr->dummy_rx)
1122 xfer->rx_buf = NULL;
1125 return __spi_unmap_msg(ctlr, msg);
1128 static int spi_map_msg(struct spi_controller *ctlr, struct spi_message *msg)
1130 struct spi_transfer *xfer;
1132 unsigned int max_tx, max_rx;
1134 if ((ctlr->flags & (SPI_CONTROLLER_MUST_RX | SPI_CONTROLLER_MUST_TX))
1135 && !(msg->spi->mode & SPI_3WIRE)) {
1139 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
1140 if ((ctlr->flags & SPI_CONTROLLER_MUST_TX) &&
1142 max_tx = max(xfer->len, max_tx);
1143 if ((ctlr->flags & SPI_CONTROLLER_MUST_RX) &&
1145 max_rx = max(xfer->len, max_rx);
1149 tmp = krealloc(ctlr->dummy_tx, max_tx,
1150 GFP_KERNEL | GFP_DMA);
1153 ctlr->dummy_tx = tmp;
1154 memset(tmp, 0, max_tx);
1158 tmp = krealloc(ctlr->dummy_rx, max_rx,
1159 GFP_KERNEL | GFP_DMA);
1162 ctlr->dummy_rx = tmp;
1165 if (max_tx || max_rx) {
1166 list_for_each_entry(xfer, &msg->transfers,
1171 xfer->tx_buf = ctlr->dummy_tx;
1173 xfer->rx_buf = ctlr->dummy_rx;
1178 return __spi_map_msg(ctlr, msg);
1181 static int spi_transfer_wait(struct spi_controller *ctlr,
1182 struct spi_message *msg,
1183 struct spi_transfer *xfer)
1185 struct spi_statistics *statm = &ctlr->statistics;
1186 struct spi_statistics *stats = &msg->spi->statistics;
1187 u32 speed_hz = xfer->speed_hz;
1188 unsigned long long ms;
1190 if (spi_controller_is_slave(ctlr)) {
1191 if (wait_for_completion_interruptible(&ctlr->xfer_completion)) {
1192 dev_dbg(&msg->spi->dev, "SPI transfer interrupted\n");
1200 * For each byte we wait for 8 cycles of the SPI clock.
1201 * Since speed is defined in Hz and we want milliseconds,
1202 * use respective multiplier, but before the division,
1203 * otherwise we may get 0 for short transfers.
1205 ms = 8LL * MSEC_PER_SEC * xfer->len;
1206 do_div(ms, speed_hz);
1209 * Increase it twice and add 200 ms tolerance, use
1210 * predefined maximum in case of overflow.
1216 ms = wait_for_completion_timeout(&ctlr->xfer_completion,
1217 msecs_to_jiffies(ms));
1220 SPI_STATISTICS_INCREMENT_FIELD(statm, timedout);
1221 SPI_STATISTICS_INCREMENT_FIELD(stats, timedout);
1222 dev_err(&msg->spi->dev,
1223 "SPI transfer timed out\n");
1231 static void _spi_transfer_delay_ns(u32 ns)
1235 if (ns <= NSEC_PER_USEC) {
1238 u32 us = DIV_ROUND_UP(ns, NSEC_PER_USEC);
1243 usleep_range(us, us + DIV_ROUND_UP(us, 10));
1247 int spi_delay_to_ns(struct spi_delay *_delay, struct spi_transfer *xfer)
1249 u32 delay = _delay->value;
1250 u32 unit = _delay->unit;
1257 case SPI_DELAY_UNIT_USECS:
1258 delay *= NSEC_PER_USEC;
1260 case SPI_DELAY_UNIT_NSECS:
1261 /* Nothing to do here */
1263 case SPI_DELAY_UNIT_SCK:
1264 /* clock cycles need to be obtained from spi_transfer */
1268 * If there is unknown effective speed, approximate it
1269 * by underestimating with half of the requested hz.
1271 hz = xfer->effective_speed_hz ?: xfer->speed_hz / 2;
1275 /* Convert delay to nanoseconds */
1276 delay *= DIV_ROUND_UP(NSEC_PER_SEC, hz);
1284 EXPORT_SYMBOL_GPL(spi_delay_to_ns);
1286 int spi_delay_exec(struct spi_delay *_delay, struct spi_transfer *xfer)
1295 delay = spi_delay_to_ns(_delay, xfer);
1299 _spi_transfer_delay_ns(delay);
1303 EXPORT_SYMBOL_GPL(spi_delay_exec);
1305 static void _spi_transfer_cs_change_delay(struct spi_message *msg,
1306 struct spi_transfer *xfer)
1308 u32 default_delay_ns = 10 * NSEC_PER_USEC;
1309 u32 delay = xfer->cs_change_delay.value;
1310 u32 unit = xfer->cs_change_delay.unit;
1313 /* return early on "fast" mode - for everything but USECS */
1315 if (unit == SPI_DELAY_UNIT_USECS)
1316 _spi_transfer_delay_ns(default_delay_ns);
1320 ret = spi_delay_exec(&xfer->cs_change_delay, xfer);
1322 dev_err_once(&msg->spi->dev,
1323 "Use of unsupported delay unit %i, using default of %luus\n",
1324 unit, default_delay_ns / NSEC_PER_USEC);
1325 _spi_transfer_delay_ns(default_delay_ns);
1330 * spi_transfer_one_message - Default implementation of transfer_one_message()
1332 * This is a standard implementation of transfer_one_message() for
1333 * drivers which implement a transfer_one() operation. It provides
1334 * standard handling of delays and chip select management.
1336 static int spi_transfer_one_message(struct spi_controller *ctlr,
1337 struct spi_message *msg)
1339 struct spi_transfer *xfer;
1340 bool keep_cs = false;
1342 struct spi_statistics *statm = &ctlr->statistics;
1343 struct spi_statistics *stats = &msg->spi->statistics;
1345 spi_set_cs(msg->spi, true, false);
1347 SPI_STATISTICS_INCREMENT_FIELD(statm, messages);
1348 SPI_STATISTICS_INCREMENT_FIELD(stats, messages);
1350 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
1351 trace_spi_transfer_start(msg, xfer);
1353 spi_statistics_add_transfer_stats(statm, xfer, ctlr);
1354 spi_statistics_add_transfer_stats(stats, xfer, ctlr);
1356 if (!ctlr->ptp_sts_supported) {
1357 xfer->ptp_sts_word_pre = 0;
1358 ptp_read_system_prets(xfer->ptp_sts);
1361 if ((xfer->tx_buf || xfer->rx_buf) && xfer->len) {
1362 reinit_completion(&ctlr->xfer_completion);
1365 ret = ctlr->transfer_one(ctlr, msg->spi, xfer);
1367 if (ctlr->cur_msg_mapped &&
1368 (xfer->error & SPI_TRANS_FAIL_NO_START)) {
1369 __spi_unmap_msg(ctlr, msg);
1370 ctlr->fallback = true;
1371 xfer->error &= ~SPI_TRANS_FAIL_NO_START;
1375 SPI_STATISTICS_INCREMENT_FIELD(statm,
1377 SPI_STATISTICS_INCREMENT_FIELD(stats,
1379 dev_err(&msg->spi->dev,
1380 "SPI transfer failed: %d\n", ret);
1385 ret = spi_transfer_wait(ctlr, msg, xfer);
1391 dev_err(&msg->spi->dev,
1392 "Bufferless transfer has length %u\n",
1396 if (!ctlr->ptp_sts_supported) {
1397 ptp_read_system_postts(xfer->ptp_sts);
1398 xfer->ptp_sts_word_post = xfer->len;
1401 trace_spi_transfer_stop(msg, xfer);
1403 if (msg->status != -EINPROGRESS)
1406 spi_transfer_delay_exec(xfer);
1408 if (xfer->cs_change) {
1409 if (list_is_last(&xfer->transfer_list,
1413 spi_set_cs(msg->spi, false, false);
1414 _spi_transfer_cs_change_delay(msg, xfer);
1415 spi_set_cs(msg->spi, true, false);
1419 msg->actual_length += xfer->len;
1423 if (ret != 0 || !keep_cs)
1424 spi_set_cs(msg->spi, false, false);
1426 if (msg->status == -EINPROGRESS)
1429 if (msg->status && ctlr->handle_err)
1430 ctlr->handle_err(ctlr, msg);
1432 spi_finalize_current_message(ctlr);
1438 * spi_finalize_current_transfer - report completion of a transfer
1439 * @ctlr: the controller reporting completion
1441 * Called by SPI drivers using the core transfer_one_message()
1442 * implementation to notify it that the current interrupt driven
1443 * transfer has finished and the next one may be scheduled.
1445 void spi_finalize_current_transfer(struct spi_controller *ctlr)
1447 complete(&ctlr->xfer_completion);
1449 EXPORT_SYMBOL_GPL(spi_finalize_current_transfer);
1451 static void spi_idle_runtime_pm(struct spi_controller *ctlr)
1453 if (ctlr->auto_runtime_pm) {
1454 pm_runtime_mark_last_busy(ctlr->dev.parent);
1455 pm_runtime_put_autosuspend(ctlr->dev.parent);
1460 * __spi_pump_messages - function which processes spi message queue
1461 * @ctlr: controller to process queue for
1462 * @in_kthread: true if we are in the context of the message pump thread
1464 * This function checks if there is any spi message in the queue that
1465 * needs processing and if so call out to the driver to initialize hardware
1466 * and transfer each message.
1468 * Note that it is called both from the kthread itself and also from
1469 * inside spi_sync(); the queue extraction handling at the top of the
1470 * function should deal with this safely.
1472 static void __spi_pump_messages(struct spi_controller *ctlr, bool in_kthread)
1474 struct spi_transfer *xfer;
1475 struct spi_message *msg;
1476 bool was_busy = false;
1477 unsigned long flags;
1481 spin_lock_irqsave(&ctlr->queue_lock, flags);
1483 /* Make sure we are not already running a message */
1484 if (ctlr->cur_msg) {
1485 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1489 /* If another context is idling the device then defer */
1491 kthread_queue_work(ctlr->kworker, &ctlr->pump_messages);
1492 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1496 /* Check if the queue is idle */
1497 if (list_empty(&ctlr->queue) || !ctlr->running) {
1499 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1503 /* Defer any non-atomic teardown to the thread */
1505 if (!ctlr->dummy_rx && !ctlr->dummy_tx &&
1506 !ctlr->unprepare_transfer_hardware) {
1507 spi_idle_runtime_pm(ctlr);
1509 trace_spi_controller_idle(ctlr);
1511 kthread_queue_work(ctlr->kworker,
1512 &ctlr->pump_messages);
1514 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1519 ctlr->idling = true;
1520 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1522 kfree(ctlr->dummy_rx);
1523 ctlr->dummy_rx = NULL;
1524 kfree(ctlr->dummy_tx);
1525 ctlr->dummy_tx = NULL;
1526 if (ctlr->unprepare_transfer_hardware &&
1527 ctlr->unprepare_transfer_hardware(ctlr))
1529 "failed to unprepare transfer hardware\n");
1530 spi_idle_runtime_pm(ctlr);
1531 trace_spi_controller_idle(ctlr);
1533 spin_lock_irqsave(&ctlr->queue_lock, flags);
1534 ctlr->idling = false;
1535 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1539 /* Extract head of queue */
1540 msg = list_first_entry(&ctlr->queue, struct spi_message, queue);
1541 ctlr->cur_msg = msg;
1543 list_del_init(&msg->queue);
1548 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1550 mutex_lock(&ctlr->io_mutex);
1552 if (!was_busy && ctlr->auto_runtime_pm) {
1553 ret = pm_runtime_get_sync(ctlr->dev.parent);
1555 pm_runtime_put_noidle(ctlr->dev.parent);
1556 dev_err(&ctlr->dev, "Failed to power device: %d\n",
1558 mutex_unlock(&ctlr->io_mutex);
1564 trace_spi_controller_busy(ctlr);
1566 if (!was_busy && ctlr->prepare_transfer_hardware) {
1567 ret = ctlr->prepare_transfer_hardware(ctlr);
1570 "failed to prepare transfer hardware: %d\n",
1573 if (ctlr->auto_runtime_pm)
1574 pm_runtime_put(ctlr->dev.parent);
1577 spi_finalize_current_message(ctlr);
1579 mutex_unlock(&ctlr->io_mutex);
1584 trace_spi_message_start(msg);
1586 if (ctlr->prepare_message) {
1587 ret = ctlr->prepare_message(ctlr, msg);
1589 dev_err(&ctlr->dev, "failed to prepare message: %d\n",
1592 spi_finalize_current_message(ctlr);
1595 ctlr->cur_msg_prepared = true;
1598 ret = spi_map_msg(ctlr, msg);
1601 spi_finalize_current_message(ctlr);
1605 if (!ctlr->ptp_sts_supported && !ctlr->transfer_one) {
1606 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
1607 xfer->ptp_sts_word_pre = 0;
1608 ptp_read_system_prets(xfer->ptp_sts);
1612 ret = ctlr->transfer_one_message(ctlr, msg);
1615 "failed to transfer one message from queue\n");
1620 mutex_unlock(&ctlr->io_mutex);
1622 /* Prod the scheduler in case transfer_one() was busy waiting */
1628 * spi_pump_messages - kthread work function which processes spi message queue
1629 * @work: pointer to kthread work struct contained in the controller struct
1631 static void spi_pump_messages(struct kthread_work *work)
1633 struct spi_controller *ctlr =
1634 container_of(work, struct spi_controller, pump_messages);
1636 __spi_pump_messages(ctlr, true);
1640 * spi_take_timestamp_pre - helper for drivers to collect the beginning of the
1641 * TX timestamp for the requested byte from the SPI
1642 * transfer. The frequency with which this function
1643 * must be called (once per word, once for the whole
1644 * transfer, once per batch of words etc) is arbitrary
1645 * as long as the @tx buffer offset is greater than or
1646 * equal to the requested byte at the time of the
1647 * call. The timestamp is only taken once, at the
1648 * first such call. It is assumed that the driver
1649 * advances its @tx buffer pointer monotonically.
1650 * @ctlr: Pointer to the spi_controller structure of the driver
1651 * @xfer: Pointer to the transfer being timestamped
1652 * @progress: How many words (not bytes) have been transferred so far
1653 * @irqs_off: If true, will disable IRQs and preemption for the duration of the
1654 * transfer, for less jitter in time measurement. Only compatible
1655 * with PIO drivers. If true, must follow up with
1656 * spi_take_timestamp_post or otherwise system will crash.
1657 * WARNING: for fully predictable results, the CPU frequency must
1658 * also be under control (governor).
1660 void spi_take_timestamp_pre(struct spi_controller *ctlr,
1661 struct spi_transfer *xfer,
1662 size_t progress, bool irqs_off)
1667 if (xfer->timestamped)
1670 if (progress > xfer->ptp_sts_word_pre)
1673 /* Capture the resolution of the timestamp */
1674 xfer->ptp_sts_word_pre = progress;
1677 local_irq_save(ctlr->irq_flags);
1681 ptp_read_system_prets(xfer->ptp_sts);
1683 EXPORT_SYMBOL_GPL(spi_take_timestamp_pre);
1686 * spi_take_timestamp_post - helper for drivers to collect the end of the
1687 * TX timestamp for the requested byte from the SPI
1688 * transfer. Can be called with an arbitrary
1689 * frequency: only the first call where @tx exceeds
1690 * or is equal to the requested word will be
1692 * @ctlr: Pointer to the spi_controller structure of the driver
1693 * @xfer: Pointer to the transfer being timestamped
1694 * @progress: How many words (not bytes) have been transferred so far
1695 * @irqs_off: If true, will re-enable IRQs and preemption for the local CPU.
1697 void spi_take_timestamp_post(struct spi_controller *ctlr,
1698 struct spi_transfer *xfer,
1699 size_t progress, bool irqs_off)
1704 if (xfer->timestamped)
1707 if (progress < xfer->ptp_sts_word_post)
1710 ptp_read_system_postts(xfer->ptp_sts);
1713 local_irq_restore(ctlr->irq_flags);
1717 /* Capture the resolution of the timestamp */
1718 xfer->ptp_sts_word_post = progress;
1720 xfer->timestamped = true;
1722 EXPORT_SYMBOL_GPL(spi_take_timestamp_post);
1725 * spi_set_thread_rt - set the controller to pump at realtime priority
1726 * @ctlr: controller to boost priority of
1728 * This can be called because the controller requested realtime priority
1729 * (by setting the ->rt value before calling spi_register_controller()) or
1730 * because a device on the bus said that its transfers needed realtime
1733 * NOTE: at the moment if any device on a bus says it needs realtime then
1734 * the thread will be at realtime priority for all transfers on that
1735 * controller. If this eventually becomes a problem we may see if we can
1736 * find a way to boost the priority only temporarily during relevant
1739 static void spi_set_thread_rt(struct spi_controller *ctlr)
1741 dev_info(&ctlr->dev,
1742 "will run message pump with realtime priority\n");
1743 sched_set_fifo(ctlr->kworker->task);
1746 static int spi_init_queue(struct spi_controller *ctlr)
1748 ctlr->running = false;
1751 ctlr->kworker = kthread_create_worker(0, dev_name(&ctlr->dev));
1752 if (IS_ERR(ctlr->kworker)) {
1753 dev_err(&ctlr->dev, "failed to create message pump kworker\n");
1754 return PTR_ERR(ctlr->kworker);
1757 kthread_init_work(&ctlr->pump_messages, spi_pump_messages);
1760 * Controller config will indicate if this controller should run the
1761 * message pump with high (realtime) priority to reduce the transfer
1762 * latency on the bus by minimising the delay between a transfer
1763 * request and the scheduling of the message pump thread. Without this
1764 * setting the message pump thread will remain at default priority.
1767 spi_set_thread_rt(ctlr);
1773 * spi_get_next_queued_message() - called by driver to check for queued
1775 * @ctlr: the controller to check for queued messages
1777 * If there are more messages in the queue, the next message is returned from
1780 * Return: the next message in the queue, else NULL if the queue is empty.
1782 struct spi_message *spi_get_next_queued_message(struct spi_controller *ctlr)
1784 struct spi_message *next;
1785 unsigned long flags;
1787 /* get a pointer to the next message, if any */
1788 spin_lock_irqsave(&ctlr->queue_lock, flags);
1789 next = list_first_entry_or_null(&ctlr->queue, struct spi_message,
1791 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1795 EXPORT_SYMBOL_GPL(spi_get_next_queued_message);
1798 * spi_finalize_current_message() - the current message is complete
1799 * @ctlr: the controller to return the message to
1801 * Called by the driver to notify the core that the message in the front of the
1802 * queue is complete and can be removed from the queue.
1804 void spi_finalize_current_message(struct spi_controller *ctlr)
1806 struct spi_transfer *xfer;
1807 struct spi_message *mesg;
1808 unsigned long flags;
1811 spin_lock_irqsave(&ctlr->queue_lock, flags);
1812 mesg = ctlr->cur_msg;
1813 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1815 if (!ctlr->ptp_sts_supported && !ctlr->transfer_one) {
1816 list_for_each_entry(xfer, &mesg->transfers, transfer_list) {
1817 ptp_read_system_postts(xfer->ptp_sts);
1818 xfer->ptp_sts_word_post = xfer->len;
1822 if (unlikely(ctlr->ptp_sts_supported))
1823 list_for_each_entry(xfer, &mesg->transfers, transfer_list)
1824 WARN_ON_ONCE(xfer->ptp_sts && !xfer->timestamped);
1826 spi_unmap_msg(ctlr, mesg);
1828 /* In the prepare_messages callback the spi bus has the opportunity to
1829 * split a transfer to smaller chunks.
1830 * Release splited transfers here since spi_map_msg is done on the
1831 * splited transfers.
1833 spi_res_release(ctlr, mesg);
1835 if (ctlr->cur_msg_prepared && ctlr->unprepare_message) {
1836 ret = ctlr->unprepare_message(ctlr, mesg);
1838 dev_err(&ctlr->dev, "failed to unprepare message: %d\n",
1843 spin_lock_irqsave(&ctlr->queue_lock, flags);
1844 ctlr->cur_msg = NULL;
1845 ctlr->cur_msg_prepared = false;
1846 ctlr->fallback = false;
1847 kthread_queue_work(ctlr->kworker, &ctlr->pump_messages);
1848 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1850 trace_spi_message_done(mesg);
1854 mesg->complete(mesg->context);
1856 EXPORT_SYMBOL_GPL(spi_finalize_current_message);
1858 static int spi_start_queue(struct spi_controller *ctlr)
1860 unsigned long flags;
1862 spin_lock_irqsave(&ctlr->queue_lock, flags);
1864 if (ctlr->running || ctlr->busy) {
1865 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1869 ctlr->running = true;
1870 ctlr->cur_msg = NULL;
1871 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1873 kthread_queue_work(ctlr->kworker, &ctlr->pump_messages);
1878 static int spi_stop_queue(struct spi_controller *ctlr)
1880 unsigned long flags;
1881 unsigned limit = 500;
1884 spin_lock_irqsave(&ctlr->queue_lock, flags);
1887 * This is a bit lame, but is optimized for the common execution path.
1888 * A wait_queue on the ctlr->busy could be used, but then the common
1889 * execution path (pump_messages) would be required to call wake_up or
1890 * friends on every SPI message. Do this instead.
1892 while ((!list_empty(&ctlr->queue) || ctlr->busy) && limit--) {
1893 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1894 usleep_range(10000, 11000);
1895 spin_lock_irqsave(&ctlr->queue_lock, flags);
1898 if (!list_empty(&ctlr->queue) || ctlr->busy)
1901 ctlr->running = false;
1903 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1906 dev_warn(&ctlr->dev, "could not stop message queue\n");
1912 static int spi_destroy_queue(struct spi_controller *ctlr)
1916 ret = spi_stop_queue(ctlr);
1919 * kthread_flush_worker will block until all work is done.
1920 * If the reason that stop_queue timed out is that the work will never
1921 * finish, then it does no good to call flush/stop thread, so
1925 dev_err(&ctlr->dev, "problem destroying queue\n");
1929 kthread_destroy_worker(ctlr->kworker);
1934 static int __spi_queued_transfer(struct spi_device *spi,
1935 struct spi_message *msg,
1938 struct spi_controller *ctlr = spi->controller;
1939 unsigned long flags;
1941 spin_lock_irqsave(&ctlr->queue_lock, flags);
1943 if (!ctlr->running) {
1944 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1947 msg->actual_length = 0;
1948 msg->status = -EINPROGRESS;
1950 list_add_tail(&msg->queue, &ctlr->queue);
1951 if (!ctlr->busy && need_pump)
1952 kthread_queue_work(ctlr->kworker, &ctlr->pump_messages);
1954 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1959 * spi_queued_transfer - transfer function for queued transfers
1960 * @spi: spi device which is requesting transfer
1961 * @msg: spi message which is to handled is queued to driver queue
1963 * Return: zero on success, else a negative error code.
1965 static int spi_queued_transfer(struct spi_device *spi, struct spi_message *msg)
1967 return __spi_queued_transfer(spi, msg, true);
1970 static int spi_controller_initialize_queue(struct spi_controller *ctlr)
1974 ctlr->transfer = spi_queued_transfer;
1975 if (!ctlr->transfer_one_message)
1976 ctlr->transfer_one_message = spi_transfer_one_message;
1978 /* Initialize and start queue */
1979 ret = spi_init_queue(ctlr);
1981 dev_err(&ctlr->dev, "problem initializing queue\n");
1982 goto err_init_queue;
1984 ctlr->queued = true;
1985 ret = spi_start_queue(ctlr);
1987 dev_err(&ctlr->dev, "problem starting queue\n");
1988 goto err_start_queue;
1994 spi_destroy_queue(ctlr);
2000 * spi_flush_queue - Send all pending messages in the queue from the callers'
2002 * @ctlr: controller to process queue for
2004 * This should be used when one wants to ensure all pending messages have been
2005 * sent before doing something. Is used by the spi-mem code to make sure SPI
2006 * memory operations do not preempt regular SPI transfers that have been queued
2007 * before the spi-mem operation.
2009 void spi_flush_queue(struct spi_controller *ctlr)
2011 if (ctlr->transfer == spi_queued_transfer)
2012 __spi_pump_messages(ctlr, false);
2015 /*-------------------------------------------------------------------------*/
2017 #if defined(CONFIG_OF)
2018 static int of_spi_parse_dt(struct spi_controller *ctlr, struct spi_device *spi,
2019 struct device_node *nc)
2024 /* Mode (clock phase/polarity/etc.) */
2025 if (of_property_read_bool(nc, "spi-cpha"))
2026 spi->mode |= SPI_CPHA;
2027 if (of_property_read_bool(nc, "spi-cpol"))
2028 spi->mode |= SPI_CPOL;
2029 if (of_property_read_bool(nc, "spi-3wire"))
2030 spi->mode |= SPI_3WIRE;
2031 if (of_property_read_bool(nc, "spi-lsb-first"))
2032 spi->mode |= SPI_LSB_FIRST;
2033 if (of_property_read_bool(nc, "spi-cs-high"))
2034 spi->mode |= SPI_CS_HIGH;
2036 /* Device DUAL/QUAD mode */
2037 if (!of_property_read_u32(nc, "spi-tx-bus-width", &value)) {
2040 spi->mode |= SPI_NO_TX;
2045 spi->mode |= SPI_TX_DUAL;
2048 spi->mode |= SPI_TX_QUAD;
2051 spi->mode |= SPI_TX_OCTAL;
2054 dev_warn(&ctlr->dev,
2055 "spi-tx-bus-width %d not supported\n",
2061 if (!of_property_read_u32(nc, "spi-rx-bus-width", &value)) {
2064 spi->mode |= SPI_NO_RX;
2069 spi->mode |= SPI_RX_DUAL;
2072 spi->mode |= SPI_RX_QUAD;
2075 spi->mode |= SPI_RX_OCTAL;
2078 dev_warn(&ctlr->dev,
2079 "spi-rx-bus-width %d not supported\n",
2085 if (spi_controller_is_slave(ctlr)) {
2086 if (!of_node_name_eq(nc, "slave")) {
2087 dev_err(&ctlr->dev, "%pOF is not called 'slave'\n",
2094 /* Device address */
2095 rc = of_property_read_u32(nc, "reg", &value);
2097 dev_err(&ctlr->dev, "%pOF has no valid 'reg' property (%d)\n",
2101 spi->chip_select = value;
2104 if (!of_property_read_u32(nc, "spi-max-frequency", &value))
2105 spi->max_speed_hz = value;
2110 static struct spi_device *
2111 of_register_spi_device(struct spi_controller *ctlr, struct device_node *nc)
2113 struct spi_device *spi;
2116 /* Alloc an spi_device */
2117 spi = spi_alloc_device(ctlr);
2119 dev_err(&ctlr->dev, "spi_device alloc error for %pOF\n", nc);
2124 /* Select device driver */
2125 rc = of_modalias_node(nc, spi->modalias,
2126 sizeof(spi->modalias));
2128 dev_err(&ctlr->dev, "cannot find modalias for %pOF\n", nc);
2132 rc = of_spi_parse_dt(ctlr, spi, nc);
2136 /* Store a pointer to the node in the device structure */
2138 spi->dev.of_node = nc;
2139 spi->dev.fwnode = of_fwnode_handle(nc);
2141 /* Register the new device */
2142 rc = spi_add_device(spi);
2144 dev_err(&ctlr->dev, "spi_device register error %pOF\n", nc);
2145 goto err_of_node_put;
2158 * of_register_spi_devices() - Register child devices onto the SPI bus
2159 * @ctlr: Pointer to spi_controller device
2161 * Registers an spi_device for each child node of controller node which
2162 * represents a valid SPI slave.
2164 static void of_register_spi_devices(struct spi_controller *ctlr)
2166 struct spi_device *spi;
2167 struct device_node *nc;
2169 if (!ctlr->dev.of_node)
2172 for_each_available_child_of_node(ctlr->dev.of_node, nc) {
2173 if (of_node_test_and_set_flag(nc, OF_POPULATED))
2175 spi = of_register_spi_device(ctlr, nc);
2177 dev_warn(&ctlr->dev,
2178 "Failed to create SPI device for %pOF\n", nc);
2179 of_node_clear_flag(nc, OF_POPULATED);
2184 static void of_register_spi_devices(struct spi_controller *ctlr) { }
2188 * spi_new_ancillary_device() - Register ancillary SPI device
2189 * @spi: Pointer to the main SPI device registering the ancillary device
2190 * @chip_select: Chip Select of the ancillary device
2192 * Register an ancillary SPI device; for example some chips have a chip-select
2193 * for normal device usage and another one for setup/firmware upload.
2195 * This may only be called from main SPI device's probe routine.
2197 * Return: 0 on success; negative errno on failure
2199 struct spi_device *spi_new_ancillary_device(struct spi_device *spi,
2202 struct spi_device *ancillary;
2205 /* Alloc an spi_device */
2206 ancillary = spi_alloc_device(spi->controller);
2212 strlcpy(ancillary->modalias, "dummy", sizeof(ancillary->modalias));
2214 /* Use provided chip-select for ancillary device */
2215 ancillary->chip_select = chip_select;
2217 /* Take over SPI mode/speed from SPI main device */
2218 ancillary->max_speed_hz = spi->max_speed_hz;
2219 ancillary->mode = spi->mode;
2221 /* Register the new device */
2222 rc = spi_add_device_locked(ancillary);
2224 dev_err(&spi->dev, "failed to register ancillary device\n");
2231 spi_dev_put(ancillary);
2234 EXPORT_SYMBOL_GPL(spi_new_ancillary_device);
2237 struct acpi_spi_lookup {
2238 struct spi_controller *ctlr;
2246 static void acpi_spi_parse_apple_properties(struct acpi_device *dev,
2247 struct acpi_spi_lookup *lookup)
2249 const union acpi_object *obj;
2251 if (!x86_apple_machine)
2254 if (!acpi_dev_get_property(dev, "spiSclkPeriod", ACPI_TYPE_BUFFER, &obj)
2255 && obj->buffer.length >= 4)
2256 lookup->max_speed_hz = NSEC_PER_SEC / *(u32 *)obj->buffer.pointer;
2258 if (!acpi_dev_get_property(dev, "spiWordSize", ACPI_TYPE_BUFFER, &obj)
2259 && obj->buffer.length == 8)
2260 lookup->bits_per_word = *(u64 *)obj->buffer.pointer;
2262 if (!acpi_dev_get_property(dev, "spiBitOrder", ACPI_TYPE_BUFFER, &obj)
2263 && obj->buffer.length == 8 && !*(u64 *)obj->buffer.pointer)
2264 lookup->mode |= SPI_LSB_FIRST;
2266 if (!acpi_dev_get_property(dev, "spiSPO", ACPI_TYPE_BUFFER, &obj)
2267 && obj->buffer.length == 8 && *(u64 *)obj->buffer.pointer)
2268 lookup->mode |= SPI_CPOL;
2270 if (!acpi_dev_get_property(dev, "spiSPH", ACPI_TYPE_BUFFER, &obj)
2271 && obj->buffer.length == 8 && *(u64 *)obj->buffer.pointer)
2272 lookup->mode |= SPI_CPHA;
2275 static int acpi_spi_add_resource(struct acpi_resource *ares, void *data)
2277 struct acpi_spi_lookup *lookup = data;
2278 struct spi_controller *ctlr = lookup->ctlr;
2280 if (ares->type == ACPI_RESOURCE_TYPE_SERIAL_BUS) {
2281 struct acpi_resource_spi_serialbus *sb;
2282 acpi_handle parent_handle;
2285 sb = &ares->data.spi_serial_bus;
2286 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_SPI) {
2288 status = acpi_get_handle(NULL,
2289 sb->resource_source.string_ptr,
2292 if (ACPI_FAILURE(status) ||
2293 ACPI_HANDLE(ctlr->dev.parent) != parent_handle)
2297 * ACPI DeviceSelection numbering is handled by the
2298 * host controller driver in Windows and can vary
2299 * from driver to driver. In Linux we always expect
2300 * 0 .. max - 1 so we need to ask the driver to
2301 * translate between the two schemes.
2303 if (ctlr->fw_translate_cs) {
2304 int cs = ctlr->fw_translate_cs(ctlr,
2305 sb->device_selection);
2308 lookup->chip_select = cs;
2310 lookup->chip_select = sb->device_selection;
2313 lookup->max_speed_hz = sb->connection_speed;
2314 lookup->bits_per_word = sb->data_bit_length;
2316 if (sb->clock_phase == ACPI_SPI_SECOND_PHASE)
2317 lookup->mode |= SPI_CPHA;
2318 if (sb->clock_polarity == ACPI_SPI_START_HIGH)
2319 lookup->mode |= SPI_CPOL;
2320 if (sb->device_polarity == ACPI_SPI_ACTIVE_HIGH)
2321 lookup->mode |= SPI_CS_HIGH;
2323 } else if (lookup->irq < 0) {
2326 if (acpi_dev_resource_interrupt(ares, 0, &r))
2327 lookup->irq = r.start;
2330 /* Always tell the ACPI core to skip this resource */
2334 static acpi_status acpi_register_spi_device(struct spi_controller *ctlr,
2335 struct acpi_device *adev)
2337 acpi_handle parent_handle = NULL;
2338 struct list_head resource_list;
2339 struct acpi_spi_lookup lookup = {};
2340 struct spi_device *spi;
2343 if (acpi_bus_get_status(adev) || !adev->status.present ||
2344 acpi_device_enumerated(adev))
2350 INIT_LIST_HEAD(&resource_list);
2351 ret = acpi_dev_get_resources(adev, &resource_list,
2352 acpi_spi_add_resource, &lookup);
2353 acpi_dev_free_resource_list(&resource_list);
2356 /* found SPI in _CRS but it points to another controller */
2359 if (!lookup.max_speed_hz &&
2360 ACPI_SUCCESS(acpi_get_parent(adev->handle, &parent_handle)) &&
2361 ACPI_HANDLE(ctlr->dev.parent) == parent_handle) {
2362 /* Apple does not use _CRS but nested devices for SPI slaves */
2363 acpi_spi_parse_apple_properties(adev, &lookup);
2366 if (!lookup.max_speed_hz)
2369 spi = spi_alloc_device(ctlr);
2371 dev_err(&ctlr->dev, "failed to allocate SPI device for %s\n",
2372 dev_name(&adev->dev));
2373 return AE_NO_MEMORY;
2377 ACPI_COMPANION_SET(&spi->dev, adev);
2378 spi->max_speed_hz = lookup.max_speed_hz;
2379 spi->mode |= lookup.mode;
2380 spi->irq = lookup.irq;
2381 spi->bits_per_word = lookup.bits_per_word;
2382 spi->chip_select = lookup.chip_select;
2384 acpi_set_modalias(adev, acpi_device_hid(adev), spi->modalias,
2385 sizeof(spi->modalias));
2388 spi->irq = acpi_dev_gpio_irq_get(adev, 0);
2390 acpi_device_set_enumerated(adev);
2392 adev->power.flags.ignore_parent = true;
2393 if (spi_add_device(spi)) {
2394 adev->power.flags.ignore_parent = false;
2395 dev_err(&ctlr->dev, "failed to add SPI device %s from ACPI\n",
2396 dev_name(&adev->dev));
2403 static acpi_status acpi_spi_add_device(acpi_handle handle, u32 level,
2404 void *data, void **return_value)
2406 struct spi_controller *ctlr = data;
2407 struct acpi_device *adev;
2409 if (acpi_bus_get_device(handle, &adev))
2412 return acpi_register_spi_device(ctlr, adev);
2415 #define SPI_ACPI_ENUMERATE_MAX_DEPTH 32
2417 static void acpi_register_spi_devices(struct spi_controller *ctlr)
2422 handle = ACPI_HANDLE(ctlr->dev.parent);
2426 status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
2427 SPI_ACPI_ENUMERATE_MAX_DEPTH,
2428 acpi_spi_add_device, NULL, ctlr, NULL);
2429 if (ACPI_FAILURE(status))
2430 dev_warn(&ctlr->dev, "failed to enumerate SPI slaves\n");
2433 static inline void acpi_register_spi_devices(struct spi_controller *ctlr) {}
2434 #endif /* CONFIG_ACPI */
2436 static void spi_controller_release(struct device *dev)
2438 struct spi_controller *ctlr;
2440 ctlr = container_of(dev, struct spi_controller, dev);
2444 static struct class spi_master_class = {
2445 .name = "spi_master",
2446 .owner = THIS_MODULE,
2447 .dev_release = spi_controller_release,
2448 .dev_groups = spi_master_groups,
2451 #ifdef CONFIG_SPI_SLAVE
2453 * spi_slave_abort - abort the ongoing transfer request on an SPI slave
2455 * @spi: device used for the current transfer
2457 int spi_slave_abort(struct spi_device *spi)
2459 struct spi_controller *ctlr = spi->controller;
2461 if (spi_controller_is_slave(ctlr) && ctlr->slave_abort)
2462 return ctlr->slave_abort(ctlr);
2466 EXPORT_SYMBOL_GPL(spi_slave_abort);
2468 static int match_true(struct device *dev, void *data)
2473 static ssize_t slave_show(struct device *dev, struct device_attribute *attr,
2476 struct spi_controller *ctlr = container_of(dev, struct spi_controller,
2478 struct device *child;
2480 child = device_find_child(&ctlr->dev, NULL, match_true);
2481 return sprintf(buf, "%s\n",
2482 child ? to_spi_device(child)->modalias : NULL);
2485 static ssize_t slave_store(struct device *dev, struct device_attribute *attr,
2486 const char *buf, size_t count)
2488 struct spi_controller *ctlr = container_of(dev, struct spi_controller,
2490 struct spi_device *spi;
2491 struct device *child;
2495 rc = sscanf(buf, "%31s", name);
2496 if (rc != 1 || !name[0])
2499 child = device_find_child(&ctlr->dev, NULL, match_true);
2501 /* Remove registered slave */
2502 device_unregister(child);
2506 if (strcmp(name, "(null)")) {
2507 /* Register new slave */
2508 spi = spi_alloc_device(ctlr);
2512 strlcpy(spi->modalias, name, sizeof(spi->modalias));
2514 rc = spi_add_device(spi);
2524 static DEVICE_ATTR_RW(slave);
2526 static struct attribute *spi_slave_attrs[] = {
2527 &dev_attr_slave.attr,
2531 static const struct attribute_group spi_slave_group = {
2532 .attrs = spi_slave_attrs,
2535 static const struct attribute_group *spi_slave_groups[] = {
2536 &spi_controller_statistics_group,
2541 static struct class spi_slave_class = {
2542 .name = "spi_slave",
2543 .owner = THIS_MODULE,
2544 .dev_release = spi_controller_release,
2545 .dev_groups = spi_slave_groups,
2548 extern struct class spi_slave_class; /* dummy */
2552 * __spi_alloc_controller - allocate an SPI master or slave controller
2553 * @dev: the controller, possibly using the platform_bus
2554 * @size: how much zeroed driver-private data to allocate; the pointer to this
2555 * memory is in the driver_data field of the returned device, accessible
2556 * with spi_controller_get_devdata(); the memory is cacheline aligned;
2557 * drivers granting DMA access to portions of their private data need to
2558 * round up @size using ALIGN(size, dma_get_cache_alignment()).
2559 * @slave: flag indicating whether to allocate an SPI master (false) or SPI
2560 * slave (true) controller
2561 * Context: can sleep
2563 * This call is used only by SPI controller drivers, which are the
2564 * only ones directly touching chip registers. It's how they allocate
2565 * an spi_controller structure, prior to calling spi_register_controller().
2567 * This must be called from context that can sleep.
2569 * The caller is responsible for assigning the bus number and initializing the
2570 * controller's methods before calling spi_register_controller(); and (after
2571 * errors adding the device) calling spi_controller_put() to prevent a memory
2574 * Return: the SPI controller structure on success, else NULL.
2576 struct spi_controller *__spi_alloc_controller(struct device *dev,
2577 unsigned int size, bool slave)
2579 struct spi_controller *ctlr;
2580 size_t ctlr_size = ALIGN(sizeof(*ctlr), dma_get_cache_alignment());
2585 ctlr = kzalloc(size + ctlr_size, GFP_KERNEL);
2589 device_initialize(&ctlr->dev);
2590 INIT_LIST_HEAD(&ctlr->queue);
2591 spin_lock_init(&ctlr->queue_lock);
2592 spin_lock_init(&ctlr->bus_lock_spinlock);
2593 mutex_init(&ctlr->bus_lock_mutex);
2594 mutex_init(&ctlr->io_mutex);
2595 mutex_init(&ctlr->add_lock);
2597 ctlr->num_chipselect = 1;
2598 ctlr->slave = slave;
2599 if (IS_ENABLED(CONFIG_SPI_SLAVE) && slave)
2600 ctlr->dev.class = &spi_slave_class;
2602 ctlr->dev.class = &spi_master_class;
2603 ctlr->dev.parent = dev;
2604 pm_suspend_ignore_children(&ctlr->dev, true);
2605 spi_controller_set_devdata(ctlr, (void *)ctlr + ctlr_size);
2609 EXPORT_SYMBOL_GPL(__spi_alloc_controller);
2611 static void devm_spi_release_controller(struct device *dev, void *ctlr)
2613 spi_controller_put(*(struct spi_controller **)ctlr);
2617 * __devm_spi_alloc_controller - resource-managed __spi_alloc_controller()
2618 * @dev: physical device of SPI controller
2619 * @size: how much zeroed driver-private data to allocate
2620 * @slave: whether to allocate an SPI master (false) or SPI slave (true)
2621 * Context: can sleep
2623 * Allocate an SPI controller and automatically release a reference on it
2624 * when @dev is unbound from its driver. Drivers are thus relieved from
2625 * having to call spi_controller_put().
2627 * The arguments to this function are identical to __spi_alloc_controller().
2629 * Return: the SPI controller structure on success, else NULL.
2631 struct spi_controller *__devm_spi_alloc_controller(struct device *dev,
2635 struct spi_controller **ptr, *ctlr;
2637 ptr = devres_alloc(devm_spi_release_controller, sizeof(*ptr),
2642 ctlr = __spi_alloc_controller(dev, size, slave);
2644 ctlr->devm_allocated = true;
2646 devres_add(dev, ptr);
2653 EXPORT_SYMBOL_GPL(__devm_spi_alloc_controller);
2656 static int of_spi_get_gpio_numbers(struct spi_controller *ctlr)
2659 struct device_node *np = ctlr->dev.of_node;
2664 nb = of_gpio_named_count(np, "cs-gpios");
2665 ctlr->num_chipselect = max_t(int, nb, ctlr->num_chipselect);
2667 /* Return error only for an incorrectly formed cs-gpios property */
2668 if (nb == 0 || nb == -ENOENT)
2673 cs = devm_kcalloc(&ctlr->dev, ctlr->num_chipselect, sizeof(int),
2675 ctlr->cs_gpios = cs;
2677 if (!ctlr->cs_gpios)
2680 for (i = 0; i < ctlr->num_chipselect; i++)
2683 for (i = 0; i < nb; i++)
2684 cs[i] = of_get_named_gpio(np, "cs-gpios", i);
2689 static int of_spi_get_gpio_numbers(struct spi_controller *ctlr)
2696 * spi_get_gpio_descs() - grab chip select GPIOs for the master
2697 * @ctlr: The SPI master to grab GPIO descriptors for
2699 static int spi_get_gpio_descs(struct spi_controller *ctlr)
2702 struct gpio_desc **cs;
2703 struct device *dev = &ctlr->dev;
2704 unsigned long native_cs_mask = 0;
2705 unsigned int num_cs_gpios = 0;
2707 nb = gpiod_count(dev, "cs");
2709 /* No GPIOs at all is fine, else return the error */
2715 ctlr->num_chipselect = max_t(int, nb, ctlr->num_chipselect);
2717 cs = devm_kcalloc(dev, ctlr->num_chipselect, sizeof(*cs),
2721 ctlr->cs_gpiods = cs;
2723 for (i = 0; i < nb; i++) {
2725 * Most chipselects are active low, the inverted
2726 * semantics are handled by special quirks in gpiolib,
2727 * so initializing them GPIOD_OUT_LOW here means
2728 * "unasserted", in most cases this will drive the physical
2731 cs[i] = devm_gpiod_get_index_optional(dev, "cs", i,
2734 return PTR_ERR(cs[i]);
2738 * If we find a CS GPIO, name it after the device and
2743 gpioname = devm_kasprintf(dev, GFP_KERNEL, "%s CS%d",
2747 gpiod_set_consumer_name(cs[i], gpioname);
2752 if (ctlr->max_native_cs && i >= ctlr->max_native_cs) {
2753 dev_err(dev, "Invalid native chip select %d\n", i);
2756 native_cs_mask |= BIT(i);
2759 ctlr->unused_native_cs = ffs(~native_cs_mask) - 1;
2761 if ((ctlr->flags & SPI_MASTER_GPIO_SS) && num_cs_gpios &&
2762 ctlr->max_native_cs && ctlr->unused_native_cs >= ctlr->max_native_cs) {
2763 dev_err(dev, "No unused native chip select available\n");
2770 static int spi_controller_check_ops(struct spi_controller *ctlr)
2773 * The controller may implement only the high-level SPI-memory like
2774 * operations if it does not support regular SPI transfers, and this is
2776 * If ->mem_ops is NULL, we request that at least one of the
2777 * ->transfer_xxx() method be implemented.
2779 if (ctlr->mem_ops) {
2780 if (!ctlr->mem_ops->exec_op)
2782 } else if (!ctlr->transfer && !ctlr->transfer_one &&
2783 !ctlr->transfer_one_message) {
2791 * spi_register_controller - register SPI master or slave controller
2792 * @ctlr: initialized master, originally from spi_alloc_master() or
2794 * Context: can sleep
2796 * SPI controllers connect to their drivers using some non-SPI bus,
2797 * such as the platform bus. The final stage of probe() in that code
2798 * includes calling spi_register_controller() to hook up to this SPI bus glue.
2800 * SPI controllers use board specific (often SOC specific) bus numbers,
2801 * and board-specific addressing for SPI devices combines those numbers
2802 * with chip select numbers. Since SPI does not directly support dynamic
2803 * device identification, boards need configuration tables telling which
2804 * chip is at which address.
2806 * This must be called from context that can sleep. It returns zero on
2807 * success, else a negative error code (dropping the controller's refcount).
2808 * After a successful return, the caller is responsible for calling
2809 * spi_unregister_controller().
2811 * Return: zero on success, else a negative error code.
2813 int spi_register_controller(struct spi_controller *ctlr)
2815 struct device *dev = ctlr->dev.parent;
2816 struct boardinfo *bi;
2818 int id, first_dynamic;
2824 * Make sure all necessary hooks are implemented before registering
2825 * the SPI controller.
2827 status = spi_controller_check_ops(ctlr);
2831 if (ctlr->bus_num >= 0) {
2832 /* devices with a fixed bus num must check-in with the num */
2833 mutex_lock(&board_lock);
2834 id = idr_alloc(&spi_master_idr, ctlr, ctlr->bus_num,
2835 ctlr->bus_num + 1, GFP_KERNEL);
2836 mutex_unlock(&board_lock);
2837 if (WARN(id < 0, "couldn't get idr"))
2838 return id == -ENOSPC ? -EBUSY : id;
2840 } else if (ctlr->dev.of_node) {
2841 /* allocate dynamic bus number using Linux idr */
2842 id = of_alias_get_id(ctlr->dev.of_node, "spi");
2845 mutex_lock(&board_lock);
2846 id = idr_alloc(&spi_master_idr, ctlr, ctlr->bus_num,
2847 ctlr->bus_num + 1, GFP_KERNEL);
2848 mutex_unlock(&board_lock);
2849 if (WARN(id < 0, "couldn't get idr"))
2850 return id == -ENOSPC ? -EBUSY : id;
2853 if (ctlr->bus_num < 0) {
2854 first_dynamic = of_alias_get_highest_id("spi");
2855 if (first_dynamic < 0)
2860 mutex_lock(&board_lock);
2861 id = idr_alloc(&spi_master_idr, ctlr, first_dynamic,
2863 mutex_unlock(&board_lock);
2864 if (WARN(id < 0, "couldn't get idr"))
2868 ctlr->bus_lock_flag = 0;
2869 init_completion(&ctlr->xfer_completion);
2870 if (!ctlr->max_dma_len)
2871 ctlr->max_dma_len = INT_MAX;
2873 /* register the device, then userspace will see it.
2874 * registration fails if the bus ID is in use.
2876 dev_set_name(&ctlr->dev, "spi%u", ctlr->bus_num);
2878 if (!spi_controller_is_slave(ctlr)) {
2879 if (ctlr->use_gpio_descriptors) {
2880 status = spi_get_gpio_descs(ctlr);
2884 * A controller using GPIO descriptors always
2885 * supports SPI_CS_HIGH if need be.
2887 ctlr->mode_bits |= SPI_CS_HIGH;
2889 /* Legacy code path for GPIOs from DT */
2890 status = of_spi_get_gpio_numbers(ctlr);
2897 * Even if it's just one always-selected device, there must
2898 * be at least one chipselect.
2900 if (!ctlr->num_chipselect) {
2905 status = device_add(&ctlr->dev);
2908 dev_dbg(dev, "registered %s %s\n",
2909 spi_controller_is_slave(ctlr) ? "slave" : "master",
2910 dev_name(&ctlr->dev));
2913 * If we're using a queued driver, start the queue. Note that we don't
2914 * need the queueing logic if the driver is only supporting high-level
2915 * memory operations.
2917 if (ctlr->transfer) {
2918 dev_info(dev, "controller is unqueued, this is deprecated\n");
2919 } else if (ctlr->transfer_one || ctlr->transfer_one_message) {
2920 status = spi_controller_initialize_queue(ctlr);
2922 device_del(&ctlr->dev);
2926 /* add statistics */
2927 spin_lock_init(&ctlr->statistics.lock);
2929 mutex_lock(&board_lock);
2930 list_add_tail(&ctlr->list, &spi_controller_list);
2931 list_for_each_entry(bi, &board_list, list)
2932 spi_match_controller_to_boardinfo(ctlr, &bi->board_info);
2933 mutex_unlock(&board_lock);
2935 /* Register devices from the device tree and ACPI */
2936 of_register_spi_devices(ctlr);
2937 acpi_register_spi_devices(ctlr);
2941 mutex_lock(&board_lock);
2942 idr_remove(&spi_master_idr, ctlr->bus_num);
2943 mutex_unlock(&board_lock);
2946 EXPORT_SYMBOL_GPL(spi_register_controller);
2948 static void devm_spi_unregister(void *ctlr)
2950 spi_unregister_controller(ctlr);
2954 * devm_spi_register_controller - register managed SPI master or slave
2956 * @dev: device managing SPI controller
2957 * @ctlr: initialized controller, originally from spi_alloc_master() or
2959 * Context: can sleep
2961 * Register a SPI device as with spi_register_controller() which will
2962 * automatically be unregistered and freed.
2964 * Return: zero on success, else a negative error code.
2966 int devm_spi_register_controller(struct device *dev,
2967 struct spi_controller *ctlr)
2971 ret = spi_register_controller(ctlr);
2975 return devm_add_action_or_reset(dev, devm_spi_unregister, ctlr);
2977 EXPORT_SYMBOL_GPL(devm_spi_register_controller);
2979 static int __unregister(struct device *dev, void *null)
2981 spi_unregister_device(to_spi_device(dev));
2986 * spi_unregister_controller - unregister SPI master or slave controller
2987 * @ctlr: the controller being unregistered
2988 * Context: can sleep
2990 * This call is used only by SPI controller drivers, which are the
2991 * only ones directly touching chip registers.
2993 * This must be called from context that can sleep.
2995 * Note that this function also drops a reference to the controller.
2997 void spi_unregister_controller(struct spi_controller *ctlr)
2999 struct spi_controller *found;
3000 int id = ctlr->bus_num;
3002 /* Prevent addition of new devices, unregister existing ones */
3003 if (IS_ENABLED(CONFIG_SPI_DYNAMIC))
3004 mutex_lock(&ctlr->add_lock);
3006 device_for_each_child(&ctlr->dev, NULL, __unregister);
3008 /* First make sure that this controller was ever added */
3009 mutex_lock(&board_lock);
3010 found = idr_find(&spi_master_idr, id);
3011 mutex_unlock(&board_lock);
3013 if (spi_destroy_queue(ctlr))
3014 dev_err(&ctlr->dev, "queue remove failed\n");
3016 mutex_lock(&board_lock);
3017 list_del(&ctlr->list);
3018 mutex_unlock(&board_lock);
3020 device_del(&ctlr->dev);
3023 mutex_lock(&board_lock);
3025 idr_remove(&spi_master_idr, id);
3026 mutex_unlock(&board_lock);
3028 if (IS_ENABLED(CONFIG_SPI_DYNAMIC))
3029 mutex_unlock(&ctlr->add_lock);
3031 /* Release the last reference on the controller if its driver
3032 * has not yet been converted to devm_spi_alloc_master/slave().
3034 if (!ctlr->devm_allocated)
3035 put_device(&ctlr->dev);
3037 EXPORT_SYMBOL_GPL(spi_unregister_controller);
3039 int spi_controller_suspend(struct spi_controller *ctlr)
3043 /* Basically no-ops for non-queued controllers */
3047 ret = spi_stop_queue(ctlr);
3049 dev_err(&ctlr->dev, "queue stop failed\n");
3053 EXPORT_SYMBOL_GPL(spi_controller_suspend);
3055 int spi_controller_resume(struct spi_controller *ctlr)
3062 ret = spi_start_queue(ctlr);
3064 dev_err(&ctlr->dev, "queue restart failed\n");
3068 EXPORT_SYMBOL_GPL(spi_controller_resume);
3070 static int __spi_controller_match(struct device *dev, const void *data)
3072 struct spi_controller *ctlr;
3073 const u16 *bus_num = data;
3075 ctlr = container_of(dev, struct spi_controller, dev);
3076 return ctlr->bus_num == *bus_num;
3080 * spi_busnum_to_master - look up master associated with bus_num
3081 * @bus_num: the master's bus number
3082 * Context: can sleep
3084 * This call may be used with devices that are registered after
3085 * arch init time. It returns a refcounted pointer to the relevant
3086 * spi_controller (which the caller must release), or NULL if there is
3087 * no such master registered.
3089 * Return: the SPI master structure on success, else NULL.
3091 struct spi_controller *spi_busnum_to_master(u16 bus_num)
3094 struct spi_controller *ctlr = NULL;
3096 dev = class_find_device(&spi_master_class, NULL, &bus_num,
3097 __spi_controller_match);
3099 ctlr = container_of(dev, struct spi_controller, dev);
3100 /* reference got in class_find_device */
3103 EXPORT_SYMBOL_GPL(spi_busnum_to_master);
3105 /*-------------------------------------------------------------------------*/
3107 /* Core methods for SPI resource management */
3110 * spi_res_alloc - allocate a spi resource that is life-cycle managed
3111 * during the processing of a spi_message while using
3113 * @spi: the spi device for which we allocate memory
3114 * @release: the release code to execute for this resource
3115 * @size: size to alloc and return
3116 * @gfp: GFP allocation flags
3118 * Return: the pointer to the allocated data
3120 * This may get enhanced in the future to allocate from a memory pool
3121 * of the @spi_device or @spi_controller to avoid repeated allocations.
3123 void *spi_res_alloc(struct spi_device *spi,
3124 spi_res_release_t release,
3125 size_t size, gfp_t gfp)
3127 struct spi_res *sres;
3129 sres = kzalloc(sizeof(*sres) + size, gfp);
3133 INIT_LIST_HEAD(&sres->entry);
3134 sres->release = release;
3138 EXPORT_SYMBOL_GPL(spi_res_alloc);
3141 * spi_res_free - free an spi resource
3142 * @res: pointer to the custom data of a resource
3145 void spi_res_free(void *res)
3147 struct spi_res *sres = container_of(res, struct spi_res, data);
3152 WARN_ON(!list_empty(&sres->entry));
3155 EXPORT_SYMBOL_GPL(spi_res_free);
3158 * spi_res_add - add a spi_res to the spi_message
3159 * @message: the spi message
3160 * @res: the spi_resource
3162 void spi_res_add(struct spi_message *message, void *res)
3164 struct spi_res *sres = container_of(res, struct spi_res, data);
3166 WARN_ON(!list_empty(&sres->entry));
3167 list_add_tail(&sres->entry, &message->resources);
3169 EXPORT_SYMBOL_GPL(spi_res_add);
3172 * spi_res_release - release all spi resources for this message
3173 * @ctlr: the @spi_controller
3174 * @message: the @spi_message
3176 void spi_res_release(struct spi_controller *ctlr, struct spi_message *message)
3178 struct spi_res *res, *tmp;
3180 list_for_each_entry_safe_reverse(res, tmp, &message->resources, entry) {
3182 res->release(ctlr, message, res->data);
3184 list_del(&res->entry);
3189 EXPORT_SYMBOL_GPL(spi_res_release);
3191 /*-------------------------------------------------------------------------*/
3193 /* Core methods for spi_message alterations */
3195 static void __spi_replace_transfers_release(struct spi_controller *ctlr,
3196 struct spi_message *msg,
3199 struct spi_replaced_transfers *rxfer = res;
3202 /* call extra callback if requested */
3204 rxfer->release(ctlr, msg, res);
3206 /* insert replaced transfers back into the message */
3207 list_splice(&rxfer->replaced_transfers, rxfer->replaced_after);
3209 /* remove the formerly inserted entries */
3210 for (i = 0; i < rxfer->inserted; i++)
3211 list_del(&rxfer->inserted_transfers[i].transfer_list);
3215 * spi_replace_transfers - replace transfers with several transfers
3216 * and register change with spi_message.resources
3217 * @msg: the spi_message we work upon
3218 * @xfer_first: the first spi_transfer we want to replace
3219 * @remove: number of transfers to remove
3220 * @insert: the number of transfers we want to insert instead
3221 * @release: extra release code necessary in some circumstances
3222 * @extradatasize: extra data to allocate (with alignment guarantees
3223 * of struct @spi_transfer)
3226 * Returns: pointer to @spi_replaced_transfers,
3227 * PTR_ERR(...) in case of errors.
3229 struct spi_replaced_transfers *spi_replace_transfers(
3230 struct spi_message *msg,
3231 struct spi_transfer *xfer_first,
3234 spi_replaced_release_t release,
3235 size_t extradatasize,
3238 struct spi_replaced_transfers *rxfer;
3239 struct spi_transfer *xfer;
3242 /* allocate the structure using spi_res */
3243 rxfer = spi_res_alloc(msg->spi, __spi_replace_transfers_release,
3244 struct_size(rxfer, inserted_transfers, insert)
3248 return ERR_PTR(-ENOMEM);
3250 /* the release code to invoke before running the generic release */
3251 rxfer->release = release;
3253 /* assign extradata */
3256 &rxfer->inserted_transfers[insert];
3258 /* init the replaced_transfers list */
3259 INIT_LIST_HEAD(&rxfer->replaced_transfers);
3261 /* assign the list_entry after which we should reinsert
3262 * the @replaced_transfers - it may be spi_message.messages!
3264 rxfer->replaced_after = xfer_first->transfer_list.prev;
3266 /* remove the requested number of transfers */
3267 for (i = 0; i < remove; i++) {
3268 /* if the entry after replaced_after it is msg->transfers
3269 * then we have been requested to remove more transfers
3270 * than are in the list
3272 if (rxfer->replaced_after->next == &msg->transfers) {
3273 dev_err(&msg->spi->dev,
3274 "requested to remove more spi_transfers than are available\n");
3275 /* insert replaced transfers back into the message */
3276 list_splice(&rxfer->replaced_transfers,
3277 rxfer->replaced_after);
3279 /* free the spi_replace_transfer structure */
3280 spi_res_free(rxfer);
3282 /* and return with an error */
3283 return ERR_PTR(-EINVAL);
3286 /* remove the entry after replaced_after from list of
3287 * transfers and add it to list of replaced_transfers
3289 list_move_tail(rxfer->replaced_after->next,
3290 &rxfer->replaced_transfers);
3293 /* create copy of the given xfer with identical settings
3294 * based on the first transfer to get removed
3296 for (i = 0; i < insert; i++) {
3297 /* we need to run in reverse order */
3298 xfer = &rxfer->inserted_transfers[insert - 1 - i];
3300 /* copy all spi_transfer data */
3301 memcpy(xfer, xfer_first, sizeof(*xfer));
3304 list_add(&xfer->transfer_list, rxfer->replaced_after);
3306 /* clear cs_change and delay for all but the last */
3308 xfer->cs_change = false;
3309 xfer->delay.value = 0;
3313 /* set up inserted */
3314 rxfer->inserted = insert;
3316 /* and register it with spi_res/spi_message */
3317 spi_res_add(msg, rxfer);
3321 EXPORT_SYMBOL_GPL(spi_replace_transfers);
3323 static int __spi_split_transfer_maxsize(struct spi_controller *ctlr,
3324 struct spi_message *msg,
3325 struct spi_transfer **xferp,
3329 struct spi_transfer *xfer = *xferp, *xfers;
3330 struct spi_replaced_transfers *srt;
3334 /* calculate how many we have to replace */
3335 count = DIV_ROUND_UP(xfer->len, maxsize);
3337 /* create replacement */
3338 srt = spi_replace_transfers(msg, xfer, 1, count, NULL, 0, gfp);
3340 return PTR_ERR(srt);
3341 xfers = srt->inserted_transfers;
3343 /* now handle each of those newly inserted spi_transfers
3344 * note that the replacements spi_transfers all are preset
3345 * to the same values as *xferp, so tx_buf, rx_buf and len
3346 * are all identical (as well as most others)
3347 * so we just have to fix up len and the pointers.
3349 * this also includes support for the depreciated
3350 * spi_message.is_dma_mapped interface
3353 /* the first transfer just needs the length modified, so we
3354 * run it outside the loop
3356 xfers[0].len = min_t(size_t, maxsize, xfer[0].len);
3358 /* all the others need rx_buf/tx_buf also set */
3359 for (i = 1, offset = maxsize; i < count; offset += maxsize, i++) {
3360 /* update rx_buf, tx_buf and dma */
3361 if (xfers[i].rx_buf)
3362 xfers[i].rx_buf += offset;
3363 if (xfers[i].rx_dma)
3364 xfers[i].rx_dma += offset;
3365 if (xfers[i].tx_buf)
3366 xfers[i].tx_buf += offset;
3367 if (xfers[i].tx_dma)
3368 xfers[i].tx_dma += offset;
3371 xfers[i].len = min(maxsize, xfers[i].len - offset);
3374 /* we set up xferp to the last entry we have inserted,
3375 * so that we skip those already split transfers
3377 *xferp = &xfers[count - 1];
3379 /* increment statistics counters */
3380 SPI_STATISTICS_INCREMENT_FIELD(&ctlr->statistics,
3381 transfers_split_maxsize);
3382 SPI_STATISTICS_INCREMENT_FIELD(&msg->spi->statistics,
3383 transfers_split_maxsize);
3389 * spi_split_transfers_maxsize - split spi transfers into multiple transfers
3390 * when an individual transfer exceeds a
3392 * @ctlr: the @spi_controller for this transfer
3393 * @msg: the @spi_message to transform
3394 * @maxsize: the maximum when to apply this
3395 * @gfp: GFP allocation flags
3397 * Return: status of transformation
3399 int spi_split_transfers_maxsize(struct spi_controller *ctlr,
3400 struct spi_message *msg,
3404 struct spi_transfer *xfer;
3407 /* iterate over the transfer_list,
3408 * but note that xfer is advanced to the last transfer inserted
3409 * to avoid checking sizes again unnecessarily (also xfer does
3410 * potentiall belong to a different list by the time the
3411 * replacement has happened
3413 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
3414 if (xfer->len > maxsize) {
3415 ret = __spi_split_transfer_maxsize(ctlr, msg, &xfer,
3424 EXPORT_SYMBOL_GPL(spi_split_transfers_maxsize);
3426 /*-------------------------------------------------------------------------*/
3428 /* Core methods for SPI controller protocol drivers. Some of the
3429 * other core methods are currently defined as inline functions.
3432 static int __spi_validate_bits_per_word(struct spi_controller *ctlr,
3435 if (ctlr->bits_per_word_mask) {
3436 /* Only 32 bits fit in the mask */
3437 if (bits_per_word > 32)
3439 if (!(ctlr->bits_per_word_mask & SPI_BPW_MASK(bits_per_word)))
3447 * spi_setup - setup SPI mode and clock rate
3448 * @spi: the device whose settings are being modified
3449 * Context: can sleep, and no requests are queued to the device
3451 * SPI protocol drivers may need to update the transfer mode if the
3452 * device doesn't work with its default. They may likewise need
3453 * to update clock rates or word sizes from initial values. This function
3454 * changes those settings, and must be called from a context that can sleep.
3455 * Except for SPI_CS_HIGH, which takes effect immediately, the changes take
3456 * effect the next time the device is selected and data is transferred to
3457 * or from it. When this function returns, the spi device is deselected.
3459 * Note that this call will fail if the protocol driver specifies an option
3460 * that the underlying controller or its driver does not support. For
3461 * example, not all hardware supports wire transfers using nine bit words,
3462 * LSB-first wire encoding, or active-high chipselects.
3464 * Return: zero on success, else a negative error code.
3466 int spi_setup(struct spi_device *spi)
3468 unsigned bad_bits, ugly_bits;
3472 * check mode to prevent that any two of DUAL, QUAD and NO_MOSI/MISO
3473 * are set at the same time
3475 if ((hweight_long(spi->mode &
3476 (SPI_TX_DUAL | SPI_TX_QUAD | SPI_NO_TX)) > 1) ||
3477 (hweight_long(spi->mode &
3478 (SPI_RX_DUAL | SPI_RX_QUAD | SPI_NO_RX)) > 1)) {
3480 "setup: can not select any two of dual, quad and no-rx/tx at the same time\n");
3483 /* if it is SPI_3WIRE mode, DUAL and QUAD should be forbidden
3485 if ((spi->mode & SPI_3WIRE) && (spi->mode &
3486 (SPI_TX_DUAL | SPI_TX_QUAD | SPI_TX_OCTAL |
3487 SPI_RX_DUAL | SPI_RX_QUAD | SPI_RX_OCTAL)))
3489 /* help drivers fail *cleanly* when they need options
3490 * that aren't supported with their current controller
3491 * SPI_CS_WORD has a fallback software implementation,
3492 * so it is ignored here.
3494 bad_bits = spi->mode & ~(spi->controller->mode_bits | SPI_CS_WORD |
3495 SPI_NO_TX | SPI_NO_RX);
3496 /* nothing prevents from working with active-high CS in case if it
3497 * is driven by GPIO.
3499 if (gpio_is_valid(spi->cs_gpio))
3500 bad_bits &= ~SPI_CS_HIGH;
3501 ugly_bits = bad_bits &
3502 (SPI_TX_DUAL | SPI_TX_QUAD | SPI_TX_OCTAL |
3503 SPI_RX_DUAL | SPI_RX_QUAD | SPI_RX_OCTAL);
3506 "setup: ignoring unsupported mode bits %x\n",
3508 spi->mode &= ~ugly_bits;
3509 bad_bits &= ~ugly_bits;
3512 dev_err(&spi->dev, "setup: unsupported mode bits %x\n",
3517 if (!spi->bits_per_word)
3518 spi->bits_per_word = 8;
3520 status = __spi_validate_bits_per_word(spi->controller,
3521 spi->bits_per_word);
3525 if (spi->controller->max_speed_hz &&
3526 (!spi->max_speed_hz ||
3527 spi->max_speed_hz > spi->controller->max_speed_hz))
3528 spi->max_speed_hz = spi->controller->max_speed_hz;
3530 mutex_lock(&spi->controller->io_mutex);
3532 if (spi->controller->setup) {
3533 status = spi->controller->setup(spi);
3535 mutex_unlock(&spi->controller->io_mutex);
3536 dev_err(&spi->controller->dev, "Failed to setup device: %d\n",
3542 if (spi->controller->auto_runtime_pm && spi->controller->set_cs) {
3543 status = pm_runtime_get_sync(spi->controller->dev.parent);
3545 mutex_unlock(&spi->controller->io_mutex);
3546 pm_runtime_put_noidle(spi->controller->dev.parent);
3547 dev_err(&spi->controller->dev, "Failed to power device: %d\n",
3553 * We do not want to return positive value from pm_runtime_get,
3554 * there are many instances of devices calling spi_setup() and
3555 * checking for a non-zero return value instead of a negative
3560 spi_set_cs(spi, false, true);
3561 pm_runtime_mark_last_busy(spi->controller->dev.parent);
3562 pm_runtime_put_autosuspend(spi->controller->dev.parent);
3564 spi_set_cs(spi, false, true);
3567 mutex_unlock(&spi->controller->io_mutex);
3569 if (spi->rt && !spi->controller->rt) {
3570 spi->controller->rt = true;
3571 spi_set_thread_rt(spi->controller);
3574 trace_spi_setup(spi, status);
3576 dev_dbg(&spi->dev, "setup mode %lu, %s%s%s%s%u bits/w, %u Hz max --> %d\n",
3577 spi->mode & SPI_MODE_X_MASK,
3578 (spi->mode & SPI_CS_HIGH) ? "cs_high, " : "",
3579 (spi->mode & SPI_LSB_FIRST) ? "lsb, " : "",
3580 (spi->mode & SPI_3WIRE) ? "3wire, " : "",
3581 (spi->mode & SPI_LOOP) ? "loopback, " : "",
3582 spi->bits_per_word, spi->max_speed_hz,
3587 EXPORT_SYMBOL_GPL(spi_setup);
3589 static int _spi_xfer_word_delay_update(struct spi_transfer *xfer,
3590 struct spi_device *spi)
3594 delay1 = spi_delay_to_ns(&xfer->word_delay, xfer);
3598 delay2 = spi_delay_to_ns(&spi->word_delay, xfer);
3602 if (delay1 < delay2)
3603 memcpy(&xfer->word_delay, &spi->word_delay,
3604 sizeof(xfer->word_delay));
3609 static int __spi_validate(struct spi_device *spi, struct spi_message *message)
3611 struct spi_controller *ctlr = spi->controller;
3612 struct spi_transfer *xfer;
3615 if (list_empty(&message->transfers))
3618 /* If an SPI controller does not support toggling the CS line on each
3619 * transfer (indicated by the SPI_CS_WORD flag) or we are using a GPIO
3620 * for the CS line, we can emulate the CS-per-word hardware function by
3621 * splitting transfers into one-word transfers and ensuring that
3622 * cs_change is set for each transfer.
3624 if ((spi->mode & SPI_CS_WORD) && (!(ctlr->mode_bits & SPI_CS_WORD) ||
3626 gpio_is_valid(spi->cs_gpio))) {
3630 maxsize = (spi->bits_per_word + 7) / 8;
3632 /* spi_split_transfers_maxsize() requires message->spi */
3635 ret = spi_split_transfers_maxsize(ctlr, message, maxsize,
3640 list_for_each_entry(xfer, &message->transfers, transfer_list) {
3641 /* don't change cs_change on the last entry in the list */
3642 if (list_is_last(&xfer->transfer_list, &message->transfers))
3644 xfer->cs_change = 1;
3648 /* Half-duplex links include original MicroWire, and ones with
3649 * only one data pin like SPI_3WIRE (switches direction) or where
3650 * either MOSI or MISO is missing. They can also be caused by
3651 * software limitations.
3653 if ((ctlr->flags & SPI_CONTROLLER_HALF_DUPLEX) ||
3654 (spi->mode & SPI_3WIRE)) {
3655 unsigned flags = ctlr->flags;
3657 list_for_each_entry(xfer, &message->transfers, transfer_list) {
3658 if (xfer->rx_buf && xfer->tx_buf)
3660 if ((flags & SPI_CONTROLLER_NO_TX) && xfer->tx_buf)
3662 if ((flags & SPI_CONTROLLER_NO_RX) && xfer->rx_buf)
3668 * Set transfer bits_per_word and max speed as spi device default if
3669 * it is not set for this transfer.
3670 * Set transfer tx_nbits and rx_nbits as single transfer default
3671 * (SPI_NBITS_SINGLE) if it is not set for this transfer.
3672 * Ensure transfer word_delay is at least as long as that required by
3675 message->frame_length = 0;
3676 list_for_each_entry(xfer, &message->transfers, transfer_list) {
3677 xfer->effective_speed_hz = 0;
3678 message->frame_length += xfer->len;
3679 if (!xfer->bits_per_word)
3680 xfer->bits_per_word = spi->bits_per_word;
3682 if (!xfer->speed_hz)
3683 xfer->speed_hz = spi->max_speed_hz;
3685 if (ctlr->max_speed_hz && xfer->speed_hz > ctlr->max_speed_hz)
3686 xfer->speed_hz = ctlr->max_speed_hz;
3688 if (__spi_validate_bits_per_word(ctlr, xfer->bits_per_word))
3692 * SPI transfer length should be multiple of SPI word size
3693 * where SPI word size should be power-of-two multiple
3695 if (xfer->bits_per_word <= 8)
3697 else if (xfer->bits_per_word <= 16)
3702 /* No partial transfers accepted */
3703 if (xfer->len % w_size)
3706 if (xfer->speed_hz && ctlr->min_speed_hz &&
3707 xfer->speed_hz < ctlr->min_speed_hz)
3710 if (xfer->tx_buf && !xfer->tx_nbits)
3711 xfer->tx_nbits = SPI_NBITS_SINGLE;
3712 if (xfer->rx_buf && !xfer->rx_nbits)
3713 xfer->rx_nbits = SPI_NBITS_SINGLE;
3714 /* check transfer tx/rx_nbits:
3715 * 1. check the value matches one of single, dual and quad
3716 * 2. check tx/rx_nbits match the mode in spi_device
3719 if (spi->mode & SPI_NO_TX)
3721 if (xfer->tx_nbits != SPI_NBITS_SINGLE &&
3722 xfer->tx_nbits != SPI_NBITS_DUAL &&
3723 xfer->tx_nbits != SPI_NBITS_QUAD)
3725 if ((xfer->tx_nbits == SPI_NBITS_DUAL) &&
3726 !(spi->mode & (SPI_TX_DUAL | SPI_TX_QUAD)))
3728 if ((xfer->tx_nbits == SPI_NBITS_QUAD) &&
3729 !(spi->mode & SPI_TX_QUAD))
3732 /* check transfer rx_nbits */
3734 if (spi->mode & SPI_NO_RX)
3736 if (xfer->rx_nbits != SPI_NBITS_SINGLE &&
3737 xfer->rx_nbits != SPI_NBITS_DUAL &&
3738 xfer->rx_nbits != SPI_NBITS_QUAD)
3740 if ((xfer->rx_nbits == SPI_NBITS_DUAL) &&
3741 !(spi->mode & (SPI_RX_DUAL | SPI_RX_QUAD)))
3743 if ((xfer->rx_nbits == SPI_NBITS_QUAD) &&
3744 !(spi->mode & SPI_RX_QUAD))
3748 if (_spi_xfer_word_delay_update(xfer, spi))
3752 message->status = -EINPROGRESS;
3757 static int __spi_async(struct spi_device *spi, struct spi_message *message)
3759 struct spi_controller *ctlr = spi->controller;
3760 struct spi_transfer *xfer;
3763 * Some controllers do not support doing regular SPI transfers. Return
3764 * ENOTSUPP when this is the case.
3766 if (!ctlr->transfer)
3771 SPI_STATISTICS_INCREMENT_FIELD(&ctlr->statistics, spi_async);
3772 SPI_STATISTICS_INCREMENT_FIELD(&spi->statistics, spi_async);
3774 trace_spi_message_submit(message);
3776 if (!ctlr->ptp_sts_supported) {
3777 list_for_each_entry(xfer, &message->transfers, transfer_list) {
3778 xfer->ptp_sts_word_pre = 0;
3779 ptp_read_system_prets(xfer->ptp_sts);
3783 return ctlr->transfer(spi, message);
3787 * spi_async - asynchronous SPI transfer
3788 * @spi: device with which data will be exchanged
3789 * @message: describes the data transfers, including completion callback
3790 * Context: any (irqs may be blocked, etc)
3792 * This call may be used in_irq and other contexts which can't sleep,
3793 * as well as from task contexts which can sleep.
3795 * The completion callback is invoked in a context which can't sleep.
3796 * Before that invocation, the value of message->status is undefined.
3797 * When the callback is issued, message->status holds either zero (to
3798 * indicate complete success) or a negative error code. After that
3799 * callback returns, the driver which issued the transfer request may
3800 * deallocate the associated memory; it's no longer in use by any SPI
3801 * core or controller driver code.
3803 * Note that although all messages to a spi_device are handled in
3804 * FIFO order, messages may go to different devices in other orders.
3805 * Some device might be higher priority, or have various "hard" access
3806 * time requirements, for example.
3808 * On detection of any fault during the transfer, processing of
3809 * the entire message is aborted, and the device is deselected.
3810 * Until returning from the associated message completion callback,
3811 * no other spi_message queued to that device will be processed.
3812 * (This rule applies equally to all the synchronous transfer calls,
3813 * which are wrappers around this core asynchronous primitive.)
3815 * Return: zero on success, else a negative error code.
3817 int spi_async(struct spi_device *spi, struct spi_message *message)
3819 struct spi_controller *ctlr = spi->controller;
3821 unsigned long flags;
3823 ret = __spi_validate(spi, message);
3827 spin_lock_irqsave(&ctlr->bus_lock_spinlock, flags);
3829 if (ctlr->bus_lock_flag)
3832 ret = __spi_async(spi, message);
3834 spin_unlock_irqrestore(&ctlr->bus_lock_spinlock, flags);
3838 EXPORT_SYMBOL_GPL(spi_async);
3841 * spi_async_locked - version of spi_async with exclusive bus usage
3842 * @spi: device with which data will be exchanged
3843 * @message: describes the data transfers, including completion callback
3844 * Context: any (irqs may be blocked, etc)
3846 * This call may be used in_irq and other contexts which can't sleep,
3847 * as well as from task contexts which can sleep.
3849 * The completion callback is invoked in a context which can't sleep.
3850 * Before that invocation, the value of message->status is undefined.
3851 * When the callback is issued, message->status holds either zero (to
3852 * indicate complete success) or a negative error code. After that
3853 * callback returns, the driver which issued the transfer request may
3854 * deallocate the associated memory; it's no longer in use by any SPI
3855 * core or controller driver code.
3857 * Note that although all messages to a spi_device are handled in
3858 * FIFO order, messages may go to different devices in other orders.
3859 * Some device might be higher priority, or have various "hard" access
3860 * time requirements, for example.
3862 * On detection of any fault during the transfer, processing of
3863 * the entire message is aborted, and the device is deselected.
3864 * Until returning from the associated message completion callback,
3865 * no other spi_message queued to that device will be processed.
3866 * (This rule applies equally to all the synchronous transfer calls,
3867 * which are wrappers around this core asynchronous primitive.)
3869 * Return: zero on success, else a negative error code.
3871 int spi_async_locked(struct spi_device *spi, struct spi_message *message)
3873 struct spi_controller *ctlr = spi->controller;
3875 unsigned long flags;
3877 ret = __spi_validate(spi, message);
3881 spin_lock_irqsave(&ctlr->bus_lock_spinlock, flags);
3883 ret = __spi_async(spi, message);
3885 spin_unlock_irqrestore(&ctlr->bus_lock_spinlock, flags);
3890 EXPORT_SYMBOL_GPL(spi_async_locked);
3892 /*-------------------------------------------------------------------------*/
3894 /* Utility methods for SPI protocol drivers, layered on
3895 * top of the core. Some other utility methods are defined as
3899 static void spi_complete(void *arg)
3904 static int __spi_sync(struct spi_device *spi, struct spi_message *message)
3906 DECLARE_COMPLETION_ONSTACK(done);
3908 struct spi_controller *ctlr = spi->controller;
3909 unsigned long flags;
3911 status = __spi_validate(spi, message);
3915 message->complete = spi_complete;
3916 message->context = &done;
3919 SPI_STATISTICS_INCREMENT_FIELD(&ctlr->statistics, spi_sync);
3920 SPI_STATISTICS_INCREMENT_FIELD(&spi->statistics, spi_sync);
3922 /* If we're not using the legacy transfer method then we will
3923 * try to transfer in the calling context so special case.
3924 * This code would be less tricky if we could remove the
3925 * support for driver implemented message queues.
3927 if (ctlr->transfer == spi_queued_transfer) {
3928 spin_lock_irqsave(&ctlr->bus_lock_spinlock, flags);
3930 trace_spi_message_submit(message);
3932 status = __spi_queued_transfer(spi, message, false);
3934 spin_unlock_irqrestore(&ctlr->bus_lock_spinlock, flags);
3936 status = spi_async_locked(spi, message);
3940 /* Push out the messages in the calling context if we
3943 if (ctlr->transfer == spi_queued_transfer) {
3944 SPI_STATISTICS_INCREMENT_FIELD(&ctlr->statistics,
3945 spi_sync_immediate);
3946 SPI_STATISTICS_INCREMENT_FIELD(&spi->statistics,
3947 spi_sync_immediate);
3948 __spi_pump_messages(ctlr, false);
3951 wait_for_completion(&done);
3952 status = message->status;
3954 message->context = NULL;
3959 * spi_sync - blocking/synchronous SPI data transfers
3960 * @spi: device with which data will be exchanged
3961 * @message: describes the data transfers
3962 * Context: can sleep
3964 * This call may only be used from a context that may sleep. The sleep
3965 * is non-interruptible, and has no timeout. Low-overhead controller
3966 * drivers may DMA directly into and out of the message buffers.
3968 * Note that the SPI device's chip select is active during the message,
3969 * and then is normally disabled between messages. Drivers for some
3970 * frequently-used devices may want to minimize costs of selecting a chip,
3971 * by leaving it selected in anticipation that the next message will go
3972 * to the same chip. (That may increase power usage.)
3974 * Also, the caller is guaranteeing that the memory associated with the
3975 * message will not be freed before this call returns.
3977 * Return: zero on success, else a negative error code.
3979 int spi_sync(struct spi_device *spi, struct spi_message *message)
3983 mutex_lock(&spi->controller->bus_lock_mutex);
3984 ret = __spi_sync(spi, message);
3985 mutex_unlock(&spi->controller->bus_lock_mutex);
3989 EXPORT_SYMBOL_GPL(spi_sync);
3992 * spi_sync_locked - version of spi_sync with exclusive bus usage
3993 * @spi: device with which data will be exchanged
3994 * @message: describes the data transfers
3995 * Context: can sleep
3997 * This call may only be used from a context that may sleep. The sleep
3998 * is non-interruptible, and has no timeout. Low-overhead controller
3999 * drivers may DMA directly into and out of the message buffers.
4001 * This call should be used by drivers that require exclusive access to the
4002 * SPI bus. It has to be preceded by a spi_bus_lock call. The SPI bus must
4003 * be released by a spi_bus_unlock call when the exclusive access is over.
4005 * Return: zero on success, else a negative error code.
4007 int spi_sync_locked(struct spi_device *spi, struct spi_message *message)
4009 return __spi_sync(spi, message);
4011 EXPORT_SYMBOL_GPL(spi_sync_locked);
4014 * spi_bus_lock - obtain a lock for exclusive SPI bus usage
4015 * @ctlr: SPI bus master that should be locked for exclusive bus access
4016 * Context: can sleep
4018 * This call may only be used from a context that may sleep. The sleep
4019 * is non-interruptible, and has no timeout.
4021 * This call should be used by drivers that require exclusive access to the
4022 * SPI bus. The SPI bus must be released by a spi_bus_unlock call when the
4023 * exclusive access is over. Data transfer must be done by spi_sync_locked
4024 * and spi_async_locked calls when the SPI bus lock is held.
4026 * Return: always zero.
4028 int spi_bus_lock(struct spi_controller *ctlr)
4030 unsigned long flags;
4032 mutex_lock(&ctlr->bus_lock_mutex);
4034 spin_lock_irqsave(&ctlr->bus_lock_spinlock, flags);
4035 ctlr->bus_lock_flag = 1;
4036 spin_unlock_irqrestore(&ctlr->bus_lock_spinlock, flags);
4038 /* mutex remains locked until spi_bus_unlock is called */
4042 EXPORT_SYMBOL_GPL(spi_bus_lock);
4045 * spi_bus_unlock - release the lock for exclusive SPI bus usage
4046 * @ctlr: SPI bus master that was locked for exclusive bus access
4047 * Context: can sleep
4049 * This call may only be used from a context that may sleep. The sleep
4050 * is non-interruptible, and has no timeout.
4052 * This call releases an SPI bus lock previously obtained by an spi_bus_lock
4055 * Return: always zero.
4057 int spi_bus_unlock(struct spi_controller *ctlr)
4059 ctlr->bus_lock_flag = 0;
4061 mutex_unlock(&ctlr->bus_lock_mutex);
4065 EXPORT_SYMBOL_GPL(spi_bus_unlock);
4067 /* portable code must never pass more than 32 bytes */
4068 #define SPI_BUFSIZ max(32, SMP_CACHE_BYTES)
4073 * spi_write_then_read - SPI synchronous write followed by read
4074 * @spi: device with which data will be exchanged
4075 * @txbuf: data to be written (need not be dma-safe)
4076 * @n_tx: size of txbuf, in bytes
4077 * @rxbuf: buffer into which data will be read (need not be dma-safe)
4078 * @n_rx: size of rxbuf, in bytes
4079 * Context: can sleep
4081 * This performs a half duplex MicroWire style transaction with the
4082 * device, sending txbuf and then reading rxbuf. The return value
4083 * is zero for success, else a negative errno status code.
4084 * This call may only be used from a context that may sleep.
4086 * Parameters to this routine are always copied using a small buffer.
4087 * Performance-sensitive or bulk transfer code should instead use
4088 * spi_{async,sync}() calls with dma-safe buffers.
4090 * Return: zero on success, else a negative error code.
4092 int spi_write_then_read(struct spi_device *spi,
4093 const void *txbuf, unsigned n_tx,
4094 void *rxbuf, unsigned n_rx)
4096 static DEFINE_MUTEX(lock);
4099 struct spi_message message;
4100 struct spi_transfer x[2];
4103 /* Use preallocated DMA-safe buffer if we can. We can't avoid
4104 * copying here, (as a pure convenience thing), but we can
4105 * keep heap costs out of the hot path unless someone else is
4106 * using the pre-allocated buffer or the transfer is too large.
4108 if ((n_tx + n_rx) > SPI_BUFSIZ || !mutex_trylock(&lock)) {
4109 local_buf = kmalloc(max((unsigned)SPI_BUFSIZ, n_tx + n_rx),
4110 GFP_KERNEL | GFP_DMA);
4117 spi_message_init(&message);
4118 memset(x, 0, sizeof(x));
4121 spi_message_add_tail(&x[0], &message);
4125 spi_message_add_tail(&x[1], &message);
4128 memcpy(local_buf, txbuf, n_tx);
4129 x[0].tx_buf = local_buf;
4130 x[1].rx_buf = local_buf + n_tx;
4133 status = spi_sync(spi, &message);
4135 memcpy(rxbuf, x[1].rx_buf, n_rx);
4137 if (x[0].tx_buf == buf)
4138 mutex_unlock(&lock);
4144 EXPORT_SYMBOL_GPL(spi_write_then_read);
4146 /*-------------------------------------------------------------------------*/
4148 #if IS_ENABLED(CONFIG_OF)
4149 /* must call put_device() when done with returned spi_device device */
4150 struct spi_device *of_find_spi_device_by_node(struct device_node *node)
4152 struct device *dev = bus_find_device_by_of_node(&spi_bus_type, node);
4154 return dev ? to_spi_device(dev) : NULL;
4156 EXPORT_SYMBOL_GPL(of_find_spi_device_by_node);
4157 #endif /* IS_ENABLED(CONFIG_OF) */
4159 #if IS_ENABLED(CONFIG_OF_DYNAMIC)
4160 /* the spi controllers are not using spi_bus, so we find it with another way */
4161 static struct spi_controller *of_find_spi_controller_by_node(struct device_node *node)
4165 dev = class_find_device_by_of_node(&spi_master_class, node);
4166 if (!dev && IS_ENABLED(CONFIG_SPI_SLAVE))
4167 dev = class_find_device_by_of_node(&spi_slave_class, node);
4171 /* reference got in class_find_device */
4172 return container_of(dev, struct spi_controller, dev);
4175 static int of_spi_notify(struct notifier_block *nb, unsigned long action,
4178 struct of_reconfig_data *rd = arg;
4179 struct spi_controller *ctlr;
4180 struct spi_device *spi;
4182 switch (of_reconfig_get_state_change(action, arg)) {
4183 case OF_RECONFIG_CHANGE_ADD:
4184 ctlr = of_find_spi_controller_by_node(rd->dn->parent);
4186 return NOTIFY_OK; /* not for us */
4188 if (of_node_test_and_set_flag(rd->dn, OF_POPULATED)) {
4189 put_device(&ctlr->dev);
4193 spi = of_register_spi_device(ctlr, rd->dn);
4194 put_device(&ctlr->dev);
4197 pr_err("%s: failed to create for '%pOF'\n",
4199 of_node_clear_flag(rd->dn, OF_POPULATED);
4200 return notifier_from_errno(PTR_ERR(spi));
4204 case OF_RECONFIG_CHANGE_REMOVE:
4205 /* already depopulated? */
4206 if (!of_node_check_flag(rd->dn, OF_POPULATED))
4209 /* find our device by node */
4210 spi = of_find_spi_device_by_node(rd->dn);
4212 return NOTIFY_OK; /* no? not meant for us */
4214 /* unregister takes one ref away */
4215 spi_unregister_device(spi);
4217 /* and put the reference of the find */
4218 put_device(&spi->dev);
4225 static struct notifier_block spi_of_notifier = {
4226 .notifier_call = of_spi_notify,
4228 #else /* IS_ENABLED(CONFIG_OF_DYNAMIC) */
4229 extern struct notifier_block spi_of_notifier;
4230 #endif /* IS_ENABLED(CONFIG_OF_DYNAMIC) */
4232 #if IS_ENABLED(CONFIG_ACPI)
4233 static int spi_acpi_controller_match(struct device *dev, const void *data)
4235 return ACPI_COMPANION(dev->parent) == data;
4238 static struct spi_controller *acpi_spi_find_controller_by_adev(struct acpi_device *adev)
4242 dev = class_find_device(&spi_master_class, NULL, adev,
4243 spi_acpi_controller_match);
4244 if (!dev && IS_ENABLED(CONFIG_SPI_SLAVE))
4245 dev = class_find_device(&spi_slave_class, NULL, adev,
4246 spi_acpi_controller_match);
4250 return container_of(dev, struct spi_controller, dev);
4253 static struct spi_device *acpi_spi_find_device_by_adev(struct acpi_device *adev)
4257 dev = bus_find_device_by_acpi_dev(&spi_bus_type, adev);
4258 return to_spi_device(dev);
4261 static int acpi_spi_notify(struct notifier_block *nb, unsigned long value,
4264 struct acpi_device *adev = arg;
4265 struct spi_controller *ctlr;
4266 struct spi_device *spi;
4269 case ACPI_RECONFIG_DEVICE_ADD:
4270 ctlr = acpi_spi_find_controller_by_adev(adev->parent);
4274 acpi_register_spi_device(ctlr, adev);
4275 put_device(&ctlr->dev);
4277 case ACPI_RECONFIG_DEVICE_REMOVE:
4278 if (!acpi_device_enumerated(adev))
4281 spi = acpi_spi_find_device_by_adev(adev);
4285 spi_unregister_device(spi);
4286 put_device(&spi->dev);
4293 static struct notifier_block spi_acpi_notifier = {
4294 .notifier_call = acpi_spi_notify,
4297 extern struct notifier_block spi_acpi_notifier;
4300 static int __init spi_init(void)
4304 buf = kmalloc(SPI_BUFSIZ, GFP_KERNEL);
4310 status = bus_register(&spi_bus_type);
4314 status = class_register(&spi_master_class);
4318 if (IS_ENABLED(CONFIG_SPI_SLAVE)) {
4319 status = class_register(&spi_slave_class);
4324 if (IS_ENABLED(CONFIG_OF_DYNAMIC))
4325 WARN_ON(of_reconfig_notifier_register(&spi_of_notifier));
4326 if (IS_ENABLED(CONFIG_ACPI))
4327 WARN_ON(acpi_reconfig_notifier_register(&spi_acpi_notifier));
4332 class_unregister(&spi_master_class);
4334 bus_unregister(&spi_bus_type);
4342 /* board_info is normally registered in arch_initcall(),
4343 * but even essential drivers wait till later
4345 * REVISIT only boardinfo really needs static linking. the rest (device and
4346 * driver registration) _could_ be dynamically linked (modular) ... costs
4347 * include needing to have boardinfo data structures be much more public.
4349 postcore_initcall(spi_init);