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/acpi.h>
8 #include <linux/cache.h>
9 #include <linux/clk/clk-conf.h>
10 #include <linux/delay.h>
11 #include <linux/device.h>
12 #include <linux/dmaengine.h>
13 #include <linux/dma-mapping.h>
14 #include <linux/export.h>
15 #include <linux/gpio/consumer.h>
16 #include <linux/highmem.h>
17 #include <linux/idr.h>
18 #include <linux/init.h>
19 #include <linux/ioport.h>
20 #include <linux/kernel.h>
21 #include <linux/kthread.h>
22 #include <linux/mod_devicetable.h>
23 #include <linux/mutex.h>
24 #include <linux/of_device.h>
25 #include <linux/of_irq.h>
26 #include <linux/percpu.h>
27 #include <linux/platform_data/x86/apple.h>
28 #include <linux/pm_domain.h>
29 #include <linux/pm_runtime.h>
30 #include <linux/property.h>
31 #include <linux/ptp_clock_kernel.h>
32 #include <linux/sched/rt.h>
33 #include <linux/slab.h>
34 #include <linux/spi/spi.h>
35 #include <linux/spi/spi-mem.h>
36 #include <uapi/linux/sched/types.h>
38 #define CREATE_TRACE_POINTS
39 #include <trace/events/spi.h>
40 EXPORT_TRACEPOINT_SYMBOL(spi_transfer_start);
41 EXPORT_TRACEPOINT_SYMBOL(spi_transfer_stop);
43 #include "internals.h"
45 static DEFINE_IDR(spi_master_idr);
47 static void spidev_release(struct device *dev)
49 struct spi_device *spi = to_spi_device(dev);
51 spi_controller_put(spi->controller);
52 kfree(spi->driver_override);
53 free_percpu(spi->pcpu_statistics);
58 modalias_show(struct device *dev, struct device_attribute *a, char *buf)
60 const struct spi_device *spi = to_spi_device(dev);
63 len = acpi_device_modalias(dev, buf, PAGE_SIZE - 1);
67 return sysfs_emit(buf, "%s%s\n", SPI_MODULE_PREFIX, spi->modalias);
69 static DEVICE_ATTR_RO(modalias);
71 static ssize_t driver_override_store(struct device *dev,
72 struct device_attribute *a,
73 const char *buf, size_t count)
75 struct spi_device *spi = to_spi_device(dev);
78 ret = driver_set_override(dev, &spi->driver_override, buf, count);
85 static ssize_t driver_override_show(struct device *dev,
86 struct device_attribute *a, char *buf)
88 const struct spi_device *spi = to_spi_device(dev);
92 len = sysfs_emit(buf, "%s\n", spi->driver_override ? : "");
96 static DEVICE_ATTR_RW(driver_override);
98 static struct spi_statistics __percpu *spi_alloc_pcpu_stats(struct device *dev)
100 struct spi_statistics __percpu *pcpu_stats;
103 pcpu_stats = devm_alloc_percpu(dev, struct spi_statistics);
105 pcpu_stats = alloc_percpu_gfp(struct spi_statistics, GFP_KERNEL);
110 for_each_possible_cpu(cpu) {
111 struct spi_statistics *stat;
113 stat = per_cpu_ptr(pcpu_stats, cpu);
114 u64_stats_init(&stat->syncp);
120 static ssize_t spi_emit_pcpu_stats(struct spi_statistics __percpu *stat,
121 char *buf, size_t offset)
126 for_each_possible_cpu(i) {
127 const struct spi_statistics *pcpu_stats;
132 pcpu_stats = per_cpu_ptr(stat, i);
133 field = (void *)pcpu_stats + offset;
135 start = u64_stats_fetch_begin(&pcpu_stats->syncp);
136 inc = u64_stats_read(field);
137 } while (u64_stats_fetch_retry(&pcpu_stats->syncp, start));
140 return sysfs_emit(buf, "%llu\n", val);
143 #define SPI_STATISTICS_ATTRS(field, file) \
144 static ssize_t spi_controller_##field##_show(struct device *dev, \
145 struct device_attribute *attr, \
148 struct spi_controller *ctlr = container_of(dev, \
149 struct spi_controller, dev); \
150 return spi_statistics_##field##_show(ctlr->pcpu_statistics, buf); \
152 static struct device_attribute dev_attr_spi_controller_##field = { \
153 .attr = { .name = file, .mode = 0444 }, \
154 .show = spi_controller_##field##_show, \
156 static ssize_t spi_device_##field##_show(struct device *dev, \
157 struct device_attribute *attr, \
160 struct spi_device *spi = to_spi_device(dev); \
161 return spi_statistics_##field##_show(spi->pcpu_statistics, buf); \
163 static struct device_attribute dev_attr_spi_device_##field = { \
164 .attr = { .name = file, .mode = 0444 }, \
165 .show = spi_device_##field##_show, \
168 #define SPI_STATISTICS_SHOW_NAME(name, file, field) \
169 static ssize_t spi_statistics_##name##_show(struct spi_statistics __percpu *stat, \
172 return spi_emit_pcpu_stats(stat, buf, \
173 offsetof(struct spi_statistics, field)); \
175 SPI_STATISTICS_ATTRS(name, file)
177 #define SPI_STATISTICS_SHOW(field) \
178 SPI_STATISTICS_SHOW_NAME(field, __stringify(field), \
181 SPI_STATISTICS_SHOW(messages);
182 SPI_STATISTICS_SHOW(transfers);
183 SPI_STATISTICS_SHOW(errors);
184 SPI_STATISTICS_SHOW(timedout);
186 SPI_STATISTICS_SHOW(spi_sync);
187 SPI_STATISTICS_SHOW(spi_sync_immediate);
188 SPI_STATISTICS_SHOW(spi_async);
190 SPI_STATISTICS_SHOW(bytes);
191 SPI_STATISTICS_SHOW(bytes_rx);
192 SPI_STATISTICS_SHOW(bytes_tx);
194 #define SPI_STATISTICS_TRANSFER_BYTES_HISTO(index, number) \
195 SPI_STATISTICS_SHOW_NAME(transfer_bytes_histo##index, \
196 "transfer_bytes_histo_" number, \
197 transfer_bytes_histo[index])
198 SPI_STATISTICS_TRANSFER_BYTES_HISTO(0, "0-1");
199 SPI_STATISTICS_TRANSFER_BYTES_HISTO(1, "2-3");
200 SPI_STATISTICS_TRANSFER_BYTES_HISTO(2, "4-7");
201 SPI_STATISTICS_TRANSFER_BYTES_HISTO(3, "8-15");
202 SPI_STATISTICS_TRANSFER_BYTES_HISTO(4, "16-31");
203 SPI_STATISTICS_TRANSFER_BYTES_HISTO(5, "32-63");
204 SPI_STATISTICS_TRANSFER_BYTES_HISTO(6, "64-127");
205 SPI_STATISTICS_TRANSFER_BYTES_HISTO(7, "128-255");
206 SPI_STATISTICS_TRANSFER_BYTES_HISTO(8, "256-511");
207 SPI_STATISTICS_TRANSFER_BYTES_HISTO(9, "512-1023");
208 SPI_STATISTICS_TRANSFER_BYTES_HISTO(10, "1024-2047");
209 SPI_STATISTICS_TRANSFER_BYTES_HISTO(11, "2048-4095");
210 SPI_STATISTICS_TRANSFER_BYTES_HISTO(12, "4096-8191");
211 SPI_STATISTICS_TRANSFER_BYTES_HISTO(13, "8192-16383");
212 SPI_STATISTICS_TRANSFER_BYTES_HISTO(14, "16384-32767");
213 SPI_STATISTICS_TRANSFER_BYTES_HISTO(15, "32768-65535");
214 SPI_STATISTICS_TRANSFER_BYTES_HISTO(16, "65536+");
216 SPI_STATISTICS_SHOW(transfers_split_maxsize);
218 static struct attribute *spi_dev_attrs[] = {
219 &dev_attr_modalias.attr,
220 &dev_attr_driver_override.attr,
224 static const struct attribute_group spi_dev_group = {
225 .attrs = spi_dev_attrs,
228 static struct attribute *spi_device_statistics_attrs[] = {
229 &dev_attr_spi_device_messages.attr,
230 &dev_attr_spi_device_transfers.attr,
231 &dev_attr_spi_device_errors.attr,
232 &dev_attr_spi_device_timedout.attr,
233 &dev_attr_spi_device_spi_sync.attr,
234 &dev_attr_spi_device_spi_sync_immediate.attr,
235 &dev_attr_spi_device_spi_async.attr,
236 &dev_attr_spi_device_bytes.attr,
237 &dev_attr_spi_device_bytes_rx.attr,
238 &dev_attr_spi_device_bytes_tx.attr,
239 &dev_attr_spi_device_transfer_bytes_histo0.attr,
240 &dev_attr_spi_device_transfer_bytes_histo1.attr,
241 &dev_attr_spi_device_transfer_bytes_histo2.attr,
242 &dev_attr_spi_device_transfer_bytes_histo3.attr,
243 &dev_attr_spi_device_transfer_bytes_histo4.attr,
244 &dev_attr_spi_device_transfer_bytes_histo5.attr,
245 &dev_attr_spi_device_transfer_bytes_histo6.attr,
246 &dev_attr_spi_device_transfer_bytes_histo7.attr,
247 &dev_attr_spi_device_transfer_bytes_histo8.attr,
248 &dev_attr_spi_device_transfer_bytes_histo9.attr,
249 &dev_attr_spi_device_transfer_bytes_histo10.attr,
250 &dev_attr_spi_device_transfer_bytes_histo11.attr,
251 &dev_attr_spi_device_transfer_bytes_histo12.attr,
252 &dev_attr_spi_device_transfer_bytes_histo13.attr,
253 &dev_attr_spi_device_transfer_bytes_histo14.attr,
254 &dev_attr_spi_device_transfer_bytes_histo15.attr,
255 &dev_attr_spi_device_transfer_bytes_histo16.attr,
256 &dev_attr_spi_device_transfers_split_maxsize.attr,
260 static const struct attribute_group spi_device_statistics_group = {
261 .name = "statistics",
262 .attrs = spi_device_statistics_attrs,
265 static const struct attribute_group *spi_dev_groups[] = {
267 &spi_device_statistics_group,
271 static struct attribute *spi_controller_statistics_attrs[] = {
272 &dev_attr_spi_controller_messages.attr,
273 &dev_attr_spi_controller_transfers.attr,
274 &dev_attr_spi_controller_errors.attr,
275 &dev_attr_spi_controller_timedout.attr,
276 &dev_attr_spi_controller_spi_sync.attr,
277 &dev_attr_spi_controller_spi_sync_immediate.attr,
278 &dev_attr_spi_controller_spi_async.attr,
279 &dev_attr_spi_controller_bytes.attr,
280 &dev_attr_spi_controller_bytes_rx.attr,
281 &dev_attr_spi_controller_bytes_tx.attr,
282 &dev_attr_spi_controller_transfer_bytes_histo0.attr,
283 &dev_attr_spi_controller_transfer_bytes_histo1.attr,
284 &dev_attr_spi_controller_transfer_bytes_histo2.attr,
285 &dev_attr_spi_controller_transfer_bytes_histo3.attr,
286 &dev_attr_spi_controller_transfer_bytes_histo4.attr,
287 &dev_attr_spi_controller_transfer_bytes_histo5.attr,
288 &dev_attr_spi_controller_transfer_bytes_histo6.attr,
289 &dev_attr_spi_controller_transfer_bytes_histo7.attr,
290 &dev_attr_spi_controller_transfer_bytes_histo8.attr,
291 &dev_attr_spi_controller_transfer_bytes_histo9.attr,
292 &dev_attr_spi_controller_transfer_bytes_histo10.attr,
293 &dev_attr_spi_controller_transfer_bytes_histo11.attr,
294 &dev_attr_spi_controller_transfer_bytes_histo12.attr,
295 &dev_attr_spi_controller_transfer_bytes_histo13.attr,
296 &dev_attr_spi_controller_transfer_bytes_histo14.attr,
297 &dev_attr_spi_controller_transfer_bytes_histo15.attr,
298 &dev_attr_spi_controller_transfer_bytes_histo16.attr,
299 &dev_attr_spi_controller_transfers_split_maxsize.attr,
303 static const struct attribute_group spi_controller_statistics_group = {
304 .name = "statistics",
305 .attrs = spi_controller_statistics_attrs,
308 static const struct attribute_group *spi_master_groups[] = {
309 &spi_controller_statistics_group,
313 static void spi_statistics_add_transfer_stats(struct spi_statistics __percpu *pcpu_stats,
314 struct spi_transfer *xfer,
315 struct spi_controller *ctlr)
317 int l2len = min(fls(xfer->len), SPI_STATISTICS_HISTO_SIZE) - 1;
318 struct spi_statistics *stats;
324 stats = this_cpu_ptr(pcpu_stats);
325 u64_stats_update_begin(&stats->syncp);
327 u64_stats_inc(&stats->transfers);
328 u64_stats_inc(&stats->transfer_bytes_histo[l2len]);
330 u64_stats_add(&stats->bytes, xfer->len);
331 if ((xfer->tx_buf) &&
332 (xfer->tx_buf != ctlr->dummy_tx))
333 u64_stats_add(&stats->bytes_tx, xfer->len);
334 if ((xfer->rx_buf) &&
335 (xfer->rx_buf != ctlr->dummy_rx))
336 u64_stats_add(&stats->bytes_rx, xfer->len);
338 u64_stats_update_end(&stats->syncp);
343 * modalias support makes "modprobe $MODALIAS" new-style hotplug work,
344 * and the sysfs version makes coldplug work too.
346 static const struct spi_device_id *spi_match_id(const struct spi_device_id *id, const char *name)
348 while (id->name[0]) {
349 if (!strcmp(name, id->name))
356 const struct spi_device_id *spi_get_device_id(const struct spi_device *sdev)
358 const struct spi_driver *sdrv = to_spi_driver(sdev->dev.driver);
360 return spi_match_id(sdrv->id_table, sdev->modalias);
362 EXPORT_SYMBOL_GPL(spi_get_device_id);
364 const void *spi_get_device_match_data(const struct spi_device *sdev)
368 match = device_get_match_data(&sdev->dev);
372 return (const void *)spi_get_device_id(sdev)->driver_data;
374 EXPORT_SYMBOL_GPL(spi_get_device_match_data);
376 static int spi_match_device(struct device *dev, struct device_driver *drv)
378 const struct spi_device *spi = to_spi_device(dev);
379 const struct spi_driver *sdrv = to_spi_driver(drv);
381 /* Check override first, and if set, only use the named driver */
382 if (spi->driver_override)
383 return strcmp(spi->driver_override, drv->name) == 0;
385 /* Attempt an OF style match */
386 if (of_driver_match_device(dev, drv))
390 if (acpi_driver_match_device(dev, drv))
394 return !!spi_match_id(sdrv->id_table, spi->modalias);
396 return strcmp(spi->modalias, drv->name) == 0;
399 static int spi_uevent(const struct device *dev, struct kobj_uevent_env *env)
401 const struct spi_device *spi = to_spi_device(dev);
404 rc = acpi_device_uevent_modalias(dev, env);
408 return add_uevent_var(env, "MODALIAS=%s%s", SPI_MODULE_PREFIX, spi->modalias);
411 static int spi_probe(struct device *dev)
413 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
414 struct spi_device *spi = to_spi_device(dev);
417 ret = of_clk_set_defaults(dev->of_node, false);
422 spi->irq = of_irq_get(dev->of_node, 0);
423 if (spi->irq == -EPROBE_DEFER)
424 return -EPROBE_DEFER;
429 ret = dev_pm_domain_attach(dev, true);
434 ret = sdrv->probe(spi);
436 dev_pm_domain_detach(dev, true);
442 static void spi_remove(struct device *dev)
444 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
447 sdrv->remove(to_spi_device(dev));
449 dev_pm_domain_detach(dev, true);
452 static void spi_shutdown(struct device *dev)
455 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
458 sdrv->shutdown(to_spi_device(dev));
462 struct bus_type spi_bus_type = {
464 .dev_groups = spi_dev_groups,
465 .match = spi_match_device,
466 .uevent = spi_uevent,
468 .remove = spi_remove,
469 .shutdown = spi_shutdown,
471 EXPORT_SYMBOL_GPL(spi_bus_type);
474 * __spi_register_driver - register a SPI driver
475 * @owner: owner module of the driver to register
476 * @sdrv: the driver to register
479 * Return: zero on success, else a negative error code.
481 int __spi_register_driver(struct module *owner, struct spi_driver *sdrv)
483 sdrv->driver.owner = owner;
484 sdrv->driver.bus = &spi_bus_type;
487 * For Really Good Reasons we use spi: modaliases not of:
488 * modaliases for DT so module autoloading won't work if we
489 * don't have a spi_device_id as well as a compatible string.
491 if (sdrv->driver.of_match_table) {
492 const struct of_device_id *of_id;
494 for (of_id = sdrv->driver.of_match_table; of_id->compatible[0];
498 /* Strip off any vendor prefix */
499 of_name = strnchr(of_id->compatible,
500 sizeof(of_id->compatible), ',');
504 of_name = of_id->compatible;
506 if (sdrv->id_table) {
507 const struct spi_device_id *spi_id;
509 spi_id = spi_match_id(sdrv->id_table, of_name);
513 if (strcmp(sdrv->driver.name, of_name) == 0)
517 pr_warn("SPI driver %s has no spi_device_id for %s\n",
518 sdrv->driver.name, of_id->compatible);
522 return driver_register(&sdrv->driver);
524 EXPORT_SYMBOL_GPL(__spi_register_driver);
526 /*-------------------------------------------------------------------------*/
529 * SPI devices should normally not be created by SPI device drivers; that
530 * would make them board-specific. Similarly with SPI controller drivers.
531 * Device registration normally goes into like arch/.../mach.../board-YYY.c
532 * with other readonly (flashable) information about mainboard devices.
536 struct list_head list;
537 struct spi_board_info board_info;
540 static LIST_HEAD(board_list);
541 static LIST_HEAD(spi_controller_list);
544 * Used to protect add/del operation for board_info list and
545 * spi_controller list, and their matching process also used
546 * to protect object of type struct idr.
548 static DEFINE_MUTEX(board_lock);
551 * spi_alloc_device - Allocate a new SPI device
552 * @ctlr: Controller to which device is connected
555 * Allows a driver to allocate and initialize a spi_device without
556 * registering it immediately. This allows a driver to directly
557 * fill the spi_device with device parameters before calling
558 * spi_add_device() on it.
560 * Caller is responsible to call spi_add_device() on the returned
561 * spi_device structure to add it to the SPI controller. If the caller
562 * needs to discard the spi_device without adding it, then it should
563 * call spi_dev_put() on it.
565 * Return: a pointer to the new device, or NULL.
567 struct spi_device *spi_alloc_device(struct spi_controller *ctlr)
569 struct spi_device *spi;
571 if (!spi_controller_get(ctlr))
574 spi = kzalloc(sizeof(*spi), GFP_KERNEL);
576 spi_controller_put(ctlr);
580 spi->pcpu_statistics = spi_alloc_pcpu_stats(NULL);
581 if (!spi->pcpu_statistics) {
583 spi_controller_put(ctlr);
587 spi->master = spi->controller = ctlr;
588 spi->dev.parent = &ctlr->dev;
589 spi->dev.bus = &spi_bus_type;
590 spi->dev.release = spidev_release;
591 spi->mode = ctlr->buswidth_override_bits;
593 device_initialize(&spi->dev);
596 EXPORT_SYMBOL_GPL(spi_alloc_device);
598 static void spi_dev_set_name(struct spi_device *spi)
600 struct acpi_device *adev = ACPI_COMPANION(&spi->dev);
603 dev_set_name(&spi->dev, "spi-%s", acpi_dev_name(adev));
607 dev_set_name(&spi->dev, "%s.%u", dev_name(&spi->controller->dev),
608 spi_get_chipselect(spi, 0));
611 static int spi_dev_check(struct device *dev, void *data)
613 struct spi_device *spi = to_spi_device(dev);
614 struct spi_device *new_spi = data;
618 if (spi->controller == new_spi->controller) {
619 for (idx = 0; idx < SPI_CS_CNT_MAX; idx++) {
620 cs = spi_get_chipselect(spi, idx);
621 for (nw_idx = 0; nw_idx < SPI_CS_CNT_MAX; nw_idx++) {
622 cs_nw = spi_get_chipselect(new_spi, nw_idx);
623 if (cs != 0xFF && cs_nw != 0xFF && cs == cs_nw) {
624 dev_err(dev, "chipselect %d already in use\n", cs_nw);
633 static void spi_cleanup(struct spi_device *spi)
635 if (spi->controller->cleanup)
636 spi->controller->cleanup(spi);
639 static int __spi_add_device(struct spi_device *spi)
641 struct spi_controller *ctlr = spi->controller;
642 struct device *dev = ctlr->dev.parent;
643 int status, idx, nw_idx;
646 for (idx = 0; idx < SPI_CS_CNT_MAX; idx++) {
647 /* Chipselects are numbered 0..max; validate. */
648 cs = spi_get_chipselect(spi, idx);
649 if (cs != 0xFF && cs >= ctlr->num_chipselect) {
650 dev_err(dev, "cs%d >= max %d\n", spi_get_chipselect(spi, idx),
651 ctlr->num_chipselect);
657 * Make sure that multiple logical CS doesn't map to the same physical CS.
658 * For example, spi->chip_select[0] != spi->chip_select[1] and so on.
660 for (idx = 0; idx < SPI_CS_CNT_MAX; idx++) {
661 cs = spi_get_chipselect(spi, idx);
662 for (nw_idx = idx + 1; nw_idx < SPI_CS_CNT_MAX; nw_idx++) {
663 nw_cs = spi_get_chipselect(spi, nw_idx);
664 if (cs != 0xFF && nw_cs != 0xFF && cs == nw_cs) {
665 dev_err(dev, "chipselect %d already in use\n", nw_cs);
671 /* Set the bus ID string */
672 spi_dev_set_name(spi);
675 * We need to make sure there's no other device with this
676 * chipselect **BEFORE** we call setup(), else we'll trash
679 status = bus_for_each_dev(&spi_bus_type, NULL, spi, spi_dev_check);
683 /* Controller may unregister concurrently */
684 if (IS_ENABLED(CONFIG_SPI_DYNAMIC) &&
685 !device_is_registered(&ctlr->dev)) {
689 if (ctlr->cs_gpiods) {
692 for (idx = 0; idx < SPI_CS_CNT_MAX; idx++) {
693 cs = spi_get_chipselect(spi, idx);
695 spi_set_csgpiod(spi, idx, ctlr->cs_gpiods[cs]);
700 * Drivers may modify this initial i/o setup, but will
701 * normally rely on the device being setup. Devices
702 * using SPI_CS_HIGH can't coexist well otherwise...
704 status = spi_setup(spi);
706 dev_err(dev, "can't setup %s, status %d\n",
707 dev_name(&spi->dev), status);
711 /* Device may be bound to an active driver when this returns */
712 status = device_add(&spi->dev);
714 dev_err(dev, "can't add %s, status %d\n",
715 dev_name(&spi->dev), status);
718 dev_dbg(dev, "registered child %s\n", dev_name(&spi->dev));
725 * spi_add_device - Add spi_device allocated with spi_alloc_device
726 * @spi: spi_device to register
728 * Companion function to spi_alloc_device. Devices allocated with
729 * spi_alloc_device can be added onto the SPI bus with this function.
731 * Return: 0 on success; negative errno on failure
733 int spi_add_device(struct spi_device *spi)
735 struct spi_controller *ctlr = spi->controller;
738 /* Set the bus ID string */
739 spi_dev_set_name(spi);
741 mutex_lock(&ctlr->add_lock);
742 status = __spi_add_device(spi);
743 mutex_unlock(&ctlr->add_lock);
746 EXPORT_SYMBOL_GPL(spi_add_device);
749 * spi_new_device - instantiate one new SPI device
750 * @ctlr: Controller to which device is connected
751 * @chip: Describes the SPI device
754 * On typical mainboards, this is purely internal; and it's not needed
755 * after board init creates the hard-wired devices. Some development
756 * platforms may not be able to use spi_register_board_info though, and
757 * this is exported so that for example a USB or parport based adapter
758 * driver could add devices (which it would learn about out-of-band).
760 * Return: the new device, or NULL.
762 struct spi_device *spi_new_device(struct spi_controller *ctlr,
763 struct spi_board_info *chip)
765 struct spi_device *proxy;
770 * NOTE: caller did any chip->bus_num checks necessary.
772 * Also, unless we change the return value convention to use
773 * error-or-pointer (not NULL-or-pointer), troubleshootability
774 * suggests syslogged diagnostics are best here (ugh).
777 proxy = spi_alloc_device(ctlr);
781 WARN_ON(strlen(chip->modalias) >= sizeof(proxy->modalias));
784 * Zero(0) is a valid physical CS value and can be located at any
785 * logical CS in the spi->chip_select[]. If all the physical CS
786 * are initialized to 0 then It would be difficult to differentiate
787 * between a valid physical CS 0 & an unused logical CS whose physical
788 * CS can be 0. As a solution to this issue initialize all the CS to 0xFF.
789 * Now all the unused logical CS will have 0xFF physical CS value & can be
790 * ignore while performing physical CS validity checks.
792 for (idx = 0; idx < SPI_CS_CNT_MAX; idx++)
793 spi_set_chipselect(proxy, idx, 0xFF);
795 spi_set_chipselect(proxy, 0, chip->chip_select);
796 proxy->max_speed_hz = chip->max_speed_hz;
797 proxy->mode = chip->mode;
798 proxy->irq = chip->irq;
799 strscpy(proxy->modalias, chip->modalias, sizeof(proxy->modalias));
800 proxy->dev.platform_data = (void *) chip->platform_data;
801 proxy->controller_data = chip->controller_data;
802 proxy->controller_state = NULL;
804 * spi->chip_select[i] gives the corresponding physical CS for logical CS i
805 * logical CS number is represented by setting the ith bit in spi->cs_index_mask
806 * So, for example, if spi->cs_index_mask = 0x01 then logical CS number is 0 and
807 * spi->chip_select[0] will give the physical CS.
808 * By default spi->chip_select[0] will hold the physical CS number so, set
809 * spi->cs_index_mask as 0x01.
811 proxy->cs_index_mask = 0x01;
814 status = device_add_software_node(&proxy->dev, chip->swnode);
816 dev_err(&ctlr->dev, "failed to add software node to '%s': %d\n",
817 chip->modalias, status);
822 status = spi_add_device(proxy);
829 device_remove_software_node(&proxy->dev);
833 EXPORT_SYMBOL_GPL(spi_new_device);
836 * spi_unregister_device - unregister a single SPI device
837 * @spi: spi_device to unregister
839 * Start making the passed SPI device vanish. Normally this would be handled
840 * by spi_unregister_controller().
842 void spi_unregister_device(struct spi_device *spi)
847 if (spi->dev.of_node) {
848 of_node_clear_flag(spi->dev.of_node, OF_POPULATED);
849 of_node_put(spi->dev.of_node);
851 if (ACPI_COMPANION(&spi->dev))
852 acpi_device_clear_enumerated(ACPI_COMPANION(&spi->dev));
853 device_remove_software_node(&spi->dev);
854 device_del(&spi->dev);
856 put_device(&spi->dev);
858 EXPORT_SYMBOL_GPL(spi_unregister_device);
860 static void spi_match_controller_to_boardinfo(struct spi_controller *ctlr,
861 struct spi_board_info *bi)
863 struct spi_device *dev;
865 if (ctlr->bus_num != bi->bus_num)
868 dev = spi_new_device(ctlr, bi);
870 dev_err(ctlr->dev.parent, "can't create new device for %s\n",
875 * spi_register_board_info - register SPI devices for a given board
876 * @info: array of chip descriptors
877 * @n: how many descriptors are provided
880 * Board-specific early init code calls this (probably during arch_initcall)
881 * with segments of the SPI device table. Any device nodes are created later,
882 * after the relevant parent SPI controller (bus_num) is defined. We keep
883 * this table of devices forever, so that reloading a controller driver will
884 * not make Linux forget about these hard-wired devices.
886 * Other code can also call this, e.g. a particular add-on board might provide
887 * SPI devices through its expansion connector, so code initializing that board
888 * would naturally declare its SPI devices.
890 * The board info passed can safely be __initdata ... but be careful of
891 * any embedded pointers (platform_data, etc), they're copied as-is.
893 * Return: zero on success, else a negative error code.
895 int spi_register_board_info(struct spi_board_info const *info, unsigned n)
897 struct boardinfo *bi;
903 bi = kcalloc(n, sizeof(*bi), GFP_KERNEL);
907 for (i = 0; i < n; i++, bi++, info++) {
908 struct spi_controller *ctlr;
910 memcpy(&bi->board_info, info, sizeof(*info));
912 mutex_lock(&board_lock);
913 list_add_tail(&bi->list, &board_list);
914 list_for_each_entry(ctlr, &spi_controller_list, list)
915 spi_match_controller_to_boardinfo(ctlr,
917 mutex_unlock(&board_lock);
923 /*-------------------------------------------------------------------------*/
925 /* Core methods for SPI resource management */
928 * spi_res_alloc - allocate a spi resource that is life-cycle managed
929 * during the processing of a spi_message while using
931 * @spi: the SPI device for which we allocate memory
932 * @release: the release code to execute for this resource
933 * @size: size to alloc and return
934 * @gfp: GFP allocation flags
936 * Return: the pointer to the allocated data
938 * This may get enhanced in the future to allocate from a memory pool
939 * of the @spi_device or @spi_controller to avoid repeated allocations.
941 static void *spi_res_alloc(struct spi_device *spi, spi_res_release_t release,
942 size_t size, gfp_t gfp)
944 struct spi_res *sres;
946 sres = kzalloc(sizeof(*sres) + size, gfp);
950 INIT_LIST_HEAD(&sres->entry);
951 sres->release = release;
957 * spi_res_free - free an SPI resource
958 * @res: pointer to the custom data of a resource
960 static void spi_res_free(void *res)
962 struct spi_res *sres = container_of(res, struct spi_res, data);
967 WARN_ON(!list_empty(&sres->entry));
972 * spi_res_add - add a spi_res to the spi_message
973 * @message: the SPI message
974 * @res: the spi_resource
976 static void spi_res_add(struct spi_message *message, void *res)
978 struct spi_res *sres = container_of(res, struct spi_res, data);
980 WARN_ON(!list_empty(&sres->entry));
981 list_add_tail(&sres->entry, &message->resources);
985 * spi_res_release - release all SPI resources for this message
986 * @ctlr: the @spi_controller
987 * @message: the @spi_message
989 static void spi_res_release(struct spi_controller *ctlr, struct spi_message *message)
991 struct spi_res *res, *tmp;
993 list_for_each_entry_safe_reverse(res, tmp, &message->resources, entry) {
995 res->release(ctlr, message, res->data);
997 list_del(&res->entry);
1003 /*-------------------------------------------------------------------------*/
1004 static inline bool spi_is_last_cs(struct spi_device *spi)
1009 for (idx = 0; idx < SPI_CS_CNT_MAX; idx++) {
1010 if ((spi->cs_index_mask >> idx) & 0x01) {
1011 if (spi->controller->last_cs[idx] == spi_get_chipselect(spi, idx))
1019 static void spi_set_cs(struct spi_device *spi, bool enable, bool force)
1021 bool activate = enable;
1025 * Avoid calling into the driver (or doing delays) if the chip select
1026 * isn't actually changing from the last time this was called.
1028 if (!force && ((enable && spi->controller->last_cs_index_mask == spi->cs_index_mask &&
1029 spi_is_last_cs(spi)) ||
1030 (!enable && spi->controller->last_cs_index_mask == spi->cs_index_mask &&
1031 !spi_is_last_cs(spi))) &&
1032 (spi->controller->last_cs_mode_high == (spi->mode & SPI_CS_HIGH)))
1035 trace_spi_set_cs(spi, activate);
1037 spi->controller->last_cs_index_mask = spi->cs_index_mask;
1038 for (idx = 0; idx < SPI_CS_CNT_MAX; idx++)
1039 spi->controller->last_cs[idx] = enable ? spi_get_chipselect(spi, 0) : -1;
1040 spi->controller->last_cs_mode_high = spi->mode & SPI_CS_HIGH;
1042 if (spi->mode & SPI_CS_HIGH)
1045 if (spi_is_csgpiod(spi)) {
1046 if (!spi->controller->set_cs_timing && !activate)
1047 spi_delay_exec(&spi->cs_hold, NULL);
1049 if (!(spi->mode & SPI_NO_CS)) {
1051 * Historically ACPI has no means of the GPIO polarity and
1052 * thus the SPISerialBus() resource defines it on the per-chip
1053 * basis. In order to avoid a chain of negations, the GPIO
1054 * polarity is considered being Active High. Even for the cases
1055 * when _DSD() is involved (in the updated versions of ACPI)
1056 * the GPIO CS polarity must be defined Active High to avoid
1057 * ambiguity. That's why we use enable, that takes SPI_CS_HIGH
1060 for (idx = 0; idx < SPI_CS_CNT_MAX; idx++) {
1061 if (((spi->cs_index_mask >> idx) & 0x01) &&
1062 spi_get_csgpiod(spi, idx)) {
1063 if (has_acpi_companion(&spi->dev))
1064 gpiod_set_value_cansleep(spi_get_csgpiod(spi, idx),
1067 /* Polarity handled by GPIO library */
1068 gpiod_set_value_cansleep(spi_get_csgpiod(spi, idx),
1072 spi_delay_exec(&spi->cs_setup, NULL);
1074 spi_delay_exec(&spi->cs_inactive, NULL);
1078 /* Some SPI masters need both GPIO CS & slave_select */
1079 if ((spi->controller->flags & SPI_CONTROLLER_GPIO_SS) &&
1080 spi->controller->set_cs)
1081 spi->controller->set_cs(spi, !enable);
1083 if (!spi->controller->set_cs_timing) {
1085 spi_delay_exec(&spi->cs_setup, NULL);
1087 spi_delay_exec(&spi->cs_inactive, NULL);
1089 } else if (spi->controller->set_cs) {
1090 spi->controller->set_cs(spi, !enable);
1094 #ifdef CONFIG_HAS_DMA
1095 static int spi_map_buf_attrs(struct spi_controller *ctlr, struct device *dev,
1096 struct sg_table *sgt, void *buf, size_t len,
1097 enum dma_data_direction dir, unsigned long attrs)
1099 const bool vmalloced_buf = is_vmalloc_addr(buf);
1100 unsigned int max_seg_size = dma_get_max_seg_size(dev);
1101 #ifdef CONFIG_HIGHMEM
1102 const bool kmap_buf = ((unsigned long)buf >= PKMAP_BASE &&
1103 (unsigned long)buf < (PKMAP_BASE +
1104 (LAST_PKMAP * PAGE_SIZE)));
1106 const bool kmap_buf = false;
1110 struct page *vm_page;
1111 struct scatterlist *sg;
1116 if (vmalloced_buf || kmap_buf) {
1117 desc_len = min_t(unsigned long, max_seg_size, PAGE_SIZE);
1118 sgs = DIV_ROUND_UP(len + offset_in_page(buf), desc_len);
1119 } else if (virt_addr_valid(buf)) {
1120 desc_len = min_t(size_t, max_seg_size, ctlr->max_dma_len);
1121 sgs = DIV_ROUND_UP(len, desc_len);
1126 ret = sg_alloc_table(sgt, sgs, GFP_KERNEL);
1131 for (i = 0; i < sgs; i++) {
1133 if (vmalloced_buf || kmap_buf) {
1135 * Next scatterlist entry size is the minimum between
1136 * the desc_len and the remaining buffer length that
1139 min = min_t(size_t, desc_len,
1141 PAGE_SIZE - offset_in_page(buf)));
1143 vm_page = vmalloc_to_page(buf);
1145 vm_page = kmap_to_page(buf);
1150 sg_set_page(sg, vm_page,
1151 min, offset_in_page(buf));
1153 min = min_t(size_t, len, desc_len);
1155 sg_set_buf(sg, sg_buf, min);
1163 ret = dma_map_sgtable(dev, sgt, dir, attrs);
1172 int spi_map_buf(struct spi_controller *ctlr, struct device *dev,
1173 struct sg_table *sgt, void *buf, size_t len,
1174 enum dma_data_direction dir)
1176 return spi_map_buf_attrs(ctlr, dev, sgt, buf, len, dir, 0);
1179 static void spi_unmap_buf_attrs(struct spi_controller *ctlr,
1180 struct device *dev, struct sg_table *sgt,
1181 enum dma_data_direction dir,
1182 unsigned long attrs)
1184 if (sgt->orig_nents) {
1185 dma_unmap_sgtable(dev, sgt, dir, attrs);
1187 sgt->orig_nents = 0;
1192 void spi_unmap_buf(struct spi_controller *ctlr, struct device *dev,
1193 struct sg_table *sgt, enum dma_data_direction dir)
1195 spi_unmap_buf_attrs(ctlr, dev, sgt, dir, 0);
1198 static int __spi_map_msg(struct spi_controller *ctlr, struct spi_message *msg)
1200 struct device *tx_dev, *rx_dev;
1201 struct spi_transfer *xfer;
1208 tx_dev = ctlr->dma_tx->device->dev;
1209 else if (ctlr->dma_map_dev)
1210 tx_dev = ctlr->dma_map_dev;
1212 tx_dev = ctlr->dev.parent;
1215 rx_dev = ctlr->dma_rx->device->dev;
1216 else if (ctlr->dma_map_dev)
1217 rx_dev = ctlr->dma_map_dev;
1219 rx_dev = ctlr->dev.parent;
1221 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
1222 /* The sync is done before each transfer. */
1223 unsigned long attrs = DMA_ATTR_SKIP_CPU_SYNC;
1225 if (!ctlr->can_dma(ctlr, msg->spi, xfer))
1228 if (xfer->tx_buf != NULL) {
1229 ret = spi_map_buf_attrs(ctlr, tx_dev, &xfer->tx_sg,
1230 (void *)xfer->tx_buf,
1231 xfer->len, DMA_TO_DEVICE,
1237 if (xfer->rx_buf != NULL) {
1238 ret = spi_map_buf_attrs(ctlr, rx_dev, &xfer->rx_sg,
1239 xfer->rx_buf, xfer->len,
1240 DMA_FROM_DEVICE, attrs);
1242 spi_unmap_buf_attrs(ctlr, tx_dev,
1243 &xfer->tx_sg, DMA_TO_DEVICE,
1251 ctlr->cur_rx_dma_dev = rx_dev;
1252 ctlr->cur_tx_dma_dev = tx_dev;
1253 ctlr->cur_msg_mapped = true;
1258 static int __spi_unmap_msg(struct spi_controller *ctlr, struct spi_message *msg)
1260 struct device *rx_dev = ctlr->cur_rx_dma_dev;
1261 struct device *tx_dev = ctlr->cur_tx_dma_dev;
1262 struct spi_transfer *xfer;
1264 if (!ctlr->cur_msg_mapped || !ctlr->can_dma)
1267 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
1268 /* The sync has already been done after each transfer. */
1269 unsigned long attrs = DMA_ATTR_SKIP_CPU_SYNC;
1271 if (!ctlr->can_dma(ctlr, msg->spi, xfer))
1274 spi_unmap_buf_attrs(ctlr, rx_dev, &xfer->rx_sg,
1275 DMA_FROM_DEVICE, attrs);
1276 spi_unmap_buf_attrs(ctlr, tx_dev, &xfer->tx_sg,
1277 DMA_TO_DEVICE, attrs);
1280 ctlr->cur_msg_mapped = false;
1285 static void spi_dma_sync_for_device(struct spi_controller *ctlr,
1286 struct spi_transfer *xfer)
1288 struct device *rx_dev = ctlr->cur_rx_dma_dev;
1289 struct device *tx_dev = ctlr->cur_tx_dma_dev;
1291 if (!ctlr->cur_msg_mapped)
1294 if (xfer->tx_sg.orig_nents)
1295 dma_sync_sgtable_for_device(tx_dev, &xfer->tx_sg, DMA_TO_DEVICE);
1296 if (xfer->rx_sg.orig_nents)
1297 dma_sync_sgtable_for_device(rx_dev, &xfer->rx_sg, DMA_FROM_DEVICE);
1300 static void spi_dma_sync_for_cpu(struct spi_controller *ctlr,
1301 struct spi_transfer *xfer)
1303 struct device *rx_dev = ctlr->cur_rx_dma_dev;
1304 struct device *tx_dev = ctlr->cur_tx_dma_dev;
1306 if (!ctlr->cur_msg_mapped)
1309 if (xfer->rx_sg.orig_nents)
1310 dma_sync_sgtable_for_cpu(rx_dev, &xfer->rx_sg, DMA_FROM_DEVICE);
1311 if (xfer->tx_sg.orig_nents)
1312 dma_sync_sgtable_for_cpu(tx_dev, &xfer->tx_sg, DMA_TO_DEVICE);
1314 #else /* !CONFIG_HAS_DMA */
1315 static inline int __spi_map_msg(struct spi_controller *ctlr,
1316 struct spi_message *msg)
1321 static inline int __spi_unmap_msg(struct spi_controller *ctlr,
1322 struct spi_message *msg)
1327 static void spi_dma_sync_for_device(struct spi_controller *ctrl,
1328 struct spi_transfer *xfer)
1332 static void spi_dma_sync_for_cpu(struct spi_controller *ctrl,
1333 struct spi_transfer *xfer)
1336 #endif /* !CONFIG_HAS_DMA */
1338 static inline int spi_unmap_msg(struct spi_controller *ctlr,
1339 struct spi_message *msg)
1341 struct spi_transfer *xfer;
1343 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
1345 * Restore the original value of tx_buf or rx_buf if they are
1348 if (xfer->tx_buf == ctlr->dummy_tx)
1349 xfer->tx_buf = NULL;
1350 if (xfer->rx_buf == ctlr->dummy_rx)
1351 xfer->rx_buf = NULL;
1354 return __spi_unmap_msg(ctlr, msg);
1357 static int spi_map_msg(struct spi_controller *ctlr, struct spi_message *msg)
1359 struct spi_transfer *xfer;
1361 unsigned int max_tx, max_rx;
1363 if ((ctlr->flags & (SPI_CONTROLLER_MUST_RX | SPI_CONTROLLER_MUST_TX))
1364 && !(msg->spi->mode & SPI_3WIRE)) {
1368 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
1369 if ((ctlr->flags & SPI_CONTROLLER_MUST_TX) &&
1371 max_tx = max(xfer->len, max_tx);
1372 if ((ctlr->flags & SPI_CONTROLLER_MUST_RX) &&
1374 max_rx = max(xfer->len, max_rx);
1378 tmp = krealloc(ctlr->dummy_tx, max_tx,
1379 GFP_KERNEL | GFP_DMA | __GFP_ZERO);
1382 ctlr->dummy_tx = tmp;
1386 tmp = krealloc(ctlr->dummy_rx, max_rx,
1387 GFP_KERNEL | GFP_DMA);
1390 ctlr->dummy_rx = tmp;
1393 if (max_tx || max_rx) {
1394 list_for_each_entry(xfer, &msg->transfers,
1399 xfer->tx_buf = ctlr->dummy_tx;
1401 xfer->rx_buf = ctlr->dummy_rx;
1406 return __spi_map_msg(ctlr, msg);
1409 static int spi_transfer_wait(struct spi_controller *ctlr,
1410 struct spi_message *msg,
1411 struct spi_transfer *xfer)
1413 struct spi_statistics __percpu *statm = ctlr->pcpu_statistics;
1414 struct spi_statistics __percpu *stats = msg->spi->pcpu_statistics;
1415 u32 speed_hz = xfer->speed_hz;
1416 unsigned long long ms;
1418 if (spi_controller_is_slave(ctlr)) {
1419 if (wait_for_completion_interruptible(&ctlr->xfer_completion)) {
1420 dev_dbg(&msg->spi->dev, "SPI transfer interrupted\n");
1428 * For each byte we wait for 8 cycles of the SPI clock.
1429 * Since speed is defined in Hz and we want milliseconds,
1430 * use respective multiplier, but before the division,
1431 * otherwise we may get 0 for short transfers.
1433 ms = 8LL * MSEC_PER_SEC * xfer->len;
1434 do_div(ms, speed_hz);
1437 * Increase it twice and add 200 ms tolerance, use
1438 * predefined maximum in case of overflow.
1444 ms = wait_for_completion_timeout(&ctlr->xfer_completion,
1445 msecs_to_jiffies(ms));
1448 SPI_STATISTICS_INCREMENT_FIELD(statm, timedout);
1449 SPI_STATISTICS_INCREMENT_FIELD(stats, timedout);
1450 dev_err(&msg->spi->dev,
1451 "SPI transfer timed out\n");
1455 if (xfer->error & SPI_TRANS_FAIL_IO)
1462 static void _spi_transfer_delay_ns(u32 ns)
1466 if (ns <= NSEC_PER_USEC) {
1469 u32 us = DIV_ROUND_UP(ns, NSEC_PER_USEC);
1474 usleep_range(us, us + DIV_ROUND_UP(us, 10));
1478 int spi_delay_to_ns(struct spi_delay *_delay, struct spi_transfer *xfer)
1480 u32 delay = _delay->value;
1481 u32 unit = _delay->unit;
1488 case SPI_DELAY_UNIT_USECS:
1489 delay *= NSEC_PER_USEC;
1491 case SPI_DELAY_UNIT_NSECS:
1492 /* Nothing to do here */
1494 case SPI_DELAY_UNIT_SCK:
1495 /* Clock cycles need to be obtained from spi_transfer */
1499 * If there is unknown effective speed, approximate it
1500 * by underestimating with half of the requested Hz.
1502 hz = xfer->effective_speed_hz ?: xfer->speed_hz / 2;
1506 /* Convert delay to nanoseconds */
1507 delay *= DIV_ROUND_UP(NSEC_PER_SEC, hz);
1515 EXPORT_SYMBOL_GPL(spi_delay_to_ns);
1517 int spi_delay_exec(struct spi_delay *_delay, struct spi_transfer *xfer)
1526 delay = spi_delay_to_ns(_delay, xfer);
1530 _spi_transfer_delay_ns(delay);
1534 EXPORT_SYMBOL_GPL(spi_delay_exec);
1536 static void _spi_transfer_cs_change_delay(struct spi_message *msg,
1537 struct spi_transfer *xfer)
1539 u32 default_delay_ns = 10 * NSEC_PER_USEC;
1540 u32 delay = xfer->cs_change_delay.value;
1541 u32 unit = xfer->cs_change_delay.unit;
1544 /* Return early on "fast" mode - for everything but USECS */
1546 if (unit == SPI_DELAY_UNIT_USECS)
1547 _spi_transfer_delay_ns(default_delay_ns);
1551 ret = spi_delay_exec(&xfer->cs_change_delay, xfer);
1553 dev_err_once(&msg->spi->dev,
1554 "Use of unsupported delay unit %i, using default of %luus\n",
1555 unit, default_delay_ns / NSEC_PER_USEC);
1556 _spi_transfer_delay_ns(default_delay_ns);
1560 void spi_transfer_cs_change_delay_exec(struct spi_message *msg,
1561 struct spi_transfer *xfer)
1563 _spi_transfer_cs_change_delay(msg, xfer);
1565 EXPORT_SYMBOL_GPL(spi_transfer_cs_change_delay_exec);
1568 * spi_transfer_one_message - Default implementation of transfer_one_message()
1570 * This is a standard implementation of transfer_one_message() for
1571 * drivers which implement a transfer_one() operation. It provides
1572 * standard handling of delays and chip select management.
1574 static int spi_transfer_one_message(struct spi_controller *ctlr,
1575 struct spi_message *msg)
1577 struct spi_transfer *xfer;
1578 bool keep_cs = false;
1580 struct spi_statistics __percpu *statm = ctlr->pcpu_statistics;
1581 struct spi_statistics __percpu *stats = msg->spi->pcpu_statistics;
1583 xfer = list_first_entry(&msg->transfers, struct spi_transfer, transfer_list);
1584 spi_set_cs(msg->spi, !xfer->cs_off, false);
1586 SPI_STATISTICS_INCREMENT_FIELD(statm, messages);
1587 SPI_STATISTICS_INCREMENT_FIELD(stats, messages);
1589 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
1590 trace_spi_transfer_start(msg, xfer);
1592 spi_statistics_add_transfer_stats(statm, xfer, ctlr);
1593 spi_statistics_add_transfer_stats(stats, xfer, ctlr);
1595 if (!ctlr->ptp_sts_supported) {
1596 xfer->ptp_sts_word_pre = 0;
1597 ptp_read_system_prets(xfer->ptp_sts);
1600 if ((xfer->tx_buf || xfer->rx_buf) && xfer->len) {
1601 reinit_completion(&ctlr->xfer_completion);
1604 spi_dma_sync_for_device(ctlr, xfer);
1605 ret = ctlr->transfer_one(ctlr, msg->spi, xfer);
1607 spi_dma_sync_for_cpu(ctlr, xfer);
1609 if (ctlr->cur_msg_mapped &&
1610 (xfer->error & SPI_TRANS_FAIL_NO_START)) {
1611 __spi_unmap_msg(ctlr, msg);
1612 ctlr->fallback = true;
1613 xfer->error &= ~SPI_TRANS_FAIL_NO_START;
1617 SPI_STATISTICS_INCREMENT_FIELD(statm,
1619 SPI_STATISTICS_INCREMENT_FIELD(stats,
1621 dev_err(&msg->spi->dev,
1622 "SPI transfer failed: %d\n", ret);
1627 ret = spi_transfer_wait(ctlr, msg, xfer);
1632 spi_dma_sync_for_cpu(ctlr, xfer);
1635 dev_err(&msg->spi->dev,
1636 "Bufferless transfer has length %u\n",
1640 if (!ctlr->ptp_sts_supported) {
1641 ptp_read_system_postts(xfer->ptp_sts);
1642 xfer->ptp_sts_word_post = xfer->len;
1645 trace_spi_transfer_stop(msg, xfer);
1647 if (msg->status != -EINPROGRESS)
1650 spi_transfer_delay_exec(xfer);
1652 if (xfer->cs_change) {
1653 if (list_is_last(&xfer->transfer_list,
1658 spi_set_cs(msg->spi, false, false);
1659 _spi_transfer_cs_change_delay(msg, xfer);
1660 if (!list_next_entry(xfer, transfer_list)->cs_off)
1661 spi_set_cs(msg->spi, true, false);
1663 } else if (!list_is_last(&xfer->transfer_list, &msg->transfers) &&
1664 xfer->cs_off != list_next_entry(xfer, transfer_list)->cs_off) {
1665 spi_set_cs(msg->spi, xfer->cs_off, false);
1668 msg->actual_length += xfer->len;
1672 if (ret != 0 || !keep_cs)
1673 spi_set_cs(msg->spi, false, false);
1675 if (msg->status == -EINPROGRESS)
1678 if (msg->status && ctlr->handle_err)
1679 ctlr->handle_err(ctlr, msg);
1681 spi_finalize_current_message(ctlr);
1687 * spi_finalize_current_transfer - report completion of a transfer
1688 * @ctlr: the controller reporting completion
1690 * Called by SPI drivers using the core transfer_one_message()
1691 * implementation to notify it that the current interrupt driven
1692 * transfer has finished and the next one may be scheduled.
1694 void spi_finalize_current_transfer(struct spi_controller *ctlr)
1696 complete(&ctlr->xfer_completion);
1698 EXPORT_SYMBOL_GPL(spi_finalize_current_transfer);
1700 static void spi_idle_runtime_pm(struct spi_controller *ctlr)
1702 if (ctlr->auto_runtime_pm) {
1703 pm_runtime_mark_last_busy(ctlr->dev.parent);
1704 pm_runtime_put_autosuspend(ctlr->dev.parent);
1708 static int __spi_pump_transfer_message(struct spi_controller *ctlr,
1709 struct spi_message *msg, bool was_busy)
1711 struct spi_transfer *xfer;
1714 if (!was_busy && ctlr->auto_runtime_pm) {
1715 ret = pm_runtime_get_sync(ctlr->dev.parent);
1717 pm_runtime_put_noidle(ctlr->dev.parent);
1718 dev_err(&ctlr->dev, "Failed to power device: %d\n",
1725 trace_spi_controller_busy(ctlr);
1727 if (!was_busy && ctlr->prepare_transfer_hardware) {
1728 ret = ctlr->prepare_transfer_hardware(ctlr);
1731 "failed to prepare transfer hardware: %d\n",
1734 if (ctlr->auto_runtime_pm)
1735 pm_runtime_put(ctlr->dev.parent);
1738 spi_finalize_current_message(ctlr);
1744 trace_spi_message_start(msg);
1746 ret = spi_split_transfers_maxsize(ctlr, msg,
1747 spi_max_transfer_size(msg->spi),
1748 GFP_KERNEL | GFP_DMA);
1751 spi_finalize_current_message(ctlr);
1755 if (ctlr->prepare_message) {
1756 ret = ctlr->prepare_message(ctlr, msg);
1758 dev_err(&ctlr->dev, "failed to prepare message: %d\n",
1761 spi_finalize_current_message(ctlr);
1764 msg->prepared = true;
1767 ret = spi_map_msg(ctlr, msg);
1770 spi_finalize_current_message(ctlr);
1774 if (!ctlr->ptp_sts_supported && !ctlr->transfer_one) {
1775 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
1776 xfer->ptp_sts_word_pre = 0;
1777 ptp_read_system_prets(xfer->ptp_sts);
1782 * Drivers implementation of transfer_one_message() must arrange for
1783 * spi_finalize_current_message() to get called. Most drivers will do
1784 * this in the calling context, but some don't. For those cases, a
1785 * completion is used to guarantee that this function does not return
1786 * until spi_finalize_current_message() is done accessing
1788 * Use of the following two flags enable to opportunistically skip the
1789 * use of the completion since its use involves expensive spin locks.
1790 * In case of a race with the context that calls
1791 * spi_finalize_current_message() the completion will always be used,
1792 * due to strict ordering of these flags using barriers.
1794 WRITE_ONCE(ctlr->cur_msg_incomplete, true);
1795 WRITE_ONCE(ctlr->cur_msg_need_completion, false);
1796 reinit_completion(&ctlr->cur_msg_completion);
1797 smp_wmb(); /* Make these available to spi_finalize_current_message() */
1799 ret = ctlr->transfer_one_message(ctlr, msg);
1802 "failed to transfer one message from queue\n");
1806 WRITE_ONCE(ctlr->cur_msg_need_completion, true);
1807 smp_mb(); /* See spi_finalize_current_message()... */
1808 if (READ_ONCE(ctlr->cur_msg_incomplete))
1809 wait_for_completion(&ctlr->cur_msg_completion);
1815 * __spi_pump_messages - function which processes SPI message queue
1816 * @ctlr: controller to process queue for
1817 * @in_kthread: true if we are in the context of the message pump thread
1819 * This function checks if there is any SPI message in the queue that
1820 * needs processing and if so call out to the driver to initialize hardware
1821 * and transfer each message.
1823 * Note that it is called both from the kthread itself and also from
1824 * inside spi_sync(); the queue extraction handling at the top of the
1825 * function should deal with this safely.
1827 static void __spi_pump_messages(struct spi_controller *ctlr, bool in_kthread)
1829 struct spi_message *msg;
1830 bool was_busy = false;
1831 unsigned long flags;
1834 /* Take the I/O mutex */
1835 mutex_lock(&ctlr->io_mutex);
1838 spin_lock_irqsave(&ctlr->queue_lock, flags);
1840 /* Make sure we are not already running a message */
1844 /* Check if the queue is idle */
1845 if (list_empty(&ctlr->queue) || !ctlr->running) {
1849 /* Defer any non-atomic teardown to the thread */
1851 if (!ctlr->dummy_rx && !ctlr->dummy_tx &&
1852 !ctlr->unprepare_transfer_hardware) {
1853 spi_idle_runtime_pm(ctlr);
1855 ctlr->queue_empty = true;
1856 trace_spi_controller_idle(ctlr);
1858 kthread_queue_work(ctlr->kworker,
1859 &ctlr->pump_messages);
1865 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1867 kfree(ctlr->dummy_rx);
1868 ctlr->dummy_rx = NULL;
1869 kfree(ctlr->dummy_tx);
1870 ctlr->dummy_tx = NULL;
1871 if (ctlr->unprepare_transfer_hardware &&
1872 ctlr->unprepare_transfer_hardware(ctlr))
1874 "failed to unprepare transfer hardware\n");
1875 spi_idle_runtime_pm(ctlr);
1876 trace_spi_controller_idle(ctlr);
1878 spin_lock_irqsave(&ctlr->queue_lock, flags);
1879 ctlr->queue_empty = true;
1883 /* Extract head of queue */
1884 msg = list_first_entry(&ctlr->queue, struct spi_message, queue);
1885 ctlr->cur_msg = msg;
1887 list_del_init(&msg->queue);
1892 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1894 ret = __spi_pump_transfer_message(ctlr, msg, was_busy);
1895 kthread_queue_work(ctlr->kworker, &ctlr->pump_messages);
1897 ctlr->cur_msg = NULL;
1898 ctlr->fallback = false;
1900 mutex_unlock(&ctlr->io_mutex);
1902 /* Prod the scheduler in case transfer_one() was busy waiting */
1908 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
1909 mutex_unlock(&ctlr->io_mutex);
1913 * spi_pump_messages - kthread work function which processes spi message queue
1914 * @work: pointer to kthread work struct contained in the controller struct
1916 static void spi_pump_messages(struct kthread_work *work)
1918 struct spi_controller *ctlr =
1919 container_of(work, struct spi_controller, pump_messages);
1921 __spi_pump_messages(ctlr, true);
1925 * spi_take_timestamp_pre - helper to collect the beginning of the TX timestamp
1926 * @ctlr: Pointer to the spi_controller structure of the driver
1927 * @xfer: Pointer to the transfer being timestamped
1928 * @progress: How many words (not bytes) have been transferred so far
1929 * @irqs_off: If true, will disable IRQs and preemption for the duration of the
1930 * transfer, for less jitter in time measurement. Only compatible
1931 * with PIO drivers. If true, must follow up with
1932 * spi_take_timestamp_post or otherwise system will crash.
1933 * WARNING: for fully predictable results, the CPU frequency must
1934 * also be under control (governor).
1936 * This is a helper for drivers to collect the beginning of the TX timestamp
1937 * for the requested byte from the SPI transfer. The frequency with which this
1938 * function must be called (once per word, once for the whole transfer, once
1939 * per batch of words etc) is arbitrary as long as the @tx buffer offset is
1940 * greater than or equal to the requested byte at the time of the call. The
1941 * timestamp is only taken once, at the first such call. It is assumed that
1942 * the driver advances its @tx buffer pointer monotonically.
1944 void spi_take_timestamp_pre(struct spi_controller *ctlr,
1945 struct spi_transfer *xfer,
1946 size_t progress, bool irqs_off)
1951 if (xfer->timestamped)
1954 if (progress > xfer->ptp_sts_word_pre)
1957 /* Capture the resolution of the timestamp */
1958 xfer->ptp_sts_word_pre = progress;
1961 local_irq_save(ctlr->irq_flags);
1965 ptp_read_system_prets(xfer->ptp_sts);
1967 EXPORT_SYMBOL_GPL(spi_take_timestamp_pre);
1970 * spi_take_timestamp_post - helper to collect the end of the TX timestamp
1971 * @ctlr: Pointer to the spi_controller structure of the driver
1972 * @xfer: Pointer to the transfer being timestamped
1973 * @progress: How many words (not bytes) have been transferred so far
1974 * @irqs_off: If true, will re-enable IRQs and preemption for the local CPU.
1976 * This is a helper for drivers to collect the end of the TX timestamp for
1977 * the requested byte from the SPI transfer. Can be called with an arbitrary
1978 * frequency: only the first call where @tx exceeds or is equal to the
1979 * requested word will be timestamped.
1981 void spi_take_timestamp_post(struct spi_controller *ctlr,
1982 struct spi_transfer *xfer,
1983 size_t progress, bool irqs_off)
1988 if (xfer->timestamped)
1991 if (progress < xfer->ptp_sts_word_post)
1994 ptp_read_system_postts(xfer->ptp_sts);
1997 local_irq_restore(ctlr->irq_flags);
2001 /* Capture the resolution of the timestamp */
2002 xfer->ptp_sts_word_post = progress;
2004 xfer->timestamped = 1;
2006 EXPORT_SYMBOL_GPL(spi_take_timestamp_post);
2009 * spi_set_thread_rt - set the controller to pump at realtime priority
2010 * @ctlr: controller to boost priority of
2012 * This can be called because the controller requested realtime priority
2013 * (by setting the ->rt value before calling spi_register_controller()) or
2014 * because a device on the bus said that its transfers needed realtime
2017 * NOTE: at the moment if any device on a bus says it needs realtime then
2018 * the thread will be at realtime priority for all transfers on that
2019 * controller. If this eventually becomes a problem we may see if we can
2020 * find a way to boost the priority only temporarily during relevant
2023 static void spi_set_thread_rt(struct spi_controller *ctlr)
2025 dev_info(&ctlr->dev,
2026 "will run message pump with realtime priority\n");
2027 sched_set_fifo(ctlr->kworker->task);
2030 static int spi_init_queue(struct spi_controller *ctlr)
2032 ctlr->running = false;
2034 ctlr->queue_empty = true;
2036 ctlr->kworker = kthread_create_worker(0, dev_name(&ctlr->dev));
2037 if (IS_ERR(ctlr->kworker)) {
2038 dev_err(&ctlr->dev, "failed to create message pump kworker\n");
2039 return PTR_ERR(ctlr->kworker);
2042 kthread_init_work(&ctlr->pump_messages, spi_pump_messages);
2045 * Controller config will indicate if this controller should run the
2046 * message pump with high (realtime) priority to reduce the transfer
2047 * latency on the bus by minimising the delay between a transfer
2048 * request and the scheduling of the message pump thread. Without this
2049 * setting the message pump thread will remain at default priority.
2052 spi_set_thread_rt(ctlr);
2058 * spi_get_next_queued_message() - called by driver to check for queued
2060 * @ctlr: the controller to check for queued messages
2062 * If there are more messages in the queue, the next message is returned from
2065 * Return: the next message in the queue, else NULL if the queue is empty.
2067 struct spi_message *spi_get_next_queued_message(struct spi_controller *ctlr)
2069 struct spi_message *next;
2070 unsigned long flags;
2072 /* Get a pointer to the next message, if any */
2073 spin_lock_irqsave(&ctlr->queue_lock, flags);
2074 next = list_first_entry_or_null(&ctlr->queue, struct spi_message,
2076 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
2080 EXPORT_SYMBOL_GPL(spi_get_next_queued_message);
2083 * spi_finalize_current_message() - the current message is complete
2084 * @ctlr: the controller to return the message to
2086 * Called by the driver to notify the core that the message in the front of the
2087 * queue is complete and can be removed from the queue.
2089 void spi_finalize_current_message(struct spi_controller *ctlr)
2091 struct spi_transfer *xfer;
2092 struct spi_message *mesg;
2095 mesg = ctlr->cur_msg;
2097 if (!ctlr->ptp_sts_supported && !ctlr->transfer_one) {
2098 list_for_each_entry(xfer, &mesg->transfers, transfer_list) {
2099 ptp_read_system_postts(xfer->ptp_sts);
2100 xfer->ptp_sts_word_post = xfer->len;
2104 if (unlikely(ctlr->ptp_sts_supported))
2105 list_for_each_entry(xfer, &mesg->transfers, transfer_list)
2106 WARN_ON_ONCE(xfer->ptp_sts && !xfer->timestamped);
2108 spi_unmap_msg(ctlr, mesg);
2111 * In the prepare_messages callback the SPI bus has the opportunity
2112 * to split a transfer to smaller chunks.
2114 * Release the split transfers here since spi_map_msg() is done on
2115 * the split transfers.
2117 spi_res_release(ctlr, mesg);
2119 if (mesg->prepared && ctlr->unprepare_message) {
2120 ret = ctlr->unprepare_message(ctlr, mesg);
2122 dev_err(&ctlr->dev, "failed to unprepare message: %d\n",
2127 mesg->prepared = false;
2129 WRITE_ONCE(ctlr->cur_msg_incomplete, false);
2130 smp_mb(); /* See __spi_pump_transfer_message()... */
2131 if (READ_ONCE(ctlr->cur_msg_need_completion))
2132 complete(&ctlr->cur_msg_completion);
2134 trace_spi_message_done(mesg);
2138 mesg->complete(mesg->context);
2140 EXPORT_SYMBOL_GPL(spi_finalize_current_message);
2142 static int spi_start_queue(struct spi_controller *ctlr)
2144 unsigned long flags;
2146 spin_lock_irqsave(&ctlr->queue_lock, flags);
2148 if (ctlr->running || ctlr->busy) {
2149 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
2153 ctlr->running = true;
2154 ctlr->cur_msg = NULL;
2155 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
2157 kthread_queue_work(ctlr->kworker, &ctlr->pump_messages);
2162 static int spi_stop_queue(struct spi_controller *ctlr)
2164 unsigned long flags;
2165 unsigned limit = 500;
2168 spin_lock_irqsave(&ctlr->queue_lock, flags);
2171 * This is a bit lame, but is optimized for the common execution path.
2172 * A wait_queue on the ctlr->busy could be used, but then the common
2173 * execution path (pump_messages) would be required to call wake_up or
2174 * friends on every SPI message. Do this instead.
2176 while ((!list_empty(&ctlr->queue) || ctlr->busy) && limit--) {
2177 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
2178 usleep_range(10000, 11000);
2179 spin_lock_irqsave(&ctlr->queue_lock, flags);
2182 if (!list_empty(&ctlr->queue) || ctlr->busy)
2185 ctlr->running = false;
2187 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
2192 static int spi_destroy_queue(struct spi_controller *ctlr)
2196 ret = spi_stop_queue(ctlr);
2199 * kthread_flush_worker will block until all work is done.
2200 * If the reason that stop_queue timed out is that the work will never
2201 * finish, then it does no good to call flush/stop thread, so
2205 dev_err(&ctlr->dev, "problem destroying queue\n");
2209 kthread_destroy_worker(ctlr->kworker);
2214 static int __spi_queued_transfer(struct spi_device *spi,
2215 struct spi_message *msg,
2218 struct spi_controller *ctlr = spi->controller;
2219 unsigned long flags;
2221 spin_lock_irqsave(&ctlr->queue_lock, flags);
2223 if (!ctlr->running) {
2224 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
2227 msg->actual_length = 0;
2228 msg->status = -EINPROGRESS;
2230 list_add_tail(&msg->queue, &ctlr->queue);
2231 ctlr->queue_empty = false;
2232 if (!ctlr->busy && need_pump)
2233 kthread_queue_work(ctlr->kworker, &ctlr->pump_messages);
2235 spin_unlock_irqrestore(&ctlr->queue_lock, flags);
2240 * spi_queued_transfer - transfer function for queued transfers
2241 * @spi: SPI device which is requesting transfer
2242 * @msg: SPI message which is to handled is queued to driver queue
2244 * Return: zero on success, else a negative error code.
2246 static int spi_queued_transfer(struct spi_device *spi, struct spi_message *msg)
2248 return __spi_queued_transfer(spi, msg, true);
2251 static int spi_controller_initialize_queue(struct spi_controller *ctlr)
2255 ctlr->transfer = spi_queued_transfer;
2256 if (!ctlr->transfer_one_message)
2257 ctlr->transfer_one_message = spi_transfer_one_message;
2259 /* Initialize and start queue */
2260 ret = spi_init_queue(ctlr);
2262 dev_err(&ctlr->dev, "problem initializing queue\n");
2263 goto err_init_queue;
2265 ctlr->queued = true;
2266 ret = spi_start_queue(ctlr);
2268 dev_err(&ctlr->dev, "problem starting queue\n");
2269 goto err_start_queue;
2275 spi_destroy_queue(ctlr);
2281 * spi_flush_queue - Send all pending messages in the queue from the callers'
2283 * @ctlr: controller to process queue for
2285 * This should be used when one wants to ensure all pending messages have been
2286 * sent before doing something. Is used by the spi-mem code to make sure SPI
2287 * memory operations do not preempt regular SPI transfers that have been queued
2288 * before the spi-mem operation.
2290 void spi_flush_queue(struct spi_controller *ctlr)
2292 if (ctlr->transfer == spi_queued_transfer)
2293 __spi_pump_messages(ctlr, false);
2296 /*-------------------------------------------------------------------------*/
2298 #if defined(CONFIG_OF)
2299 static void of_spi_parse_dt_cs_delay(struct device_node *nc,
2300 struct spi_delay *delay, const char *prop)
2304 if (!of_property_read_u32(nc, prop, &value)) {
2305 if (value > U16_MAX) {
2306 delay->value = DIV_ROUND_UP(value, 1000);
2307 delay->unit = SPI_DELAY_UNIT_USECS;
2309 delay->value = value;
2310 delay->unit = SPI_DELAY_UNIT_NSECS;
2315 static int of_spi_parse_dt(struct spi_controller *ctlr, struct spi_device *spi,
2316 struct device_node *nc)
2318 u32 value, cs[SPI_CS_CNT_MAX];
2321 /* Mode (clock phase/polarity/etc.) */
2322 if (of_property_read_bool(nc, "spi-cpha"))
2323 spi->mode |= SPI_CPHA;
2324 if (of_property_read_bool(nc, "spi-cpol"))
2325 spi->mode |= SPI_CPOL;
2326 if (of_property_read_bool(nc, "spi-3wire"))
2327 spi->mode |= SPI_3WIRE;
2328 if (of_property_read_bool(nc, "spi-lsb-first"))
2329 spi->mode |= SPI_LSB_FIRST;
2330 if (of_property_read_bool(nc, "spi-cs-high"))
2331 spi->mode |= SPI_CS_HIGH;
2333 /* Device DUAL/QUAD mode */
2334 if (!of_property_read_u32(nc, "spi-tx-bus-width", &value)) {
2337 spi->mode |= SPI_NO_TX;
2342 spi->mode |= SPI_TX_DUAL;
2345 spi->mode |= SPI_TX_QUAD;
2348 spi->mode |= SPI_TX_OCTAL;
2351 dev_warn(&ctlr->dev,
2352 "spi-tx-bus-width %d not supported\n",
2358 if (!of_property_read_u32(nc, "spi-rx-bus-width", &value)) {
2361 spi->mode |= SPI_NO_RX;
2366 spi->mode |= SPI_RX_DUAL;
2369 spi->mode |= SPI_RX_QUAD;
2372 spi->mode |= SPI_RX_OCTAL;
2375 dev_warn(&ctlr->dev,
2376 "spi-rx-bus-width %d not supported\n",
2382 if (spi_controller_is_slave(ctlr)) {
2383 if (!of_node_name_eq(nc, "slave")) {
2384 dev_err(&ctlr->dev, "%pOF is not called 'slave'\n",
2391 if (ctlr->num_chipselect > SPI_CS_CNT_MAX) {
2392 dev_err(&ctlr->dev, "No. of CS is more than max. no. of supported CS\n");
2397 * Zero(0) is a valid physical CS value and can be located at any
2398 * logical CS in the spi->chip_select[]. If all the physical CS
2399 * are initialized to 0 then It would be difficult to differentiate
2400 * between a valid physical CS 0 & an unused logical CS whose physical
2401 * CS can be 0. As a solution to this issue initialize all the CS to 0xFF.
2402 * Now all the unused logical CS will have 0xFF physical CS value & can be
2403 * ignore while performing physical CS validity checks.
2405 for (idx = 0; idx < SPI_CS_CNT_MAX; idx++)
2406 spi_set_chipselect(spi, idx, 0xFF);
2408 /* Device address */
2409 rc = of_property_read_variable_u32_array(nc, "reg", &cs[0], 1,
2412 dev_err(&ctlr->dev, "%pOF has no valid 'reg' property (%d)\n",
2416 if (rc > ctlr->num_chipselect) {
2417 dev_err(&ctlr->dev, "%pOF has number of CS > ctlr->num_chipselect (%d)\n",
2421 if ((of_property_read_bool(nc, "parallel-memories")) &&
2422 (!(ctlr->flags & SPI_CONTROLLER_MULTI_CS))) {
2423 dev_err(&ctlr->dev, "SPI controller doesn't support multi CS\n");
2426 for (idx = 0; idx < rc; idx++)
2427 spi_set_chipselect(spi, idx, cs[idx]);
2430 * spi->chip_select[i] gives the corresponding physical CS for logical CS i
2431 * logical CS number is represented by setting the ith bit in spi->cs_index_mask
2432 * So, for example, if spi->cs_index_mask = 0x01 then logical CS number is 0 and
2433 * spi->chip_select[0] will give the physical CS.
2434 * By default spi->chip_select[0] will hold the physical CS number so, set
2435 * spi->cs_index_mask as 0x01.
2437 spi->cs_index_mask = 0x01;
2440 if (!of_property_read_u32(nc, "spi-max-frequency", &value))
2441 spi->max_speed_hz = value;
2443 /* Device CS delays */
2444 of_spi_parse_dt_cs_delay(nc, &spi->cs_setup, "spi-cs-setup-delay-ns");
2445 of_spi_parse_dt_cs_delay(nc, &spi->cs_hold, "spi-cs-hold-delay-ns");
2446 of_spi_parse_dt_cs_delay(nc, &spi->cs_inactive, "spi-cs-inactive-delay-ns");
2451 static struct spi_device *
2452 of_register_spi_device(struct spi_controller *ctlr, struct device_node *nc)
2454 struct spi_device *spi;
2457 /* Alloc an spi_device */
2458 spi = spi_alloc_device(ctlr);
2460 dev_err(&ctlr->dev, "spi_device alloc error for %pOF\n", nc);
2465 /* Select device driver */
2466 rc = of_alias_from_compatible(nc, spi->modalias,
2467 sizeof(spi->modalias));
2469 dev_err(&ctlr->dev, "cannot find modalias for %pOF\n", nc);
2473 rc = of_spi_parse_dt(ctlr, spi, nc);
2477 /* Store a pointer to the node in the device structure */
2480 device_set_node(&spi->dev, of_fwnode_handle(nc));
2482 /* Register the new device */
2483 rc = spi_add_device(spi);
2485 dev_err(&ctlr->dev, "spi_device register error %pOF\n", nc);
2486 goto err_of_node_put;
2499 * of_register_spi_devices() - Register child devices onto the SPI bus
2500 * @ctlr: Pointer to spi_controller device
2502 * Registers an spi_device for each child node of controller node which
2503 * represents a valid SPI slave.
2505 static void of_register_spi_devices(struct spi_controller *ctlr)
2507 struct spi_device *spi;
2508 struct device_node *nc;
2510 for_each_available_child_of_node(ctlr->dev.of_node, nc) {
2511 if (of_node_test_and_set_flag(nc, OF_POPULATED))
2513 spi = of_register_spi_device(ctlr, nc);
2515 dev_warn(&ctlr->dev,
2516 "Failed to create SPI device for %pOF\n", nc);
2517 of_node_clear_flag(nc, OF_POPULATED);
2522 static void of_register_spi_devices(struct spi_controller *ctlr) { }
2526 * spi_new_ancillary_device() - Register ancillary SPI device
2527 * @spi: Pointer to the main SPI device registering the ancillary device
2528 * @chip_select: Chip Select of the ancillary device
2530 * Register an ancillary SPI device; for example some chips have a chip-select
2531 * for normal device usage and another one for setup/firmware upload.
2533 * This may only be called from main SPI device's probe routine.
2535 * Return: 0 on success; negative errno on failure
2537 struct spi_device *spi_new_ancillary_device(struct spi_device *spi,
2540 struct spi_controller *ctlr = spi->controller;
2541 struct spi_device *ancillary;
2545 /* Alloc an spi_device */
2546 ancillary = spi_alloc_device(ctlr);
2552 strscpy(ancillary->modalias, "dummy", sizeof(ancillary->modalias));
2555 * Zero(0) is a valid physical CS value and can be located at any
2556 * logical CS in the spi->chip_select[]. If all the physical CS
2557 * are initialized to 0 then It would be difficult to differentiate
2558 * between a valid physical CS 0 & an unused logical CS whose physical
2559 * CS can be 0. As a solution to this issue initialize all the CS to 0xFF.
2560 * Now all the unused logical CS will have 0xFF physical CS value & can be
2561 * ignore while performing physical CS validity checks.
2563 for (idx = 0; idx < SPI_CS_CNT_MAX; idx++)
2564 spi_set_chipselect(ancillary, idx, 0xFF);
2566 /* Use provided chip-select for ancillary device */
2567 spi_set_chipselect(ancillary, 0, chip_select);
2569 /* Take over SPI mode/speed from SPI main device */
2570 ancillary->max_speed_hz = spi->max_speed_hz;
2571 ancillary->mode = spi->mode;
2573 * spi->chip_select[i] gives the corresponding physical CS for logical CS i
2574 * logical CS number is represented by setting the ith bit in spi->cs_index_mask
2575 * So, for example, if spi->cs_index_mask = 0x01 then logical CS number is 0 and
2576 * spi->chip_select[0] will give the physical CS.
2577 * By default spi->chip_select[0] will hold the physical CS number so, set
2578 * spi->cs_index_mask as 0x01.
2580 ancillary->cs_index_mask = 0x01;
2582 WARN_ON(!mutex_is_locked(&ctlr->add_lock));
2584 /* Register the new device */
2585 rc = __spi_add_device(ancillary);
2587 dev_err(&spi->dev, "failed to register ancillary device\n");
2594 spi_dev_put(ancillary);
2597 EXPORT_SYMBOL_GPL(spi_new_ancillary_device);
2600 struct acpi_spi_lookup {
2601 struct spi_controller *ctlr;
2611 static int acpi_spi_count(struct acpi_resource *ares, void *data)
2613 struct acpi_resource_spi_serialbus *sb;
2616 if (ares->type != ACPI_RESOURCE_TYPE_SERIAL_BUS)
2619 sb = &ares->data.spi_serial_bus;
2620 if (sb->type != ACPI_RESOURCE_SERIAL_TYPE_SPI)
2623 *count = *count + 1;
2629 * acpi_spi_count_resources - Count the number of SpiSerialBus resources
2630 * @adev: ACPI device
2632 * Return: the number of SpiSerialBus resources in the ACPI-device's
2633 * resource-list; or a negative error code.
2635 int acpi_spi_count_resources(struct acpi_device *adev)
2641 ret = acpi_dev_get_resources(adev, &r, acpi_spi_count, &count);
2645 acpi_dev_free_resource_list(&r);
2649 EXPORT_SYMBOL_GPL(acpi_spi_count_resources);
2651 static void acpi_spi_parse_apple_properties(struct acpi_device *dev,
2652 struct acpi_spi_lookup *lookup)
2654 const union acpi_object *obj;
2656 if (!x86_apple_machine)
2659 if (!acpi_dev_get_property(dev, "spiSclkPeriod", ACPI_TYPE_BUFFER, &obj)
2660 && obj->buffer.length >= 4)
2661 lookup->max_speed_hz = NSEC_PER_SEC / *(u32 *)obj->buffer.pointer;
2663 if (!acpi_dev_get_property(dev, "spiWordSize", ACPI_TYPE_BUFFER, &obj)
2664 && obj->buffer.length == 8)
2665 lookup->bits_per_word = *(u64 *)obj->buffer.pointer;
2667 if (!acpi_dev_get_property(dev, "spiBitOrder", ACPI_TYPE_BUFFER, &obj)
2668 && obj->buffer.length == 8 && !*(u64 *)obj->buffer.pointer)
2669 lookup->mode |= SPI_LSB_FIRST;
2671 if (!acpi_dev_get_property(dev, "spiSPO", ACPI_TYPE_BUFFER, &obj)
2672 && obj->buffer.length == 8 && *(u64 *)obj->buffer.pointer)
2673 lookup->mode |= SPI_CPOL;
2675 if (!acpi_dev_get_property(dev, "spiSPH", ACPI_TYPE_BUFFER, &obj)
2676 && obj->buffer.length == 8 && *(u64 *)obj->buffer.pointer)
2677 lookup->mode |= SPI_CPHA;
2680 static int acpi_spi_add_resource(struct acpi_resource *ares, void *data)
2682 struct acpi_spi_lookup *lookup = data;
2683 struct spi_controller *ctlr = lookup->ctlr;
2685 if (ares->type == ACPI_RESOURCE_TYPE_SERIAL_BUS) {
2686 struct acpi_resource_spi_serialbus *sb;
2687 acpi_handle parent_handle;
2690 sb = &ares->data.spi_serial_bus;
2691 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_SPI) {
2693 if (lookup->index != -1 && lookup->n++ != lookup->index)
2696 status = acpi_get_handle(NULL,
2697 sb->resource_source.string_ptr,
2700 if (ACPI_FAILURE(status))
2704 if (ACPI_HANDLE(ctlr->dev.parent) != parent_handle)
2707 struct acpi_device *adev;
2709 adev = acpi_fetch_acpi_dev(parent_handle);
2713 ctlr = acpi_spi_find_controller_by_adev(adev);
2715 return -EPROBE_DEFER;
2717 lookup->ctlr = ctlr;
2721 * ACPI DeviceSelection numbering is handled by the
2722 * host controller driver in Windows and can vary
2723 * from driver to driver. In Linux we always expect
2724 * 0 .. max - 1 so we need to ask the driver to
2725 * translate between the two schemes.
2727 if (ctlr->fw_translate_cs) {
2728 int cs = ctlr->fw_translate_cs(ctlr,
2729 sb->device_selection);
2732 lookup->chip_select = cs;
2734 lookup->chip_select = sb->device_selection;
2737 lookup->max_speed_hz = sb->connection_speed;
2738 lookup->bits_per_word = sb->data_bit_length;
2740 if (sb->clock_phase == ACPI_SPI_SECOND_PHASE)
2741 lookup->mode |= SPI_CPHA;
2742 if (sb->clock_polarity == ACPI_SPI_START_HIGH)
2743 lookup->mode |= SPI_CPOL;
2744 if (sb->device_polarity == ACPI_SPI_ACTIVE_HIGH)
2745 lookup->mode |= SPI_CS_HIGH;
2747 } else if (lookup->irq < 0) {
2750 if (acpi_dev_resource_interrupt(ares, 0, &r))
2751 lookup->irq = r.start;
2754 /* Always tell the ACPI core to skip this resource */
2759 * acpi_spi_device_alloc - Allocate a spi device, and fill it in with ACPI information
2760 * @ctlr: controller to which the spi device belongs
2761 * @adev: ACPI Device for the spi device
2762 * @index: Index of the spi resource inside the ACPI Node
2764 * This should be used to allocate a new SPI device from and ACPI Device node.
2765 * The caller is responsible for calling spi_add_device to register the SPI device.
2767 * If ctlr is set to NULL, the Controller for the SPI device will be looked up
2768 * using the resource.
2769 * If index is set to -1, index is not used.
2770 * Note: If index is -1, ctlr must be set.
2772 * Return: a pointer to the new device, or ERR_PTR on error.
2774 struct spi_device *acpi_spi_device_alloc(struct spi_controller *ctlr,
2775 struct acpi_device *adev,
2778 acpi_handle parent_handle = NULL;
2779 struct list_head resource_list;
2780 struct acpi_spi_lookup lookup = {};
2781 struct spi_device *spi;
2785 if (!ctlr && index == -1)
2786 return ERR_PTR(-EINVAL);
2790 lookup.index = index;
2793 INIT_LIST_HEAD(&resource_list);
2794 ret = acpi_dev_get_resources(adev, &resource_list,
2795 acpi_spi_add_resource, &lookup);
2796 acpi_dev_free_resource_list(&resource_list);
2799 /* Found SPI in _CRS but it points to another controller */
2800 return ERR_PTR(ret);
2802 if (!lookup.max_speed_hz &&
2803 ACPI_SUCCESS(acpi_get_parent(adev->handle, &parent_handle)) &&
2804 ACPI_HANDLE(lookup.ctlr->dev.parent) == parent_handle) {
2805 /* Apple does not use _CRS but nested devices for SPI slaves */
2806 acpi_spi_parse_apple_properties(adev, &lookup);
2809 if (!lookup.max_speed_hz)
2810 return ERR_PTR(-ENODEV);
2812 spi = spi_alloc_device(lookup.ctlr);
2814 dev_err(&lookup.ctlr->dev, "failed to allocate SPI device for %s\n",
2815 dev_name(&adev->dev));
2816 return ERR_PTR(-ENOMEM);
2820 * Zero(0) is a valid physical CS value and can be located at any
2821 * logical CS in the spi->chip_select[]. If all the physical CS
2822 * are initialized to 0 then It would be difficult to differentiate
2823 * between a valid physical CS 0 & an unused logical CS whose physical
2824 * CS can be 0. As a solution to this issue initialize all the CS to 0xFF.
2825 * Now all the unused logical CS will have 0xFF physical CS value & can be
2826 * ignore while performing physical CS validity checks.
2828 for (idx = 0; idx < SPI_CS_CNT_MAX; idx++)
2829 spi_set_chipselect(spi, idx, 0xFF);
2831 ACPI_COMPANION_SET(&spi->dev, adev);
2832 spi->max_speed_hz = lookup.max_speed_hz;
2833 spi->mode |= lookup.mode;
2834 spi->irq = lookup.irq;
2835 spi->bits_per_word = lookup.bits_per_word;
2836 spi_set_chipselect(spi, 0, lookup.chip_select);
2838 * spi->chip_select[i] gives the corresponding physical CS for logical CS i
2839 * logical CS number is represented by setting the ith bit in spi->cs_index_mask
2840 * So, for example, if spi->cs_index_mask = 0x01 then logical CS number is 0 and
2841 * spi->chip_select[0] will give the physical CS.
2842 * By default spi->chip_select[0] will hold the physical CS number so, set
2843 * spi->cs_index_mask as 0x01.
2845 spi->cs_index_mask = 0x01;
2849 EXPORT_SYMBOL_GPL(acpi_spi_device_alloc);
2851 static acpi_status acpi_register_spi_device(struct spi_controller *ctlr,
2852 struct acpi_device *adev)
2854 struct spi_device *spi;
2856 if (acpi_bus_get_status(adev) || !adev->status.present ||
2857 acpi_device_enumerated(adev))
2860 spi = acpi_spi_device_alloc(ctlr, adev, -1);
2862 if (PTR_ERR(spi) == -ENOMEM)
2863 return AE_NO_MEMORY;
2868 acpi_set_modalias(adev, acpi_device_hid(adev), spi->modalias,
2869 sizeof(spi->modalias));
2872 spi->irq = acpi_dev_gpio_irq_get(adev, 0);
2874 acpi_device_set_enumerated(adev);
2876 adev->power.flags.ignore_parent = true;
2877 if (spi_add_device(spi)) {
2878 adev->power.flags.ignore_parent = false;
2879 dev_err(&ctlr->dev, "failed to add SPI device %s from ACPI\n",
2880 dev_name(&adev->dev));
2887 static acpi_status acpi_spi_add_device(acpi_handle handle, u32 level,
2888 void *data, void **return_value)
2890 struct acpi_device *adev = acpi_fetch_acpi_dev(handle);
2891 struct spi_controller *ctlr = data;
2896 return acpi_register_spi_device(ctlr, adev);
2899 #define SPI_ACPI_ENUMERATE_MAX_DEPTH 32
2901 static void acpi_register_spi_devices(struct spi_controller *ctlr)
2906 handle = ACPI_HANDLE(ctlr->dev.parent);
2910 status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
2911 SPI_ACPI_ENUMERATE_MAX_DEPTH,
2912 acpi_spi_add_device, NULL, ctlr, NULL);
2913 if (ACPI_FAILURE(status))
2914 dev_warn(&ctlr->dev, "failed to enumerate SPI slaves\n");
2917 static inline void acpi_register_spi_devices(struct spi_controller *ctlr) {}
2918 #endif /* CONFIG_ACPI */
2920 static void spi_controller_release(struct device *dev)
2922 struct spi_controller *ctlr;
2924 ctlr = container_of(dev, struct spi_controller, dev);
2928 static struct class spi_master_class = {
2929 .name = "spi_master",
2930 .dev_release = spi_controller_release,
2931 .dev_groups = spi_master_groups,
2934 #ifdef CONFIG_SPI_SLAVE
2936 * spi_slave_abort - abort the ongoing transfer request on an SPI slave
2938 * @spi: device used for the current transfer
2940 int spi_slave_abort(struct spi_device *spi)
2942 struct spi_controller *ctlr = spi->controller;
2944 if (spi_controller_is_slave(ctlr) && ctlr->slave_abort)
2945 return ctlr->slave_abort(ctlr);
2949 EXPORT_SYMBOL_GPL(spi_slave_abort);
2951 int spi_target_abort(struct spi_device *spi)
2953 struct spi_controller *ctlr = spi->controller;
2955 if (spi_controller_is_target(ctlr) && ctlr->target_abort)
2956 return ctlr->target_abort(ctlr);
2960 EXPORT_SYMBOL_GPL(spi_target_abort);
2962 static ssize_t slave_show(struct device *dev, struct device_attribute *attr,
2965 struct spi_controller *ctlr = container_of(dev, struct spi_controller,
2967 struct device *child;
2969 child = device_find_any_child(&ctlr->dev);
2970 return sysfs_emit(buf, "%s\n", child ? to_spi_device(child)->modalias : NULL);
2973 static ssize_t slave_store(struct device *dev, struct device_attribute *attr,
2974 const char *buf, size_t count)
2976 struct spi_controller *ctlr = container_of(dev, struct spi_controller,
2978 struct spi_device *spi;
2979 struct device *child;
2983 rc = sscanf(buf, "%31s", name);
2984 if (rc != 1 || !name[0])
2987 child = device_find_any_child(&ctlr->dev);
2989 /* Remove registered slave */
2990 device_unregister(child);
2994 if (strcmp(name, "(null)")) {
2995 /* Register new slave */
2996 spi = spi_alloc_device(ctlr);
3000 strscpy(spi->modalias, name, sizeof(spi->modalias));
3002 rc = spi_add_device(spi);
3012 static DEVICE_ATTR_RW(slave);
3014 static struct attribute *spi_slave_attrs[] = {
3015 &dev_attr_slave.attr,
3019 static const struct attribute_group spi_slave_group = {
3020 .attrs = spi_slave_attrs,
3023 static const struct attribute_group *spi_slave_groups[] = {
3024 &spi_controller_statistics_group,
3029 static struct class spi_slave_class = {
3030 .name = "spi_slave",
3031 .dev_release = spi_controller_release,
3032 .dev_groups = spi_slave_groups,
3035 extern struct class spi_slave_class; /* dummy */
3039 * __spi_alloc_controller - allocate an SPI master or slave controller
3040 * @dev: the controller, possibly using the platform_bus
3041 * @size: how much zeroed driver-private data to allocate; the pointer to this
3042 * memory is in the driver_data field of the returned device, accessible
3043 * with spi_controller_get_devdata(); the memory is cacheline aligned;
3044 * drivers granting DMA access to portions of their private data need to
3045 * round up @size using ALIGN(size, dma_get_cache_alignment()).
3046 * @slave: flag indicating whether to allocate an SPI master (false) or SPI
3047 * slave (true) controller
3048 * Context: can sleep
3050 * This call is used only by SPI controller drivers, which are the
3051 * only ones directly touching chip registers. It's how they allocate
3052 * an spi_controller structure, prior to calling spi_register_controller().
3054 * This must be called from context that can sleep.
3056 * The caller is responsible for assigning the bus number and initializing the
3057 * controller's methods before calling spi_register_controller(); and (after
3058 * errors adding the device) calling spi_controller_put() to prevent a memory
3061 * Return: the SPI controller structure on success, else NULL.
3063 struct spi_controller *__spi_alloc_controller(struct device *dev,
3064 unsigned int size, bool slave)
3066 struct spi_controller *ctlr;
3067 size_t ctlr_size = ALIGN(sizeof(*ctlr), dma_get_cache_alignment());
3072 ctlr = kzalloc(size + ctlr_size, GFP_KERNEL);
3076 device_initialize(&ctlr->dev);
3077 INIT_LIST_HEAD(&ctlr->queue);
3078 spin_lock_init(&ctlr->queue_lock);
3079 spin_lock_init(&ctlr->bus_lock_spinlock);
3080 mutex_init(&ctlr->bus_lock_mutex);
3081 mutex_init(&ctlr->io_mutex);
3082 mutex_init(&ctlr->add_lock);
3084 ctlr->num_chipselect = 1;
3085 ctlr->slave = slave;
3086 if (IS_ENABLED(CONFIG_SPI_SLAVE) && slave)
3087 ctlr->dev.class = &spi_slave_class;
3089 ctlr->dev.class = &spi_master_class;
3090 ctlr->dev.parent = dev;
3091 pm_suspend_ignore_children(&ctlr->dev, true);
3092 spi_controller_set_devdata(ctlr, (void *)ctlr + ctlr_size);
3096 EXPORT_SYMBOL_GPL(__spi_alloc_controller);
3098 static void devm_spi_release_controller(struct device *dev, void *ctlr)
3100 spi_controller_put(*(struct spi_controller **)ctlr);
3104 * __devm_spi_alloc_controller - resource-managed __spi_alloc_controller()
3105 * @dev: physical device of SPI controller
3106 * @size: how much zeroed driver-private data to allocate
3107 * @slave: whether to allocate an SPI master (false) or SPI slave (true)
3108 * Context: can sleep
3110 * Allocate an SPI controller and automatically release a reference on it
3111 * when @dev is unbound from its driver. Drivers are thus relieved from
3112 * having to call spi_controller_put().
3114 * The arguments to this function are identical to __spi_alloc_controller().
3116 * Return: the SPI controller structure on success, else NULL.
3118 struct spi_controller *__devm_spi_alloc_controller(struct device *dev,
3122 struct spi_controller **ptr, *ctlr;
3124 ptr = devres_alloc(devm_spi_release_controller, sizeof(*ptr),
3129 ctlr = __spi_alloc_controller(dev, size, slave);
3131 ctlr->devm_allocated = true;
3133 devres_add(dev, ptr);
3140 EXPORT_SYMBOL_GPL(__devm_spi_alloc_controller);
3143 * spi_get_gpio_descs() - grab chip select GPIOs for the master
3144 * @ctlr: The SPI master to grab GPIO descriptors for
3146 static int spi_get_gpio_descs(struct spi_controller *ctlr)
3149 struct gpio_desc **cs;
3150 struct device *dev = &ctlr->dev;
3151 unsigned long native_cs_mask = 0;
3152 unsigned int num_cs_gpios = 0;
3154 nb = gpiod_count(dev, "cs");
3156 /* No GPIOs at all is fine, else return the error */
3162 ctlr->num_chipselect = max_t(int, nb, ctlr->num_chipselect);
3164 cs = devm_kcalloc(dev, ctlr->num_chipselect, sizeof(*cs),
3168 ctlr->cs_gpiods = cs;
3170 for (i = 0; i < nb; i++) {
3172 * Most chipselects are active low, the inverted
3173 * semantics are handled by special quirks in gpiolib,
3174 * so initializing them GPIOD_OUT_LOW here means
3175 * "unasserted", in most cases this will drive the physical
3178 cs[i] = devm_gpiod_get_index_optional(dev, "cs", i,
3181 return PTR_ERR(cs[i]);
3185 * If we find a CS GPIO, name it after the device and
3190 gpioname = devm_kasprintf(dev, GFP_KERNEL, "%s CS%d",
3194 gpiod_set_consumer_name(cs[i], gpioname);
3199 if (ctlr->max_native_cs && i >= ctlr->max_native_cs) {
3200 dev_err(dev, "Invalid native chip select %d\n", i);
3203 native_cs_mask |= BIT(i);
3206 ctlr->unused_native_cs = ffs(~native_cs_mask) - 1;
3208 if ((ctlr->flags & SPI_CONTROLLER_GPIO_SS) && num_cs_gpios &&
3209 ctlr->max_native_cs && ctlr->unused_native_cs >= ctlr->max_native_cs) {
3210 dev_err(dev, "No unused native chip select available\n");
3217 static int spi_controller_check_ops(struct spi_controller *ctlr)
3220 * The controller may implement only the high-level SPI-memory like
3221 * operations if it does not support regular SPI transfers, and this is
3223 * If ->mem_ops or ->mem_ops->exec_op is NULL, we request that at least
3224 * one of the ->transfer_xxx() method be implemented.
3226 if (!ctlr->mem_ops || !ctlr->mem_ops->exec_op) {
3227 if (!ctlr->transfer && !ctlr->transfer_one &&
3228 !ctlr->transfer_one_message) {
3236 /* Allocate dynamic bus number using Linux idr */
3237 static int spi_controller_id_alloc(struct spi_controller *ctlr, int start, int end)
3241 mutex_lock(&board_lock);
3242 id = idr_alloc(&spi_master_idr, ctlr, start, end, GFP_KERNEL);
3243 mutex_unlock(&board_lock);
3244 if (WARN(id < 0, "couldn't get idr"))
3245 return id == -ENOSPC ? -EBUSY : id;
3251 * spi_register_controller - register SPI master or slave controller
3252 * @ctlr: initialized master, originally from spi_alloc_master() or
3254 * Context: can sleep
3256 * SPI controllers connect to their drivers using some non-SPI bus,
3257 * such as the platform bus. The final stage of probe() in that code
3258 * includes calling spi_register_controller() to hook up to this SPI bus glue.
3260 * SPI controllers use board specific (often SOC specific) bus numbers,
3261 * and board-specific addressing for SPI devices combines those numbers
3262 * with chip select numbers. Since SPI does not directly support dynamic
3263 * device identification, boards need configuration tables telling which
3264 * chip is at which address.
3266 * This must be called from context that can sleep. It returns zero on
3267 * success, else a negative error code (dropping the controller's refcount).
3268 * After a successful return, the caller is responsible for calling
3269 * spi_unregister_controller().
3271 * Return: zero on success, else a negative error code.
3273 int spi_register_controller(struct spi_controller *ctlr)
3275 struct device *dev = ctlr->dev.parent;
3276 struct boardinfo *bi;
3285 * Make sure all necessary hooks are implemented before registering
3286 * the SPI controller.
3288 status = spi_controller_check_ops(ctlr);
3292 if (ctlr->bus_num < 0)
3293 ctlr->bus_num = of_alias_get_id(ctlr->dev.of_node, "spi");
3294 if (ctlr->bus_num >= 0) {
3295 /* Devices with a fixed bus num must check-in with the num */
3296 status = spi_controller_id_alloc(ctlr, ctlr->bus_num, ctlr->bus_num + 1);
3300 if (ctlr->bus_num < 0) {
3301 first_dynamic = of_alias_get_highest_id("spi");
3302 if (first_dynamic < 0)
3307 status = spi_controller_id_alloc(ctlr, first_dynamic, 0);
3311 ctlr->bus_lock_flag = 0;
3312 init_completion(&ctlr->xfer_completion);
3313 init_completion(&ctlr->cur_msg_completion);
3314 if (!ctlr->max_dma_len)
3315 ctlr->max_dma_len = INT_MAX;
3318 * Register the device, then userspace will see it.
3319 * Registration fails if the bus ID is in use.
3321 dev_set_name(&ctlr->dev, "spi%u", ctlr->bus_num);
3323 if (!spi_controller_is_slave(ctlr) && ctlr->use_gpio_descriptors) {
3324 status = spi_get_gpio_descs(ctlr);
3328 * A controller using GPIO descriptors always
3329 * supports SPI_CS_HIGH if need be.
3331 ctlr->mode_bits |= SPI_CS_HIGH;
3335 * Even if it's just one always-selected device, there must
3336 * be at least one chipselect.
3338 if (!ctlr->num_chipselect) {
3343 /* Setting last_cs to -1 means no chip selected */
3344 for (idx = 0; idx < SPI_CS_CNT_MAX; idx++)
3345 ctlr->last_cs[idx] = -1;
3347 status = device_add(&ctlr->dev);
3350 dev_dbg(dev, "registered %s %s\n",
3351 spi_controller_is_slave(ctlr) ? "slave" : "master",
3352 dev_name(&ctlr->dev));
3355 * If we're using a queued driver, start the queue. Note that we don't
3356 * need the queueing logic if the driver is only supporting high-level
3357 * memory operations.
3359 if (ctlr->transfer) {
3360 dev_info(dev, "controller is unqueued, this is deprecated\n");
3361 } else if (ctlr->transfer_one || ctlr->transfer_one_message) {
3362 status = spi_controller_initialize_queue(ctlr);
3364 device_del(&ctlr->dev);
3368 /* Add statistics */
3369 ctlr->pcpu_statistics = spi_alloc_pcpu_stats(dev);
3370 if (!ctlr->pcpu_statistics) {
3371 dev_err(dev, "Error allocating per-cpu statistics\n");
3376 mutex_lock(&board_lock);
3377 list_add_tail(&ctlr->list, &spi_controller_list);
3378 list_for_each_entry(bi, &board_list, list)
3379 spi_match_controller_to_boardinfo(ctlr, &bi->board_info);
3380 mutex_unlock(&board_lock);
3382 /* Register devices from the device tree and ACPI */
3383 of_register_spi_devices(ctlr);
3384 acpi_register_spi_devices(ctlr);
3388 spi_destroy_queue(ctlr);
3390 mutex_lock(&board_lock);
3391 idr_remove(&spi_master_idr, ctlr->bus_num);
3392 mutex_unlock(&board_lock);
3395 EXPORT_SYMBOL_GPL(spi_register_controller);
3397 static void devm_spi_unregister(struct device *dev, void *res)
3399 spi_unregister_controller(*(struct spi_controller **)res);
3403 * devm_spi_register_controller - register managed SPI master or slave
3405 * @dev: device managing SPI controller
3406 * @ctlr: initialized controller, originally from spi_alloc_master() or
3408 * Context: can sleep
3410 * Register a SPI device as with spi_register_controller() which will
3411 * automatically be unregistered and freed.
3413 * Return: zero on success, else a negative error code.
3415 int devm_spi_register_controller(struct device *dev,
3416 struct spi_controller *ctlr)
3418 struct spi_controller **ptr;
3421 ptr = devres_alloc(devm_spi_unregister, sizeof(*ptr), GFP_KERNEL);
3425 ret = spi_register_controller(ctlr);
3428 devres_add(dev, ptr);
3435 EXPORT_SYMBOL_GPL(devm_spi_register_controller);
3437 static int __unregister(struct device *dev, void *null)
3439 spi_unregister_device(to_spi_device(dev));
3444 * spi_unregister_controller - unregister SPI master or slave controller
3445 * @ctlr: the controller being unregistered
3446 * Context: can sleep
3448 * This call is used only by SPI controller drivers, which are the
3449 * only ones directly touching chip registers.
3451 * This must be called from context that can sleep.
3453 * Note that this function also drops a reference to the controller.
3455 void spi_unregister_controller(struct spi_controller *ctlr)
3457 struct spi_controller *found;
3458 int id = ctlr->bus_num;
3460 /* Prevent addition of new devices, unregister existing ones */
3461 if (IS_ENABLED(CONFIG_SPI_DYNAMIC))
3462 mutex_lock(&ctlr->add_lock);
3464 device_for_each_child(&ctlr->dev, NULL, __unregister);
3466 /* First make sure that this controller was ever added */
3467 mutex_lock(&board_lock);
3468 found = idr_find(&spi_master_idr, id);
3469 mutex_unlock(&board_lock);
3471 if (spi_destroy_queue(ctlr))
3472 dev_err(&ctlr->dev, "queue remove failed\n");
3474 mutex_lock(&board_lock);
3475 list_del(&ctlr->list);
3476 mutex_unlock(&board_lock);
3478 device_del(&ctlr->dev);
3481 mutex_lock(&board_lock);
3483 idr_remove(&spi_master_idr, id);
3484 mutex_unlock(&board_lock);
3486 if (IS_ENABLED(CONFIG_SPI_DYNAMIC))
3487 mutex_unlock(&ctlr->add_lock);
3490 * Release the last reference on the controller if its driver
3491 * has not yet been converted to devm_spi_alloc_master/slave().
3493 if (!ctlr->devm_allocated)
3494 put_device(&ctlr->dev);
3496 EXPORT_SYMBOL_GPL(spi_unregister_controller);
3498 static inline int __spi_check_suspended(const struct spi_controller *ctlr)
3500 return ctlr->flags & SPI_CONTROLLER_SUSPENDED ? -ESHUTDOWN : 0;
3503 static inline void __spi_mark_suspended(struct spi_controller *ctlr)
3505 mutex_lock(&ctlr->bus_lock_mutex);
3506 ctlr->flags |= SPI_CONTROLLER_SUSPENDED;
3507 mutex_unlock(&ctlr->bus_lock_mutex);
3510 static inline void __spi_mark_resumed(struct spi_controller *ctlr)
3512 mutex_lock(&ctlr->bus_lock_mutex);
3513 ctlr->flags &= ~SPI_CONTROLLER_SUSPENDED;
3514 mutex_unlock(&ctlr->bus_lock_mutex);
3517 int spi_controller_suspend(struct spi_controller *ctlr)
3521 /* Basically no-ops for non-queued controllers */
3523 ret = spi_stop_queue(ctlr);
3525 dev_err(&ctlr->dev, "queue stop failed\n");
3528 __spi_mark_suspended(ctlr);
3531 EXPORT_SYMBOL_GPL(spi_controller_suspend);
3533 int spi_controller_resume(struct spi_controller *ctlr)
3537 __spi_mark_resumed(ctlr);
3540 ret = spi_start_queue(ctlr);
3542 dev_err(&ctlr->dev, "queue restart failed\n");
3546 EXPORT_SYMBOL_GPL(spi_controller_resume);
3548 /*-------------------------------------------------------------------------*/
3550 /* Core methods for spi_message alterations */
3552 static void __spi_replace_transfers_release(struct spi_controller *ctlr,
3553 struct spi_message *msg,
3556 struct spi_replaced_transfers *rxfer = res;
3559 /* Call extra callback if requested */
3561 rxfer->release(ctlr, msg, res);
3563 /* Insert replaced transfers back into the message */
3564 list_splice(&rxfer->replaced_transfers, rxfer->replaced_after);
3566 /* Remove the formerly inserted entries */
3567 for (i = 0; i < rxfer->inserted; i++)
3568 list_del(&rxfer->inserted_transfers[i].transfer_list);
3572 * spi_replace_transfers - replace transfers with several transfers
3573 * and register change with spi_message.resources
3574 * @msg: the spi_message we work upon
3575 * @xfer_first: the first spi_transfer we want to replace
3576 * @remove: number of transfers to remove
3577 * @insert: the number of transfers we want to insert instead
3578 * @release: extra release code necessary in some circumstances
3579 * @extradatasize: extra data to allocate (with alignment guarantees
3580 * of struct @spi_transfer)
3583 * Returns: pointer to @spi_replaced_transfers,
3584 * PTR_ERR(...) in case of errors.
3586 static struct spi_replaced_transfers *spi_replace_transfers(
3587 struct spi_message *msg,
3588 struct spi_transfer *xfer_first,
3591 spi_replaced_release_t release,
3592 size_t extradatasize,
3595 struct spi_replaced_transfers *rxfer;
3596 struct spi_transfer *xfer;
3599 /* Allocate the structure using spi_res */
3600 rxfer = spi_res_alloc(msg->spi, __spi_replace_transfers_release,
3601 struct_size(rxfer, inserted_transfers, insert)
3605 return ERR_PTR(-ENOMEM);
3607 /* The release code to invoke before running the generic release */
3608 rxfer->release = release;
3610 /* Assign extradata */
3613 &rxfer->inserted_transfers[insert];
3615 /* Init the replaced_transfers list */
3616 INIT_LIST_HEAD(&rxfer->replaced_transfers);
3619 * Assign the list_entry after which we should reinsert
3620 * the @replaced_transfers - it may be spi_message.messages!
3622 rxfer->replaced_after = xfer_first->transfer_list.prev;
3624 /* Remove the requested number of transfers */
3625 for (i = 0; i < remove; i++) {
3627 * If the entry after replaced_after it is msg->transfers
3628 * then we have been requested to remove more transfers
3629 * than are in the list.
3631 if (rxfer->replaced_after->next == &msg->transfers) {
3632 dev_err(&msg->spi->dev,
3633 "requested to remove more spi_transfers than are available\n");
3634 /* Insert replaced transfers back into the message */
3635 list_splice(&rxfer->replaced_transfers,
3636 rxfer->replaced_after);
3638 /* Free the spi_replace_transfer structure... */
3639 spi_res_free(rxfer);
3641 /* ...and return with an error */
3642 return ERR_PTR(-EINVAL);
3646 * Remove the entry after replaced_after from list of
3647 * transfers and add it to list of replaced_transfers.
3649 list_move_tail(rxfer->replaced_after->next,
3650 &rxfer->replaced_transfers);
3654 * Create copy of the given xfer with identical settings
3655 * based on the first transfer to get removed.
3657 for (i = 0; i < insert; i++) {
3658 /* We need to run in reverse order */
3659 xfer = &rxfer->inserted_transfers[insert - 1 - i];
3661 /* Copy all spi_transfer data */
3662 memcpy(xfer, xfer_first, sizeof(*xfer));
3665 list_add(&xfer->transfer_list, rxfer->replaced_after);
3667 /* Clear cs_change and delay for all but the last */
3669 xfer->cs_change = false;
3670 xfer->delay.value = 0;
3674 /* Set up inserted... */
3675 rxfer->inserted = insert;
3677 /* ...and register it with spi_res/spi_message */
3678 spi_res_add(msg, rxfer);
3683 static int __spi_split_transfer_maxsize(struct spi_controller *ctlr,
3684 struct spi_message *msg,
3685 struct spi_transfer **xferp,
3689 struct spi_transfer *xfer = *xferp, *xfers;
3690 struct spi_replaced_transfers *srt;
3694 /* Calculate how many we have to replace */
3695 count = DIV_ROUND_UP(xfer->len, maxsize);
3697 /* Create replacement */
3698 srt = spi_replace_transfers(msg, xfer, 1, count, NULL, 0, gfp);
3700 return PTR_ERR(srt);
3701 xfers = srt->inserted_transfers;
3704 * Now handle each of those newly inserted spi_transfers.
3705 * Note that the replacements spi_transfers all are preset
3706 * to the same values as *xferp, so tx_buf, rx_buf and len
3707 * are all identical (as well as most others)
3708 * so we just have to fix up len and the pointers.
3710 * This also includes support for the depreciated
3711 * spi_message.is_dma_mapped interface.
3715 * The first transfer just needs the length modified, so we
3716 * run it outside the loop.
3718 xfers[0].len = min_t(size_t, maxsize, xfer[0].len);
3720 /* All the others need rx_buf/tx_buf also set */
3721 for (i = 1, offset = maxsize; i < count; offset += maxsize, i++) {
3722 /* Update rx_buf, tx_buf and DMA */
3723 if (xfers[i].rx_buf)
3724 xfers[i].rx_buf += offset;
3725 if (xfers[i].rx_dma)
3726 xfers[i].rx_dma += offset;
3727 if (xfers[i].tx_buf)
3728 xfers[i].tx_buf += offset;
3729 if (xfers[i].tx_dma)
3730 xfers[i].tx_dma += offset;
3733 xfers[i].len = min(maxsize, xfers[i].len - offset);
3737 * We set up xferp to the last entry we have inserted,
3738 * so that we skip those already split transfers.
3740 *xferp = &xfers[count - 1];
3742 /* Increment statistics counters */
3743 SPI_STATISTICS_INCREMENT_FIELD(ctlr->pcpu_statistics,
3744 transfers_split_maxsize);
3745 SPI_STATISTICS_INCREMENT_FIELD(msg->spi->pcpu_statistics,
3746 transfers_split_maxsize);
3752 * spi_split_transfers_maxsize - split spi transfers into multiple transfers
3753 * when an individual transfer exceeds a
3755 * @ctlr: the @spi_controller for this transfer
3756 * @msg: the @spi_message to transform
3757 * @maxsize: the maximum when to apply this
3758 * @gfp: GFP allocation flags
3760 * Return: status of transformation
3762 int spi_split_transfers_maxsize(struct spi_controller *ctlr,
3763 struct spi_message *msg,
3767 struct spi_transfer *xfer;
3771 * Iterate over the transfer_list,
3772 * but note that xfer is advanced to the last transfer inserted
3773 * to avoid checking sizes again unnecessarily (also xfer does
3774 * potentially belong to a different list by the time the
3775 * replacement has happened).
3777 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
3778 if (xfer->len > maxsize) {
3779 ret = __spi_split_transfer_maxsize(ctlr, msg, &xfer,
3788 EXPORT_SYMBOL_GPL(spi_split_transfers_maxsize);
3792 * spi_split_transfers_maxwords - split SPI transfers into multiple transfers
3793 * when an individual transfer exceeds a
3794 * certain number of SPI words
3795 * @ctlr: the @spi_controller for this transfer
3796 * @msg: the @spi_message to transform
3797 * @maxwords: the number of words to limit each transfer to
3798 * @gfp: GFP allocation flags
3800 * Return: status of transformation
3802 int spi_split_transfers_maxwords(struct spi_controller *ctlr,
3803 struct spi_message *msg,
3807 struct spi_transfer *xfer;
3810 * Iterate over the transfer_list,
3811 * but note that xfer is advanced to the last transfer inserted
3812 * to avoid checking sizes again unnecessarily (also xfer does
3813 * potentially belong to a different list by the time the
3814 * replacement has happened).
3816 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
3820 maxsize = maxwords * roundup_pow_of_two(BITS_TO_BYTES(xfer->bits_per_word));
3821 if (xfer->len > maxsize) {
3822 ret = __spi_split_transfer_maxsize(ctlr, msg, &xfer,
3831 EXPORT_SYMBOL_GPL(spi_split_transfers_maxwords);
3833 /*-------------------------------------------------------------------------*/
3836 * Core methods for SPI controller protocol drivers. Some of the
3837 * other core methods are currently defined as inline functions.
3840 static int __spi_validate_bits_per_word(struct spi_controller *ctlr,
3843 if (ctlr->bits_per_word_mask) {
3844 /* Only 32 bits fit in the mask */
3845 if (bits_per_word > 32)
3847 if (!(ctlr->bits_per_word_mask & SPI_BPW_MASK(bits_per_word)))
3855 * spi_set_cs_timing - configure CS setup, hold, and inactive delays
3856 * @spi: the device that requires specific CS timing configuration
3858 * Return: zero on success, else a negative error code.
3860 static int spi_set_cs_timing(struct spi_device *spi)
3862 struct device *parent = spi->controller->dev.parent;
3865 if (spi->controller->set_cs_timing && !spi_get_csgpiod(spi, 0)) {
3866 if (spi->controller->auto_runtime_pm) {
3867 status = pm_runtime_get_sync(parent);
3869 pm_runtime_put_noidle(parent);
3870 dev_err(&spi->controller->dev, "Failed to power device: %d\n",
3875 status = spi->controller->set_cs_timing(spi);
3876 pm_runtime_mark_last_busy(parent);
3877 pm_runtime_put_autosuspend(parent);
3879 status = spi->controller->set_cs_timing(spi);
3886 * spi_setup - setup SPI mode and clock rate
3887 * @spi: the device whose settings are being modified
3888 * Context: can sleep, and no requests are queued to the device
3890 * SPI protocol drivers may need to update the transfer mode if the
3891 * device doesn't work with its default. They may likewise need
3892 * to update clock rates or word sizes from initial values. This function
3893 * changes those settings, and must be called from a context that can sleep.
3894 * Except for SPI_CS_HIGH, which takes effect immediately, the changes take
3895 * effect the next time the device is selected and data is transferred to
3896 * or from it. When this function returns, the SPI device is deselected.
3898 * Note that this call will fail if the protocol driver specifies an option
3899 * that the underlying controller or its driver does not support. For
3900 * example, not all hardware supports wire transfers using nine bit words,
3901 * LSB-first wire encoding, or active-high chipselects.
3903 * Return: zero on success, else a negative error code.
3905 int spi_setup(struct spi_device *spi)
3907 unsigned bad_bits, ugly_bits;
3911 * Check mode to prevent that any two of DUAL, QUAD and NO_MOSI/MISO
3912 * are set at the same time.
3914 if ((hweight_long(spi->mode &
3915 (SPI_TX_DUAL | SPI_TX_QUAD | SPI_NO_TX)) > 1) ||
3916 (hweight_long(spi->mode &
3917 (SPI_RX_DUAL | SPI_RX_QUAD | SPI_NO_RX)) > 1)) {
3919 "setup: can not select any two of dual, quad and no-rx/tx at the same time\n");
3922 /* If it is SPI_3WIRE mode, DUAL and QUAD should be forbidden */
3923 if ((spi->mode & SPI_3WIRE) && (spi->mode &
3924 (SPI_TX_DUAL | SPI_TX_QUAD | SPI_TX_OCTAL |
3925 SPI_RX_DUAL | SPI_RX_QUAD | SPI_RX_OCTAL)))
3928 * Help drivers fail *cleanly* when they need options
3929 * that aren't supported with their current controller.
3930 * SPI_CS_WORD has a fallback software implementation,
3931 * so it is ignored here.
3933 bad_bits = spi->mode & ~(spi->controller->mode_bits | SPI_CS_WORD |
3934 SPI_NO_TX | SPI_NO_RX);
3935 ugly_bits = bad_bits &
3936 (SPI_TX_DUAL | SPI_TX_QUAD | SPI_TX_OCTAL |
3937 SPI_RX_DUAL | SPI_RX_QUAD | SPI_RX_OCTAL);
3940 "setup: ignoring unsupported mode bits %x\n",
3942 spi->mode &= ~ugly_bits;
3943 bad_bits &= ~ugly_bits;
3946 dev_err(&spi->dev, "setup: unsupported mode bits %x\n",
3951 if (!spi->bits_per_word) {
3952 spi->bits_per_word = 8;
3955 * Some controllers may not support the default 8 bits-per-word
3956 * so only perform the check when this is explicitly provided.
3958 status = __spi_validate_bits_per_word(spi->controller,
3959 spi->bits_per_word);
3964 if (spi->controller->max_speed_hz &&
3965 (!spi->max_speed_hz ||
3966 spi->max_speed_hz > spi->controller->max_speed_hz))
3967 spi->max_speed_hz = spi->controller->max_speed_hz;
3969 mutex_lock(&spi->controller->io_mutex);
3971 if (spi->controller->setup) {
3972 status = spi->controller->setup(spi);
3974 mutex_unlock(&spi->controller->io_mutex);
3975 dev_err(&spi->controller->dev, "Failed to setup device: %d\n",
3981 status = spi_set_cs_timing(spi);
3983 mutex_unlock(&spi->controller->io_mutex);
3987 if (spi->controller->auto_runtime_pm && spi->controller->set_cs) {
3988 status = pm_runtime_resume_and_get(spi->controller->dev.parent);
3990 mutex_unlock(&spi->controller->io_mutex);
3991 dev_err(&spi->controller->dev, "Failed to power device: %d\n",
3997 * We do not want to return positive value from pm_runtime_get,
3998 * there are many instances of devices calling spi_setup() and
3999 * checking for a non-zero return value instead of a negative
4004 spi_set_cs(spi, false, true);
4005 pm_runtime_mark_last_busy(spi->controller->dev.parent);
4006 pm_runtime_put_autosuspend(spi->controller->dev.parent);
4008 spi_set_cs(spi, false, true);
4011 mutex_unlock(&spi->controller->io_mutex);
4013 if (spi->rt && !spi->controller->rt) {
4014 spi->controller->rt = true;
4015 spi_set_thread_rt(spi->controller);
4018 trace_spi_setup(spi, status);
4020 dev_dbg(&spi->dev, "setup mode %lu, %s%s%s%s%u bits/w, %u Hz max --> %d\n",
4021 spi->mode & SPI_MODE_X_MASK,
4022 (spi->mode & SPI_CS_HIGH) ? "cs_high, " : "",
4023 (spi->mode & SPI_LSB_FIRST) ? "lsb, " : "",
4024 (spi->mode & SPI_3WIRE) ? "3wire, " : "",
4025 (spi->mode & SPI_LOOP) ? "loopback, " : "",
4026 spi->bits_per_word, spi->max_speed_hz,
4031 EXPORT_SYMBOL_GPL(spi_setup);
4033 static int _spi_xfer_word_delay_update(struct spi_transfer *xfer,
4034 struct spi_device *spi)
4038 delay1 = spi_delay_to_ns(&xfer->word_delay, xfer);
4042 delay2 = spi_delay_to_ns(&spi->word_delay, xfer);
4046 if (delay1 < delay2)
4047 memcpy(&xfer->word_delay, &spi->word_delay,
4048 sizeof(xfer->word_delay));
4053 static int __spi_validate(struct spi_device *spi, struct spi_message *message)
4055 struct spi_controller *ctlr = spi->controller;
4056 struct spi_transfer *xfer;
4059 if (list_empty(&message->transfers))
4063 * If an SPI controller does not support toggling the CS line on each
4064 * transfer (indicated by the SPI_CS_WORD flag) or we are using a GPIO
4065 * for the CS line, we can emulate the CS-per-word hardware function by
4066 * splitting transfers into one-word transfers and ensuring that
4067 * cs_change is set for each transfer.
4069 if ((spi->mode & SPI_CS_WORD) && (!(ctlr->mode_bits & SPI_CS_WORD) ||
4070 spi_is_csgpiod(spi))) {
4071 size_t maxsize = BITS_TO_BYTES(spi->bits_per_word);
4074 /* spi_split_transfers_maxsize() requires message->spi */
4077 ret = spi_split_transfers_maxsize(ctlr, message, maxsize,
4082 list_for_each_entry(xfer, &message->transfers, transfer_list) {
4083 /* Don't change cs_change on the last entry in the list */
4084 if (list_is_last(&xfer->transfer_list, &message->transfers))
4086 xfer->cs_change = 1;
4091 * Half-duplex links include original MicroWire, and ones with
4092 * only one data pin like SPI_3WIRE (switches direction) or where
4093 * either MOSI or MISO is missing. They can also be caused by
4094 * software limitations.
4096 if ((ctlr->flags & SPI_CONTROLLER_HALF_DUPLEX) ||
4097 (spi->mode & SPI_3WIRE)) {
4098 unsigned flags = ctlr->flags;
4100 list_for_each_entry(xfer, &message->transfers, transfer_list) {
4101 if (xfer->rx_buf && xfer->tx_buf)
4103 if ((flags & SPI_CONTROLLER_NO_TX) && xfer->tx_buf)
4105 if ((flags & SPI_CONTROLLER_NO_RX) && xfer->rx_buf)
4111 * Set transfer bits_per_word and max speed as spi device default if
4112 * it is not set for this transfer.
4113 * Set transfer tx_nbits and rx_nbits as single transfer default
4114 * (SPI_NBITS_SINGLE) if it is not set for this transfer.
4115 * Ensure transfer word_delay is at least as long as that required by
4118 message->frame_length = 0;
4119 list_for_each_entry(xfer, &message->transfers, transfer_list) {
4120 xfer->effective_speed_hz = 0;
4121 message->frame_length += xfer->len;
4122 if (!xfer->bits_per_word)
4123 xfer->bits_per_word = spi->bits_per_word;
4125 if (!xfer->speed_hz)
4126 xfer->speed_hz = spi->max_speed_hz;
4128 if (ctlr->max_speed_hz && xfer->speed_hz > ctlr->max_speed_hz)
4129 xfer->speed_hz = ctlr->max_speed_hz;
4131 if (__spi_validate_bits_per_word(ctlr, xfer->bits_per_word))
4135 * SPI transfer length should be multiple of SPI word size
4136 * where SPI word size should be power-of-two multiple.
4138 if (xfer->bits_per_word <= 8)
4140 else if (xfer->bits_per_word <= 16)
4145 /* No partial transfers accepted */
4146 if (xfer->len % w_size)
4149 if (xfer->speed_hz && ctlr->min_speed_hz &&
4150 xfer->speed_hz < ctlr->min_speed_hz)
4153 if (xfer->tx_buf && !xfer->tx_nbits)
4154 xfer->tx_nbits = SPI_NBITS_SINGLE;
4155 if (xfer->rx_buf && !xfer->rx_nbits)
4156 xfer->rx_nbits = SPI_NBITS_SINGLE;
4158 * Check transfer tx/rx_nbits:
4159 * 1. check the value matches one of single, dual and quad
4160 * 2. check tx/rx_nbits match the mode in spi_device
4163 if (spi->mode & SPI_NO_TX)
4165 if (xfer->tx_nbits != SPI_NBITS_SINGLE &&
4166 xfer->tx_nbits != SPI_NBITS_DUAL &&
4167 xfer->tx_nbits != SPI_NBITS_QUAD)
4169 if ((xfer->tx_nbits == SPI_NBITS_DUAL) &&
4170 !(spi->mode & (SPI_TX_DUAL | SPI_TX_QUAD)))
4172 if ((xfer->tx_nbits == SPI_NBITS_QUAD) &&
4173 !(spi->mode & SPI_TX_QUAD))
4176 /* Check transfer rx_nbits */
4178 if (spi->mode & SPI_NO_RX)
4180 if (xfer->rx_nbits != SPI_NBITS_SINGLE &&
4181 xfer->rx_nbits != SPI_NBITS_DUAL &&
4182 xfer->rx_nbits != SPI_NBITS_QUAD)
4184 if ((xfer->rx_nbits == SPI_NBITS_DUAL) &&
4185 !(spi->mode & (SPI_RX_DUAL | SPI_RX_QUAD)))
4187 if ((xfer->rx_nbits == SPI_NBITS_QUAD) &&
4188 !(spi->mode & SPI_RX_QUAD))
4192 if (_spi_xfer_word_delay_update(xfer, spi))
4196 message->status = -EINPROGRESS;
4201 static int __spi_async(struct spi_device *spi, struct spi_message *message)
4203 struct spi_controller *ctlr = spi->controller;
4204 struct spi_transfer *xfer;
4207 * Some controllers do not support doing regular SPI transfers. Return
4208 * ENOTSUPP when this is the case.
4210 if (!ctlr->transfer)
4215 SPI_STATISTICS_INCREMENT_FIELD(ctlr->pcpu_statistics, spi_async);
4216 SPI_STATISTICS_INCREMENT_FIELD(spi->pcpu_statistics, spi_async);
4218 trace_spi_message_submit(message);
4220 if (!ctlr->ptp_sts_supported) {
4221 list_for_each_entry(xfer, &message->transfers, transfer_list) {
4222 xfer->ptp_sts_word_pre = 0;
4223 ptp_read_system_prets(xfer->ptp_sts);
4227 return ctlr->transfer(spi, message);
4231 * spi_async - asynchronous SPI transfer
4232 * @spi: device with which data will be exchanged
4233 * @message: describes the data transfers, including completion callback
4234 * Context: any (IRQs may be blocked, etc)
4236 * This call may be used in_irq and other contexts which can't sleep,
4237 * as well as from task contexts which can sleep.
4239 * The completion callback is invoked in a context which can't sleep.
4240 * Before that invocation, the value of message->status is undefined.
4241 * When the callback is issued, message->status holds either zero (to
4242 * indicate complete success) or a negative error code. After that
4243 * callback returns, the driver which issued the transfer request may
4244 * deallocate the associated memory; it's no longer in use by any SPI
4245 * core or controller driver code.
4247 * Note that although all messages to a spi_device are handled in
4248 * FIFO order, messages may go to different devices in other orders.
4249 * Some device might be higher priority, or have various "hard" access
4250 * time requirements, for example.
4252 * On detection of any fault during the transfer, processing of
4253 * the entire message is aborted, and the device is deselected.
4254 * Until returning from the associated message completion callback,
4255 * no other spi_message queued to that device will be processed.
4256 * (This rule applies equally to all the synchronous transfer calls,
4257 * which are wrappers around this core asynchronous primitive.)
4259 * Return: zero on success, else a negative error code.
4261 int spi_async(struct spi_device *spi, struct spi_message *message)
4263 struct spi_controller *ctlr = spi->controller;
4265 unsigned long flags;
4267 ret = __spi_validate(spi, message);
4271 spin_lock_irqsave(&ctlr->bus_lock_spinlock, flags);
4273 if (ctlr->bus_lock_flag)
4276 ret = __spi_async(spi, message);
4278 spin_unlock_irqrestore(&ctlr->bus_lock_spinlock, flags);
4282 EXPORT_SYMBOL_GPL(spi_async);
4285 * spi_async_locked - version of spi_async with exclusive bus usage
4286 * @spi: device with which data will be exchanged
4287 * @message: describes the data transfers, including completion callback
4288 * Context: any (IRQs may be blocked, etc)
4290 * This call may be used in_irq and other contexts which can't sleep,
4291 * as well as from task contexts which can sleep.
4293 * The completion callback is invoked in a context which can't sleep.
4294 * Before that invocation, the value of message->status is undefined.
4295 * When the callback is issued, message->status holds either zero (to
4296 * indicate complete success) or a negative error code. After that
4297 * callback returns, the driver which issued the transfer request may
4298 * deallocate the associated memory; it's no longer in use by any SPI
4299 * core or controller driver code.
4301 * Note that although all messages to a spi_device are handled in
4302 * FIFO order, messages may go to different devices in other orders.
4303 * Some device might be higher priority, or have various "hard" access
4304 * time requirements, for example.
4306 * On detection of any fault during the transfer, processing of
4307 * the entire message is aborted, and the device is deselected.
4308 * Until returning from the associated message completion callback,
4309 * no other spi_message queued to that device will be processed.
4310 * (This rule applies equally to all the synchronous transfer calls,
4311 * which are wrappers around this core asynchronous primitive.)
4313 * Return: zero on success, else a negative error code.
4315 static int spi_async_locked(struct spi_device *spi, struct spi_message *message)
4317 struct spi_controller *ctlr = spi->controller;
4319 unsigned long flags;
4321 ret = __spi_validate(spi, message);
4325 spin_lock_irqsave(&ctlr->bus_lock_spinlock, flags);
4327 ret = __spi_async(spi, message);
4329 spin_unlock_irqrestore(&ctlr->bus_lock_spinlock, flags);
4335 static void __spi_transfer_message_noqueue(struct spi_controller *ctlr, struct spi_message *msg)
4340 mutex_lock(&ctlr->io_mutex);
4342 was_busy = ctlr->busy;
4344 ctlr->cur_msg = msg;
4345 ret = __spi_pump_transfer_message(ctlr, msg, was_busy);
4347 dev_err(&ctlr->dev, "noqueue transfer failed\n");
4348 ctlr->cur_msg = NULL;
4349 ctlr->fallback = false;
4352 kfree(ctlr->dummy_rx);
4353 ctlr->dummy_rx = NULL;
4354 kfree(ctlr->dummy_tx);
4355 ctlr->dummy_tx = NULL;
4356 if (ctlr->unprepare_transfer_hardware &&
4357 ctlr->unprepare_transfer_hardware(ctlr))
4359 "failed to unprepare transfer hardware\n");
4360 spi_idle_runtime_pm(ctlr);
4363 mutex_unlock(&ctlr->io_mutex);
4366 /*-------------------------------------------------------------------------*/
4369 * Utility methods for SPI protocol drivers, layered on
4370 * top of the core. Some other utility methods are defined as
4374 static void spi_complete(void *arg)
4379 static int __spi_sync(struct spi_device *spi, struct spi_message *message)
4381 DECLARE_COMPLETION_ONSTACK(done);
4383 struct spi_controller *ctlr = spi->controller;
4385 if (__spi_check_suspended(ctlr)) {
4386 dev_warn_once(&spi->dev, "Attempted to sync while suspend\n");
4390 status = __spi_validate(spi, message);
4396 SPI_STATISTICS_INCREMENT_FIELD(ctlr->pcpu_statistics, spi_sync);
4397 SPI_STATISTICS_INCREMENT_FIELD(spi->pcpu_statistics, spi_sync);
4400 * Checking queue_empty here only guarantees async/sync message
4401 * ordering when coming from the same context. It does not need to
4402 * guard against reentrancy from a different context. The io_mutex
4403 * will catch those cases.
4405 if (READ_ONCE(ctlr->queue_empty) && !ctlr->must_async) {
4406 message->actual_length = 0;
4407 message->status = -EINPROGRESS;
4409 trace_spi_message_submit(message);
4411 SPI_STATISTICS_INCREMENT_FIELD(ctlr->pcpu_statistics, spi_sync_immediate);
4412 SPI_STATISTICS_INCREMENT_FIELD(spi->pcpu_statistics, spi_sync_immediate);
4414 __spi_transfer_message_noqueue(ctlr, message);
4416 return message->status;
4420 * There are messages in the async queue that could have originated
4421 * from the same context, so we need to preserve ordering.
4422 * Therefor we send the message to the async queue and wait until they
4425 message->complete = spi_complete;
4426 message->context = &done;
4427 status = spi_async_locked(spi, message);
4429 wait_for_completion(&done);
4430 status = message->status;
4432 message->context = NULL;
4438 * spi_sync - blocking/synchronous SPI data transfers
4439 * @spi: device with which data will be exchanged
4440 * @message: describes the data transfers
4441 * Context: can sleep
4443 * This call may only be used from a context that may sleep. The sleep
4444 * is non-interruptible, and has no timeout. Low-overhead controller
4445 * drivers may DMA directly into and out of the message buffers.
4447 * Note that the SPI device's chip select is active during the message,
4448 * and then is normally disabled between messages. Drivers for some
4449 * frequently-used devices may want to minimize costs of selecting a chip,
4450 * by leaving it selected in anticipation that the next message will go
4451 * to the same chip. (That may increase power usage.)
4453 * Also, the caller is guaranteeing that the memory associated with the
4454 * message will not be freed before this call returns.
4456 * Return: zero on success, else a negative error code.
4458 int spi_sync(struct spi_device *spi, struct spi_message *message)
4462 mutex_lock(&spi->controller->bus_lock_mutex);
4463 ret = __spi_sync(spi, message);
4464 mutex_unlock(&spi->controller->bus_lock_mutex);
4468 EXPORT_SYMBOL_GPL(spi_sync);
4471 * spi_sync_locked - version of spi_sync with exclusive bus usage
4472 * @spi: device with which data will be exchanged
4473 * @message: describes the data transfers
4474 * Context: can sleep
4476 * This call may only be used from a context that may sleep. The sleep
4477 * is non-interruptible, and has no timeout. Low-overhead controller
4478 * drivers may DMA directly into and out of the message buffers.
4480 * This call should be used by drivers that require exclusive access to the
4481 * SPI bus. It has to be preceded by a spi_bus_lock call. The SPI bus must
4482 * be released by a spi_bus_unlock call when the exclusive access is over.
4484 * Return: zero on success, else a negative error code.
4486 int spi_sync_locked(struct spi_device *spi, struct spi_message *message)
4488 return __spi_sync(spi, message);
4490 EXPORT_SYMBOL_GPL(spi_sync_locked);
4493 * spi_bus_lock - obtain a lock for exclusive SPI bus usage
4494 * @ctlr: SPI bus master that should be locked for exclusive bus access
4495 * Context: can sleep
4497 * This call may only be used from a context that may sleep. The sleep
4498 * is non-interruptible, and has no timeout.
4500 * This call should be used by drivers that require exclusive access to the
4501 * SPI bus. The SPI bus must be released by a spi_bus_unlock call when the
4502 * exclusive access is over. Data transfer must be done by spi_sync_locked
4503 * and spi_async_locked calls when the SPI bus lock is held.
4505 * Return: always zero.
4507 int spi_bus_lock(struct spi_controller *ctlr)
4509 unsigned long flags;
4511 mutex_lock(&ctlr->bus_lock_mutex);
4513 spin_lock_irqsave(&ctlr->bus_lock_spinlock, flags);
4514 ctlr->bus_lock_flag = 1;
4515 spin_unlock_irqrestore(&ctlr->bus_lock_spinlock, flags);
4517 /* Mutex remains locked until spi_bus_unlock() is called */
4521 EXPORT_SYMBOL_GPL(spi_bus_lock);
4524 * spi_bus_unlock - release the lock for exclusive SPI bus usage
4525 * @ctlr: SPI bus master that was locked for exclusive bus access
4526 * Context: can sleep
4528 * This call may only be used from a context that may sleep. The sleep
4529 * is non-interruptible, and has no timeout.
4531 * This call releases an SPI bus lock previously obtained by an spi_bus_lock
4534 * Return: always zero.
4536 int spi_bus_unlock(struct spi_controller *ctlr)
4538 ctlr->bus_lock_flag = 0;
4540 mutex_unlock(&ctlr->bus_lock_mutex);
4544 EXPORT_SYMBOL_GPL(spi_bus_unlock);
4546 /* Portable code must never pass more than 32 bytes */
4547 #define SPI_BUFSIZ max(32, SMP_CACHE_BYTES)
4552 * spi_write_then_read - SPI synchronous write followed by read
4553 * @spi: device with which data will be exchanged
4554 * @txbuf: data to be written (need not be DMA-safe)
4555 * @n_tx: size of txbuf, in bytes
4556 * @rxbuf: buffer into which data will be read (need not be DMA-safe)
4557 * @n_rx: size of rxbuf, in bytes
4558 * Context: can sleep
4560 * This performs a half duplex MicroWire style transaction with the
4561 * device, sending txbuf and then reading rxbuf. The return value
4562 * is zero for success, else a negative errno status code.
4563 * This call may only be used from a context that may sleep.
4565 * Parameters to this routine are always copied using a small buffer.
4566 * Performance-sensitive or bulk transfer code should instead use
4567 * spi_{async,sync}() calls with DMA-safe buffers.
4569 * Return: zero on success, else a negative error code.
4571 int spi_write_then_read(struct spi_device *spi,
4572 const void *txbuf, unsigned n_tx,
4573 void *rxbuf, unsigned n_rx)
4575 static DEFINE_MUTEX(lock);
4578 struct spi_message message;
4579 struct spi_transfer x[2];
4583 * Use preallocated DMA-safe buffer if we can. We can't avoid
4584 * copying here, (as a pure convenience thing), but we can
4585 * keep heap costs out of the hot path unless someone else is
4586 * using the pre-allocated buffer or the transfer is too large.
4588 if ((n_tx + n_rx) > SPI_BUFSIZ || !mutex_trylock(&lock)) {
4589 local_buf = kmalloc(max((unsigned)SPI_BUFSIZ, n_tx + n_rx),
4590 GFP_KERNEL | GFP_DMA);
4597 spi_message_init(&message);
4598 memset(x, 0, sizeof(x));
4601 spi_message_add_tail(&x[0], &message);
4605 spi_message_add_tail(&x[1], &message);
4608 memcpy(local_buf, txbuf, n_tx);
4609 x[0].tx_buf = local_buf;
4610 x[1].rx_buf = local_buf + n_tx;
4613 status = spi_sync(spi, &message);
4615 memcpy(rxbuf, x[1].rx_buf, n_rx);
4617 if (x[0].tx_buf == buf)
4618 mutex_unlock(&lock);
4624 EXPORT_SYMBOL_GPL(spi_write_then_read);
4626 /*-------------------------------------------------------------------------*/
4628 #if IS_ENABLED(CONFIG_OF_DYNAMIC)
4629 /* Must call put_device() when done with returned spi_device device */
4630 static struct spi_device *of_find_spi_device_by_node(struct device_node *node)
4632 struct device *dev = bus_find_device_by_of_node(&spi_bus_type, node);
4634 return dev ? to_spi_device(dev) : NULL;
4637 /* The spi controllers are not using spi_bus, so we find it with another way */
4638 static struct spi_controller *of_find_spi_controller_by_node(struct device_node *node)
4642 dev = class_find_device_by_of_node(&spi_master_class, node);
4643 if (!dev && IS_ENABLED(CONFIG_SPI_SLAVE))
4644 dev = class_find_device_by_of_node(&spi_slave_class, node);
4648 /* Reference got in class_find_device */
4649 return container_of(dev, struct spi_controller, dev);
4652 static int of_spi_notify(struct notifier_block *nb, unsigned long action,
4655 struct of_reconfig_data *rd = arg;
4656 struct spi_controller *ctlr;
4657 struct spi_device *spi;
4659 switch (of_reconfig_get_state_change(action, arg)) {
4660 case OF_RECONFIG_CHANGE_ADD:
4661 ctlr = of_find_spi_controller_by_node(rd->dn->parent);
4663 return NOTIFY_OK; /* Not for us */
4665 if (of_node_test_and_set_flag(rd->dn, OF_POPULATED)) {
4666 put_device(&ctlr->dev);
4671 * Clear the flag before adding the device so that fw_devlink
4672 * doesn't skip adding consumers to this device.
4674 rd->dn->fwnode.flags &= ~FWNODE_FLAG_NOT_DEVICE;
4675 spi = of_register_spi_device(ctlr, rd->dn);
4676 put_device(&ctlr->dev);
4679 pr_err("%s: failed to create for '%pOF'\n",
4681 of_node_clear_flag(rd->dn, OF_POPULATED);
4682 return notifier_from_errno(PTR_ERR(spi));
4686 case OF_RECONFIG_CHANGE_REMOVE:
4687 /* Already depopulated? */
4688 if (!of_node_check_flag(rd->dn, OF_POPULATED))
4691 /* Find our device by node */
4692 spi = of_find_spi_device_by_node(rd->dn);
4694 return NOTIFY_OK; /* No? not meant for us */
4696 /* Unregister takes one ref away */
4697 spi_unregister_device(spi);
4699 /* And put the reference of the find */
4700 put_device(&spi->dev);
4707 static struct notifier_block spi_of_notifier = {
4708 .notifier_call = of_spi_notify,
4710 #else /* IS_ENABLED(CONFIG_OF_DYNAMIC) */
4711 extern struct notifier_block spi_of_notifier;
4712 #endif /* IS_ENABLED(CONFIG_OF_DYNAMIC) */
4714 #if IS_ENABLED(CONFIG_ACPI)
4715 static int spi_acpi_controller_match(struct device *dev, const void *data)
4717 return ACPI_COMPANION(dev->parent) == data;
4720 struct spi_controller *acpi_spi_find_controller_by_adev(struct acpi_device *adev)
4724 dev = class_find_device(&spi_master_class, NULL, adev,
4725 spi_acpi_controller_match);
4726 if (!dev && IS_ENABLED(CONFIG_SPI_SLAVE))
4727 dev = class_find_device(&spi_slave_class, NULL, adev,
4728 spi_acpi_controller_match);
4732 return container_of(dev, struct spi_controller, dev);
4734 EXPORT_SYMBOL_GPL(acpi_spi_find_controller_by_adev);
4736 static struct spi_device *acpi_spi_find_device_by_adev(struct acpi_device *adev)
4740 dev = bus_find_device_by_acpi_dev(&spi_bus_type, adev);
4741 return to_spi_device(dev);
4744 static int acpi_spi_notify(struct notifier_block *nb, unsigned long value,
4747 struct acpi_device *adev = arg;
4748 struct spi_controller *ctlr;
4749 struct spi_device *spi;
4752 case ACPI_RECONFIG_DEVICE_ADD:
4753 ctlr = acpi_spi_find_controller_by_adev(acpi_dev_parent(adev));
4757 acpi_register_spi_device(ctlr, adev);
4758 put_device(&ctlr->dev);
4760 case ACPI_RECONFIG_DEVICE_REMOVE:
4761 if (!acpi_device_enumerated(adev))
4764 spi = acpi_spi_find_device_by_adev(adev);
4768 spi_unregister_device(spi);
4769 put_device(&spi->dev);
4776 static struct notifier_block spi_acpi_notifier = {
4777 .notifier_call = acpi_spi_notify,
4780 extern struct notifier_block spi_acpi_notifier;
4783 static int __init spi_init(void)
4787 buf = kmalloc(SPI_BUFSIZ, GFP_KERNEL);
4793 status = bus_register(&spi_bus_type);
4797 status = class_register(&spi_master_class);
4801 if (IS_ENABLED(CONFIG_SPI_SLAVE)) {
4802 status = class_register(&spi_slave_class);
4807 if (IS_ENABLED(CONFIG_OF_DYNAMIC))
4808 WARN_ON(of_reconfig_notifier_register(&spi_of_notifier));
4809 if (IS_ENABLED(CONFIG_ACPI))
4810 WARN_ON(acpi_reconfig_notifier_register(&spi_acpi_notifier));
4815 class_unregister(&spi_master_class);
4817 bus_unregister(&spi_bus_type);
4826 * A board_info is normally registered in arch_initcall(),
4827 * but even essential drivers wait till later.
4829 * REVISIT only boardinfo really needs static linking. The rest (device and
4830 * driver registration) _could_ be dynamically linked (modular) ... Costs
4831 * include needing to have boardinfo data structures be much more public.
4833 postcore_initcall(spi_init);