4 * Copyright (C) 2005 David Brownell
5 * Copyright (C) 2008 Secret Lab Technologies Ltd.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
18 #include <linux/kernel.h>
19 #include <linux/kmod.h>
20 #include <linux/device.h>
21 #include <linux/init.h>
22 #include <linux/cache.h>
23 #include <linux/dma-mapping.h>
24 #include <linux/dmaengine.h>
25 #include <linux/mutex.h>
26 #include <linux/of_device.h>
27 #include <linux/of_irq.h>
28 #include <linux/clk/clk-conf.h>
29 #include <linux/slab.h>
30 #include <linux/mod_devicetable.h>
31 #include <linux/spi/spi.h>
32 #include <linux/of_gpio.h>
33 #include <linux/pm_runtime.h>
34 #include <linux/pm_domain.h>
35 #include <linux/export.h>
36 #include <linux/sched/rt.h>
37 #include <linux/delay.h>
38 #include <linux/kthread.h>
39 #include <linux/ioport.h>
40 #include <linux/acpi.h>
42 #define CREATE_TRACE_POINTS
43 #include <trace/events/spi.h>
45 static void spidev_release(struct device *dev)
47 struct spi_device *spi = to_spi_device(dev);
49 /* spi masters may cleanup for released devices */
50 if (spi->master->cleanup)
51 spi->master->cleanup(spi);
53 spi_master_put(spi->master);
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 sprintf(buf, "%s%s\n", SPI_MODULE_PREFIX, spi->modalias);
69 static DEVICE_ATTR_RO(modalias);
71 static struct attribute *spi_dev_attrs[] = {
72 &dev_attr_modalias.attr,
75 ATTRIBUTE_GROUPS(spi_dev);
77 /* modalias support makes "modprobe $MODALIAS" new-style hotplug work,
78 * and the sysfs version makes coldplug work too.
81 static const struct spi_device_id *spi_match_id(const struct spi_device_id *id,
82 const struct spi_device *sdev)
85 if (!strcmp(sdev->modalias, id->name))
92 const struct spi_device_id *spi_get_device_id(const struct spi_device *sdev)
94 const struct spi_driver *sdrv = to_spi_driver(sdev->dev.driver);
96 return spi_match_id(sdrv->id_table, sdev);
98 EXPORT_SYMBOL_GPL(spi_get_device_id);
100 static int spi_match_device(struct device *dev, struct device_driver *drv)
102 const struct spi_device *spi = to_spi_device(dev);
103 const struct spi_driver *sdrv = to_spi_driver(drv);
105 /* Attempt an OF style match */
106 if (of_driver_match_device(dev, drv))
110 if (acpi_driver_match_device(dev, drv))
114 return !!spi_match_id(sdrv->id_table, spi);
116 return strcmp(spi->modalias, drv->name) == 0;
119 static int spi_uevent(struct device *dev, struct kobj_uevent_env *env)
121 const struct spi_device *spi = to_spi_device(dev);
124 rc = acpi_device_uevent_modalias(dev, env);
128 add_uevent_var(env, "MODALIAS=%s%s", SPI_MODULE_PREFIX, spi->modalias);
132 #ifdef CONFIG_PM_SLEEP
133 static int spi_legacy_suspend(struct device *dev, pm_message_t message)
136 struct spi_driver *drv = to_spi_driver(dev->driver);
138 /* suspend will stop irqs and dma; no more i/o */
141 value = drv->suspend(to_spi_device(dev), message);
143 dev_dbg(dev, "... can't suspend\n");
148 static int spi_legacy_resume(struct device *dev)
151 struct spi_driver *drv = to_spi_driver(dev->driver);
153 /* resume may restart the i/o queue */
156 value = drv->resume(to_spi_device(dev));
158 dev_dbg(dev, "... can't resume\n");
163 static int spi_pm_suspend(struct device *dev)
165 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
168 return pm_generic_suspend(dev);
170 return spi_legacy_suspend(dev, PMSG_SUSPEND);
173 static int spi_pm_resume(struct device *dev)
175 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
178 return pm_generic_resume(dev);
180 return spi_legacy_resume(dev);
183 static int spi_pm_freeze(struct device *dev)
185 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
188 return pm_generic_freeze(dev);
190 return spi_legacy_suspend(dev, PMSG_FREEZE);
193 static int spi_pm_thaw(struct device *dev)
195 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
198 return pm_generic_thaw(dev);
200 return spi_legacy_resume(dev);
203 static int spi_pm_poweroff(struct device *dev)
205 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
208 return pm_generic_poweroff(dev);
210 return spi_legacy_suspend(dev, PMSG_HIBERNATE);
213 static int spi_pm_restore(struct device *dev)
215 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
218 return pm_generic_restore(dev);
220 return spi_legacy_resume(dev);
223 #define spi_pm_suspend NULL
224 #define spi_pm_resume NULL
225 #define spi_pm_freeze NULL
226 #define spi_pm_thaw NULL
227 #define spi_pm_poweroff NULL
228 #define spi_pm_restore NULL
231 static const struct dev_pm_ops spi_pm = {
232 .suspend = spi_pm_suspend,
233 .resume = spi_pm_resume,
234 .freeze = spi_pm_freeze,
236 .poweroff = spi_pm_poweroff,
237 .restore = spi_pm_restore,
239 pm_generic_runtime_suspend,
240 pm_generic_runtime_resume,
245 struct bus_type spi_bus_type = {
247 .dev_groups = spi_dev_groups,
248 .match = spi_match_device,
249 .uevent = spi_uevent,
252 EXPORT_SYMBOL_GPL(spi_bus_type);
255 static int spi_drv_probe(struct device *dev)
257 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
260 ret = of_clk_set_defaults(dev->of_node, false);
264 ret = dev_pm_domain_attach(dev, true);
265 if (ret != -EPROBE_DEFER) {
266 ret = sdrv->probe(to_spi_device(dev));
268 dev_pm_domain_detach(dev, true);
274 static int spi_drv_remove(struct device *dev)
276 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
279 ret = sdrv->remove(to_spi_device(dev));
280 dev_pm_domain_detach(dev, true);
285 static void spi_drv_shutdown(struct device *dev)
287 const struct spi_driver *sdrv = to_spi_driver(dev->driver);
289 sdrv->shutdown(to_spi_device(dev));
293 * spi_register_driver - register a SPI driver
294 * @sdrv: the driver to register
297 int spi_register_driver(struct spi_driver *sdrv)
299 sdrv->driver.bus = &spi_bus_type;
301 sdrv->driver.probe = spi_drv_probe;
303 sdrv->driver.remove = spi_drv_remove;
305 sdrv->driver.shutdown = spi_drv_shutdown;
306 return driver_register(&sdrv->driver);
308 EXPORT_SYMBOL_GPL(spi_register_driver);
310 /*-------------------------------------------------------------------------*/
312 /* SPI devices should normally not be created by SPI device drivers; that
313 * would make them board-specific. Similarly with SPI master drivers.
314 * Device registration normally goes into like arch/.../mach.../board-YYY.c
315 * with other readonly (flashable) information about mainboard devices.
319 struct list_head list;
320 struct spi_board_info board_info;
323 static LIST_HEAD(board_list);
324 static LIST_HEAD(spi_master_list);
327 * Used to protect add/del opertion for board_info list and
328 * spi_master list, and their matching process
330 static DEFINE_MUTEX(board_lock);
333 * spi_alloc_device - Allocate a new SPI device
334 * @master: Controller to which device is connected
337 * Allows a driver to allocate and initialize a spi_device without
338 * registering it immediately. This allows a driver to directly
339 * fill the spi_device with device parameters before calling
340 * spi_add_device() on it.
342 * Caller is responsible to call spi_add_device() on the returned
343 * spi_device structure to add it to the SPI master. If the caller
344 * needs to discard the spi_device without adding it, then it should
345 * call spi_dev_put() on it.
347 * Returns a pointer to the new device, or NULL.
349 struct spi_device *spi_alloc_device(struct spi_master *master)
351 struct spi_device *spi;
353 if (!spi_master_get(master))
356 spi = kzalloc(sizeof(*spi), GFP_KERNEL);
358 spi_master_put(master);
362 spi->master = master;
363 spi->dev.parent = &master->dev;
364 spi->dev.bus = &spi_bus_type;
365 spi->dev.release = spidev_release;
366 spi->cs_gpio = -ENOENT;
367 device_initialize(&spi->dev);
370 EXPORT_SYMBOL_GPL(spi_alloc_device);
372 static void spi_dev_set_name(struct spi_device *spi)
374 struct acpi_device *adev = ACPI_COMPANION(&spi->dev);
377 dev_set_name(&spi->dev, "spi-%s", acpi_dev_name(adev));
381 dev_set_name(&spi->dev, "%s.%u", dev_name(&spi->master->dev),
385 static int spi_dev_check(struct device *dev, void *data)
387 struct spi_device *spi = to_spi_device(dev);
388 struct spi_device *new_spi = data;
390 if (spi->master == new_spi->master &&
391 spi->chip_select == new_spi->chip_select)
397 * spi_add_device - Add spi_device allocated with spi_alloc_device
398 * @spi: spi_device to register
400 * Companion function to spi_alloc_device. Devices allocated with
401 * spi_alloc_device can be added onto the spi bus with this function.
403 * Returns 0 on success; negative errno on failure
405 int spi_add_device(struct spi_device *spi)
407 static DEFINE_MUTEX(spi_add_lock);
408 struct spi_master *master = spi->master;
409 struct device *dev = master->dev.parent;
412 /* Chipselects are numbered 0..max; validate. */
413 if (spi->chip_select >= master->num_chipselect) {
414 dev_err(dev, "cs%d >= max %d\n",
416 master->num_chipselect);
420 /* Set the bus ID string */
421 spi_dev_set_name(spi);
423 /* We need to make sure there's no other device with this
424 * chipselect **BEFORE** we call setup(), else we'll trash
425 * its configuration. Lock against concurrent add() calls.
427 mutex_lock(&spi_add_lock);
429 status = bus_for_each_dev(&spi_bus_type, NULL, spi, spi_dev_check);
431 dev_err(dev, "chipselect %d already in use\n",
436 if (master->cs_gpios)
437 spi->cs_gpio = master->cs_gpios[spi->chip_select];
439 /* Drivers may modify this initial i/o setup, but will
440 * normally rely on the device being setup. Devices
441 * using SPI_CS_HIGH can't coexist well otherwise...
443 status = spi_setup(spi);
445 dev_err(dev, "can't setup %s, status %d\n",
446 dev_name(&spi->dev), status);
450 /* Device may be bound to an active driver when this returns */
451 status = device_add(&spi->dev);
453 dev_err(dev, "can't add %s, status %d\n",
454 dev_name(&spi->dev), status);
456 dev_dbg(dev, "registered child %s\n", dev_name(&spi->dev));
459 mutex_unlock(&spi_add_lock);
462 EXPORT_SYMBOL_GPL(spi_add_device);
465 * spi_new_device - instantiate one new SPI device
466 * @master: Controller to which device is connected
467 * @chip: Describes the SPI device
470 * On typical mainboards, this is purely internal; and it's not needed
471 * after board init creates the hard-wired devices. Some development
472 * platforms may not be able to use spi_register_board_info though, and
473 * this is exported so that for example a USB or parport based adapter
474 * driver could add devices (which it would learn about out-of-band).
476 * Returns the new device, or NULL.
478 struct spi_device *spi_new_device(struct spi_master *master,
479 struct spi_board_info *chip)
481 struct spi_device *proxy;
484 /* NOTE: caller did any chip->bus_num checks necessary.
486 * Also, unless we change the return value convention to use
487 * error-or-pointer (not NULL-or-pointer), troubleshootability
488 * suggests syslogged diagnostics are best here (ugh).
491 proxy = spi_alloc_device(master);
495 WARN_ON(strlen(chip->modalias) >= sizeof(proxy->modalias));
497 proxy->chip_select = chip->chip_select;
498 proxy->max_speed_hz = chip->max_speed_hz;
499 proxy->mode = chip->mode;
500 proxy->irq = chip->irq;
501 strlcpy(proxy->modalias, chip->modalias, sizeof(proxy->modalias));
502 proxy->dev.platform_data = (void *) chip->platform_data;
503 proxy->controller_data = chip->controller_data;
504 proxy->controller_state = NULL;
506 status = spi_add_device(proxy);
514 EXPORT_SYMBOL_GPL(spi_new_device);
516 static void spi_match_master_to_boardinfo(struct spi_master *master,
517 struct spi_board_info *bi)
519 struct spi_device *dev;
521 if (master->bus_num != bi->bus_num)
524 dev = spi_new_device(master, bi);
526 dev_err(master->dev.parent, "can't create new device for %s\n",
531 * spi_register_board_info - register SPI devices for a given board
532 * @info: array of chip descriptors
533 * @n: how many descriptors are provided
536 * Board-specific early init code calls this (probably during arch_initcall)
537 * with segments of the SPI device table. Any device nodes are created later,
538 * after the relevant parent SPI controller (bus_num) is defined. We keep
539 * this table of devices forever, so that reloading a controller driver will
540 * not make Linux forget about these hard-wired devices.
542 * Other code can also call this, e.g. a particular add-on board might provide
543 * SPI devices through its expansion connector, so code initializing that board
544 * would naturally declare its SPI devices.
546 * The board info passed can safely be __initdata ... but be careful of
547 * any embedded pointers (platform_data, etc), they're copied as-is.
549 int spi_register_board_info(struct spi_board_info const *info, unsigned n)
551 struct boardinfo *bi;
557 bi = kzalloc(n * sizeof(*bi), GFP_KERNEL);
561 for (i = 0; i < n; i++, bi++, info++) {
562 struct spi_master *master;
564 memcpy(&bi->board_info, info, sizeof(*info));
565 mutex_lock(&board_lock);
566 list_add_tail(&bi->list, &board_list);
567 list_for_each_entry(master, &spi_master_list, list)
568 spi_match_master_to_boardinfo(master, &bi->board_info);
569 mutex_unlock(&board_lock);
575 /*-------------------------------------------------------------------------*/
577 static void spi_set_cs(struct spi_device *spi, bool enable)
579 if (spi->mode & SPI_CS_HIGH)
582 if (spi->cs_gpio >= 0)
583 gpio_set_value(spi->cs_gpio, !enable);
584 else if (spi->master->set_cs)
585 spi->master->set_cs(spi, !enable);
588 #ifdef CONFIG_HAS_DMA
589 static int spi_map_buf(struct spi_master *master, struct device *dev,
590 struct sg_table *sgt, void *buf, size_t len,
591 enum dma_data_direction dir)
593 const bool vmalloced_buf = is_vmalloc_addr(buf);
594 const int desc_len = vmalloced_buf ? PAGE_SIZE : master->max_dma_len;
595 const int sgs = DIV_ROUND_UP(len, desc_len);
596 struct page *vm_page;
601 ret = sg_alloc_table(sgt, sgs, GFP_KERNEL);
605 for (i = 0; i < sgs; i++) {
606 min = min_t(size_t, len, desc_len);
609 vm_page = vmalloc_to_page(buf);
614 sg_set_page(&sgt->sgl[i], vm_page,
615 min, offset_in_page(buf));
618 sg_set_buf(&sgt->sgl[i], sg_buf, min);
626 ret = dma_map_sg(dev, sgt->sgl, sgt->nents, dir);
639 static void spi_unmap_buf(struct spi_master *master, struct device *dev,
640 struct sg_table *sgt, enum dma_data_direction dir)
642 if (sgt->orig_nents) {
643 dma_unmap_sg(dev, sgt->sgl, sgt->orig_nents, dir);
648 static int __spi_map_msg(struct spi_master *master, struct spi_message *msg)
650 struct device *tx_dev, *rx_dev;
651 struct spi_transfer *xfer;
654 if (!master->can_dma)
657 tx_dev = master->dma_tx->device->dev;
658 rx_dev = master->dma_rx->device->dev;
660 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
661 if (!master->can_dma(master, msg->spi, xfer))
664 if (xfer->tx_buf != NULL) {
665 ret = spi_map_buf(master, tx_dev, &xfer->tx_sg,
666 (void *)xfer->tx_buf, xfer->len,
672 if (xfer->rx_buf != NULL) {
673 ret = spi_map_buf(master, rx_dev, &xfer->rx_sg,
674 xfer->rx_buf, xfer->len,
677 spi_unmap_buf(master, tx_dev, &xfer->tx_sg,
684 master->cur_msg_mapped = true;
689 static int spi_unmap_msg(struct spi_master *master, struct spi_message *msg)
691 struct spi_transfer *xfer;
692 struct device *tx_dev, *rx_dev;
694 if (!master->cur_msg_mapped || !master->can_dma)
697 tx_dev = master->dma_tx->device->dev;
698 rx_dev = master->dma_rx->device->dev;
700 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
701 if (!master->can_dma(master, msg->spi, xfer))
704 spi_unmap_buf(master, rx_dev, &xfer->rx_sg, DMA_FROM_DEVICE);
705 spi_unmap_buf(master, tx_dev, &xfer->tx_sg, DMA_TO_DEVICE);
710 #else /* !CONFIG_HAS_DMA */
711 static inline int __spi_map_msg(struct spi_master *master,
712 struct spi_message *msg)
717 static inline int spi_unmap_msg(struct spi_master *master,
718 struct spi_message *msg)
722 #endif /* !CONFIG_HAS_DMA */
724 static int spi_map_msg(struct spi_master *master, struct spi_message *msg)
726 struct spi_transfer *xfer;
728 unsigned int max_tx, max_rx;
730 if (master->flags & (SPI_MASTER_MUST_RX | SPI_MASTER_MUST_TX)) {
734 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
735 if ((master->flags & SPI_MASTER_MUST_TX) &&
737 max_tx = max(xfer->len, max_tx);
738 if ((master->flags & SPI_MASTER_MUST_RX) &&
740 max_rx = max(xfer->len, max_rx);
744 tmp = krealloc(master->dummy_tx, max_tx,
745 GFP_KERNEL | GFP_DMA);
748 master->dummy_tx = tmp;
749 memset(tmp, 0, max_tx);
753 tmp = krealloc(master->dummy_rx, max_rx,
754 GFP_KERNEL | GFP_DMA);
757 master->dummy_rx = tmp;
760 if (max_tx || max_rx) {
761 list_for_each_entry(xfer, &msg->transfers,
764 xfer->tx_buf = master->dummy_tx;
766 xfer->rx_buf = master->dummy_rx;
771 return __spi_map_msg(master, msg);
775 * spi_transfer_one_message - Default implementation of transfer_one_message()
777 * This is a standard implementation of transfer_one_message() for
778 * drivers which impelment a transfer_one() operation. It provides
779 * standard handling of delays and chip select management.
781 static int spi_transfer_one_message(struct spi_master *master,
782 struct spi_message *msg)
784 struct spi_transfer *xfer;
785 bool keep_cs = false;
787 unsigned long ms = 1;
789 spi_set_cs(msg->spi, true);
791 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
792 trace_spi_transfer_start(msg, xfer);
794 if (xfer->tx_buf || xfer->rx_buf) {
795 reinit_completion(&master->xfer_completion);
797 ret = master->transfer_one(master, msg->spi, xfer);
799 dev_err(&msg->spi->dev,
800 "SPI transfer failed: %d\n", ret);
806 ms = xfer->len * 8 * 1000 / xfer->speed_hz;
807 ms += ms + 100; /* some tolerance */
809 ms = wait_for_completion_timeout(&master->xfer_completion,
810 msecs_to_jiffies(ms));
814 dev_err(&msg->spi->dev,
815 "SPI transfer timed out\n");
816 msg->status = -ETIMEDOUT;
820 dev_err(&msg->spi->dev,
821 "Bufferless transfer has length %u\n",
825 trace_spi_transfer_stop(msg, xfer);
827 if (msg->status != -EINPROGRESS)
830 if (xfer->delay_usecs)
831 udelay(xfer->delay_usecs);
833 if (xfer->cs_change) {
834 if (list_is_last(&xfer->transfer_list,
838 spi_set_cs(msg->spi, false);
840 spi_set_cs(msg->spi, true);
844 msg->actual_length += xfer->len;
848 if (ret != 0 || !keep_cs)
849 spi_set_cs(msg->spi, false);
851 if (msg->status == -EINPROGRESS)
855 master->handle_err(master, msg);
857 spi_finalize_current_message(master);
863 * spi_finalize_current_transfer - report completion of a transfer
864 * @master: the master reporting completion
866 * Called by SPI drivers using the core transfer_one_message()
867 * implementation to notify it that the current interrupt driven
868 * transfer has finished and the next one may be scheduled.
870 void spi_finalize_current_transfer(struct spi_master *master)
872 complete(&master->xfer_completion);
874 EXPORT_SYMBOL_GPL(spi_finalize_current_transfer);
877 * __spi_pump_messages - function which processes spi message queue
878 * @master: master to process queue for
879 * @in_kthread: true if we are in the context of the message pump thread
881 * This function checks if there is any spi message in the queue that
882 * needs processing and if so call out to the driver to initialize hardware
883 * and transfer each message.
885 * Note that it is called both from the kthread itself and also from
886 * inside spi_sync(); the queue extraction handling at the top of the
887 * function should deal with this safely.
889 static void __spi_pump_messages(struct spi_master *master, bool in_kthread)
892 bool was_busy = false;
896 spin_lock_irqsave(&master->queue_lock, flags);
898 /* Make sure we are not already running a message */
899 if (master->cur_msg) {
900 spin_unlock_irqrestore(&master->queue_lock, flags);
904 /* If another context is idling the device then defer */
905 if (master->idling) {
906 queue_kthread_work(&master->kworker, &master->pump_messages);
907 spin_unlock_irqrestore(&master->queue_lock, flags);
911 /* Check if the queue is idle */
912 if (list_empty(&master->queue) || !master->running) {
914 spin_unlock_irqrestore(&master->queue_lock, flags);
918 /* Only do teardown in the thread */
920 queue_kthread_work(&master->kworker,
921 &master->pump_messages);
922 spin_unlock_irqrestore(&master->queue_lock, flags);
926 master->busy = false;
927 master->idling = true;
928 spin_unlock_irqrestore(&master->queue_lock, flags);
930 kfree(master->dummy_rx);
931 master->dummy_rx = NULL;
932 kfree(master->dummy_tx);
933 master->dummy_tx = NULL;
934 if (master->unprepare_transfer_hardware &&
935 master->unprepare_transfer_hardware(master))
936 dev_err(&master->dev,
937 "failed to unprepare transfer hardware\n");
938 if (master->auto_runtime_pm) {
939 pm_runtime_mark_last_busy(master->dev.parent);
940 pm_runtime_put_autosuspend(master->dev.parent);
942 trace_spi_master_idle(master);
944 spin_lock_irqsave(&master->queue_lock, flags);
945 master->idling = false;
946 spin_unlock_irqrestore(&master->queue_lock, flags);
950 /* Extract head of queue */
952 list_first_entry(&master->queue, struct spi_message, queue);
954 list_del_init(&master->cur_msg->queue);
959 spin_unlock_irqrestore(&master->queue_lock, flags);
961 if (!was_busy && master->auto_runtime_pm) {
962 ret = pm_runtime_get_sync(master->dev.parent);
964 dev_err(&master->dev, "Failed to power device: %d\n",
971 trace_spi_master_busy(master);
973 if (!was_busy && master->prepare_transfer_hardware) {
974 ret = master->prepare_transfer_hardware(master);
976 dev_err(&master->dev,
977 "failed to prepare transfer hardware\n");
979 if (master->auto_runtime_pm)
980 pm_runtime_put(master->dev.parent);
985 trace_spi_message_start(master->cur_msg);
987 if (master->prepare_message) {
988 ret = master->prepare_message(master, master->cur_msg);
990 dev_err(&master->dev,
991 "failed to prepare message: %d\n", ret);
992 master->cur_msg->status = ret;
993 spi_finalize_current_message(master);
996 master->cur_msg_prepared = true;
999 ret = spi_map_msg(master, master->cur_msg);
1001 master->cur_msg->status = ret;
1002 spi_finalize_current_message(master);
1006 ret = master->transfer_one_message(master, master->cur_msg);
1008 dev_err(&master->dev,
1009 "failed to transfer one message from queue\n");
1015 * spi_pump_messages - kthread work function which processes spi message queue
1016 * @work: pointer to kthread work struct contained in the master struct
1018 static void spi_pump_messages(struct kthread_work *work)
1020 struct spi_master *master =
1021 container_of(work, struct spi_master, pump_messages);
1023 __spi_pump_messages(master, true);
1026 static int spi_init_queue(struct spi_master *master)
1028 struct sched_param param = { .sched_priority = MAX_RT_PRIO - 1 };
1030 master->running = false;
1031 master->busy = false;
1033 init_kthread_worker(&master->kworker);
1034 master->kworker_task = kthread_run(kthread_worker_fn,
1035 &master->kworker, "%s",
1036 dev_name(&master->dev));
1037 if (IS_ERR(master->kworker_task)) {
1038 dev_err(&master->dev, "failed to create message pump task\n");
1039 return PTR_ERR(master->kworker_task);
1041 init_kthread_work(&master->pump_messages, spi_pump_messages);
1044 * Master config will indicate if this controller should run the
1045 * message pump with high (realtime) priority to reduce the transfer
1046 * latency on the bus by minimising the delay between a transfer
1047 * request and the scheduling of the message pump thread. Without this
1048 * setting the message pump thread will remain at default priority.
1051 dev_info(&master->dev,
1052 "will run message pump with realtime priority\n");
1053 sched_setscheduler(master->kworker_task, SCHED_FIFO, ¶m);
1060 * spi_get_next_queued_message() - called by driver to check for queued
1062 * @master: the master to check for queued messages
1064 * If there are more messages in the queue, the next message is returned from
1067 struct spi_message *spi_get_next_queued_message(struct spi_master *master)
1069 struct spi_message *next;
1070 unsigned long flags;
1072 /* get a pointer to the next message, if any */
1073 spin_lock_irqsave(&master->queue_lock, flags);
1074 next = list_first_entry_or_null(&master->queue, struct spi_message,
1076 spin_unlock_irqrestore(&master->queue_lock, flags);
1080 EXPORT_SYMBOL_GPL(spi_get_next_queued_message);
1083 * spi_finalize_current_message() - the current message is complete
1084 * @master: the master to return the message to
1086 * Called by the driver to notify the core that the message in the front of the
1087 * queue is complete and can be removed from the queue.
1089 void spi_finalize_current_message(struct spi_master *master)
1091 struct spi_message *mesg;
1092 unsigned long flags;
1095 spin_lock_irqsave(&master->queue_lock, flags);
1096 mesg = master->cur_msg;
1097 master->cur_msg = NULL;
1099 queue_kthread_work(&master->kworker, &master->pump_messages);
1100 spin_unlock_irqrestore(&master->queue_lock, flags);
1102 spi_unmap_msg(master, mesg);
1104 if (master->cur_msg_prepared && master->unprepare_message) {
1105 ret = master->unprepare_message(master, mesg);
1107 dev_err(&master->dev,
1108 "failed to unprepare message: %d\n", ret);
1111 master->cur_msg_prepared = false;
1115 mesg->complete(mesg->context);
1117 trace_spi_message_done(mesg);
1119 EXPORT_SYMBOL_GPL(spi_finalize_current_message);
1121 static int spi_start_queue(struct spi_master *master)
1123 unsigned long flags;
1125 spin_lock_irqsave(&master->queue_lock, flags);
1127 if (master->running || master->busy) {
1128 spin_unlock_irqrestore(&master->queue_lock, flags);
1132 master->running = true;
1133 master->cur_msg = NULL;
1134 spin_unlock_irqrestore(&master->queue_lock, flags);
1136 queue_kthread_work(&master->kworker, &master->pump_messages);
1141 static int spi_stop_queue(struct spi_master *master)
1143 unsigned long flags;
1144 unsigned limit = 500;
1147 spin_lock_irqsave(&master->queue_lock, flags);
1150 * This is a bit lame, but is optimized for the common execution path.
1151 * A wait_queue on the master->busy could be used, but then the common
1152 * execution path (pump_messages) would be required to call wake_up or
1153 * friends on every SPI message. Do this instead.
1155 while ((!list_empty(&master->queue) || master->busy) && limit--) {
1156 spin_unlock_irqrestore(&master->queue_lock, flags);
1157 usleep_range(10000, 11000);
1158 spin_lock_irqsave(&master->queue_lock, flags);
1161 if (!list_empty(&master->queue) || master->busy)
1164 master->running = false;
1166 spin_unlock_irqrestore(&master->queue_lock, flags);
1169 dev_warn(&master->dev,
1170 "could not stop message queue\n");
1176 static int spi_destroy_queue(struct spi_master *master)
1180 ret = spi_stop_queue(master);
1183 * flush_kthread_worker will block until all work is done.
1184 * If the reason that stop_queue timed out is that the work will never
1185 * finish, then it does no good to call flush/stop thread, so
1189 dev_err(&master->dev, "problem destroying queue\n");
1193 flush_kthread_worker(&master->kworker);
1194 kthread_stop(master->kworker_task);
1199 static int __spi_queued_transfer(struct spi_device *spi,
1200 struct spi_message *msg,
1203 struct spi_master *master = spi->master;
1204 unsigned long flags;
1206 spin_lock_irqsave(&master->queue_lock, flags);
1208 if (!master->running) {
1209 spin_unlock_irqrestore(&master->queue_lock, flags);
1212 msg->actual_length = 0;
1213 msg->status = -EINPROGRESS;
1215 list_add_tail(&msg->queue, &master->queue);
1216 if (!master->busy && need_pump)
1217 queue_kthread_work(&master->kworker, &master->pump_messages);
1219 spin_unlock_irqrestore(&master->queue_lock, flags);
1224 * spi_queued_transfer - transfer function for queued transfers
1225 * @spi: spi device which is requesting transfer
1226 * @msg: spi message which is to handled is queued to driver queue
1228 static int spi_queued_transfer(struct spi_device *spi, struct spi_message *msg)
1230 return __spi_queued_transfer(spi, msg, true);
1233 static int spi_master_initialize_queue(struct spi_master *master)
1237 master->transfer = spi_queued_transfer;
1238 if (!master->transfer_one_message)
1239 master->transfer_one_message = spi_transfer_one_message;
1241 /* Initialize and start queue */
1242 ret = spi_init_queue(master);
1244 dev_err(&master->dev, "problem initializing queue\n");
1245 goto err_init_queue;
1247 master->queued = true;
1248 ret = spi_start_queue(master);
1250 dev_err(&master->dev, "problem starting queue\n");
1251 goto err_start_queue;
1257 spi_destroy_queue(master);
1262 /*-------------------------------------------------------------------------*/
1264 #if defined(CONFIG_OF)
1265 static struct spi_device *
1266 of_register_spi_device(struct spi_master *master, struct device_node *nc)
1268 struct spi_device *spi;
1272 /* Alloc an spi_device */
1273 spi = spi_alloc_device(master);
1275 dev_err(&master->dev, "spi_device alloc error for %s\n",
1281 /* Select device driver */
1282 rc = of_modalias_node(nc, spi->modalias,
1283 sizeof(spi->modalias));
1285 dev_err(&master->dev, "cannot find modalias for %s\n",
1290 /* Device address */
1291 rc = of_property_read_u32(nc, "reg", &value);
1293 dev_err(&master->dev, "%s has no valid 'reg' property (%d)\n",
1297 spi->chip_select = value;
1299 /* Mode (clock phase/polarity/etc.) */
1300 if (of_find_property(nc, "spi-cpha", NULL))
1301 spi->mode |= SPI_CPHA;
1302 if (of_find_property(nc, "spi-cpol", NULL))
1303 spi->mode |= SPI_CPOL;
1304 if (of_find_property(nc, "spi-cs-high", NULL))
1305 spi->mode |= SPI_CS_HIGH;
1306 if (of_find_property(nc, "spi-3wire", NULL))
1307 spi->mode |= SPI_3WIRE;
1308 if (of_find_property(nc, "spi-lsb-first", NULL))
1309 spi->mode |= SPI_LSB_FIRST;
1311 /* Device DUAL/QUAD mode */
1312 if (!of_property_read_u32(nc, "spi-tx-bus-width", &value)) {
1317 spi->mode |= SPI_TX_DUAL;
1320 spi->mode |= SPI_TX_QUAD;
1323 dev_warn(&master->dev,
1324 "spi-tx-bus-width %d not supported\n",
1330 if (!of_property_read_u32(nc, "spi-rx-bus-width", &value)) {
1335 spi->mode |= SPI_RX_DUAL;
1338 spi->mode |= SPI_RX_QUAD;
1341 dev_warn(&master->dev,
1342 "spi-rx-bus-width %d not supported\n",
1349 rc = of_property_read_u32(nc, "spi-max-frequency", &value);
1351 dev_err(&master->dev, "%s has no valid 'spi-max-frequency' property (%d)\n",
1355 spi->max_speed_hz = value;
1358 spi->irq = irq_of_parse_and_map(nc, 0);
1360 /* Store a pointer to the node in the device structure */
1362 spi->dev.of_node = nc;
1364 /* Register the new device */
1365 request_module("%s%s", SPI_MODULE_PREFIX, spi->modalias);
1366 rc = spi_add_device(spi);
1368 dev_err(&master->dev, "spi_device register error %s\n",
1381 * of_register_spi_devices() - Register child devices onto the SPI bus
1382 * @master: Pointer to spi_master device
1384 * Registers an spi_device for each child node of master node which has a 'reg'
1387 static void of_register_spi_devices(struct spi_master *master)
1389 struct spi_device *spi;
1390 struct device_node *nc;
1392 if (!master->dev.of_node)
1395 for_each_available_child_of_node(master->dev.of_node, nc) {
1396 spi = of_register_spi_device(master, nc);
1398 dev_warn(&master->dev, "Failed to create SPI device for %s\n",
1403 static void of_register_spi_devices(struct spi_master *master) { }
1407 static int acpi_spi_add_resource(struct acpi_resource *ares, void *data)
1409 struct spi_device *spi = data;
1411 if (ares->type == ACPI_RESOURCE_TYPE_SERIAL_BUS) {
1412 struct acpi_resource_spi_serialbus *sb;
1414 sb = &ares->data.spi_serial_bus;
1415 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_SPI) {
1416 spi->chip_select = sb->device_selection;
1417 spi->max_speed_hz = sb->connection_speed;
1419 if (sb->clock_phase == ACPI_SPI_SECOND_PHASE)
1420 spi->mode |= SPI_CPHA;
1421 if (sb->clock_polarity == ACPI_SPI_START_HIGH)
1422 spi->mode |= SPI_CPOL;
1423 if (sb->device_polarity == ACPI_SPI_ACTIVE_HIGH)
1424 spi->mode |= SPI_CS_HIGH;
1426 } else if (spi->irq < 0) {
1429 if (acpi_dev_resource_interrupt(ares, 0, &r))
1433 /* Always tell the ACPI core to skip this resource */
1437 static acpi_status acpi_spi_add_device(acpi_handle handle, u32 level,
1438 void *data, void **return_value)
1440 struct spi_master *master = data;
1441 struct list_head resource_list;
1442 struct acpi_device *adev;
1443 struct spi_device *spi;
1446 if (acpi_bus_get_device(handle, &adev))
1448 if (acpi_bus_get_status(adev) || !adev->status.present)
1451 spi = spi_alloc_device(master);
1453 dev_err(&master->dev, "failed to allocate SPI device for %s\n",
1454 dev_name(&adev->dev));
1455 return AE_NO_MEMORY;
1458 ACPI_COMPANION_SET(&spi->dev, adev);
1461 INIT_LIST_HEAD(&resource_list);
1462 ret = acpi_dev_get_resources(adev, &resource_list,
1463 acpi_spi_add_resource, spi);
1464 acpi_dev_free_resource_list(&resource_list);
1466 if (ret < 0 || !spi->max_speed_hz) {
1471 adev->power.flags.ignore_parent = true;
1472 strlcpy(spi->modalias, acpi_device_hid(adev), sizeof(spi->modalias));
1473 if (spi_add_device(spi)) {
1474 adev->power.flags.ignore_parent = false;
1475 dev_err(&master->dev, "failed to add SPI device %s from ACPI\n",
1476 dev_name(&adev->dev));
1483 static void acpi_register_spi_devices(struct spi_master *master)
1488 handle = ACPI_HANDLE(master->dev.parent);
1492 status = acpi_walk_namespace(ACPI_TYPE_DEVICE, handle, 1,
1493 acpi_spi_add_device, NULL,
1495 if (ACPI_FAILURE(status))
1496 dev_warn(&master->dev, "failed to enumerate SPI slaves\n");
1499 static inline void acpi_register_spi_devices(struct spi_master *master) {}
1500 #endif /* CONFIG_ACPI */
1502 static void spi_master_release(struct device *dev)
1504 struct spi_master *master;
1506 master = container_of(dev, struct spi_master, dev);
1510 static struct class spi_master_class = {
1511 .name = "spi_master",
1512 .owner = THIS_MODULE,
1513 .dev_release = spi_master_release,
1519 * spi_alloc_master - allocate SPI master controller
1520 * @dev: the controller, possibly using the platform_bus
1521 * @size: how much zeroed driver-private data to allocate; the pointer to this
1522 * memory is in the driver_data field of the returned device,
1523 * accessible with spi_master_get_devdata().
1524 * Context: can sleep
1526 * This call is used only by SPI master controller drivers, which are the
1527 * only ones directly touching chip registers. It's how they allocate
1528 * an spi_master structure, prior to calling spi_register_master().
1530 * This must be called from context that can sleep. It returns the SPI
1531 * master structure on success, else NULL.
1533 * The caller is responsible for assigning the bus number and initializing
1534 * the master's methods before calling spi_register_master(); and (after errors
1535 * adding the device) calling spi_master_put() and kfree() to prevent a memory
1538 struct spi_master *spi_alloc_master(struct device *dev, unsigned size)
1540 struct spi_master *master;
1545 master = kzalloc(size + sizeof(*master), GFP_KERNEL);
1549 device_initialize(&master->dev);
1550 master->bus_num = -1;
1551 master->num_chipselect = 1;
1552 master->dev.class = &spi_master_class;
1553 master->dev.parent = get_device(dev);
1554 spi_master_set_devdata(master, &master[1]);
1558 EXPORT_SYMBOL_GPL(spi_alloc_master);
1561 static int of_spi_register_master(struct spi_master *master)
1564 struct device_node *np = master->dev.of_node;
1569 nb = of_gpio_named_count(np, "cs-gpios");
1570 master->num_chipselect = max_t(int, nb, master->num_chipselect);
1572 /* Return error only for an incorrectly formed cs-gpios property */
1573 if (nb == 0 || nb == -ENOENT)
1578 cs = devm_kzalloc(&master->dev,
1579 sizeof(int) * master->num_chipselect,
1581 master->cs_gpios = cs;
1583 if (!master->cs_gpios)
1586 for (i = 0; i < master->num_chipselect; i++)
1589 for (i = 0; i < nb; i++)
1590 cs[i] = of_get_named_gpio(np, "cs-gpios", i);
1595 static int of_spi_register_master(struct spi_master *master)
1602 * spi_register_master - register SPI master controller
1603 * @master: initialized master, originally from spi_alloc_master()
1604 * Context: can sleep
1606 * SPI master controllers connect to their drivers using some non-SPI bus,
1607 * such as the platform bus. The final stage of probe() in that code
1608 * includes calling spi_register_master() to hook up to this SPI bus glue.
1610 * SPI controllers use board specific (often SOC specific) bus numbers,
1611 * and board-specific addressing for SPI devices combines those numbers
1612 * with chip select numbers. Since SPI does not directly support dynamic
1613 * device identification, boards need configuration tables telling which
1614 * chip is at which address.
1616 * This must be called from context that can sleep. It returns zero on
1617 * success, else a negative error code (dropping the master's refcount).
1618 * After a successful return, the caller is responsible for calling
1619 * spi_unregister_master().
1621 int spi_register_master(struct spi_master *master)
1623 static atomic_t dyn_bus_id = ATOMIC_INIT((1<<15) - 1);
1624 struct device *dev = master->dev.parent;
1625 struct boardinfo *bi;
1626 int status = -ENODEV;
1632 status = of_spi_register_master(master);
1636 /* even if it's just one always-selected device, there must
1637 * be at least one chipselect
1639 if (master->num_chipselect == 0)
1642 if ((master->bus_num < 0) && master->dev.of_node)
1643 master->bus_num = of_alias_get_id(master->dev.of_node, "spi");
1645 /* convention: dynamically assigned bus IDs count down from the max */
1646 if (master->bus_num < 0) {
1647 /* FIXME switch to an IDR based scheme, something like
1648 * I2C now uses, so we can't run out of "dynamic" IDs
1650 master->bus_num = atomic_dec_return(&dyn_bus_id);
1654 INIT_LIST_HEAD(&master->queue);
1655 spin_lock_init(&master->queue_lock);
1656 spin_lock_init(&master->bus_lock_spinlock);
1657 mutex_init(&master->bus_lock_mutex);
1658 master->bus_lock_flag = 0;
1659 init_completion(&master->xfer_completion);
1660 if (!master->max_dma_len)
1661 master->max_dma_len = INT_MAX;
1663 /* register the device, then userspace will see it.
1664 * registration fails if the bus ID is in use.
1666 dev_set_name(&master->dev, "spi%u", master->bus_num);
1667 status = device_add(&master->dev);
1670 dev_dbg(dev, "registered master %s%s\n", dev_name(&master->dev),
1671 dynamic ? " (dynamic)" : "");
1673 /* If we're using a queued driver, start the queue */
1674 if (master->transfer)
1675 dev_info(dev, "master is unqueued, this is deprecated\n");
1677 status = spi_master_initialize_queue(master);
1679 device_del(&master->dev);
1684 mutex_lock(&board_lock);
1685 list_add_tail(&master->list, &spi_master_list);
1686 list_for_each_entry(bi, &board_list, list)
1687 spi_match_master_to_boardinfo(master, &bi->board_info);
1688 mutex_unlock(&board_lock);
1690 /* Register devices from the device tree and ACPI */
1691 of_register_spi_devices(master);
1692 acpi_register_spi_devices(master);
1696 EXPORT_SYMBOL_GPL(spi_register_master);
1698 static void devm_spi_unregister(struct device *dev, void *res)
1700 spi_unregister_master(*(struct spi_master **)res);
1704 * dev_spi_register_master - register managed SPI master controller
1705 * @dev: device managing SPI master
1706 * @master: initialized master, originally from spi_alloc_master()
1707 * Context: can sleep
1709 * Register a SPI device as with spi_register_master() which will
1710 * automatically be unregister
1712 int devm_spi_register_master(struct device *dev, struct spi_master *master)
1714 struct spi_master **ptr;
1717 ptr = devres_alloc(devm_spi_unregister, sizeof(*ptr), GFP_KERNEL);
1721 ret = spi_register_master(master);
1724 devres_add(dev, ptr);
1731 EXPORT_SYMBOL_GPL(devm_spi_register_master);
1733 static int __unregister(struct device *dev, void *null)
1735 spi_unregister_device(to_spi_device(dev));
1740 * spi_unregister_master - unregister SPI master controller
1741 * @master: the master being unregistered
1742 * Context: can sleep
1744 * This call is used only by SPI master controller drivers, which are the
1745 * only ones directly touching chip registers.
1747 * This must be called from context that can sleep.
1749 void spi_unregister_master(struct spi_master *master)
1753 if (master->queued) {
1754 if (spi_destroy_queue(master))
1755 dev_err(&master->dev, "queue remove failed\n");
1758 mutex_lock(&board_lock);
1759 list_del(&master->list);
1760 mutex_unlock(&board_lock);
1762 dummy = device_for_each_child(&master->dev, NULL, __unregister);
1763 device_unregister(&master->dev);
1765 EXPORT_SYMBOL_GPL(spi_unregister_master);
1767 int spi_master_suspend(struct spi_master *master)
1771 /* Basically no-ops for non-queued masters */
1772 if (!master->queued)
1775 ret = spi_stop_queue(master);
1777 dev_err(&master->dev, "queue stop failed\n");
1781 EXPORT_SYMBOL_GPL(spi_master_suspend);
1783 int spi_master_resume(struct spi_master *master)
1787 if (!master->queued)
1790 ret = spi_start_queue(master);
1792 dev_err(&master->dev, "queue restart failed\n");
1796 EXPORT_SYMBOL_GPL(spi_master_resume);
1798 static int __spi_master_match(struct device *dev, const void *data)
1800 struct spi_master *m;
1801 const u16 *bus_num = data;
1803 m = container_of(dev, struct spi_master, dev);
1804 return m->bus_num == *bus_num;
1808 * spi_busnum_to_master - look up master associated with bus_num
1809 * @bus_num: the master's bus number
1810 * Context: can sleep
1812 * This call may be used with devices that are registered after
1813 * arch init time. It returns a refcounted pointer to the relevant
1814 * spi_master (which the caller must release), or NULL if there is
1815 * no such master registered.
1817 struct spi_master *spi_busnum_to_master(u16 bus_num)
1820 struct spi_master *master = NULL;
1822 dev = class_find_device(&spi_master_class, NULL, &bus_num,
1823 __spi_master_match);
1825 master = container_of(dev, struct spi_master, dev);
1826 /* reference got in class_find_device */
1829 EXPORT_SYMBOL_GPL(spi_busnum_to_master);
1832 /*-------------------------------------------------------------------------*/
1834 /* Core methods for SPI master protocol drivers. Some of the
1835 * other core methods are currently defined as inline functions.
1839 * spi_setup - setup SPI mode and clock rate
1840 * @spi: the device whose settings are being modified
1841 * Context: can sleep, and no requests are queued to the device
1843 * SPI protocol drivers may need to update the transfer mode if the
1844 * device doesn't work with its default. They may likewise need
1845 * to update clock rates or word sizes from initial values. This function
1846 * changes those settings, and must be called from a context that can sleep.
1847 * Except for SPI_CS_HIGH, which takes effect immediately, the changes take
1848 * effect the next time the device is selected and data is transferred to
1849 * or from it. When this function returns, the spi device is deselected.
1851 * Note that this call will fail if the protocol driver specifies an option
1852 * that the underlying controller or its driver does not support. For
1853 * example, not all hardware supports wire transfers using nine bit words,
1854 * LSB-first wire encoding, or active-high chipselects.
1856 int spi_setup(struct spi_device *spi)
1858 unsigned bad_bits, ugly_bits;
1861 /* check mode to prevent that DUAL and QUAD set at the same time
1863 if (((spi->mode & SPI_TX_DUAL) && (spi->mode & SPI_TX_QUAD)) ||
1864 ((spi->mode & SPI_RX_DUAL) && (spi->mode & SPI_RX_QUAD))) {
1866 "setup: can not select dual and quad at the same time\n");
1869 /* if it is SPI_3WIRE mode, DUAL and QUAD should be forbidden
1871 if ((spi->mode & SPI_3WIRE) && (spi->mode &
1872 (SPI_TX_DUAL | SPI_TX_QUAD | SPI_RX_DUAL | SPI_RX_QUAD)))
1874 /* help drivers fail *cleanly* when they need options
1875 * that aren't supported with their current master
1877 bad_bits = spi->mode & ~spi->master->mode_bits;
1878 ugly_bits = bad_bits &
1879 (SPI_TX_DUAL | SPI_TX_QUAD | SPI_RX_DUAL | SPI_RX_QUAD);
1882 "setup: ignoring unsupported mode bits %x\n",
1884 spi->mode &= ~ugly_bits;
1885 bad_bits &= ~ugly_bits;
1888 dev_err(&spi->dev, "setup: unsupported mode bits %x\n",
1893 if (!spi->bits_per_word)
1894 spi->bits_per_word = 8;
1896 if (!spi->max_speed_hz)
1897 spi->max_speed_hz = spi->master->max_speed_hz;
1899 if (spi->master->setup)
1900 status = spi->master->setup(spi);
1902 dev_dbg(&spi->dev, "setup mode %d, %s%s%s%s%u bits/w, %u Hz max --> %d\n",
1903 (int) (spi->mode & (SPI_CPOL | SPI_CPHA)),
1904 (spi->mode & SPI_CS_HIGH) ? "cs_high, " : "",
1905 (spi->mode & SPI_LSB_FIRST) ? "lsb, " : "",
1906 (spi->mode & SPI_3WIRE) ? "3wire, " : "",
1907 (spi->mode & SPI_LOOP) ? "loopback, " : "",
1908 spi->bits_per_word, spi->max_speed_hz,
1913 EXPORT_SYMBOL_GPL(spi_setup);
1915 static int __spi_validate(struct spi_device *spi, struct spi_message *message)
1917 struct spi_master *master = spi->master;
1918 struct spi_transfer *xfer;
1921 if (list_empty(&message->transfers))
1924 /* Half-duplex links include original MicroWire, and ones with
1925 * only one data pin like SPI_3WIRE (switches direction) or where
1926 * either MOSI or MISO is missing. They can also be caused by
1927 * software limitations.
1929 if ((master->flags & SPI_MASTER_HALF_DUPLEX)
1930 || (spi->mode & SPI_3WIRE)) {
1931 unsigned flags = master->flags;
1933 list_for_each_entry(xfer, &message->transfers, transfer_list) {
1934 if (xfer->rx_buf && xfer->tx_buf)
1936 if ((flags & SPI_MASTER_NO_TX) && xfer->tx_buf)
1938 if ((flags & SPI_MASTER_NO_RX) && xfer->rx_buf)
1944 * Set transfer bits_per_word and max speed as spi device default if
1945 * it is not set for this transfer.
1946 * Set transfer tx_nbits and rx_nbits as single transfer default
1947 * (SPI_NBITS_SINGLE) if it is not set for this transfer.
1949 list_for_each_entry(xfer, &message->transfers, transfer_list) {
1950 message->frame_length += xfer->len;
1951 if (!xfer->bits_per_word)
1952 xfer->bits_per_word = spi->bits_per_word;
1954 if (!xfer->speed_hz)
1955 xfer->speed_hz = spi->max_speed_hz;
1957 if (master->max_speed_hz &&
1958 xfer->speed_hz > master->max_speed_hz)
1959 xfer->speed_hz = master->max_speed_hz;
1961 if (master->bits_per_word_mask) {
1962 /* Only 32 bits fit in the mask */
1963 if (xfer->bits_per_word > 32)
1965 if (!(master->bits_per_word_mask &
1966 BIT(xfer->bits_per_word - 1)))
1971 * SPI transfer length should be multiple of SPI word size
1972 * where SPI word size should be power-of-two multiple
1974 if (xfer->bits_per_word <= 8)
1976 else if (xfer->bits_per_word <= 16)
1981 /* No partial transfers accepted */
1982 if (xfer->len % w_size)
1985 if (xfer->speed_hz && master->min_speed_hz &&
1986 xfer->speed_hz < master->min_speed_hz)
1989 if (xfer->tx_buf && !xfer->tx_nbits)
1990 xfer->tx_nbits = SPI_NBITS_SINGLE;
1991 if (xfer->rx_buf && !xfer->rx_nbits)
1992 xfer->rx_nbits = SPI_NBITS_SINGLE;
1993 /* check transfer tx/rx_nbits:
1994 * 1. check the value matches one of single, dual and quad
1995 * 2. check tx/rx_nbits match the mode in spi_device
1998 if (xfer->tx_nbits != SPI_NBITS_SINGLE &&
1999 xfer->tx_nbits != SPI_NBITS_DUAL &&
2000 xfer->tx_nbits != SPI_NBITS_QUAD)
2002 if ((xfer->tx_nbits == SPI_NBITS_DUAL) &&
2003 !(spi->mode & (SPI_TX_DUAL | SPI_TX_QUAD)))
2005 if ((xfer->tx_nbits == SPI_NBITS_QUAD) &&
2006 !(spi->mode & SPI_TX_QUAD))
2009 /* check transfer rx_nbits */
2011 if (xfer->rx_nbits != SPI_NBITS_SINGLE &&
2012 xfer->rx_nbits != SPI_NBITS_DUAL &&
2013 xfer->rx_nbits != SPI_NBITS_QUAD)
2015 if ((xfer->rx_nbits == SPI_NBITS_DUAL) &&
2016 !(spi->mode & (SPI_RX_DUAL | SPI_RX_QUAD)))
2018 if ((xfer->rx_nbits == SPI_NBITS_QUAD) &&
2019 !(spi->mode & SPI_RX_QUAD))
2024 message->status = -EINPROGRESS;
2029 static int __spi_async(struct spi_device *spi, struct spi_message *message)
2031 struct spi_master *master = spi->master;
2035 trace_spi_message_submit(message);
2037 return master->transfer(spi, message);
2041 * spi_async - asynchronous SPI transfer
2042 * @spi: device with which data will be exchanged
2043 * @message: describes the data transfers, including completion callback
2044 * Context: any (irqs may be blocked, etc)
2046 * This call may be used in_irq and other contexts which can't sleep,
2047 * as well as from task contexts which can sleep.
2049 * The completion callback is invoked in a context which can't sleep.
2050 * Before that invocation, the value of message->status is undefined.
2051 * When the callback is issued, message->status holds either zero (to
2052 * indicate complete success) or a negative error code. After that
2053 * callback returns, the driver which issued the transfer request may
2054 * deallocate the associated memory; it's no longer in use by any SPI
2055 * core or controller driver code.
2057 * Note that although all messages to a spi_device are handled in
2058 * FIFO order, messages may go to different devices in other orders.
2059 * Some device might be higher priority, or have various "hard" access
2060 * time requirements, for example.
2062 * On detection of any fault during the transfer, processing of
2063 * the entire message is aborted, and the device is deselected.
2064 * Until returning from the associated message completion callback,
2065 * no other spi_message queued to that device will be processed.
2066 * (This rule applies equally to all the synchronous transfer calls,
2067 * which are wrappers around this core asynchronous primitive.)
2069 int spi_async(struct spi_device *spi, struct spi_message *message)
2071 struct spi_master *master = spi->master;
2073 unsigned long flags;
2075 ret = __spi_validate(spi, message);
2079 spin_lock_irqsave(&master->bus_lock_spinlock, flags);
2081 if (master->bus_lock_flag)
2084 ret = __spi_async(spi, message);
2086 spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
2090 EXPORT_SYMBOL_GPL(spi_async);
2093 * spi_async_locked - version of spi_async with exclusive bus usage
2094 * @spi: device with which data will be exchanged
2095 * @message: describes the data transfers, including completion callback
2096 * Context: any (irqs may be blocked, etc)
2098 * This call may be used in_irq and other contexts which can't sleep,
2099 * as well as from task contexts which can sleep.
2101 * The completion callback is invoked in a context which can't sleep.
2102 * Before that invocation, the value of message->status is undefined.
2103 * When the callback is issued, message->status holds either zero (to
2104 * indicate complete success) or a negative error code. After that
2105 * callback returns, the driver which issued the transfer request may
2106 * deallocate the associated memory; it's no longer in use by any SPI
2107 * core or controller driver code.
2109 * Note that although all messages to a spi_device are handled in
2110 * FIFO order, messages may go to different devices in other orders.
2111 * Some device might be higher priority, or have various "hard" access
2112 * time requirements, for example.
2114 * On detection of any fault during the transfer, processing of
2115 * the entire message is aborted, and the device is deselected.
2116 * Until returning from the associated message completion callback,
2117 * no other spi_message queued to that device will be processed.
2118 * (This rule applies equally to all the synchronous transfer calls,
2119 * which are wrappers around this core asynchronous primitive.)
2121 int spi_async_locked(struct spi_device *spi, struct spi_message *message)
2123 struct spi_master *master = spi->master;
2125 unsigned long flags;
2127 ret = __spi_validate(spi, message);
2131 spin_lock_irqsave(&master->bus_lock_spinlock, flags);
2133 ret = __spi_async(spi, message);
2135 spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
2140 EXPORT_SYMBOL_GPL(spi_async_locked);
2143 /*-------------------------------------------------------------------------*/
2145 /* Utility methods for SPI master protocol drivers, layered on
2146 * top of the core. Some other utility methods are defined as
2150 static void spi_complete(void *arg)
2155 static int __spi_sync(struct spi_device *spi, struct spi_message *message,
2158 DECLARE_COMPLETION_ONSTACK(done);
2160 struct spi_master *master = spi->master;
2161 unsigned long flags;
2163 status = __spi_validate(spi, message);
2167 message->complete = spi_complete;
2168 message->context = &done;
2172 mutex_lock(&master->bus_lock_mutex);
2174 /* If we're not using the legacy transfer method then we will
2175 * try to transfer in the calling context so special case.
2176 * This code would be less tricky if we could remove the
2177 * support for driver implemented message queues.
2179 if (master->transfer == spi_queued_transfer) {
2180 spin_lock_irqsave(&master->bus_lock_spinlock, flags);
2182 trace_spi_message_submit(message);
2184 status = __spi_queued_transfer(spi, message, false);
2186 spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
2188 status = spi_async_locked(spi, message);
2192 mutex_unlock(&master->bus_lock_mutex);
2195 /* Push out the messages in the calling context if we
2198 if (master->transfer == spi_queued_transfer)
2199 __spi_pump_messages(master, false);
2201 wait_for_completion(&done);
2202 status = message->status;
2204 message->context = NULL;
2209 * spi_sync - blocking/synchronous SPI data transfers
2210 * @spi: device with which data will be exchanged
2211 * @message: describes the data transfers
2212 * Context: can sleep
2214 * This call may only be used from a context that may sleep. The sleep
2215 * is non-interruptible, and has no timeout. Low-overhead controller
2216 * drivers may DMA directly into and out of the message buffers.
2218 * Note that the SPI device's chip select is active during the message,
2219 * and then is normally disabled between messages. Drivers for some
2220 * frequently-used devices may want to minimize costs of selecting a chip,
2221 * by leaving it selected in anticipation that the next message will go
2222 * to the same chip. (That may increase power usage.)
2224 * Also, the caller is guaranteeing that the memory associated with the
2225 * message will not be freed before this call returns.
2227 * It returns zero on success, else a negative error code.
2229 int spi_sync(struct spi_device *spi, struct spi_message *message)
2231 return __spi_sync(spi, message, 0);
2233 EXPORT_SYMBOL_GPL(spi_sync);
2236 * spi_sync_locked - version of spi_sync with exclusive bus usage
2237 * @spi: device with which data will be exchanged
2238 * @message: describes the data transfers
2239 * Context: can sleep
2241 * This call may only be used from a context that may sleep. The sleep
2242 * is non-interruptible, and has no timeout. Low-overhead controller
2243 * drivers may DMA directly into and out of the message buffers.
2245 * This call should be used by drivers that require exclusive access to the
2246 * SPI bus. It has to be preceded by a spi_bus_lock call. The SPI bus must
2247 * be released by a spi_bus_unlock call when the exclusive access is over.
2249 * It returns zero on success, else a negative error code.
2251 int spi_sync_locked(struct spi_device *spi, struct spi_message *message)
2253 return __spi_sync(spi, message, 1);
2255 EXPORT_SYMBOL_GPL(spi_sync_locked);
2258 * spi_bus_lock - obtain a lock for exclusive SPI bus usage
2259 * @master: SPI bus master that should be locked for exclusive bus access
2260 * Context: can sleep
2262 * This call may only be used from a context that may sleep. The sleep
2263 * is non-interruptible, and has no timeout.
2265 * This call should be used by drivers that require exclusive access to the
2266 * SPI bus. The SPI bus must be released by a spi_bus_unlock call when the
2267 * exclusive access is over. Data transfer must be done by spi_sync_locked
2268 * and spi_async_locked calls when the SPI bus lock is held.
2270 * It returns zero on success, else a negative error code.
2272 int spi_bus_lock(struct spi_master *master)
2274 unsigned long flags;
2276 mutex_lock(&master->bus_lock_mutex);
2278 spin_lock_irqsave(&master->bus_lock_spinlock, flags);
2279 master->bus_lock_flag = 1;
2280 spin_unlock_irqrestore(&master->bus_lock_spinlock, flags);
2282 /* mutex remains locked until spi_bus_unlock is called */
2286 EXPORT_SYMBOL_GPL(spi_bus_lock);
2289 * spi_bus_unlock - release the lock for exclusive SPI bus usage
2290 * @master: SPI bus master that was locked for exclusive bus access
2291 * Context: can sleep
2293 * This call may only be used from a context that may sleep. The sleep
2294 * is non-interruptible, and has no timeout.
2296 * This call releases an SPI bus lock previously obtained by an spi_bus_lock
2299 * It returns zero on success, else a negative error code.
2301 int spi_bus_unlock(struct spi_master *master)
2303 master->bus_lock_flag = 0;
2305 mutex_unlock(&master->bus_lock_mutex);
2309 EXPORT_SYMBOL_GPL(spi_bus_unlock);
2311 /* portable code must never pass more than 32 bytes */
2312 #define SPI_BUFSIZ max(32, SMP_CACHE_BYTES)
2317 * spi_write_then_read - SPI synchronous write followed by read
2318 * @spi: device with which data will be exchanged
2319 * @txbuf: data to be written (need not be dma-safe)
2320 * @n_tx: size of txbuf, in bytes
2321 * @rxbuf: buffer into which data will be read (need not be dma-safe)
2322 * @n_rx: size of rxbuf, in bytes
2323 * Context: can sleep
2325 * This performs a half duplex MicroWire style transaction with the
2326 * device, sending txbuf and then reading rxbuf. The return value
2327 * is zero for success, else a negative errno status code.
2328 * This call may only be used from a context that may sleep.
2330 * Parameters to this routine are always copied using a small buffer;
2331 * portable code should never use this for more than 32 bytes.
2332 * Performance-sensitive or bulk transfer code should instead use
2333 * spi_{async,sync}() calls with dma-safe buffers.
2335 int spi_write_then_read(struct spi_device *spi,
2336 const void *txbuf, unsigned n_tx,
2337 void *rxbuf, unsigned n_rx)
2339 static DEFINE_MUTEX(lock);
2342 struct spi_message message;
2343 struct spi_transfer x[2];
2346 /* Use preallocated DMA-safe buffer if we can. We can't avoid
2347 * copying here, (as a pure convenience thing), but we can
2348 * keep heap costs out of the hot path unless someone else is
2349 * using the pre-allocated buffer or the transfer is too large.
2351 if ((n_tx + n_rx) > SPI_BUFSIZ || !mutex_trylock(&lock)) {
2352 local_buf = kmalloc(max((unsigned)SPI_BUFSIZ, n_tx + n_rx),
2353 GFP_KERNEL | GFP_DMA);
2360 spi_message_init(&message);
2361 memset(x, 0, sizeof(x));
2364 spi_message_add_tail(&x[0], &message);
2368 spi_message_add_tail(&x[1], &message);
2371 memcpy(local_buf, txbuf, n_tx);
2372 x[0].tx_buf = local_buf;
2373 x[1].rx_buf = local_buf + n_tx;
2376 status = spi_sync(spi, &message);
2378 memcpy(rxbuf, x[1].rx_buf, n_rx);
2380 if (x[0].tx_buf == buf)
2381 mutex_unlock(&lock);
2387 EXPORT_SYMBOL_GPL(spi_write_then_read);
2389 /*-------------------------------------------------------------------------*/
2391 #if IS_ENABLED(CONFIG_OF_DYNAMIC)
2392 static int __spi_of_device_match(struct device *dev, void *data)
2394 return dev->of_node == data;
2397 /* must call put_device() when done with returned spi_device device */
2398 static struct spi_device *of_find_spi_device_by_node(struct device_node *node)
2400 struct device *dev = bus_find_device(&spi_bus_type, NULL, node,
2401 __spi_of_device_match);
2402 return dev ? to_spi_device(dev) : NULL;
2405 static int __spi_of_master_match(struct device *dev, const void *data)
2407 return dev->of_node == data;
2410 /* the spi masters are not using spi_bus, so we find it with another way */
2411 static struct spi_master *of_find_spi_master_by_node(struct device_node *node)
2415 dev = class_find_device(&spi_master_class, NULL, node,
2416 __spi_of_master_match);
2420 /* reference got in class_find_device */
2421 return container_of(dev, struct spi_master, dev);
2424 static int of_spi_notify(struct notifier_block *nb, unsigned long action,
2427 struct of_reconfig_data *rd = arg;
2428 struct spi_master *master;
2429 struct spi_device *spi;
2431 switch (of_reconfig_get_state_change(action, arg)) {
2432 case OF_RECONFIG_CHANGE_ADD:
2433 master = of_find_spi_master_by_node(rd->dn->parent);
2435 return NOTIFY_OK; /* not for us */
2437 spi = of_register_spi_device(master, rd->dn);
2438 put_device(&master->dev);
2441 pr_err("%s: failed to create for '%s'\n",
2442 __func__, rd->dn->full_name);
2443 return notifier_from_errno(PTR_ERR(spi));
2447 case OF_RECONFIG_CHANGE_REMOVE:
2448 /* find our device by node */
2449 spi = of_find_spi_device_by_node(rd->dn);
2451 return NOTIFY_OK; /* no? not meant for us */
2453 /* unregister takes one ref away */
2454 spi_unregister_device(spi);
2456 /* and put the reference of the find */
2457 put_device(&spi->dev);
2464 static struct notifier_block spi_of_notifier = {
2465 .notifier_call = of_spi_notify,
2467 #else /* IS_ENABLED(CONFIG_OF_DYNAMIC) */
2468 extern struct notifier_block spi_of_notifier;
2469 #endif /* IS_ENABLED(CONFIG_OF_DYNAMIC) */
2471 static int __init spi_init(void)
2475 buf = kmalloc(SPI_BUFSIZ, GFP_KERNEL);
2481 status = bus_register(&spi_bus_type);
2485 status = class_register(&spi_master_class);
2489 if (IS_ENABLED(CONFIG_OF_DYNAMIC))
2490 WARN_ON(of_reconfig_notifier_register(&spi_of_notifier));
2495 bus_unregister(&spi_bus_type);
2503 /* board_info is normally registered in arch_initcall(),
2504 * but even essential drivers wait till later
2506 * REVISIT only boardinfo really needs static linking. the rest (device and
2507 * driver registration) _could_ be dynamically linked (modular) ... costs
2508 * include needing to have boardinfo data structures be much more public.
2510 postcore_initcall(spi_init);