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 controllers may cleanup for released devices */
51 if (spi->controller->cleanup)
52 spi->controller->cleanup(spi);
54 spi_controller_put(spi->controller);
55 kfree(spi->driver_override);
60 modalias_show(struct device *dev, struct device_attribute *a, char *buf)
62 const struct spi_device *spi = to_spi_device(dev);
65 len = acpi_device_modalias(dev, buf, PAGE_SIZE - 1);
69 return sprintf(buf, "%s%s\n", SPI_MODULE_PREFIX, spi->modalias);
71 static DEVICE_ATTR_RO(modalias);
73 static ssize_t driver_override_store(struct device *dev,
74 struct device_attribute *a,
75 const char *buf, size_t count)
77 struct spi_device *spi = to_spi_device(dev);
78 const char *end = memchr(buf, '\n', count);
79 const size_t len = end ? end - buf : count;
80 const char *driver_override, *old;
82 /* We need to keep extra room for a newline when displaying value */
83 if (len >= (PAGE_SIZE - 1))
86 driver_override = kstrndup(buf, len, GFP_KERNEL);
91 old = spi->driver_override;
93 spi->driver_override = driver_override;
95 /* Emptry string, disable driver override */
96 spi->driver_override = NULL;
97 kfree(driver_override);
105 static ssize_t driver_override_show(struct device *dev,
106 struct device_attribute *a, char *buf)
108 const struct spi_device *spi = to_spi_device(dev);
112 len = snprintf(buf, PAGE_SIZE, "%s\n", spi->driver_override ? : "");
116 static DEVICE_ATTR_RW(driver_override);
118 #define SPI_STATISTICS_ATTRS(field, file) \
119 static ssize_t spi_controller_##field##_show(struct device *dev, \
120 struct device_attribute *attr, \
123 struct spi_controller *ctlr = container_of(dev, \
124 struct spi_controller, dev); \
125 return spi_statistics_##field##_show(&ctlr->statistics, buf); \
127 static struct device_attribute dev_attr_spi_controller_##field = { \
128 .attr = { .name = file, .mode = 0444 }, \
129 .show = spi_controller_##field##_show, \
131 static ssize_t spi_device_##field##_show(struct device *dev, \
132 struct device_attribute *attr, \
135 struct spi_device *spi = to_spi_device(dev); \
136 return spi_statistics_##field##_show(&spi->statistics, buf); \
138 static struct device_attribute dev_attr_spi_device_##field = { \
139 .attr = { .name = file, .mode = 0444 }, \
140 .show = spi_device_##field##_show, \
143 #define SPI_STATISTICS_SHOW_NAME(name, file, field, format_string) \
144 static ssize_t spi_statistics_##name##_show(struct spi_statistics *stat, \
147 unsigned long flags; \
149 spin_lock_irqsave(&stat->lock, flags); \
150 len = sprintf(buf, format_string, stat->field); \
151 spin_unlock_irqrestore(&stat->lock, flags); \
154 SPI_STATISTICS_ATTRS(name, file)
156 #define SPI_STATISTICS_SHOW(field, format_string) \
157 SPI_STATISTICS_SHOW_NAME(field, __stringify(field), \
158 field, format_string)
160 SPI_STATISTICS_SHOW(messages, "%lu");
161 SPI_STATISTICS_SHOW(transfers, "%lu");
162 SPI_STATISTICS_SHOW(errors, "%lu");
163 SPI_STATISTICS_SHOW(timedout, "%lu");
165 SPI_STATISTICS_SHOW(spi_sync, "%lu");
166 SPI_STATISTICS_SHOW(spi_sync_immediate, "%lu");
167 SPI_STATISTICS_SHOW(spi_async, "%lu");
169 SPI_STATISTICS_SHOW(bytes, "%llu");
170 SPI_STATISTICS_SHOW(bytes_rx, "%llu");
171 SPI_STATISTICS_SHOW(bytes_tx, "%llu");
173 #define SPI_STATISTICS_TRANSFER_BYTES_HISTO(index, number) \
174 SPI_STATISTICS_SHOW_NAME(transfer_bytes_histo##index, \
175 "transfer_bytes_histo_" number, \
176 transfer_bytes_histo[index], "%lu")
177 SPI_STATISTICS_TRANSFER_BYTES_HISTO(0, "0-1");
178 SPI_STATISTICS_TRANSFER_BYTES_HISTO(1, "2-3");
179 SPI_STATISTICS_TRANSFER_BYTES_HISTO(2, "4-7");
180 SPI_STATISTICS_TRANSFER_BYTES_HISTO(3, "8-15");
181 SPI_STATISTICS_TRANSFER_BYTES_HISTO(4, "16-31");
182 SPI_STATISTICS_TRANSFER_BYTES_HISTO(5, "32-63");
183 SPI_STATISTICS_TRANSFER_BYTES_HISTO(6, "64-127");
184 SPI_STATISTICS_TRANSFER_BYTES_HISTO(7, "128-255");
185 SPI_STATISTICS_TRANSFER_BYTES_HISTO(8, "256-511");
186 SPI_STATISTICS_TRANSFER_BYTES_HISTO(9, "512-1023");
187 SPI_STATISTICS_TRANSFER_BYTES_HISTO(10, "1024-2047");
188 SPI_STATISTICS_TRANSFER_BYTES_HISTO(11, "2048-4095");
189 SPI_STATISTICS_TRANSFER_BYTES_HISTO(12, "4096-8191");
190 SPI_STATISTICS_TRANSFER_BYTES_HISTO(13, "8192-16383");
191 SPI_STATISTICS_TRANSFER_BYTES_HISTO(14, "16384-32767");
192 SPI_STATISTICS_TRANSFER_BYTES_HISTO(15, "32768-65535");
193 SPI_STATISTICS_TRANSFER_BYTES_HISTO(16, "65536+");
195 SPI_STATISTICS_SHOW(transfers_split_maxsize, "%lu");
197 static struct attribute *spi_dev_attrs[] = {
198 &dev_attr_modalias.attr,
199 &dev_attr_driver_override.attr,
203 static const struct attribute_group spi_dev_group = {
204 .attrs = spi_dev_attrs,
207 static struct attribute *spi_device_statistics_attrs[] = {
208 &dev_attr_spi_device_messages.attr,
209 &dev_attr_spi_device_transfers.attr,
210 &dev_attr_spi_device_errors.attr,
211 &dev_attr_spi_device_timedout.attr,
212 &dev_attr_spi_device_spi_sync.attr,
213 &dev_attr_spi_device_spi_sync_immediate.attr,
214 &dev_attr_spi_device_spi_async.attr,
215 &dev_attr_spi_device_bytes.attr,
216 &dev_attr_spi_device_bytes_rx.attr,
217 &dev_attr_spi_device_bytes_tx.attr,
218 &dev_attr_spi_device_transfer_bytes_histo0.attr,
219 &dev_attr_spi_device_transfer_bytes_histo1.attr,
220 &dev_attr_spi_device_transfer_bytes_histo2.attr,
221 &dev_attr_spi_device_transfer_bytes_histo3.attr,
222 &dev_attr_spi_device_transfer_bytes_histo4.attr,
223 &dev_attr_spi_device_transfer_bytes_histo5.attr,
224 &dev_attr_spi_device_transfer_bytes_histo6.attr,
225 &dev_attr_spi_device_transfer_bytes_histo7.attr,
226 &dev_attr_spi_device_transfer_bytes_histo8.attr,
227 &dev_attr_spi_device_transfer_bytes_histo9.attr,
228 &dev_attr_spi_device_transfer_bytes_histo10.attr,
229 &dev_attr_spi_device_transfer_bytes_histo11.attr,
230 &dev_attr_spi_device_transfer_bytes_histo12.attr,
231 &dev_attr_spi_device_transfer_bytes_histo13.attr,
232 &dev_attr_spi_device_transfer_bytes_histo14.attr,
233 &dev_attr_spi_device_transfer_bytes_histo15.attr,
234 &dev_attr_spi_device_transfer_bytes_histo16.attr,
235 &dev_attr_spi_device_transfers_split_maxsize.attr,
239 static const struct attribute_group spi_device_statistics_group = {
240 .name = "statistics",
241 .attrs = spi_device_statistics_attrs,
244 static const struct attribute_group *spi_dev_groups[] = {
246 &spi_device_statistics_group,
250 static struct attribute *spi_controller_statistics_attrs[] = {
251 &dev_attr_spi_controller_messages.attr,
252 &dev_attr_spi_controller_transfers.attr,
253 &dev_attr_spi_controller_errors.attr,
254 &dev_attr_spi_controller_timedout.attr,
255 &dev_attr_spi_controller_spi_sync.attr,
256 &dev_attr_spi_controller_spi_sync_immediate.attr,
257 &dev_attr_spi_controller_spi_async.attr,
258 &dev_attr_spi_controller_bytes.attr,
259 &dev_attr_spi_controller_bytes_rx.attr,
260 &dev_attr_spi_controller_bytes_tx.attr,
261 &dev_attr_spi_controller_transfer_bytes_histo0.attr,
262 &dev_attr_spi_controller_transfer_bytes_histo1.attr,
263 &dev_attr_spi_controller_transfer_bytes_histo2.attr,
264 &dev_attr_spi_controller_transfer_bytes_histo3.attr,
265 &dev_attr_spi_controller_transfer_bytes_histo4.attr,
266 &dev_attr_spi_controller_transfer_bytes_histo5.attr,
267 &dev_attr_spi_controller_transfer_bytes_histo6.attr,
268 &dev_attr_spi_controller_transfer_bytes_histo7.attr,
269 &dev_attr_spi_controller_transfer_bytes_histo8.attr,
270 &dev_attr_spi_controller_transfer_bytes_histo9.attr,
271 &dev_attr_spi_controller_transfer_bytes_histo10.attr,
272 &dev_attr_spi_controller_transfer_bytes_histo11.attr,
273 &dev_attr_spi_controller_transfer_bytes_histo12.attr,
274 &dev_attr_spi_controller_transfer_bytes_histo13.attr,
275 &dev_attr_spi_controller_transfer_bytes_histo14.attr,
276 &dev_attr_spi_controller_transfer_bytes_histo15.attr,
277 &dev_attr_spi_controller_transfer_bytes_histo16.attr,
278 &dev_attr_spi_controller_transfers_split_maxsize.attr,
282 static const struct attribute_group spi_controller_statistics_group = {
283 .name = "statistics",
284 .attrs = spi_controller_statistics_attrs,
287 static const struct attribute_group *spi_master_groups[] = {
288 &spi_controller_statistics_group,
292 void spi_statistics_add_transfer_stats(struct spi_statistics *stats,
293 struct spi_transfer *xfer,
294 struct spi_controller *ctlr)
297 int l2len = min(fls(xfer->len), SPI_STATISTICS_HISTO_SIZE) - 1;
302 spin_lock_irqsave(&stats->lock, flags);
305 stats->transfer_bytes_histo[l2len]++;
307 stats->bytes += xfer->len;
308 if ((xfer->tx_buf) &&
309 (xfer->tx_buf != ctlr->dummy_tx))
310 stats->bytes_tx += xfer->len;
311 if ((xfer->rx_buf) &&
312 (xfer->rx_buf != ctlr->dummy_rx))
313 stats->bytes_rx += xfer->len;
315 spin_unlock_irqrestore(&stats->lock, flags);
317 EXPORT_SYMBOL_GPL(spi_statistics_add_transfer_stats);
319 /* modalias support makes "modprobe $MODALIAS" new-style hotplug work,
320 * and the sysfs version makes coldplug work too.
323 static const struct spi_device_id *spi_match_id(const struct spi_device_id *id,
324 const struct spi_device *sdev)
326 while (id->name[0]) {
327 if (!strcmp(sdev->modalias, id->name))
334 const struct spi_device_id *spi_get_device_id(const struct spi_device *sdev)
336 const struct spi_driver *sdrv = to_spi_driver(sdev->dev.driver);
338 return spi_match_id(sdrv->id_table, sdev);
340 EXPORT_SYMBOL_GPL(spi_get_device_id);
342 static int spi_match_device(struct device *dev, struct device_driver *drv)
344 const struct spi_device *spi = to_spi_device(dev);
345 const struct spi_driver *sdrv = to_spi_driver(drv);
347 /* Check override first, and if set, only use the named driver */
348 if (spi->driver_override)
349 return strcmp(spi->driver_override, drv->name) == 0;
351 /* Attempt an OF style match */
352 if (of_driver_match_device(dev, drv))
356 if (acpi_driver_match_device(dev, drv))
360 return !!spi_match_id(sdrv->id_table, spi);
362 return strcmp(spi->modalias, drv->name) == 0;
365 static int spi_uevent(struct device *dev, struct kobj_uevent_env *env)
367 const struct spi_device *spi = to_spi_device(dev);
370 rc = acpi_device_uevent_modalias(dev, env);
374 return add_uevent_var(env, "MODALIAS=%s%s", SPI_MODULE_PREFIX, spi->modalias);
377 struct bus_type spi_bus_type = {
379 .dev_groups = spi_dev_groups,
380 .match = spi_match_device,
381 .uevent = spi_uevent,
383 EXPORT_SYMBOL_GPL(spi_bus_type);
386 static int spi_drv_probe(struct device *dev)
388 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
389 struct spi_device *spi = to_spi_device(dev);
392 ret = of_clk_set_defaults(dev->of_node, false);
397 spi->irq = of_irq_get(dev->of_node, 0);
398 if (spi->irq == -EPROBE_DEFER)
399 return -EPROBE_DEFER;
404 ret = dev_pm_domain_attach(dev, true);
408 ret = sdrv->probe(spi);
410 dev_pm_domain_detach(dev, true);
415 static int spi_drv_remove(struct device *dev)
417 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
420 ret = sdrv->remove(to_spi_device(dev));
421 dev_pm_domain_detach(dev, true);
426 static void spi_drv_shutdown(struct device *dev)
428 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
430 sdrv->shutdown(to_spi_device(dev));
434 * __spi_register_driver - register a SPI driver
435 * @owner: owner module of the driver to register
436 * @sdrv: the driver to register
439 * Return: zero on success, else a negative error code.
441 int __spi_register_driver(struct module *owner, struct spi_driver *sdrv)
443 sdrv->driver.owner = owner;
444 sdrv->driver.bus = &spi_bus_type;
446 sdrv->driver.probe = spi_drv_probe;
448 sdrv->driver.remove = spi_drv_remove;
450 sdrv->driver.shutdown = spi_drv_shutdown;
451 return driver_register(&sdrv->driver);
453 EXPORT_SYMBOL_GPL(__spi_register_driver);
455 /*-------------------------------------------------------------------------*/
457 /* SPI devices should normally not be created by SPI device drivers; that
458 * would make them board-specific. Similarly with SPI controller drivers.
459 * Device registration normally goes into like arch/.../mach.../board-YYY.c
460 * with other readonly (flashable) information about mainboard devices.
464 struct list_head list;
465 struct spi_board_info board_info;
468 static LIST_HEAD(board_list);
469 static LIST_HEAD(spi_controller_list);
472 * Used to protect add/del opertion for board_info list and
473 * spi_controller list, and their matching process
474 * also used to protect object of type struct idr
476 static DEFINE_MUTEX(board_lock);
479 * spi_alloc_device - Allocate a new SPI device
480 * @ctlr: Controller to which device is connected
483 * Allows a driver to allocate and initialize a spi_device without
484 * registering it immediately. This allows a driver to directly
485 * fill the spi_device with device parameters before calling
486 * spi_add_device() on it.
488 * Caller is responsible to call spi_add_device() on the returned
489 * spi_device structure to add it to the SPI controller. If the caller
490 * needs to discard the spi_device without adding it, then it should
491 * call spi_dev_put() on it.
493 * Return: a pointer to the new device, or NULL.
495 struct spi_device *spi_alloc_device(struct spi_controller *ctlr)
497 struct spi_device *spi;
499 if (!spi_controller_get(ctlr))
502 spi = kzalloc(sizeof(*spi), GFP_KERNEL);
504 spi_controller_put(ctlr);
508 spi->master = spi->controller = ctlr;
509 spi->dev.parent = &ctlr->dev;
510 spi->dev.bus = &spi_bus_type;
511 spi->dev.release = spidev_release;
512 spi->cs_gpio = -ENOENT;
514 spin_lock_init(&spi->statistics.lock);
516 device_initialize(&spi->dev);
519 EXPORT_SYMBOL_GPL(spi_alloc_device);
521 static void spi_dev_set_name(struct spi_device *spi)
523 struct acpi_device *adev = ACPI_COMPANION(&spi->dev);
526 dev_set_name(&spi->dev, "spi-%s", acpi_dev_name(adev));
530 dev_set_name(&spi->dev, "%s.%u", dev_name(&spi->controller->dev),
534 static int spi_dev_check(struct device *dev, void *data)
536 struct spi_device *spi = to_spi_device(dev);
537 struct spi_device *new_spi = data;
539 if (spi->controller == new_spi->controller &&
540 spi->chip_select == new_spi->chip_select)
546 * spi_add_device - Add spi_device allocated with spi_alloc_device
547 * @spi: spi_device to register
549 * Companion function to spi_alloc_device. Devices allocated with
550 * spi_alloc_device can be added onto the spi bus with this function.
552 * Return: 0 on success; negative errno on failure
554 int spi_add_device(struct spi_device *spi)
556 static DEFINE_MUTEX(spi_add_lock);
557 struct spi_controller *ctlr = spi->controller;
558 struct device *dev = ctlr->dev.parent;
561 /* Chipselects are numbered 0..max; validate. */
562 if (spi->chip_select >= ctlr->num_chipselect) {
563 dev_err(dev, "cs%d >= max %d\n", spi->chip_select,
564 ctlr->num_chipselect);
568 /* Set the bus ID string */
569 spi_dev_set_name(spi);
571 /* We need to make sure there's no other device with this
572 * chipselect **BEFORE** we call setup(), else we'll trash
573 * its configuration. Lock against concurrent add() calls.
575 mutex_lock(&spi_add_lock);
577 status = bus_for_each_dev(&spi_bus_type, NULL, spi, spi_dev_check);
579 dev_err(dev, "chipselect %d already in use\n",
584 /* Descriptors take precedence */
586 spi->cs_gpiod = ctlr->cs_gpiods[spi->chip_select];
587 else if (ctlr->cs_gpios)
588 spi->cs_gpio = ctlr->cs_gpios[spi->chip_select];
590 /* Drivers may modify this initial i/o setup, but will
591 * normally rely on the device being setup. Devices
592 * using SPI_CS_HIGH can't coexist well otherwise...
594 status = spi_setup(spi);
596 dev_err(dev, "can't setup %s, status %d\n",
597 dev_name(&spi->dev), status);
601 /* Device may be bound to an active driver when this returns */
602 status = device_add(&spi->dev);
604 dev_err(dev, "can't add %s, status %d\n",
605 dev_name(&spi->dev), status);
607 dev_dbg(dev, "registered child %s\n", dev_name(&spi->dev));
610 mutex_unlock(&spi_add_lock);
613 EXPORT_SYMBOL_GPL(spi_add_device);
616 * spi_new_device - instantiate one new SPI device
617 * @ctlr: Controller to which device is connected
618 * @chip: Describes the SPI device
621 * On typical mainboards, this is purely internal; and it's not needed
622 * after board init creates the hard-wired devices. Some development
623 * platforms may not be able to use spi_register_board_info though, and
624 * this is exported so that for example a USB or parport based adapter
625 * driver could add devices (which it would learn about out-of-band).
627 * Return: the new device, or NULL.
629 struct spi_device *spi_new_device(struct spi_controller *ctlr,
630 struct spi_board_info *chip)
632 struct spi_device *proxy;
635 /* NOTE: caller did any chip->bus_num checks necessary.
637 * Also, unless we change the return value convention to use
638 * error-or-pointer (not NULL-or-pointer), troubleshootability
639 * suggests syslogged diagnostics are best here (ugh).
642 proxy = spi_alloc_device(ctlr);
646 WARN_ON(strlen(chip->modalias) >= sizeof(proxy->modalias));
648 proxy->chip_select = chip->chip_select;
649 proxy->max_speed_hz = chip->max_speed_hz;
650 proxy->mode = chip->mode;
651 proxy->irq = chip->irq;
652 strlcpy(proxy->modalias, chip->modalias, sizeof(proxy->modalias));
653 proxy->dev.platform_data = (void *) chip->platform_data;
654 proxy->controller_data = chip->controller_data;
655 proxy->controller_state = NULL;
657 if (chip->properties) {
658 status = device_add_properties(&proxy->dev, chip->properties);
661 "failed to add properties to '%s': %d\n",
662 chip->modalias, status);
667 status = spi_add_device(proxy);
669 goto err_remove_props;
674 if (chip->properties)
675 device_remove_properties(&proxy->dev);
680 EXPORT_SYMBOL_GPL(spi_new_device);
683 * spi_unregister_device - unregister a single SPI device
684 * @spi: spi_device to unregister
686 * Start making the passed SPI device vanish. Normally this would be handled
687 * by spi_unregister_controller().
689 void spi_unregister_device(struct spi_device *spi)
694 if (spi->dev.of_node) {
695 of_node_clear_flag(spi->dev.of_node, OF_POPULATED);
696 of_node_put(spi->dev.of_node);
698 if (ACPI_COMPANION(&spi->dev))
699 acpi_device_clear_enumerated(ACPI_COMPANION(&spi->dev));
700 device_unregister(&spi->dev);
702 EXPORT_SYMBOL_GPL(spi_unregister_device);
704 static void spi_match_controller_to_boardinfo(struct spi_controller *ctlr,
705 struct spi_board_info *bi)
707 struct spi_device *dev;
709 if (ctlr->bus_num != bi->bus_num)
712 dev = spi_new_device(ctlr, bi);
714 dev_err(ctlr->dev.parent, "can't create new device for %s\n",
719 * spi_register_board_info - register SPI devices for a given board
720 * @info: array of chip descriptors
721 * @n: how many descriptors are provided
724 * Board-specific early init code calls this (probably during arch_initcall)
725 * with segments of the SPI device table. Any device nodes are created later,
726 * after the relevant parent SPI controller (bus_num) is defined. We keep
727 * this table of devices forever, so that reloading a controller driver will
728 * not make Linux forget about these hard-wired devices.
730 * Other code can also call this, e.g. a particular add-on board might provide
731 * SPI devices through its expansion connector, so code initializing that board
732 * would naturally declare its SPI devices.
734 * The board info passed can safely be __initdata ... but be careful of
735 * any embedded pointers (platform_data, etc), they're copied as-is.
736 * Device properties are deep-copied though.
738 * Return: zero on success, else a negative error code.
740 int spi_register_board_info(struct spi_board_info const *info, unsigned n)
742 struct boardinfo *bi;
748 bi = kcalloc(n, sizeof(*bi), GFP_KERNEL);
752 for (i = 0; i < n; i++, bi++, info++) {
753 struct spi_controller *ctlr;
755 memcpy(&bi->board_info, info, sizeof(*info));
756 if (info->properties) {
757 bi->board_info.properties =
758 property_entries_dup(info->properties);
759 if (IS_ERR(bi->board_info.properties))
760 return PTR_ERR(bi->board_info.properties);
763 mutex_lock(&board_lock);
764 list_add_tail(&bi->list, &board_list);
765 list_for_each_entry(ctlr, &spi_controller_list, list)
766 spi_match_controller_to_boardinfo(ctlr,
768 mutex_unlock(&board_lock);
774 /*-------------------------------------------------------------------------*/
776 static void spi_set_cs(struct spi_device *spi, bool enable)
778 if (spi->mode & SPI_CS_HIGH)
781 if (spi->cs_gpiod || gpio_is_valid(spi->cs_gpio)) {
783 * Honour the SPI_NO_CS flag and invert the enable line, as
784 * active low is default for SPI. Execution paths that handle
785 * polarity inversion in gpiolib (such as device tree) will
786 * enforce active high using the SPI_CS_HIGH resulting in a
787 * double inversion through the code above.
789 if (!(spi->mode & SPI_NO_CS)) {
791 gpiod_set_value_cansleep(spi->cs_gpiod,
794 gpio_set_value_cansleep(spi->cs_gpio, !enable);
796 /* Some SPI masters need both GPIO CS & slave_select */
797 if ((spi->controller->flags & SPI_MASTER_GPIO_SS) &&
798 spi->controller->set_cs)
799 spi->controller->set_cs(spi, !enable);
800 } else if (spi->controller->set_cs) {
801 spi->controller->set_cs(spi, !enable);
805 #ifdef CONFIG_HAS_DMA
806 int spi_map_buf(struct spi_controller *ctlr, struct device *dev,
807 struct sg_table *sgt, void *buf, size_t len,
808 enum dma_data_direction dir)
810 const bool vmalloced_buf = is_vmalloc_addr(buf);
811 unsigned int max_seg_size = dma_get_max_seg_size(dev);
812 #ifdef CONFIG_HIGHMEM
813 const bool kmap_buf = ((unsigned long)buf >= PKMAP_BASE &&
814 (unsigned long)buf < (PKMAP_BASE +
815 (LAST_PKMAP * PAGE_SIZE)));
817 const bool kmap_buf = false;
821 struct page *vm_page;
822 struct scatterlist *sg;
827 if (vmalloced_buf || kmap_buf) {
828 desc_len = min_t(int, max_seg_size, PAGE_SIZE);
829 sgs = DIV_ROUND_UP(len + offset_in_page(buf), desc_len);
830 } else if (virt_addr_valid(buf)) {
831 desc_len = min_t(int, max_seg_size, ctlr->max_dma_len);
832 sgs = DIV_ROUND_UP(len, desc_len);
837 ret = sg_alloc_table(sgt, sgs, GFP_KERNEL);
842 for (i = 0; i < sgs; i++) {
844 if (vmalloced_buf || kmap_buf) {
846 * Next scatterlist entry size is the minimum between
847 * the desc_len and the remaining buffer length that
850 min = min_t(size_t, desc_len,
852 PAGE_SIZE - offset_in_page(buf)));
854 vm_page = vmalloc_to_page(buf);
856 vm_page = kmap_to_page(buf);
861 sg_set_page(sg, vm_page,
862 min, offset_in_page(buf));
864 min = min_t(size_t, len, desc_len);
866 sg_set_buf(sg, sg_buf, min);
874 ret = dma_map_sg(dev, sgt->sgl, sgt->nents, dir);
887 void spi_unmap_buf(struct spi_controller *ctlr, struct device *dev,
888 struct sg_table *sgt, enum dma_data_direction dir)
890 if (sgt->orig_nents) {
891 dma_unmap_sg(dev, sgt->sgl, sgt->orig_nents, dir);
896 static int __spi_map_msg(struct spi_controller *ctlr, struct spi_message *msg)
898 struct device *tx_dev, *rx_dev;
899 struct spi_transfer *xfer;
906 tx_dev = ctlr->dma_tx->device->dev;
908 tx_dev = ctlr->dev.parent;
911 rx_dev = ctlr->dma_rx->device->dev;
913 rx_dev = ctlr->dev.parent;
915 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
916 if (!ctlr->can_dma(ctlr, msg->spi, xfer))
919 if (xfer->tx_buf != NULL) {
920 ret = spi_map_buf(ctlr, tx_dev, &xfer->tx_sg,
921 (void *)xfer->tx_buf, xfer->len,
927 if (xfer->rx_buf != NULL) {
928 ret = spi_map_buf(ctlr, rx_dev, &xfer->rx_sg,
929 xfer->rx_buf, xfer->len,
932 spi_unmap_buf(ctlr, tx_dev, &xfer->tx_sg,
939 ctlr->cur_msg_mapped = true;
944 static int __spi_unmap_msg(struct spi_controller *ctlr, struct spi_message *msg)
946 struct spi_transfer *xfer;
947 struct device *tx_dev, *rx_dev;
949 if (!ctlr->cur_msg_mapped || !ctlr->can_dma)
953 tx_dev = ctlr->dma_tx->device->dev;
955 tx_dev = ctlr->dev.parent;
958 rx_dev = ctlr->dma_rx->device->dev;
960 rx_dev = ctlr->dev.parent;
962 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
963 if (!ctlr->can_dma(ctlr, msg->spi, xfer))
966 spi_unmap_buf(ctlr, rx_dev, &xfer->rx_sg, DMA_FROM_DEVICE);
967 spi_unmap_buf(ctlr, tx_dev, &xfer->tx_sg, DMA_TO_DEVICE);
972 #else /* !CONFIG_HAS_DMA */
973 static inline int __spi_map_msg(struct spi_controller *ctlr,
974 struct spi_message *msg)
979 static inline int __spi_unmap_msg(struct spi_controller *ctlr,
980 struct spi_message *msg)
984 #endif /* !CONFIG_HAS_DMA */
986 static inline int spi_unmap_msg(struct spi_controller *ctlr,
987 struct spi_message *msg)
989 struct spi_transfer *xfer;
991 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
993 * Restore the original value of tx_buf or rx_buf if they are
996 if (xfer->tx_buf == ctlr->dummy_tx)
998 if (xfer->rx_buf == ctlr->dummy_rx)
1002 return __spi_unmap_msg(ctlr, msg);
1005 static int spi_map_msg(struct spi_controller *ctlr, struct spi_message *msg)
1007 struct spi_transfer *xfer;
1009 unsigned int max_tx, max_rx;
1011 if (ctlr->flags & (SPI_CONTROLLER_MUST_RX | SPI_CONTROLLER_MUST_TX)) {
1015 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
1016 if ((ctlr->flags & SPI_CONTROLLER_MUST_TX) &&
1018 max_tx = max(xfer->len, max_tx);
1019 if ((ctlr->flags & SPI_CONTROLLER_MUST_RX) &&
1021 max_rx = max(xfer->len, max_rx);
1025 tmp = krealloc(ctlr->dummy_tx, max_tx,
1026 GFP_KERNEL | GFP_DMA);
1029 ctlr->dummy_tx = tmp;
1030 memset(tmp, 0, max_tx);
1034 tmp = krealloc(ctlr->dummy_rx, max_rx,
1035 GFP_KERNEL | GFP_DMA);
1038 ctlr->dummy_rx = tmp;
1041 if (max_tx || max_rx) {
1042 list_for_each_entry(xfer, &msg->transfers,
1047 xfer->tx_buf = ctlr->dummy_tx;
1049 xfer->rx_buf = ctlr->dummy_rx;
1054 return __spi_map_msg(ctlr, msg);
1057 static int spi_transfer_wait(struct spi_controller *ctlr,
1058 struct spi_message *msg,
1059 struct spi_transfer *xfer)
1061 struct spi_statistics *statm = &ctlr->statistics;
1062 struct spi_statistics *stats = &msg->spi->statistics;
1063 unsigned long long ms = 1;
1065 if (spi_controller_is_slave(ctlr)) {
1066 if (wait_for_completion_interruptible(&ctlr->xfer_completion)) {
1067 dev_dbg(&msg->spi->dev, "SPI transfer interrupted\n");
1071 ms = 8LL * 1000LL * xfer->len;
1072 do_div(ms, xfer->speed_hz);
1073 ms += ms + 200; /* some tolerance */
1078 ms = wait_for_completion_timeout(&ctlr->xfer_completion,
1079 msecs_to_jiffies(ms));
1082 SPI_STATISTICS_INCREMENT_FIELD(statm, timedout);
1083 SPI_STATISTICS_INCREMENT_FIELD(stats, timedout);
1084 dev_err(&msg->spi->dev,
1085 "SPI transfer timed out\n");
1093 static void _spi_transfer_delay_ns(u32 ns)
1100 u32 us = DIV_ROUND_UP(ns, 1000);
1105 usleep_range(us, us + DIV_ROUND_UP(us, 10));
1109 static void _spi_transfer_cs_change_delay(struct spi_message *msg,
1110 struct spi_transfer *xfer)
1112 u32 delay = xfer->cs_change_delay;
1113 u32 unit = xfer->cs_change_delay_unit;
1116 /* return early on "fast" mode - for everything but USECS */
1117 if (!delay && unit != SPI_DELAY_UNIT_USECS)
1121 case SPI_DELAY_UNIT_USECS:
1122 /* for compatibility use default of 10us */
1128 case SPI_DELAY_UNIT_NSECS: /* nothing to do here */
1130 case SPI_DELAY_UNIT_SCK:
1131 /* if there is no effective speed know, then approximate
1132 * by underestimating with half the requested hz
1134 hz = xfer->effective_speed_hz ?: xfer->speed_hz / 2;
1135 delay *= DIV_ROUND_UP(1000000000, hz);
1138 dev_err_once(&msg->spi->dev,
1139 "Use of unsupported delay unit %i, using default of 10us\n",
1140 xfer->cs_change_delay_unit);
1143 /* now sleep for the requested amount of time */
1144 _spi_transfer_delay_ns(delay);
1148 * spi_transfer_one_message - Default implementation of transfer_one_message()
1150 * This is a standard implementation of transfer_one_message() for
1151 * drivers which implement a transfer_one() operation. It provides
1152 * standard handling of delays and chip select management.
1154 static int spi_transfer_one_message(struct spi_controller *ctlr,
1155 struct spi_message *msg)
1157 struct spi_transfer *xfer;
1158 bool keep_cs = false;
1160 struct spi_statistics *statm = &ctlr->statistics;
1161 struct spi_statistics *stats = &msg->spi->statistics;
1163 spi_set_cs(msg->spi, true);
1165 SPI_STATISTICS_INCREMENT_FIELD(statm, messages);
1166 SPI_STATISTICS_INCREMENT_FIELD(stats, messages);
1168 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
1169 trace_spi_transfer_start(msg, xfer);
1171 spi_statistics_add_transfer_stats(statm, xfer, ctlr);
1172 spi_statistics_add_transfer_stats(stats, xfer, ctlr);
1174 if (xfer->tx_buf || xfer->rx_buf) {
1175 reinit_completion(&ctlr->xfer_completion);
1177 ret = ctlr->transfer_one(ctlr, msg->spi, xfer);
1179 SPI_STATISTICS_INCREMENT_FIELD(statm,
1181 SPI_STATISTICS_INCREMENT_FIELD(stats,
1183 dev_err(&msg->spi->dev,
1184 "SPI transfer failed: %d\n", ret);
1189 ret = spi_transfer_wait(ctlr, msg, xfer);
1195 dev_err(&msg->spi->dev,
1196 "Bufferless transfer has length %u\n",
1200 trace_spi_transfer_stop(msg, xfer);
1202 if (msg->status != -EINPROGRESS)
1205 if (xfer->delay_usecs)
1206 _spi_transfer_delay_ns(xfer->delay_usecs * 1000);
1208 if (xfer->cs_change) {
1209 if (list_is_last(&xfer->transfer_list,
1213 spi_set_cs(msg->spi, false);
1214 _spi_transfer_cs_change_delay(msg, xfer);
1215 spi_set_cs(msg->spi, true);
1219 msg->actual_length += xfer->len;
1223 if (ret != 0 || !keep_cs)
1224 spi_set_cs(msg->spi, false);
1226 if (msg->status == -EINPROGRESS)
1229 if (msg->status && ctlr->handle_err)
1230 ctlr->handle_err(ctlr, msg);
1232 spi_res_release(ctlr, msg);
1234 spi_finalize_current_message(ctlr);
1240 * spi_finalize_current_transfer - report completion of a transfer
1241 * @ctlr: the controller reporting completion
1243 * Called by SPI drivers using the core transfer_one_message()
1244 * implementation to notify it that the current interrupt driven
1245 * transfer has finished and the next one may be scheduled.
1247 void spi_finalize_current_transfer(struct spi_controller *ctlr)
1249 complete(&ctlr->xfer_completion);
1251 EXPORT_SYMBOL_GPL(spi_finalize_current_transfer);
1254 * __spi_pump_messages - function which processes spi message queue
1255 * @ctlr: controller to process queue for
1256 * @in_kthread: true if we are in the context of the message pump thread
1258 * This function checks if there is any spi message in the queue that
1259 * needs processing and if so call out to the driver to initialize hardware
1260 * and transfer each message.
1262 * Note that it is called both from the kthread itself and also from
1263 * inside spi_sync(); the queue extraction handling at the top of the
1264 * function should deal with this safely.
1266 static void __spi_pump_messages(struct spi_controller *ctlr, bool in_kthread)
1268 struct spi_message *msg;
1269 bool was_busy = false;
1270 unsigned long flags;
1274 spin_lock_irqsave(&ctlr->queue_lock, flags);
1276 /* Make sure we are not already running a message */
1277 if (ctlr->cur_msg) {
1278 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1282 /* If another context is idling the device then defer */
1284 kthread_queue_work(&ctlr->kworker, &ctlr->pump_messages);
1285 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1289 /* Check if the queue is idle */
1290 if (list_empty(&ctlr->queue) || !ctlr->running) {
1292 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1296 /* Only do teardown in the thread */
1298 kthread_queue_work(&ctlr->kworker,
1299 &ctlr->pump_messages);
1300 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1305 ctlr->idling = true;
1306 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1308 kfree(ctlr->dummy_rx);
1309 ctlr->dummy_rx = NULL;
1310 kfree(ctlr->dummy_tx);
1311 ctlr->dummy_tx = NULL;
1312 if (ctlr->unprepare_transfer_hardware &&
1313 ctlr->unprepare_transfer_hardware(ctlr))
1315 "failed to unprepare transfer hardware\n");
1316 if (ctlr->auto_runtime_pm) {
1317 pm_runtime_mark_last_busy(ctlr->dev.parent);
1318 pm_runtime_put_autosuspend(ctlr->dev.parent);
1320 trace_spi_controller_idle(ctlr);
1322 spin_lock_irqsave(&ctlr->queue_lock, flags);
1323 ctlr->idling = false;
1324 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1328 /* Extract head of queue */
1329 msg = list_first_entry(&ctlr->queue, struct spi_message, queue);
1330 ctlr->cur_msg = msg;
1332 list_del_init(&msg->queue);
1337 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1339 mutex_lock(&ctlr->io_mutex);
1341 if (!was_busy && ctlr->auto_runtime_pm) {
1342 ret = pm_runtime_get_sync(ctlr->dev.parent);
1344 pm_runtime_put_noidle(ctlr->dev.parent);
1345 dev_err(&ctlr->dev, "Failed to power device: %d\n",
1347 mutex_unlock(&ctlr->io_mutex);
1353 trace_spi_controller_busy(ctlr);
1355 if (!was_busy && ctlr->prepare_transfer_hardware) {
1356 ret = ctlr->prepare_transfer_hardware(ctlr);
1359 "failed to prepare transfer hardware: %d\n",
1362 if (ctlr->auto_runtime_pm)
1363 pm_runtime_put(ctlr->dev.parent);
1366 spi_finalize_current_message(ctlr);
1368 mutex_unlock(&ctlr->io_mutex);
1373 trace_spi_message_start(msg);
1375 if (ctlr->prepare_message) {
1376 ret = ctlr->prepare_message(ctlr, msg);
1378 dev_err(&ctlr->dev, "failed to prepare message: %d\n",
1381 spi_finalize_current_message(ctlr);
1384 ctlr->cur_msg_prepared = true;
1387 ret = spi_map_msg(ctlr, msg);
1390 spi_finalize_current_message(ctlr);
1394 ret = ctlr->transfer_one_message(ctlr, msg);
1397 "failed to transfer one message from queue\n");
1402 mutex_unlock(&ctlr->io_mutex);
1404 /* Prod the scheduler in case transfer_one() was busy waiting */
1410 * spi_pump_messages - kthread work function which processes spi message queue
1411 * @work: pointer to kthread work struct contained in the controller struct
1413 static void spi_pump_messages(struct kthread_work *work)
1415 struct spi_controller *ctlr =
1416 container_of(work, struct spi_controller, pump_messages);
1418 __spi_pump_messages(ctlr, true);
1422 * spi_set_thread_rt - set the controller to pump at realtime priority
1423 * @ctlr: controller to boost priority of
1425 * This can be called because the controller requested realtime priority
1426 * (by setting the ->rt value before calling spi_register_controller()) or
1427 * because a device on the bus said that its transfers needed realtime
1430 * NOTE: at the moment if any device on a bus says it needs realtime then
1431 * the thread will be at realtime priority for all transfers on that
1432 * controller. If this eventually becomes a problem we may see if we can
1433 * find a way to boost the priority only temporarily during relevant
1436 static void spi_set_thread_rt(struct spi_controller *ctlr)
1438 struct sched_param param = { .sched_priority = MAX_RT_PRIO / 2 };
1440 dev_info(&ctlr->dev,
1441 "will run message pump with realtime priority\n");
1442 sched_setscheduler(ctlr->kworker_task, SCHED_FIFO, ¶m);
1445 static int spi_init_queue(struct spi_controller *ctlr)
1447 ctlr->running = false;
1450 kthread_init_worker(&ctlr->kworker);
1451 ctlr->kworker_task = kthread_run(kthread_worker_fn, &ctlr->kworker,
1452 "%s", dev_name(&ctlr->dev));
1453 if (IS_ERR(ctlr->kworker_task)) {
1454 dev_err(&ctlr->dev, "failed to create message pump task\n");
1455 return PTR_ERR(ctlr->kworker_task);
1457 kthread_init_work(&ctlr->pump_messages, spi_pump_messages);
1460 * Controller config will indicate if this controller should run the
1461 * message pump with high (realtime) priority to reduce the transfer
1462 * latency on the bus by minimising the delay between a transfer
1463 * request and the scheduling of the message pump thread. Without this
1464 * setting the message pump thread will remain at default priority.
1467 spi_set_thread_rt(ctlr);
1473 * spi_get_next_queued_message() - called by driver to check for queued
1475 * @ctlr: the controller to check for queued messages
1477 * If there are more messages in the queue, the next message is returned from
1480 * Return: the next message in the queue, else NULL if the queue is empty.
1482 struct spi_message *spi_get_next_queued_message(struct spi_controller *ctlr)
1484 struct spi_message *next;
1485 unsigned long flags;
1487 /* get a pointer to the next message, if any */
1488 spin_lock_irqsave(&ctlr->queue_lock, flags);
1489 next = list_first_entry_or_null(&ctlr->queue, struct spi_message,
1491 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1495 EXPORT_SYMBOL_GPL(spi_get_next_queued_message);
1498 * spi_finalize_current_message() - the current message is complete
1499 * @ctlr: the controller to return the message to
1501 * Called by the driver to notify the core that the message in the front of the
1502 * queue is complete and can be removed from the queue.
1504 void spi_finalize_current_message(struct spi_controller *ctlr)
1506 struct spi_message *mesg;
1507 unsigned long flags;
1510 spin_lock_irqsave(&ctlr->queue_lock, flags);
1511 mesg = ctlr->cur_msg;
1512 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1514 spi_unmap_msg(ctlr, mesg);
1516 if (ctlr->cur_msg_prepared && ctlr->unprepare_message) {
1517 ret = ctlr->unprepare_message(ctlr, mesg);
1519 dev_err(&ctlr->dev, "failed to unprepare message: %d\n",
1524 spin_lock_irqsave(&ctlr->queue_lock, flags);
1525 ctlr->cur_msg = NULL;
1526 ctlr->cur_msg_prepared = false;
1527 kthread_queue_work(&ctlr->kworker, &ctlr->pump_messages);
1528 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1530 trace_spi_message_done(mesg);
1534 mesg->complete(mesg->context);
1536 EXPORT_SYMBOL_GPL(spi_finalize_current_message);
1538 static int spi_start_queue(struct spi_controller *ctlr)
1540 unsigned long flags;
1542 spin_lock_irqsave(&ctlr->queue_lock, flags);
1544 if (ctlr->running || ctlr->busy) {
1545 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1549 ctlr->running = true;
1550 ctlr->cur_msg = NULL;
1551 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1553 kthread_queue_work(&ctlr->kworker, &ctlr->pump_messages);
1558 static int spi_stop_queue(struct spi_controller *ctlr)
1560 unsigned long flags;
1561 unsigned limit = 500;
1564 spin_lock_irqsave(&ctlr->queue_lock, flags);
1567 * This is a bit lame, but is optimized for the common execution path.
1568 * A wait_queue on the ctlr->busy could be used, but then the common
1569 * execution path (pump_messages) would be required to call wake_up or
1570 * friends on every SPI message. Do this instead.
1572 while ((!list_empty(&ctlr->queue) || ctlr->busy) && limit--) {
1573 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1574 usleep_range(10000, 11000);
1575 spin_lock_irqsave(&ctlr->queue_lock, flags);
1578 if (!list_empty(&ctlr->queue) || ctlr->busy)
1581 ctlr->running = false;
1583 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1586 dev_warn(&ctlr->dev, "could not stop message queue\n");
1592 static int spi_destroy_queue(struct spi_controller *ctlr)
1596 ret = spi_stop_queue(ctlr);
1599 * kthread_flush_worker will block until all work is done.
1600 * If the reason that stop_queue timed out is that the work will never
1601 * finish, then it does no good to call flush/stop thread, so
1605 dev_err(&ctlr->dev, "problem destroying queue\n");
1609 kthread_flush_worker(&ctlr->kworker);
1610 kthread_stop(ctlr->kworker_task);
1615 static int __spi_queued_transfer(struct spi_device *spi,
1616 struct spi_message *msg,
1619 struct spi_controller *ctlr = spi->controller;
1620 unsigned long flags;
1622 spin_lock_irqsave(&ctlr->queue_lock, flags);
1624 if (!ctlr->running) {
1625 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1628 msg->actual_length = 0;
1629 msg->status = -EINPROGRESS;
1631 list_add_tail(&msg->queue, &ctlr->queue);
1632 if (!ctlr->busy && need_pump)
1633 kthread_queue_work(&ctlr->kworker, &ctlr->pump_messages);
1635 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1640 * spi_queued_transfer - transfer function for queued transfers
1641 * @spi: spi device which is requesting transfer
1642 * @msg: spi message which is to handled is queued to driver queue
1644 * Return: zero on success, else a negative error code.
1646 static int spi_queued_transfer(struct spi_device *spi, struct spi_message *msg)
1648 return __spi_queued_transfer(spi, msg, true);
1651 static int spi_controller_initialize_queue(struct spi_controller *ctlr)
1655 ctlr->transfer = spi_queued_transfer;
1656 if (!ctlr->transfer_one_message)
1657 ctlr->transfer_one_message = spi_transfer_one_message;
1659 /* Initialize and start queue */
1660 ret = spi_init_queue(ctlr);
1662 dev_err(&ctlr->dev, "problem initializing queue\n");
1663 goto err_init_queue;
1665 ctlr->queued = true;
1666 ret = spi_start_queue(ctlr);
1668 dev_err(&ctlr->dev, "problem starting queue\n");
1669 goto err_start_queue;
1675 spi_destroy_queue(ctlr);
1681 * spi_flush_queue - Send all pending messages in the queue from the callers'
1683 * @ctlr: controller to process queue for
1685 * This should be used when one wants to ensure all pending messages have been
1686 * sent before doing something. Is used by the spi-mem code to make sure SPI
1687 * memory operations do not preempt regular SPI transfers that have been queued
1688 * before the spi-mem operation.
1690 void spi_flush_queue(struct spi_controller *ctlr)
1692 if (ctlr->transfer == spi_queued_transfer)
1693 __spi_pump_messages(ctlr, false);
1696 /*-------------------------------------------------------------------------*/
1698 #if defined(CONFIG_OF)
1699 static int of_spi_parse_dt(struct spi_controller *ctlr, struct spi_device *spi,
1700 struct device_node *nc)
1705 /* Mode (clock phase/polarity/etc.) */
1706 if (of_property_read_bool(nc, "spi-cpha"))
1707 spi->mode |= SPI_CPHA;
1708 if (of_property_read_bool(nc, "spi-cpol"))
1709 spi->mode |= SPI_CPOL;
1710 if (of_property_read_bool(nc, "spi-3wire"))
1711 spi->mode |= SPI_3WIRE;
1712 if (of_property_read_bool(nc, "spi-lsb-first"))
1713 spi->mode |= SPI_LSB_FIRST;
1716 * For descriptors associated with the device, polarity inversion is
1717 * handled in the gpiolib, so all chip selects are "active high" in
1718 * the logical sense, the gpiolib will invert the line if need be.
1720 if (ctlr->use_gpio_descriptors)
1721 spi->mode |= SPI_CS_HIGH;
1722 else if (of_property_read_bool(nc, "spi-cs-high"))
1723 spi->mode |= SPI_CS_HIGH;
1725 /* Device DUAL/QUAD mode */
1726 if (!of_property_read_u32(nc, "spi-tx-bus-width", &value)) {
1731 spi->mode |= SPI_TX_DUAL;
1734 spi->mode |= SPI_TX_QUAD;
1737 spi->mode |= SPI_TX_OCTAL;
1740 dev_warn(&ctlr->dev,
1741 "spi-tx-bus-width %d not supported\n",
1747 if (!of_property_read_u32(nc, "spi-rx-bus-width", &value)) {
1752 spi->mode |= SPI_RX_DUAL;
1755 spi->mode |= SPI_RX_QUAD;
1758 spi->mode |= SPI_RX_OCTAL;
1761 dev_warn(&ctlr->dev,
1762 "spi-rx-bus-width %d not supported\n",
1768 if (spi_controller_is_slave(ctlr)) {
1769 if (!of_node_name_eq(nc, "slave")) {
1770 dev_err(&ctlr->dev, "%pOF is not called 'slave'\n",
1777 /* Device address */
1778 rc = of_property_read_u32(nc, "reg", &value);
1780 dev_err(&ctlr->dev, "%pOF has no valid 'reg' property (%d)\n",
1784 spi->chip_select = value;
1787 rc = of_property_read_u32(nc, "spi-max-frequency", &value);
1790 "%pOF has no valid 'spi-max-frequency' property (%d)\n", nc, rc);
1793 spi->max_speed_hz = value;
1798 static struct spi_device *
1799 of_register_spi_device(struct spi_controller *ctlr, struct device_node *nc)
1801 struct spi_device *spi;
1804 /* Alloc an spi_device */
1805 spi = spi_alloc_device(ctlr);
1807 dev_err(&ctlr->dev, "spi_device alloc error for %pOF\n", nc);
1812 /* Select device driver */
1813 rc = of_modalias_node(nc, spi->modalias,
1814 sizeof(spi->modalias));
1816 dev_err(&ctlr->dev, "cannot find modalias for %pOF\n", nc);
1820 rc = of_spi_parse_dt(ctlr, spi, nc);
1824 /* Store a pointer to the node in the device structure */
1826 spi->dev.of_node = nc;
1828 /* Register the new device */
1829 rc = spi_add_device(spi);
1831 dev_err(&ctlr->dev, "spi_device register error %pOF\n", nc);
1832 goto err_of_node_put;
1845 * of_register_spi_devices() - Register child devices onto the SPI bus
1846 * @ctlr: Pointer to spi_controller device
1848 * Registers an spi_device for each child node of controller node which
1849 * represents a valid SPI slave.
1851 static void of_register_spi_devices(struct spi_controller *ctlr)
1853 struct spi_device *spi;
1854 struct device_node *nc;
1856 if (!ctlr->dev.of_node)
1859 for_each_available_child_of_node(ctlr->dev.of_node, nc) {
1860 if (of_node_test_and_set_flag(nc, OF_POPULATED))
1862 spi = of_register_spi_device(ctlr, nc);
1864 dev_warn(&ctlr->dev,
1865 "Failed to create SPI device for %pOF\n", nc);
1866 of_node_clear_flag(nc, OF_POPULATED);
1871 static void of_register_spi_devices(struct spi_controller *ctlr) { }
1875 struct acpi_spi_lookup {
1876 struct spi_controller *ctlr;
1884 static void acpi_spi_parse_apple_properties(struct acpi_device *dev,
1885 struct acpi_spi_lookup *lookup)
1887 const union acpi_object *obj;
1889 if (!x86_apple_machine)
1892 if (!acpi_dev_get_property(dev, "spiSclkPeriod", ACPI_TYPE_BUFFER, &obj)
1893 && obj->buffer.length >= 4)
1894 lookup->max_speed_hz = NSEC_PER_SEC / *(u32 *)obj->buffer.pointer;
1896 if (!acpi_dev_get_property(dev, "spiWordSize", ACPI_TYPE_BUFFER, &obj)
1897 && obj->buffer.length == 8)
1898 lookup->bits_per_word = *(u64 *)obj->buffer.pointer;
1900 if (!acpi_dev_get_property(dev, "spiBitOrder", ACPI_TYPE_BUFFER, &obj)
1901 && obj->buffer.length == 8 && !*(u64 *)obj->buffer.pointer)
1902 lookup->mode |= SPI_LSB_FIRST;
1904 if (!acpi_dev_get_property(dev, "spiSPO", ACPI_TYPE_BUFFER, &obj)
1905 && obj->buffer.length == 8 && *(u64 *)obj->buffer.pointer)
1906 lookup->mode |= SPI_CPOL;
1908 if (!acpi_dev_get_property(dev, "spiSPH", ACPI_TYPE_BUFFER, &obj)
1909 && obj->buffer.length == 8 && *(u64 *)obj->buffer.pointer)
1910 lookup->mode |= SPI_CPHA;
1913 static int acpi_spi_add_resource(struct acpi_resource *ares, void *data)
1915 struct acpi_spi_lookup *lookup = data;
1916 struct spi_controller *ctlr = lookup->ctlr;
1918 if (ares->type == ACPI_RESOURCE_TYPE_SERIAL_BUS) {
1919 struct acpi_resource_spi_serialbus *sb;
1920 acpi_handle parent_handle;
1923 sb = &ares->data.spi_serial_bus;
1924 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_SPI) {
1926 status = acpi_get_handle(NULL,
1927 sb->resource_source.string_ptr,
1930 if (ACPI_FAILURE(status) ||
1931 ACPI_HANDLE(ctlr->dev.parent) != parent_handle)
1935 * ACPI DeviceSelection numbering is handled by the
1936 * host controller driver in Windows and can vary
1937 * from driver to driver. In Linux we always expect
1938 * 0 .. max - 1 so we need to ask the driver to
1939 * translate between the two schemes.
1941 if (ctlr->fw_translate_cs) {
1942 int cs = ctlr->fw_translate_cs(ctlr,
1943 sb->device_selection);
1946 lookup->chip_select = cs;
1948 lookup->chip_select = sb->device_selection;
1951 lookup->max_speed_hz = sb->connection_speed;
1953 if (sb->clock_phase == ACPI_SPI_SECOND_PHASE)
1954 lookup->mode |= SPI_CPHA;
1955 if (sb->clock_polarity == ACPI_SPI_START_HIGH)
1956 lookup->mode |= SPI_CPOL;
1957 if (sb->device_polarity == ACPI_SPI_ACTIVE_HIGH)
1958 lookup->mode |= SPI_CS_HIGH;
1960 } else if (lookup->irq < 0) {
1963 if (acpi_dev_resource_interrupt(ares, 0, &r))
1964 lookup->irq = r.start;
1967 /* Always tell the ACPI core to skip this resource */
1971 static acpi_status acpi_register_spi_device(struct spi_controller *ctlr,
1972 struct acpi_device *adev)
1974 acpi_handle parent_handle = NULL;
1975 struct list_head resource_list;
1976 struct acpi_spi_lookup lookup = {};
1977 struct spi_device *spi;
1980 if (acpi_bus_get_status(adev) || !adev->status.present ||
1981 acpi_device_enumerated(adev))
1987 INIT_LIST_HEAD(&resource_list);
1988 ret = acpi_dev_get_resources(adev, &resource_list,
1989 acpi_spi_add_resource, &lookup);
1990 acpi_dev_free_resource_list(&resource_list);
1993 /* found SPI in _CRS but it points to another controller */
1996 if (!lookup.max_speed_hz &&
1997 !ACPI_FAILURE(acpi_get_parent(adev->handle, &parent_handle)) &&
1998 ACPI_HANDLE(ctlr->dev.parent) == parent_handle) {
1999 /* Apple does not use _CRS but nested devices for SPI slaves */
2000 acpi_spi_parse_apple_properties(adev, &lookup);
2003 if (!lookup.max_speed_hz)
2006 spi = spi_alloc_device(ctlr);
2008 dev_err(&ctlr->dev, "failed to allocate SPI device for %s\n",
2009 dev_name(&adev->dev));
2010 return AE_NO_MEMORY;
2013 ACPI_COMPANION_SET(&spi->dev, adev);
2014 spi->max_speed_hz = lookup.max_speed_hz;
2015 spi->mode = lookup.mode;
2016 spi->irq = lookup.irq;
2017 spi->bits_per_word = lookup.bits_per_word;
2018 spi->chip_select = lookup.chip_select;
2020 acpi_set_modalias(adev, acpi_device_hid(adev), spi->modalias,
2021 sizeof(spi->modalias));
2024 spi->irq = acpi_dev_gpio_irq_get(adev, 0);
2026 acpi_device_set_enumerated(adev);
2028 adev->power.flags.ignore_parent = true;
2029 if (spi_add_device(spi)) {
2030 adev->power.flags.ignore_parent = false;
2031 dev_err(&ctlr->dev, "failed to add SPI device %s from ACPI\n",
2032 dev_name(&adev->dev));
2039 static acpi_status acpi_spi_add_device(acpi_handle handle, u32 level,
2040 void *data, void **return_value)
2042 struct spi_controller *ctlr = data;
2043 struct acpi_device *adev;
2045 if (acpi_bus_get_device(handle, &adev))
2048 return acpi_register_spi_device(ctlr, adev);
2051 #define SPI_ACPI_ENUMERATE_MAX_DEPTH 32
2053 static void acpi_register_spi_devices(struct spi_controller *ctlr)
2058 handle = ACPI_HANDLE(ctlr->dev.parent);
2062 status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
2063 SPI_ACPI_ENUMERATE_MAX_DEPTH,
2064 acpi_spi_add_device, NULL, ctlr, NULL);
2065 if (ACPI_FAILURE(status))
2066 dev_warn(&ctlr->dev, "failed to enumerate SPI slaves\n");
2069 static inline void acpi_register_spi_devices(struct spi_controller *ctlr) {}
2070 #endif /* CONFIG_ACPI */
2072 static void spi_controller_release(struct device *dev)
2074 struct spi_controller *ctlr;
2076 ctlr = container_of(dev, struct spi_controller, dev);
2080 static struct class spi_master_class = {
2081 .name = "spi_master",
2082 .owner = THIS_MODULE,
2083 .dev_release = spi_controller_release,
2084 .dev_groups = spi_master_groups,
2087 #ifdef CONFIG_SPI_SLAVE
2089 * spi_slave_abort - abort the ongoing transfer request on an SPI slave
2091 * @spi: device used for the current transfer
2093 int spi_slave_abort(struct spi_device *spi)
2095 struct spi_controller *ctlr = spi->controller;
2097 if (spi_controller_is_slave(ctlr) && ctlr->slave_abort)
2098 return ctlr->slave_abort(ctlr);
2102 EXPORT_SYMBOL_GPL(spi_slave_abort);
2104 static int match_true(struct device *dev, void *data)
2109 static ssize_t slave_show(struct device *dev, struct device_attribute *attr,
2112 struct spi_controller *ctlr = container_of(dev, struct spi_controller,
2114 struct device *child;
2116 child = device_find_child(&ctlr->dev, NULL, match_true);
2117 return sprintf(buf, "%s\n",
2118 child ? to_spi_device(child)->modalias : NULL);
2121 static ssize_t slave_store(struct device *dev, struct device_attribute *attr,
2122 const char *buf, size_t count)
2124 struct spi_controller *ctlr = container_of(dev, struct spi_controller,
2126 struct spi_device *spi;
2127 struct device *child;
2131 rc = sscanf(buf, "%31s", name);
2132 if (rc != 1 || !name[0])
2135 child = device_find_child(&ctlr->dev, NULL, match_true);
2137 /* Remove registered slave */
2138 device_unregister(child);
2142 if (strcmp(name, "(null)")) {
2143 /* Register new slave */
2144 spi = spi_alloc_device(ctlr);
2148 strlcpy(spi->modalias, name, sizeof(spi->modalias));
2150 rc = spi_add_device(spi);
2160 static DEVICE_ATTR_RW(slave);
2162 static struct attribute *spi_slave_attrs[] = {
2163 &dev_attr_slave.attr,
2167 static const struct attribute_group spi_slave_group = {
2168 .attrs = spi_slave_attrs,
2171 static const struct attribute_group *spi_slave_groups[] = {
2172 &spi_controller_statistics_group,
2177 static struct class spi_slave_class = {
2178 .name = "spi_slave",
2179 .owner = THIS_MODULE,
2180 .dev_release = spi_controller_release,
2181 .dev_groups = spi_slave_groups,
2184 extern struct class spi_slave_class; /* dummy */
2188 * __spi_alloc_controller - allocate an SPI master or slave controller
2189 * @dev: the controller, possibly using the platform_bus
2190 * @size: how much zeroed driver-private data to allocate; the pointer to this
2191 * memory is in the driver_data field of the returned device, accessible
2192 * with spi_controller_get_devdata(); the memory is cacheline aligned;
2193 * drivers granting DMA access to portions of their private data need to
2194 * round up @size using ALIGN(size, dma_get_cache_alignment()).
2195 * @slave: flag indicating whether to allocate an SPI master (false) or SPI
2196 * slave (true) controller
2197 * Context: can sleep
2199 * This call is used only by SPI controller drivers, which are the
2200 * only ones directly touching chip registers. It's how they allocate
2201 * an spi_controller structure, prior to calling spi_register_controller().
2203 * This must be called from context that can sleep.
2205 * The caller is responsible for assigning the bus number and initializing the
2206 * controller's methods before calling spi_register_controller(); and (after
2207 * errors adding the device) calling spi_controller_put() to prevent a memory
2210 * Return: the SPI controller structure on success, else NULL.
2212 struct spi_controller *__spi_alloc_controller(struct device *dev,
2213 unsigned int size, bool slave)
2215 struct spi_controller *ctlr;
2216 size_t ctlr_size = ALIGN(sizeof(*ctlr), dma_get_cache_alignment());
2221 ctlr = kzalloc(size + ctlr_size, GFP_KERNEL);
2225 device_initialize(&ctlr->dev);
2227 ctlr->num_chipselect = 1;
2228 ctlr->slave = slave;
2229 if (IS_ENABLED(CONFIG_SPI_SLAVE) && slave)
2230 ctlr->dev.class = &spi_slave_class;
2232 ctlr->dev.class = &spi_master_class;
2233 ctlr->dev.parent = dev;
2234 pm_suspend_ignore_children(&ctlr->dev, true);
2235 spi_controller_set_devdata(ctlr, (void *)ctlr + ctlr_size);
2239 EXPORT_SYMBOL_GPL(__spi_alloc_controller);
2242 static int of_spi_get_gpio_numbers(struct spi_controller *ctlr)
2245 struct device_node *np = ctlr->dev.of_node;
2250 nb = of_gpio_named_count(np, "cs-gpios");
2251 ctlr->num_chipselect = max_t(int, nb, ctlr->num_chipselect);
2253 /* Return error only for an incorrectly formed cs-gpios property */
2254 if (nb == 0 || nb == -ENOENT)
2259 cs = devm_kcalloc(&ctlr->dev, ctlr->num_chipselect, sizeof(int),
2261 ctlr->cs_gpios = cs;
2263 if (!ctlr->cs_gpios)
2266 for (i = 0; i < ctlr->num_chipselect; i++)
2269 for (i = 0; i < nb; i++)
2270 cs[i] = of_get_named_gpio(np, "cs-gpios", i);
2275 static int of_spi_get_gpio_numbers(struct spi_controller *ctlr)
2282 * spi_get_gpio_descs() - grab chip select GPIOs for the master
2283 * @ctlr: The SPI master to grab GPIO descriptors for
2285 static int spi_get_gpio_descs(struct spi_controller *ctlr)
2288 struct gpio_desc **cs;
2289 struct device *dev = &ctlr->dev;
2291 nb = gpiod_count(dev, "cs");
2292 ctlr->num_chipselect = max_t(int, nb, ctlr->num_chipselect);
2294 /* No GPIOs at all is fine, else return the error */
2295 if (nb == 0 || nb == -ENOENT)
2300 cs = devm_kcalloc(dev, ctlr->num_chipselect, sizeof(*cs),
2304 ctlr->cs_gpiods = cs;
2306 for (i = 0; i < nb; i++) {
2308 * Most chipselects are active low, the inverted
2309 * semantics are handled by special quirks in gpiolib,
2310 * so initializing them GPIOD_OUT_LOW here means
2311 * "unasserted", in most cases this will drive the physical
2314 cs[i] = devm_gpiod_get_index_optional(dev, "cs", i,
2317 return PTR_ERR(cs[i]);
2321 * If we find a CS GPIO, name it after the device and
2326 gpioname = devm_kasprintf(dev, GFP_KERNEL, "%s CS%d",
2330 gpiod_set_consumer_name(cs[i], gpioname);
2337 static int spi_controller_check_ops(struct spi_controller *ctlr)
2340 * The controller may implement only the high-level SPI-memory like
2341 * operations if it does not support regular SPI transfers, and this is
2343 * If ->mem_ops is NULL, we request that at least one of the
2344 * ->transfer_xxx() method be implemented.
2346 if (ctlr->mem_ops) {
2347 if (!ctlr->mem_ops->exec_op)
2349 } else if (!ctlr->transfer && !ctlr->transfer_one &&
2350 !ctlr->transfer_one_message) {
2358 * spi_register_controller - register SPI master or slave controller
2359 * @ctlr: initialized master, originally from spi_alloc_master() or
2361 * Context: can sleep
2363 * SPI controllers connect to their drivers using some non-SPI bus,
2364 * such as the platform bus. The final stage of probe() in that code
2365 * includes calling spi_register_controller() to hook up to this SPI bus glue.
2367 * SPI controllers use board specific (often SOC specific) bus numbers,
2368 * and board-specific addressing for SPI devices combines those numbers
2369 * with chip select numbers. Since SPI does not directly support dynamic
2370 * device identification, boards need configuration tables telling which
2371 * chip is at which address.
2373 * This must be called from context that can sleep. It returns zero on
2374 * success, else a negative error code (dropping the controller's refcount).
2375 * After a successful return, the caller is responsible for calling
2376 * spi_unregister_controller().
2378 * Return: zero on success, else a negative error code.
2380 int spi_register_controller(struct spi_controller *ctlr)
2382 struct device *dev = ctlr->dev.parent;
2383 struct boardinfo *bi;
2385 int id, first_dynamic;
2391 * Make sure all necessary hooks are implemented before registering
2392 * the SPI controller.
2394 status = spi_controller_check_ops(ctlr);
2398 if (ctlr->bus_num >= 0) {
2399 /* devices with a fixed bus num must check-in with the num */
2400 mutex_lock(&board_lock);
2401 id = idr_alloc(&spi_master_idr, ctlr, ctlr->bus_num,
2402 ctlr->bus_num + 1, GFP_KERNEL);
2403 mutex_unlock(&board_lock);
2404 if (WARN(id < 0, "couldn't get idr"))
2405 return id == -ENOSPC ? -EBUSY : id;
2407 } else if (ctlr->dev.of_node) {
2408 /* allocate dynamic bus number using Linux idr */
2409 id = of_alias_get_id(ctlr->dev.of_node, "spi");
2412 mutex_lock(&board_lock);
2413 id = idr_alloc(&spi_master_idr, ctlr, ctlr->bus_num,
2414 ctlr->bus_num + 1, GFP_KERNEL);
2415 mutex_unlock(&board_lock);
2416 if (WARN(id < 0, "couldn't get idr"))
2417 return id == -ENOSPC ? -EBUSY : id;
2420 if (ctlr->bus_num < 0) {
2421 first_dynamic = of_alias_get_highest_id("spi");
2422 if (first_dynamic < 0)
2427 mutex_lock(&board_lock);
2428 id = idr_alloc(&spi_master_idr, ctlr, first_dynamic,
2430 mutex_unlock(&board_lock);
2431 if (WARN(id < 0, "couldn't get idr"))
2435 INIT_LIST_HEAD(&ctlr->queue);
2436 spin_lock_init(&ctlr->queue_lock);
2437 spin_lock_init(&ctlr->bus_lock_spinlock);
2438 mutex_init(&ctlr->bus_lock_mutex);
2439 mutex_init(&ctlr->io_mutex);
2440 ctlr->bus_lock_flag = 0;
2441 init_completion(&ctlr->xfer_completion);
2442 if (!ctlr->max_dma_len)
2443 ctlr->max_dma_len = INT_MAX;
2445 /* register the device, then userspace will see it.
2446 * registration fails if the bus ID is in use.
2448 dev_set_name(&ctlr->dev, "spi%u", ctlr->bus_num);
2450 if (!spi_controller_is_slave(ctlr)) {
2451 if (ctlr->use_gpio_descriptors) {
2452 status = spi_get_gpio_descs(ctlr);
2456 * A controller using GPIO descriptors always
2457 * supports SPI_CS_HIGH if need be.
2459 ctlr->mode_bits |= SPI_CS_HIGH;
2461 /* Legacy code path for GPIOs from DT */
2462 status = of_spi_get_gpio_numbers(ctlr);
2469 * Even if it's just one always-selected device, there must
2470 * be at least one chipselect.
2472 if (!ctlr->num_chipselect)
2475 status = device_add(&ctlr->dev);
2478 mutex_lock(&board_lock);
2479 idr_remove(&spi_master_idr, ctlr->bus_num);
2480 mutex_unlock(&board_lock);
2483 dev_dbg(dev, "registered %s %s\n",
2484 spi_controller_is_slave(ctlr) ? "slave" : "master",
2485 dev_name(&ctlr->dev));
2488 * If we're using a queued driver, start the queue. Note that we don't
2489 * need the queueing logic if the driver is only supporting high-level
2490 * memory operations.
2492 if (ctlr->transfer) {
2493 dev_info(dev, "controller is unqueued, this is deprecated\n");
2494 } else if (ctlr->transfer_one || ctlr->transfer_one_message) {
2495 status = spi_controller_initialize_queue(ctlr);
2497 device_del(&ctlr->dev);
2499 mutex_lock(&board_lock);
2500 idr_remove(&spi_master_idr, ctlr->bus_num);
2501 mutex_unlock(&board_lock);
2505 /* add statistics */
2506 spin_lock_init(&ctlr->statistics.lock);
2508 mutex_lock(&board_lock);
2509 list_add_tail(&ctlr->list, &spi_controller_list);
2510 list_for_each_entry(bi, &board_list, list)
2511 spi_match_controller_to_boardinfo(ctlr, &bi->board_info);
2512 mutex_unlock(&board_lock);
2514 /* Register devices from the device tree and ACPI */
2515 of_register_spi_devices(ctlr);
2516 acpi_register_spi_devices(ctlr);
2520 EXPORT_SYMBOL_GPL(spi_register_controller);
2522 static void devm_spi_unregister(struct device *dev, void *res)
2524 spi_unregister_controller(*(struct spi_controller **)res);
2528 * devm_spi_register_controller - register managed SPI master or slave
2530 * @dev: device managing SPI controller
2531 * @ctlr: initialized controller, originally from spi_alloc_master() or
2533 * Context: can sleep
2535 * Register a SPI device as with spi_register_controller() which will
2536 * automatically be unregistered and freed.
2538 * Return: zero on success, else a negative error code.
2540 int devm_spi_register_controller(struct device *dev,
2541 struct spi_controller *ctlr)
2543 struct spi_controller **ptr;
2546 ptr = devres_alloc(devm_spi_unregister, sizeof(*ptr), GFP_KERNEL);
2550 ret = spi_register_controller(ctlr);
2553 devres_add(dev, ptr);
2560 EXPORT_SYMBOL_GPL(devm_spi_register_controller);
2562 static int __unregister(struct device *dev, void *null)
2564 spi_unregister_device(to_spi_device(dev));
2569 * spi_unregister_controller - unregister SPI master or slave controller
2570 * @ctlr: the controller being unregistered
2571 * Context: can sleep
2573 * This call is used only by SPI controller drivers, which are the
2574 * only ones directly touching chip registers.
2576 * This must be called from context that can sleep.
2578 * Note that this function also drops a reference to the controller.
2580 void spi_unregister_controller(struct spi_controller *ctlr)
2582 struct spi_controller *found;
2583 int id = ctlr->bus_num;
2585 /* First make sure that this controller was ever added */
2586 mutex_lock(&board_lock);
2587 found = idr_find(&spi_master_idr, id);
2588 mutex_unlock(&board_lock);
2590 if (spi_destroy_queue(ctlr))
2591 dev_err(&ctlr->dev, "queue remove failed\n");
2593 mutex_lock(&board_lock);
2594 list_del(&ctlr->list);
2595 mutex_unlock(&board_lock);
2597 device_for_each_child(&ctlr->dev, NULL, __unregister);
2598 device_unregister(&ctlr->dev);
2600 mutex_lock(&board_lock);
2602 idr_remove(&spi_master_idr, id);
2603 mutex_unlock(&board_lock);
2605 EXPORT_SYMBOL_GPL(spi_unregister_controller);
2607 int spi_controller_suspend(struct spi_controller *ctlr)
2611 /* Basically no-ops for non-queued controllers */
2615 ret = spi_stop_queue(ctlr);
2617 dev_err(&ctlr->dev, "queue stop failed\n");
2621 EXPORT_SYMBOL_GPL(spi_controller_suspend);
2623 int spi_controller_resume(struct spi_controller *ctlr)
2630 ret = spi_start_queue(ctlr);
2632 dev_err(&ctlr->dev, "queue restart failed\n");
2636 EXPORT_SYMBOL_GPL(spi_controller_resume);
2638 static int __spi_controller_match(struct device *dev, const void *data)
2640 struct spi_controller *ctlr;
2641 const u16 *bus_num = data;
2643 ctlr = container_of(dev, struct spi_controller, dev);
2644 return ctlr->bus_num == *bus_num;
2648 * spi_busnum_to_master - look up master associated with bus_num
2649 * @bus_num: the master's bus number
2650 * Context: can sleep
2652 * This call may be used with devices that are registered after
2653 * arch init time. It returns a refcounted pointer to the relevant
2654 * spi_controller (which the caller must release), or NULL if there is
2655 * no such master registered.
2657 * Return: the SPI master structure on success, else NULL.
2659 struct spi_controller *spi_busnum_to_master(u16 bus_num)
2662 struct spi_controller *ctlr = NULL;
2664 dev = class_find_device(&spi_master_class, NULL, &bus_num,
2665 __spi_controller_match);
2667 ctlr = container_of(dev, struct spi_controller, dev);
2668 /* reference got in class_find_device */
2671 EXPORT_SYMBOL_GPL(spi_busnum_to_master);
2673 /*-------------------------------------------------------------------------*/
2675 /* Core methods for SPI resource management */
2678 * spi_res_alloc - allocate a spi resource that is life-cycle managed
2679 * during the processing of a spi_message while using
2681 * @spi: the spi device for which we allocate memory
2682 * @release: the release code to execute for this resource
2683 * @size: size to alloc and return
2684 * @gfp: GFP allocation flags
2686 * Return: the pointer to the allocated data
2688 * This may get enhanced in the future to allocate from a memory pool
2689 * of the @spi_device or @spi_controller to avoid repeated allocations.
2691 void *spi_res_alloc(struct spi_device *spi,
2692 spi_res_release_t release,
2693 size_t size, gfp_t gfp)
2695 struct spi_res *sres;
2697 sres = kzalloc(sizeof(*sres) + size, gfp);
2701 INIT_LIST_HEAD(&sres->entry);
2702 sres->release = release;
2706 EXPORT_SYMBOL_GPL(spi_res_alloc);
2709 * spi_res_free - free an spi resource
2710 * @res: pointer to the custom data of a resource
2713 void spi_res_free(void *res)
2715 struct spi_res *sres = container_of(res, struct spi_res, data);
2720 WARN_ON(!list_empty(&sres->entry));
2723 EXPORT_SYMBOL_GPL(spi_res_free);
2726 * spi_res_add - add a spi_res to the spi_message
2727 * @message: the spi message
2728 * @res: the spi_resource
2730 void spi_res_add(struct spi_message *message, void *res)
2732 struct spi_res *sres = container_of(res, struct spi_res, data);
2734 WARN_ON(!list_empty(&sres->entry));
2735 list_add_tail(&sres->entry, &message->resources);
2737 EXPORT_SYMBOL_GPL(spi_res_add);
2740 * spi_res_release - release all spi resources for this message
2741 * @ctlr: the @spi_controller
2742 * @message: the @spi_message
2744 void spi_res_release(struct spi_controller *ctlr, struct spi_message *message)
2746 struct spi_res *res, *tmp;
2748 list_for_each_entry_safe_reverse(res, tmp, &message->resources, entry) {
2750 res->release(ctlr, message, res->data);
2752 list_del(&res->entry);
2757 EXPORT_SYMBOL_GPL(spi_res_release);
2759 /*-------------------------------------------------------------------------*/
2761 /* Core methods for spi_message alterations */
2763 static void __spi_replace_transfers_release(struct spi_controller *ctlr,
2764 struct spi_message *msg,
2767 struct spi_replaced_transfers *rxfer = res;
2770 /* call extra callback if requested */
2772 rxfer->release(ctlr, msg, res);
2774 /* insert replaced transfers back into the message */
2775 list_splice(&rxfer->replaced_transfers, rxfer->replaced_after);
2777 /* remove the formerly inserted entries */
2778 for (i = 0; i < rxfer->inserted; i++)
2779 list_del(&rxfer->inserted_transfers[i].transfer_list);
2783 * spi_replace_transfers - replace transfers with several transfers
2784 * and register change with spi_message.resources
2785 * @msg: the spi_message we work upon
2786 * @xfer_first: the first spi_transfer we want to replace
2787 * @remove: number of transfers to remove
2788 * @insert: the number of transfers we want to insert instead
2789 * @release: extra release code necessary in some circumstances
2790 * @extradatasize: extra data to allocate (with alignment guarantees
2791 * of struct @spi_transfer)
2794 * Returns: pointer to @spi_replaced_transfers,
2795 * PTR_ERR(...) in case of errors.
2797 struct spi_replaced_transfers *spi_replace_transfers(
2798 struct spi_message *msg,
2799 struct spi_transfer *xfer_first,
2802 spi_replaced_release_t release,
2803 size_t extradatasize,
2806 struct spi_replaced_transfers *rxfer;
2807 struct spi_transfer *xfer;
2810 /* allocate the structure using spi_res */
2811 rxfer = spi_res_alloc(msg->spi, __spi_replace_transfers_release,
2812 struct_size(rxfer, inserted_transfers, insert)
2816 return ERR_PTR(-ENOMEM);
2818 /* the release code to invoke before running the generic release */
2819 rxfer->release = release;
2821 /* assign extradata */
2824 &rxfer->inserted_transfers[insert];
2826 /* init the replaced_transfers list */
2827 INIT_LIST_HEAD(&rxfer->replaced_transfers);
2829 /* assign the list_entry after which we should reinsert
2830 * the @replaced_transfers - it may be spi_message.messages!
2832 rxfer->replaced_after = xfer_first->transfer_list.prev;
2834 /* remove the requested number of transfers */
2835 for (i = 0; i < remove; i++) {
2836 /* if the entry after replaced_after it is msg->transfers
2837 * then we have been requested to remove more transfers
2838 * than are in the list
2840 if (rxfer->replaced_after->next == &msg->transfers) {
2841 dev_err(&msg->spi->dev,
2842 "requested to remove more spi_transfers than are available\n");
2843 /* insert replaced transfers back into the message */
2844 list_splice(&rxfer->replaced_transfers,
2845 rxfer->replaced_after);
2847 /* free the spi_replace_transfer structure */
2848 spi_res_free(rxfer);
2850 /* and return with an error */
2851 return ERR_PTR(-EINVAL);
2854 /* remove the entry after replaced_after from list of
2855 * transfers and add it to list of replaced_transfers
2857 list_move_tail(rxfer->replaced_after->next,
2858 &rxfer->replaced_transfers);
2861 /* create copy of the given xfer with identical settings
2862 * based on the first transfer to get removed
2864 for (i = 0; i < insert; i++) {
2865 /* we need to run in reverse order */
2866 xfer = &rxfer->inserted_transfers[insert - 1 - i];
2868 /* copy all spi_transfer data */
2869 memcpy(xfer, xfer_first, sizeof(*xfer));
2872 list_add(&xfer->transfer_list, rxfer->replaced_after);
2874 /* clear cs_change and delay_usecs for all but the last */
2876 xfer->cs_change = false;
2877 xfer->delay_usecs = 0;
2881 /* set up inserted */
2882 rxfer->inserted = insert;
2884 /* and register it with spi_res/spi_message */
2885 spi_res_add(msg, rxfer);
2889 EXPORT_SYMBOL_GPL(spi_replace_transfers);
2891 static int __spi_split_transfer_maxsize(struct spi_controller *ctlr,
2892 struct spi_message *msg,
2893 struct spi_transfer **xferp,
2897 struct spi_transfer *xfer = *xferp, *xfers;
2898 struct spi_replaced_transfers *srt;
2902 /* calculate how many we have to replace */
2903 count = DIV_ROUND_UP(xfer->len, maxsize);
2905 /* create replacement */
2906 srt = spi_replace_transfers(msg, xfer, 1, count, NULL, 0, gfp);
2908 return PTR_ERR(srt);
2909 xfers = srt->inserted_transfers;
2911 /* now handle each of those newly inserted spi_transfers
2912 * note that the replacements spi_transfers all are preset
2913 * to the same values as *xferp, so tx_buf, rx_buf and len
2914 * are all identical (as well as most others)
2915 * so we just have to fix up len and the pointers.
2917 * this also includes support for the depreciated
2918 * spi_message.is_dma_mapped interface
2921 /* the first transfer just needs the length modified, so we
2922 * run it outside the loop
2924 xfers[0].len = min_t(size_t, maxsize, xfer[0].len);
2926 /* all the others need rx_buf/tx_buf also set */
2927 for (i = 1, offset = maxsize; i < count; offset += maxsize, i++) {
2928 /* update rx_buf, tx_buf and dma */
2929 if (xfers[i].rx_buf)
2930 xfers[i].rx_buf += offset;
2931 if (xfers[i].rx_dma)
2932 xfers[i].rx_dma += offset;
2933 if (xfers[i].tx_buf)
2934 xfers[i].tx_buf += offset;
2935 if (xfers[i].tx_dma)
2936 xfers[i].tx_dma += offset;
2939 xfers[i].len = min(maxsize, xfers[i].len - offset);
2942 /* we set up xferp to the last entry we have inserted,
2943 * so that we skip those already split transfers
2945 *xferp = &xfers[count - 1];
2947 /* increment statistics counters */
2948 SPI_STATISTICS_INCREMENT_FIELD(&ctlr->statistics,
2949 transfers_split_maxsize);
2950 SPI_STATISTICS_INCREMENT_FIELD(&msg->spi->statistics,
2951 transfers_split_maxsize);
2957 * spi_split_tranfers_maxsize - split spi transfers into multiple transfers
2958 * when an individual transfer exceeds a
2960 * @ctlr: the @spi_controller for this transfer
2961 * @msg: the @spi_message to transform
2962 * @maxsize: the maximum when to apply this
2963 * @gfp: GFP allocation flags
2965 * Return: status of transformation
2967 int spi_split_transfers_maxsize(struct spi_controller *ctlr,
2968 struct spi_message *msg,
2972 struct spi_transfer *xfer;
2975 /* iterate over the transfer_list,
2976 * but note that xfer is advanced to the last transfer inserted
2977 * to avoid checking sizes again unnecessarily (also xfer does
2978 * potentiall belong to a different list by the time the
2979 * replacement has happened
2981 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
2982 if (xfer->len > maxsize) {
2983 ret = __spi_split_transfer_maxsize(ctlr, msg, &xfer,
2992 EXPORT_SYMBOL_GPL(spi_split_transfers_maxsize);
2994 /*-------------------------------------------------------------------------*/
2996 /* Core methods for SPI controller protocol drivers. Some of the
2997 * other core methods are currently defined as inline functions.
3000 static int __spi_validate_bits_per_word(struct spi_controller *ctlr,
3003 if (ctlr->bits_per_word_mask) {
3004 /* Only 32 bits fit in the mask */
3005 if (bits_per_word > 32)
3007 if (!(ctlr->bits_per_word_mask & SPI_BPW_MASK(bits_per_word)))
3015 * spi_setup - setup SPI mode and clock rate
3016 * @spi: the device whose settings are being modified
3017 * Context: can sleep, and no requests are queued to the device
3019 * SPI protocol drivers may need to update the transfer mode if the
3020 * device doesn't work with its default. They may likewise need
3021 * to update clock rates or word sizes from initial values. This function
3022 * changes those settings, and must be called from a context that can sleep.
3023 * Except for SPI_CS_HIGH, which takes effect immediately, the changes take
3024 * effect the next time the device is selected and data is transferred to
3025 * or from it. When this function returns, the spi device is deselected.
3027 * Note that this call will fail if the protocol driver specifies an option
3028 * that the underlying controller or its driver does not support. For
3029 * example, not all hardware supports wire transfers using nine bit words,
3030 * LSB-first wire encoding, or active-high chipselects.
3032 * Return: zero on success, else a negative error code.
3034 int spi_setup(struct spi_device *spi)
3036 unsigned bad_bits, ugly_bits;
3039 /* check mode to prevent that DUAL and QUAD set at the same time
3041 if (((spi->mode & SPI_TX_DUAL) && (spi->mode & SPI_TX_QUAD)) ||
3042 ((spi->mode & SPI_RX_DUAL) && (spi->mode & SPI_RX_QUAD))) {
3044 "setup: can not select dual and quad at the same time\n");
3047 /* if it is SPI_3WIRE mode, DUAL and QUAD should be forbidden
3049 if ((spi->mode & SPI_3WIRE) && (spi->mode &
3050 (SPI_TX_DUAL | SPI_TX_QUAD | SPI_TX_OCTAL |
3051 SPI_RX_DUAL | SPI_RX_QUAD | SPI_RX_OCTAL)))
3053 /* help drivers fail *cleanly* when they need options
3054 * that aren't supported with their current controller
3055 * SPI_CS_WORD has a fallback software implementation,
3056 * so it is ignored here.
3058 bad_bits = spi->mode & ~(spi->controller->mode_bits | SPI_CS_WORD);
3059 /* nothing prevents from working with active-high CS in case if it
3060 * is driven by GPIO.
3062 if (gpio_is_valid(spi->cs_gpio))
3063 bad_bits &= ~SPI_CS_HIGH;
3064 ugly_bits = bad_bits &
3065 (SPI_TX_DUAL | SPI_TX_QUAD | SPI_TX_OCTAL |
3066 SPI_RX_DUAL | SPI_RX_QUAD | SPI_RX_OCTAL);
3069 "setup: ignoring unsupported mode bits %x\n",
3071 spi->mode &= ~ugly_bits;
3072 bad_bits &= ~ugly_bits;
3075 dev_err(&spi->dev, "setup: unsupported mode bits %x\n",
3080 if (!spi->bits_per_word)
3081 spi->bits_per_word = 8;
3083 status = __spi_validate_bits_per_word(spi->controller,
3084 spi->bits_per_word);
3088 if (!spi->max_speed_hz)
3089 spi->max_speed_hz = spi->controller->max_speed_hz;
3091 if (spi->controller->setup)
3092 status = spi->controller->setup(spi);
3094 spi_set_cs(spi, false);
3096 if (spi->rt && !spi->controller->rt) {
3097 spi->controller->rt = true;
3098 spi_set_thread_rt(spi->controller);
3101 dev_dbg(&spi->dev, "setup mode %d, %s%s%s%s%u bits/w, %u Hz max --> %d\n",
3102 (int) (spi->mode & (SPI_CPOL | SPI_CPHA)),
3103 (spi->mode & SPI_CS_HIGH) ? "cs_high, " : "",
3104 (spi->mode & SPI_LSB_FIRST) ? "lsb, " : "",
3105 (spi->mode & SPI_3WIRE) ? "3wire, " : "",
3106 (spi->mode & SPI_LOOP) ? "loopback, " : "",
3107 spi->bits_per_word, spi->max_speed_hz,
3112 EXPORT_SYMBOL_GPL(spi_setup);
3115 * spi_set_cs_timing - configure CS setup, hold, and inactive delays
3116 * @spi: the device that requires specific CS timing configuration
3117 * @setup: CS setup time in terms of clock count
3118 * @hold: CS hold time in terms of clock count
3119 * @inactive_dly: CS inactive delay between transfers in terms of clock count
3121 void spi_set_cs_timing(struct spi_device *spi, u8 setup, u8 hold,
3124 if (spi->controller->set_cs_timing)
3125 spi->controller->set_cs_timing(spi, setup, hold, inactive_dly);
3127 EXPORT_SYMBOL_GPL(spi_set_cs_timing);
3129 static int __spi_validate(struct spi_device *spi, struct spi_message *message)
3131 struct spi_controller *ctlr = spi->controller;
3132 struct spi_transfer *xfer;
3135 if (list_empty(&message->transfers))
3138 /* If an SPI controller does not support toggling the CS line on each
3139 * transfer (indicated by the SPI_CS_WORD flag) or we are using a GPIO
3140 * for the CS line, we can emulate the CS-per-word hardware function by
3141 * splitting transfers into one-word transfers and ensuring that
3142 * cs_change is set for each transfer.
3144 if ((spi->mode & SPI_CS_WORD) && (!(ctlr->mode_bits & SPI_CS_WORD) ||
3146 gpio_is_valid(spi->cs_gpio))) {
3150 maxsize = (spi->bits_per_word + 7) / 8;
3152 /* spi_split_transfers_maxsize() requires message->spi */
3155 ret = spi_split_transfers_maxsize(ctlr, message, maxsize,
3160 list_for_each_entry(xfer, &message->transfers, transfer_list) {
3161 /* don't change cs_change on the last entry in the list */
3162 if (list_is_last(&xfer->transfer_list, &message->transfers))
3164 xfer->cs_change = 1;
3168 /* Half-duplex links include original MicroWire, and ones with
3169 * only one data pin like SPI_3WIRE (switches direction) or where
3170 * either MOSI or MISO is missing. They can also be caused by
3171 * software limitations.
3173 if ((ctlr->flags & SPI_CONTROLLER_HALF_DUPLEX) ||
3174 (spi->mode & SPI_3WIRE)) {
3175 unsigned flags = ctlr->flags;
3177 list_for_each_entry(xfer, &message->transfers, transfer_list) {
3178 if (xfer->rx_buf && xfer->tx_buf)
3180 if ((flags & SPI_CONTROLLER_NO_TX) && xfer->tx_buf)
3182 if ((flags & SPI_CONTROLLER_NO_RX) && xfer->rx_buf)
3188 * Set transfer bits_per_word and max speed as spi device default if
3189 * it is not set for this transfer.
3190 * Set transfer tx_nbits and rx_nbits as single transfer default
3191 * (SPI_NBITS_SINGLE) if it is not set for this transfer.
3192 * Ensure transfer word_delay is at least as long as that required by
3195 message->frame_length = 0;
3196 list_for_each_entry(xfer, &message->transfers, transfer_list) {
3197 xfer->effective_speed_hz = 0;
3198 message->frame_length += xfer->len;
3199 if (!xfer->bits_per_word)
3200 xfer->bits_per_word = spi->bits_per_word;
3202 if (!xfer->speed_hz)
3203 xfer->speed_hz = spi->max_speed_hz;
3205 if (ctlr->max_speed_hz && xfer->speed_hz > ctlr->max_speed_hz)
3206 xfer->speed_hz = ctlr->max_speed_hz;
3208 if (__spi_validate_bits_per_word(ctlr, xfer->bits_per_word))
3212 * SPI transfer length should be multiple of SPI word size
3213 * where SPI word size should be power-of-two multiple
3215 if (xfer->bits_per_word <= 8)
3217 else if (xfer->bits_per_word <= 16)
3222 /* No partial transfers accepted */
3223 if (xfer->len % w_size)
3226 if (xfer->speed_hz && ctlr->min_speed_hz &&
3227 xfer->speed_hz < ctlr->min_speed_hz)
3230 if (xfer->tx_buf && !xfer->tx_nbits)
3231 xfer->tx_nbits = SPI_NBITS_SINGLE;
3232 if (xfer->rx_buf && !xfer->rx_nbits)
3233 xfer->rx_nbits = SPI_NBITS_SINGLE;
3234 /* check transfer tx/rx_nbits:
3235 * 1. check the value matches one of single, dual and quad
3236 * 2. check tx/rx_nbits match the mode in spi_device
3239 if (xfer->tx_nbits != SPI_NBITS_SINGLE &&
3240 xfer->tx_nbits != SPI_NBITS_DUAL &&
3241 xfer->tx_nbits != SPI_NBITS_QUAD)
3243 if ((xfer->tx_nbits == SPI_NBITS_DUAL) &&
3244 !(spi->mode & (SPI_TX_DUAL | SPI_TX_QUAD)))
3246 if ((xfer->tx_nbits == SPI_NBITS_QUAD) &&
3247 !(spi->mode & SPI_TX_QUAD))
3250 /* check transfer rx_nbits */
3252 if (xfer->rx_nbits != SPI_NBITS_SINGLE &&
3253 xfer->rx_nbits != SPI_NBITS_DUAL &&
3254 xfer->rx_nbits != SPI_NBITS_QUAD)
3256 if ((xfer->rx_nbits == SPI_NBITS_DUAL) &&
3257 !(spi->mode & (SPI_RX_DUAL | SPI_RX_QUAD)))
3259 if ((xfer->rx_nbits == SPI_NBITS_QUAD) &&
3260 !(spi->mode & SPI_RX_QUAD))
3264 if (xfer->word_delay_usecs < spi->word_delay_usecs)
3265 xfer->word_delay_usecs = spi->word_delay_usecs;
3268 message->status = -EINPROGRESS;
3273 static int __spi_async(struct spi_device *spi, struct spi_message *message)
3275 struct spi_controller *ctlr = spi->controller;
3278 * Some controllers do not support doing regular SPI transfers. Return
3279 * ENOTSUPP when this is the case.
3281 if (!ctlr->transfer)
3286 SPI_STATISTICS_INCREMENT_FIELD(&ctlr->statistics, spi_async);
3287 SPI_STATISTICS_INCREMENT_FIELD(&spi->statistics, spi_async);
3289 trace_spi_message_submit(message);
3291 return ctlr->transfer(spi, message);
3295 * spi_async - asynchronous SPI transfer
3296 * @spi: device with which data will be exchanged
3297 * @message: describes the data transfers, including completion callback
3298 * Context: any (irqs may be blocked, etc)
3300 * This call may be used in_irq and other contexts which can't sleep,
3301 * as well as from task contexts which can sleep.
3303 * The completion callback is invoked in a context which can't sleep.
3304 * Before that invocation, the value of message->status is undefined.
3305 * When the callback is issued, message->status holds either zero (to
3306 * indicate complete success) or a negative error code. After that
3307 * callback returns, the driver which issued the transfer request may
3308 * deallocate the associated memory; it's no longer in use by any SPI
3309 * core or controller driver code.
3311 * Note that although all messages to a spi_device are handled in
3312 * FIFO order, messages may go to different devices in other orders.
3313 * Some device might be higher priority, or have various "hard" access
3314 * time requirements, for example.
3316 * On detection of any fault during the transfer, processing of
3317 * the entire message is aborted, and the device is deselected.
3318 * Until returning from the associated message completion callback,
3319 * no other spi_message queued to that device will be processed.
3320 * (This rule applies equally to all the synchronous transfer calls,
3321 * which are wrappers around this core asynchronous primitive.)
3323 * Return: zero on success, else a negative error code.
3325 int spi_async(struct spi_device *spi, struct spi_message *message)
3327 struct spi_controller *ctlr = spi->controller;
3329 unsigned long flags;
3331 ret = __spi_validate(spi, message);
3335 spin_lock_irqsave(&ctlr->bus_lock_spinlock, flags);
3337 if (ctlr->bus_lock_flag)
3340 ret = __spi_async(spi, message);
3342 spin_unlock_irqrestore(&ctlr->bus_lock_spinlock, flags);
3346 EXPORT_SYMBOL_GPL(spi_async);
3349 * spi_async_locked - version of spi_async with exclusive bus usage
3350 * @spi: device with which data will be exchanged
3351 * @message: describes the data transfers, including completion callback
3352 * Context: any (irqs may be blocked, etc)
3354 * This call may be used in_irq and other contexts which can't sleep,
3355 * as well as from task contexts which can sleep.
3357 * The completion callback is invoked in a context which can't sleep.
3358 * Before that invocation, the value of message->status is undefined.
3359 * When the callback is issued, message->status holds either zero (to
3360 * indicate complete success) or a negative error code. After that
3361 * callback returns, the driver which issued the transfer request may
3362 * deallocate the associated memory; it's no longer in use by any SPI
3363 * core or controller driver code.
3365 * Note that although all messages to a spi_device are handled in
3366 * FIFO order, messages may go to different devices in other orders.
3367 * Some device might be higher priority, or have various "hard" access
3368 * time requirements, for example.
3370 * On detection of any fault during the transfer, processing of
3371 * the entire message is aborted, and the device is deselected.
3372 * Until returning from the associated message completion callback,
3373 * no other spi_message queued to that device will be processed.
3374 * (This rule applies equally to all the synchronous transfer calls,
3375 * which are wrappers around this core asynchronous primitive.)
3377 * Return: zero on success, else a negative error code.
3379 int spi_async_locked(struct spi_device *spi, struct spi_message *message)
3381 struct spi_controller *ctlr = spi->controller;
3383 unsigned long flags;
3385 ret = __spi_validate(spi, message);
3389 spin_lock_irqsave(&ctlr->bus_lock_spinlock, flags);
3391 ret = __spi_async(spi, message);
3393 spin_unlock_irqrestore(&ctlr->bus_lock_spinlock, flags);
3398 EXPORT_SYMBOL_GPL(spi_async_locked);
3400 /*-------------------------------------------------------------------------*/
3402 /* Utility methods for SPI protocol drivers, layered on
3403 * top of the core. Some other utility methods are defined as
3407 static void spi_complete(void *arg)
3412 static int __spi_sync(struct spi_device *spi, struct spi_message *message)
3414 DECLARE_COMPLETION_ONSTACK(done);
3416 struct spi_controller *ctlr = spi->controller;
3417 unsigned long flags;
3419 status = __spi_validate(spi, message);
3423 message->complete = spi_complete;
3424 message->context = &done;
3427 SPI_STATISTICS_INCREMENT_FIELD(&ctlr->statistics, spi_sync);
3428 SPI_STATISTICS_INCREMENT_FIELD(&spi->statistics, spi_sync);
3430 /* If we're not using the legacy transfer method then we will
3431 * try to transfer in the calling context so special case.
3432 * This code would be less tricky if we could remove the
3433 * support for driver implemented message queues.
3435 if (ctlr->transfer == spi_queued_transfer) {
3436 spin_lock_irqsave(&ctlr->bus_lock_spinlock, flags);
3438 trace_spi_message_submit(message);
3440 status = __spi_queued_transfer(spi, message, false);
3442 spin_unlock_irqrestore(&ctlr->bus_lock_spinlock, flags);
3444 status = spi_async_locked(spi, message);
3448 /* Push out the messages in the calling context if we
3451 if (ctlr->transfer == spi_queued_transfer) {
3452 SPI_STATISTICS_INCREMENT_FIELD(&ctlr->statistics,
3453 spi_sync_immediate);
3454 SPI_STATISTICS_INCREMENT_FIELD(&spi->statistics,
3455 spi_sync_immediate);
3456 __spi_pump_messages(ctlr, false);
3459 wait_for_completion(&done);
3460 status = message->status;
3462 message->context = NULL;
3467 * spi_sync - blocking/synchronous SPI data transfers
3468 * @spi: device with which data will be exchanged
3469 * @message: describes the data transfers
3470 * Context: can sleep
3472 * This call may only be used from a context that may sleep. The sleep
3473 * is non-interruptible, and has no timeout. Low-overhead controller
3474 * drivers may DMA directly into and out of the message buffers.
3476 * Note that the SPI device's chip select is active during the message,
3477 * and then is normally disabled between messages. Drivers for some
3478 * frequently-used devices may want to minimize costs of selecting a chip,
3479 * by leaving it selected in anticipation that the next message will go
3480 * to the same chip. (That may increase power usage.)
3482 * Also, the caller is guaranteeing that the memory associated with the
3483 * message will not be freed before this call returns.
3485 * Return: zero on success, else a negative error code.
3487 int spi_sync(struct spi_device *spi, struct spi_message *message)
3491 mutex_lock(&spi->controller->bus_lock_mutex);
3492 ret = __spi_sync(spi, message);
3493 mutex_unlock(&spi->controller->bus_lock_mutex);
3497 EXPORT_SYMBOL_GPL(spi_sync);
3500 * spi_sync_locked - version of spi_sync with exclusive bus usage
3501 * @spi: device with which data will be exchanged
3502 * @message: describes the data transfers
3503 * Context: can sleep
3505 * This call may only be used from a context that may sleep. The sleep
3506 * is non-interruptible, and has no timeout. Low-overhead controller
3507 * drivers may DMA directly into and out of the message buffers.
3509 * This call should be used by drivers that require exclusive access to the
3510 * SPI bus. It has to be preceded by a spi_bus_lock call. The SPI bus must
3511 * be released by a spi_bus_unlock call when the exclusive access is over.
3513 * Return: zero on success, else a negative error code.
3515 int spi_sync_locked(struct spi_device *spi, struct spi_message *message)
3517 return __spi_sync(spi, message);
3519 EXPORT_SYMBOL_GPL(spi_sync_locked);
3522 * spi_bus_lock - obtain a lock for exclusive SPI bus usage
3523 * @ctlr: SPI bus master that should be locked for exclusive bus access
3524 * Context: can sleep
3526 * This call may only be used from a context that may sleep. The sleep
3527 * is non-interruptible, and has no timeout.
3529 * This call should be used by drivers that require exclusive access to the
3530 * SPI bus. The SPI bus must be released by a spi_bus_unlock call when the
3531 * exclusive access is over. Data transfer must be done by spi_sync_locked
3532 * and spi_async_locked calls when the SPI bus lock is held.
3534 * Return: always zero.
3536 int spi_bus_lock(struct spi_controller *ctlr)
3538 unsigned long flags;
3540 mutex_lock(&ctlr->bus_lock_mutex);
3542 spin_lock_irqsave(&ctlr->bus_lock_spinlock, flags);
3543 ctlr->bus_lock_flag = 1;
3544 spin_unlock_irqrestore(&ctlr->bus_lock_spinlock, flags);
3546 /* mutex remains locked until spi_bus_unlock is called */
3550 EXPORT_SYMBOL_GPL(spi_bus_lock);
3553 * spi_bus_unlock - release the lock for exclusive SPI bus usage
3554 * @ctlr: SPI bus master that was locked for exclusive bus access
3555 * Context: can sleep
3557 * This call may only be used from a context that may sleep. The sleep
3558 * is non-interruptible, and has no timeout.
3560 * This call releases an SPI bus lock previously obtained by an spi_bus_lock
3563 * Return: always zero.
3565 int spi_bus_unlock(struct spi_controller *ctlr)
3567 ctlr->bus_lock_flag = 0;
3569 mutex_unlock(&ctlr->bus_lock_mutex);
3573 EXPORT_SYMBOL_GPL(spi_bus_unlock);
3575 /* portable code must never pass more than 32 bytes */
3576 #define SPI_BUFSIZ max(32, SMP_CACHE_BYTES)
3581 * spi_write_then_read - SPI synchronous write followed by read
3582 * @spi: device with which data will be exchanged
3583 * @txbuf: data to be written (need not be dma-safe)
3584 * @n_tx: size of txbuf, in bytes
3585 * @rxbuf: buffer into which data will be read (need not be dma-safe)
3586 * @n_rx: size of rxbuf, in bytes
3587 * Context: can sleep
3589 * This performs a half duplex MicroWire style transaction with the
3590 * device, sending txbuf and then reading rxbuf. The return value
3591 * is zero for success, else a negative errno status code.
3592 * This call may only be used from a context that may sleep.
3594 * Parameters to this routine are always copied using a small buffer;
3595 * portable code should never use this for more than 32 bytes.
3596 * Performance-sensitive or bulk transfer code should instead use
3597 * spi_{async,sync}() calls with dma-safe buffers.
3599 * Return: zero on success, else a negative error code.
3601 int spi_write_then_read(struct spi_device *spi,
3602 const void *txbuf, unsigned n_tx,
3603 void *rxbuf, unsigned n_rx)
3605 static DEFINE_MUTEX(lock);
3608 struct spi_message message;
3609 struct spi_transfer x[2];
3612 /* Use preallocated DMA-safe buffer if we can. We can't avoid
3613 * copying here, (as a pure convenience thing), but we can
3614 * keep heap costs out of the hot path unless someone else is
3615 * using the pre-allocated buffer or the transfer is too large.
3617 if ((n_tx + n_rx) > SPI_BUFSIZ || !mutex_trylock(&lock)) {
3618 local_buf = kmalloc(max((unsigned)SPI_BUFSIZ, n_tx + n_rx),
3619 GFP_KERNEL | GFP_DMA);
3626 spi_message_init(&message);
3627 memset(x, 0, sizeof(x));
3630 spi_message_add_tail(&x[0], &message);
3634 spi_message_add_tail(&x[1], &message);
3637 memcpy(local_buf, txbuf, n_tx);
3638 x[0].tx_buf = local_buf;
3639 x[1].rx_buf = local_buf + n_tx;
3642 status = spi_sync(spi, &message);
3644 memcpy(rxbuf, x[1].rx_buf, n_rx);
3646 if (x[0].tx_buf == buf)
3647 mutex_unlock(&lock);
3653 EXPORT_SYMBOL_GPL(spi_write_then_read);
3655 /*-------------------------------------------------------------------------*/
3657 #if IS_ENABLED(CONFIG_OF)
3658 /* must call put_device() when done with returned spi_device device */
3659 struct spi_device *of_find_spi_device_by_node(struct device_node *node)
3661 struct device *dev = bus_find_device_by_of_node(&spi_bus_type, node);
3663 return dev ? to_spi_device(dev) : NULL;
3665 EXPORT_SYMBOL_GPL(of_find_spi_device_by_node);
3666 #endif /* IS_ENABLED(CONFIG_OF) */
3668 #if IS_ENABLED(CONFIG_OF_DYNAMIC)
3669 /* the spi controllers are not using spi_bus, so we find it with another way */
3670 static struct spi_controller *of_find_spi_controller_by_node(struct device_node *node)
3674 dev = class_find_device_by_of_node(&spi_master_class, node);
3675 if (!dev && IS_ENABLED(CONFIG_SPI_SLAVE))
3676 dev = class_find_device_by_of_node(&spi_slave_class, node);
3680 /* reference got in class_find_device */
3681 return container_of(dev, struct spi_controller, dev);
3684 static int of_spi_notify(struct notifier_block *nb, unsigned long action,
3687 struct of_reconfig_data *rd = arg;
3688 struct spi_controller *ctlr;
3689 struct spi_device *spi;
3691 switch (of_reconfig_get_state_change(action, arg)) {
3692 case OF_RECONFIG_CHANGE_ADD:
3693 ctlr = of_find_spi_controller_by_node(rd->dn->parent);
3695 return NOTIFY_OK; /* not for us */
3697 if (of_node_test_and_set_flag(rd->dn, OF_POPULATED)) {
3698 put_device(&ctlr->dev);
3702 spi = of_register_spi_device(ctlr, rd->dn);
3703 put_device(&ctlr->dev);
3706 pr_err("%s: failed to create for '%pOF'\n",
3708 of_node_clear_flag(rd->dn, OF_POPULATED);
3709 return notifier_from_errno(PTR_ERR(spi));
3713 case OF_RECONFIG_CHANGE_REMOVE:
3714 /* already depopulated? */
3715 if (!of_node_check_flag(rd->dn, OF_POPULATED))
3718 /* find our device by node */
3719 spi = of_find_spi_device_by_node(rd->dn);
3721 return NOTIFY_OK; /* no? not meant for us */
3723 /* unregister takes one ref away */
3724 spi_unregister_device(spi);
3726 /* and put the reference of the find */
3727 put_device(&spi->dev);
3734 static struct notifier_block spi_of_notifier = {
3735 .notifier_call = of_spi_notify,
3737 #else /* IS_ENABLED(CONFIG_OF_DYNAMIC) */
3738 extern struct notifier_block spi_of_notifier;
3739 #endif /* IS_ENABLED(CONFIG_OF_DYNAMIC) */
3741 #if IS_ENABLED(CONFIG_ACPI)
3742 static int spi_acpi_controller_match(struct device *dev, const void *data)
3744 return ACPI_COMPANION(dev->parent) == data;
3747 static struct spi_controller *acpi_spi_find_controller_by_adev(struct acpi_device *adev)
3751 dev = class_find_device(&spi_master_class, NULL, adev,
3752 spi_acpi_controller_match);
3753 if (!dev && IS_ENABLED(CONFIG_SPI_SLAVE))
3754 dev = class_find_device(&spi_slave_class, NULL, adev,
3755 spi_acpi_controller_match);
3759 return container_of(dev, struct spi_controller, dev);
3762 static struct spi_device *acpi_spi_find_device_by_adev(struct acpi_device *adev)
3766 dev = bus_find_device_by_acpi_dev(&spi_bus_type, adev);
3767 return dev ? to_spi_device(dev) : NULL;
3770 static int acpi_spi_notify(struct notifier_block *nb, unsigned long value,
3773 struct acpi_device *adev = arg;
3774 struct spi_controller *ctlr;
3775 struct spi_device *spi;
3778 case ACPI_RECONFIG_DEVICE_ADD:
3779 ctlr = acpi_spi_find_controller_by_adev(adev->parent);
3783 acpi_register_spi_device(ctlr, adev);
3784 put_device(&ctlr->dev);
3786 case ACPI_RECONFIG_DEVICE_REMOVE:
3787 if (!acpi_device_enumerated(adev))
3790 spi = acpi_spi_find_device_by_adev(adev);
3794 spi_unregister_device(spi);
3795 put_device(&spi->dev);
3802 static struct notifier_block spi_acpi_notifier = {
3803 .notifier_call = acpi_spi_notify,
3806 extern struct notifier_block spi_acpi_notifier;
3809 static int __init spi_init(void)
3813 buf = kmalloc(SPI_BUFSIZ, GFP_KERNEL);
3819 status = bus_register(&spi_bus_type);
3823 status = class_register(&spi_master_class);
3827 if (IS_ENABLED(CONFIG_SPI_SLAVE)) {
3828 status = class_register(&spi_slave_class);
3833 if (IS_ENABLED(CONFIG_OF_DYNAMIC))
3834 WARN_ON(of_reconfig_notifier_register(&spi_of_notifier));
3835 if (IS_ENABLED(CONFIG_ACPI))
3836 WARN_ON(acpi_reconfig_notifier_register(&spi_acpi_notifier));
3841 class_unregister(&spi_master_class);
3843 bus_unregister(&spi_bus_type);
3851 /* board_info is normally registered in arch_initcall(),
3852 * but even essential drivers wait till later
3854 * REVISIT only boardinfo really needs static linking. the rest (device and
3855 * driver registration) _could_ be dynamically linked (modular) ... costs
3856 * include needing to have boardinfo data structures be much more public.
3858 postcore_initcall(spi_init);